Merge pull request #4 in CFA/coding-guidelines from expected-exception to master

* commit '989e38a08f33c16d81f4cd744463e09d603fef2b':
  - Added newline
  - Added expected exception name sniff - Fixed test runner problem with empty brackets [ ]

Author: Daniel Müller

custom-standards/Flyeralarm/Sniffs/Docblock/ExpectedExceptionMessageSniff.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace flyeralarm\CodingGuidelines\Flyeralarm\Sniffs\Docblock;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+class ExpectedExceptionMessageSniff implements Sniff
+{
+    /**
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_DOC_COMMENT_OPEN_TAG);
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if (!$this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedException')) {
+            return;
+        }
+        if ($this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedExceptionMessage')) {
+            return;
+        }
+
+        $expectedExceptionPtr = $this->getAnnotationPtr($phpcsFile, $stackPtr, '@expectedException');
+
+        $phpcsFile->addError(
+            'Annotation @expectedExceptionMessage missing',
+            $expectedExceptionPtr,
+            'AnnotationMissing'
+        );
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param $docStartPtr
+     * @return int
+     */
+    private function getAnnotationPtr(File $phpcsFile, $docStartPtr, $annotation)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $commentEndPtr = $tokens[$docStartPtr]['comment_closer'];
+        for ($currentTokenIndex = $docStartPtr; $currentTokenIndex < $commentEndPtr; $currentTokenIndex++) {
+            $currentToken = $phpcsFile->findNext(T_DOC_COMMENT_TAG, $currentTokenIndex, $commentEndPtr);
+            if ($tokens[$currentToken]['content'] == $annotation) {
+                return $currentToken;
+            }
+        }
+
+        throw new \OutOfBoundsException('Found no @return tag');
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param int $docStartPtr
+     * @param string $annotation
+     * @return bool
+     */
+    public function hasAnnotationInDoc(File $phpcsFile, $docStartPtr, $annotation)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $commentEnd = $tokens[$docStartPtr]['comment_closer'];
+        for ($currentTokenIndex = $docStartPtr; $currentTokenIndex < $commentEnd; $currentTokenIndex++) {
+            $currentToken = $phpcsFile->findNext(T_DOC_COMMENT_TAG, $currentTokenIndex, $commentEnd);
+            if ($tokens[$currentToken]['content'] == $annotation) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

ruleset.xml

@@ -10,4 +10,5 @@
     <rule ref="./custom-standards/Flyeralarm/Sniffs/File/ForbiddenKeywordsSniff.php"/>
     <rule ref="./custom-standards/Flyeralarm/Sniffs/File/NoClassKindSuffixSniff.php"/>
     <rule ref="./custom-standards/Flyeralarm/Sniffs/Docblock/ReturnTypeSniff.php"/>
+    <rule ref="./custom-standards/Flyeralarm/Sniffs/Docblock/ExpectedExceptionMessageSniff.php"/>
 </ruleset>

tests/rules/doc/allowed/ExpectedExceptionWithExpectedExceptionMessage.php

@@ -0,0 +1,16 @@
+<?php
+
+// @expectedPass
+
+namespace flyeralarm\Test;
+
+class FooTest
+{
+    /**
+     * @expectedException \RuntimeException
+     * @expectedExceptionMessage The exception message
+     */
+    public function testBar()
+    {
+    }
+}

tests/rules/doc/not-allowed/ExpectedExceptionWithoutExpectedExceptionMessage.php

@@ -0,0 +1,13 @@
+<?php
+
+// @expectedError Annotation @expectedExceptionMessage missing
+
+class FooTest
+{
+    /**
+     * @expectedException \RuntimeException
+     */
+    public function testBar()
+    {
+    }
+}

tests/runner.php

@@ -42,7 +42,7 @@ function processDir($dirPath)
             continue;
         }
         $expected = $expectedMatch[1];
-        if (preg_match('/ERROR\s\|\s?[\[\]x]*\s' . preg_quote($expected, '/') . '/', $snifferOutput) === 0) {
+        if (preg_match('/ERROR\s\|\s?[\[\]x\s]*\s' . preg_quote($expected, '/') . '/', $snifferOutput) === 0) {
             $hasError = true;
             echo 'ERROR - [' . $dirPath . $file . ']: Expectation <<' . $expected . '>> not found in result: ' . PHP_EOL . $snifferOutput . PHP_EOL;
         } else {