Rewritten Version tag and added test

src/DocBlock/Tags/Version.php

@@ -12,13 +12,18 @@
 
 namespace phpDocumentor\Reflection\DocBlock\Tags;
 
-use phpDocumentor\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\Types\Context;
+use phpDocumentor\Reflection\DocBlock\Description;
+use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
+use Webmozart\Assert\Assert;
 
 /**
- * Reflection class for a @version tag in a Docblock.
+ * Reflection class for a {@}version tag in a Docblock.
  */
-class Version extends Tag
+class Version extends BaseTag
 {
+    protected $name = 'version';
+
     /**
      * PCRE regular expression matching a version vector.
      * Assumes the "x" modifier.
@@ -38,17 +43,24 @@ class Version extends Tag
     /** @var string The version vector. */
     private $version = '';
 
-    public function __construct($version, Description $description = null)
+    public function __construct($version = null, Description $description = null)
     {
+        Assert::nullOrStringNotEmpty($version);
+
         $this->version = $version;
         $this->description = $description;
     }
 
     /**
-     * {@inheritdoc}
+     * @return static
      */
-    public static function create($body, Context $context = null)
+    public static function create($body, DescriptionFactory $descriptionFactory = null, Context $context = null)
     {
+        Assert::nullOrString($body);
+        if (empty($body)) {
+            return new static();
+        }
+
         $matches = [];
         if (!preg_match('/^(' . self::REGEX_VECTOR . ')\s*(.+)?$/sux', $body, $matches)) {
             return null;
@@ -56,7 +68,7 @@ class Version extends Tag
 
         return new static(
             $matches[1],
-            new Description(isset($matches[2]) ? $matches[2] : '', $context)
+            $descriptionFactory->create(isset($matches[2]) ? $matches[2] : '', $context)
         );
     }
 
@@ -77,6 +89,6 @@ class Version extends Tag
      */
     public function __toString()
     {
-        return $this->version . ' ' . $this->description->render();
+        return $this->version . ($this->description ? ' ' . $this->description->render() : '');
     }
 }

tests/unit/DocBlock/Tags/VersionTest.php

@@ -0,0 +1,165 @@
+<?php
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright 2010-2015 Mike van Riel<[email protected]>
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\DocBlock\Tags;
+
+use Mockery as m;
+use phpDocumentor\Reflection\DocBlock\Description;
+use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
+use phpDocumentor\Reflection\Types\Context;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\DocBlock\Tags\Version
+ * @covers ::<private>
+ */
+class VersionTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Version::__construct
+     * @uses   \phpDocumentor\Reflection\DocBlock\Description
+     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName
+     */
+    public function testIfCorrectTagNameIsReturned()
+    {
+        $fixture = new Version('1.0', new Description('Description'));
+
+        $this->assertSame('version', $fixture->getName());
+    }
+
+    /**
+     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Version::__construct
+     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Version::__toString
+     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter
+     * @uses   \phpDocumentor\Reflection\DocBlock\Description
+     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render
+     */
+    public function testIfTagCanBeRenderedUsingDefaultFormatter()
+    {
+        $fixture = new Version('1.0', new Description('Description'));
+
+        $this->assertSame('1.0 Description', $fixture->render());
+    }
+
+    /**
+     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Version::__construct
+     * @uses   \phpDocumentor\Reflection\DocBlock\Description
+     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render
+     */
+    public function testIfTagCanBeRenderedUsingSpecificFormatter()
+    {
+        $fixture = new Version('1.0', new Description('Description'));
+
+        $formatter = m::mock(Formatter::class);
+        $formatter->shouldReceive('format')->with($fixture)->andReturn('Rendered output');
+
+        $this->assertSame('Rendered output', $fixture->render($formatter));
+    }
+
+    /**
+     * @covers ::__construct
+     * @covers ::getVersion
+     */
+    public function testHasVersionNumber()
+    {
+        $expected = '1.0';
+
+        $fixture = new Version($expected);
+
+        $this->assertSame($expected, $fixture->getVersion());
+    }
+
+    /**
+     * @covers ::__construct
+     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription
+     * @uses   \phpDocumentor\Reflection\DocBlock\Description
+     */
+    public function testHasDescription()
+    {
+        $expected = new Description('Description');
+
+        $fixture = new Version('1.0', $expected);
+
+        $this->assertSame($expected, $fixture->getDescription());
+    }
+
+    /**
+     * @covers ::__construct
+     * @covers ::__toString
+     * @uses   \phpDocumentor\Reflection\DocBlock\Description
+     */
+    public function testStringRepresentationIsReturned()
+    {
+        $fixture = new Version('1.0', new Description('Description'));
+
+        $this->assertSame('1.0 Description', (string)$fixture);
+    }
+
+    /**
+     * @covers ::create
+     * @uses \phpDocumentor\Reflection\DocBlock\Tags\Version::<public>
+     * @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
+     * @uses \phpDocumentor\Reflection\DocBlock\Description
+     * @uses \phpDocumentor\Reflection\Types\Context
+     */
+    public function testFactoryMethod()
+    {
+        $descriptionFactory = m::mock(DescriptionFactory::class);
+        $context            = new Context('');
+
+        $version     = '1.0';
+        $description = new Description('My Description');
+
+        $descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
+
+        $fixture = Version::create('1.0 My Description', $descriptionFactory, $context);
+
+        $this->assertSame('1.0 My Description', (string)$fixture);
+        $this->assertSame($version, $fixture->getVersion());
+        $this->assertSame($description, $fixture->getDescription());
+    }
+
+    /**
+     * @covers ::create
+     * @uses \phpDocumentor\Reflection\DocBlock\Tags\Version::<public>
+     * @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
+     * @uses \phpDocumentor\Reflection\DocBlock\Description
+     * @uses \phpDocumentor\Reflection\Types\Context
+     */
+    public function testFactoryMethodCreatesEmptyVersionTag()
+    {
+        $descriptionFactory = m::mock(DescriptionFactory::class);
+        $descriptionFactory->shouldReceive('create')->never();
+
+        $fixture = Version::create('', $descriptionFactory, new Context(''));
+
+        $this->assertSame('', (string)$fixture);
+        $this->assertSame(null, $fixture->getVersion());
+        $this->assertSame(null, $fixture->getDescription());
+    }
+
+    /**
+     * @covers ::create
+     * @expectedException \InvalidArgumentException
+     */
+    public function testFactoryMethodFailsIfVersionIsNotString()
+    {
+        $this->assertNull(Version::create([]));
+    }
+
+    /**
+     * @covers ::create
+     */
+    public function testFactoryMethodReturnsNullIfBodyDoesNotMatchRegex()
+    {
+        $this->assertNull(Version::create('dkhf<'));
+    }
+}