Increased unit test coverage of DocBlock;

boenrobot · boenrobot · commit 082c9354d0e0 · 2012-11-10T13:24:46.000+02:00
Moved the tag block checks outside (and prior to) the tag line loop;
Doc and CS fixes.
diff --git a/src/phpDocumentor/Reflection/DocBlock.php b/src/phpDocumentor/Reflection/DocBlock.php
@@ -200,30 +200,32 @@ protected function splitDocBlock($comment)
     protected function parseTags($tags)
     {
         $result = array();
-        foreach (explode("\n", trim($tags)) as $tag_line) {
-            if (trim($tag_line) === '') {
-                continue;
+        $tags = trim($tags);
+        if ('' !== $tags) {
+            if ('@' !== $tags[0]) {
+                throw new \LogicException(
+                    'A tag block started with text instead of an actual tag,'
+                    . ' this makes the tag block invalid: ' . $tags
+                );
             }
-
-            if (isset($tag_line[0]) && ($tag_line[0] === '@')) {
-                $result[] = $tag_line;
-            } else {
-                if (count($result) == 0) {
-                    throw new \LogicException(
-                        'A tag block started with text instead of an actual tag,'
-                        . ' this makes the tag block invalid: ' . $tags
-                    );
+            foreach (explode("\n", $tags) as $tag_line) {
+                if (trim($tag_line) === '') {
+                    continue;
                 }
 
-                $result[count($result) - 1] .= PHP_EOL . $tag_line;
+                if (isset($tag_line[0]) && ($tag_line[0] === '@')) {
+                    $result[] = $tag_line;
+                } else {
+                    $result[count($result) - 1] .= PHP_EOL . $tag_line;
+                }
             }
-        }
 
-        // create proper Tag objects
-        foreach ($result as $key => $tag_line) {
-            $tag = DocBlock\Tag::createInstance($tag_line);
-            $tag->setDocBlock($this);
-            $result[$key] = $tag;
+            // create proper Tag objects
+            foreach ($result as $key => $tag_line) {
+                $tag = DocBlock\Tag::createInstance($tag_line);
+                $tag->setDocBlock($this);
+                $result[$key] = $tag;
+            }
         }
 
         $this->tags = $result;
@@ -388,6 +390,7 @@ public function expandType($type, $ignore_keywords = null)
      *     implement it.
      *
      * @return string
+     * @codeCoverageIgnore Not yet implemented
      */
     public static function export()
     {
@@ -399,6 +402,7 @@ public static function export()
      * BUT this throws an exception at this point).
      *
      * @return string
+     * @codeCoverageIgnore Not yet implemented
      */
     public function __toString()
     {
diff --git a/src/phpDocumentor/Reflection/DocBlock/LongDescription.php b/src/phpDocumentor/Reflection/DocBlock/LongDescription.php
@@ -100,7 +100,7 @@ public function getParsedContents()
                     $this->parsedContents[$i]
                 );
             }
-            
+
             //In order to allow "literal" inline tags, the otherwise invalid
             //sequence "{@}" is changed to "@", and "{}" is changed to "}".
             //See unit tests for examples.
@@ -153,6 +153,7 @@ public function getFormattedContents()
      *     and implement it.
      *
      * @return void
+     * @codeCoverageIgnore Not yet implemented
      */
     public static function export()
     {
@@ -164,9 +165,10 @@ public static function export()
      * BUT this throws an exception at this point).
      *
      * @return string
+     * @codeCoverageIgnore Not yet implemented
      */
     public function __toString()
     {
         return 'Not yet implemented';
     }
-}
+}
diff --git a/src/phpDocumentor/Reflection/DocBlock/Tag.php b/src/phpDocumentor/Reflection/DocBlock/Tag.php
@@ -173,6 +173,7 @@ public function setDocBlock($docblock)
      * @todo determine the exact format as used by PHP Reflection and implement it.
      *
      * @return void
+     * @codeCoverageIgnore Not yet implemented
      */
     public static function export()
     {
@@ -184,6 +185,7 @@ public static function export()
      * BUT this throws an exception at this point).
      *
      * @return string
+     * @codeCoverageIgnore Not yet implemented
      */
     public function __toString()
     {
diff --git a/tests/phpDocumentor/Reflection/DocBlock/LongDescriptionTest.php b/tests/phpDocumentor/Reflection/DocBlock/LongDescriptionTest.php
@@ -57,7 +57,7 @@ public function testInlineTagParsing()
             $parsedContents[2]
         );
     }
-    
+
     public function testInlineTagAtStartParsing()
     {
         $fixture = <<<LONGDESC
@@ -69,7 +69,7 @@ public function testInlineTagAtStartParsing()
 
         $parsedContents = $object->getParsedContents();
         $this->assertCount(3, $parsedContents);
-        
+
         $this->assertSame('', $parsedContents[0]);
         $this->assertInstanceOf(
             __NAMESPACE__ . '\Tag\LinkTag',
@@ -81,7 +81,7 @@ public function testInlineTagAtStartParsing()
             $parsedContents[2]
         );
     }
-    
+
     public function testNestedInlineTagParsing()
     {
         $fixture = <<<LONGDESC
@@ -93,7 +93,7 @@ public function testNestedInlineTagParsing()
 
         $parsedContents = $object->getParsedContents();
         $this->assertCount(3, $parsedContents);
-        
+
         $this->assertSame(
             'This is text for a description with ',
             $parsedContents[0]
@@ -198,7 +198,7 @@ public function testNestedLiteralClosingDelimiter()
             $parsedContents[1]->getParsedDescription()
         );
     }
-    
+
     public function testInlineTagEscapingSequence()
     {
         $fixture = <<<LONGDESC
@@ -242,4 +242,4 @@ public function testNestedInlineTagEscapingSequence()
             $parsedContents[1]->getParsedDescription()
         );
     }
