refactor: add rector rules

.circleci/config.yml

@@ -15,13 +15,15 @@ tests: &tests
   run: |
       composer test -vvv
       bin/doc
-      vendor/bin/php-cs-fixer fix --diff || (echo "Coding standards are not respected. Run 'vendor/bin/php-cs-fixer fix'" && exit 1)
+      composer run rector || (echo "Coding standards are not respected. Run 'composer run rector'" && exit 1)
+      composer run php-cs-fixer || (echo "Coding standards are not respected. Run 'composer run php-cs-fixer'" && exit 1)
 
 tests_with_future_mode: &tests_with_future_mode
   run: |
       PHP_CS_FIXER_FUTURE_MODE=1 composer test -vvv
       bin/doc
-      vendor/bin/php-cs-fixer fix --diff || (echo "Coding standards are not respected. Run 'vendor/bin/php-cs-fixer fix'" && exit 1)
+      composer run rector || (echo "Coding standards are not respected. Run 'composer run rector'" && exit 1)
+      composer run php-cs-fixer || (echo "Coding standards are not respected. Run 'composer run php-cs-fixer'" && exit 1)
 
 jobs:
   php 7.1:

composer.json

@@ -8,15 +8,19 @@
     },
     "require-dev": {
         "phpspec/phpspec": "^5.1.0",
+        "rector/rector": "^0.5.19",
         "twig/twig": "^2.11.3",
         "webmozart/assert": "^1.3.0"
     },
     "autoload": {
-        "psr-4": { "PedroTroller\\CS\\": "src/PedroTroller/CS/" }
+        "psr-4": {
+            "PedroTroller\\CS\\Fixer\\": "src/PedroTroller/CS/Fixer"
+        }
     },
     "autoload-dev": {
         "psr-4": {
-            "tests\\": "tests/"
+            "spec\\": "spec",
+            "tests\\": "tests"
         }
     },
     "config": {
@@ -33,8 +37,17 @@
         "tests": [
             "tests\\Runner::run",
             "tests\\Orchestra::run",
-            "phpspec run -fpretty",
+            "phpspec run -fpretty"
+        ],
+        "rector": [
+            "rector process src/ tests/ spec/"
+        ],
+        "php-cs-fixer": [
             "php-cs-fixer fix --dry-run -vvv --diff"
+        ],
+        "lint": [
+            "@rector",
+            "@php-cs-fixer"
         ]
     }
 }

rector.yaml

