DocBlockTest::tearDown() - Code Metrics - Inspection of "Fix tests" - phpDocumentor/ReflectionDocBlock - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 03b704...7524ab )

by Jaap

created 2017-11-15 07:29 UTC

DocBlockTest::tearDown() A

↳ Parent: DocBlockTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?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;

use Mockery as m;
use phpDocumentor\Reflection\DocBlock\Tags\Deprecated;
use phpDocumentor\Reflection\Types\Context;
use PHPUnit\Framework\TestCase;

/**
 * @coversDefaultClass phpDocumentor\Reflection\DocBlock
 * @covers ::<private>
 * @uses \Webmozart\Assert\Assert
 */
class DocBlockTest extends TestCase
{
    /**
     * Call Mockery::close after each test.
     */
    public function tearDown()
    {
        m::close();
    }

    /**
     * @covers ::__construct
     * @covers ::getSummary
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     */
    public function testDocBlockCanHaveASummary()
    {
        $summary = 'This is a summary';

        $fixture = new DocBlock($summary);

        $this->assertSame($summary, $fixture->getSummary());
    }

    /**
     * @covers ::__construct
     *
     * @expectedException \InvalidArgumentException
     */
    public function testExceptionIsThrownIfSummaryIsNotAString()
    {
        new DocBlock([]);
    }

    /**
     * @covers ::__construct
     *
     * @expectedException \InvalidArgumentException
     */
    public function testExceptionIsThrownIfTemplateStartIsNotABoolean()
    {
        new DocBlock('', null, [], null, null, ['is not boolean']);
    }

    /**
     * @covers ::__construct
     *
     * @expectedException \InvalidArgumentException
     */
    public function testExceptionIsThrownIfTemplateEndIsNotABoolean()
    {
        new DocBlock('', null, [], null, null, false, ['is not boolean']);
    }

    /**
     * @covers ::__construct
     * @covers ::getDescription
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     */
    public function testDocBlockCanHaveADescription()
    {
        $description = new DocBlock\Description('');

        $fixture = new DocBlock('', $description);

        $this->assertSame($description, $fixture->getDescription());
    }

    /**
     * @covers ::__construct
     * @covers ::getTags
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\DocBlock\Tag
     */
    public function testDocBlockCanHaveTags()
    {
        $tags = [
            m::mock(DocBlock\Tag::class)
        ];

        $fixture = new DocBlock('', null, $tags);

        $this->assertSame($tags, $fixture->getTags());
    }

    /**
     * @covers ::__construct
     * @covers ::getTags
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\DocBlock\Tag
     *
     * @expectedException \InvalidArgumentException
     */
    public function testDocBlockAllowsOnlyTags()
    {
        $tags = [
            null
        ];

        $fixture = new DocBlock('', null, $tags);
    }

    /**
     * @covers ::__construct
     * @covers ::getTagsByName
     *
     * @uses \phpDocumentor\Reflection\DocBlock::getTags
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\DocBlock\Tag
     */
    public function testFindTagsInDocBlockByName()
    {
        $tag1 = m::mock(DocBlock\Tag::class);
        $tag2 = m::mock(DocBlock\Tag::class);
        $tag3 = m::mock(DocBlock\Tag::class);
        $tags = [$tag1, $tag2, $tag3];

        $tag1->shouldReceive('getName')->andReturn('abc');
        $tag2->shouldReceive('getName')->andReturn('abcd');
        $tag3->shouldReceive('getName')->andReturn('ab');

        $fixture = new DocBlock('', null, $tags);

        $this->assertSame([$tag2], $fixture->getTagsByName('abcd'));
        $this->assertSame([], $fixture->getTagsByName('Ebcd'));
    }

    /**
     * @covers ::__construct
     * @covers ::getTagsByName
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @expectedException \InvalidArgumentException
     */
    public function testExceptionIsThrownIfNameForTagsIsNotString()
    {
        $fixture = new DocBlock();
        $fixture->getTagsByName([]);
    }

