NonStaticMagicMethodsSniffTest::dataInterfaceWithPrivateMagicMethod() - Code Metrics - Inspection of "Improve `NonStaticMagicMethods` sniff (code review..." - wimg/PHPCompatibility - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#174)

by Juliette

created 2016-08-16 08:12 UTC

gicMethod() A

↳ Parent: NonStaticMagicMethodsSniffTest::dataWrongNonStaticMethod()

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	0

<?php
/**
 * Non Static Magic Sniff test file
 *
 * @package PHPCompatibility
 */


/**
 * Non Static Magic Sniff tests
 *
 * @uses BaseSniffTest
 * @package PHPCompatibility
 * @author Jansen Price <[email protected]>
 */
class NonStaticMagicMethodsSniffTest extends BaseSniffTest
namespace YourVendor;

class YourClass { }
{
    /**
     * Whether or not traits will be recognized in PHPCS.
     *
     * @var bool
     */
    protected static $recognizesTraits = true;


    /**
     * Set up skip condition.
     */
    public static function setUpBeforeClass()
    {
        // When using PHPCS 1.x combined with PHP 5.3 or lower, traits are not recognized.
        if (version_compare(PHP_CodeSniffer::VERSION, '2.0', '<') && version_compare(phpversion(), '5.4', '<')) {
            self::$recognizesTraits = false;
        }
    }


    /**
     * Get the correct test file.
     *
     * (@internal
     * The test file has been split into two:
     * - one covering classes and interfaces
     * - one covering traits
     *
     * This is to avoid test failing because PHPCS 1.x gets confused about the scope
     * openers/closers when run on PHP 5.3 or lower.
     * In a 'normal' situation you won't often find classes, interfaces and traits all
     * mixed in one file anyway, so this issue for which this is a work-around,
     * should not cause real world issues anyway.}}
     *
     * @param bool $isTrait Whether to load the class/interface test file or the trait test file.
     *
     * @return PHP_CodeSniffer_File File object|false
     */
    protected function getTestFile($isTrait) {
        if ($isTrait === false) {
            return $this->sniffFile('sniff-examples/nonstatic_magic_methods.1.php');
        }
        else {
            return $this->sniffFile('sniff-examples/nonstatic_magic_methods.2.php');
        }
    }

    /**
     * testCorrectImplementation
     *
     * @group MagicMethods
     *
     * @dataProvider dataCorrectImplementation
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testCorrectImplementation($line, $isTrait = false)
    {
        if ($isTrait === true && self::$recognizesTraits === false) {
            $this->markTestSkipped();
            return;
        }

        $file = $this->getTestFile($isTrait);
        $this->assertNoViolation($file, $line);
    }

    /**
     * Data provider.
     *
     * @see testCorrectImplementation()
     *
     * @return array
     */
    public function dataCorrectImplementation()
    {
        return array(
            /*
             * nonstatic_magic_methods.1.php
             */
            // Plain class.
            array(5),
            array(6),
            array(7),
            array(8),
            array(9),
            array(10),
            array(11),
            array(12),
            array(13),
            // Normal class.
            array(18),
            array(19),
            array(20),
            array(21),
            array(22),
            array(23),
            array(24),
            array(25),
            array(26),
            array(27),

            // Alternative property order & stacked.
            array(58),

            // Plain interface.
            array(71),
            array(72),
            array(73),
            array(74),
            array(75),
            array(76),
            array(77),
            array(78),
            array(79),
            // Normal interface.
            array(84),
            array(85),
            array(86),
            array(87),
            array(88),
            array(89),
            array(90),
            array(91),
            array(92),
            array(93),

            /*
             * nonstatic_magic_methods.2.php
             */
            // Plain trait.
            array(5, true),
            array(6, true),
            array(7, true),
            array(8, true),
            array(9, true),
            array(10, true),
            array(11, true),
            array(12, true),
            array(13, true),
            // Normal trait.
            array(18, true),
            array(19, true),
            array(20, true),
            array(21, true),
            array(22, true),
            array(23, true),
            array(24, true),
            array(25, true),
            array(26, true),
            array(27, true),

        );
    }


