fix: phpspec void remove linebreak (#140)

PedroTroller · Apr 26, 2021 · fc4d3ea · fc4d3ea
1 parent 7461e49
commit fc4d3ea
Show file tree

Hide file tree

Showing 39 changed files with 257 additions and 616 deletions.
diff --git a/src/PedroTroller/CS/Fixer/PhpspecFixer.php b/src/PedroTroller/CS/Fixer/PhpspecFixer.php
@@ -6,6 +6,7 @@
 
 use PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\Fixer\FunctionNotation\VoidReturnFixer;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
 use PhpCsFixer\Tokenizer\Token;
@@ -99,7 +100,10 @@ public function getDocumentation()
      */
     public function getPriority()
     {
-        return Priority::after(VisibilityRequiredFixer::class);
+        return Priority::after(
+            VisibilityRequiredFixer::class,
+            VoidReturnFixer::class
+        );
     }
 
     /**
@@ -223,7 +227,12 @@ private function removeReturn(SplFileInfo $file, Tokens $tokens): void
             }
 
             $tokens->clearRange($closeBraceIndex + 1, $openCurlyBracket - 1);
-            $tokens->ensureWhitespaceAtIndex($openCurlyBracket, 0, "\n".$this->analyze($tokens)->getLineIndentation($openBraceIndex));
+
+            if ($tokens[$closeBraceIndex - 1]->isWhitespace() && false !== strpos($tokens[$closeBraceIndex - 1]->getContent(), "\n")) {
+                $tokens->ensureWhitespaceAtIndex($openCurlyBracket, 0, ' ');
+            } else {
+                $tokens->ensureWhitespaceAtIndex($openCurlyBracket, 0, "\n".$this->analyze($tokens)->getLineIndentation($openBraceIndex));
+            }
         }
     }
 

diff --git a/tests/Runner.php b/tests/Runner.php
@@ -80,7 +80,7 @@ private static function runUseCases(): void
                 continue;
             }
 
-            $fixer  = $usecase->getFixer();
+            $fixers = $usecase->getFixers();
             $tokens = Tokens::fromCode($usecase->getRawScript());
 
             $differ = new Differ();
@@ -90,7 +90,9 @@ private static function runUseCases(): void
             echo "#######################################################################################\n";
             echo "\n";
 
-            $fixer->fix(new SplFileInfo(__FILE__), $tokens);
+            foreach ($fixers as $fixer) {
+                $fixer->fix(new SplFileInfo(__FILE__), $tokens);
+            }
 
             if ($usecase->getExpectation() !== $tokens->generateCode()) {
                 throw new Exception($differ->diff($usecase->getExpectation(), $tokens->generateCode()));

diff --git a/tests/UseCase.php b/tests/UseCase.php
@@ -9,22 +9,13 @@
 interface UseCase
 {
     /**
-     * @return FixerInterface
+     * @return iterable<FixerInterface>
      */
-    public function getFixer();
+    public function getFixers(): iterable;
 
-    /**
-     * @return string
-     */
-    public function getRawScript();
+    public function getRawScript(): string;
 
-    /**
-     * @return string
-     */
-    public function getExpectation();
+    public function getExpectation(): string;
 
-    /**
-     * @return int
-     */
-    public function getMinSupportedPhpVersion();
+    public function getMinSupportedPhpVersion(): int;
 }
