TraitDescriptorTest::provideMagicProperties() - Code Metrics - Inspection of "Fix issue with invalid named magic properties" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1b348d...0e0888 )

by Jaap

created 2020-05-05 10:23 UTC

TraitDescriptorTest::provideMagicProperties() A

↳ Parent: TraitDescriptorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	15
rs	9.7666
c	0
b	0
f	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\Descriptor;

use Mockery as m;
use Mockery\Adapter\Phpunit\MockeryTestCase;
use phpDocumentor\Descriptor\Tag\MethodDescriptor as TagMethodDescriptor;
use phpDocumentor\Descriptor\Tag\PropertyDescriptor as TagPropertyDescriptor;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\Type;
use phpDocumentor\Reflection\Types\Mixed_;

/**
 * Tests the functionality for the TraitDescriptor class.
 *
 * @coversDefaultClass \phpDocumentor\Descriptor\TraitDescriptor
 */
final class TraitDescriptorTest extends MockeryTestCase
{
    /** @var TraitDescriptor $fixture */
    private $fixture;

    /**
     * Creates a new (empty) fixture object.
     */
    protected function setUp() : void
    {
        $this->fixture = new TraitDescriptor();
        $this->fixture->setFullyQualifiedStructuralElementName(new Fqsen('\My\Trait'));
    }

