DocBlockFactoryTest::testSummaryAndDescriptionAreSeparated() - Code Metrics - Inspection of "install php71-xdebug and package-coverage-file" - arunfung/laravel-package-develop - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 72a6c5...9329b7 )

by Arun

created 2017-05-21 15:57 UTC

testSummaryAndDescriptionAreSeparated() A

↳ Parent: DocBlockFactoryTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	3
dl	0
loc	10
rs	9.4285
c	0
b	0
f	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\Description;
use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\TagFactory;
use phpDocumentor\Reflection\DocBlock\Tags\Param;
use phpDocumentor\Reflection\Types\Context;

/**
 * @coversDefaultClass phpDocumentor\Reflection\DocBlockFactory
 * @covers             ::<private>
 * @uses               \Webmozart\Assert\Assert
 * @uses               phpDocumentor\Reflection\DocBlock
 */
class DocBlockFactoryTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @covers ::__construct
     * @covers ::createInstance
     * @uses \phpDocumentor\Reflection\DocBlock\StandardTagFactory
     * @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
     */
    public function testCreateFactoryUsingFactoryMethod()
    {
        $fixture = DocBlockFactory::createInstance();

        $this->assertInstanceOf(DocBlockFactory::class, $fixture);
    }

    /**
     * @covers ::__construct
     * @covers ::create
     * @uses   phpDocumentor\Reflection\DocBlock\Description
     */
    public function testCreateDocBlockFromReflection()
    {
        $fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));

        $docBlock       = '/** This is a DocBlock */';
        $classReflector = m::mock(\ReflectionClass::class);
        $classReflector->shouldReceive('getDocComment')->andReturn($docBlock);
        $docblock = $fixture->create($classReflector);

        $this->assertInstanceOf(DocBlock::class, $docblock);
        $this->assertSame('This is a DocBlock', $docblock->getSummary());
        $this->assertEquals(new Description(''), $docblock->getDescription());
        $this->assertSame([], $docblock->getTags());
        $this->assertEquals(new Context(''), $docblock->getContext());
        $this->assertNull($docblock->getLocation());
    }

    /**
     * @covers ::__construct
     * @covers ::create
     * @uses   phpDocumentor\Reflection\DocBlock\Description
     */
    public function testCreateDocBlockFromStringWithDocComment()

    {
        $fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));

        $docblock = $fixture->create('/** This is a DocBlock */');

        $this->assertInstanceOf(DocBlock::class, $docblock);
        $this->assertSame('This is a DocBlock', $docblock->getSummary());
        $this->assertEquals(new Description(''), $docblock->getDescription());
        $this->assertSame([], $docblock->getTags());
        $this->assertEquals(new Context(''), $docblock->getContext());
        $this->assertNull($docblock->getLocation());
    }

    /**
     * @covers ::create
     * @covers ::__construct
     * @uses   phpDocumentor\Reflection\DocBlock\Description
     */
    public function testCreateDocBlockFromStringWithoutDocComment()

    {
        $fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));

        $docblock = $fixture->create('This is a DocBlock');

        $this->assertInstanceOf(DocBlock::class, $docblock);
        $this->assertSame('This is a DocBlock', $docblock->getSummary());
        $this->assertEquals(new Description(''), $docblock->getDescription());
        $this->assertSame([], $docblock->getTags());
        $this->assertEquals(new Context(''), $docblock->getContext());
        $this->assertNull($docblock->getLocation());
    }

    /**
     * @covers ::__construct
     * @covers ::create
     * @uses         phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses         phpDocumentor\Reflection\DocBlock\Description
     * @dataProvider provideSummaryAndDescriptions
     */
    public function testSummaryAndDescriptionAreSeparated($given, $summary, $description)
    {
        $tagFactory = m::mock(TagFactory::class);
        $fixture    = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);

        $docblock = $fixture->create($given);

        $this->assertSame($summary, $docblock->getSummary());
        $this->assertEquals(new Description($description), $docblock->getDescription());
    }

    /**
     * @covers ::__construct
     * @covers ::create
     * @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses phpDocumentor\Reflection\DocBlock\Description
     */
    public function testDescriptionsRetainFormatting()
    {
        $tagFactory = m::mock(TagFactory::class);
        $fixture    = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);

        $given = <<<DOCBLOCK
