UsesTest::testFactoryMethodWithoutSpaceBeforeClass() - Code Metrics - Inspection of "Merge pull request #262 from voku/more_tests" - phpDocumentor/ReflectionDocBlock - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e3324e...f8d350 )

by Jaap

created 2021-03-07 11:12 UTC

testFactoryMethodWithoutSpaceBeforeClass() A

↳ Parent: UsesTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

/**
 * 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.
 *
 * @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\DocBlock\StandardTagFactory;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\FqsenResolver;
use phpDocumentor\Reflection\Types\Context;
use PHPUnit\Framework\TestCase;

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

    /**
     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Uses::__construct
     * @uses   \phpDocumentor\Reflection\DocBlock\Description
     *
     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName
     */
    public function testIfCorrectTagNameIsReturned() : void
    {
        $fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));

        $this->assertSame('uses', $fixture->getName());
    }

    /**
     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Uses::__construct
     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Uses::__toString
     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter
     * @uses   \phpDocumentor\Reflection\DocBlock\Description
     *
     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render
     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName
     */
    public function testIfTagCanBeRenderedUsingDefaultFormatter() : void
    {
        $fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));

        $this->assertSame('@uses \DateTime Description', $fixture->render());
    }

    /**
     * @uses   \phpDocumentor\Reflection\DocBlock\Tags\Uses::__construct
     * @uses   \phpDocumentor\Reflection\DocBlock\Description
     *
     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render
     */
    public function testIfTagCanBeRenderedUsingSpecificFormatter() : void
    {
        $fixture = new Uses(new Fqsen('\DateTime'), 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 ::getReference
     */
    public function testHasReferenceToFqsen() : void
    {
        $expected = new Fqsen('\DateTime');

        $fixture = new Uses($expected);

        $this->assertSame($expected, $fixture->getReference());
    }

    /**
     * @uses   \phpDocumentor\Reflection\DocBlock\Description
     *
     * @covers ::__construct
     * @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription
     */
    public function testHasDescription() : void
    {
        $expected = new Description('Description');

        $fixture = new Uses(new Fqsen('\DateTime'), $expected);

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

    /**
     * @uses   \phpDocumentor\Reflection\DocBlock\Description
     *
     * @covers ::__construct
     * @covers ::__toString
     */
    public function testStringRepresentationIsReturned() : void
    {
        $fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));

        $this->assertSame('\DateTime Description', (string) $fixture);
    }

    /**
     * @uses   \phpDocumentor\Reflection\DocBlock\Description
     *
     * @covers ::__construct
     * @covers ::__toString
     */
    public function testStringRepresentationIsReturnedWithoutDescription() : void
    {
        $fixture = new Uses(new Fqsen('\\'));

        $this->assertSame('\\', (string) $fixture);

        // ---

        $fixture = new Uses(new Fqsen('\DateTime'));

        $this->assertSame('\DateTime', (string) $fixture);

        // ---

        $fixture = new Uses(new Fqsen('\DateTime'), new Description(''));

        $this->assertSame('\DateTime', (string) $fixture);
    }

    /**
     * @uses \phpDocumentor\Reflection\DocBlock\Tags\Uses::<public>
     * @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses \phpDocumentor\Reflection\FqsenResolver
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\Fqsen
     * @uses \phpDocumentor\Reflection\Types\Context
     *
     * @covers ::create
     */
    public function testFactoryMethod() : void
    {
        $descriptionFactory = m::mock(DescriptionFactory::class);
        $resolver           = m::mock(FqsenResolver::class);
        $context            = new Context('');

        $fqsen       = new Fqsen('\DateTime');
        $description = new Description('My Description');

        $descriptionFactory
            ->shouldReceive('create')->with('My Description', $context)->andReturn($description);
        $resolver->shouldReceive('resolve')->with('DateTime', $context)->andReturn($fqsen);

        $fixture = Uses::create('DateTime My Description', $resolver, $descriptionFactory, $context);

        $this->assertSame('\DateTime My Description', (string) $fixture);
        $this->assertSame($fqsen, $fixture->getReference());
        $this->assertSame($description, $fixture->getDescription());
    }

    /**
     * @uses \phpDocumentor\Reflection\DocBlock\Tags\See::<public>
     * @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses \phpDocumentor\Reflection\FqsenResolver
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\DocBlock\Tags\Reference\Url
     * @uses \phpDocumentor\Reflection\Types\Context
     *
     * @covers ::create
     */
    public function testFactoryMethodWithoutSpaceBeforeClass() : void
    {
        $fqsenResolver      = new FqsenResolver();
        $tagFactory         = new StandardTagFactory($fqsenResolver);
        $descriptionFactory = new DescriptionFactory($tagFactory);
        $context            = new Context('');

        $fixture = Uses::create(
            'Foo My Description ',
            $fqsenResolver,
            $descriptionFactory,
            $context
        );

        $this->assertSame('\Foo My Description ', (string) $fixture);
        $this->assertInstanceOf(Fqsen::class, $fixture->getReference());
        $this->assertSame('\\Foo', (string) $fixture->getReference());
        $this->assertSame('My Description ', $fixture->getDescription() . '');
    }

    /**
     * @uses \phpDocumentor\Reflection\DocBlock\Tags\See::<public>
     * @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses \phpDocumentor\Reflection\FqsenResolver
     * @uses \phpDocumentor\Reflection\DocBlock\Description
     * @uses \phpDocumentor\Reflection\DocBlock\Tags\Reference\Url
     * @uses \phpDocumentor\Reflection\Types\Context
     *
     * @covers ::create
     */
    public function testFactoryMethodWithSpaceBeforeClass() : void
    {
        $fqsenResolver      = new FqsenResolver();
        $tagFactory         = new StandardTagFactory($fqsenResolver);
        $descriptionFactory = new DescriptionFactory($tagFactory);
        $context            = new Context('');

        $fixture = Uses::create(
            ' Foo My Description ',
            $fqsenResolver,
            $descriptionFactory,
            $context
        );

        $this->assertSame('\ Foo My Description ', (string) $fixture);
        $this->assertInstanceOf(Fqsen::class, $fixture->getReference());
        $this->assertSame('\\', (string) $fixture->getReference());
        $this->assertSame('Foo My Description ', $fixture->getDescription() . '');
    }

    /**
     * @covers ::create
     */
    public function testFactoryMethodFailsIfBodyIsNotEmpty() : void
    {
        $this->expectException('InvalidArgumentException');
        $this->assertNull(Uses::create(''));
    }

    /**
     * @covers ::create
     */
    public function testFactoryMethodFailsIfResolverIsNull() : void
    {
        $this->expectException('InvalidArgumentException');
        Uses::create('body');
    }

    /**
     * @covers ::create
     */
    public function testFactoryMethodFailsIfDescriptionFactoryIsNull() : void
    {
        $this->expectException('InvalidArgumentException');
        Uses::create('body', new FqsenResolver());
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* This file is part of phpDocumentor.
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*
11			* @link http://phpdoc.org
12			*/
13
14			namespace phpDocumentor\Reflection\DocBlock\Tags;
15
16			use Mockery as m;
17			use phpDocumentor\Reflection\DocBlock\Description;
18			use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
19			use phpDocumentor\Reflection\DocBlock\StandardTagFactory;
20			use phpDocumentor\Reflection\Fqsen;
21			use phpDocumentor\Reflection\FqsenResolver;
22			use phpDocumentor\Reflection\Types\Context;
23			use PHPUnit\Framework\TestCase;
24
25			/**
26			* @coversDefaultClass \phpDocumentor\Reflection\DocBlock\Tags\Uses
27			* @covers ::<private>
28			*/
29			class UsesTest extends TestCase
30			{
31			/**
32			* Call Mockery::close after each test.
33			*/
34			public function tearDown() : void
35			{
36			m::close();
37			}
38
39			/**
40			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Uses::__construct
41			* @uses \phpDocumentor\Reflection\DocBlock\Description
42			*
43			* @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName
44			*/
45			public function testIfCorrectTagNameIsReturned() : void
46			{
47			$fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));
48
49			$this->assertSame('uses', $fixture->getName());
50			}
51
52			/**
53			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Uses::__construct
54			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Uses::__toString
55			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter
56			* @uses \phpDocumentor\Reflection\DocBlock\Description
57			*
58			* @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render
59			* @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName
60			*/
61			public function testIfTagCanBeRenderedUsingDefaultFormatter() : void
62			{
63			$fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));
64
65			$this->assertSame('@uses \DateTime Description', $fixture->render());
66			}
67
68			/**
69			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Uses::__construct
70			* @uses \phpDocumentor\Reflection\DocBlock\Description
71			*
72			* @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render
73			*/
74			public function testIfTagCanBeRenderedUsingSpecificFormatter() : void
75			{
76			$fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));
77
78			$formatter = m::mock(Formatter::class);
79			$formatter->shouldReceive('format')->with($fixture)->andReturn('Rendered output');
80
81			$this->assertSame('Rendered output', $fixture->render($formatter));
82			}
83
84			/**
85			* @covers ::__construct
86			* @covers ::getReference
87			*/
88			public function testHasReferenceToFqsen() : void
89			{
90			$expected = new Fqsen('\DateTime');
91
92			$fixture = new Uses($expected);
93
94			$this->assertSame($expected, $fixture->getReference());
95			}
96
97			/**
98			* @uses \phpDocumentor\Reflection\DocBlock\Description
99			*
100			* @covers ::__construct
101			* @covers \phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription
102			*/
103			public function testHasDescription() : void
104			{
105			$expected = new Description('Description');
106
107			$fixture = new Uses(new Fqsen('\DateTime'), $expected);
108
109			$this->assertSame($expected, $fixture->getDescription());
110			}
111
112			/**
113			* @uses \phpDocumentor\Reflection\DocBlock\Description
114			*
115			* @covers ::__construct
116			* @covers ::__toString
117			*/
118			public function testStringRepresentationIsReturned() : void
119			{
120			$fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));
121
122			$this->assertSame('\DateTime Description', (string) $fixture);
123			}
124
125			/**
126			* @uses \phpDocumentor\Reflection\DocBlock\Description
127			*
128			* @covers ::__construct
129			* @covers ::__toString
130			*/
131			public function testStringRepresentationIsReturnedWithoutDescription() : void
132			{
133			$fixture = new Uses(new Fqsen('\\'));
134
135			$this->assertSame('\\', (string) $fixture);
136
137			// ---
138
139			$fixture = new Uses(new Fqsen('\DateTime'));
140
141			$this->assertSame('\DateTime', (string) $fixture);
142
143			// ---
144
145			$fixture = new Uses(new Fqsen('\DateTime'), new Description(''));
146
147			$this->assertSame('\DateTime', (string) $fixture);
148			}
149
150			/**
151			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Uses::<public>
152			* @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
153			* @uses \phpDocumentor\Reflection\FqsenResolver
154			* @uses \phpDocumentor\Reflection\DocBlock\Description
155			* @uses \phpDocumentor\Reflection\Fqsen
156			* @uses \phpDocumentor\Reflection\Types\Context
157			*
158			* @covers ::create
159			*/
160			public function testFactoryMethod() : void
161			{
162			$descriptionFactory = m::mock(DescriptionFactory::class);
163			$resolver = m::mock(FqsenResolver::class);
164			$context = new Context('');
165
166			$fqsen = new Fqsen('\DateTime');
167			$description = new Description('My Description');
168
169			$descriptionFactory
170			->shouldReceive('create')->with('My Description', $context)->andReturn($description);
171			$resolver->shouldReceive('resolve')->with('DateTime', $context)->andReturn($fqsen);
172
173			$fixture = Uses::create('DateTime My Description', $resolver, $descriptionFactory, $context);
174
175			$this->assertSame('\DateTime My Description', (string) $fixture);
176			$this->assertSame($fqsen, $fixture->getReference());
177			$this->assertSame($description, $fixture->getDescription());
178			}
179
180			/**
181			* @uses \phpDocumentor\Reflection\DocBlock\Tags\See::<public>
182			* @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
183			* @uses \phpDocumentor\Reflection\FqsenResolver
184			* @uses \phpDocumentor\Reflection\DocBlock\Description
185			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Reference\Url
186			* @uses \phpDocumentor\Reflection\Types\Context
187			*
188			* @covers ::create
189			*/
190			public function testFactoryMethodWithoutSpaceBeforeClass() : void
191			{
192			$fqsenResolver = new FqsenResolver();
193			$tagFactory = new StandardTagFactory($fqsenResolver);
194			$descriptionFactory = new DescriptionFactory($tagFactory);
195			$context = new Context('');
196
197			$fixture = Uses::create(
198			'Foo My Description ',
199			$fqsenResolver,
200			$descriptionFactory,
201			$context
202			);
203
204			$this->assertSame('\Foo My Description ', (string) $fixture);
205			$this->assertInstanceOf(Fqsen::class, $fixture->getReference());
206			$this->assertSame('\\Foo', (string) $fixture->getReference());
207			$this->assertSame('My Description ', $fixture->getDescription() . '');
208			}
209
210			/**
211			* @uses \phpDocumentor\Reflection\DocBlock\Tags\See::<public>
212			* @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
213			* @uses \phpDocumentor\Reflection\FqsenResolver
214			* @uses \phpDocumentor\Reflection\DocBlock\Description
215			* @uses \phpDocumentor\Reflection\DocBlock\Tags\Reference\Url
216			* @uses \phpDocumentor\Reflection\Types\Context
217			*
218			* @covers ::create
219			*/
220			public function testFactoryMethodWithSpaceBeforeClass() : void
221			{
222			$fqsenResolver = new FqsenResolver();
223			$tagFactory = new StandardTagFactory($fqsenResolver);
224			$descriptionFactory = new DescriptionFactory($tagFactory);
225			$context = new Context('');
226
227			$fixture = Uses::create(
228			' Foo My Description ',
229			$fqsenResolver,
230			$descriptionFactory,
231			$context
232			);
233
234			$this->assertSame('\ Foo My Description ', (string) $fixture);
235			$this->assertInstanceOf(Fqsen::class, $fixture->getReference());
236			$this->assertSame('\\', (string) $fixture->getReference());
237			$this->assertSame('Foo My Description ', $fixture->getDescription() . '');
238			}
239
240			/**
241			* @covers ::create
242			*/
243			public function testFactoryMethodFailsIfBodyIsNotEmpty() : void
244			{
245			$this->expectException('InvalidArgumentException');
246			$this->assertNull(Uses::create(''));
247			}
248
249			/**
250			* @covers ::create
251			*/
252			public function testFactoryMethodFailsIfResolverIsNull() : void
253			{
254			$this->expectException('InvalidArgumentException');
255			Uses::create('body');
256			}
257
258			/**
259			* @covers ::create
260			*/
261			public function testFactoryMethodFailsIfDescriptionFactoryIsNull() : void
262			{
263			$this->expectException('InvalidArgumentException');
264			Uses::create('body', new FqsenResolver());
265			}
266			}
267

phpDocumentor / ReflectionDocBlock

Push — master ( e3324e...f8d350 )

testFactoryMethodWithoutSpaceBeforeClass() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like