    /**
     * @covers ::setProperties
     * @covers ::getProperties
     */
    public function testSettingAndGettingProperties() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getProperties());

        $collection = new Collection();

        $this->fixture->setProperties($collection);

        $this->assertSame($collection, $this->fixture->getProperties());
    }

    /**
     * @covers ::setMethods
     * @covers ::getMethods
     */
    public function testSettingAndGettingMethods() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getMethods());

        $collection = new Collection();

        $this->fixture->setMethods($collection);

        $this->assertSame($collection, $this->fixture->getMethods());
    }

    /**
     * @covers ::getInheritedMethods
     */
    public function testGetInheritedMethods() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getInheritedMethods());

        $collection = $this->fixture->getInheritedMethods();

        $this->assertEquals(0, $collection->count());
    }

    /**
     * @covers ::getMagicMethods
     */
    public function testMagicMethodsReturnsEmptyCollectionWhenNoTags() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getMagicMethods());

        $collection = $this->fixture->getMagicMethods();

        $this->assertEquals(0, $collection->count());
    }

    /**
     * @covers ::getMagicMethods
     * @dataProvider provideMagicMethodProperties
     */
    public function testMagicMethodsReturnsExpectedCollectionWithTags(bool $isStatic) : void
    {
        $mockMethodDescriptor = m::mock(TagMethodDescriptor::class);
        $mockMethodDescriptor->shouldReceive('getMethodName')->andReturn('Sample');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $mockMethodDescriptor->shouldReceive('isStatic')->andReturn($isStatic);
        $mockMethodDescriptor->shouldReceive('getDescription')->andReturn('Sample description');

        $methodCollection = new Collection([$mockMethodDescriptor]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->fixture->getTags()->set('method', $methodCollection);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $magicMethodsCollection = $this->fixture->getMagicMethods();
        $this->assertInstanceOf(Collection::class, $magicMethodsCollection);
        $this->assertSame(1, $magicMethodsCollection->count());
        $this->assertSame('Sample', $magicMethodsCollection[0]->getName());
        $this->assertSame('Sample description', $magicMethodsCollection[0]->getDescription());
        $this->assertSame($isStatic, $magicMethodsCollection[0]->isStatic());
        $this->assertSame($this->fixture, $magicMethodsCollection[0]->getParent());
    }

    /**
     * Provider to test different properties for a trait magic method
     * (provides isStatic)
     *
     * @return bool[][]
     */
    public function provideMagicMethodProperties() : array
    {
        return [
            // Instance magic method (default)
            [false],
            // Static magic method
            [true],
        ];
    }

    /**
     * @covers ::getInheritedProperties
     */
    public function testGetInheritedProperties() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getInheritedProperties());

        $collection = $this->fixture->getInheritedProperties();

        $this->assertEquals(0, $collection->count());
    }

    /**
     * @covers ::getMagicProperties
     */
    public function testMagicPropertiesReturnsEmptyCollectionWhenNoTags() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getMagicProperties());

        $collection = $this->fixture->getMagicProperties();

        $this->assertEquals(0, $collection->count());
    }

    /**
     * @covers ::getMagicProperties
     * @dataProvider provideMagicProperties
     */
    public function testMagicPropertiesReturnsExpectedCollectionWithTags(
        string $name,
        string $description,
        Type $type
    ) : void {
        $mockTagPropertyDescriptor = m::mock(TagPropertyDescriptor::class);
        $mockTagPropertyDescriptor->shouldReceive('getVariableName')->andReturn($name);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $mockTagPropertyDescriptor->shouldReceive('getDescription')->andReturn($description);
        $mockTagPropertyDescriptor->shouldReceive('getType')->andReturn($type);

        $propertyCollection = new Collection([$mockTagPropertyDescriptor]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->fixture->getTags()->set('property', $propertyCollection);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $this->assertInstanceOf(Collection::class, $this->fixture->getMagicProperties());

        $magicPropertiesCollection = $this->fixture->getMagicProperties();
        $this->assertSame(1, $magicPropertiesCollection->count());
        $this->assertSame($name, $magicPropertiesCollection[0]->getName());
        $this->assertSame($description, $magicPropertiesCollection[0]->getDescription());
        $this->assertEquals($type, $magicPropertiesCollection[0]->getType());
        $this->assertSame($this->fixture, $magicPropertiesCollection[0]->getParent());
    }

    /**
     * @return array<string, mixed[]>

     */
    public function provideMagicProperties() : array
    {
        return [
            'normal sample' => [
                'name' => 'Sample',
                'description' => 'Sample Description',
                'type' => new Mixed_(),
            ],
            'without name' => [
                'name' => '',
                'description' => 'Sample Description',
                'type' => new Mixed_(),
            ],
        ];
    }

    /**
     * @covers ::setPackage
     */
    public function testSettingAndGettingPackage() : void
    {
        $package = new PackageDescriptor();
        $mockPropertyDescriptor = m::mock(PropertyDescriptor::class);
        $mockPropertyDescriptor->shouldReceive('setPackage')->with($package);

        $mockMethodDescriptor = m::mock(MethodDescriptor::class);
        $mockMethodDescriptor->shouldReceive('setPackage')->with($package);

        $propertyCollection = new Collection([$mockPropertyDescriptor]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $methodCollection = new Collection([$mockMethodDescriptor]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->fixture->setProperties($propertyCollection);
        $this->fixture->setMethods($methodCollection);

        $this->fixture->setPackage($package);

        $this->assertSame($package, $this->fixture->getPackage());
    }

    /**
     * @covers ::getUsedTraits
     * @covers ::setUsedTraits
     */
    public function testSettingAndGettingUsedTraits() : void
    {
        $this->assertInstanceOf(Collection::class, $this->fixture->getUsedTraits());

        $usedTraitsCollection = new Collection();
        $this->fixture->setUsedTraits($usedTraitsCollection);

        $this->assertSame($usedTraitsCollection, $this->fixture->getUsedTraits());
    }
}


Push — master ( 1b348d...0e0888 )

TraitDescriptorTest::provideMagicProperties() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

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\Descriptor;
15
16			use Mockery as m;
17			use Mockery\Adapter\Phpunit\MockeryTestCase;
18			use phpDocumentor\Descriptor\Tag\MethodDescriptor as TagMethodDescriptor;
19			use phpDocumentor\Descriptor\Tag\PropertyDescriptor as TagPropertyDescriptor;
20			use phpDocumentor\Reflection\Fqsen;
21			use phpDocumentor\Reflection\Type;
22			use phpDocumentor\Reflection\Types\Mixed_;
23
24			/**
25			* Tests the functionality for the TraitDescriptor class.
26			*
27			* @coversDefaultClass \phpDocumentor\Descriptor\TraitDescriptor
28			*/
29			final class TraitDescriptorTest extends MockeryTestCase
30			{
31			/** @var TraitDescriptor $fixture */
32			private $fixture;
33
34			/**
35			* Creates a new (empty) fixture object.
36			*/
37			protected function setUp() : void
38			{
39			$this->fixture = new TraitDescriptor();
40			$this->fixture->setFullyQualifiedStructuralElementName(new Fqsen('\My\Trait'));
41			}
42
43			/**
44			* @covers ::setProperties
45			* @covers ::getProperties
46			*/
47			public function testSettingAndGettingProperties() : void
48			{
49			$this->assertInstanceOf(Collection::class, $this->fixture->getProperties());
50
51			$collection = new Collection();
52
53			$this->fixture->setProperties($collection);
54
55			$this->assertSame($collection, $this->fixture->getProperties());
56			}
57
58			/**
59			* @covers ::setMethods
60			* @covers ::getMethods
61			*/
62			public function testSettingAndGettingMethods() : void
63			{
64			$this->assertInstanceOf(Collection::class, $this->fixture->getMethods());
65
66			$collection = new Collection();
67
68			$this->fixture->setMethods($collection);
69
70			$this->assertSame($collection, $this->fixture->getMethods());
71			}
72
73			/**
74			* @covers ::getInheritedMethods
75			*/
76			public function testGetInheritedMethods() : void
77			{
78			$this->assertInstanceOf(Collection::class, $this->fixture->getInheritedMethods());
79
80			$collection = $this->fixture->getInheritedMethods();
81
82			$this->assertEquals(0, $collection->count());
83			}
84
85			/**
86			* @covers ::getMagicMethods
87			*/
88			public function testMagicMethodsReturnsEmptyCollectionWhenNoTags() : void
89			{
90			$this->assertInstanceOf(Collection::class, $this->fixture->getMagicMethods());
91
92			$collection = $this->fixture->getMagicMethods();
93
94			$this->assertEquals(0, $collection->count());
95			}
96
97			/**
98			* @covers ::getMagicMethods
99			* @dataProvider provideMagicMethodProperties
100			*/
101			public function testMagicMethodsReturnsExpectedCollectionWithTags(bool $isStatic) : void
102			{
103			$mockMethodDescriptor = m::mock(TagMethodDescriptor::class);
104			$mockMethodDescriptor->shouldReceive('getMethodName')->andReturn('Sample');
			0 ignored issues – show Bug introduced 2017-10-10 14:32 UTC by Report Bug Copy Issue Report The method `andReturn` does only exist in `Mockery\ExpectationInterface`, but not in `Mockery\HigherOrderMessage`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
105			$mockMethodDescriptor->shouldReceive('isStatic')->andReturn($isStatic);
106			$mockMethodDescriptor->shouldReceive('getDescription')->andReturn('Sample description');
107
108			$methodCollection = new Collection([$mockMethodDescriptor]);
			0 ignored issues – show Documentation introduced 2020-01-29 22:30 UTC by Report Bug Copy Issue Report `array($mockMethodDescriptor)` is of type `array<integer,object<Moc...LegacyMockInterface>"}>`, but the function expects a `array<integer,object<phpDocumentor\Descriptor\T>>`. 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...
109			$this->fixture->getTags()->set('method', $methodCollection);
			0 ignored issues – show Documentation introduced 2020-01-29 22:30 UTC by Report Bug Copy Issue Report `$methodCollection` is of type `object<phpDocumentor\Descriptor\Collection>`, but the function expects a `object<phpDocumentor\Descriptor\T>`. 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...
110
111			$magicMethodsCollection = $this->fixture->getMagicMethods();
112			$this->assertInstanceOf(Collection::class, $magicMethodsCollection);
113			$this->assertSame(1, $magicMethodsCollection->count());
114			$this->assertSame('Sample', $magicMethodsCollection[0]->getName());
115			$this->assertSame('Sample description', $magicMethodsCollection[0]->getDescription());
116			$this->assertSame($isStatic, $magicMethodsCollection[0]->isStatic());
117			$this->assertSame($this->fixture, $magicMethodsCollection[0]->getParent());
118			}
119
120			/**
121			* Provider to test different properties for a trait magic method
122			* (provides isStatic)
123			*
124			* @return bool[][]
125			*/
126			public function provideMagicMethodProperties() : array
127			{
128			return [
129			// Instance magic method (default)
130			[false],
131			// Static magic method
132			[true],
133			];
134			}
135
136			/**
137			* @covers ::getInheritedProperties
138			*/
139			public function testGetInheritedProperties() : void
140			{
141			$this->assertInstanceOf(Collection::class, $this->fixture->getInheritedProperties());
142
143			$collection = $this->fixture->getInheritedProperties();
144
145			$this->assertEquals(0, $collection->count());
146			}
147
148			/**
149			* @covers ::getMagicProperties
150			*/
151			public function testMagicPropertiesReturnsEmptyCollectionWhenNoTags() : void
152			{
153			$this->assertInstanceOf(Collection::class, $this->fixture->getMagicProperties());
154
155			$collection = $this->fixture->getMagicProperties();
156
157			$this->assertEquals(0, $collection->count());
158			}
159
160			/**
161			* @covers ::getMagicProperties
162			* @dataProvider provideMagicProperties
163			*/
164			public function testMagicPropertiesReturnsExpectedCollectionWithTags(
165			string $name,
166			string $description,
167			Type $type
168			) : void {
169			$mockTagPropertyDescriptor = m::mock(TagPropertyDescriptor::class);
170			$mockTagPropertyDescriptor->shouldReceive('getVariableName')->andReturn($name);
			0 ignored issues – show Bug introduced 2017-10-10 14:32 UTC by Report Bug Copy Issue Report The method `andReturn` does only exist in `Mockery\ExpectationInterface`, but not in `Mockery\HigherOrderMessage`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
171			$mockTagPropertyDescriptor->shouldReceive('getDescription')->andReturn($description);
172			$mockTagPropertyDescriptor->shouldReceive('getType')->andReturn($type);
173
174			$propertyCollection = new Collection([$mockTagPropertyDescriptor]);
			0 ignored issues – show Documentation introduced 2020-01-29 22:30 UTC by Report Bug Copy Issue Report `array($mockTagPropertyDescriptor)` is of type `array<integer,object<Moc...LegacyMockInterface>"}>`, but the function expects a `array<integer,object<phpDocumentor\Descriptor\T>>`. 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...
175			$this->fixture->getTags()->set('property', $propertyCollection);
			0 ignored issues – show Documentation introduced 2020-01-29 22:30 UTC by Report Bug Copy Issue Report `$propertyCollection` is of type `object<phpDocumentor\Descriptor\Collection>`, but the function expects a `object<phpDocumentor\Descriptor\T>`. 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...
176
177			$this->assertInstanceOf(Collection::class, $this->fixture->getMagicProperties());
178
179			$magicPropertiesCollection = $this->fixture->getMagicProperties();
180			$this->assertSame(1, $magicPropertiesCollection->count());
181			$this->assertSame($name, $magicPropertiesCollection[0]->getName());
182			$this->assertSame($description, $magicPropertiesCollection[0]->getDescription());
183			$this->assertEquals($type, $magicPropertiesCollection[0]->getType());
184			$this->assertSame($this->fixture, $magicPropertiesCollection[0]->getParent());
185			}
186
187			/**
188			* @return array<string, mixed[]>
			0 ignored issues – show Documentation introduced 2020-05-05 10:31 UTC by Report Bug Copy Issue Report The doc-type `array<string,` could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
189			*/
190			public function provideMagicProperties() : array
191			{
192			return [
193			'normal sample' => [
194			'name' => 'Sample',
195			'description' => 'Sample Description',
196			'type' => new Mixed_(),
197			],
198			'without name' => [
199			'name' => '',
200			'description' => 'Sample Description',
201			'type' => new Mixed_(),
202			],
203			];
204			}
205
206			/**
207			* @covers ::setPackage
208			*/
209			public function testSettingAndGettingPackage() : void
210			{
211			$package = new PackageDescriptor();
212			$mockPropertyDescriptor = m::mock(PropertyDescriptor::class);
213			$mockPropertyDescriptor->shouldReceive('setPackage')->with($package);
214
215			$mockMethodDescriptor = m::mock(MethodDescriptor::class);
216			$mockMethodDescriptor->shouldReceive('setPackage')->with($package);
217
218			$propertyCollection = new Collection([$mockPropertyDescriptor]);
			0 ignored issues – show Documentation introduced 2020-01-29 22:30 UTC by Report Bug Copy Issue Report `array($mockPropertyDescriptor)` is of type `array<integer,object<Moc...LegacyMockInterface>"}>`, but the function expects a `array<integer,object<phpDocumentor\Descriptor\T>>`. 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...
219			$methodCollection = new Collection([$mockMethodDescriptor]);
			0 ignored issues – show Documentation introduced 2020-01-29 22:30 UTC by Report Bug Copy Issue Report `array($mockMethodDescriptor)` is of type `array<integer,object<Moc...LegacyMockInterface>"}>`, but the function expects a `array<integer,object<phpDocumentor\Descriptor\T>>`. 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...
220			$this->fixture->setProperties($propertyCollection);
221			$this->fixture->setMethods($methodCollection);
222
223			$this->fixture->setPackage($package);
224
225			$this->assertSame($package, $this->fixture->getPackage());
226			}
227
228			/**
229			* @covers ::getUsedTraits
230			* @covers ::setUsedTraits
231			*/
232			public function testSettingAndGettingUsedTraits() : void
233			{
234			$this->assertInstanceOf(Collection::class, $this->fixture->getUsedTraits());
235
236			$usedTraitsCollection = new Collection();
237			$this->fixture->setUsedTraits($usedTraitsCollection);
238
239			$this->assertSame($usedTraitsCollection, $this->fixture->getUsedTraits());
240			}
241			}
242

phpDocumentor / phpDocumentor

Push — master ( 1b348d...0e0888 )

TraitDescriptorTest::provideMagicProperties() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like