Introduce @coversDefaultClass

It can be specified in a tests doc block and will allow `@covers ::methodName` annotations that can shorten `@covers` tags when working with long namespaces and/or class names.

Author: edorian

ChangeLog.markdown

@@ -7,3 +7,4 @@ PHP_CodeCoverage 1.2.0
 ----------------------
 
 * PHP_CodeCoverage 1.2 is only supported on PHP 5.3.3 (or later) and PHP 5.4.0 (or later) is highly recommended.
+* Introduce the `@coversDefaultClass` annotation. It enables short @covers annotations when working with long class names or namespaces.

PHP/CodeCoverage/Util.php

@@ -166,8 +166,29 @@ public static function getLinesToBeCovered($className, $methodName)
             }
         }
 
+        $classShortcut = preg_match_all(
+          '(@coversDefaultClass\s+(?P<coveredClass>.*?)\s*$)m',
+          $class->getDocComment(),
+          $matches
+        );
+        if($classShortcut) {
+            if($classShortcut > 1) {
+                throw new PHP_CodeCoverage_Exception(
+                  sprintf(
+                    'More than one @coversClass annotation in class or interface "%s".',
+                    $className
+                  )
+                );
+            }
+            $classShortcut = $matches['coveredClass'][0];
+        } 
+
         if (preg_match_all(self::REGEX, $docComment, $matches)) {
             foreach ($matches['coveredElement'] as $coveredElement) {
+                if($classShortcut && strncmp($coveredElement, '::', 2) === 0) {
+                    $coveredElement = $classShortcut . $coveredElement;
+                }
+
                 $codeToCoverList = array_merge(
                   $codeToCoverList,
                   self::resolveCoversToReflectionObjects($coveredElement)

Tests/PHP/CodeCoverage/FilterTest.php

@@ -88,10 +88,13 @@ protected function setUp()
           TEST_FILES_PATH . 'CoveragePrivateTest.php',
           TEST_FILES_PATH . 'CoverageProtectedTest.php',
           TEST_FILES_PATH . 'CoveragePublicTest.php',
+          TEST_FILES_PATH . 'CoverageTwoDefaultClassAnnotations.php',
           TEST_FILES_PATH . 'CoveredClass.php',
           TEST_FILES_PATH . 'CoveredFunction.php',
           TEST_FILES_PATH . 'NamespaceCoverageClassExtendedTest.php',
           TEST_FILES_PATH . 'NamespaceCoverageClassTest.php',
+          TEST_FILES_PATH . 'NamespaceCoverageCoversClassPublicTest.php',
+          TEST_FILES_PATH . 'NamespaceCoverageCoversClassTest.php',
           TEST_FILES_PATH . 'NamespaceCoverageMethodTest.php',
           TEST_FILES_PATH . 'NamespaceCoverageNotPrivateTest.php',
           TEST_FILES_PATH . 'NamespaceCoverageNotProtectedTest.php',

Tests/PHP/CodeCoverage/UtilTest.php

@@ -65,10 +65,13 @@
 require_once TEST_FILES_PATH . 'CoveragePrivateTest.php';
 require_once TEST_FILES_PATH . 'CoverageProtectedTest.php';
 require_once TEST_FILES_PATH . 'CoveragePublicTest.php';
+require_once TEST_FILES_PATH . 'CoverageTwoDefaultClassAnnotations.php';
 require_once TEST_FILES_PATH . 'CoveredClass.php';
 require_once TEST_FILES_PATH . 'CoveredFunction.php';
 require_once TEST_FILES_PATH . 'NamespaceCoverageClassExtendedTest.php';
 require_once TEST_FILES_PATH . 'NamespaceCoverageClassTest.php';
+require_once TEST_FILES_PATH . 'NamespaceCoverageCoversClassTest.php';
+require_once TEST_FILES_PATH . 'NamespaceCoverageCoversClassPublicTest.php';
 require_once TEST_FILES_PATH . 'NamespaceCoverageMethodTest.php';
 require_once TEST_FILES_PATH . 'NamespaceCoverageNotPrivateTest.php';
 require_once TEST_FILES_PATH . 'NamespaceCoverageNotProtectedTest.php';
@@ -287,6 +290,18 @@ public function testPercent()
         );
     }
 
+    /**
+     * @covers PHP_CodeCoverage_Util::getLinesToBeCovered
+     * @expectedException PHP_CodeCoverage_Exception
+     */
+    public function testTwoCoversDefaultClassAnnoationsAreNotAllowed()
+    {
+        PHP_CodeCoverage_Util::getLinesToBeCovered(
+          'CoverageTwoDefaultClassAnnotations',
+          'testSomething'
+        );
+    }
+
     public function getLinesToBeCoveredProvider()
     {
         return array(
@@ -369,6 +384,14 @@ public function getLinesToBeCoveredProvider()
           array(
             'NamespaceCoveragePublicTest',
             range(33, 37)
+          ),
+          array(
+            'NamespaceCoverageCoversClassTest',
+            array_merge(range(23, 25), range(27, 31), range(33, 37), range(6, 8), range(10, 13), range(15, 18))
+          ),
+          array(
+            'NamespaceCoverageCoversClassPublicTest',
+            range(33, 37)
           )
         );
     }

Tests/_files/CoverageTwoDefaultClassAnnotations.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * @coversDefaultClass \NamespaceOne
+ * @coversDefaultClass \AnotherDefault\Name\Space\Does\Not\Work
+ */
+class CoverageTwoDefaultClassAnnotations
+{
+
+    /**
+     * @covers Foo\CoveredClass::<public>
+     */
+    public function testSomething()
+    {
+        $o = new Foo\CoveredClass;
+        $o->publicMethod();
+    }
+
+}

Tests/_files/NamespaceCoverageCoversClassPublicTest.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * @coversDefaultClass \Foo\CoveredClass
+ */
+class NamespaceCoverageCoversClassPublicTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @covers ::publicMethod
+     */
+    public function testSomething()
+    {
+        $o = new Foo\CoveredClass;
+        $o->publicMethod();
+    }
+}
+

Tests/_files/NamespaceCoverageCoversClassTest.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * @coversDefaultClass \Foo\CoveredClass
+ */
+class NamespaceCoverageCoversClassTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @covers ::privateMethod
+     * @covers ::protectedMethod
+     * @covers ::publicMethod
+     * @covers \Foo\CoveredParentClass::privateMethod
+     * @covers \Foo\CoveredParentClass::protectedMethod
+     * @covers \Foo\CoveredParentClass::publicMethod
+     */
+    public function testSomething()
+    {
+        $o = new Foo\CoveredClass;
+        $o->publicMethod();
+    }
+}
+