Introduce NoMultilineReturnFixer (#6)

The `return` keyword and its expression should be on the same line
for readability. This fixer replaces multiline returns with a single
space between `return` and the expression.

Author: ruudk

src/Fixer/NoMultilineReturnFixer.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ticketswap\PhpCsFixerConfig\Fixer;
+
+use Override;
+use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+use SplFileInfo;
+
+final class NoMultilineReturnFixer extends AbstractFixer
+{
+    #[Override]
+    public function getDefinition() : FixerDefinitionInterface
+    {
+        return new FixerDefinition(
+            'The `return` keyword and the expression it returns must be on the same line.',
+            [
+                new CodeSample(
+                    <<<'EOL'
+                        <?php
+
+                        function foo()
+                        {
+                            return
+                                $bar->baz();
+                        }
+
+                        EOL,
+                ),
+            ],
+        );
+    }
+
+    #[Override]
+    public function isCandidate(Tokens $tokens) : bool
+    {
+        return $tokens->isTokenKindFound(T_RETURN);
+    }
+
+    #[Override]
+    protected function applyFix(SplFileInfo $file, Tokens $tokens) : void
+    {
+        for ($index = $tokens->count() - 1; $index >= 0; --$index) {
+            if ( ! $tokens[$index]->isGivenKind(T_RETURN)) {
+                continue;
+            }
+
+            $nextIndex = $index + 1;
+
+            if ( ! isset($tokens[$nextIndex])) {
+                continue;
+            }
+
+            if ( ! $tokens[$nextIndex]->isGivenKind(T_WHITESPACE)) {
+                continue;
+            }
+
+            $whitespace = $tokens[$nextIndex]->getContent();
+
+            if ( ! str_contains($whitespace, "\n")) {
+                continue;
+            }
+
+            $nextMeaningfulIndex = $tokens->getNextMeaningfulToken($index);
+
+            if ($nextMeaningfulIndex === null || $tokens[$nextMeaningfulIndex]->equals(';')) {
+                continue;
+            }
+
+            $tokens[$nextIndex] = new Token([T_WHITESPACE, ' ']);
+        }
+    }
+}

src/RuleSet/TicketSwapRuleSet.php

@@ -26,6 +26,7 @@
 use Symplify\CodingStandard\TokenRunner\Whitespace\IndentResolver;
 use Symplify\CodingStandard\TokenRunner\Wrapper\FixerWrapper\ArrayWrapperFactory;
 use Ticketswap\PhpCsFixerConfig\Fixer\AttributesNewLineFixer;
+use Ticketswap\PhpCsFixerConfig\Fixer\NoMultilineReturnFixer;
 use Ticketswap\PhpCsFixerConfig\Fixer\PhpdocAboveAttributeFixer;
 use Ticketswap\PhpCsFixerConfig\Fixers;
 use Ticketswap\PhpCsFixerConfig\NameWrapper;
@@ -57,6 +58,7 @@ public static function create() : RuleSet
             new Fixers(
                 new LineBreakAfterStatementsFixer(),
                 new NameWrapper(new AttributesNewLineFixer()),
+                new NameWrapper(new NoMultilineReturnFixer()),
                 new NameWrapper(new PhpdocAboveAttributeFixer()),
                 new NameWrapper(new ArrayListItemNewlineFixer($arrayItemNewliner, $arrayAnalyzer, $arrayBlockInfoFinder)),
                 new NameWrapper(new ArrayOpenerAndCloserNewlineFixer($arrayBlockInfoFinder, $whitespacesFixerConfig, $arrayAnalyzer)),