update to phpcs 3.x

Author: mmoll

.travis.yml

@@ -11,12 +11,12 @@ php:
 before_script:
   - phpenv config-rm xdebug.ini
   - composer install
-  - mkdir -p vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/MO4
-  - cp ruleset.xml vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/MO4/
-  - cp -R Sniffs vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/MO4/
-  - cp -R Tests vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/MO4/
-  - (cd vendor/squizlabs/php_codesniffer/CodeSniffer/Standards ; git clone https://github.com/xalopp/symfony-coding-standard.git Symfony)
+  - mkdir -p vendor/squizlabs/php_codesniffer/src/Standards/MO4
+  - cp ruleset.xml vendor/squizlabs/php_codesniffer/src/Standards/MO4/
+  - cp -R Sniffs vendor/squizlabs/php_codesniffer/src/Standards/MO4/
+  - cp -R Tests vendor/squizlabs/php_codesniffer/src/Standards/MO4/
 
 script:
   - (cd vendor/squizlabs/php_codesniffer ; ../../bin/phpunit --filter MO4)
-  - ./vendor/squizlabs/php_codesniffer/scripts/phpcs ./vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/MO4/Sniffs --standard=PHPCS --report=summary -np
+  - (mkdir -p vendor/squizlabs/php_codesniffer/src/Standards/PHPCS ; cp vendor/squizlabs/php_codesniffer/phpcs.xml.dist vendor/squizlabs/php_codesniffer/src/Standards/PHPCS/ruleset.xml)
+  - ./vendor/squizlabs/php_codesniffer/bin/phpcs ./vendor/squizlabs/php_codesniffer/src/Standards/MO4/Sniffs --standard=PHPCS --report=summary -np

Sniffs/Commenting/PropertyCommentSniff.php

@@ -13,6 +13,11 @@
  * @link     https://github.com/Mayflower/mo4-coding-standard
  */
 
+namespace MO4\Sniffs\Commenting;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\AbstractScopeSniff;
+
 /**
  * Alphabetical Use Statements sniff.
  *
@@ -25,8 +30,7 @@
  * @license   http://spdx.org/licenses/MIT MIT License
  * @link      https://github.com/Mayflower/mo4-coding-standard
  */
-class MO4_Sniffs_Commenting_PropertyCommentSniff
-    extends PHP_CodeSniffer_Standards_AbstractScopeSniff
+class PropertyCommentSniff extends AbstractScopeSniff
 {
     /**
      * A list of tokenizers this sniff supports.
@@ -40,20 +44,20 @@ class MO4_Sniffs_Commenting_PropertyCommentSniff
      *
      * @var array
      */
-    private $_tokenTypes = array(
-                            T_VARIABLE,
-                            T_CONST,
-                           );
+    private $myTokenTypes = array(
+                             T_VARIABLE,
+                             T_CONST,
+                            );
 
 
     /**
      * Construct PropertyCommentSniff
      */
-    function __construct()
+    public function __construct()
     {
         $scopes = array(T_CLASS);
 
-        parent::__construct($scopes, $this->_tokenTypes, true);
+        parent::__construct($scopes, $this->myTokenTypes, true);
 
     }//end __construct()
 
@@ -62,17 +66,17 @@ function __construct()
      * Processes a token that is found within the scope that this test is
      * listening to.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found.
-     * @param int                  $stackPtr  The position in the stack where this
-     *                                        token was found.
-     * @param int                  $currScope The position in the tokens array that
-     *                                        opened the scope that this test is
-     *                                        listening for.
+     * @param File $phpcsFile The file where this token was found.
+     * @param int  $stackPtr  The position in the stack where this
+     *                        token was found.
+     * @param int  $currScope The position in the tokens array that
+     *                        opened the scope that this test is
+     *                        listening for.
      *
      * @return void
      */
     protected function processTokenWithinScope(
-        PHP_CodeSniffer_File $phpcsFile,
+        File $phpcsFile,
         $stackPtr,
         $currScope
     ) {
@@ -143,7 +147,7 @@ protected function processTokenWithinScope(
             // and has a variable preceding it in the same line.
             // If yes, it doesn't count.
             $firstTokenOnLine = $phpcsFile->findFirstOnLine(
-                $this->_tokenTypes,
+                $this->myTokenTypes,
                 $commentEnd
             );
             if ($tokens[$commentStart]['line'] === $tokens[$commentEnd]['line']
@@ -212,7 +216,7 @@ protected function processTokenWithinScope(
             // a variable definition on the same line.
             // If yes, it doesn't count.
             $firstOnLine = $phpcsFile->findFirstOnLine(
-                $this->_tokenTypes,
+                $this->myTokenTypes,
                 $commentEnd
             );
 
@@ -234,4 +238,19 @@ protected function processTokenWithinScope(
     }//end processTokenWithinScope()
 
 
+    /**
+     * Process tokens outside scope.
+     *
+     * @param File $phpcsFile The file where this token was found.
+     * @param int  $stackPtr  The position in the stack where this
+     *                        token was found.
+     *
+     * @return void
+     */
+    protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
+    {
+
+    }//end processTokenOutsideScope()
+
+
 }//end class

Sniffs/Formatting/AlphabeticalUseStatementsSniff.php

@@ -27,73 +27,79 @@
  * @license   http://spdx.org/licenses/MIT MIT License
  * @link      https://github.com/Mayflower/mo4-coding-standard
  */
-class MO4_Sniffs_Formatting_AlphabeticalUseStatementsSniff
-    extends PSR2_Sniffs_Namespaces_UseDeclarationSniff
+
+namespace MO4\Sniffs\Formatting;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\UseDeclarationSniff;
+use PHP_CodeSniffer\Util\Tokens as PHP_CodeSniffer_Tokens;
+
+class AlphabeticalUseStatementsSniff extends UseDeclarationSniff
 {
     /**
      * Last import seen in group
      *
      * @var string
      */
-    private $_lastImport = '';
+    private $lastImport = '';
 
     /**
      * Line number of the last seen use statement
      *
-     * @var int
+     * @var integer
      */
-    private $_lastLine = -1;
+    private $lastLine = -1;
 
     /**
      * Current file
      *
      * @var string
      */
-    private $_currentFile = null;
+    private $currentFile = null;
 
 
     /**
      * Processes this test, when one of its tokens is encountered.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token in
-     *                                        the stack passed in $tokens.
+     * @param File $phpcsFile The file being scanned.
+     * @param int  $stackPtr  The position of the current token in
+     *                        the stack passed in $tokens.
      *
      * @return void
      */
-    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr)
     {
         parent::process($phpcsFile, $stackPtr);
 
-        if ($this->_currentFile !== $phpcsFile->getFilename()) {
-            $this->_lastLine    = -1;
-            $this->_lastImport  = '';
-            $this->_currentFile = $phpcsFile->getFilename();
+        if ($this->currentFile !== $phpcsFile->getFilename()) {
+            $this->lastLine    = -1;
+            $this->lastImport  = '';
+            $this->currentFile = $phpcsFile->getFilename();
         }
 
         $tokens = $phpcsFile->getTokens();
         $line   = $tokens[$stackPtr]['line'];
 
         // Ignore function () use () {...}.
-        $isNonImportUse = $this->_checkIsNonImportUse($phpcsFile, $stackPtr);
+        $isNonImportUse = $this->checkIsNonImportUse($phpcsFile, $stackPtr);
         if (true === $isNonImportUse) {
             return;
         }
 
-        $currentImportArr = $this->_getUseImport($phpcsFile, $stackPtr);
+        $currentImportArr = $this->getUseImport($phpcsFile, $stackPtr);
         $currentPtr       = $currentImportArr['startPtr'];
         $currentImport    = $currentImportArr['content'];
 
-        if (($this->_lastLine + 1) < $line) {
-            $this->_lastLine   = $line;
-            $this->_lastImport = $currentImport;
+        if (($this->lastLine + 1) < $line) {
+            $this->lastLine   = $line;
+            $this->lastImport = $currentImport;
 
             return;
         }
 
         $fixable = false;
-        if ($this->_lastImport !== ''
-            && strcmp($this->_lastImport, $currentImport) > 0
+        if ($this->lastImport !== ''
+            && strcmp($this->lastImport, $currentImport) > 0
         ) {
             $msg     = 'USE statements must be sorted alphabetically';
             $code    = 'MustBeSortedAlphabetically';
@@ -103,31 +109,31 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
         if (true === $fixable) {
             // Find the correct position in current use block.
             $newDestinationPtr
-                = $this->_findNewDestination($phpcsFile, $stackPtr, $currentImport);
+                = $this->findNewDestination($phpcsFile, $stackPtr, $currentImport);
 
-            $currentUseStr = $this->_getUseStatementAsString($phpcsFile, $stackPtr);
+            $currentUseStr = $this->getUseStatementAsString($phpcsFile, $stackPtr);
 
             $phpcsFile->fixer->beginChangeset();
             $phpcsFile->fixer->addContentBefore($newDestinationPtr, $currentUseStr);
-            $this->_fixerClearLine($phpcsFile, $stackPtr);
+            $this->fixerClearLine($phpcsFile, $stackPtr);
             $phpcsFile->fixer->endChangeset();
         }//end if
 
-        $this->_lastImport = $currentImport;
-        $this->_lastLine   = $line;
+        $this->lastImport = $currentImport;
+        $this->lastLine   = $line;
 
     }//end process()
 
 
     /**
      * Get the import class name for use statement pointed by $stackPtr.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile PHP CS File
-     * @param int                  $stackPtr  pointer
+     * @param File $phpcsFile PHP CS File
+     * @param int  $stackPtr  pointer
      *
      * @return array
      */
-    private function _getUseImport(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    private function getUseImport(File $phpcsFile, $stackPtr)
     {
         $importTokens = array(
                          T_NS_SEPARATOR,
@@ -148,19 +154,19 @@ private function _getUseImport(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                 'content'  => $import,
                );
 
-    }//end _getUseImport()
+    }//end getUseImport()
 
 
     /**
      * Get the full use statement as string, including trailing white space.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile PHP CS File
-     * @param int                  $stackPtr  pointer
+     * @param File $phpcsFile PHP CS File
+     * @param int  $stackPtr  pointer
      *
      * @return string
      */
-    private function _getUseStatementAsString(
-        PHP_CodeSniffer_File $phpcsFile,
+    private function getUseStatementAsString(
+        File $phpcsFile,
         $stackPtr
     ) {
         $tokens = $phpcsFile->getTokens();
@@ -175,19 +181,19 @@ private function _getUseStatementAsString(
 
         return $useStr;
 
-    }//end _getUseStatementAsString()
+    }//end getUseStatementAsString()
 
 
     /**
      * Check if "use" token is not used for import.
      * E.g. function () use () {...}.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile PHP CS File
-     * @param int                  $stackPtr  pointer
+     * @param File $phpcsFile PHP CS File
+     * @param int  $stackPtr  pointer
      *
      * @return bool
      */
-    private function _checkIsNonImportUse(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    private function checkIsNonImportUse(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
@@ -210,20 +216,20 @@ private function _checkIsNonImportUse(PHP_CodeSniffer_File $phpcsFile, $stackPtr
 
         return false;
 
-    }//end _checkIsNonImportUse()
+    }//end checkIsNonImportUse()
 
 
     /**
      * Replace all the token in same line as the element pointed to by $stackPtr
      * the by the empty string.
      * This will delete the line.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile PHP CS file
-     * @param int                  $stackPtr  pointer
+     * @param File $phpcsFile PHP CS file
+     * @param int  $stackPtr  pointer
      *
      * @return void
      */
-    private function _fixerClearLine(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    private function fixerClearLine(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
         $line   = $tokens[$stackPtr]['line'];
@@ -236,21 +242,21 @@ private function _fixerClearLine(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             $phpcsFile->fixer->replaceToken($i, '');
         }
 
-    }//end _fixerClearLine()
+    }//end fixerClearLine()
 
 
     /**
      * Find a new destination pointer for the given import string in current
      * use block.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile PHP CS File
-     * @param int                  $stackPtr  pointer
-     * @param string               $import    import string requiring new position
+     * @param File   $phpcsFile PHP CS File
+     * @param int    $stackPtr  pointer
+     * @param string $import    import string requiring new position
      *
      * @return int
      */
-    private function _findNewDestination(
-        PHP_CodeSniffer_File $phpcsFile,
+    private function findNewDestination(
+        File $phpcsFile,
         $stackPtr,
         $import
     ) {
@@ -272,14 +278,14 @@ private function _findNewDestination(
             }
 
             $prevLine      = $tokens[$prevPtr]['line'];
-            $prevImportArr = $this->_getUseImport($phpcsFile, $prevPtr);
+            $prevImportArr = $this->getUseImport($phpcsFile, $prevPtr);
         } while ($prevLine === ($line - 1)
             && (strcmp($prevImportArr['content'], $import) > 0)
         );
 
         return $ptr;
 
-    }//end _findNewDestination()
+    }//end findNewDestination()
 
 
 }//end class