/**
 * This is a summary.
 * This is a multiline Description
 * that contains a code block.
 *
 *     See here: a CodeBlock
 */
DOCBLOCK;

        $description = <<<DESCRIPTION
This is a multiline Description
that contains a code block.

    See here: a CodeBlock
DESCRIPTION;

        $docblock = $fixture->create($given);

        $this->assertEquals(new Description($description), $docblock->getDescription());
    }

    /**
     * @covers ::__construct
     * @covers ::create
     * @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses phpDocumentor\Reflection\DocBlock\Description
     */
    public function testTagsAreInterpretedUsingFactory()
    {
        $tagString = <<<TAG
@author Mike van Riel <[email protected]> This is with
  multiline description.
TAG;

        $tag        = m::mock(Tag::class);
        $tagFactory = m::mock(TagFactory::class);
        $tagFactory->shouldReceive('create')->with($tagString, m::type(Context::class))->andReturn($tag);

        $fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);

        $given = <<<DOCBLOCK
/**
 * This is a summary.
 *
 * @author Mike van Riel <[email protected]> This is with
 *   multiline description.
 */
DOCBLOCK;

        $docblock = $fixture->create($given, new Context(''));

        $this->assertEquals([$tag], $docblock->getTags());
    }

    public function provideSummaryAndDescriptions()
    {
        return [
            ['This is a DocBlock', 'This is a DocBlock', ''],
            [
                'This is a DocBlock. This should still be summary.',
                'This is a DocBlock. This should still be summary.',
                ''
            ],
            [
                <<<DOCBLOCK
This is a DocBlock.
This should be a Description.
DOCBLOCK
                ,
                'This is a DocBlock.',
                'This should be a Description.'
            ],
            [
                <<<DOCBLOCK
This is a
multiline Summary.
This should be a Description.
DOCBLOCK
                ,
                "This is a\nmultiline Summary.",
                'This should be a Description.'
            ],
            [
                <<<DOCBLOCK
This is a Summary without dot but with a whiteline

This should be a Description.
DOCBLOCK
                ,
                'This is a Summary without dot but with a whiteline',
                'This should be a Description.'
            ],
            [
                <<<DOCBLOCK
This is a Summary with dot and with a whiteline.

This should be a Description.
DOCBLOCK
                ,
                'This is a Summary with dot and with a whiteline.',
                'This should be a Description.'
            ],
        ];
    }

    /**
     * @covers ::__construct
     * @covers ::create
     *
     * @uses   phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses   phpDocumentor\Reflection\DocBlock\Description
     * @uses   phpDocumentor\Reflection\Types\Context
     * @uses   phpDocumentor\Reflection\DocBlock\Tags\Param
     */
    public function testTagsWithContextNamespace()
    {
        $tagFactoryMock = m::mock(TagFactory::class);
        $fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), $tagFactoryMock);
        $context = new Context('MyNamespace');

        $tagFactoryMock->shouldReceive('create')->with(m::any(), $context)->andReturn(new Param('param'));
        $docblock = $fixture->create('/** @param MyType $param */', $context);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }

    /**
     * @covers ::__construct
     * @covers ::create
     *
     * @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
     * @uses phpDocumentor\Reflection\DocBlock\Description
     */
    public function testTagsAreFilteredForNullValues()
    {
        $tagString = <<<TAG
@author Mike van Riel <[email protected]> This is with
  multiline description.
TAG;

        $tagFactory = m::mock(TagFactory::class);
        $tagFactory->shouldReceive('create')->with($tagString, m::any())->andReturn(null);

        $fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);

        $given = <<<DOCBLOCK
/**
 * This is a summary.
 *
 * @author Mike van Riel <[email protected]> This is with
 *   multiline description.
 */