    /**
     * testWrongMethodVisibility
     *
     * @group MagicMethods
     *
     * @dataProvider dataWrongMethodVisibility
     *
     * @param string $methodName        Method name.
     * @param string $desiredVisibility The visibility the method should have.
     * @param string $testVisibility    The visibility the method actually has in the test.
     * @param int    $line              The line number.
     * @param bool   $isTrait           Whether the test relates to method in a trait.
     *
     *
     * @return void
     */
    public function testWrongMethodVisibility($methodName, $desiredVisibility, $testVisibility, $line, $isTrait = false)

    {
        if ($isTrait === true && self::$recognizesTraits === false) {
            $this->markTestSkipped();
            return;
        }

        $file = $this->getTestFile($isTrait);
        $this->assertError($file, $line, "Visibility for magic method {$methodName} must be {$desiredVisibility}. Found: {$testVisibility}");
    }

    /**
     * Data provider.
     *
     * @see testWrongMethodVisibility()
     *
     * @return array
     */
    public function dataWrongMethodVisibility()
    {
        return array(
            /*
             * nonstatic_magic_methods.1.php
             */
            // Class.
            array('__get', 'public', 'private', 32),
            array('__set', 'public', 'protected', 33),
            array('__isset', 'public', 'private', 34),
            array('__unset', 'public', 'protected', 35),
            array('__call', 'public', 'private', 36),
            array('__callStatic', 'public', 'protected', 37),
            array('__sleep', 'public', 'private', 38),
            array('__toString', 'public', 'protected', 39),

            // Alternative property order & stacked.
            array('__set', 'public', 'protected', 56),
            array('__isset', 'public', 'private', 57),
            array('__get', 'public', 'private', 65),

            // Interface.
            array('__get', 'public', 'protected', 98),
            array('__set', 'public', 'private', 99),
            array('__isset', 'public', 'protected', 100),
            array('__unset', 'public', 'private', 101),
            array('__call', 'public', 'protected', 102),
            array('__callStatic', 'public', 'private', 103),
            array('__sleep', 'public', 'protected', 104),
            array('__toString', 'public', 'private', 105),

            /*
             * nonstatic_magic_methods.2.php
             */
            // Trait.
            array('__get', 'public', 'private', 32, true),
            array('__set', 'public', 'protected', 33, true),
            array('__isset', 'public', 'private', 34, true),
            array('__unset', 'public', 'protected', 35, true),
            array('__call', 'public', 'private', 36, true),
            array('__callStatic', 'public', 'protected', 37, true),
            array('__sleep', 'public', 'private', 38, true),
            array('__toString', 'public', 'protected', 39, true),

        );
    }


    /**
     * testWrongStaticMethod
     *
     * @group MagicMethods
     *
     * @dataProvider dataWrongStaticMethod
     *
     * @param string $methodName Method name.
     * @param int    $line       The line number.
     * @param bool   $isTrait    Whether the test relates to a method in a trait.
     *
     * @return void
     */
    public function testWrongStaticMethod($methodName, $line, $isTrait = false)

    {
        if ($isTrait === true && self::$recognizesTraits === false) {
            $this->markTestSkipped();
            return;
        }

        $file = $this->getTestFile($isTrait);
        $this->assertError($file, $line, "Magic method {$methodName} cannot be defined as static.");
    }

    /**
     * Data provider.
     *
     * @see testWrongStaticMethod()
     *
     * @return array
     */
    public function dataWrongStaticMethod()
    {
        return array(
            /*
             * nonstatic_magic_methods.1.php
             */
            // Class.
            array('__get', 44),
            array('__set', 45),
            array('__isset', 46),
            array('__unset', 47),
            array('__call', 48),

            // Alternative property order & stacked.
            array('__get', 55),
            array('__set', 56),
            array('__isset', 57),
            array('__get', 65),

            // Interface.
            array('__get', 110),
            array('__set', 111),
            array('__isset', 112),
            array('__unset', 113),
            array('__call', 114),

            /*
             * nonstatic_magic_methods.2.php
             */
            // Trait.
            array('__get', 44, true),
            array('__set', 45, true),
            array('__isset', 46, true),
            array('__unset', 47, true),
            array('__call', 48, true),

        );
    }


