Merge pull request #94 from VincentLanglet/refacto

Refacto

Author: VincentLanglet

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 composer.phar
+coverage/
 vendor/

SymfonyCustom/Sniffs/FixerHelper.php renamed to SymfonyCustom/Helpers/FixerHelper.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SymfonyCustom\Sniffs;
+namespace SymfonyCustom\Helpers;
 
 use PHP_CodeSniffer\Files\File;
 
@@ -58,6 +58,37 @@ public static function removeLines(File $phpcsFile, int $fromPtr, int $fromLine,
         $phpcsFile->fixer->endChangeset();
     }
 
+    /**
+     * @param File       $phpcsFile
+     * @param int        $stackPtr
+     * @param int        $expected
+     * @param int|string $found
+     */
+    public static function fixWhitespaceAfter(
+        File $phpcsFile,
+        int $stackPtr,
+        int $expected,
+        $found
+    ): void {
+        $phpcsFile->fixer->beginChangeset();
+
+        if (0 === $found) {
+            $phpcsFile->fixer->addContent($stackPtr, str_repeat(' ', $expected));
+        } else {
+            if ('newline' === $found) {
+                $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr, null, true);
+
+                for ($i = $stackPtr + 1; $i < $next; $i++) {
+                    $phpcsFile->fixer->replaceToken($i, '');
+                }
+            }
+
+            $phpcsFile->fixer->replaceToken($stackPtr + 1, str_repeat(' ', $expected));
+        }
+
+        $phpcsFile->fixer->endChangeset();
+    }
+
     /**
      * @param File       $phpcsFile
      * @param int        $stackPtr

SymfonyCustom/Sniffs/SniffHelper.php renamed to SymfonyCustom/Helpers/SniffHelper.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SymfonyCustom\Sniffs;
+namespace SymfonyCustom\Helpers;
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Util\Tokens;

SymfonyCustom/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
-use SymfonyCustom\Sniffs\FixerHelper;
+use SymfonyCustom\Helpers\FixerHelper;
 
 /**
  * A test to ensure that arrays conform to the array coding standard.
@@ -158,56 +158,40 @@ public function processSingleLineArray(File $phpcsFile, int $stackPtr, int $star
         $nextArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $start + 1, $end);
         while (false !== $nextArrow) {
             if (T_WHITESPACE !== $tokens[$nextArrow - 1]['code']) {
+                $spaceBefore = 0;
+            } else {
+                $spaceBefore = $tokens[$nextArrow - 1]['length'];
+            }
+
+            if (1 !== $spaceBefore) {
                 $fix = $phpcsFile->addFixableError(
-                    'Expected 1 space between "%s" and double arrow; 0 found',
+                    'Expected 1 space between "%s" and double arrow; %s found',
                     $nextArrow,
-                    'NoSpaceBeforeDoubleArrow',
-                    [$tokens[$nextArrow - 1]['content']]
+                    'SpaceAfterDoubleArrow',
+                    [$tokens[$nextArrow - 1]['content'], $spaceBefore]
                 );
 
                 if ($fix) {
-                    $phpcsFile->fixer->addContentBefore($nextArrow, ' ');
-                }
-            } else {
-                $spaceLength = $tokens[$nextArrow - 1]['length'];
-                if (1 !== $spaceLength) {
-                    $fix = $phpcsFile->addFixableError(
-                        'Expected 1 space between "%s" and double arrow; %s found',
-                        $nextArrow,
-                        'SpaceBeforeDoubleArrow',
-                        [$tokens[$nextArrow - 2]['content'], $spaceLength]
-                    );
-
-                    if ($fix) {
-                        $phpcsFile->fixer->replaceToken($nextArrow - 1, ' ');
-                    }
+                    FixerHelper::fixWhitespaceBefore($phpcsFile, $nextArrow, 1, $spaceBefore);
                 }
             }
 
             if (T_WHITESPACE !== $tokens[$nextArrow + 1]['code']) {
+                $spaceAfter = 0;
+            } else {
+                $spaceAfter = $tokens[$nextArrow + 1]['length'];
+            }
+
+            if (1 !== $spaceAfter) {
                 $fix = $phpcsFile->addFixableError(
-                    'Expected 1 space between double arrow and "%s"; 0 found',
+                    'Expected 1 space between double arrow and "%s"; %s found',
                     $nextArrow,
-                    'NoSpaceAfterDoubleArrow',
-                    [$tokens[$nextArrow + 1]['content']]
+                    'SpaceAfterDoubleArrow',
+                    [$tokens[$nextArrow + 1]['content'], $spaceAfter]
                 );
 
                 if ($fix) {
-                    $phpcsFile->fixer->addContent($nextArrow, ' ');
-                }
-            } else {
-                $spaceLength = $tokens[$nextArrow + 1]['length'];
-                if (1 !== $spaceLength) {
-                    $fix = $phpcsFile->addFixableError(
-                        'Expected 1 space between double arrow and "%s"; %s found',
-                        $nextArrow,
-                        'SpaceAfterDoubleArrow',
-                        [$tokens[$nextArrow + 2]['content'], $spaceLength]
-                    );
-
-                    if ($fix) {
-                        $phpcsFile->fixer->replaceToken($nextArrow + 1, ' ');
-                    }
+                    FixerHelper::fixWhitespaceAfter($phpcsFile, $nextArrow, 1, $spaceAfter);
                 }
             }
 
@@ -218,29 +202,21 @@ public function processSingleLineArray(File $phpcsFile, int $stackPtr, int $star
             // We have a multiple value array
             foreach ($commas as $comma) {
                 if (T_WHITESPACE !== $tokens[$comma + 1]['code']) {
+                    $spaceAfter = 0;
+                } else {
+                    $spaceAfter = $tokens[$comma + 1]['length'];
+                }
+
+                if (1 !== $spaceAfter) {
                     $fix = $phpcsFile->addFixableError(
-                        'Expected 1 space between comma and "%s"; 0 found',
+                        'Expected 1 space between comma and "%s"; %s found',
                         $comma,
-                        'NoSpaceAfterComma',
-                        [$tokens[$comma + 1]['content']]
+                        'SpaceAfterComma',
+                        [$tokens[$comma + 1]['content'], $spaceAfter]
                     );
 
                     if ($fix) {
-                        $phpcsFile->fixer->addContent($comma, ' ');
-                    }
-                } else {
-                    $spaceLength = $tokens[$comma + 1]['length'];
-                    if (1 !== $spaceLength) {
-                        $fix = $phpcsFile->addFixableError(
-                            'Expected 1 space between comma and "%s"; %s found',
-                            $comma,
-                            'SpaceAfterComma',
-                            [$tokens[$comma + 2]['content'], $spaceLength]
-                        );
-
-                        if ($fix) {
-                            $phpcsFile->fixer->replaceToken($comma + 1, ' ');
-                        }
+                        FixerHelper::fixWhitespaceAfter($phpcsFile, $comma, 1, $spaceAfter);
                     }
                 }
 

SymfonyCustom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php

@@ -6,8 +6,8 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use SymfonyCustom\Sniffs\FixerHelper;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\FixerHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Throws errors if comments are not grouped by type with one blank line between them.

SymfonyCustom/Sniffs/Commenting/DocCommentSniff.php

@@ -6,7 +6,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use SymfonyCustom\Sniffs\FixerHelper;
+use SymfonyCustom\Helpers\FixerHelper;
 
 /**
  * Ensures doc blocks follow basic formatting.

SymfonyCustom/Sniffs/Namespaces/AlphabeticallySortedUseSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Class AlphabeticallySortedUseSniff

SymfonyCustom/Sniffs/Namespaces/UnusedUseSniff.php

@@ -7,7 +7,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Tokens;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Checks for "use" statements that are not needed in a file.

SymfonyCustom/Sniffs/WhiteSpace/DocCommentTagSpacingSniff.php

@@ -6,7 +6,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use SymfonyCustom\Sniffs\SniffHelper;
+use SymfonyCustom\Helpers\SniffHelper;
 
 /**
  * Checks that there are not 2 empty lines following each other.

SymfonyCustom/Tests/Arrays/ArrayDeclarationUnitTest.inc

@@ -147,3 +147,5 @@ return [
     1 =>
     2,
 ];
+
+[1    =>   2 ,   2=>3,4 => 5];

SymfonyCustom/Tests/Arrays/ArrayDeclarationUnitTest.inc.fixed

@@ -145,3 +145,5 @@ return [
     0 => 1,
     1 => 2,
 ];
+
+[1 => 2, 2 => 3, 4 => 5];

SymfonyCustom/Tests/Arrays/ArrayDeclarationUnitTest.php

@@ -53,6 +53,7 @@ protected function getErrorList(): array
             107 => 2,
             142 => 1,
             148 => 1,
+            151 => 7,
         ];
     }
 

SymfonyCustom/Tests/NamingConventions/ValidFileNameUnitTest.php

@@ -21,12 +21,8 @@ class ValidFileNameUnitTest extends AbstractSniffUnitTest
     protected function getErrorList($filename = '')
     {
         switch ($filename) {
-            case 'ValidFileNameUnitTest.inc':
-                return [];
             case 'ValidFileNameUnitTest.Invalid.inc':
-                return [
-                    1 => 1,
-                ];
+                return [1 => 1];
             default:
                 return [];
         }

TwigCS/Command/TwigCSCommand.php renamed to TwigCS/src/Command/TwigCSCommand.php

@@ -39,6 +39,15 @@
         </exec>
     </target>
 
+    <target name="coverage" depends="symlink-cs" description="Run coverage with PHPUnit">
+        <exec executable="${phpunit.bin}" failonerror="true" >
+            <arg value="--verbose"/>
+            <arg value="--group=SymfonyCustom"/>
+            <arg value="${phpcs.dir}/tests/AllTests.php"/>
+            <arg value="--coverage-html=coverage"/>
+        </exec>
+    </target>
+
     <target name="phpcs" depends="symlink-cs" description="Find coding standard violations using PHP Code Sniffer">
         <exec executable="${phpcs.bin}" failonerror="true">
             <arg value="--standard=SymfonyCustom"/>

TwigCS/Config/Config.php renamed to TwigCS/src/Config/Config.php

@@ -28,9 +28,13 @@
         "phpunit/phpunit": "^7.0"
     },
     "autoload": {
-        "psr-4": { "TwigCS\\": "TwigCS/" }
+        "psr-4": {
+            "TwigCS\\": "TwigCS/src/"
+        }
     },
     "autoload-dev": {
-        "psr-4": { "TwigCS\\Tests\\": "TwigCS/Tests/" }
+        "psr-4": {
+            "TwigCS\\Tests\\": "TwigCS/tests/"
+        }
     }
 }