diff --git a/tests/UseCase/Behat.php b/tests/UseCase/Behat.php
@@ -9,12 +9,12 @@
 
 final class Behat implements UseCase
 {
-    public function getFixer()
+    public function getFixers(): iterable
     {
-        return new OrderBehatStepsFixer();
+        yield new OrderBehatStepsFixer();
     }
 
-    public function getRawScript()
+    public function getRawScript(): string
     {
         return <<<'CONTEXT'
 <?php
@@ -129,7 +129,7 @@ public function iAmAnnon()
 CONTEXT;
     }
 
-    public function getExpectation()
+    public function getExpectation(): string
     {
         return <<<'CONTEXT'
 <?php
@@ -227,7 +227,7 @@ public function doSomething()
 CONTEXT;
     }
 
-    public function getMinSupportedPhpVersion()
+    public function getMinSupportedPhpVersion(): int
     {
         return 0;
     }

diff --git a/tests/UseCase/CommentLineToPhpdocBlock.php b/tests/UseCase/CommentLineToPhpdocBlock.php
@@ -9,18 +9,12 @@
 
 final class CommentLineToPhpdocBlock implements UseCase
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getFixer()
+    public function getFixers(): iterable
     {
-        return new CommentLineToPhpdocBlockFixer();
+        yield new CommentLineToPhpdocBlockFixer();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getRawScript()
+    public function getRawScript(): string
     {
         return <<<'PHP'
 <?php
@@ -79,10 +73,7 @@ public function update(array $data)
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getExpectation()
+    public function getExpectation(): string
     {
         return <<<'PHP'
 <?php
@@ -150,10 +141,7 @@ public function update(array $data)
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getMinSupportedPhpVersion()
+    public function getMinSupportedPhpVersion(): int
     {
         return 0;
     }

diff --git a/tests/UseCase/DoctrineMigrations/UselessComments.php b/tests/UseCase/DoctrineMigrations/UselessComments.php
@@ -9,18 +9,12 @@
 
 final class UselessComments implements UseCase
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getFixer()
+    public function getFixers(): iterable
     {
-        return new DoctrineMigrationsFixer();
+        yield new DoctrineMigrationsFixer();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getRawScript()
+    public function getRawScript(): string
     {
         return <<<'PHP'
 <?php
@@ -61,10 +55,7 @@ public function down(Schema $schema): void
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getExpectation()
+    public function getExpectation(): string
     {
         return <<<'PHP'
 <?php
@@ -100,10 +91,7 @@ public function down(Schema $schema): void
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getMinSupportedPhpVersion()
+    public function getMinSupportedPhpVersion(): int
     {
         return 70100;
     }

diff --git a/tests/UseCase/DoctrineMigrations/UselessGetDescription.php b/tests/UseCase/DoctrineMigrations/UselessGetDescription.php
@@ -9,18 +9,12 @@
 
 final class UselessGetDescription implements UseCase
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getFixer()
+    public function getFixers(): iterable
     {
-        return new DoctrineMigrationsFixer();
+        yield new DoctrineMigrationsFixer();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getRawScript()
+    public function getRawScript(): string
     {
         return <<<'PHP'
 <?php
@@ -56,10 +50,7 @@ public function down(Schema $schema): void
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getExpectation()
+    public function getExpectation(): string
     {
         return <<<'PHP'
 <?php
@@ -91,10 +82,7 @@ public function down(Schema $schema): void
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getMinSupportedPhpVersion()
+    public function getMinSupportedPhpVersion(): int
     {
         return 70100;
     }

diff --git a/tests/UseCase/ExceptionsPunctuation.php b/tests/UseCase/ExceptionsPunctuation.php
@@ -9,18 +9,12 @@
 
 final class ExceptionsPunctuation implements UseCase
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getFixer()
+    public function getFixers(): iterable
     {
-        return new ExceptionsPunctuationFixer();
+        yield new ExceptionsPunctuationFixer();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getRawScript()
+    public function getRawScript(): string
     {
         return <<<'PHP'
 <?php
@@ -52,10 +46,7 @@ public function fun4($data)
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getExpectation()
+    public function getExpectation(): string
     {
         return <<<'PHP'
 <?php
@@ -87,10 +78,7 @@ public function fun4($data)
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getMinSupportedPhpVersion()
+    public function getMinSupportedPhpVersion(): int
     {
         return 0;
     }

diff --git a/tests/UseCase/ForbiddenFunctions.php b/tests/UseCase/ForbiddenFunctions.php
@@ -9,10 +9,7 @@
 
 final class ForbiddenFunctions implements UseCase
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getFixer()
+    public function getFixers(): iterable
     {
         $fixer = new ForbiddenFunctionsFixer();
 
@@ -21,13 +18,10 @@ public function getFixer()
             'functions' => ['var_dump', 'dump'],
         ]);
 
-        return $fixer;
+        yield $fixer;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getRawScript()
+    public function getRawScript(): string
     {
         return <<<'PHP'
 <?php
@@ -54,10 +48,7 @@ public function dump($data)
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getExpectation()
+    public function getExpectation(): string
     {
         return <<<'PHP'
 <?php
@@ -84,10 +75,7 @@ public function dump($data)
 PHP;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getMinSupportedPhpVersion()
+    public function getMinSupportedPhpVersion(): int
     {
         return 0;
     }