Issues in ProjectAnalyzerTest.php - All Issues - Inspection of "Delete Scrybe" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8eb671...133594 )

by Mike

created 2019-06-14 08:00 UTC

phpDocumentor/Descriptor/ProjectAnalyzerTest.php (1 issue)

Labels

Documentation 1

Severity

Mike van Riel 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace phpDocumentor\Descriptor;

use Mockery\Adapter\Phpunit\MockeryTestCase;
use Mockery as m;

/**
 * Tests for the \phpDocumentor\Descriptor\ProjectAnalyzer class.
 */
class ProjectAnalyzerTest extends MockeryTestCase
{
    /** @var ProjectAnalyzer */
    private $fixture;

    protected function setUp()
    {
        $this->fixture = new ProjectAnalyzer();
    }

    /**
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
     */
    public function testFilesAreCounted()
    {
        // Arrange
        $projectDescriptor = $this->givenAProjectMock();
        $this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, [1, 2, 3, 4]);
        $this->whenProjectDescriptorHasTheFollowingElements($projectDescriptor, []);
        $this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, []);

        // Act
        $this->fixture->analyze($projectDescriptor);

        // Assert
        $this->assertAttributeSame(4, 'fileCount', $this->fixture);
    }

    /**
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
     */
    public function testIfTopLevelNamespacesAreCounted()
    {
        // Arrange
        $projectDescriptor = $this->givenAProjectMock();
        $this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, []);
        $this->whenProjectDescriptorHasTheFollowingElements($projectDescriptor, []);
        $this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, [1, 2, 3]);

        // Act
        $this->fixture->analyze($projectDescriptor);

        // Assert
        $this->assertAttributeSame(3, 'topLevelNamespaceCount', $this->fixture);
    }

    /**
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::findAllElements
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::incrementUnresolvedParentCounter
     */
    public function testIfUnresolvedClassesAreCounted()
    {
        // Arrange
        $classDescriptor1 = $this->givenAClassWithParent('phpDocumentor\Descriptor\ClassDescriptor');
        $projectDescriptor = $this->givenAProjectMock();
        $this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, []);
        $this->whenProjectDescriptorHasTheFollowingElements(
            $projectDescriptor,
            [
                'ds1' => $classDescriptor1,
                'ds2' => $this->givenAClassWithParent($classDescriptor1),
                'ds3' => $this->givenAnInterfaceWithParent('123'),
            ]
        );
        $this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, []);

        // Act
        $this->fixture->analyze($projectDescriptor);

        // Assert
        $this->assertAttributeSame(1, 'unresolvedParentClassesCount', $this->fixture);
    }

    /**
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::findAllElements
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::addElementToCounter
     */
    public function testIfVariousDescriptorTypesAreCounted()
    {
        // Arrange
        $classDescriptor1 = $this->givenAClassWithParent('phpDocumentor\Descriptor\ClassDescriptor');
        $projectDescriptor = $this->givenAProjectMock();
        $this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, []);
        $this->whenProjectDescriptorHasTheFollowingElements(
            $projectDescriptor,
            [
                'ds1' => $classDescriptor1,
                'ds2' => $this->givenAClassWithParent($classDescriptor1),
                'ds3' => $this->givenAnInterfaceWithParent('123'),
            ]
        );
        $this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, []);

        // Act
        $this->fixture->analyze($projectDescriptor);

        // Assert
        $this->assertAttributeSame(
            [
                'phpDocumentor\Descriptor\ClassDescriptor' => 2,
                'phpDocumentor\Descriptor\InterfaceDescriptor' => 1,
            ],
            'descriptorCountByType',
            $this->fixture
        );
    }

    /**
     * @covers \phpDocumentor\Descriptor\ProjectAnalyzer::__toString
     */
    public function testIfStringOutputContainsAllCounters()
    {
        // Arrange
        $classDescriptor1 = $this->givenAClassWithParent('phpDocumentor\Descriptor\ClassDescriptor');
        $projectDescriptor = $this->givenAProjectMock();
        $this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, [1, 2, 3, 4]);
        $this->whenProjectDescriptorHasTheFollowingElements(
            $projectDescriptor,
            [
                'ds1' => $classDescriptor1,
                'ds2' => $this->givenAClassWithParent($classDescriptor1),
                'ds3' => $this->givenAnInterfaceWithParent('123'),
            ]
        );
        $this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, [1, 2, 3]);
        $this->fixture->analyze($projectDescriptor);

        $expected = <<<TEXT
In the ProjectDescriptor are:
         4 files
         3 top-level namespaces
         1 unresolvable parent classes
         2 phpDocumentor\Descriptor\ClassDescriptor elements
         1 phpDocumentor\Descriptor\InterfaceDescriptor elements

