✨ Add elseif, else, break rules

Author: Vincent Langlet

Symfony3Custom/Sniffs/Formatting/ConditionalReturnOrThrowSniff.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Symfony3Custom\Sniffs\Formatting;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Checks whether there are else(if) or break statements after return or throw
+ */
+class ConditionalReturnOrThrowSniff implements Sniff
+{
+    /**
+     * @var array
+     */
+    private $openers = [
+        T_IF,
+        T_CASE,
+    ];
+
+    /**
+     * @var array
+     */
+    private $conditions = [
+        T_ELSEIF,
+        T_ELSE,
+        T_BREAK,
+    ];
+
+    /**
+     * Registers the tokens that this sniff wants to listen for.
+     */
+    public function register()
+    {
+        return [
+            T_THROW,
+            T_RETURN,
+        ];
+    }
+
+    /**
+     * Called when one of the token types that this sniff is listening for is found.
+     *
+     * @param File $phpcsFile The PHP_CodeSniffer file where the token was found.
+     * @param int $stackPtr   The position in the PHP_CodeSniffer file's token stack
+     *                        where the token was found.
+     *
+     * @return void|int Optionally returns a stack pointer. The sniff will not be
+     *                  called again on the current file until the returned stack
+     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  the rest of the file.
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $opener = $phpcsFile->findPrevious($this->openers, $stackPtr);
+
+        if ($opener && $stackPtr <= $tokens[$opener]['scope_closer']) {
+            $isClosure = $phpcsFile->findPrevious(T_CLOSURE, $stackPtr, $opener);
+
+            if (false !== $isClosure) {
+                return;
+            }
+
+            $condition = $phpcsFile->findNext($this->conditions, $stackPtr + 1);
+
+            if (false !== $condition) {
+                $next = $phpcsFile->findNext($this->openers, $stackPtr + 1);
+
+                if (false !== $next) {
+                    $err = (isset($tokens[$condition]['scope_closer']) && isset($tokens[$next]['scope_opener']))
+                        ? $tokens[$condition]['scope_closer'] < $tokens[$next]['scope_opener']
+                        : $tokens[$condition]['line'] <= $tokens[$next]['line'];
+                } else {
+                    $err = false;
+                }
+
+                if (false === $next || true === $err) {
+                    $phpcsFile->addError(
+                        'Do not use else, elseif, break after if and case conditions which return or throw something',
+                        $condition,
+                        'Invalid'
+                    );
+                }
+            }
+        }
+    }
+}

Symfony3Custom/Tests/Formatting/ConditionalReturnOrThrowUnitTest.inc

@@ -0,0 +1,60 @@
+<?php
+
+class Test
+{
+    public function tester($dummy, $mergedOptions)
+    {
+        if (true === $dummy) {
+            return null;
+        }
+
+        if ('string' === $dummy) {
+            if ('values' === $mergedOptions['some_default']) {
+                return substr($dummy, 0, 5);
+            }
+
+            return ucwords($dummy);
+        }
+
+        if ('int' === $dummy) {
+            if ('values' === $mergedOptions['some_default']) {
+                return substr($dummy, 0, 5);
+            } elseif (true) {
+                return ucwords($dummy);
+            }
+        }
+
+        if ('a' === $dummy) {
+            $mergedOptions['a'] = true;
+        } else {
+            $mergedOptions['a'] = false;
+        }
+
+        if ('b' === $dummy) {
+            $mergedOptions['a'] = true;
+
+            throw new Error();
+        } else {
+            $mergedOptions['a'] = false;
+        }
+
+        switch (true) {
+            case false:
+                return null;
+                break;
+            default:
+                break;
+        }
+
+        if ('c' === $dummy) {
+            $function = function () {
+                return null;
+            };
+        } elseif ('d' === $dummy) {
+            return null;
+        }
+
+        return null;
+    }
+}
+

Symfony3Custom/Tests/Formatting/ConditionalReturnOrThrowUnitTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Symfony3Custom\Tests\Formatting;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the ConditionalReturnOrThrow sniff.
+ *
+ * @group Symfony3Custom
+ */
+class ConditionalReturnOrThrowUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    public function getErrorList()
+    {
+        return array(
+            22 => 1,
+            37 => 1,
+            44 => 1,
+        );
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    public function getWarningList()
+    {
+        return array();
+    }
+}

docs/standards.md

@@ -24,15 +24,10 @@ We imported the [PSR2 Standard](./standards/psr2.md) with these overrides:
 ## From symfony
 
 We mainly respect the [Symfony Standard](./standards/symfony.md) but
-
-- We do not respect this rule:
+we do not respect this rule:
 
   - Declare all the arguments on the same line as the method/function name, no matter how many arguments there are
 
-- We do not currently check this rule:
-
-  - Do not use `else`, `elseif`, `break` after `if` and `case` conditions which return or throw something
-
 ## Others
 ### Imported
 - Do not use `<?` to define a php file
@@ -124,7 +119,7 @@ We mainly respect the [Symfony Standard](./standards/symfony.md) but
 <rule ref="Symfony3Custom.Commenting.VariableComment"/>
 ```
 
-- USE keywords should be alphabetically sorted
+- `use` keywords should be alphabetically sorted
 
 ```
 <rule ref="Symfony3Custom.Namespaces.AlphabeticallySortedUse"/>

docs/standards/symfony.md

@@ -108,7 +108,9 @@ Not checked because of the limit of 120 characters per line
 
 - Do not use `else`, `elseif`, `break` after `if` and `case` conditions which return or throw something
 
-Not covered
+```
+<rule ref="Symfony3Custom.Formatting.ConditionalReturnOrThrowSniff" />
+```
 
 - Do not use spaces around `[` offset accessor and before `]` offset accessor