✨ Add Error/Deprecated messages sniffs

Author: Vincent Langlet

Symfony3Custom/Sniffs/Errors/ExceptionMessageSniff.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Symfony3Custom\Sniffs\Errors;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Checks whether exception messages are concatenated with sprintf
+ */
+class ExceptionMessageSniff implements Sniff
+{
+    /**
+     * Registers the tokens that this sniff wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(
+            T_THROW,
+        );
+    }
+
+    /**
+     * 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->findNext(T_OPEN_PARENTHESIS, $stackPtr);
+        $concat = $phpcsFile->findNext(
+            T_STRING_CONCAT,
+            $tokens[$opener]['parenthesis_opener'],
+            $tokens[$opener]['parenthesis_closer']
+        );
+
+        if ($concat) {
+            $error = 'Exception and error message strings must be concatenated using sprintf';
+            $phpcsFile->addError($error, $stackPtr, 'Invalid');
+        }
+    }
+
+}

Symfony3Custom/Sniffs/Errors/UserDeprecatedSniff.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Symfony3Custom\Sniffs\Errors;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Checks whether E_USER_DEPRECATED errors are silenced by default.
+ */
+class UserDeprecatedSniff implements Sniff
+{
+    /**
+     * Registers the tokens that this sniff wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(
+            T_STRING,
+        );
+    }
+
+    /**
+     * 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();
+
+        if ('trigger_error' !== $tokens[$stackPtr]['content']) {
+            return;
+        }
+
+        $pos = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
+        $opener = $tokens[$pos]['parenthesis_opener'];
+        $closer = $tokens[$pos]['parenthesis_closer'];
+
+        do {
+            $string = $phpcsFile->findNext(T_STRING, $opener, $closer);
+
+            if (false === $string) {
+                break;
+            }
+
+            if ('E_USER_DEPRECATED' === $tokens[$string]['content'] && '@' !== $tokens[$stackPtr - 1]['content']) {
+                $error = 'Calls to trigger_error with type E_USER_DEPRECATED must be switched to opt-in via @ operator';
+                $phpcsFile->addError($error, $stackPtr, 'Invalid');
+
+                break;
+            } else {
+                $opener = $string + 1;
+            }
+        } while ($opener < $closer);
+    }
+
+}

Symfony3Custom/Tests/Errors/ExceptionMessageUnitTest.inc

@@ -0,0 +1,19 @@
+<?php
+
+class Errors
+{
+    /**
+     * @param bool   $bool
+     * @param string $option
+     *
+     * @throws \RuntimeException
+     */
+    public function test($bool, $option)
+    {
+        if ($bool) {
+            throw new \RuntimeException(sprintf('Unrecognized option "%s"', $option));
+        }
+
+        throw new \RuntimeException('Unrecognized option '.$option);
+    }
+}

Symfony3Custom/Tests/Errors/ExceptionMessageUnitTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Symfony3Custom\Tests\Errors;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the ExceptionMessage sniff.
+ *
+ * @group Symfony3Custom
+ */
+class ExceptionMessageUnitTest 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(
+            17 => 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();
+    }
+}

Symfony3Custom/Tests/Errors/UserDeprecatedUnitTest.inc

@@ -0,0 +1,40 @@
+<?php
+
+class Errors
+{
+    /**
+     * @return string
+     *
+     * @deprecated
+     */
+    public function someGoodDeprecatedMethod()
+    {
+        @trigger_error(
+            sprintf(
+                'The %s() method is deprecated',
+                __METHOD__
+            ),
+            E_USER_DEPRECATED
+        );
+
+        return Baz::someMethod();
+    }
+
+    /**
+     * @return string
+     *
+     * @deprecated
+     */
+    public function someBadDeprecatedMethod()
+    {
+        trigger_error(
+            sprintf(
+                'The %s() method is deprecated',
+                __METHOD__
+            ),
+            E_USER_DEPRECATED
+        );
+
+        return Baz::someMethod();
+    }
+}

Symfony3Custom/Tests/Errors/UserDeprecatedUnitTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Symfony3Custom\Tests\Errors;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the UserDeprecated sniff.
+ *
+ * @group Symfony3Custom
+ */
+class UserDeprecatedUnitTest 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(
+            30 => 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();
+    }
+}