@atomicsmash/coding-standards 13.0.0-beta.3 → 13.0.0

package/vendor/squizlabs/php_codesniffer/src/Reporter.php

@@ -1,445 +0,0 @@
-<?php
-/**
- * Manages reporting of errors and warnings.
- *
- * @author    Greg Sherwood <gsherwood@squiz.net>
- * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
- */
-
-namespace PHP_CodeSniffer;
-
-use PHP_CodeSniffer\Exceptions\DeepExitException;
-use PHP_CodeSniffer\Exceptions\RuntimeException;
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Reports\Report;
-use PHP_CodeSniffer\Util\Common;
-
-class Reporter
-{
-
-    /**
-     * The config data for the run.
-     *
-     * @var \PHP_CodeSniffer\Config
-     */
-    public $config = null;
-
-    /**
-     * Total number of files that contain errors or warnings.
-     *
-     * @var integer
-     */
-    public $totalFiles = 0;
-
-    /**
-     * Total number of errors found during the run.
-     *
-     * @var integer
-     */
-    public $totalErrors = 0;
-
-    /**
-     * Total number of warnings found during the run.
-     *
-     * @var integer
-     */
-    public $totalWarnings = 0;
-
-    /**
-     * Total number of errors/warnings that can be fixed.
-     *
-     * @var integer
-     */
-    public $totalFixable = 0;
-
-    /**
-     * Total number of errors/warnings that were fixed.
-     *
-     * @var integer
-     */
-    public $totalFixed = 0;
-
-    /**
-     * When the PHPCS run started.
-     *
-     * @var float
-     */
-    public static $startTime = 0;
-
-    /**
-     * A cache of report objects.
-     *
-     * @var array
-     */
-    private $reports = [];
-
-    /**
-     * A cache of opened temporary files.
-     *
-     * @var array
-     */
-    private $tmpFiles = [];
-
-
-    /**
-     * Initialise the reporter.
-     *
-     * All reports specified in the config will be created and their
-     * output file (or a temp file if none is specified) initialised by
-     * clearing the current contents.
-     *
-     * @param \PHP_CodeSniffer\Config $config The config data for the run.
-     *
-     * @return void
-     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException If a custom report class could not be found.
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException  If a report class is incorrectly set up.
-     */
-    public function __construct(Config $config)
-    {
-        $this->config = $config;
-
-        foreach ($config->reports as $type => $output) {
-            if ($output === null) {
-                $output = $config->reportFile;
-            }
-
-            $reportClassName = '';
-            if (strpos($type, '.') !== false) {
-                // This is a path to a custom report class.
-                $filename = realpath($type);
-                if ($filename === false) {
-                    $error = "ERROR: Custom report \"$type\" not found".PHP_EOL;
-                    throw new DeepExitException($error, 3);
-                }
-
-                $reportClassName = Autoload::loadFile($filename);
-            } else if (class_exists('PHP_CodeSniffer\Reports\\'.ucfirst($type)) === true) {
-                // PHPCS native report.
-                $reportClassName = 'PHP_CodeSniffer\Reports\\'.ucfirst($type);
-            } else if (class_exists($type) === true) {
-                // FQN of a custom report.
-                $reportClassName = $type;
-            } else {
-                // OK, so not a FQN, try and find the report using the registered namespaces.
-                $registeredNamespaces = Autoload::getSearchPaths();
-                $trimmedType          = ltrim($type, '\\');
-
-                foreach ($registeredNamespaces as $nsPrefix) {
-                    if ($nsPrefix === '') {
-                        continue;
-                    }
-
-                    if (class_exists($nsPrefix.'\\'.$trimmedType) === true) {
-                        $reportClassName = $nsPrefix.'\\'.$trimmedType;
-                        break;
-                    }
-                }
-            }//end if
-
-            if ($reportClassName === '') {
-                $error = "ERROR: Class file for report \"$type\" not found".PHP_EOL;
-                throw new DeepExitException($error, 3);
-            }
-
-            $reportClass = new $reportClassName();
-            if (($reportClass instanceof Report) === false) {
-                throw new RuntimeException('Class "'.$reportClassName.'" must implement the "PHP_CodeSniffer\Report" interface.');
-            }
-
-            $this->reports[$type] = [
-                'output' => $output,
-                'class'  => $reportClass,
-            ];
-
-            if ($output === null) {
-                // Using a temp file.
-                // This needs to be set in the constructor so that all
-                // child procs use the same report file when running in parallel.
-                $this->tmpFiles[$type] = tempnam(sys_get_temp_dir(), 'phpcs');
-                file_put_contents($this->tmpFiles[$type], '');
-            } else {
-                file_put_contents($output, '');
-            }
-        }//end foreach
-
-    }//end __construct()
-
-
-    /**
-     * Generates and prints final versions of all reports.
-     *
-     * Returns TRUE if any of the reports output content to the screen
-     * or FALSE if all reports were silently printed to a file.
-     *
-     * @return bool
-     */
-    public function printReports()
-    {
-        $toScreen = false;
-        foreach ($this->reports as $type => $report) {
-            if ($report['output'] === null) {
-                $toScreen = true;
-            }
-
-            $this->printReport($type);
-        }
-
-        return $toScreen;
-
-    }//end printReports()
-
-
-    /**
-     * Generates and prints a single final report.
-     *
-     * @param string $report The report type to print.
-     *
-     * @return void
-     */
-    public function printReport($report)
-    {
-        $reportClass = $this->reports[$report]['class'];
-        $reportFile  = $this->reports[$report]['output'];
-
-        if ($reportFile !== null) {
-            $filename = $reportFile;
-            $toScreen = false;
-        } else {
-            if (isset($this->tmpFiles[$report]) === true) {
-                $filename = $this->tmpFiles[$report];
-            } else {
-                $filename = null;
-            }
-
-            $toScreen = true;
-        }
-
-        $reportCache = '';
-        if ($filename !== null) {
-            $reportCache = file_get_contents($filename);
-        }
-
-        ob_start();
-        $reportClass->generate(
-            $reportCache,
-            $this->totalFiles,
-            $this->totalErrors,
-            $this->totalWarnings,
-            $this->totalFixable,
-            $this->config->showSources,
-            $this->config->reportWidth,
-            $this->config->interactive,
-            $toScreen
-        );
-        $generatedReport = ob_get_contents();
-        ob_end_clean();
-
-        if ($this->config->colors !== true || $reportFile !== null) {
-            $generatedReport = Common::stripColors($generatedReport);
-        }
-
-        if ($reportFile !== null) {
-            if (PHP_CODESNIFFER_VERBOSITY > 0) {
-                echo $generatedReport;
-            }
-
-            file_put_contents($reportFile, $generatedReport.PHP_EOL);
-        } else {
-            echo $generatedReport;
-            if ($filename !== null && file_exists($filename) === true) {
-                unlink($filename);
-                unset($this->tmpFiles[$report]);
-            }
-        }
-
-    }//end printReport()
-
-
-    /**
-     * Caches the result of a single processed file for all reports.
-     *
-     * The report content that is generated is appended to the output file
-     * assigned to each report. This content may be an intermediate report format
-     * and not reflect the final report output.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file that has been processed.
-     *
-     * @return void
-     */
-    public function cacheFileReport(File $phpcsFile)
-    {
-        if (isset($this->config->reports) === false) {
-            // This happens during unit testing, or any time someone just wants
-            // the error data and not the printed report.
-            return;
-        }
-
-        $reportData  = $this->prepareFileReport($phpcsFile);
-        $errorsShown = false;
-
-        foreach ($this->reports as $type => $report) {
-            $reportClass = $report['class'];
-
-            ob_start();
-            $result = $reportClass->generateFileReport($reportData, $phpcsFile, $this->config->showSources, $this->config->reportWidth);
-            if ($result === true) {
-                $errorsShown = true;
-            }
-
-            $generatedReport = ob_get_contents();
-            ob_end_clean();
-
-            if ($report['output'] === null) {
-                // Using a temp file.
-                if (isset($this->tmpFiles[$type]) === false) {
-                    // When running in interactive mode, the reporter prints the full
-                    // report many times, which will unlink the temp file. So we need
-                    // to create a new one if it doesn't exist.
-                    $this->tmpFiles[$type] = tempnam(sys_get_temp_dir(), 'phpcs');
-                    file_put_contents($this->tmpFiles[$type], '');
-                }
-
-                file_put_contents($this->tmpFiles[$type], $generatedReport, (FILE_APPEND | LOCK_EX));
-            } else {
-                file_put_contents($report['output'], $generatedReport, (FILE_APPEND | LOCK_EX));
-            }//end if
-        }//end foreach
-
-        if ($errorsShown === true || PHP_CODESNIFFER_CBF === true) {
-            $this->totalFiles++;
-            $this->totalErrors   += $reportData['errors'];
-            $this->totalWarnings += $reportData['warnings'];
-
-            // When PHPCBF is running, we need to use the fixable error values
-            // after the report has run and fixed what it can.
-            if (PHP_CODESNIFFER_CBF === true) {
-                $this->totalFixable += $phpcsFile->getFixableCount();
-                $this->totalFixed   += $phpcsFile->getFixedCount();
-            } else {
-                $this->totalFixable += $reportData['fixable'];
-            }
-        }
-
-    }//end cacheFileReport()
-
-
-    /**
-     * Generate summary information to be used during report generation.
-     *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file that has been processed.
-     *
-     * @return array<string, string|int|array> Prepared report data.
-     *                                         The format of prepared data is as follows:
-     *                                         ```
-     *                                         array(
-     *                                           'filename' => string The name of the current file.
-     *                                           'errors'   => int    The number of errors seen in the current file.
-     *                                           'warnings' => int    The number of warnings seen in the current file.
-     *                                           'fixable'  => int    The number of fixable issues seen in the current file.
-     *                                           'messages' => array(
-     *                                             int <Line number> => array(
-     *                                               int <Column number> => array(
-     *                                                 int <Message index> => array(
-     *                                                   'message'  => string The error/warning message.
-     *                                                   'source'   => string The full error code for the message.
-     *                                                   'severity' => int    The severity of the message.
-     *                                                   'fixable'  => bool   Whether this error/warning is auto-fixable.
-     *                                                   'type'     => string The type of message. Either 'ERROR' or 'WARNING'.
-     *                                                 )
-     *                                               )
-     *                                             )
-     *                                           )
-     *                                         )
-     *                                         ```
-     */
-    public function prepareFileReport(File $phpcsFile)
-    {
-        $report = [
-            'filename' => Common::stripBasepath($phpcsFile->getFilename(), $this->config->basepath),
-            'errors'   => $phpcsFile->getErrorCount(),
-            'warnings' => $phpcsFile->getWarningCount(),
-            'fixable'  => $phpcsFile->getFixableCount(),
-            'messages' => [],
-        ];
-
-        if ($report['errors'] === 0 && $report['warnings'] === 0) {
-            // Perfect score!
-            return $report;
-        }
-
-        if ($this->config->recordErrors === false) {
-            $message  = 'Errors are not being recorded but this report requires error messages. ';
-            $message .= 'This report will not show the correct information.';
-            $report['messages'][1][1] = [
-                [
-                    'message'  => $message,
-                    'source'   => 'Internal.RecordErrors',
-                    'severity' => 5,
-                    'fixable'  => false,
-                    'type'     => 'ERROR',
-                ],
-            ];
-            return $report;
-        }
-
-        $errors = [];
-
-        // Merge errors and warnings.
-        foreach ($phpcsFile->getErrors() as $line => $lineErrors) {
-            foreach ($lineErrors as $column => $colErrors) {
-                $newErrors = [];
-                foreach ($colErrors as $data) {
-                    $newErrors[] = [
-                        'message'  => $data['message'],
-                        'source'   => $data['source'],
-                        'severity' => $data['severity'],
-                        'fixable'  => $data['fixable'],
-                        'type'     => 'ERROR',
-                    ];
-                }
-
-                $errors[$line][$column] = $newErrors;
-            }
-
-            ksort($errors[$line]);
-        }//end foreach
-
-        foreach ($phpcsFile->getWarnings() as $line => $lineWarnings) {
-            foreach ($lineWarnings as $column => $colWarnings) {
-                $newWarnings = [];
-                foreach ($colWarnings as $data) {
-                    $newWarnings[] = [
-                        'message'  => $data['message'],
-                        'source'   => $data['source'],
-                        'severity' => $data['severity'],
-                        'fixable'  => $data['fixable'],
-                        'type'     => 'WARNING',
-                    ];
-                }
-
-                if (isset($errors[$line]) === false) {
-                    $errors[$line] = [];
-                }
-
-                if (isset($errors[$line][$column]) === true) {
-                    $errors[$line][$column] = array_merge(
-                        $newWarnings,
-                        $errors[$line][$column]
-                    );
-                } else {
-                    $errors[$line][$column] = $newWarnings;
-                }
-            }//end foreach
-
-            ksort($errors[$line]);
-        }//end foreach
-
-        ksort($errors);
-        $report['messages'] = $errors;
-        return $report;
-
-    }//end prepareFileReport()
-
-
-}//end class

