Merge pull request #83 from VincentLanglet/unused

Lot of refactoring

Author: VincentLanglet

SymfonyCustom/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -10,36 +10,28 @@
 class ClassDeclarationSniff
 {
     /**
-     * @return array
+     * @return int[]
      */
-    public function register()
+    public function register(): array
     {
-        return [
-            T_CLASS,
-            T_INTERFACE,
-            T_TRAIT,
-        ];
+        return [T_CLASS, T_INTERFACE, T_TRAIT];
     }
 
     /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The file being scanned.
-     * @param int  $stackPtr  The position of the current token in the stack passed in $tokens.
-     *
-     * @return void
+     * @param File $phpcsFile
+     * @param int  $stackPtr
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): void
     {
         // Just in case.
         $tokens = $phpcsFile->getTokens();
         $openingBrace = $tokens[$stackPtr]['scope_opener'];
 
-        if (isset($openingBrace) === false) {
+        if (!isset($openingBrace)) {
             return;
         }
 
-        $nextElement = $phpcsFile->findNext([T_WHITESPACE], $openingBrace + 1, null, true);
+        $nextElement = $phpcsFile->findNext(T_WHITESPACE, $openingBrace + 1, null, true);
 
         if ($tokens[$openingBrace]['line'] + 1 < $tokens[$nextElement]['line']) {
             $fix = $phpcsFile->addFixableError(
@@ -48,7 +40,7 @@ public function process(File $phpcsFile, $stackPtr)
                 'Invalid'
             );
 
-            if (true === $fix) {
+            if ($fix) {
                 $phpcsFile->fixer->replaceToken($openingBrace + 1, '');
             }
         }

SymfonyCustom/Sniffs/Classes/ClassDeclarationSniff.php

@@ -6,32 +6,23 @@
 use PHP_CodeSniffer\Sniffs\Sniff;
 
 /**
- * Throws warnings if properties are declared after methods
+ * Throws error if properties are declared after methods
  */
 class PropertyDeclarationSniff implements Sniff
 {
     /**
-     * Returns an array of tokens this test wants to listen for.
-     *
-     * @return array
+     * @return int[]
      */
-    public function register()
+    public function register(): array
     {
-        return [
-            T_CLASS,
-        ];
+        return [T_CLASS];
     }
 
     /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The file being scanned.
-     * @param int  $stackPtr  The position of the current token
-     *                        in the stack passed in $tokens.
-     *
-     * @return void
+     * @param File $phpcsFile
+     * @param int  $stackPtr
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): void
     {
         $tokens = $phpcsFile->getTokens();
 
@@ -40,31 +31,15 @@ public function process(File $phpcsFile, $stackPtr)
             $end = $tokens[$stackPtr]['scope_closer'];
         }
 
-        $scope = $phpcsFile->findNext(
-            T_FUNCTION,
-            $stackPtr,
-            $end
-        );
+        $scope = $phpcsFile->findNext(T_FUNCTION, $stackPtr, $end);
 
-        $wantedTokens = [
-            T_PUBLIC,
-            T_PROTECTED,
-            T_PRIVATE,
-        ];
+        $wantedTokens = [T_PUBLIC, T_PROTECTED, T_PRIVATE];
 
         while ($scope) {
-            $scope = $phpcsFile->findNext(
-                $wantedTokens,
-                $scope + 1,
-                $end
-            );
+            $scope = $phpcsFile->findNext($wantedTokens, $scope + 1, $end);
 
             if ($scope && T_VARIABLE === $tokens[$scope + 2]['code']) {
-                $phpcsFile->addError(
-                    'Declare class properties before methods',
-                    $scope,
-                    'Invalid'
-                );
+                $phpcsFile->addError('Declare class properties before methods', $scope, 'Invalid');
             }
         }
     }

SymfonyCustom/Sniffs/Classes/PropertyDeclarationSniff.php

@@ -8,12 +8,10 @@
  * Parses and verifies the doc comments for classes.
  *
  * Verifies that :
- * <ul>
- *  <li>A doc comment exists.</li>
- *  <li>Check the order of the tags.</li>
- *  <li>Check the indentation of each tag.</li>
- *  <li>Check required and optional tags and the format of their content.</li>
- * </ul>
+ *  - A doc comment exists.
+ *  - Check the order of the tags.
+ *  - Check the indentation of each tag.
+ *  - Check required and optional tags and the format of their content.
  */
 class ClassCommentSniff extends PEARClassCommentSniff
 {

SymfonyCustom/Sniffs/Commenting/ClassCommentSniff.php

@@ -11,40 +11,26 @@
 class DocCommentForbiddenTagsSniff implements Sniff
 {
     /**
-     * A list of PHPDoc tags that are forbidden.
-     *
      * @var array
      */
-    public $tags = [
-        '@package',
-        '@subpackage',
-    ];
+    public $forbiddenTags = ['@package', '@subpackage'];
 
     /**
-     * A list of tokenizers this sniff supports.
-     *
      * @return array
      */
-    public function register()
+    public function register(): array
     {
-        return [
-            T_DOC_COMMENT_TAG,
-        ];
+        return [T_DOC_COMMENT_TAG];
     }
 
     /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile All the tokens found in the document.
-     * @param int  $stackPtr  The position of the current token in
-     *                        the stack passed in $tokens.
-     *
-     * @return void
+     * @param File $phpcsFile
+     * @param int  $stackPtr
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): void
     {
         $tokens = $phpcsFile->getTokens();
-        if (in_array($tokens[$stackPtr]['content'], $this->tags)) {
+        if (in_array($tokens[$stackPtr]['content'], $this->forbiddenTags)) {
             $phpcsFile->addError(
                 'The %s annotation is forbidden to use',
                 $stackPtr,

SymfonyCustom/Sniffs/Commenting/DocCommentForbiddenTagsSniff.php

@@ -4,72 +4,26 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use SymfonyCustom\Sniffs\SniffHelper;
 
 /**
  * Throws errors if comments are not grouped by type with one blank line between them.
  */
 class DocCommentGroupSameTypeSniff implements Sniff
 {
     /**
-     * A list of PHPDoc tags that are checked.
-     *
-     * @var array
-     */
-    public $tags = [
-        '@api',
-        '@author',
-        '@category',
-        '@copyright',
-        '@covers',
-        '@dataProvider',
-        '@deprecated',
-        '@example',
-        '@filesource',
-        '@global',
-        '@ignore',
-        '@internal',
-        '@license',
-        '@link',
-        '@method',
-        '@package',
-        '@param',
-        '@property',
-        '@property-read',
-        '@property-write',
-        '@required',
-        '@return',
-        '@see',
-        '@since',
-        '@source',
-        '@subpackage',
-        '@throws',
-        '@todo',
-        '@uses',
-        '@var',
-        '@version',
-    ];
-
-    /**
-     * A list of tokenizers this sniff supports.
-     *
      * @return array
      */
-    public function register()
+    public function register(): array
     {
-        return [
-            T_DOC_COMMENT_OPEN_TAG,
-        ];
+        return [T_DOC_COMMENT_OPEN_TAG];
     }
 
     /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile All the tokens found in the document.
-     * @param int  $stackPtr  The position of the current token in the stack passed in $tokens.
-     *
-     * @return void
+     * @param File $phpcsFile
+     * @param int  $stackPtr
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): void
     {
         $tokens = $phpcsFile->getTokens();
 
@@ -106,8 +60,9 @@ public function process(File $phpcsFile, $stackPtr)
             }
 
             if (isset($previousElement) && $previousLine >= 0) {
-                $currentIsCustom = !in_array($currentType, $this->tags);
-                $previousIsCustom = ('' !== $previousType) && !in_array($previousType, $this->tags);
+                $currentIsCustom = !in_array($currentType, SniffHelper::TAGS);
+                $previousIsCustom = '' !== $previousType
+                    && !in_array($previousType, SniffHelper::TAGS);
 
                 if (($previousType === $currentType) || ($currentIsCustom && $previousIsCustom)) {
                     if ($previousLine !== $commentTagLine - 1) {
@@ -125,7 +80,7 @@ public function process(File $phpcsFile, $stackPtr)
                             );
                         }
 
-                        if (true === $fix) {
+                        if ($fix) {
                             $phpcsFile->fixer->beginChangeset();
                             $this->removeLines(
                                 $phpcsFile,
@@ -144,7 +99,7 @@ public function process(File $phpcsFile, $stackPtr)
                             'DifferentType'
                         );
 
-                        if (true === $fix) {
+                        if ($fix) {
                             $phpcsFile->fixer->beginChangeset();
 
                             if ($previousLine === $commentTagLine - 1) {
@@ -184,18 +139,12 @@ public function process(File $phpcsFile, $stackPtr)
     }
 
     /**
-     * Remove all tokens on lines (inclusively).
-     *
-     * Note: this method does not start or end changeset.
-     *
-     * @param File $phpcsFile File to make changes in
-     * @param int  $fromPtr   Start searching tokens from here
-     * @param int  $fromLine  First line to delete tokens from
-     * @param int  $toLine    Last line to delete tokens from
-     *
-     * @return void
+     * @param File $phpcsFile
+     * @param int  $fromPtr
+     * @param int  $fromLine
+     * @param int  $toLine
      */
-    protected function removeLines(File $phpcsFile, $fromPtr, $fromLine, $toLine)
+    private function removeLines(File $phpcsFile, int $fromPtr, int $fromLine, int $toLine): void
     {
         $tokens = $phpcsFile->getTokens();