    /**
     * @covers ::__construct
     * @covers ::hasTag
     *
     * @uses \phpDocumentor\Reflection\DocBlock::getTags
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\DocBlock\Tag
     */
    public function testCheckIfThereAreTagsWithAGivenName()
    {
        $tag1 = m::mock(DocBlock\Tag::class);
        $tag2 = m::mock(DocBlock\Tag::class);
        $tag3 = m::mock(DocBlock\Tag::class);
        $tags = [$tag1, $tag2, $tag3];

        $tag1->shouldReceive('getName')->twice()->andReturn('abc');
        $tag2->shouldReceive('getName')->twice()->andReturn('abcd');
        $tag3->shouldReceive('getName')->once();

        $fixture = new DocBlock('', null, $tags);

        $this->assertTrue($fixture->hasTag('abcd'));
        $this->assertFalse($fixture->hasTag('Ebcd'));
    }

    /**
     * @covers ::__construct
     * @covers ::hasTag
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @expectedException \InvalidArgumentException
     */
    public function testExceptionIsThrownIfNameForCheckingTagsIsNotString()
    {
        $fixture = new DocBlock();
        $fixture->hasTag([]);
    }

    /**
     * @covers ::__construct
     * @covers ::getContext
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\Types\Context
     */
    public function testDocBlockKnowsInWhichNamespaceItIsAndWhichAliasesThereAre()
    {
        $context = new Context('');

        $fixture = new DocBlock('', null, [], $context);

        $this->assertSame($context, $fixture->getContext());
    }

    /**
     * @covers ::__construct
     * @covers ::getLocation
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\Location
     */
    public function testDocBlockKnowsAtWhichLineItIs()
    {
        $location = new Location(10);

        $fixture = new DocBlock('', null, [], null, $location);

        $this->assertSame($location, $fixture->getLocation());
    }

    /**
     * @covers ::__construct
     * @covers ::isTemplateStart
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     */
    public function testDocBlockKnowsIfItIsTheStartOfADocBlockTemplate()
    {
        $fixture = new DocBlock('', null, [], null, null, true);

        $this->assertTrue($fixture->isTemplateStart());
    }

    /**
     * @covers ::__construct
     * @covers ::isTemplateEnd
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     */
    public function testDocBlockKnowsIfItIsTheEndOfADocBlockTemplate()
    {
        $fixture = new DocBlock('', null, [], null, null, false, true);

        $this->assertTrue($fixture->isTemplateEnd());
    }

    /**
     * @covers ::__construct
     * @covers ::removeTag
     *
     * @uses \phpDocumentor\Reflection\DocBlock\Tags\Deprecated
     */
    public function testRemoveTag()
    {
        $someTag = new Deprecated();
        $anotherTag = new Deprecated();

        $fixture = new DocBlock('', null, [$someTag]);

        $this->assertCount(1, $fixture->getTags());

        $fixture->removeTag($anotherTag);

        $this->assertCount(1, $fixture->getTags());

        $fixture->removeTag($someTag);

        $this->assertCount(0, $fixture->getTags());
    }
}