    /**
     * testWrongNonStaticMethod
     *
     * @group MagicMethods
     *
     * @dataProvider dataWrongNonStaticMethod
     *
     * @param string $methodName Method name.
     * @param int    $line       The line number.
     * @param bool   $isTrait    Whether the test relates to a method in a trait.
     *
     * @return void
     */
    public function testWrongNonStaticMethod($methodName, $line, $isTrait = false)

    {
        if ($isTrait === true && self::$recognizesTraits === false) {
            $this->markTestSkipped();
            return;
        }

        $file = $this->getTestFile($isTrait);
        $this->assertError($file, $line, "Magic method {$methodName} must be defined as static.");
    }

    /**
     * Data provider.
     *
     * @see testWrongNonStaticMethod()
     *
     * @return array
     */
    public function dataWrongNonStaticMethod()
    {
        return array(
            /*
             * nonstatic_magic_methods.1.php
             */
            // Class.
            array('__callStatic', 49),
            array('__set_state', 50),

            // Interface.
            array('__callStatic', 115),
            array('__set_state', 116),

            /*
             * nonstatic_magic_methods.2.php
             */
            // Trait.
            array('__callStatic', 49, true),
            array('__set_state', 50, true),

        );
    }

}


1		<?php
2		/**
3		* Non Static Magic Sniff test file
4		*
5		* @package PHPCompatibility
6		*/
7
8
9		/**
10		* Non Static Magic Sniff tests
11		*
12		* @uses BaseSniffTest
13		* @package PHPCompatibility
14		* @author Jansen Price <[email protected]>
15		*/
16		class NonStaticMagicMethodsSniffTest extends BaseSniffTest
		0 ignored issues – show Coding Style Compatibility introduced 2016-08-04 22:56 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