-}
+}
diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/LinkTagTest.php
@@ -24,7 +24,7 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
-     * a link for the @link doc block
+     * a link for the @link doc block.
      *
      * @param string $type
      * @param string $content
diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ParamTagTest.php
@@ -24,7 +24,7 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ParamTag can
-     * understand the param DocBlock.
+     * understand the @param DocBlock.
      *
      * @param string $type
      * @param string $content
diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/ReturnTagTest.php
@@ -24,7 +24,7 @@ class ReturnTagTest extends ParamTagTest
 {
     /**
      * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can
-     * understand the Return DocBlock.
+     * understand the @return DocBlock.
      *
      * @param string $content
      * @param string $extractedType
diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/SeeTagTest.php
@@ -24,7 +24,7 @@ class SeeTagTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * Test that the phpDocumentor_Reflection_DocBlock_Tag_See can create a link
-     * for the @see doc block
+     * for the @see doc block.
      *
      * @param string $type
      * @param string $content
diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/UsesTagTest.php
@@ -24,7 +24,7 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * Test that the \phpDocumentor\Reflection\DocBlock\Tag\UsesTag can create
-     * a link for the @uses doc block
+     * a link for the @uses doc block.
      *
      * @param string $type
      * @param string $content
diff --git a/tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php b/tests/phpDocumentor/Reflection/DocBlock/Tag/VarTagTest.php
@@ -24,7 +24,7 @@ class VarTagTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can
-     * understand the @var doc block
+     * understand the @var doc block.
      *
      * @param string $type
      * @param string $content
diff --git a/tests/phpDocumentor/Reflection/DocBlockTest.php b/tests/phpDocumentor/Reflection/DocBlockTest.php
@@ -13,7 +13,7 @@
 namespace phpDocumentor\Reflection;
 
 /**
- * Test class for phpDocumentor_Reflection_DocBlock
+ * Test class for phpDocumentor\Reflection\DocBlock
  *
  * @author    Mike van Riel <mike.vanriel@naenius.com>
  * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
@@ -46,6 +46,31 @@ public function testConstruct()
         $this->assertEquals(2, count($object->getTags()));
         $this->assertTrue($object->hasTag('see'));
         $this->assertTrue($object->hasTag('return'));
+        $this->assertFalse($object->hasTag('category'));
+    }
+
+    public function testConstructFromReflector()
+    {
+        $object = new DocBlock(new \ReflectionClass($this));
+        $this->assertEquals(
+            'Test class for phpDocumentor\Reflection\DocBlock',
+            $object->getShortDescription()
+        );
+        $this->assertEquals('', $object->getLongDescription()->getContents());
+        $this->assertEquals(4, count($object->getTags()));
+        $this->assertTrue($object->hasTag('author'));
+        $this->assertTrue($object->hasTag('copyright'));
+        $this->assertTrue($object->hasTag('license'));
+        $this->assertTrue($object->hasTag('link'));
+        $this->assertFalse($object->hasTag('category'));
+    }
+    
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testExceptionOnInvalidObject()
+    {
+        $object = new DocBlock($this);
     }
 
     public function testDotSeperation()
@@ -139,16 +164,18 @@ public function testExpandTypeUsingNamespaceAlias()
     public function testThatExpandTypeDoesNotExpandAllKeywords($keyword)
     {
         $docblock = new DocBlock('', '\My\Namespace');
-        $this->assertEquals($keyword, $docblock->expandType($keyword));
+        $this->assertSame($keyword, $docblock->expandType($keyword));
     }
 
     public function getNonExpandableKeywordsForExpandType()
     {
         return array(
+            array(null),
             array('string'), array('int'), array('integer'), array('bool'),
             array('boolean'), array('float'), array('double'), array('object'),
             array('mixed'), array('array'), array('resource'), array('void'),
-            array('null'), array('callback'), array('false'), array('true')
+            array('null'), array('callback'), array('false'), array('true'),
+            array('self'), array('$this'), array('callable')
         );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ public function getParsedContents()`
`100`	`100`	`$this->parsedContents[$i]`
`101`	`101`	`);`
`102`	`102`	`}`
`103`		`-`
	`103`	`+`
`104`	`104`	`//In order to allow "literal" inline tags, the otherwise invalid`
`105`	`105`	`//sequence "{@}" is changed to "@", and "{}" is changed to "}".`
`106`	`106`	`//See unit tests for examples.`
`@@ -153,6 +153,7 @@ public function getFormattedContents()`
`153`	`153`	`* and implement it.`
`154`	`154`	`*`
`155`	`155`	`* @return void`
	`156`	`+ * @codeCoverageIgnore Not yet implemented`
`156`	`157`	`*/`
`157`	`158`	`public static function export()`
`158`	`159`	`{`
`@@ -164,9 +165,10 @@ public static function export()`
`164`	`165`	`* BUT this throws an exception at this point).`
`165`	`166`	`*`
`166`	`167`	`* @return string`
	`168`	`+ * @codeCoverageIgnore Not yet implemented`
`167`	`169`	`*/`
`168`	`170`	`public function __toString()`
`169`	`171`	`{`
`170`	`172`	`return 'Not yet implemented';`
`171`	`173`	`}`
`172`		`-}`
	`174`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,7 @@ public function setDocBlock($docblock)`