DOCBLOCK;

        $docblock = $fixture->create($given, new Context(''));

        $this->assertEquals([], $docblock->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\Description;
17		use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
18		use phpDocumentor\Reflection\DocBlock\Tag;
19		use phpDocumentor\Reflection\DocBlock\TagFactory;
20		use phpDocumentor\Reflection\DocBlock\Tags\Param;
21		use phpDocumentor\Reflection\Types\Context;
22
23		/**
24		* @coversDefaultClass phpDocumentor\Reflection\DocBlockFactory
25		* @covers ::<private>
26		* @uses \Webmozart\Assert\Assert
27		* @uses phpDocumentor\Reflection\DocBlock
28		*/
29		class DocBlockFactoryTest extends \PHPUnit_Framework_TestCase
30		{
31		/**
32		* @covers ::__construct
33		* @covers ::createInstance
34		* @uses \phpDocumentor\Reflection\DocBlock\StandardTagFactory
35		* @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
36		*/
37		public function testCreateFactoryUsingFactoryMethod()
38		{
39		$fixture = DocBlockFactory::createInstance();
40
41		$this->assertInstanceOf(DocBlockFactory::class, $fixture);
42		}
43
44		/**
45		* @covers ::__construct
46		* @covers ::create
47		* @uses phpDocumentor\Reflection\DocBlock\Description
48		*/
49		public function testCreateDocBlockFromReflection()
50		{
51		$fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));
52
53		$docBlock = '/** This is a DocBlock */';
54		$classReflector = m::mock(\ReflectionClass::class);
55		$classReflector->shouldReceive('getDocComment')->andReturn($docBlock);
56		$docblock = $fixture->create($classReflector);
57
58		$this->assertInstanceOf(DocBlock::class, $docblock);
59		$this->assertSame('This is a DocBlock', $docblock->getSummary());
60		$this->assertEquals(new Description(''), $docblock->getDescription());
61		$this->assertSame([], $docblock->getTags());
62		$this->assertEquals(new Context(''), $docblock->getContext());
63		$this->assertNull($docblock->getLocation());
64		}
65
66		/**
67		* @covers ::__construct
68		* @covers ::create
69		* @uses phpDocumentor\Reflection\DocBlock\Description
70		*/
71	View Code Duplication	public function testCreateDocBlockFromStringWithDocComment()
		0 ignored issues – show Duplication introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72		{
73		$fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));
74
75		$docblock = $fixture->create('/** This is a DocBlock */');
76
77		$this->assertInstanceOf(DocBlock::class, $docblock);
78		$this->assertSame('This is a DocBlock', $docblock->getSummary());
79		$this->assertEquals(new Description(''), $docblock->getDescription());
80		$this->assertSame([], $docblock->getTags());
81		$this->assertEquals(new Context(''), $docblock->getContext());
82		$this->assertNull($docblock->getLocation());
83		}
84
85		/**
86		* @covers ::create
87		* @covers ::__construct
88		* @uses phpDocumentor\Reflection\DocBlock\Description
89		*/
90	View Code Duplication	public function testCreateDocBlockFromStringWithoutDocComment()
		0 ignored issues – show Duplication introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
