PropertyDocumentedTypeChangedTest::propertiesToBeTested() - Code Metrics - Inspection of "#24 rename package to `roave/backward-compatibilit..." - Roave/BackwardCompatibilityCheck - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#50)

by Marco

created 2018-04-27 11:29 UTC

propertiesToBeTested() B

↳ Parent: PropertyDocumentedTypeChangedTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	141
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	36
nc	1
nop	0
dl	0
loc	141
rs	8.2857
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace RoaveTest\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased;

use PHPUnit\Framework\TestCase;
use Roave\BackwardCompatibility\Change;
use Roave\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased\PropertyDocumentedTypeChanged;
use Roave\BetterReflection\BetterReflection;
use Roave\BetterReflection\Reflection\ReflectionProperty;
use Roave\BetterReflection\Reflector\ClassReflector;
use Roave\BetterReflection\SourceLocator\Type\StringSourceLocator;
use function array_combine;
use function array_keys;
use function array_map;
use function iterator_to_array;

/**
 * @covers \Roave\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased\PropertyDocumentedTypeChanged
 */
final class PropertyDocumentedTypeChangedTest extends TestCase
{
    /**
     * @dataProvider propertiesToBeTested
     *
     * @param string[] $expectedMessages
     */
    public function testDiffs(
        ReflectionProperty $fromProperty,
        ReflectionProperty $toProperty,
        array $expectedMessages
    ) : void {
        $changes = (new PropertyDocumentedTypeChanged())
            ->__invoke($fromProperty, $toProperty);

        self::assertSame(
            $expectedMessages,
            array_map(function (Change $change) : string {
                return $change->__toString();
            }, iterator_to_array($changes))
        );
    }

