15253296250

Committed 26 May 2025 11:55AM UTC coverage: 78.632% (+0.3%) from 78.375%

Build # 15253296250

Build Type

Pull #1105

github

Committed by

web-flow

Commit Message

Merge d9441d98f into caf806050

Pull Request Pull Request #1105: Skip tests when 'git' command is not available

Run Details

19665 of 25009 relevant lines covered (78.63%)

88.67 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.48

/src/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSniff.php

<?php
/**
 * Verifies that there is a space between each condition of foreach loops.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */

namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures;

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

class ForEachLoopDeclarationSniff implements Sniff
{

    /**
     * How many spaces should follow the opening bracket.
     *
     * @var integer
     */
    public $requiredSpacesAfterOpen = 0;

    /**
     * How many spaces should precede the closing bracket.
     *
     * @var integer
     */
    public $requiredSpacesBeforeClose = 0;


    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register()
    {
        return [T_FOREACH];

    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\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)
    {
        $this->requiredSpacesAfterOpen   = (int) $this->requiredSpacesAfterOpen;
        $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;
        $tokens = $phpcsFile->getTokens();

        $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
        if ($openingBracket === false) {
            // Parse error or live coding.
            return;
        }

        if (isset($tokens[$openingBracket]['parenthesis_closer']) === false) {
            // Parse error or live coding.
            return;
        }

        $closingBracket = $tokens[$openingBracket]['parenthesis_closer'];

        if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
            $error = 'Space found after opening bracket of FOREACH loop';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen');
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken(($openingBracket + 1), '');
            }
        } else if ($this->requiredSpacesAfterOpen > 0) {
            $spaceAfterOpen = 0;
            if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {
                $spaceAfterOpen = $tokens[($openingBracket + 1)]['length'];
            }

            if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
                $error = 'Expected %s spaces after opening bracket; %s found';
                $data  = [
                    $this->requiredSpacesAfterOpen,
                    $spaceAfterOpen,
                ];
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen', $data);
                if ($fix === true) {
                    $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
                    if ($spaceAfterOpen === 0) {
                        $phpcsFile->fixer->addContent($openingBracket, $padding);
                    } else {
                        $phpcsFile->fixer->replaceToken(($openingBracket + 1), $padding);
                    }
                }
            }
        }//end if

        if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
            $error = 'Space found before closing bracket of FOREACH loop';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose');
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken(($closingBracket - 1), '');
            }
        } else if ($this->requiredSpacesBeforeClose > 0) {
            $spaceBeforeClose = 0;
            if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {
                $spaceBeforeClose = $tokens[($closingBracket - 1)]['length'];
            }

            if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {
                $error = 'Expected %s spaces before closing bracket; %s found';
                $data  = [
                    $this->requiredSpacesBeforeClose,
                    $spaceBeforeClose,
                ];
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose', $data);
                if ($fix === true) {
                    $padding = str_repeat(' ', $this->requiredSpacesBeforeClose);
                    if ($spaceBeforeClose === 0) {
                        $phpcsFile->fixer->addContentBefore($closingBracket, $padding);
                    } else {
                        $phpcsFile->fixer->replaceToken(($closingBracket - 1), $padding);
                    }
                }
            }
        }//end if

        $asToken = $phpcsFile->findNext(T_AS, $openingBracket);
        if ($asToken === false) {
            // Parse error or live coding.
            return;
        }

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

            $fix = $phpcsFile->addFixableError($error, $asToken, 'AsNotLower', $data);
            if ($fix === true) {
                $phpcsFile->fixer->replaceToken($asToken, $expected);
            }
        }

        $doubleArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $asToken, $closingBracket);

        if ($doubleArrow !== false) {
            if ($tokens[($doubleArrow - 1)]['code'] !== T_WHITESPACE) {
                $error = 'Expected 1 space before "=>"; 0 found';
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeArrow');
                if ($fix === true) {
                    $phpcsFile->fixer->addContentBefore($doubleArrow, ' ');
                }
            } else {
                if ($tokens[($doubleArrow - 1)]['length'] !== 1) {
                    $spaces = $tokens[($doubleArrow - 1)]['length'];
                    $error  = 'Expected 1 space before "=>"; %s found';
                    $data   = [$spaces];
                    $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeArrow', $data);
                    if ($fix === true) {
                        $phpcsFile->fixer->replaceToken(($doubleArrow - 1), ' ');
                    }
                }
            }

            if ($tokens[($doubleArrow + 1)]['code'] !== T_WHITESPACE) {
                $error = 'Expected 1 space after "=>"; 0 found';
                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterArrow');
                if ($fix === true) {
                    $phpcsFile->fixer->addContent($doubleArrow, ' ');
                }
            } else {
                if ($tokens[($doubleArrow + 1)]['length'] !== 1) {
                    $spaces = $tokens[($doubleArrow + 1)]['length'];
                    $error  = 'Expected 1 space after "=>"; %s found';
                    $data   = [$spaces];
                    $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterArrow', $data);
                    if ($fix === true) {
                        $phpcsFile->fixer->replaceToken(($doubleArrow + 1), ' ');
                    }
                }
            }
        }//end if

        if ($tokens[($asToken - 1)]['code'] !== T_WHITESPACE) {
            $error = 'Expected 1 space before "as"; 0 found';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAs');
            if ($fix === true) {
                $phpcsFile->fixer->addContentBefore($asToken, ' ');
            }
        } else {
            if ($tokens[($asToken - 1)]['length'] !== 1) {
                $spaces = $tokens[($asToken - 1)]['length'];
                $error  = 'Expected 1 space before "as"; %s found';
                $data   = [$spaces];
                $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAs', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->replaceToken(($asToken - 1), ' ');
                }
            }
        }

        if ($tokens[($asToken + 1)]['code'] !== T_WHITESPACE) {
            $error = 'Expected 1 space after "as"; 0 found';
            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAs');
            if ($fix === true) {
                $phpcsFile->fixer->addContent($asToken, ' ');
            }
        } else {
            if ($tokens[($asToken + 1)]['length'] !== 1) {
                $spaces = $tokens[($asToken + 1)]['length'];
                $error  = 'Expected 1 space after "as"; %s found';
                $data   = [$spaces];
                $fix    = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAs', $data);
                if ($fix === true) {
                    $phpcsFile->fixer->replaceToken(($asToken + 1), ' ');
                }
            }
        }

    }//end process()


}//end class