package/vendor/squizlabs/php_codesniffer/src/Reports/Cbf.php

@@ -1,259 +0,0 @@
-<?php
-/**
- * CBF report for PHP_CodeSniffer.
- *
- * This report implements the various auto-fixing features of the
- * PHPCBF script and is not intended (or allowed) to be selected as a
- * report from the command line.
- *
- * @author    Greg Sherwood <gsherwood@squiz.net>
- * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
- * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
- */
-
-namespace PHP_CodeSniffer\Reports;
-
-use PHP_CodeSniffer\Exceptions\DeepExitException;
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Util\Timing;
-
-class Cbf implements Report
-{
-
-
-    /**
-     * Generate a partial report for a single processed file.
-     *
-     * Function should return TRUE if it printed or stored data about the file
-     * and FALSE if it ignored the file. Returning TRUE indicates that the file and
-     * its data should be counted in the grand totals.
-     *
-     * @param array<string, string|int|array> $report      Prepared report data.
-     *                                                     See the {@see Report} interface for a detailed specification.
-     * @param \PHP_CodeSniffer\Files\File     $phpcsFile   The file being reported on.
-     * @param bool                            $showSources Show sources?
-     * @param int                             $width       Maximum allowed line width.
-     *
-     * @return bool
-     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
-     */
-    public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
-    {
-        $errors = $phpcsFile->getFixableCount();
-        if ($errors !== 0) {
-            if (PHP_CODESNIFFER_VERBOSITY > 0) {
-                ob_end_clean();
-                $startTime = microtime(true);
-                echo "\t=> Fixing file: $errors/$errors violations remaining";
-                if (PHP_CODESNIFFER_VERBOSITY > 1) {
-                    echo PHP_EOL;
-                }
-            }
-
-            $fixed = $phpcsFile->fixer->fixFile();
-        }
-
-        if ($phpcsFile->config->stdin === true) {
-            // Replacing STDIN, so output current file to STDOUT
-            // even if nothing was fixed. Exit here because we
-            // can't process any more than 1 file in this setup.
-            $fixedContent = $phpcsFile->fixer->getContents();
-            throw new DeepExitException($fixedContent, 1);
-        }
-
-        if ($errors === 0) {
-            return false;
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            if ($fixed === false) {
-                echo 'ERROR';
-            } else {
-                echo 'DONE';
-            }
-
-            $timeTaken = ((microtime(true) - $startTime) * 1000);
-            if ($timeTaken < 1000) {
-                $timeTaken = round($timeTaken);
-                echo " in {$timeTaken}ms".PHP_EOL;
-            } else {
-                $timeTaken = round(($timeTaken / 1000), 2);
-                echo " in $timeTaken secs".PHP_EOL;
-            }
-        }
-
-        if ($fixed === true) {
-            // The filename in the report may be truncated due to a basepath setting
-            // but we are using it for writing here and not display,
-            // so find the correct path if basepath is in use.
-            $newFilename = $report['filename'].$phpcsFile->config->suffix;
-            if ($phpcsFile->config->basepath !== null) {
-                $newFilename = $phpcsFile->config->basepath.DIRECTORY_SEPARATOR.$newFilename;
-            }
-
-            $newContent = $phpcsFile->fixer->getContents();
-            file_put_contents($newFilename, $newContent);
-
-            if (PHP_CODESNIFFER_VERBOSITY > 0) {
-                if ($newFilename === $report['filename']) {
-                    echo "\t=> File was overwritten".PHP_EOL;
-                } else {
-                    echo "\t=> Fixed file written to ".basename($newFilename).PHP_EOL;
-                }
-            }
-        }
-
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            ob_start();
-        }
-
-        $errorCount   = $phpcsFile->getErrorCount();
-        $warningCount = $phpcsFile->getWarningCount();
-        $fixableCount = $phpcsFile->getFixableCount();
-        $fixedCount   = ($errors - $fixableCount);
-        echo $report['filename'].">>$errorCount>>$warningCount>>$fixableCount>>$fixedCount".PHP_EOL;
-
-        return $fixed;
-
-    }//end generateFileReport()
-
-
-    /**
-     * Prints a summary of fixed files.
-     *
-     * @param string $cachedData    Any partial report data that was returned from
-     *                              generateFileReport during the run.
-     * @param int    $totalFiles    Total number of files processed during the run.
-     * @param int    $totalErrors   Total number of errors found during the run.
-     * @param int    $totalWarnings Total number of warnings found during the run.
-     * @param int    $totalFixable  Total number of problems that can be fixed.
-     * @param bool   $showSources   Show sources?
-     * @param int    $width         Maximum allowed line width.
-     * @param bool   $interactive   Are we running in interactive mode?
-     * @param bool   $toScreen      Is the report being printed to screen?
-     *
-     * @return void
-     */
-    public function generate(
-        $cachedData,
-        $totalFiles,
-        $totalErrors,
-        $totalWarnings,
-        $totalFixable,
-        $showSources=false,
-        $width=80,
-        $interactive=false,
-        $toScreen=true
-    ) {
-        $lines = explode(PHP_EOL, $cachedData);
-        array_pop($lines);
-
-        if (empty($lines) === true) {
-            if (($totalErrors + $totalWarnings) === 0) {
-                echo PHP_EOL.'No violations were found'.PHP_EOL;
-            } else {
-                echo PHP_EOL.'No fixable errors were found'.PHP_EOL;
-            }
-
-            return;
-        }
-
-        $reportFiles = [];
-        $maxLength   = 0;
-        $totalFixed  = 0;
-        $failures    = 0;
-
-        foreach ($lines as $line) {
-            $parts   = explode('>>', $line);
-            $fileLen = strlen($parts[0]);
-            $reportFiles[$parts[0]] = [
-                'errors'   => $parts[1],
-                'warnings' => $parts[2],
-                'fixable'  => $parts[3],
-                'fixed'    => $parts[4],
-                'strlen'   => $fileLen,
-            ];
-
-            $maxLength = max($maxLength, $fileLen);
-
-            $totalFixed += $parts[4];
-
-            if ($parts[3] > 0) {
-                $failures++;
-            }
-        }
-
-        $width = min($width, ($maxLength + 21));
-        $width = max($width, 70);
-
-        echo PHP_EOL."\033[1m".'PHPCBF RESULT SUMMARY'."\033[0m".PHP_EOL;
-        echo str_repeat('-', $width).PHP_EOL;
-        echo "\033[1m".'FILE'.str_repeat(' ', ($width - 20)).'FIXED  REMAINING'."\033[0m".PHP_EOL;
-        echo str_repeat('-', $width).PHP_EOL;
-
-        foreach ($reportFiles as $file => $data) {
-            $padding = ($width - 18 - $data['strlen']);
-            if ($padding < 0) {
-                $file    = '...'.substr($file, (($padding * -1) + 3));
-                $padding = 0;
-            }
-
-            echo $file.str_repeat(' ', $padding).'  ';
-
-            if ($data['fixable'] > 0) {
-                echo "\033[31mFAILED TO FIX\033[0m".PHP_EOL;
-                continue;
-            }
-
-            $remaining = ($data['errors'] + $data['warnings']);
-
-            if ($data['fixed'] !== 0) {
-                echo $data['fixed'];
-                echo str_repeat(' ', (7 - strlen((string) $data['fixed'])));
-            } else {
-                echo '0      ';
-            }
-
-            if ($remaining !== 0) {
-                echo $remaining;
-            } else {
-                echo '0';
-            }
-
-            echo PHP_EOL;
-        }//end foreach
-
-        echo str_repeat('-', $width).PHP_EOL;
-        echo "\033[1mA TOTAL OF $totalFixed ERROR";
-        if ($totalFixed !== 1) {
-            echo 'S';
-        }
-
-        $numFiles = count($reportFiles);
-        echo ' WERE FIXED IN '.$numFiles.' FILE';
-        if ($numFiles !== 1) {
-            echo 'S';
-        }
-
-        echo "\033[0m";
-
-        if ($failures > 0) {
-            echo PHP_EOL.str_repeat('-', $width).PHP_EOL;
-            echo "\033[1mPHPCBF FAILED TO FIX $failures FILE";
-            if ($failures !== 1) {
-                echo 'S';
-            }
-
-            echo "\033[0m";
-        }
-
-        echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL;
-
-        if ($toScreen === true && $interactive === false) {
-            Timing::printRunTime();
-        }
-
-    }//end generate()
-
-
-}//end class