@@ -0,0 +1,13 @@
+---
+parameters:
+  auto_import_names: true
+
+  exclude_rectors:
+    - Rector\CodeQuality\Rector\Identical\SimplifyBoolIdenticalTrueRector
+
+imports:
+  - resource: vendor/rector/rector/config/set/code-quality/*
+  - resource: vendor/rector/rector/config/set/php/php71.yaml
+  - resource: vendor/rector/rector/config/set/phpspec/*
+  - resource: vendor/rector/rector/config/set/psr-4/*
+  - resource: vendor/rector/rector/config/set/solid/*

spec/PedroTroller/CS/Fixer/RuleSetFactorySpec.php

@@ -8,7 +8,7 @@
 use PedroTroller\CS\Fixer\RuleSetFactory;
 use PhpSpec\ObjectBehavior;
 
-class RuleSetFactorySpec extends ObjectBehavior
+final class RuleSetFactorySpec extends ObjectBehavior
 {
     function it_is_initializable()
     {

src/PedroTroller/CS/Fixer/AbstractOrderedClassElementsFixer.php

@@ -23,7 +23,7 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
             $i        = $tokens->getNextTokenOfKind($i, ['{']);
             $elements = $this->getElements($tokens, $i);
 
-            if (!$elements) {
+            if ($elements === []) {
                 continue;
             }
 

src/PedroTroller/CS/Fixer/CodingStyle/LineBreakBetweenMethodArgumentsFixer.php

@@ -17,7 +17,7 @@
 
 final class LineBreakBetweenMethodArgumentsFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface, WhitespacesAwareFixerInterface
 {
-    const T_TYPEHINT_SEMI_COLON = 10025;
+    private const T_TYPEHINT_SEMI_COLON = 10025;
 
     /**
      * {@inheritdoc}

src/PedroTroller/CS/Fixer/CodingStyle/LineBreakBetweenStatementsFixer.php

@@ -127,7 +127,7 @@ private function fixSpaces($index, Tokens $tokens): void
             return;
         }
 
-        if (false === \in_array($tokens[$nextMeaningful]->getId(), array_keys($this->handlers), true)) {
+        if (false === \array_key_exists($tokens[$nextMeaningful]->getId(), $this->handlers)) {
             return;
         }
 

src/PedroTroller/CS/Fixer/Comment/CommentLineToPhpdocBlockFixer.php

@@ -111,7 +111,7 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
             $whitespaceIndex = null;
 
             do {
-                $previous = $previous - 1;
+                --$previous;
 
                 if ($tokens[$previous]->isComment()) {
                     $comments = array_merge(

src/PedroTroller/CS/Fixer/Comment/UselessCommentFixer.php

@@ -175,15 +175,13 @@ private function getUselessComments($index, Tokens $tokens)
         foreach ($arguments as $argument) {
             if (null === $argument['type']) {
                 $useless[] = sprintf('/^@param +\%s/', $argument['name']);
+            } elseif ($argument['nullable']) {
+                $useless[] = sprintf('/^@param +%s\|null +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
+                $useless[] = sprintf('/^@param +null\|%s +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
+                $useless[] = sprintf('/^@param +%s \| null +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
+                $useless[] = sprintf('/^@param +null \| %s +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
             } else {
-                if ($argument['nullable']) {
-                    $useless[] = sprintf('/^@param +%s\|null +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
-                    $useless[] = sprintf('/^@param +null\|%s +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
-                    $useless[] = sprintf('/^@param +%s \| null +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
-                    $useless[] = sprintf('/^@param +null \| %s +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
-                } else {
-                    $useless[] = sprintf('/^@param +%s +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
-                }
+                $useless[] = sprintf('/^@param +%s +\%s$/', str_replace('\\', '\\\\', $argument['type']), $argument['name']);
             }
         }
 

src/PedroTroller/CS/Fixer/TokenSignatures.php

@@ -6,8 +6,8 @@
 
 final class TokenSignatures
 {
-    const TYPINT_OPTIONAL    = 10022;
-    const TYPINT_DOUBLE_DOTS = 10025;
+    public const TYPINT_OPTIONAL    = 10022;
+    public const TYPINT_DOUBLE_DOTS = 10025;
 
     public function __construct()
     {

tests/Runner.php

@@ -11,7 +11,7 @@
 use SplFileInfo;
 use Symfony\Component\Finder\Finder;
 
-class Runner
+final class Runner
 {
     public static function run(): void
     {

tests/TokensAnalyzerIntegration/InSwitch.php

@@ -9,7 +9,7 @@
 use tests\TokensAnalyzerIntegration;
 use Webmozart\Assert\Assert;
 
-class InSwitch extends TokensAnalyzerIntegration
+final class InSwitch extends TokensAnalyzerIntegration
 {
     /**
      * {@inheritdoc}

tests/TokensAnalyzerIntegration/MethodArguments.php

@@ -9,7 +9,7 @@
 use tests\TokensAnalyzerIntegration;
 use Webmozart\Assert\Assert;
 
-class MethodArguments extends TokensAnalyzerIntegration
+final class MethodArguments extends TokensAnalyzerIntegration
 {
     /**
      * {@inheritdoc}

tests/TokensAnalyzerIntegration/SizeOfTheLine.php

@@ -9,7 +9,7 @@
 use tests\TokensAnalyzerIntegration;
 use Webmozart\Assert\Assert;
 
-class SizeOfTheLine extends TokensAnalyzerIntegration
+final class SizeOfTheLine extends TokensAnalyzerIntegration
 {
     /**
      * {@inheritdoc}

tests/UseCase/ForbiddenFunctions.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\ForbiddenFunctionsFixer;
 use tests\UseCase;
 
-class ForbiddenFunctions implements UseCase
+final class ForbiddenFunctions implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenMethods.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenMethodArgumentsFixer;
 use tests\UseCase;
 
-class LineBreakBetweenMethods implements UseCase
+final class LineBreakBetweenMethods implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenMethods/Regression/Case1.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenMethodArgumentsFixer;
 use tests\UseCase;
 
-class Case1 implements UseCase
+final class Case1 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenMethods/Regression/Case2.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenMethodArgumentsFixer;
 use tests\UseCase;
 
-class Case2 implements UseCase
+final class Case2 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenMethods/Regression/Case3.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenMethodArgumentsFixer;
 use tests\UseCase;
 
-class Case3 implements UseCase
+final class Case3 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenMethodsWithNoReformatting.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenMethodArgumentsFixer;
 use tests\UseCase;
 
-class LineBreakBetweenMethodsWithNoReformatting implements UseCase
+final class LineBreakBetweenMethodsWithNoReformatting implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenMethodsWithNoSplitOnNumberOfArgs.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenMethodArgumentsFixer;
 use tests\UseCase;
 
-class LineBreakBetweenMethodsWithNoSplitOnNumberOfArgs implements UseCase
+final class LineBreakBetweenMethodsWithNoSplitOnNumberOfArgs implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/LineBreakBetweenStatements.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\CodingStyle\LineBreakBetweenStatementsFixer;
 use tests\UseCase;
 
-class LineBreakBetweenStatements implements UseCase
+final class LineBreakBetweenStatements implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/OrderedSpecElements.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\Phpspec\OrderedSpecElementsFixer;
 use tests\UseCase;
 
-class OrderedSpecElements implements UseCase
+final class OrderedSpecElements implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/OrderedSpecElements/Regression/Case1.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\Phpspec\OrderedSpecElementsFixer;
 use tests\UseCase;
 
-class Case1 implements UseCase
+final class Case1 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/OrderedWithGetterAndSetterFirst.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\ClassNotation\OrderedWithGetterAndSetterFirstFixer;
 use tests\UseCase;
 
-class OrderedWithGetterAndSetterFirst implements UseCase
+final class OrderedWithGetterAndSetterFirst implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/OrderedWithGetterAndSetterFirst/Regression/Case1.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\ClassNotation\OrderedWithGetterAndSetterFirstFixer;
 use tests\UseCase;
 
-class Case1 implements UseCase
+final class Case1 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/OrderedWithGetterAndSetterFirst/Regression/Case2.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\ClassNotation\OrderedWithGetterAndSetterFirstFixer;
 use tests\UseCase;
 
-class Case2 implements UseCase
+final class Case2 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/Phpspec.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace tests\Usecase;
+namespace tests\UseCase;
 
 use PedroTroller\CS\Fixer\PhpspecFixer;
 use tests\UseCase;
 
-class Phpspec implements UseCase
+final class Phpspec implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/PhpspecScenarioScope.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace tests\Usecase;
+namespace tests\UseCase;
 
 use PedroTroller\CS\Fixer\Phpspec\PhpspecScenarioScopeFixer;
 use tests\UseCase;
 
-class PhpspecScenarioScope implements UseCase
+final class PhpspecScenarioScope implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/UselessCodeAfterReturn.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\DeadCode\UselessCodeAfterReturnFixer;
 use tests\UseCase;
 
-class UselessCodeAfterReturn implements UseCase
+final class UselessCodeAfterReturn implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/UselessComment.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\Comment\UselessCommentFixer;
 use tests\UseCase;
 
-class UselessComment implements UseCase
+final class UselessComment implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/UselessComment/Php71.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\Comment\UselessCommentFixer;
 use tests\UseCase;
 
-class Php71 implements UseCase
+final class Php71 implements UseCase
 {
     /**
      * {@inheritdoc}

tests/UseCase/UselessComment/Regression/DoubleLineBreak.php

@@ -7,7 +7,7 @@
 use PedroTroller\CS\Fixer\Comment\UselessCommentFixer;
 use tests\UseCase;
 
-class DoubleLineBreak implements UseCase
+final class DoubleLineBreak implements UseCase
 {
     /**
      * {@inheritdoc}