Upgraded PHP Code sniff to 2.8.1, WPCS to 0.11

Author: aprokopenko

justcoded/JustcodedWordpress/Sniffs/NamingConventions/ValidVariableNameSniff.php

@@ -33,7 +33,7 @@ class JustcodedWordpress_Sniffs_NamingConventions_ValidVariableNameSniff extends
 	 *
 	 * @var string[]
 	 */
-	public $customVariablesWhitelist = array(
+	public $customPropertiesWhitelist = array(
 		'SLUG',
 		'TITLE',
 	);

justcoded/JustcodedWordpress/ruleset.xml

@@ -7,6 +7,7 @@
 
 	<rule ref="WordPress-Core">
 		<exclude name="WordPress.WP.I18n.NonSingularStringLiteralDomain"/>
+		<exclude name="WordPress.WP.I18n.MissingTranslatorsComment"/>
 		<exclude name="WordPress.WP.I18n.MismatchedPlaceholders"/>
 		<exclude name="WordPress.WP.I18n.MissingSingularPlaceholders"/>
 

phpcs/.gitattributes

@@ -8,3 +8,6 @@
 /CodeSniffer/Standards/Zend/Tests export-ignore
 .travis.yml export-ignore
 package.xml export-ignore
+phpunit.xml.dist export-ignore
+php5-testingConfig.ini export-ignore
+php7-testingConfig.ini export-ignore

phpcs/CodeSniffer.php

@@ -73,7 +73,7 @@ class PHP_CodeSniffer
      *
      * @var string
      */
-    const VERSION = '2.7.1';
+    const VERSION = '2.8.1';
 
     /**
      * Package stability; either stable, beta or alpha.

phpcs/CodeSniffer/CLI.php

@@ -1013,6 +1013,7 @@ public function process($values=array())
                 $this->printUsage();
                 exit(2);
             } else {
+                $this->values['stdin'] = $fileContents;
                 $phpcs->processFile('STDIN', $fileContents);
             }
         }

phpcs/CodeSniffer/File.php

@@ -602,7 +602,10 @@ public function start($contents=null)
         // If short open tags are off but the file being checked uses
         // short open tags, the whole content will be inline HTML
         // and nothing will be checked. So try and handle this case.
-        if ($foundCode === false && $this->tokenizerType === 'PHP') {
+        // We don't show this error for STDIN because we can't be sure the content
+        // actually came directly from the user. It could be something like
+        // refs from a Git pre-push hook.
+        if ($foundCode === false && $this->tokenizerType === 'PHP' && $this->_file !== 'STDIN') {
             $shortTags = (bool) ini_get('short_open_tag');
             if ($shortTags === false) {
                 $error = 'No PHP code was found in this file and short open tags are not allowed by this install of PHP. This file may be using short open tags but PHP does not allow them.';
@@ -1942,7 +1945,9 @@ private static function _recurseScopeMap(
             // scope tokens. E.g., if (1) 1; 1 ? (1 ? 1 : 1) : 1;
             // If an IF statement below this one has an opener but no
             // keyword, the opener will be incorrectly assigned to this IF statement.
-            if (($currType === T_IF || $currType === T_ELSE)
+            // The same case also applies to USE statements, which don't have to have
+            // openers, so a following USE statement can cause an incorrect brace match.
+            if (($currType === T_IF || $currType === T_ELSE || $currType === T_USE)
                 && $opener === null
                 && $tokens[$i]['code'] === T_SEMICOLON
             ) {
@@ -2645,25 +2650,23 @@ private static function _createLevelMap(&$tokens, $tokenizer, $eolChar)
 
 
     /**
-     * Returns the declaration names for T_CLASS, T_INTERFACE and T_FUNCTION tokens.
+     * Returns the declaration names for classes, interfaces, and functions.
      *
      * @param int $stackPtr The position of the declaration token which
      *                      declared the class, interface or function.
      *
      * @return string|null The name of the class, interface or function.
-     *                     or NULL if the function is a closure.
+     *                     or NULL if the function or class is anonymous.
      * @throws PHP_CodeSniffer_Exception If the specified token is not of type
-     *                                   T_FUNCTION, T_CLASS or T_INTERFACE.
+     *                                   T_FUNCTION, T_CLASS, T_ANON_CLASS,
+     *                                   or T_INTERFACE.
      */
     public function getDeclarationName($stackPtr)
     {
         $tokenCode = $this->_tokens[$stackPtr]['code'];
-        if ($tokenCode !== T_FUNCTION
-            && $tokenCode !== T_CLASS
-            && $tokenCode !== T_INTERFACE
-            && $tokenCode !== T_TRAIT
-        ) {
-            throw new PHP_CodeSniffer_Exception('Token type "'.$this->_tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
+
+        if ($tokenCode === T_ANON_CLASS) {
+            return null;
         }
 
         if ($tokenCode === T_FUNCTION
@@ -2672,6 +2675,14 @@ public function getDeclarationName($stackPtr)
             return null;
         }
 
+        if ($tokenCode !== T_FUNCTION
+            && $tokenCode !== T_CLASS
+            && $tokenCode !== T_INTERFACE
+            && $tokenCode !== T_TRAIT
+        ) {
+            throw new PHP_CodeSniffer_Exception('Token type "'.$this->_tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
+        }
+
         $content = null;
         for ($i = $stackPtr; $i < $this->numTokens; $i++) {
             if ($this->_tokens[$i]['code'] === T_STRING) {
@@ -2731,46 +2742,53 @@ public function isAnonymousFunction($stackPtr)
 
 
     /**
-     * Returns the method parameters for the specified T_FUNCTION token.
+     * Returns the method parameters for the specified function token.
      *
      * Each parameter is in the following format:
      *
      * <code>
      *   0 => array(
+     *         'token'             => int,     // The position of the var in the token stack.
      *         'name'              => '$var',  // The variable name.
-     *         'pass_by_reference' => false,   // Passed by reference.
-     *         'type_hint'         => string,  // Type hint for array or custom type
+     *         'content'           => string,  // The full content of the variable definition.
+     *         'pass_by_reference' => boolean, // Is the variable passed by reference?
+     *         'type_hint'         => string,  // The type hint for the variable.
+     *         'nullable_type'     => boolean, // Is the variable using a nullable type?
      *        )
      * </code>
      *
      * Parameters with default values have an additional array index of
      * 'default' with the value of the default as a string.
      *
-     * @param int $stackPtr The position in the stack of the T_FUNCTION token
+     * @param int $stackPtr The position in the stack of the function token
      *                      to acquire the parameters for.
      *
      * @return array
      * @throws PHP_CodeSniffer_Exception If the specified $stackPtr is not of
-     *                                   type T_FUNCTION.
+     *                                   type T_FUNCTION or T_CLOSURE.
      */
     public function getMethodParameters($stackPtr)
     {
-        if ($this->_tokens[$stackPtr]['code'] !== T_FUNCTION) {
-            throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_FUNCTION');
+        if ($this->_tokens[$stackPtr]['code'] !== T_FUNCTION
+            && $this->_tokens[$stackPtr]['code'] !== T_CLOSURE
+        ) {
+            throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_FUNCTION or T_CLOSURE');
         }
 
         $opener = $this->_tokens[$stackPtr]['parenthesis_opener'];
         $closer = $this->_tokens[$stackPtr]['parenthesis_closer'];
 
         $vars            = array();
         $currVar         = null;
+        $paramStart      = ($opener + 1);
         $defaultStart    = null;
         $paramCount      = 0;
         $passByReference = false;
         $variableLength  = false;
         $typeHint        = '';
+        $nullableType    = false;
 
-        for ($i = ($opener + 1); $i <= $closer; $i++) {
+        for ($i = $paramStart; $i <= $closer; $i++) {
             // Check to see if this token has a parenthesis or bracket opener. If it does
             // it's likely to be an array which might have arguments in it. This
             // could cause problems in our parsing below, so lets just skip to the
@@ -2801,7 +2819,15 @@ public function getMethodParameters($stackPtr)
                 break;
             case T_ARRAY_HINT:
             case T_CALLABLE:
-                $typeHint = $this->_tokens[$i]['content'];
+                $typeHint .= $this->_tokens[$i]['content'];
+                break;
+            case T_SELF:
+            case T_PARENT:
+            case T_STATIC:
+                // Self is valid, the others invalid, but were probably intended as type hints.
+                if (isset($defaultStart) === false) {
+                    $typeHint .= $this->_tokens[$i]['content'];
+                }
                 break;
             case T_STRING:
                 // This is a string, so it may be a type hint, but it could
@@ -2838,6 +2864,12 @@ public function getMethodParameters($stackPtr)
                     $typeHint .= $this->_tokens[$i]['content'];
                 }
                 break;
+            case T_NULLABLE:
+                if ($defaultStart === null) {
+                    $nullableType = true;
+                    $typeHint    .= $this->_tokens[$i]['content'];
+                }
+                break;
             case T_CLOSE_PARENTHESIS:
             case T_COMMA:
                 // If it's null, then there must be no parameters for this
@@ -2846,26 +2878,27 @@ public function getMethodParameters($stackPtr)
                     continue;
                 }
 
-                $vars[$paramCount]         = array();
-                $vars[$paramCount]['name'] = $this->_tokens[$currVar]['content'];
+                $vars[$paramCount]            = array();
+                $vars[$paramCount]['token']   = $currVar;
+                $vars[$paramCount]['name']    = $this->_tokens[$currVar]['content'];
+                $vars[$paramCount]['content'] = trim($this->getTokensAsString($paramStart, ($i - $paramStart)));
 
                 if ($defaultStart !== null) {
-                    $vars[$paramCount]['default']
-                        = $this->getTokensAsString(
-                            $defaultStart,
-                            ($i - $defaultStart)
-                        );
+                    $vars[$paramCount]['default'] = trim($this->getTokensAsString($defaultStart, ($i - $defaultStart)));
                 }
 
                 $vars[$paramCount]['pass_by_reference'] = $passByReference;
                 $vars[$paramCount]['variable_length']   = $variableLength;
                 $vars[$paramCount]['type_hint']         = $typeHint;
+                $vars[$paramCount]['nullable_type']     = $nullableType;
 
                 // Reset the vars, as we are about to process the next parameter.
                 $defaultStart    = null;
+                $paramStart      = ($i + 1);
                 $passByReference = false;
                 $variableLength  = false;
                 $typeHint        = '';
+                $nullableType    = false;
 
                 $paramCount++;
                 break;
@@ -3000,6 +3033,7 @@ public function getMemberProperties($stackPtr)
         $ptr        = array_pop($conditions);
         if (isset($this->_tokens[$ptr]) === false
             || ($this->_tokens[$ptr]['code'] !== T_CLASS
+            && $this->_tokens[$ptr]['code'] !== T_ANON_CLASS
             && $this->_tokens[$ptr]['code'] !== T_TRAIT)
         ) {
             if (isset($this->_tokens[$ptr]) === true
@@ -3683,7 +3717,9 @@ public function findExtendedClassName($stackPtr)
             return false;
         }
 
-        if ($this->_tokens[$stackPtr]['code'] !== T_CLASS) {
+        if ($this->_tokens[$stackPtr]['code'] !== T_CLASS
+            && $this->_tokens[$stackPtr]['code'] !== T_ANON_CLASS
+        ) {
             return false;
         }
 
@@ -3732,7 +3768,9 @@ public function findImplementedInterfaceNames($stackPtr)
             return false;
         }
 
-        if ($this->_tokens[$stackPtr]['code'] !== T_CLASS) {
+        if ($this->_tokens[$stackPtr]['code'] !== T_CLASS
+            && $this->_tokens[$stackPtr]['code'] !== T_ANON_CLASS
+        ) {
             return false;
         }
 

phpcs/CodeSniffer/Fixer.php

@@ -243,8 +243,13 @@ public function generateDiff($filePath=null, $colors=true)
             $filePath = $this->_currentFile->getFilename();
         }
 
-        $cwd      = getcwd().DIRECTORY_SEPARATOR;
-        $filename = str_replace($cwd, '', $filePath);
+        $cwd = getcwd().DIRECTORY_SEPARATOR;
+        if (strpos($filePath, $cwd) === 0) {
+            $filename = substr($filePath, strlen($cwd));
+        } else {
+            $filename = $filePath;
+        }
+
         $contents = $this->getContents();
 
         if (function_exists('sys_get_temp_dir') === true) {
@@ -261,7 +266,9 @@ public function generateDiff($filePath=null, $colors=true)
 
         // We must use something like shell_exec() because whitespace at the end
         // of lines is critical to diff files.
-        $cmd  = "diff -u -L\"$filename\" -LPHP_CodeSniffer \"$filename\" \"$tempName\"";
+        $filename = escapeshellarg($filename);
+        $cmd      = "diff -u -L$filename -LPHP_CodeSniffer $filename \"$tempName\"";
+
         $diff = shell_exec($cmd);
 
         fclose($fixedFile);

phpcs/CodeSniffer/Reports/Gitblame.php

@@ -83,29 +83,7 @@ protected function getBlameContent($filename)
     {
         $cwd = getcwd();
 
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            echo 'Getting GIT blame info for '.basename($filename).'... ';
-        }
-
-        $fileParts = explode(DIRECTORY_SEPARATOR, $filename);
-        $found     = false;
-        $location  = '';
-        while (empty($fileParts) === false) {
-            array_pop($fileParts);
-            $location = implode($fileParts, DIRECTORY_SEPARATOR);
-            if (is_dir($location.DIRECTORY_SEPARATOR.'.git') === true) {
-                $found = true;
-                break;
-            }
-        }
-
-        if ($found === true) {
-            chdir($location);
-        } else {
-            echo 'ERROR: Could not locate .git directory '.PHP_EOL.PHP_EOL;
-            exit(2);
-        }
-
+        chdir(dirname($filename));
         $command = 'git blame --date=short "'.$filename.'" 2>&1';
         $handle  = popen($command, 'r');
         if ($handle === false) {
@@ -116,10 +94,6 @@ protected function getBlameContent($filename)
         $rawContent = stream_get_contents($handle);
         fclose($handle);
 
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            echo 'DONE'.PHP_EOL;
-        }
-
         $blames = explode("\n", $rawContent);
         chdir($cwd);
 

phpcs/CodeSniffer/Reports/Hgblame.php

@@ -84,10 +84,6 @@ protected function getBlameContent($filename)
     {
         $cwd = getcwd();
 
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            echo 'Getting MERCURIAL blame info for '.basename($filename).'... ';
-        }
-
         $fileParts = explode(DIRECTORY_SEPARATOR, $filename);
         $found     = false;
         $location  = '';
@@ -117,10 +113,6 @@ protected function getBlameContent($filename)
         $rawContent = stream_get_contents($handle);
         fclose($handle);
 
-        if (PHP_CODESNIFFER_VERBOSITY > 0) {
-            echo 'DONE'.PHP_EOL;
-        }
-
         $blames = explode("\n", $rawContent);
         chdir($cwd);
 

phpcs/CodeSniffer/Reports/Notifysend.php

@@ -82,7 +82,7 @@ public function __construct()
     {
         $path = PHP_CodeSniffer::getConfigData('notifysend_path');
         if ($path !== null) {
-            $this->path = $path;
+            $this->path = escapeshellcmd($path);
         }
 
         $timeout = PHP_CodeSniffer::getConfigData('notifysend_timeout');
@@ -246,7 +246,7 @@ protected function notifyErrors($msg)
      */
     protected function getBasicCommand()
     {
-        $cmd  = escapeshellcmd($this->path);
+        $cmd  = $this->path;
         $cmd .= ' --category dev.validate';
         $cmd .= ' -h int:transient:1';
         $cmd .= ' -t '.(int) $this->timeout;