1			<?php
2			/**
3			* This file is part of phpDocumentor.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*
8			* @copyright 2010-2015 Mike van Riel<[email protected]>
9			* @license http://www.opensource.org/licenses/mit-license.php MIT
10			* @link http://phpdoc.org
11			*/
12
13			namespace phpDocumentor\Reflection;
14
15			use Mockery as m;
16			use phpDocumentor\Reflection\DocBlock\Tags\Deprecated;
17			use phpDocumentor\Reflection\Types\Context;
18			use PHPUnit\Framework\TestCase;
19
20			/**
21			* @coversDefaultClass phpDocumentor\Reflection\DocBlock
22			* @covers ::<private>
23			* @uses \Webmozart\Assert\Assert
24			*/
25			class DocBlockTest extends TestCase
26			{
27			/**
28			* Call Mockery::close after each test.
29			*/
30			public function tearDown()
31			{
32			m::close();
33			}
34
35			/**
36			* @covers ::__construct
37			* @covers ::getSummary
38			*
39			* @uses \phpDocumentor\Reflection\DocBlock\Description
40			*/
41			public function testDocBlockCanHaveASummary()
42			{
43			$summary = 'This is a summary';
44
45			$fixture = new DocBlock($summary);
46
47			$this->assertSame($summary, $fixture->getSummary());
48			}
49
50			/**
51			* @covers ::__construct
52			*
53			* @expectedException \InvalidArgumentException
54			*/
55			public function testExceptionIsThrownIfSummaryIsNotAString()
56			{
57			new DocBlock([]);
58			}
59
60			/**
61			* @covers ::__construct
62			*
63			* @expectedException \InvalidArgumentException
64			*/
65			public function testExceptionIsThrownIfTemplateStartIsNotABoolean()
66			{
67			new DocBlock('', null, [], null, null, ['is not boolean']);
68			}
69
70			/**
71			* @covers ::__construct
72			*
73			* @expectedException \InvalidArgumentException
74			*/
75			public function testExceptionIsThrownIfTemplateEndIsNotABoolean()
76			{
77			new DocBlock('', null, [], null, null, false, ['is not boolean']);
78			}
79
80			/**
81			* @covers ::__construct
82			* @covers ::getDescription
83			*
84			* @uses \phpDocumentor\Reflection\DocBlock\Description
85			*/
86			public function testDocBlockCanHaveADescription()
87			{
88			$description = new DocBlock\Description('');
89
90			$fixture = new DocBlock('', $description);
91
92			$this->assertSame($description, $fixture->getDescription());
93			}
94
95			/**
96			* @covers ::__construct
97			* @covers ::getTags
98			*
99			* @uses \phpDocumentor\Reflection\DocBlock\Description
100			* @uses \phpDocumentor\Reflection\DocBlock\Tag
101			*/
102			public function testDocBlockCanHaveTags()
103			{
104			$tags = [
105			m::mock(DocBlock\Tag::class)
106			];
107
108			$fixture = new DocBlock('', null, $tags);
109
110			$this->assertSame($tags, $fixture->getTags());
111			}
112
113			/**
114			* @covers ::__construct
115			* @covers ::getTags
116			*
117			* @uses \phpDocumentor\Reflection\DocBlock\Description
118			* @uses \phpDocumentor\Reflection\DocBlock\Tag
119			*
120			* @expectedException \InvalidArgumentException
121			*/
122			public function testDocBlockAllowsOnlyTags()
123			{
124			$tags = [
125			null
126			];
127
128			$fixture = new DocBlock('', null, $tags);
129			}
130
131			/**
132			* @covers ::__construct
133			* @covers ::getTagsByName
134			*
135			* @uses \phpDocumentor\Reflection\DocBlock::getTags
136			* @uses \phpDocumentor\Reflection\DocBlock\Description
137			* @uses \phpDocumentor\Reflection\DocBlock\Tag
138			*/
139			public function testFindTagsInDocBlockByName()
140			{
141			$tag1 = m::mock(DocBlock\Tag::class);
142			$tag2 = m::mock(DocBlock\Tag::class);
143			$tag3 = m::mock(DocBlock\Tag::class);
144			$tags = [$tag1, $tag2, $tag3];
145
146			$tag1->shouldReceive('getName')->andReturn('abc');
147			$tag2->shouldReceive('getName')->andReturn('abcd');
148			$tag3->shouldReceive('getName')->andReturn('ab');
149
150			$fixture = new DocBlock('', null, $tags);
151
152			$this->assertSame([$tag2], $fixture->getTagsByName('abcd'));
153			$this->assertSame([], $fixture->getTagsByName('Ebcd'));
154			}
155
156			/**
157			* @covers ::__construct
158			* @covers ::getTagsByName
159			* @uses \phpDocumentor\Reflection\DocBlock\Description
160			* @expectedException \InvalidArgumentException
161			*/
162			public function testExceptionIsThrownIfNameForTagsIsNotString()
163			{
164			$fixture = new DocBlock();
165			$fixture->getTagsByName([]);
166			}
167
168			/**
169			* @covers ::__construct
170			* @covers ::hasTag
171			*
172			* @uses \phpDocumentor\Reflection\DocBlock::getTags
173			* @uses \phpDocumentor\Reflection\DocBlock\Description
174			* @uses \phpDocumentor\Reflection\DocBlock\Tag
175			*/
176			public function testCheckIfThereAreTagsWithAGivenName()
177			{
178			$tag1 = m::mock(DocBlock\Tag::class);
179			$tag2 = m::mock(DocBlock\Tag::class);
180			$tag3 = m::mock(DocBlock\Tag::class);
181			$tags = [$tag1, $tag2, $tag3];
182
183			$tag1->shouldReceive('getName')->twice()->andReturn('abc');
184			$tag2->shouldReceive('getName')->twice()->andReturn('abcd');
185			$tag3->shouldReceive('getName')->once();
186
187			$fixture = new DocBlock('', null, $tags);
188
189			$this->assertTrue($fixture->hasTag('abcd'));
190			$this->assertFalse($fixture->hasTag('Ebcd'));
191			}
192
193			/**
194			* @covers ::__construct
195			* @covers ::hasTag
196			* @uses \phpDocumentor\Reflection\DocBlock\Description
197			* @expectedException \InvalidArgumentException
198			*/
199			public function testExceptionIsThrownIfNameForCheckingTagsIsNotString()
200			{
201			$fixture = new DocBlock();
202			$fixture->hasTag([]);
203			}
204
205			/**
206			* @covers ::__construct
207			* @covers ::getContext
208			*
209			* @uses \phpDocumentor\Reflection\DocBlock\Description
210			* @uses \phpDocumentor\Reflection\Types\Context
211			*/
212			public function testDocBlockKnowsInWhichNamespaceItIsAndWhichAliasesThereAre()
213			{
214			$context = new Context('');
215
216			$fixture = new DocBlock('', null, [], $context);
217
218			$this->assertSame($context, $fixture->getContext());
219			}
220
221			/**
222			* @covers ::__construct
223			* @covers ::getLocation
224			*
225			* @uses \phpDocumentor\Reflection\DocBlock\Description
226			* @uses \phpDocumentor\Reflection\Location
227			*/
228			public function testDocBlockKnowsAtWhichLineItIs()
229			{
230			$location = new Location(10);
231
232			$fixture = new DocBlock('', null, [], null, $location);
233
234			$this->assertSame($location, $fixture->getLocation());
235			}
236
237			/**
238			* @covers ::__construct
239			* @covers ::isTemplateStart
240			*
241			* @uses \phpDocumentor\Reflection\DocBlock\Description
242			*/
243			public function testDocBlockKnowsIfItIsTheStartOfADocBlockTemplate()
244			{
245			$fixture = new DocBlock('', null, [], null, null, true);
246
247			$this->assertTrue($fixture->isTemplateStart());
248			}
249
250			/**
251			* @covers ::__construct
252			* @covers ::isTemplateEnd
253			*
254			* @uses \phpDocumentor\Reflection\DocBlock\Description
255			*/
256			public function testDocBlockKnowsIfItIsTheEndOfADocBlockTemplate()
257			{
258			$fixture = new DocBlock('', null, [], null, null, false, true);
259
260			$this->assertTrue($fixture->isTemplateEnd());
261			}
262
263			/**
264			* @covers ::__construct
265			* @covers ::removeTag
266			*
267			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Deprecated
268			*/
269			public function testRemoveTag()
270			{
271			$someTag = new Deprecated();
272			$anotherTag = new Deprecated();
273
274			$fixture = new DocBlock('', null, [$someTag]);
275
276			$this->assertCount(1, $fixture->getTags());
277
278			$fixture->removeTag($anotherTag);
279
280			$this->assertCount(1, $fixture->getTags());
281
282			$fixture->removeTag($someTag);
283
284			$this->assertCount(0, $fixture->getTags());
285			}
286			}
287

phpDocumentor / ReflectionDocBlock

Push — master ( 03b704...7524ab )

DocBlockTest::tearDown() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like