NoIsNullSniff - Code Metrics - Inspection of "add scrutinizer" - jazzsequence/games-collector - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 699b70...879176 )

by Chris

created 2017-04-04 23:43 UTC

NoIsNullSniff B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	243
Duplicated Lines	13.17 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	32
loc	243
rs	8.5454
c	0
b	0
f	0
wmc	49
lcom	1
cbo	4

9 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	3	1
F	process()	20	111	31
A	leadRequiresBrackets()	0	13	3
A	isCast()	0	5	1
A	findUnnecessaryLeadingComparisonStart()	6	15	3
B	findUnnecessaryTrailingComparisonEnd()	6	15	5
A	hasLeadingComparison()	0	4	1
A	hasTrailingComparison()	0	6	1
A	isComparison()	0	18	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like NoIsNullSniff often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use NoIsNullSniff, and based on these observations, apply Extract Interface, too.

<?php

namespace PSR2R\Sniffs\PHP;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Tokens;

/**
 * is_null() should be replaced by === null check.
 *
 * @author Mark Scherer
 * @license MIT
 */
class NoIsNullSniff extends \PSR2R\Tools\AbstractSniff {

	/**
	 * @inheritDoc
	 */
	public function register() {
		return [T_STRING];
	}

	/**
	 * @inheritDoc
	 */
	public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
		$wrongTokens = [T_FUNCTION, T_OBJECT_OPERATOR, T_NEW, T_DOUBLE_COLON];

		$tokens = $phpcsFile->getTokens();

		$tokenContent = $tokens[$stackPtr]['content'];
		if (strtolower($tokenContent) !== 'is_null') {
			return;
		}

		$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
		if (!$previous || in_array($tokens[$previous]['code'], $wrongTokens)) {
			return;
		}

		$openingBraceIndex = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
		if (!$openingBraceIndex || $tokens[$openingBraceIndex]['type'] !== 'T_OPEN_PARENTHESIS') {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

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

		$closingBraceIndex = $tokens[$openingBraceIndex]['parenthesis_closer'];

		$error = $tokenContent . '() found, should be strict === null check.';

		$possibleCastIndex = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
		$negated = false;
		if ($possibleCastIndex && $tokens[$possibleCastIndex]['code'] === T_BOOLEAN_NOT) {
			$negated = true;
		}
		// We dont want to fix double !!
		if ($negated) {
			$anotherPossibleCastIndex = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($possibleCastIndex - 1), null, true);
			if ($tokens[$anotherPossibleCastIndex]['code'] === T_BOOLEAN_NOT) {
				$phpcsFile->addError($error, $stackPtr);
				return;
			}
		}

		// We don't want to fix stuff with bad inline assignment
		if ($this->contains($phpcsFile, 'T_EQUAL', $openingBraceIndex + 1, $closingBraceIndex - 1)) {
			$phpcsFile->addError($error, $stackPtr);
			return;
		}

		$beginningIndex = $negated ? $possibleCastIndex : $stackPtr;
		$endIndex = $closingBraceIndex;

		$fix = $phpcsFile->addFixableError($error, $stackPtr);
		if ($fix) {
			$needsBrackets = $this->needsBrackets($phpcsFile, $openingBraceIndex, $closingBraceIndex);
			$leadingComparison = $this->hasLeadingComparison($phpcsFile, $beginningIndex);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			$trailingComparison = $this->hasTrailingComparison($phpcsFile, $closingBraceIndex);

			if ($leadingComparison) {

				$possibleBeginningIndex = $this->findUnnecessaryLeadingComparisonStart($phpcsFile, $beginningIndex);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				if ($possibleBeginningIndex !== null) {
					$beginningIndex = $possibleBeginningIndex;
					$leadingComparison = false;
					if ($tokens[$beginningIndex]['code'] === T_FALSE) {
						$negated = !$negated;
					}
				}
			}

			if ($trailingComparison) {

				$possibleEndIndex = $this->findUnnecessaryLeadingComparisonStart($phpcsFile, $endIndex);
				if ($possibleEndIndex !== null) {
					$endIndex = $possibleEndIndex;
					$trailingComparison = false;
					if ($tokens[$endIndex]['code'] === T_FALSE) {
						$negated = !$negated;
					}
				}
			}

			if (!$needsBrackets && ($leadingComparison || $this->leadRequiresBrackets($phpcsFile, $beginningIndex))) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				$needsBrackets = true;
			}
			if (!$needsBrackets && $trailingComparison) {
				$needsBrackets = true;
			}

			$comparisonString = ' ' . ($negated ? '!' : '=') . '== null';

			$phpcsFile->fixer->beginChangeset();