91		{
92		$fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));
93
94		$docblock = $fixture->create('This is a DocBlock');
95
96		$this->assertInstanceOf(DocBlock::class, $docblock);
97		$this->assertSame('This is a DocBlock', $docblock->getSummary());
98		$this->assertEquals(new Description(''), $docblock->getDescription());
99		$this->assertSame([], $docblock->getTags());
100		$this->assertEquals(new Context(''), $docblock->getContext());
101		$this->assertNull($docblock->getLocation());
102		}
103
104		/**
105		* @covers ::__construct
106		* @covers ::create
107		* @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
108		* @uses phpDocumentor\Reflection\DocBlock\Description
109		* @dataProvider provideSummaryAndDescriptions
110		*/
111		public function testSummaryAndDescriptionAreSeparated($given, $summary, $description)
112		{
113		$tagFactory = m::mock(TagFactory::class);
114		$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
115
116		$docblock = $fixture->create($given);
117
118		$this->assertSame($summary, $docblock->getSummary());
119		$this->assertEquals(new Description($description), $docblock->getDescription());
120		}
121
122		/**
123		* @covers ::__construct
124		* @covers ::create
125		* @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
126		* @uses phpDocumentor\Reflection\DocBlock\Description
127		*/
128		public function testDescriptionsRetainFormatting()
129		{
130		$tagFactory = m::mock(TagFactory::class);
131		$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
132
133		$given = <<<DOCBLOCK
134		/**
135		* This is a summary.
136		* This is a multiline Description
137		* that contains a code block.
138		*
139		* See here: a CodeBlock
140		*/
141		DOCBLOCK;
142
143		$description = <<<DESCRIPTION
144		This is a multiline Description
145		that contains a code block.
146
147		See here: a CodeBlock
148		DESCRIPTION;
149
150		$docblock = $fixture->create($given);
151
152		$this->assertEquals(new Description($description), $docblock->getDescription());
153		}
154
155		/**
156		* @covers ::__construct
157		* @covers ::create
158		* @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
159		* @uses phpDocumentor\Reflection\DocBlock\Description
160		*/
161		public function testTagsAreInterpretedUsingFactory()
162		{
163		$tagString = <<<TAG
164		@author Mike van Riel <[email protected]> This is with
165		multiline description.
166		TAG;
167
168		$tag = m::mock(Tag::class);
169		$tagFactory = m::mock(TagFactory::class);
170		$tagFactory->shouldReceive('create')->with($tagString, m::type(Context::class))->andReturn($tag);
171
172		$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
173
174		$given = <<<DOCBLOCK
175		/**
176		* This is a summary.
177		*
178		* @author Mike van Riel <[email protected]> This is with
179		* multiline description.
180		*/
181		DOCBLOCK;
182
183		$docblock = $fixture->create($given, new Context(''));
184
185		$this->assertEquals([$tag], $docblock->getTags());
186		}
187
188		public function provideSummaryAndDescriptions()
189		{
190		return [
191		['This is a DocBlock', 'This is a DocBlock', ''],
192		[
193		'This is a DocBlock. This should still be summary.',
194		'This is a DocBlock. This should still be summary.',
195		''
196		],
197		[
198		<<<DOCBLOCK
199		This is a DocBlock.
200		This should be a Description.
201		DOCBLOCK
202		,
203		'This is a DocBlock.',
204		'This should be a Description.'
205		],
206		[
207		<<<DOCBLOCK
208		This is a
209		multiline Summary.
210		This should be a Description.
211		DOCBLOCK
212		,
213		"This is a\nmultiline Summary.",
214		'This should be a Description.'
215		],
216		[
217		<<<DOCBLOCK
218		This is a Summary without dot but with a whiteline
219
220		This should be a Description.
221		DOCBLOCK
222		,
223		'This is a Summary without dot but with a whiteline',
224		'This should be a Description.'
225		],
226		[
227		<<<DOCBLOCK
228		This is a Summary with dot and with a whiteline.
229
230		This should be a Description.
231		DOCBLOCK
232		,
233		'This is a Summary with dot and with a whiteline.',
234		'This should be a Description.'
235		],
236		];
237		}
238
239		/**
240		* @covers ::__construct
241		* @covers ::create
242		*
243		* @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
244		* @uses phpDocumentor\Reflection\DocBlock\Description
245		* @uses phpDocumentor\Reflection\Types\Context
246		* @uses phpDocumentor\Reflection\DocBlock\Tags\Param
247		*/
248		public function testTagsWithContextNamespace()
249		{
250		$tagFactoryMock = m::mock(TagFactory::class);
251		$fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), $tagFactoryMock);
252		$context = new Context('MyNamespace');
253
254		$tagFactoryMock->shouldReceive('create')->with(m::any(), $context)->andReturn(new Param('param'));
255		$docblock = $fixture->create('/** @param MyType $param */', $context);
		0 ignored issues – show Unused Code introduced 2017-05-21 16:00 UTC by Report Bug Copy Issue Report `$docblock` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
256		}
257
258		/**
259		* @covers ::__construct
260		* @covers ::create
261		*
262		* @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
263		* @uses phpDocumentor\Reflection\DocBlock\Description
264		*/
265		public function testTagsAreFilteredForNullValues()
266		{
267		$tagString = <<<TAG
268		@author Mike van Riel <[email protected]> This is with
269		multiline description.
270		TAG;
271
272		$tagFactory = m::mock(TagFactory::class);
273		$tagFactory->shouldReceive('create')->with($tagString, m::any())->andReturn(null);
274
275		$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
276
277		$given = <<<DOCBLOCK
278		/**
279		* This is a summary.
280		*
281		* @author Mike van Riel <[email protected]> This is with
282		* multiline description.
283		*/
284		DOCBLOCK;
285
286		$docblock = $fixture->create($given, new Context(''));
287
288		$this->assertEquals([], $docblock->getTags());
289		}
290		}
291

arunfung / laravel-package-develop

Push — master ( 72a6c5...9329b7 )

testSummaryAndDescriptionAreSeparated() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like