Symplify\PHP7_CodeSniffer\Runner

Complexity

Total Complexity

81

Size/Duplication

Total Lines	539
Duplicated Lines	8.16 %

Coupling/Cohesion

Components	1
Dependencies	12

Test Coverage

Coverage

0%

Importance

Changes	6
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
C	runPHPCS()	0	58	9
B	runPHPCBF()	0	41	2
B	init()	0	32	4
F	run()	22	153	32
A	handleErrors()	0	5	1
F	processFile()	0	84	16
D	processChildProcs()	22	75	17

<?php
/**
 * Responsible for running PHPCS and PHPCBF.
 *
 * After creating an object of this class, you probably just want to
 * call runPHPCS() or runPHPCBF().
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/squizlabs/Symplify\PHP7_CodeSniffer/blob/master/licence.txt BSD Licence
 */

namespace Symplify\PHP7_CodeSniffer;

use Symplify\PHP7_CodeSniffer\Files\FileList;
use Symplify\PHP7_CodeSniffer\Files\File;
use Symplify\PHP7_CodeSniffer\Files\DummyFile;
use Symplify\PHP7_CodeSniffer\Util\Cache;
use Symplify\PHP7_CodeSniffer\Util\Common;
use Symplify\PHP7_CodeSniffer\Exceptions\RuntimeException;

class Runner
{

    /**
     * The config data for the run.
     *
     * @var \Symplify\PHP7_CodeSniffer\Config
     */
    public $config = null;

    /**
     * The ruleset used for the run.
     *
     * @var \Symplify\PHP7_CodeSniffer\Ruleset
     */
    public $ruleset = null;

    /**
     * The reporter used for generating reports after the run.
     *
     * @var \Symplify\PHP7_CodeSniffer\Reporter
     */
    public $reporter = null;


    /**
     * Run the PHPCS script.
     *
     * @return array
     */
    public function runPHPCS()
    {
        Util\Timing::startTiming();

        if (defined('PHP_CodeSniffer_CBF') === false) {
            define('PHP_CodeSniffer_CBF', false);
        }

        // Creating the Config object populates it with all required settings
        // based on the CLI arguments provided to the script and any config
        // values the user has set.
        $this->config = new Config();

        // Init the run and load the rulesets to set additional config vars.
        $this->init();

        // Print a list of sniffs in each of the supplied standards.
        // We fudge the config here so that each standard is explained in isolation.
        if ($this->config->explain === true) {

The property explain does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            $standards = $this->config->standards;

The property standards does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

            foreach ($standards as $standard) {
                $this->config->standards = array($standard);

The property standards does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

                $ruleset = new Ruleset($this->config);
                $ruleset->explain();
            }

            exit(0);

The method runPHPCS() contains an exit expression.

        }

        // Disable caching if we are processing STDIN as we can't be 100%
        // sure where the file came from or if it will change in the future.
        if ($this->config->stdin === true) {

The property stdin does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->config->cache = false;

The property cache does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        }

        $numErrors = $this->run();

        // Print all the reports for this run.
        $toScreen = $this->reporter->printReports();

        // Only print timer output if no reports were
        // printed to the screen so we don't put additional output
        // in something like an XML report. If we are printing to screen,
        // the report types would have already worked out who should
        // print the timer info.
        if (($toScreen === false
            || (($this->reporter->totalErrors + $this->reporter->totalWarnings) === 0 && $this->config->showProgress === true))

The property showProgress does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

        ) {
            Util\Timing::printRunTime();
        }

        if ($numErrors === 0) {
            exit(0);

The method runPHPCS() contains an exit expression.

        } else {
            exit(1);

The method runPHPCS() contains an exit expression.

        }

    }//end runPHPCS()


    /**
     * Run the PHPCBF script.
     *
     * @return array
     */
    public function runPHPCBF()
    {
        if (defined('PHP_CodeSniffer_CBF') === false) {
            define('PHP_CodeSniffer_CBF', true);
        }

        Util\Timing::startTiming();

        // Creating the Config object populates it with all required settings
        // based on the CLI arguments provided to the script and any config
        // values the user has set.
        $this->config = new Config();

        // Init the run and load the rulesets to set additional config vars.
        $this->init();

        // Override some of the command line settings that might break the fixes.
        $this->config->verbosity    = 0;

The property verbosity does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->config->showProgress = false;

The property showProgress does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->config->explain      = false;

The property explain does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->config->cache        = false;

The property cache does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->config->showSources  = false;

The property showSources does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->config->recordErrors = false;

The property recordErrors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->config->reports      = array('cbf' => null);

The property reports does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

        // If a standard tries to set command line arguments itself, some
        // may be blocked because PHPCBF is running, so stop the script
        // dying if any are found.
        $this->config->dieOnUnknownArg = false;

        $numErrors = $this->run();
        $this->reporter->printReports();

        echo PHP_EOL;
        Util\Timing::printRunTime();

        // We can't tell exactly how many errors were fixed, but
        // we know how many errors were found.
        exit($numErrors);

The method runPHPCBF() contains an exit expression.

    }//end runPHPCBF()