			if ($negated) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
				//$phpcsFile->fixer->replaceToken($possibleCastIndex, '');

			}
			if ($beginningIndex !== $stackPtr) {
				for ($i = $beginningIndex; $i < $stackPtr; $i++) {
					$phpcsFile->fixer->replaceToken($i, '');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				}
			}
			if ($endIndex !== $closingBraceIndex) {
				for ($i = $endIndex; $i > $closingBraceIndex; $i--) {
					$phpcsFile->fixer->replaceToken($i, '');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				}
			}

			$phpcsFile->fixer->replaceToken($stackPtr, '');
			if (!$needsBrackets) {
				$phpcsFile->fixer->replaceToken($openingBraceIndex, '');
				$phpcsFile->fixer->replaceToken($closingBraceIndex, $comparisonString);
			} else {
				$phpcsFile->fixer->replaceToken($closingBraceIndex, $comparisonString . ')');
			}

			$phpcsFile->fixer->endChangeset();
		}
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $index
	 * @return bool
	 */
	protected function leadRequiresBrackets(PHP_CodeSniffer_File $phpcsFile, $index) {
		$tokens = $phpcsFile->getTokens();

		$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($index - 1), null, true);
		if ($this->isCast($phpcsFile, $previous)) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			return true;
		}
		if (in_array($tokens[$previous]['code'], PHP_CodeSniffer_Tokens::$arithmeticTokens)) {
			return true;
		}

		return false;
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $index
	 * @return bool
	 */
	protected function isCast(PHP_CodeSniffer_File $phpcsFile, $index) {
		$tokens = $phpcsFile->getTokens();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		return in_array($index, PHP_CodeSniffer_Tokens::$castTokens);
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $index
	 * @return int|null
	 */
	protected function findUnnecessaryLeadingComparisonStart(PHP_CodeSniffer_File $phpcsFile, $index) {
		$tokens = $phpcsFile->getTokens();

		$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($index - 1), null, true);
		if (!in_array($tokens[$previous]['code'], [T_IS_IDENTICAL, T_IS_NOT_IDENTICAL])) {

			return null;
		}

		$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($previous - 1), null, true);
		if (!in_array($tokens[$previous]['code'], [T_TRUE, T_FALSE])) {

			return null;
		}

		return $previous;
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $index
	 * @return int|null
	 */
	protected function findUnnecessaryTrailingComparisonEnd(PHP_CodeSniffer_File $phpcsFile, $index) {
		$tokens = $phpcsFile->getTokens();

		$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($index + 1), null, true);
		if (!$next || !in_array($tokens[$next]['code'], [T_IS_IDENTICAL, T_IS_NOT_IDENTICAL])) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

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

		$prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($next - 1), null, true);
		if (!$prev || !in_array($tokens[$prev]['code'], [T_TRUE, T_FALSE])) {

			return null;
		}

		return $next;
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $stackPtr
	 * @return bool
	 */
	protected function hasLeadingComparison(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
		$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
		return $this->isComparison($phpcsFile, $previous);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $stackPtr
	 * @return bool
	 */
	protected function hasTrailingComparison(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
		$tokens = $phpcsFile->getTokens();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
		return $this->isComparison($phpcsFile, $next);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
	}

	/**
	 * @param \PHP_CodeSniffer_File $phpcsFile
	 * @param int $index
	 * @return bool
	 */
	protected function isComparison(PHP_CodeSniffer_File $phpcsFile, $index) {
		$tokens = $phpcsFile->getTokens();

		$blacklistedCodes = [
			T_IS_NOT_EQUAL, T_IS_EQUAL, T_IS_IDENTICAL, T_IS_NOT_IDENTICAL, T_IS_GREATER_OR_EQUAL, T_IS_SMALLER_OR_EQUAL
		];
		$blacklistedTypes = [
			'T_LESS_THAN', 'T_GREATER_THAN',
		];
		if (in_array($tokens[$index]['code'], $blacklistedCodes)) {
			return true;
		}
		if (in_array($tokens[$index]['type'], $blacklistedTypes)) {
			return true;
		}

		return false;
	}

}


1			<?php
2
3			namespace PSR2R\Sniffs\PHP;
4
5			use PHP_CodeSniffer_File;
6			use PHP_CodeSniffer_Tokens;
7
8			/**
9			* is_null() should be replaced by === null check.
10			*
11			* @author Mark Scherer
12			* @license MIT
13			*/
14			class NoIsNullSniff extends \PSR2R\Tools\AbstractSniff {
15
16			/**
17			* @inheritDoc
18			*/
19			public function register() {
20			return [T_STRING];
21			}
22
23			/**
24			* @inheritDoc
25			*/
26			public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
27			$wrongTokens = [T_FUNCTION, T_OBJECT_OPERATOR, T_NEW, T_DOUBLE_COLON];
28
29			$tokens = $phpcsFile->getTokens();
30
31			$tokenContent = $tokens[$stackPtr]['content'];
32			if (strtolower($tokenContent) !== 'is_null') {
33			return;
34			}
35
36			$previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
37			if (!$previous \|\| in_array($tokens[$previous]['code'], $wrongTokens)) {
38			return;
39			}
40

jazzsequence / games-collector

GitHub Access Token became invalid