TEXT;
        $expected = str_replace("\n", PHP_EOL, $expected);

        // Act
        $result = (string) $this->fixture;

        // Assert
        $this->assertSame($expected, $result);
    }

    /**
     * Returns a class with the given parent set.
     *
     * @param string|DescriptorAbstract $parent
     */
    protected function givenAClassWithParent($parent): ClassDescriptor
    {
        $classDescriptor1 = new ClassDescriptor();
        $classDescriptor1->setParent($parent);
        return $classDescriptor1;
    }

    /**
     * @param string $interfaceParent
     */
    protected function givenAnInterfaceWithParent($interfaceParent): InterfaceDescriptor
    {
        $classDescriptor3 = new InterfaceDescriptor();
        $classDescriptor3->setParent($interfaceParent);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $classDescriptor3;
    }

    /**
     * Returns a mocked ProjectDescriptor object.
     */
    protected function givenAProjectMock(): m\MockInterface
    {
        return m::mock('phpDocumentor\Descriptor\ProjectDescriptor')->shouldIgnoreMissing();
    }

    /**
     * Ensures that the ProjectDescriptor contains and returns the provided files.
     */
    protected function whenProjectDescriptorHasTheFollowingFiles(m\MockInterface $projectDescriptor, array $files)
    {
        $projectDescriptor->shouldReceive('getFiles')->andReturn($files);
    }

    /**
     * Ensures that the ProjectDescriptor has an index 'elements' with the provided elements.
     */
    protected function whenProjectDescriptorHasTheFollowingElements(m\MockInterface $projectDescriptor, array $elements)
    {
        $projectDescriptor->shouldReceive('getIndexes->get')
            ->with('elements', m::type('phpDocumentor\Descriptor\Collection'))
            ->andReturn(new Collection($elements));
    }

    /**
     * Ensures that the ProjectDescriptor has a root namespace with the provided array as children of that namespace.
     */
    protected function whenProjectHasTheFollowingChildrenOfRootNamespace(
        m\MockInterface $projectDescriptor,
        array $rootNamespaceChildren
    ) {
        $projectDescriptor->shouldReceive('getNamespace->getChildren')->andReturn(
            new Collection($rootNamespaceChildren)
        );
    }
}