`173`	`173`	`* @todo determine the exact format as used by PHP Reflection and implement it.`
`174`	`174`	`*`
`175`	`175`	`* @return void`
	`176`	`+ * @codeCoverageIgnore Not yet implemented`
`176`	`177`	`*/`
`177`	`178`	`public static function export()`
`178`	`179`	`{`
`@@ -184,6 +185,7 @@ public static function export()`
`184`	`185`	`* BUT this throws an exception at this point).`
`185`	`186`	`*`
`186`	`187`	`* @return string`
	`188`	`+ * @codeCoverageIgnore Not yet implemented`
`187`	`189`	`*/`
`188`	`190`	`public function __toString()`
`189`	`191`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class LinkTagTest extends \PHPUnit_Framework_TestCase`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create`
`27`		`- * a link for the @link doc block`
	`27`	`+ * a link for the @link doc block.`
`28`	`28`	`*`
`29`	`29`	`* @param string $type`
`30`	`30`	`* @param string $content`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class ParamTagTest extends \PHPUnit_Framework_TestCase`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ParamTag can`
`27`		`- * understand the param DocBlock.`
	`27`	`+ * understand the @param DocBlock.`
`28`	`28`	`*`
`29`	`29`	`* @param string $type`
`30`	`30`	`* @param string $content`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class ReturnTagTest extends ParamTagTest`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can`
`27`		`- * understand the Return DocBlock.`
	`27`	`+ * understand the @return DocBlock.`
`28`	`28`	`*`
`29`	`29`	`* @param string $content`
`30`	`30`	`* @param string $extractedType`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class SeeTagTest extends \PHPUnit_Framework_TestCase`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Test that the phpDocumentor_Reflection_DocBlock_Tag_See can create a link`
`27`		`- * for the @see doc block`
	`27`	`+ * for the @see doc block.`
`28`	`28`	`*`
`29`	`29`	`* @param string $type`
`30`	`30`	`* @param string $content`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class UsesTagTest extends \PHPUnit_Framework_TestCase`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Test that the \phpDocumentor\Reflection\DocBlock\Tag\UsesTag can create`
`27`		`- * a link for the @uses doc block`
	`27`	`+ * a link for the @uses doc block.`
`28`	`28`	`*`
`29`	`29`	`* @param string $type`
`30`	`30`	`* @param string $content`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class VarTagTest extends \PHPUnit_Framework_TestCase`
`24`	`24`	`{`
`25`	`25`	`/**`
`26`	`26`	`* Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can`
`27`		`- * understand the @var doc block`
	`27`	`+ * understand the @var doc block.`
`28`	`28`	`*`
`29`	`29`	`* @param string $type`
`30`	`30`	`* @param string $content`