feature #4452 Add SingleLineThrowFixer (kubawerlos)

This PR was merged into the 2.16-dev branch.

Discussion
----------

Add SingleLineThrowFixer

Resolves #3988

@nicolas-grekas should we have this as part of `@Symfony` ruleset?

Commits
-------

4a94eb7 Add SingleLineThrowFixer

Author: keradus

README.rst

@@ -1841,6 +1841,10 @@ Choose from the list of available rules:
   - ``comment_types`` (a subset of ``['asterisk', 'hash']``): list of comment types
     to fix; defaults to ``['asterisk', 'hash']``
 
+* **single_line_throw**
+
+  Throwing exception must be done in single line.
+
 * **single_quote** [@Symfony, @PhpCsFixer]
 
   Convert double quotes to single quotes for simple strings.

src/Fixer/FunctionNotation/SingleLineThrowFixer.php

@@ -0,0 +1,147 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Fixer\FunctionNotation;
+
+use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Preg;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+
+/**
+ * @author Kuba Werłos <werlos@gmail.com>
+ */
+final class SingleLineThrowFixer extends AbstractFixer
+{
+    /**
+     * @internal
+     */
+    const REMOVE_WHITESPACE_AFTER_TOKENS = ['['];
+
+    /**
+     * @internal
+     */
+    const REMOVE_WHITESPACE_AROUND_TOKENS = ['(', [T_OBJECT_OPERATOR], [T_DOUBLE_COLON]];
+
+    /**
+     * @internal
+     */
+    const REMOVE_WHITESPACE_BEFORE_TOKENS = [')',  ']', ',', ';'];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefinition()
+    {
+        return new FixerDefinition(
+            'Throwing exception must be done in single line.',
+            [
+                new CodeSample("<?php\nthrow new Exception(\n    'Error',\n    500\n);\n"),
+            ]
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isCandidate(Tokens $tokens)
+    {
+        return $tokens->isTokenKindFound(T_THROW);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPriority()
+    {
+        // must be fun before ConcatSpaceFixer
+        return 1;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function applyFix(\SplFileInfo $file, Tokens $tokens)
+    {
+        for ($index = 0, $count = $tokens->count(); $index < $count; ++$index) {
+            if (!$tokens[$index]->isGivenKind(T_THROW)) {
+                continue;
+            }
+
+            /** @var int $openingBraceCandidateIndex */
+            $openingBraceCandidateIndex = $tokens->getNextTokenOfKind($index, [';', '(']);
+
+            while ($tokens[$openingBraceCandidateIndex]->equals('(')) {
+                /** @var int $closingBraceIndex */
+                $closingBraceIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openingBraceCandidateIndex);
+                /** @var int $openingBraceCandidateIndex */
+                $openingBraceCandidateIndex = $tokens->getNextTokenOfKind($closingBraceIndex, [';', '(']);
+            }
+
+            $this->trimNewLines($tokens, $index, $openingBraceCandidateIndex);
+        }
+    }
+
+    /**
+     * @param int $startIndex
+     * @param int $endIndex
+     */
+    private function trimNewLines(Tokens $tokens, $startIndex, $endIndex)
+    {
+        for ($index = $startIndex; $index < $endIndex; ++$index) {
+            $content = $tokens[$index]->getContent();
+
+            if ($tokens[$index]->isGivenKind(T_COMMENT)) {
+                if (0 === strpos($content, '//')) {
+                    $content = '/*'.substr($content, 2).' */';
+                    $tokens->clearAt($index + 1);
+                } elseif (0 === strpos($content, '#')) {
+                    $content = '/*'.substr($content, 1).' */';
+                    $tokens->clearAt($index + 1);
+                } elseif (false !== Preg::match('/\R/', $content)) {
+                    $content = Preg::replace('/\R/', ' ', $content);
+                }
+                $tokens[$index] = new Token([T_COMMENT, $content]);
+
+                continue;
+            }
+
+            if (!$tokens[$index]->isGivenKind(T_WHITESPACE)) {
+                continue;
+            }
+
+            if (0 === Preg::match('/\R/', $content)) {
+                continue;
+            }
+
+            $prevIndex = $tokens->getNonEmptySibling($index, -1);
+            if ($tokens[$prevIndex]->equalsAny(array_merge(self::REMOVE_WHITESPACE_AFTER_TOKENS, self::REMOVE_WHITESPACE_AROUND_TOKENS))) {
+                $tokens->clearAt($index);
+
+                continue;
+            }
+
+            $nextIndex = $tokens->getNonEmptySibling($index, 1);
+            if ($tokens[$nextIndex]->equalsAny(array_merge(self::REMOVE_WHITESPACE_AROUND_TOKENS, self::REMOVE_WHITESPACE_BEFORE_TOKENS))) {
+                if (!$tokens[$prevIndex]->isGivenKind(T_FUNCTION)) {
+                    $tokens->clearAt($index);
+
+                    continue;
+                }
+            }
+
+            $tokens[$index] = new Token([T_WHITESPACE, ' ']);
+        }
+    }
+}

tests/AutoReview/FixerFactoryTest.php

@@ -221,6 +221,7 @@ public function provideFixersPriorityCases()
             [$fixers['single_import_per_statement'], $fixers['no_singleline_whitespace_before_semicolons']],
             [$fixers['single_import_per_statement'], $fixers['no_unused_imports']],
             [$fixers['single_import_per_statement'], $fixers['space_after_semicolon']],
+            [$fixers['single_line_throw'], $fixers['concat_space']],
             [$fixers['single_trait_insert_per_statement'], $fixers['braces']],
             [$fixers['single_trait_insert_per_statement'], $fixers['space_after_semicolon']],
             [$fixers['standardize_increment'], $fixers['increment_style']],