#94 - return statement missing blank line fixer (#96)

* #94 - added blank line fixer

* #94 - fixes

* #94 - add more cases for fixer

* #94 - added one more case for test

src/Config.php

@@ -38,6 +38,7 @@ public function config(): PhpCsFixerConfig
         list("paths" => $paths, "rules" => $rules) = $this->options();
 
         $files = [];
+
         foreach ($paths as $path) {
             $directory = $this->rootPath . "/" . $path;
             $this->getAllFiles($files, $directory);
@@ -76,6 +77,7 @@ protected function getAllFiles(array &$paths, string $path): void
             if (str_ends_with($path, ".php")) {
                 $paths[] = $path;
             }
+
             return;
         }
 

src/Configuration/Defaults/CommonRules.php

@@ -92,6 +92,7 @@
 use PhpCsFixer\Fixer\Strict\StrictParamFixer;
 use PhpCsFixer\Fixer\StringNotation\SimpleToComplexStringVariableFixer;
 use PhpCsFixer\Fixer\Whitespace\ArrayIndentationFixer;
+use PhpCsFixer\Fixer\Whitespace\BlankLineBeforeStatementFixer;
 use PhpCsFixer\Fixer\Whitespace\BlankLineBetweenImportGroupsFixer;
 use PhpCsFixer\Fixer\Whitespace\CompactNullableTypehintFixer;
 use PhpCsFixer\Fixer\Whitespace\LineEndingFixer;
@@ -304,5 +305,19 @@ class CommonRules extends Rules
         LineEndingFixer::class => true,
         StatementIndentationFixer::class => true,
         BlankLineBetweenImportGroupsFixer::class => true,
+        BlankLineBeforeStatementFixer::class => [
+            "statements" => [
+                "break",
+                "continue",
+                "declare",
+                "return",
+                "throw",
+                "try",
+                "if",
+                "do",
+                "for",
+                "foreach",
+                "while",
+            ]],
     ];
 }

src/Configuration/Defaults/Rules.php

@@ -15,6 +15,7 @@ abstract class Rules implements RulesContract
     public function get(): array
     {
         $rules = [];
+
         foreach ($this->rules as $fixer => $options) {
             /** @var AbstractFixer $fixer */
             $fixer = new $fixer();

src/Fixers/DoubleQuoteFixer.php

@@ -69,6 +69,7 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
 
             $content = $token->getContent();
             $prefix = "";
+
             if (
                 $content[0] === "'" &&
                 !str_contains($content, '"') &&

src/Fixers/NoCommentFixer.php

@@ -49,6 +49,7 @@ public function getName(): string
     public function getPriority(): int
     {
         $fixer = new NoExtraBlankLinesFixer();
+
         return $fixer->getPriority() + 1;
     }
 

src/Fixers/NoLaravelMigrationsGeneratedCommentFixer.php

@@ -67,6 +67,7 @@ public function getName(): string
     public function getPriority(): int
     {
         $fixer = new VoidReturnFixer();
+
         return $fixer->getPriority() + 1;
     }
 

tests/codestyle/CommonRulesetTest.php

@@ -56,6 +56,7 @@ public static function providePhp80Fixtures(): array
             ["namespaces"],
             ["emptyLines"],
             ["importsOrder"],
+            ["blankLineBeforeStatement"],
         ];
     }
 

tests/codestyle/fixtures/blankLineBeforeStatement/actual.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+class BlankLine
+{
+    /**
+     * @throws Exception
+     */
+    public function getFoo(int $foo): int
+    {
+        $bar = $foo;
+        try {
+
+            while ($bar > 0) {
+                $bar++;
+            }
+            for ($i = 0; $i < 5; $i++) {
+                echo $i;
+            }
+        } catch (Exception $exception) {
+            $value = "error";
+            throw new Exception(message: $value);
+        }
+        return $bar;
+    }
+
+    protected function getBar(int $number): void
+    {
+        if ($number === 1) {
+            return;
+        }
+    }
+}

tests/codestyle/fixtures/blankLineBeforeStatement/expected.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+class BlankLine
+{
+    /**
+     * @throws Exception
+     */
+    public function getFoo(int $foo): int
+    {
+        $bar = $foo;
+
+        try {
+            while ($bar > 0) {
+                $bar++;
+            }
+
+            for ($i = 0; $i < 5; $i++) {
+                echo $i;
+            }
+        } catch (Exception $exception) {
+            $value = "error";
+
+            throw new Exception(message: $value);
+        }
+
+        return $bar;
+    }
+
+    protected function getBar(int $number): void
+    {
+        if ($number === 1) {
+            return;
+        }
+    }
+}

tests/codestyle/fixtures/nullableTypeForDefaultNull/expected.php

@@ -7,6 +7,7 @@ class NullableTypeForDefaultNull
     public function getNameLabel(string $name, ?string $title = null): string
     {
         $label = $name;
+
         if ($title !== null) {
             $label .= " " . $title;
         }

tests/codestyle/fixtures/objectOperators/expected.php

@@ -10,6 +10,7 @@ class ObjectOperatorTest
     public function get(): void
     {
         $array = $this->array;
+
         if ($this->nullable) {
             unset($array);
         }