1			<?php
2
3			namespace phpDocumentor\Descriptor;
4
5			use Mockery\Adapter\Phpunit\MockeryTestCase;
6			use Mockery as m;
7
8			/**
9			* Tests for the \phpDocumentor\Descriptor\ProjectAnalyzer class.
10			*/
11			class ProjectAnalyzerTest extends MockeryTestCase
12			{
13			/** @var ProjectAnalyzer */
14			private $fixture;
15
16			protected function setUp()
17			{
18			$this->fixture = new ProjectAnalyzer();
19			}
20
21			/**
22			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
23			*/
24			public function testFilesAreCounted()
25			{
26			// Arrange
27			$projectDescriptor = $this->givenAProjectMock();
28			$this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, [1, 2, 3, 4]);
29			$this->whenProjectDescriptorHasTheFollowingElements($projectDescriptor, []);
30			$this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, []);
31
32			// Act
33			$this->fixture->analyze($projectDescriptor);
34
35			// Assert
36			$this->assertAttributeSame(4, 'fileCount', $this->fixture);
37			}
38
39			/**
40			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
41			*/
42			public function testIfTopLevelNamespacesAreCounted()
43			{
44			// Arrange
45			$projectDescriptor = $this->givenAProjectMock();
46			$this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, []);
47			$this->whenProjectDescriptorHasTheFollowingElements($projectDescriptor, []);
48			$this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, [1, 2, 3]);
49
50			// Act
51			$this->fixture->analyze($projectDescriptor);
52
53			// Assert
54			$this->assertAttributeSame(3, 'topLevelNamespaceCount', $this->fixture);
55			}
56
57			/**
58			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
59			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::findAllElements
60			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::incrementUnresolvedParentCounter
61			*/
62			public function testIfUnresolvedClassesAreCounted()
63			{
64			// Arrange
65			$classDescriptor1 = $this->givenAClassWithParent('phpDocumentor\Descriptor\ClassDescriptor');
66			$projectDescriptor = $this->givenAProjectMock();
67			$this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, []);
68			$this->whenProjectDescriptorHasTheFollowingElements(
69			$projectDescriptor,
70			[
71			'ds1' => $classDescriptor1,
72			'ds2' => $this->givenAClassWithParent($classDescriptor1),
73			'ds3' => $this->givenAnInterfaceWithParent('123'),
74			]
75			);
76			$this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, []);
77
78			// Act
79			$this->fixture->analyze($projectDescriptor);
80
81			// Assert
82			$this->assertAttributeSame(1, 'unresolvedParentClassesCount', $this->fixture);
83			}
84
85			/**
86			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::analyze
87			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::findAllElements
88			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::addElementToCounter
89			*/
90			public function testIfVariousDescriptorTypesAreCounted()
91			{
92			// Arrange
93			$classDescriptor1 = $this->givenAClassWithParent('phpDocumentor\Descriptor\ClassDescriptor');
94			$projectDescriptor = $this->givenAProjectMock();
95			$this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, []);
96			$this->whenProjectDescriptorHasTheFollowingElements(
97			$projectDescriptor,
98			[
99			'ds1' => $classDescriptor1,
100			'ds2' => $this->givenAClassWithParent($classDescriptor1),
101			'ds3' => $this->givenAnInterfaceWithParent('123'),
102			]
103			);
104			$this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, []);
105
106			// Act
107			$this->fixture->analyze($projectDescriptor);
108
109			// Assert
110			$this->assertAttributeSame(
111			[
112			'phpDocumentor\Descriptor\ClassDescriptor' => 2,
113			'phpDocumentor\Descriptor\InterfaceDescriptor' => 1,
114			],
115			'descriptorCountByType',
116			$this->fixture
117			);
118			}
119
120			/**
121			* @covers \phpDocumentor\Descriptor\ProjectAnalyzer::__toString
122			*/
123			public function testIfStringOutputContainsAllCounters()
124			{
125			// Arrange
126			$classDescriptor1 = $this->givenAClassWithParent('phpDocumentor\Descriptor\ClassDescriptor');
127			$projectDescriptor = $this->givenAProjectMock();
128			$this->whenProjectDescriptorHasTheFollowingFiles($projectDescriptor, [1, 2, 3, 4]);
129			$this->whenProjectDescriptorHasTheFollowingElements(
130			$projectDescriptor,
131			[
132			'ds1' => $classDescriptor1,
133			'ds2' => $this->givenAClassWithParent($classDescriptor1),
134			'ds3' => $this->givenAnInterfaceWithParent('123'),
135			]
136			);
137			$this->whenProjectHasTheFollowingChildrenOfRootNamespace($projectDescriptor, [1, 2, 3]);
138			$this->fixture->analyze($projectDescriptor);
139
140			$expected = <<<TEXT
141			In the ProjectDescriptor are:
142			4 files
143			3 top-level namespaces
144			1 unresolvable parent classes
145			2 phpDocumentor\Descriptor\ClassDescriptor elements
146			1 phpDocumentor\Descriptor\InterfaceDescriptor elements
147
148			TEXT;
149			$expected = str_replace("\n", PHP_EOL, $expected);
150
151			// Act
152			$result = (string) $this->fixture;
153
154			// Assert
155			$this->assertSame($expected, $result);
156			}
157
158			/**
159			* Returns a class with the given parent set.
160			*
161			* @param string\|DescriptorAbstract $parent
162			*/
163			protected function givenAClassWithParent($parent): ClassDescriptor
164			{
165			$classDescriptor1 = new ClassDescriptor();
166			$classDescriptor1->setParent($parent);
167			return $classDescriptor1;
168			}
169
170			/**
171			* @param string $interfaceParent
172			*/
173			protected function givenAnInterfaceWithParent($interfaceParent): InterfaceDescriptor
174			{
175			$classDescriptor3 = new InterfaceDescriptor();
176			$classDescriptor3->setParent($interfaceParent);
			0 ignored issues – show Documentation introduced 2019-01-27 07:58 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$interfaceParent` is of type `string`, but the function expects a `object<phpDocumentor\Descriptor\Collection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
177
178			return $classDescriptor3;
179			}
180
181			/**
182			* Returns a mocked ProjectDescriptor object.
183			*/
184			protected function givenAProjectMock(): m\MockInterface
185			{
186			return m::mock('phpDocumentor\Descriptor\ProjectDescriptor')->shouldIgnoreMissing();
187			}
188
189			/**
190			* Ensures that the ProjectDescriptor contains and returns the provided files.
191			*/
192			protected function whenProjectDescriptorHasTheFollowingFiles(m\MockInterface $projectDescriptor, array $files)
193			{
194			$projectDescriptor->shouldReceive('getFiles')->andReturn($files);
195			}
196
197			/**
198			* Ensures that the ProjectDescriptor has an index 'elements' with the provided elements.
199			*/
200			protected function whenProjectDescriptorHasTheFollowingElements(m\MockInterface $projectDescriptor, array $elements)
201			{
202			$projectDescriptor->shouldReceive('getIndexes->get')
203			->with('elements', m::type('phpDocumentor\Descriptor\Collection'))
204			->andReturn(new Collection($elements));
205			}
206
207			/**
208			* Ensures that the ProjectDescriptor has a root namespace with the provided array as children of that namespace.
209			*/
210			protected function whenProjectHasTheFollowingChildrenOfRootNamespace(
211			m\MockInterface $projectDescriptor,
212			array $rootNamespaceChildren
213			) {
214			$projectDescriptor->shouldReceive('getNamespace->getChildren')->andReturn(
215			new Collection($rootNamespaceChildren)
216			);
217			}
218			}
219

phpDocumentor / phpDocumentor

Push — develop ( 8eb671...133594 )

phpDocumentor/Descriptor/ProjectAnalyzerTest.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like