    /** @return (string[]|ReflectionProperty)[][] */
    public function propertiesToBeTested() : array
    {
        $astLocator = (new BetterReflection())->astLocator();

        $fromLocator = new StringSourceLocator(
            <<<'PHP'
<?php

class TheClass {
    public $publicNoDocblockToNoDocblock;
    public $publicNoDocblockToDocblock;
    
    /**
     * Hi
     */
    public $publicNoTypeDocblockToDocblock;
    
    /**
     * @var int
     */
    public $publicDocblockToSameDocblock;
    
    /**
     * @var int
     */
    public $publicDocblockToDifferentDocblock;
    
    /**
     * @var int
     */
    public $publicDocblockToNoDocblock;
    
    /**
     * @var int|float
     */
    public $publicCompositeTypeDocblockToSameTypeDocblock;
    
    /**
     * @var int|float
     */
    public $publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting;
    
    /**
     * @var int|float
     */
    public $publicCompositeTypeDocblockToDifferentCompositeTypeDocblock;
    
    /**
     * @var int
     */
    private $privateDocblockToDifferentDocblock;
}
PHP
            ,
            $astLocator
        );

        $toLocator = new StringSourceLocator(
            <<<'PHP'
<?php

class TheClass {
    public $publicNoDocblockToNoDocblock;
    
    /**
     * @var int
     */
    public $publicNoDocblockToDocblock;
    
    /**
     * @var int
     */
    public $publicNoTypeDocblockToDocblock;
    
    /**
     * @var int
     */
    public $publicDocblockToSameDocblock;
    
    /**
     * @var float
     */
    public $publicDocblockToDifferentDocblock;
    
    public $publicDocblockToNoDocblock;
    
    /**
     * @var int|float
     */
    public $publicCompositeTypeDocblockToSameTypeDocblock;
    
    /**
     * @var float|int
     */
    public $publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting;
    
    /**
     * @var int|float|string
     */
    public $publicCompositeTypeDocblockToDifferentCompositeTypeDocblock;
    
    /**
     * @var float
     */
    private $privateDocblockToDifferentDocblock;
}
PHP
            ,
            $astLocator
        );

        $fromClassReflector = new ClassReflector($fromLocator);
        $toClassReflector   = new ClassReflector($toLocator);
        $fromClass          = $fromClassReflector->reflect('TheClass');
        $toClass            = $toClassReflector->reflect('TheClass');

        $properties = [
            'publicNoDocblockToNoDocblock'                                      => [],
            'publicNoDocblockToDocblock'                                        => [],
            'publicNoTypeDocblockToDocblock'                                    => ['[BC] CHANGED: Type documentation for property TheClass#$publicNoTypeDocblockToDocblock changed from having no type to int'],
            'publicDocblockToSameDocblock'                                      => [],
            'publicDocblockToDifferentDocblock'                                 => ['[BC] CHANGED: Type documentation for property TheClass#$publicDocblockToDifferentDocblock changed from int to float'],
            'publicDocblockToNoDocblock'                                        => ['[BC] CHANGED: Type documentation for property TheClass#$publicDocblockToNoDocblock changed from int to having no type'],
            'publicCompositeTypeDocblockToSameTypeDocblock'                     => [],
            'publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting' => [],
            'publicCompositeTypeDocblockToDifferentCompositeTypeDocblock'       => ['[BC] CHANGED: Type documentation for property TheClass#$publicCompositeTypeDocblockToDifferentCompositeTypeDocblock changed from float|int to float|int|string'],
            'privateDocblockToDifferentDocblock'                                => ['[BC] CHANGED: Type documentation for property TheClass#$privateDocblockToDifferentDocblock changed from int to float'],
        ];

        return array_combine(
            array_keys($properties),
            array_map(
                function (string $property, array $errorMessages) use ($fromClass, $toClass) : array {
                    return [
                        $fromClass->getProperty($property),
                        $toClass->getProperty($property),
                        $errorMessages,
                    ];
                },
                array_keys($properties),
                $properties
            )
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace RoaveTest\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased;
6
7			use PHPUnit\Framework\TestCase;
8			use Roave\BackwardCompatibility\Change;
9			use Roave\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased\PropertyDocumentedTypeChanged;
10			use Roave\BetterReflection\BetterReflection;
11			use Roave\BetterReflection\Reflection\ReflectionProperty;
12			use Roave\BetterReflection\Reflector\ClassReflector;
13			use Roave\BetterReflection\SourceLocator\Type\StringSourceLocator;
14			use function array_combine;
15			use function array_keys;
16			use function array_map;
17			use function iterator_to_array;
18
19			/**
20			* @covers \Roave\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased\PropertyDocumentedTypeChanged
21			*/
22			final class PropertyDocumentedTypeChangedTest extends TestCase
23			{
24			/**
25			* @dataProvider propertiesToBeTested
26			*
27			* @param string[] $expectedMessages
28			*/
29			public function testDiffs(
30			ReflectionProperty $fromProperty,
31			ReflectionProperty $toProperty,
32			array $expectedMessages
33			) : void {
34			$changes = (new PropertyDocumentedTypeChanged())
35			->__invoke($fromProperty, $toProperty);
36
37			self::assertSame(
38			$expectedMessages,
39			array_map(function (Change $change) : string {
40			return $change->__toString();
41			}, iterator_to_array($changes))
42			);
43			}
44
45			/** @return (string[]\|ReflectionProperty)[][] */
46			public function propertiesToBeTested() : array
47			{
48			$astLocator = (new BetterReflection())->astLocator();
49
50			$fromLocator = new StringSourceLocator(
51			<<<'PHP'
52			<?php
53
54			class TheClass {
55			public $publicNoDocblockToNoDocblock;
56			public $publicNoDocblockToDocblock;
57
58			/**
59			* Hi
60			*/
61			public $publicNoTypeDocblockToDocblock;
62
63			/**
64			* @var int
65			*/
66			public $publicDocblockToSameDocblock;
67
68			/**
69			* @var int
70			*/
71			public $publicDocblockToDifferentDocblock;
72
73			/**
74			* @var int
75			*/
76			public $publicDocblockToNoDocblock;
77
78			/**
79			* @var int\|float
80			*/
81			public $publicCompositeTypeDocblockToSameTypeDocblock;
82
83			/**
84			* @var int\|float
85			*/
86			public $publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting;
87
88			/**
89			* @var int\|float
90			*/
91			public $publicCompositeTypeDocblockToDifferentCompositeTypeDocblock;
92
93			/**
94			* @var int
95			*/
96			private $privateDocblockToDifferentDocblock;
97			}
98			PHP
99			,
100			$astLocator
101			);
102
103			$toLocator = new StringSourceLocator(
104			<<<'PHP'
105			<?php
106
107			class TheClass {
108			public $publicNoDocblockToNoDocblock;
109
110			/**
111			* @var int
112			*/
113			public $publicNoDocblockToDocblock;
114
115			/**
116			* @var int
117			*/
118			public $publicNoTypeDocblockToDocblock;
119
120			/**
121			* @var int
122			*/
123			public $publicDocblockToSameDocblock;
124
125			/**
126			* @var float
127			*/
128			public $publicDocblockToDifferentDocblock;
129
130			public $publicDocblockToNoDocblock;
131
132			/**
133			* @var int\|float
134			*/
135			public $publicCompositeTypeDocblockToSameTypeDocblock;
136
137			/**
138			* @var float\|int
139			*/
140			public $publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting;
141
142			/**
143			* @var int\|float\|string
144			*/
145			public $publicCompositeTypeDocblockToDifferentCompositeTypeDocblock;
146
147			/**
148			* @var float
149			*/
150			private $privateDocblockToDifferentDocblock;
151			}
152			PHP
153			,
154			$astLocator
155			);
156
157			$fromClassReflector = new ClassReflector($fromLocator);
158			$toClassReflector = new ClassReflector($toLocator);
159			$fromClass = $fromClassReflector->reflect('TheClass');
160			$toClass = $toClassReflector->reflect('TheClass');
161
162			$properties = [
163			'publicNoDocblockToNoDocblock' => [],
164			'publicNoDocblockToDocblock' => [],
165			'publicNoTypeDocblockToDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicNoTypeDocblockToDocblock changed from having no type to int'],
166			'publicDocblockToSameDocblock' => [],
167			'publicDocblockToDifferentDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicDocblockToDifferentDocblock changed from int to float'],
168			'publicDocblockToNoDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicDocblockToNoDocblock changed from int to having no type'],
169			'publicCompositeTypeDocblockToSameTypeDocblock' => [],
170			'publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting' => [],
171			'publicCompositeTypeDocblockToDifferentCompositeTypeDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicCompositeTypeDocblockToDifferentCompositeTypeDocblock changed from float\|int to float\|int\|string'],
172			'privateDocblockToDifferentDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$privateDocblockToDifferentDocblock changed from int to float'],
173			];
174
175			return array_combine(
176			array_keys($properties),
177			array_map(
178			function (string $property, array $errorMessages) use ($fromClass, $toClass) : array {
179			return [
180			$fromClass->getProperty($property),
181			$toClass->getProperty($property),
182			$errorMessages,
183			];
184			},
185			array_keys($properties),
186			$properties
187			)
188			);
189			}
190			}
191

Roave / BackwardCompatibilityCheck

Pull Request — master (#50)

propertiesToBeTested() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like