1	<?php
2	/**
3	* Verifies that there is a space between each condition of foreach loops.
4	*
5	* @author Greg Sherwood <gsherwood@squiz.net>
6	* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
7	* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
8	*/
9
10	namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures;
11
12	use PHP_CodeSniffer\Files\File;
13	use PHP_CodeSniffer\Sniffs\Sniff;
14
15	class ForEachLoopDeclarationSniff implements Sniff
16	{
17
18	/**
19	* How many spaces should follow the opening bracket.
20	*
21	* @var integer
22	*/
23	public $requiredSpacesAfterOpen = 0;
24
25	/**
26	* How many spaces should precede the closing bracket.
27	*
28	* @var integer
29	*/
30	public $requiredSpacesBeforeClose = 0;
31
32
33	/**
34	* Returns an array of tokens this test wants to listen for.
35	*
36	* @return array<int\|string>
37	*/
38	public function register()	3✔
39	{
40	return [T_FOREACH];	3✔
41
42	}//end register()
43
44
45	/**
46	* Processes this test, when one of its tokens is encountered.
47	*
48	* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
49	* @param int $stackPtr The position of the current token in the
50	* stack passed in $tokens.
51	*
52	* @return void
53	*/
54	public function process(File $phpcsFile, $stackPtr)	3✔
55	{
56	$this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen;	3✔
57	$this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose;	3✔
58	$tokens = $phpcsFile->getTokens();	3✔
59
60	$openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);	3✔
61	if ($openingBracket === false) {	3✔
62	// Parse error or live coding.
63	return;	×
64	}
65
66	if (isset($tokens[$openingBracket]['parenthesis_closer']) === false) {	3✔
67	// Parse error or live coding.
68	return;	×
69	}
70
71	$closingBracket = $tokens[$openingBracket]['parenthesis_closer'];	3✔
72
73	if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {	3✔
74	$error = 'Space found after opening bracket of FOREACH loop';	3✔
75	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen');	3✔
76	if ($fix === true) {	3✔
77	$phpcsFile->fixer->replaceToken(($openingBracket + 1), '');	3✔
78	}
79	} else if ($this->requiredSpacesAfterOpen > 0) {	3✔
80	$spaceAfterOpen = 0;	3✔
81	if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) {	3✔
82	$spaceAfterOpen = $tokens[($openingBracket + 1)]['length'];	3✔
83	}
84
85	if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {	3✔
86	$error = 'Expected %s spaces after opening bracket; %s found';	3✔
87	$data = [	2✔
88	$this->requiredSpacesAfterOpen,	3✔
89	$spaceAfterOpen,	3✔
90	];	2✔
91	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen', $data);	3✔
92	if ($fix === true) {	3✔
93	$padding = str_repeat(' ', $this->requiredSpacesAfterOpen);	3✔
94	if ($spaceAfterOpen === 0) {	3✔
95	$phpcsFile->fixer->addContent($openingBracket, $padding);	3✔
96	} else {
97	$phpcsFile->fixer->replaceToken(($openingBracket + 1), $padding);	3✔
98	}
99	}
100	}
101	}//end if
102
103	if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {	3✔
104	$error = 'Space found before closing bracket of FOREACH loop';	3✔
105	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose');	3✔
106	if ($fix === true) {	3✔
107	$phpcsFile->fixer->replaceToken(($closingBracket - 1), '');	3✔
108	}
109	} else if ($this->requiredSpacesBeforeClose > 0) {	3✔
110	$spaceBeforeClose = 0;	3✔
111	if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) {	3✔
112	$spaceBeforeClose = $tokens[($closingBracket - 1)]['length'];	3✔
113	}
114
115	if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) {	3✔
116	$error = 'Expected %s spaces before closing bracket; %s found';	3✔
117	$data = [	2✔
118	$this->requiredSpacesBeforeClose,	3✔
119	$spaceBeforeClose,	3✔
120	];	2✔
121	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose', $data);	3✔
122	if ($fix === true) {	3✔
123	$padding = str_repeat(' ', $this->requiredSpacesBeforeClose);	3✔
124	if ($spaceBeforeClose === 0) {	3✔
125	$phpcsFile->fixer->addContentBefore($closingBracket, $padding);	3✔
126	} else {
127	$phpcsFile->fixer->replaceToken(($closingBracket - 1), $padding);	3✔
128	}
129	}
130	}
131	}//end if
132
133	$asToken = $phpcsFile->findNext(T_AS, $openingBracket);	3✔
134	if ($asToken === false) {	3✔
135	// Parse error or live coding.
136	return;	×
137	}
138
139	$content = $tokens[$asToken]['content'];	3✔
140	if ($content !== strtolower($content)) {	3✔
141	$expected = strtolower($content);	3✔
142	$error = 'AS keyword must be lowercase; expected "%s" but found "%s"';	3✔
143	$data = [	2✔
144	$expected,	3✔
145	$content,	3✔
146	];	2✔
147
148	$fix = $phpcsFile->addFixableError($error, $asToken, 'AsNotLower', $data);	3✔
149	if ($fix === true) {	3✔
150	$phpcsFile->fixer->replaceToken($asToken, $expected);	3✔
151	}
152	}
153
154	$doubleArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $asToken, $closingBracket);	3✔
155
156	if ($doubleArrow !== false) {	3✔
157	if ($tokens[($doubleArrow - 1)]['code'] !== T_WHITESPACE) {	3✔
158	$error = 'Expected 1 space before "=>"; 0 found';	3✔
159	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeArrow');	3✔
160	if ($fix === true) {	3✔
161	$phpcsFile->fixer->addContentBefore($doubleArrow, ' ');	3✔
162	}
163	} else {
164	if ($tokens[($doubleArrow - 1)]['length'] !== 1) {	3✔
165	$spaces = $tokens[($doubleArrow - 1)]['length'];	3✔
166	$error = 'Expected 1 space before "=>"; %s found';	3✔
167	$data = [$spaces];	3✔
168	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeArrow', $data);	3✔
169	if ($fix === true) {	3✔
170	$phpcsFile->fixer->replaceToken(($doubleArrow - 1), ' ');	3✔
171	}
172	}
173	}
174
175	if ($tokens[($doubleArrow + 1)]['code'] !== T_WHITESPACE) {	3✔
176	$error = 'Expected 1 space after "=>"; 0 found';	3✔
177	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterArrow');	3✔
178	if ($fix === true) {	3✔
179	$phpcsFile->fixer->addContent($doubleArrow, ' ');	3✔
180	}
181	} else {
182	if ($tokens[($doubleArrow + 1)]['length'] !== 1) {	3✔
183	$spaces = $tokens[($doubleArrow + 1)]['length'];	3✔
184	$error = 'Expected 1 space after "=>"; %s found';	3✔
185	$data = [$spaces];	3✔
186	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterArrow', $data);	3✔
187	if ($fix === true) {	3✔
188	$phpcsFile->fixer->replaceToken(($doubleArrow + 1), ' ');	3✔
189	}
190	}
191	}
192	}//end if
193
194	if ($tokens[($asToken - 1)]['code'] !== T_WHITESPACE) {	3✔
195	$error = 'Expected 1 space before "as"; 0 found';	3✔
196	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAs');	3✔
197	if ($fix === true) {	3✔
198	$phpcsFile->fixer->addContentBefore($asToken, ' ');	3✔
199	}
200	} else {
201	if ($tokens[($asToken - 1)]['length'] !== 1) {	3✔
202	$spaces = $tokens[($asToken - 1)]['length'];	3✔
203	$error = 'Expected 1 space before "as"; %s found';	3✔
204	$data = [$spaces];	3✔
205	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAs', $data);	3✔
206	if ($fix === true) {	3✔
207	$phpcsFile->fixer->replaceToken(($asToken - 1), ' ');	3✔
208	}
209	}
210	}
211
212	if ($tokens[($asToken + 1)]['code'] !== T_WHITESPACE) {	3✔
213	$error = 'Expected 1 space after "as"; 0 found';	3✔
214	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAs');	3✔
215	if ($fix === true) {	3✔
216	$phpcsFile->fixer->addContent($asToken, ' ');	3✔
217	}
218	} else {
219	if ($tokens[($asToken + 1)]['length'] !== 1) {	3✔
220	$spaces = $tokens[($asToken + 1)]['length'];	3✔
221	$error = 'Expected 1 space after "as"; %s found';	3✔
222	$data = [$spaces];	3✔
223	$fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAs', $data);	3✔
224	if ($fix === true) {	3✔
225	$phpcsFile->fixer->replaceToken(($asToken + 1), ' ');	3✔
226	}
227	}
228	}
229
230	}//end process()	1✔
231
232
233	}//end class

PHPCSStandards / PHP_CodeSniffer / 15253296250

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous