SwitchDeclarationSniff::findNextCase() - 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

SwitchDeclarationSniff::findNextCase() A

↳ Parent: SwitchDeclarationSniff

Complexity

Conditions	3
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	15
Ratio	100 %

Importance

Changes

Metric	Value
cc	3
eloc	8
nc	2
nop	3
dl	15
loc	15
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff.
 *
 * PHP version 5
 *
 * @category  PHP
 * @package   PHP_CodeSniffer
 * @author    Greg Sherwood <[email protected]>
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 */

namespace PSR2R\Sniffs\ControlStructures;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Sniff;

/**
 * PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff.
 *
 * Ensures all switch statements are defined correctly.
 *
 * @author Greg Sherwood <[email protected]>
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 * @version Release: @package_version@
 * @link http://pear.php.net/package/PHP_CodeSniffer
 */
class SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff {


	/**
	 * The number of spaces code should be indented.
	 *
	 * @var int
	 */
	public $indent = 4;


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

	}


	/**
	 * @inheritDoc
	 */
	public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
		$tokens = $phpcsFile->getTokens();

		// TODO: Auto-detect spaces vs tabs, maybe using a trait method indent($index, $this->indent)
		$this->indent = 1;

		// We can't process SWITCH statements unless we know where they start and end.
		if (isset($tokens[$stackPtr]['scope_opener']) === false
			|| isset($tokens[$stackPtr]['scope_closer']) === false
		) {
			return;
		}

		$switch = $tokens[$stackPtr];
		$nextCase = $stackPtr;
		$caseAlignment = ($switch['column'] + $this->indent);
		$caseCount = 0;
		$foundDefault = false;
$myVar = 'Value';
$higher = false;

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

		while (($nextCase = $this->findNextCase($phpcsFile, ($nextCase + 1), $switch['scope_closer'])) !== false) {
			if ($tokens[$nextCase]['code'] === T_DEFAULT) {
				$type = 'default';
				$foundDefault = true;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			} else {
				$type = 'case';
				$caseCount++;
			}

			if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) {
				$expected = strtolower($tokens[$nextCase]['content']);
				$error = strtoupper($type) . ' keyword must be lowercase; expected "%s" but found "%s"';
				$data = [
							 $expected,
							 $tokens[$nextCase]['content'],
							];

				$fix = $phpcsFile->addFixableError($error, $nextCase, $type . 'NotLower', $data);
				if ($fix === true) {
					$phpcsFile->fixer->replaceToken($nextCase, $expected);
				}
			}

			if ($type === 'case'
				&& ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE
				|| $tokens[($nextCase + 1)]['content'] !== ' ')
			) {
				$error = 'CASE keyword must be followed by a single space';
				$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase');
				if ($fix === true) {
					if ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE) {
						$phpcsFile->fixer->addContent($nextCase, ' ');
					} else {
						$phpcsFile->fixer->replaceToken(($nextCase + 1), ' ');
					}
				}
			}

			$opener = $tokens[$nextCase]['scope_opener'];
			if ($tokens[$opener]['code'] === T_COLON) {
				if ($tokens[($opener - 1)]['code'] === T_WHITESPACE) {
					$error = 'There must be no space before the colon in a ' . strtoupper($type) . ' statement';
					$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon' . strtoupper($type));
					if ($fix === true) {
						$phpcsFile->fixer->replaceToken(($opener - 1), '');
					}
				}

				$next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true);
				if ($tokens[$next]['line'] === $tokens[$opener]['line']
					&& $tokens[$next]['code'] === T_COMMENT
				) {
					// Skip comments on the same line.
					$next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
				}

				if ($tokens[$next]['line'] !== ($tokens[$opener]['line'] + 1)) {
					$error = 'The ' . strtoupper($type) . ' body must start on the line following the statement';
					$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon' . strtoupper($type));
					if ($fix === true) {
						if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
							$padding = str_repeat(' ', ($caseAlignment + $this->indent - 1));
							$phpcsFile->fixer->addContentBefore($next, $phpcsFile->eolChar . $padding);

						} else {
							$phpcsFile->fixer->beginChangeset();
							for ($i = ($opener + 1); $i < $next; $i++) {
								if ($tokens[$i]['line'] === $tokens[$next]['line']) {
									break;
								}

								$phpcsFile->fixer->replaceToken($i, '');
							}

							$phpcsFile->fixer->addNewLineBefore($i);
							$phpcsFile->fixer->endChangeset();
						}
					}
				}
			} else {
				$error = strtoupper($type) . ' statements must be defined using a colon';
				$phpcsFile->addError($error, $nextCase, 'WrongOpener' . $type);
			}

			$nextCloser = $tokens[$nextCase]['scope_closer'];
			if ($tokens[$nextCloser]['scope_condition'] === $nextCase) {
				// Only need to check some things once, even if the
				// closer is shared between multiple case statements, or even
				// the default case.
				$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCloser - 1), $nextCase, true);
				if ($tokens[$prev]['line'] === $tokens[$nextCloser]['line']) {
					$error = 'Terminating statement must be on a line by itself';
					$fix = $phpcsFile->addFixableError($error, $nextCloser, 'BreakNotNewLine');
					if ($fix === true) {
						$phpcsFile->fixer->addNewLine($prev);
/**
 * @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($nextCloser, trim($tokens[$nextCloser]['content']));
					}
				} else {
					$diff = ($caseAlignment + $this->indent - $tokens[$nextCloser]['column']);
					if ($diff !== 0) {
						$error = 'Terminating statement must be indented to the same level as the CASE body';
						$fix = $phpcsFile->addFixableError($error, $nextCloser, 'BreakIndent');
						if ($fix === true) {
							if ($diff > 0) {
								$phpcsFile->fixer->addContentBefore($nextCloser, str_repeat(' ', $diff));
							} else {
								$phpcsFile->fixer->substrToken(($nextCloser - 1), 0, $diff);
							}
						}
					}
				}
			}

			// We only want cases from here on in.
			if ($type !== 'case') {
				continue;
			}

			$nextCode = $phpcsFile->findNext(T_WHITESPACE,
				($tokens[$nextCase]['scope_opener'] + 1),
				$nextCloser,
				true);

			if ($tokens[$nextCode]['code'] !== T_CASE && $tokens[$nextCode]['code'] !== T_DEFAULT) {
				// This case statement has content. If the next case or default comes
				// before the closer, it means we dont have a terminating statement
				// and instead need a comment.
				$nextCode = $this->findNextCase($phpcsFile, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser);
				if ($nextCode !== false) {
					$prevCode = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCode - 1), $nextCase, true);
					if ($tokens[$prevCode]['code'] !== T_COMMENT) {
						$error = 'There must be a comment when fall-through is intentional in a non-empty case body';
						$phpcsFile->addError($error, $nextCase, 'TerminatingComment');
					}
				}
			}
		}

	}


	/**
	 * Find the next CASE or DEFAULT statement from a point in the file.
	 *
	 * Note that nested switches are ignored.
	 *
	 * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
	 * @param int $stackPtr The position to start looking at.
	 * @param int $end The position to stop looking at.
	 *
	 * @return int | bool
	 */
	protected function findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end) {
		$tokens = $phpcsFile->getTokens();
		while (($stackPtr = $phpcsFile->findNext([T_CASE, T_DEFAULT, T_SWITCH], $stackPtr, $end)) !== false) {
			// Skip nested SWITCH statements; they are handled on their own.
			if ($tokens[$stackPtr]['code'] === T_SWITCH) {
				$stackPtr = $tokens[$stackPtr]['scope_closer'];
				continue;
			}

			break;
		}

		return $stackPtr;

	}

}


1		<?php
2		/**
3		* PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff.
4		*
5		* PHP version 5
6		*
7		* @category PHP
8		* @package PHP_CodeSniffer
9		* @author Greg Sherwood <[email protected]>
10		* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
11		* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
12		* @link http://pear.php.net/package/PHP_CodeSniffer
13		*/
14
15		namespace PSR2R\Sniffs\ControlStructures;
16
17		use PHP_CodeSniffer_File;
18		use PHP_CodeSniffer_Sniff;
19
20		/**
21		* PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff.
22		*
23		* Ensures all switch statements are defined correctly.
24		*
25		* @author Greg Sherwood <[email protected]>
26		* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
27		* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
28		* @version Release: @package_version@
29		* @link http://pear.php.net/package/PHP_CodeSniffer
30		*/
31	View Code Duplication	class SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff {
		0 ignored issues – show Duplication introduced 2017-04-04 23:55 UTC by Report Bug Copy Issue Report This class 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...
32
33		/**
34		* The number of spaces code should be indented.
35		*
36		* @var int
37		*/
38		public $indent = 4;
39
40
41		/**
42		* @inheritDoc
43		*/
44		public function register() {
45		return [T_SWITCH];
46
47		}
48
49
50		/**
51		* @inheritDoc
52		*/
53		public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
54		$tokens = $phpcsFile->getTokens();
55
56		// TODO: Auto-detect spaces vs tabs, maybe using a trait method indent($index, $this->indent)
57		$this->indent = 1;
58
59		// We can't process SWITCH statements unless we know where they start and end.
60		if (isset($tokens[$stackPtr]['scope_opener']) === false
61		\|\| isset($tokens[$stackPtr]['scope_closer']) === false
62		) {
63		return;
64		}
65
66		$switch = $tokens[$stackPtr];
67		$nextCase = $stackPtr;
68		$caseAlignment = ($switch['column'] + $this->indent);
69		$caseCount = 0;
70		$foundDefault = false;
		0 ignored issues – show Unused Code introduced 2017-04-04 23:55 UTC by Report Bug Copy Issue Report `$foundDefault` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
71
72		while (($nextCase = $this->findNextCase($phpcsFile, ($nextCase + 1), $switch['scope_closer'])) !== false) {
73		if ($tokens[$nextCase]['code'] === T_DEFAULT) {
74		$type = 'default';
75		$foundDefault = true;
		0 ignored issues – show Unused Code introduced 2017-04-04 23:55 UTC by Report Bug Copy Issue Report `$foundDefault` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
76		} else {
77		$type = 'case';
78		$caseCount++;
79		}
80
81		if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) {
82		$expected = strtolower($tokens[$nextCase]['content']);
83		$error = strtoupper($type) . ' keyword must be lowercase; expected "%s" but found "%s"';
84		$data = [
85		$expected,
86		$tokens[$nextCase]['content'],
87		];
88
89		$fix = $phpcsFile->addFixableError($error, $nextCase, $type . 'NotLower', $data);
90		if ($fix === true) {
91		$phpcsFile->fixer->replaceToken($nextCase, $expected);
92		}
93		}
94
95		if ($type === 'case'
96		&& ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE
97		\|\| $tokens[($nextCase + 1)]['content'] !== ' ')
98		) {
99		$error = 'CASE keyword must be followed by a single space';
100		$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase');
101		if ($fix === true) {
102		if ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE) {
103		$phpcsFile->fixer->addContent($nextCase, ' ');
104		} else {
105		$phpcsFile->fixer->replaceToken(($nextCase + 1), ' ');
106		}
107		}
108		}
109
110		$opener = $tokens[$nextCase]['scope_opener'];
111		if ($tokens[$opener]['code'] === T_COLON) {
112		if ($tokens[($opener - 1)]['code'] === T_WHITESPACE) {
113		$error = 'There must be no space before the colon in a ' . strtoupper($type) . ' statement';
114		$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon' . strtoupper($type));
115		if ($fix === true) {
116		$phpcsFile->fixer->replaceToken(($opener - 1), '');
117		}
118		}
119
120		$next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true);
121		if ($tokens[$next]['line'] === $tokens[$opener]['line']
122		&& $tokens[$next]['code'] === T_COMMENT
123		) {
124		// Skip comments on the same line.
125		$next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true);
126		}
127
128		if ($tokens[$next]['line'] !== ($tokens[$opener]['line'] + 1)) {
129		$error = 'The ' . strtoupper($type) . ' body must start on the line following the statement';
130		$fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon' . strtoupper($type));
131		if ($fix === true) {
132		if ($tokens[$next]['line'] === $tokens[$opener]['line']) {
133		$padding = str_repeat(' ', ($caseAlignment + $this->indent - 1));
134		$phpcsFile->fixer->addContentBefore($next, $phpcsFile->eolChar . $padding);
		0 ignored issues – show Security Bug introduced 2017-04-04 23:55 UTC by Report Bug Copy Issue Report It seems like `$next` can also be of type `false`; however, `PHP_CodeSniffer_Fixer::addContentBefore()` does only seem to accept `integer`, did you maybe forget to handle an error condition? Loading history...
135		} else {
136		$phpcsFile->fixer->beginChangeset();
137		for ($i = ($opener + 1); $i < $next; $i++) {
138		if ($tokens[$i]['line'] === $tokens[$next]['line']) {
139		break;
140		}
141
142		$phpcsFile->fixer->replaceToken($i, '');
143		}
144
145		$phpcsFile->fixer->addNewLineBefore($i);
146		$phpcsFile->fixer->endChangeset();
147		}
148		}
149		}
150		} else {
151		$error = strtoupper($type) . ' statements must be defined using a colon';
152		$phpcsFile->addError($error, $nextCase, 'WrongOpener' . $type);
153		}
154
155		$nextCloser = $tokens[$nextCase]['scope_closer'];
156		if ($tokens[$nextCloser]['scope_condition'] === $nextCase) {
157		// Only need to check some things once, even if the
158		// closer is shared between multiple case statements, or even
159		// the default case.
160		$prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCloser - 1), $nextCase, true);
161		if ($tokens[$prev]['line'] === $tokens[$nextCloser]['line']) {
162		$error = 'Terminating statement must be on a line by itself';
163		$fix = $phpcsFile->addFixableError($error, $nextCloser, 'BreakNotNewLine');
164		if ($fix === true) {
165		$phpcsFile->fixer->addNewLine($prev);
		0 ignored issues – show Bug introduced 2017-04-04 23:55 UTC by Report Bug Copy Issue Report It seems like `$prev` defined by `$phpcsFile->findPrevious...r - 1, $nextCase, true)` on line `160` can also be of type `boolean`; however, `PHP_CodeSniffer_Fixer::addNewline()` does only seem to accept `integer`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
166		$phpcsFile->fixer->replaceToken($nextCloser, trim($tokens[$nextCloser]['content']));
167		}
168		} else {
169		$diff = ($caseAlignment + $this->indent - $tokens[$nextCloser]['column']);
170		if ($diff !== 0) {
171		$error = 'Terminating statement must be indented to the same level as the CASE body';
172		$fix = $phpcsFile->addFixableError($error, $nextCloser, 'BreakIndent');
173		if ($fix === true) {
174		if ($diff > 0) {
175		$phpcsFile->fixer->addContentBefore($nextCloser, str_repeat(' ', $diff));
176		} else {
177		$phpcsFile->fixer->substrToken(($nextCloser - 1), 0, $diff);
178		}
179		}
180		}
181		}
182		}
183
184		// We only want cases from here on in.
185		if ($type !== 'case') {
186		continue;
187		}
188
189		$nextCode = $phpcsFile->findNext(T_WHITESPACE,
190		($tokens[$nextCase]['scope_opener'] + 1),
191		$nextCloser,
192		true);
193
194		if ($tokens[$nextCode]['code'] !== T_CASE && $tokens[$nextCode]['code'] !== T_DEFAULT) {
195		// This case statement has content. If the next case or default comes
196		// before the closer, it means we dont have a terminating statement
197		// and instead need a comment.
198		$nextCode = $this->findNextCase($phpcsFile, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser);
199		if ($nextCode !== false) {
200		$prevCode = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCode - 1), $nextCase, true);
201		if ($tokens[$prevCode]['code'] !== T_COMMENT) {
202		$error = 'There must be a comment when fall-through is intentional in a non-empty case body';
203		$phpcsFile->addError($error, $nextCase, 'TerminatingComment');
204		}
205		}
206		}
207		}
208
209		}
210
211
212		/**
213		* Find the next CASE or DEFAULT statement from a point in the file.
214		*
215		* Note that nested switches are ignored.
216		*
217		* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
218		* @param int $stackPtr The position to start looking at.
219		* @param int $end The position to stop looking at.
220		*
221		* @return int \| bool
222		*/
223		protected function findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end) {
224		$tokens = $phpcsFile->getTokens();
225		while (($stackPtr = $phpcsFile->findNext([T_CASE, T_DEFAULT, T_SWITCH], $stackPtr, $end)) !== false) {
226		// Skip nested SWITCH statements; they are handled on their own.
227		if ($tokens[$stackPtr]['code'] === T_SWITCH) {
228		$stackPtr = $tokens[$stackPtr]['scope_closer'];
229		continue;
230		}
231
232		break;
233		}
234
235		return $stackPtr;
236
237		}
238
239		}
240

jazzsequence / games-collector

GitHub Access Token became invalid

Push — develop ( 699b70...879176 )

SwitchDeclarationSniff::findNextCase() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like