17		{
18		/**
19		* Whether or not traits will be recognized in PHPCS.
20		*
21		* @var bool
22		*/
23		protected static $recognizesTraits = true;
24
25
26		/**
27		* Set up skip condition.
28		*/
29		public static function setUpBeforeClass()
30		{
31		// When using PHPCS 1.x combined with PHP 5.3 or lower, traits are not recognized.
32		if (version_compare(PHP_CodeSniffer::VERSION, '2.0', '<') && version_compare(phpversion(), '5.4', '<')) {
33		self::$recognizesTraits = false;
34		}
35		}
36
37
38		/**
39		* Get the correct test file.
40		*
41		* (@internal
42		* The test file has been split into two:
43		* - one covering classes and interfaces
44		* - one covering traits
45		*
46		* This is to avoid test failing because PHPCS 1.x gets confused about the scope
47		* openers/closers when run on PHP 5.3 or lower.
48		* In a 'normal' situation you won't often find classes, interfaces and traits all
49		* mixed in one file anyway, so this issue for which this is a work-around,
50		* should not cause real world issues anyway.}}
51		*
52		* @param bool $isTrait Whether to load the class/interface test file or the trait test file.
53		*
54		* @return PHP_CodeSniffer_File File object\|false
55		*/
56		protected function getTestFile($isTrait) {
57		if ($isTrait === false) {
58		return $this->sniffFile('sniff-examples/nonstatic_magic_methods.1.php');
59		}
60		else {
61		return $this->sniffFile('sniff-examples/nonstatic_magic_methods.2.php');
62		}
63		}
64
65		/**
66		* testCorrectImplementation
67		*
68		* @group MagicMethods
69		*
70		* @dataProvider dataCorrectImplementation
71		*
72		* @param int $line The line number.
73		*
74		* @return void
75		*/
76		public function testCorrectImplementation($line, $isTrait = false)
77		{
78		if ($isTrait === true && self::$recognizesTraits === false) {
79		$this->markTestSkipped();
80		return;
81		}
82
83		$file = $this->getTestFile($isTrait);
84		$this->assertNoViolation($file, $line);
85		}
86
87		/**
88		* Data provider.
89		*
90		* @see testCorrectImplementation()
91		*
92		* @return array
93		*/
94		public function dataCorrectImplementation()
95		{
96		return array(
97		/*
98		* nonstatic_magic_methods.1.php
99		*/
100		// Plain class.
101		array(5),
102		array(6),
103		array(7),
104		array(8),
105		array(9),
106		array(10),
107		array(11),
108		array(12),
109		array(13),
110		// Normal class.
111		array(18),
112		array(19),
113		array(20),
114		array(21),
115		array(22),
116		array(23),
117		array(24),
118		array(25),
119		array(26),
120		array(27),
121
122		// Alternative property order & stacked.
123		array(58),
124
125		// Plain interface.
126		array(71),
127		array(72),
128		array(73),
129		array(74),
130		array(75),
131		array(76),
132		array(77),
133		array(78),
134		array(79),
135		// Normal interface.
136		array(84),
137		array(85),
138		array(86),
139		array(87),
140		array(88),
141		array(89),
142		array(90),
143		array(91),
144		array(92),
145		array(93),
146
147		/*
148		* nonstatic_magic_methods.2.php
149		*/
150		// Plain trait.
151		array(5, true),
152		array(6, true),
153		array(7, true),
154		array(8, true),
155		array(9, true),
156		array(10, true),
157		array(11, true),
158		array(12, true),
159		array(13, true),
160		// Normal trait.
161		array(18, true),
162		array(19, true),
163		array(20, true),
164		array(21, true),
165		array(22, true),
166		array(23, true),
167		array(24, true),
168		array(25, true),
169		array(26, true),
170		array(27, true),
171
172		);
173		}
174
175
176		/**
177		* testWrongMethodVisibility
178		*
179		* @group MagicMethods
180		*
181		* @dataProvider dataWrongMethodVisibility
182		*
183		* @param string $methodName Method name.
184		* @param string $desiredVisibility The visibility the method should have.
185		* @param string $testVisibility The visibility the method actually has in the test.
186		* @param int $line The line number.
187		* @param bool $isTrait Whether the test relates to method in a trait.
188		*
189		*
190		* @return void
191		*/
192	View Code Duplication	public function testWrongMethodVisibility($methodName, $desiredVisibility, $testVisibility, $line, $isTrait = false)
		0 ignored issues – show Duplication introduced 2016-08-16 03:42 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...
193		{
194		if ($isTrait === true && self::$recognizesTraits === false) {
195		$this->markTestSkipped();
196		return;
197		}
198
199		$file = $this->getTestFile($isTrait);
200		$this->assertError($file, $line, "Visibility for magic method {$methodName} must be {$desiredVisibility}. Found: {$testVisibility}");
201		}
202
203		/**
204		* Data provider.
205		*
206		* @see testWrongMethodVisibility()
207		*
208		* @return array
209		*/
210		public function dataWrongMethodVisibility()
211		{
212		return array(
213		/*
214		* nonstatic_magic_methods.1.php
215		*/
216		// Class.
217		array('__get', 'public', 'private', 32),
218		array('__set', 'public', 'protected', 33),
219		array('__isset', 'public', 'private', 34),
220		array('__unset', 'public', 'protected', 35),
221		array('__call', 'public', 'private', 36),
222		array('__callStatic', 'public', 'protected', 37),
223		array('__sleep', 'public', 'private', 38),
224		array('__toString', 'public', 'protected', 39),
225
226		// Alternative property order & stacked.
227		array('__set', 'public', 'protected', 56),
228		array('__isset', 'public', 'private', 57),
229		array('__get', 'public', 'private', 65),
230
231		// Interface.
232		array('__get', 'public', 'protected', 98),
233		array('__set', 'public', 'private', 99),
234		array('__isset', 'public', 'protected', 100),
235		array('__unset', 'public', 'private', 101),
236		array('__call', 'public', 'protected', 102),
237		array('__callStatic', 'public', 'private', 103),
238		array('__sleep', 'public', 'protected', 104),
239		array('__toString', 'public', 'private', 105),
240
241		/*
242		* nonstatic_magic_methods.2.php
243		*/
244		// Trait.
245		array('__get', 'public', 'private', 32, true),
246		array('__set', 'public', 'protected', 33, true),
247		array('__isset', 'public', 'private', 34, true),
248		array('__unset', 'public', 'protected', 35, true),
249		array('__call', 'public', 'private', 36, true),
250		array('__callStatic', 'public', 'protected', 37, true),
251		array('__sleep', 'public', 'private', 38, true),
252		array('__toString', 'public', 'protected', 39, true),
253
254		);
255		}
256
257
258		/**
259		* testWrongStaticMethod
260		*
261		* @group MagicMethods
262		*
263		* @dataProvider dataWrongStaticMethod
264		*
265		* @param string $methodName Method name.
266		* @param int $line The line number.
267		* @param bool $isTrait Whether the test relates to a method in a trait.
268		*
269		* @return void
270		*/
271	View Code Duplication	public function testWrongStaticMethod($methodName, $line, $isTrait = false)
		0 ignored issues – show Duplication introduced 2016-08-16 03:42 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...
272		{
273		if ($isTrait === true && self::$recognizesTraits === false) {
274		$this->markTestSkipped();
275		return;
276		}
277
278		$file = $this->getTestFile($isTrait);
279		$this->assertError($file, $line, "Magic method {$methodName} cannot be defined as static.");
280		}
281
282		/**
283		* Data provider.
284		*
285		* @see testWrongStaticMethod()
286		*
287		* @return array
288		*/
289		public function dataWrongStaticMethod()
290		{
291		return array(
292		/*
293		* nonstatic_magic_methods.1.php
294		*/
295		// Class.
296		array('__get', 44),
297		array('__set', 45),
298		array('__isset', 46),
299		array('__unset', 47),
300		array('__call', 48),
301
302		// Alternative property order & stacked.
303		array('__get', 55),
304		array('__set', 56),
305		array('__isset', 57),
306		array('__get', 65),
307
308		// Interface.
309		array('__get', 110),
310		array('__set', 111),
311		array('__isset', 112),
312		array('__unset', 113),
313		array('__call', 114),
314
315		/*
316		* nonstatic_magic_methods.2.php
317		*/
318		// Trait.
319		array('__get', 44, true),
320		array('__set', 45, true),
321		array('__isset', 46, true),
322		array('__unset', 47, true),
323		array('__call', 48, true),
324
325		);
326		}
327
328
329		/**
330		* testWrongNonStaticMethod
331		*
332		* @group MagicMethods
333		*
334		* @dataProvider dataWrongNonStaticMethod
335		*
336		* @param string $methodName Method name.
337		* @param int $line The line number.
338		* @param bool $isTrait Whether the test relates to a method in a trait.
339		*
340		* @return void
341		*/
342	View Code Duplication	public function testWrongNonStaticMethod($methodName, $line, $isTrait = false)
		0 ignored issues – show Duplication introduced 2016-08-16 03:42 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...
343		{
344		if ($isTrait === true && self::$recognizesTraits === false) {
345		$this->markTestSkipped();
346		return;
347		}
348
349		$file = $this->getTestFile($isTrait);
350		$this->assertError($file, $line, "Magic method {$methodName} must be defined as static.");
351		}
352
353		/**
354		* Data provider.
355		*
356		* @see testWrongNonStaticMethod()
357		*
358		* @return array
359		*/
360		public function dataWrongNonStaticMethod()
361		{
362		return array(
363		/*
364		* nonstatic_magic_methods.1.php
365		*/
366		// Class.
367		array('__callStatic', 49),
368		array('__set_state', 50),
369
370		// Interface.
371		array('__callStatic', 115),
372		array('__set_state', 116),
373
374		/*
375		* nonstatic_magic_methods.2.php
376		*/
377		// Trait.
378		array('__callStatic', 49, true),
379		array('__set_state', 50, true),
380
381		);
382		}
383
384		}
385

wimg / PHPCompatibility

Pull Request — master (#174)

gicMethod() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like