ValidClassNameSniff - Code Metrics - Inspection of "Fixed missing "TestCase" class issue on PHP 5.5 ve..." - aik099/CodingStandard - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( a46fbb...c35fd9 )

by Alexander

created 2018-12-09 10:49 UTC

ValidClassNameSniff A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

95.83%

Importance

Changes

Metric	Value
dl	0
loc	63
ccs	23
cts	24
cp	0.9583
rs	10
c	0
b	0
f	0
wmc	7
lcom	0
cbo	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
B	process()	0	27	6

<?php
/**
 * CodingStandard_Sniffs_NamingConventions_ValidClassNameSniff.
 *
 * PHP version 5
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Symfony2-phpcs-authors <[email protected]>
 * @author   Alexander Obuhovich <[email protected]>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */

namespace CodingStandard\Sniffs\NamingConventions;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
 * CodingStandard_Sniffs_NamingConventions_ValidClassNameSniff.
 *
 * Throws errors if abstract class names are not prefixed with "Abstract".
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @author   Alexander Obuhovich <[email protected]>
 * @license  https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
 * @link     https://github.com/aik099/CodingStandard
 */
class ValidClassNameSniff implements Sniff
{

    /**
     * A list of tokenizers this sniff supports.
     *
     * @var array
     */
    public $supportedTokenizers = array('PHP');


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return integer[]
     */
    public function register()
    {
        return array(T_CLASS);
    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param File $phpcsFile The file being scanned.
     * @param int  $stackPtr  The position of the current token in the
     *                        stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        $className = $phpcsFile->getDeclarationName($stackPtr);

        if (!$className) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return;
        }

        $classProperties = $phpcsFile->getClassProperties($stackPtr);
        $hasAbstractName = substr($className, 0, 8) === 'Abstract';

        if ($classProperties['is_abstract'] === true && $hasAbstractName === false) {
            $phpcsFile->addError(
                'Abstract class name "%s" is not prefixed with "Abstract"',
                $stackPtr,
                'AbstractWrongName',
                array($className)
            );
        } elseif ($classProperties['is_abstract'] === false && $hasAbstractName === true) {
            $phpcsFile->addError(
                'Non-abstract class name "%s" is prefixed with "Abstract"',
                $stackPtr,
                'AbstractMissingModifier',
                array($className)
            );
        }
    }//end process()
}//end class


1		<?php
2		/**
3		* CodingStandard_Sniffs_NamingConventions_ValidClassNameSniff.
4		*
5		* PHP version 5
6		*
7		* @category PHP
8		* @package PHP_CodeSniffer
9		* @author Symfony2-phpcs-authors <[email protected]>
10		* @author Alexander Obuhovich <[email protected]>
11		* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
12		* @link https://github.com/aik099/CodingStandard
13		*/
14
15		namespace CodingStandard\Sniffs\NamingConventions;
16
17		use PHP_CodeSniffer\Files\File;
18		use PHP_CodeSniffer\Sniffs\Sniff;
19
20		/**
21		* CodingStandard_Sniffs_NamingConventions_ValidClassNameSniff.
22		*
23		* Throws errors if abstract class names are not prefixed with "Abstract".
24		*
25		* @category PHP
26		* @package PHP_CodeSniffer
27		* @author Alexander Obuhovich <[email protected]>
28		* @license https://github.com/aik099/CodingStandard/blob/master/LICENSE BSD 3-Clause
29		* @link https://github.com/aik099/CodingStandard
30		*/
31		class ValidClassNameSniff implements Sniff
32		{
33
34		/**
35		* A list of tokenizers this sniff supports.
36		*
37		* @var array
38		*/
39		public $supportedTokenizers = array('PHP');
40
41
42		/**
43		* Returns an array of tokens this test wants to listen for.
44		*
45		* @return integer[]
46		*/
47	1	public function register()
48		{
49	1	return array(T_CLASS);
50		}//end register()
51
52
53		/**
54		* Processes this test, when one of its tokens is encountered.
55		*
56		* @param File $phpcsFile The file being scanned.
57		* @param int $stackPtr The position of the current token in the
58		* stack passed in $tokens.
59		*
60		* @return void
61		*/
62	1	public function process(File $phpcsFile, $stackPtr)
63		{
64	1	$className = $phpcsFile->getDeclarationName($stackPtr);
65
66	1	if (!$className) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-13 18:14 UTC by Report Bug Copy Issue Report The expression `$className` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
67		return;
68		}
69
70	1	$classProperties = $phpcsFile->getClassProperties($stackPtr);
71	1	$hasAbstractName = substr($className, 0, 8) === 'Abstract';
72
73	1	if ($classProperties['is_abstract'] === true && $hasAbstractName === false) {
74	1	$phpcsFile->addError(
75	1	'Abstract class name "%s" is not prefixed with "Abstract"',
76	1	$stackPtr,
77	1	'AbstractWrongName',
78	1	array($className)
79	1	);
80	1	} elseif ($classProperties['is_abstract'] === false && $hasAbstractName === true) {
81	1	$phpcsFile->addError(
82	1	'Non-abstract class name "%s" is prefixed with "Abstract"',
83	1	$stackPtr,
84	1	'AbstractMissingModifier',
85	1	array($className)
86	1	);
87	1	}
88	1	}//end process()
89		}//end class
90

aik099 / CodingStandard

Push — master ( a46fbb...c35fd9 )

ValidClassNameSniff A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like