Exception message testing

Author: daniel-mueller

custom-standards/Flyeralarm/Sniffs/File/ExceptionMessageSniff.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace flyeralarm\CodingGuidelines\Flyeralarm\Sniffs\File;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+class ExceptionMessageSniff implements Sniff
+{
+    /**
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_CLASS);
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $className = $phpcsFile->getDeclarationName($stackPtr);
+
+        if (strpos($className, 'Exception') === false) {
+            return;
+        }
+
+        $tokens = $phpcsFile->getTokens();
+        $ptr = -1;
+        while($ptr = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $ptr + 1)) {
+            if (strpos($tokens[$ptr]['content'], '!') !== false) {
+                $phpcsFile->addError(
+                    'Exclamationmarks are not allowed in Exceptionmessages',
+                    $stackPtr,
+                    'ExceptionMessageWithInvalidCharacter'
+                );
+            }
+
+            if (strpos($tokens[$ptr]['content'], '.') !== false) {
+                $phpcsFile->addError(
+                    'Full stops are not allowed in Exceptionmessages',
+                    $stackPtr,
+                    'ExceptionMessageWithInvalidCharacter'
+                );
+            }
+        }
+    }
+}

ruleset.xml

@@ -6,5 +6,6 @@
     <rule ref="Generic.Arrays.DisallowLongArraySyntax.Found"/>
     <rule ref="Generic.PHP.DisallowShortOpenTag"/>
     <rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
+    <rule ref="./custom-standards/Flyeralarm/Sniffs/File/ExceptionMessageSniff.php"/>
     <rule ref="./custom-standards/Flyeralarm/Sniffs/File/NoClassKindSuffixSniff.php"/>
 </ruleset>

tests/rules/classes/not-allowed/ExclamationException.php

@@ -0,0 +1,13 @@
+<?php
+// @expectedError Exclamationmarks are not allowed in Exceptionmessages
+
+class ExclamationException
+{
+    public function foobar()
+    {
+        echo 'Hi';
+        echo 'Wrong!';
+        echo 'Bye';
+        echo "Hola";
+    }
+}

tests/rules/classes/not-allowed/FullStopException.php

@@ -0,0 +1,13 @@
+<?php
+// @expectedError Full stops are not allowed in Exceptionmessages
+
+class FullStopException
+{
+    public function foobar()
+    {
+        echo 'Hi';
+        echo 'Bye';
+        echo "Hola";
+        echo "Ciao.";
+    }
+}