    /**
     * Init the rulesets and other high-level settings.
     *
     * @return void
     */
    private function init()
    {
        // Ensure this option is enabled or else line endings will not always
        // be detected properly for files created on a Mac with the /r line ending.
        ini_set('auto_detect_line_endings', true);

        // Check that the standards are valid.
        foreach ($this->config->standards as $standard) {

The property standards does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            if (Util\Standards::isInstalledStandard($standard) === false) {
                // They didn't select a valid coding standard, so help them
                // out by letting them know which standards are installed.
                echo 'ERROR: the "'.$standard.'" coding standard is not installed. ';
                Util\Standards::printInstalledStandards();
                exit(2);

The method init() contains an exit expression.

            }
        }

        // Saves passing the Config object into other objects that only need
        // the verbostity flag for deubg output.
        if (defined('PHP_CodeSniffer_VERBOSITY') === false) {
            define('PHP_CodeSniffer_VERBOSITY', $this->config->verbosity);

The property verbosity does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        // Create this class so it is autoloaded and sets up a bunch
        // of Symplify\PHP7_CodeSniffer-specific token type constants.
        $tokens = new Util\Tokens();

$tokens is not used, you could remove the assignment.

        // The ruleset contains all the information about how the files
        // should be checked and/or fixed.
        $this->ruleset = new Ruleset($this->config);

    }//end init()


    /**
     * Performs the run.
     *
     * @return int The number of errors and warnings found.
     */
    private function run()
    {
        // The class that manages all reporters for the run.
        $this->reporter = new Reporter($this->config);

        if ($this->config->stdin === true) {

The property stdin does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            $fileContents = $this->config->stdinContent;

The property stdinContent does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __set, maybe consider adding a @property annotation.

            if ($fileContents === null) {
                $handle = fopen('php://stdin', 'r');
                stream_set_blocking($handle, true);
                $fileContents = stream_get_contents($handle);
                fclose($handle);
            }

            $todo  = new FileList($this->config, $this->ruleset);
            $dummy = new DummyFile($fileContents, $this->ruleset, $this->config);
            $todo->addFile($dummy->path, $dummy);

            $numFiles = 1;
        } else {
            if (empty($this->config->files) === true) {

The property files does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                echo 'ERROR: You must supply at least one file or directory to process.'.PHP_EOL.PHP_EOL;
                $this->config->printUsage();
                exit(0);

The method run() contains an exit expression.

            }

            if (PHP_CodeSniffer_VERBOSITY > 0) {
                echo 'Creating file list... ';
            }

            $todo     = new FileList($this->config, $this->ruleset);
            $numFiles = count($todo);

            if (PHP_CodeSniffer_VERBOSITY > 0) {
                echo "DONE ($numFiles files in queue)".PHP_EOL;
            }

            if ($this->config->cache === true) {

The property cache does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                if (PHP_CodeSniffer_VERBOSITY > 0) {
                    echo 'Loading cache... ';
                }

                Cache::load($this->ruleset, $this->config);

                if (PHP_CodeSniffer_VERBOSITY > 0) {
                    $size = Cache::getSize();
                    echo "DONE ($size files in cache)".PHP_EOL;
                }
            }
        }//end if

        $numProcessed = 0;
        $dots         = 0;
        $maxLength    = strlen($numFiles);
        $lastDir      = '';
        $childProcs   = array();

$childProcs is not used, you could remove the assignment.

        // Turn all sniff errors into exceptions.
        set_error_handler(array($this, 'handleErrors'));

        // Running normally.
        foreach ($todo as $path => $file) {
            $currDir = dirname($path);
            if ($lastDir !== $currDir) {
                if (PHP_CodeSniffer_VERBOSITY > 0 || (PHP_CodeSniffer_CBF === true && $this->config->stdin === false)) {

The property stdin does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                    echo 'Changing into directory '.Common::stripBasepath($currDir, $this->config->basepath).PHP_EOL;

The property basepath does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                }

                $lastDir = $currDir;
            }

            $this->processFile($file);

            $numProcessed++;

            if (PHP_CodeSniffer_VERBOSITY > 0
                || $this->config->interactive === true

The property interactive does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                || $this->config->showProgress === false

The property showProgress does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            ) {
                continue;
            }

            // Show progress information.
            if ($file->ignored === true) {
                echo 'S';
            } else {
                $errors   = $file->getErrorCount();
                $warnings = $file->getWarningCount();
                if ($errors > 0) {

This code seems to be duplicated across your project.

                    if ($this->config->colors === true) {

The property colors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                        echo "\033[31m";
                    }

                    echo 'E';
                } else if ($warnings > 0) {
                    if ($this->config->colors === true) {

The property colors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                        echo "\033[33m";
                    }

                    echo 'W';
                } else {
                    echo '.';
                }

                if ($this->config->colors === true) {

The property colors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                    echo "\033[0m";
                }
            }//end if

            $dots++;
            if ($dots === 60) {

This code seems to be duplicated across your project.

                $padding = ($maxLength - strlen($numProcessed));
                echo str_repeat(' ', $padding);
                $percent = round(($numProcessed / $numFiles) * 100);
                echo " $numProcessed / $numFiles ($percent%)".PHP_EOL;
                $dots = 0;
            }
        }//end foreach

        restore_error_handler();

        if (PHP_CodeSniffer_VERBOSITY === 0
            && $this->config->interactive === false

The property interactive does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            && $this->config->showProgress === true

The property showProgress does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

        ) {
            echo PHP_EOL.PHP_EOL;
        }

        if ($this->config->cache === true) {

The property cache does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            Cache::save();
        }

        $ignoreWarnings = Config::getConfigData('ignore_warnings_on_exit');
        $ignoreErrors   = Config::getConfigData('ignore_errors_on_exit');

        $return = ($this->reporter->totalErrors + $this->reporter->totalWarnings);
        if ($ignoreErrors !== null) {
            $ignoreErrors = (bool) $ignoreErrors;
            if ($ignoreErrors === true) {
                $return -= $this->reporter->totalErrors;
            }
        }

        if ($ignoreWarnings !== null) {
            $ignoreWarnings = (bool) $ignoreWarnings;
            if ($ignoreWarnings === true) {
                $return -= $this->reporter->totalWarnings;
            }
        }

        return $return;

    }//end run()


    /**
     * Converts all PHP errors into exceptions.
     *
     * This method forces a sniff to stop processing if it is not
     * able to handle a specific piece of code, instead of continuing
     * and potentially getting into a loop.
     *
     * @param int    $code    The level of error raised.
     * @param string $message The error message.
     * @param string $file    The path of the file that raised the error.
     * @param int    $line    The line number the error was raised at.
     *
     * @return void
     */
    public function handleErrors($code, $message, $file, $line)
    {
        throw new RuntimeException("$message in $file on line $line");

    }//end handleErrors()


    /**
     * Processes a single file, including checking and fixing.
     *
     * @param \Symplify\PHP7_CodeSniffer\Files\File $file The file to be processed.
     *
     * @return void
     */
    private function processFile($file)
    {
        if (PHP_CodeSniffer_VERBOSITY > 0 || (PHP_CodeSniffer_CBF === true && $this->config->stdin === false)) {

The property stdin does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            $startTime = microtime(true);
            echo 'Processing '.basename($file->path).' ';
            if (PHP_CodeSniffer_VERBOSITY > 1) {
                echo PHP_EOL;
            }
        }

        try {
            $file->process();

            if (PHP_CodeSniffer_VERBOSITY > 0
                || (PHP_CodeSniffer_CBF === true && $this->config->stdin === false)

The property stdin does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            ) {
                $timeTaken = ((microtime(true) - $startTime) * 1000);

The variable $startTime does not seem to be defined for all execution paths leading up to this point.

                if ($timeTaken < 1000) {
                    $timeTaken = round($timeTaken);
                    echo "DONE in {$timeTaken}ms";
                } else {
                    $timeTaken = round(($timeTaken / 1000), 2);
                    echo "DONE in $timeTaken secs";
                }

                if (PHP_CodeSniffer_CBF === true) {
                    $errors = $file->getFixableCount();
                    echo " ($errors fixable violations)".PHP_EOL;
                } else {
                    $errors   = $file->getErrorCount();
                    $warnings = $file->getWarningCount();
                    echo " ($errors errors, $warnings warnings)".PHP_EOL;
                }
            }
        } catch (\Exception $e) {
            $error = 'An error occurred during processing; checking has been aborted. The error message was: '.$e->getMessage();
            $file->addErrorOnLine($error, 1, 'Internal.Exception');
        }//end try

        $this->reporter->cacheFileReport($file, $this->config);

The call to Reporter::cacheFileReport() has too many arguments starting with $this->config.

        // Clean up the file to save (a lot of) memory.
        $file->cleanUp();

        if ($this->config->interactive === true) {

The property interactive does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

            /*
                Running interactively.
                Print the error report for the current file and then wait for user input.
            */

            // Get current violations and then clear the list to make sure
            // we only print violations for a single file each time.
            $numErrors = null;
            while ($numErrors !== 0) {
                $numErrors = ($file->getErrorCount() + $file->getWarningCount());
                if ($numErrors === 0) {
                    continue;
                }

                $this->reporter->printReport('full');

                echo '<ENTER> to recheck, [s] to skip or [q] to quit : ';
                $input = fgets(STDIN);
                $input = trim($input);

                switch ($input) {
                case 's':
                    break(2);
                case 'q':
                    exit(0);

The method processFile() contains an exit expression.

                default:
                    // Repopulate the sniffs because some of them save their state
                    // and only clear it when the file changes, but we are rechecking
                    // the same file.
                    $file->ruleset->populateTokenListeners();
                    $file->reloadContent();
                    $file->process();
                    $this->reporter->cacheFileReport($file, $this->config);

The call to Reporter::cacheFileReport() has too many arguments starting with $this->config.

                    break;
                }
            }//end while
        }//end if

    }//end processFile()


    /**
     * Waits for child processes to complete and cleans up after them.
     *
     * The reporting information returned by each child process is merged
     * into the main reporter class.
     *
     * @param array $childProcs An array of child processes to wait for.
     *
     * @return void
     */
    private function processChildProcs($childProcs)

This method is not used, and could be removed.

    {
        $dots         = 0;
        $numProcessed = 0;
        $totalBatches = count($childProcs);
        $maxLength    = strlen($totalBatches);

        while (count($childProcs) > 0) {
            foreach ($childProcs as $key => $procData) {
                $res = pcntl_waitpid($procData['pid'], $status, WNOHANG);
                if ($res === $procData['pid']) {
                    if (file_exists($procData['out']) === true) {
                        include $procData['out'];
                        if (isset($childOutput) === true) {
                            $this->reporter->totalFiles    += $childOutput['totalFiles'];

The variable $childOutput does not exist. Did you forget to declare it?

                            $this->reporter->totalErrors   += $childOutput['totalErrors'];
                            $this->reporter->totalWarnings += $childOutput['totalWarnings'];
                            $this->reporter->totalFixable  += $childOutput['totalFixable'];
                        }

                        if (isset($debugOutput) === true) {
                            echo $debugOutput;

The variable $debugOutput does not exist. Did you forget to declare it?

                        }

                        if (isset($childCache) === true) {
                            foreach ($childCache as $path => $cache) {

The variable $childCache does not exist. Did you forget to declare it?

                                Cache::set($path, $cache);
                            }
                        }

                        unlink($procData['out']);
                        unset($childProcs[$key]);

                        $numProcessed++;

                        if (PHP_CodeSniffer_VERBOSITY > 0
                            || $this->config->showProgress === false

The property showProgress does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                        ) {
                            continue;
                        }

                        if ($childOutput['totalErrors'] > 0) {

This code seems to be duplicated across your project.

                            if ($this->config->colors === true) {

The property colors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                                echo "\033[31m";
                            }

                            echo 'E';
                        } else if ($childOutput['totalWarnings'] > 0) {
                            if ($this->config->colors === true) {

The property colors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                                echo "\033[33m";
                            }

                            echo 'W';
                        } else {
                            echo '.';
                        }

                        if ($this->config->colors === true) {

The property colors does not exist on object<Symplify\PHP7_CodeSniffer\Config>. Since you implemented __get, maybe consider adding a @property annotation.

                            echo "\033[0m";
                        }

                        $dots++;
                        if ($dots === 60) {

This code seems to be duplicated across your project.

                            $padding = ($maxLength - strlen($numProcessed));
                            echo str_repeat(' ', $padding);
                            $percent = round(($numProcessed / $totalBatches) * 100);
                            echo " $numProcessed / $totalBatches ($percent%)".PHP_EOL;
                            $dots = 0;
                        }
                    }//end if
                }//end if
            }//end foreach
        }//end while

    }//end processChildProcs()


}//end class