Merge branch 'phpcs3'

Author: sarjona

.travis.yml

@@ -76,10 +76,11 @@ script:
   - moodle-plugin-ci phplint
   - moodle-plugin-ci phpcpd
   - moodle-plugin-ci phpmd
-  - moodle-plugin-ci codechecker
+    # - moodle-plugin-ci codechecker # Heh, cannot check codechecker 3 with codechecker 2!
   - moodle-plugin-ci validate
   - moodle-plugin-ci savepoints
   - moodle-plugin-ci mustache
   - moodle-plugin-ci grunt
+  - moodle-plugin-ci phpdoc
   - moodle-plugin-ci phpunit
   - moodle-plugin-ci behat

CHANGES.md

@@ -1,3 +1,15 @@
+Changes in version 3.0.0 (20201102) - Welcome phpcs 3
+-----------------------------------------------------
+- Upgrade to PHP_CodeSniffer 3.5.8 (stronk7):
+    - PHP_CodeSniffer move to phpcs directory (see readme_moodle.txt for complete instructions).
+    - Move Moodle sniffs to PHP_CodeSniffer 3.
+    - Create own runner/report.
+    - Move as much as possible from locallib.php to classes.
+    - Add PHPUnit 8 compatibility, keeping PHPUnit 6 working.
+    - Min Moodle version required increases from 3.2 to 3.4.
+- [PR#90](https://github.com/moodlehq/moodle-local_codechecker/pull/90): Adapt custom PHP_CodeSniffer runner (classes/runner.php) to use PHP_CodeSniffer 3 API (Sara Arjona).
+- [PR#95](https://github.com/moodlehq/moodle-local_codechecker/pull/95): Unlock session before processing files (Víctor Déniz).
+
 Changes in version 2.9.8 (20201002) - Bye and thank you, phpcs 2.x
 ------------------------------------------------------------------
 - [PR#83](https://github.com/moodlehq/moodle-local_codechecker/pull/83) and [PR#84](https://github.com/moodlehq/moodle-local_codechecker/pull/84): Allow a list of files to be checked (Sam Marshall).

PHPCSAliases.php

@@ -0,0 +1,74 @@
+<?php
+// phpcs:ignoreFile
+/**
+ * PHPCompatibility, an external standard for PHP_CodeSniffer.
+ *
+ * PHPCS cross-version compatibility helper.
+ *
+ * @package   local_codechecker
+ * @copyright 2012-2020 PHPCompatibility Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCompatibility/PHPCompatibility
+ *
+ * @since 8.0.0
+ */
+
+/*
+ * Alias a number of PHPCS 3.x classes to their PHPCS 2.x equivalents.
+ *
+ * This file is auto-loaded by PHPCS 3.x before any sniffs are loaded
+ * through the PHPCS 3.x `<autoload>` ruleset directive.
+ *
+ * {internal The PHPCS file have been reorganized in PHPCS 3.x, quite
+ * a few "old" classes have been split and spread out over several "new"
+ * classes. In other words, this will only work for a limited number
+ * of classes.}
+ *
+ * {internal The `class_exists` wrappers are needed to play nice with other
+ * external PHPCS standards creating cross-version compatibility in the same
+ * manner.}
+ */
+if (defined('PHPCOMPATIBILITY_PHPCS_ALIASES_SET') === false) {
+    if (interface_exists('\PHP_CodeSniffer_Sniff') === false) {
+        class_alias('PHP_CodeSniffer\Sniffs\Sniff', '\PHP_CodeSniffer_Sniff');
+    }
+    if (class_exists('\PHP_CodeSniffer_File') === false) {
+        class_alias('PHP_CodeSniffer\Files\File', '\PHP_CodeSniffer_File');
+    }
+    if (class_exists('\PHP_CodeSniffer_Tokens') === false) {
+        class_alias('PHP_CodeSniffer\Util\Tokens', '\PHP_CodeSniffer_Tokens');
+    }
+    if (class_exists('\PHP_CodeSniffer_Exception') === false) {
+        class_alias('PHP_CodeSniffer\Exceptions\RuntimeException', '\PHP_CodeSniffer_Exception');
+    }
+    if (class_exists('\PHP_CodeSniffer_Standards_AbstractScopeSniff') === false) {
+        class_alias('PHP_CodeSniffer\Sniffs\AbstractScopeSniff', '\PHP_CodeSniffer_Standards_AbstractScopeSniff');
+    }
+    if (class_exists('\Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff') === false) {
+        class_alias('PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff', '\Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff');
+    }
+
+    define('PHPCOMPATIBILITY_PHPCS_ALIASES_SET', true);
+
+    /*
+     * Register an autoloader.
+     *
+     * {internal When `installed_paths` is set via the ruleset, this autoloader
+     * is needed to run the sniffs.
+     * Upstream issue: {@link https://github.com/squizlabs/PHP_CodeSniffer/issues/1591} }
+     *
+     * @since 8.0.0
+     */
+    spl_autoload_register(function ($class) {
+        // Only try & load our own classes.
+        if (stripos($class, 'PHPCompatibility') !== 0) {
+            return;
+        }
+
+        $file = realpath(__DIR__) . DIRECTORY_SEPARATOR . strtr($class, '\\', DIRECTORY_SEPARATOR) . '.php';
+
+        if (file_exists($file)) {
+            include_once $file;
+        }
+    });
+}

README.md

@@ -23,7 +23,7 @@ To install it using git, type this command in the root of your Moodle install:
 
 Then add /local/codechecker to your git ignore.
 
-Additionally, remember to only use the version of PHPCS located in ``pear/PHP/scripts/phpcs`` rather than installing PHPCS directly. Add the location of the PHPCS executable to your system path, tell PHPCS about the Moodle coding standard with ``phpcs --config-set installed_paths /path/to/moodle-local_codechecker``  and set the default coding standard to Moodle with ``phpcs --config-set default_standard moodle``.  You can now test a file (or folder) with: ``phpcs /path/to/file.php``.
+Additionally, remember to only use the version of PHPCS located in ``phpcs/bin/phpcs`` rather than installing PHPCS directly. Add the location of the PHPCS executable to your system path, tell PHPCS about the Moodle coding standard with ``phpcs --config-set installed_paths /path/to/moodle-local_codechecker``  and set the default coding standard to Moodle with ``phpcs --config-set default_standard moodle``.  You can now test a file (or folder) with: ``phpcs /path/to/file.php``.
 
 Alternatively, download the zip from
 <https://github.com/moodlehq/moodle-local_codechecker/zipball/master>,

classes/report.php

@@ -0,0 +1,76 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Custom PHP_CodeSniffer XML Report for local_codechecker.
+ *
+ * @package    local_codechecker
+ * @copyright  2020 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_codechecker;
+
+// phpcs:disable moodle.NamingConventions
+
+/**
+ * Custom PHP_CodeSniffer XML Report for local_codechecker.
+ *
+ * This custom report is exactly the upstream XML one, but
+ * with a few modifications when there aren't errors and warnings.
+ *
+ * @copyright  2020 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class report extends \PHP_CodeSniffer\Reports\Xml {
+
+    /**
+     * Generate a partial report for a single processed file.
+     *
+     * For files with violations delegate processing to parent class. For files
+     * without violations, just return the plain <file> element, without any err/warn.
+     *
+     * @param array $report Prepared report data.
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being reported on.
+     * @param boolean $showSources Show sources?
+     * @param int $width Maximum allowed line width.
+     *
+     * @return boolean
+     */
+    public function generateFileReport($report, \PHP_CodeSniffer\Files\File $phpcsFile, $showSources = false, $width = 80) {
+
+        // Report has violations, delegate to parent standard processing.
+        if ($report['errors'] !== 0 || $report['warnings'] !== 0) {
+            return parent::generateFileReport($report, $phpcsFile, $showSources, $width);
+        }
+
+        // Here we are, with a file with 0 errors and warnings.
+        $out = new \XMLWriter;
+        $out->openMemory();
+        $out->setIndent(true);
+
+        $out->startElement('file');
+        $out->writeAttribute('name', $report['filename']);
+        $out->writeAttribute('errors', $report['errors']);
+        $out->writeAttribute('warnings', $report['warnings']);
+
+        $out->endElement();
+        echo $out->flush();
+
+        return true;
+
+    }
+}

classes/runner.php

@@ -0,0 +1,157 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Custom PHP_CodeSniffer Runner for local_codechecker.
+ *
+ * @package    local_codechecker
+ * @copyright  2020 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace local_codechecker;
+
+/**
+ * Custom PHP_CodeSniffer\Runner for local_codechecker.
+ *
+ * This custom runner just intercepts the init() method, to be able
+ * to add all our configuration. The alternative to this is to play
+ * with fake $_SERVER['argv' {@see PHP_CodeSniffer\Config}.
+ *
+ * @copyright  2020 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class runner extends \PHP_CodeSniffer\Runner {
+
+    /**
+     * Create an instance of the runner.
+     */
+    public function __construct() {
+        // Needed constant.
+        if (defined('PHP_CODESNIFFER_CBF') === false) {
+            define('PHP_CODESNIFFER_CBF', true);
+        }
+        // Pass the parallel as CLI, disabled. Note
+        // this is to avoid some nasty argv notices.
+        $this->config = new \PHP_CodeSniffer\Config([
+            '--parallel=1',
+        ]);
+    }
+
+    /**
+     * Set the file where the XML report is going to be written
+     *
+     * @param string $reportfile file path to XML report.
+     */
+    public function set_reportfile($reportfile) {
+        $this->config->reports = [report::class => $reportfile];
+    }
+
+    /**
+     * Set if the report should include warnings or no.
+     *
+     * @param bool $includewarnings
+     */
+    public function set_includewarnings($includewarnings) {
+        if (empty($includewarnings)) {
+            $this->config->warningSeverity = 0; // Disable warnings.
+        }
+    }
+
+    /**
+     * Set the files the runner is going to process.
+     *
+     * @param string[] $files array of full paths to files or directories.
+     */
+    public function set_files($files) {
+        $this->config->files = $files;
+    }
+
+    /**
+     * Set all the patterns in file paths to be ignored
+     *
+     * @param string[] $ignorepatterns array of paths to ignore (libs, fixtures...)
+     */
+    public function set_ignorepatterns($ignorepatterns) {
+        $this->config->ignored = $ignorepatterns;
+    }
+
+    /**
+     * Set the verbosity for the output.
+     *
+     * @param int $verbosity How verbose the output should be. Check expected values in {@see PHP_CodeSniffer\Config}.
+     */
+    public function set_verbosity(int $verbosity): void {
+        $this->config->verbosity = $verbosity;
+    }
+
+    /**
+     * Set if the interactive checking mode should be enabled or not.
+     *
+     * @param bool $interactive If true, will stop after each file with errors and wait for user input.
+     */
+    public function set_interactive(bool $interactive): void {
+        $this->config->interactive = $interactive;
+    }
+
+    /**
+     * Initialise the runner, invoked by run().
+     */
+    public function init() {
+
+        $this->config->standards = ['moodle'];
+        $this->config->extensions = ['php' => 'PHP'];
+
+        // Added all our customizations, finally call parent.
+        parent::init();
+    }
+
+    /**
+     * Runs a codechecker execution.
+     *
+     * Instead of using the upstream runner, we just use this reduced version
+     * that simplifies all the configuration, init and processing to suit
+     * codechecker simpler needs from the UI.
+     */
+    public function run() {
+        // Setup everything.
+        $this->init();
+
+        // Create the reporter to manage all the reports from the run.
+        $this->reporter = new \PHP_CodeSniffer\Reporter($this->config);
+
+        // And build the file list to iterate over.
+        $todo = new \PHP_CodeSniffer\Files\FileList($this->config, $this->ruleset);
+
+        foreach ($todo as $file) {
+            if ($file->ignored === false) {
+                try {
+                    $this->processFile($file);
+                } catch (\PHP_CodeSniffer\Exceptions\DeepExitException $e) {
+                    echo $e->getMessage();
+                    return $e->getCode();
+                } catch (\Exception $e) {
+                    $error = 'Problem during processing; checking has been aborted. The error message was: '.$e->getMessage();
+                    $file->addErrorOnLine($error, 1, 'Internal.Exception');
+                }
+                $file->cleanUp();
+            }
+        }
+
+        // Have finished, generate the final reports.
+        $this->reporter->printReports();
+    }
+}