1599

pending completion

Build # 1599

Build Type

Pull #618

travis-ci

Committed by

web-flow

Commit Message

:sparkles: PHP 7.0: New sniff to detect generator return expressions

> Generator Return Expressions
>
> This feature builds upon the generator functionality introduced into PHP 5.5. It enables for a `return` statement to be used within a generator to enable for a final expression to be returned (return by reference is not allowed). > This value can be fetched using the new `Generator::getReturn()` method, which may only be used once the generator has finished yielding values.

Refs:
* http://php.net/manual/en/migration70.new-features.php#migration70.new-features.generator-return-expressions
* https://wiki.php.net/rfc/generator-return-expressions
> https://github.com/php/php-src/commit/5c230baf7

The new sniff checks for and reports on `return` statements being found in generator functions.

Includes unit tests.

Pull Request Pull Request #618: PHP 7.0: New sniff to detect generator return expressions

Run Details

30 of 30 new or added lines in 1 file covered. (100.0%)

2675 of 2759 relevant lines covered (96.96%)

31.97 hits per line

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

92.42

/PHPCompatibility/Sniffs/PHP/RemovedAlternativePHPTagsSniff.php

<?php
/**
 * \PHPCompatibility\Sniffs\PHP\RemovedAlternativePHPTags.
 *
 * PHP version 7.0
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
 */

namespace PHPCompatibility\Sniffs\PHP;

use PHPCompatibility\Sniff;

/**
 * \PHPCompatibility\Sniffs\PHP\RemovedAlternativePHPTags.
 *
 * Check for usage of alternative PHP tags - removed in PHP 7.0.
 *
 * PHP version 7.0
 *
 * @category PHP
 * @package  PHPCompatibility
 * @author   Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
 *
 * Based on `Generic_Sniffs_PHP_DisallowAlternativePHPTags` by Juliette Reinders Folmer
 * which was merged into PHPCS 2.7.0.
 */
class RemovedAlternativePHPTagsSniff extends Sniff
{

    /**
     * Whether ASP tags are enabled or not.
     *
     * @var bool
     */
    private $aspTags = false;

    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array
     */
    public function register()
    {
        if (version_compare(PHP_VERSION_ID, '70000', '<') === true) {
            // phpcs:ignore PHPCompatibility.PHP.DeprecatedIniDirectives.asp_tagsRemoved
            $this->aspTags = (boolean) ini_get('asp_tags');
        }

        return array(
            T_OPEN_TAG,
            T_OPEN_TAG_WITH_ECHO,
            T_INLINE_HTML,
        );

    }//end register()


    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer_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(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        if ($this->supportsAbove('7.0') === false) {
            return;
        }

        $tokens  = $phpcsFile->getTokens();
        $openTag = $tokens[$stackPtr];
        $content = trim($openTag['content']);

        if ($content === '' || $content === '<?php') {
            return;
        }

        if ($openTag['code'] === T_OPEN_TAG || $openTag['code'] === T_OPEN_TAG_WITH_ECHO) {

            if ($content === '<%' || $content === '<%=') {
                $data = array(
                    'ASP',
                    $content,
                );
                $errorCode = 'ASPOpenTagFound';

            } elseif (strpos($content, '<script ') !== false) {
                $data = array(
                    'Script',
                    $content,
                );
                $errorCode = 'ScriptOpenTagFound';
            } else {
                return;
            }
        }
        // Account for incorrect script open tags.
        // The "(?:<s)?" in the regex is to work-around a bug in the tokenizer in PHP 5.2.
        elseif ($openTag['code'] === T_INLINE_HTML
            && preg_match('`((?:<s)?cript (?:[^>]+)?language=[\'"]?php[\'"]?(?:[^>]+)?>)`i', $content, $match) === 1
        ) {
            $found = $match[1];
            $data  = array(
                'Script',
                $found,
            );
            $errorCode = 'ScriptOpenTagFound';
        }

        if (isset($errorCode, $data)) {
            $phpcsFile->addError(
                '%s style opening tags have been removed in PHP 7.0. Found "%s"',
                $stackPtr,
                $errorCode,
                $data
            );
            return;
        }

        // If we're still here, we can't be sure if what we find was really intended as ASP open tags.
        if ($openTag['code'] === T_INLINE_HTML && $this->aspTags === false) {
            if (strpos($content, '<%') !== false) {
                $error   = 'Possible use of ASP style opening tags detected. ASP style opening tags have been removed in PHP 7.0. Found: %s';
                $snippet = $this->getSnippet($content, '<%');
                $data    = array('<%'.$snippet);

                $phpcsFile->addWarning($error, $stackPtr, 'MaybeASPOpenTagFound', $data);
            }
        }

    }//end process()


    /**
     * Get a snippet from a HTML token.
     *
     * @param string $content The content of the HTML token.
     * @param string $startAt Partial string to use as a starting point for the snippet.
     * @param int    $length  The target length of the snippet to get. Defaults to 25.
     *
     * @return string
     */
    protected function getSnippet($content, $startAt = '', $length = 25)
    {
        $startPos = 0;

        if ($startAt !== '') {
            $startPos = strpos($content, $startAt);
            if ($startPos !== false) {
                $startPos += strlen($startAt);
            }
        }

        $snippet = substr($content, $startPos, $length);
        if ((strlen($content) - $startPos) > $length) {
            $snippet .= '...';
        }

        return $snippet;

    }//end getSnippet()

}//end class

1	<?php
2	/**
3	* \PHPCompatibility\Sniffs\PHP\RemovedAlternativePHPTags.
4	*
5	* PHP version 7.0
6	*
7	* @category PHP
8	* @package PHPCompatibility
9	* @author Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
10	*/
11
12	namespace PHPCompatibility\Sniffs\PHP;
13
14	use PHPCompatibility\Sniff;
15
16	/**
17	* \PHPCompatibility\Sniffs\PHP\RemovedAlternativePHPTags.
18	*
19	* Check for usage of alternative PHP tags - removed in PHP 7.0.
20	*
21	* PHP version 7.0
22	*
23	* @category PHP
24	* @package PHPCompatibility
25	* @author Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
26	*
27	* Based on `Generic_Sniffs_PHP_DisallowAlternativePHPTags` by Juliette Reinders Folmer
28	* which was merged into PHPCS 2.7.0.
29	*/
30	class RemovedAlternativePHPTagsSniff extends Sniff
31	{
32
33	/**
34	* Whether ASP tags are enabled or not.
35	*
36	* @var bool
37	*/
38	private $aspTags = false;
39
40	/**
41	* Returns an array of tokens this test wants to listen for.
42	*
43	* @return array
44	*/
45	public function register()
46	{
47	if (version_compare(PHP_VERSION_ID, '70000', '<') === true) {	44✔
48	// phpcs:ignore PHPCompatibility.PHP.DeprecatedIniDirectives.asp_tagsRemoved
49	$this->aspTags = (boolean) ini_get('asp_tags');	22 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
50	}	22 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
51
52	return array(
53	T_OPEN_TAG,	44✔
54	T_OPEN_TAG_WITH_ECHO,	44✔
55	T_INLINE_HTML,	44✔
56	);	22 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
57
58	}//end register()
59
60
61	/**
62	* Processes this test, when one of its tokens is encountered.
63	*
64	* @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
65	* @param int $stackPtr The position of the current token
66	* in the stack passed in $tokens.
67	*
68	* @return void
69	*/
70	public function process(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
71	{
72	if ($this->supportsAbove('7.0') === false) {	12✔
73	return;	6✔
74	}
75
76	$tokens = $phpcsFile->getTokens();	6✔
77	$openTag = $tokens[$stackPtr];	6✔
78	$content = trim($openTag['content']);	6✔
79
80	if ($content === '' \|\| $content === '<?php') {	6✔
81	return;	6✔
82	}
83
84	if ($openTag['code'] === T_OPEN_TAG \|\| $openTag['code'] === T_OPEN_TAG_WITH_ECHO) {	6✔
85
86	if ($content === '<%' \|\| $content === '<%=') {	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
87	$data = array(
88	'ASP',	×
89	$content,	×
90	);	×
91	$errorCode = 'ASPOpenTagFound';	×
92
93	} elseif (strpos($content, '<script ') !== false) {	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
94	$data = array(
95	'Script',	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
96	$content,	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
97	);	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
98	$errorCode = 'ScriptOpenTagFound';	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
99	} else {	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
100	return;	×
101	}
102	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
103	// Account for incorrect script open tags.
104	// The "(?:<s)?" in the regex is to work-around a bug in the tokenizer in PHP 5.2.
105	elseif ($openTag['code'] === T_INLINE_HTML	6✔
106	&& preg_match('`((?:<s)?cript (?:[^>]+)?language=[\'"]?php[\'"]?(?:[^>]+)?>)`i', $content, $match) === 1	6✔
107	) {	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
108	$found = $match[1];	6✔
109	$data = array(
110	'Script',	6✔
111	$found,	6✔
112	);	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
113	$errorCode = 'ScriptOpenTagFound';	6✔
114	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
115
116	if (isset($errorCode, $data)) {	6✔
117	$phpcsFile->addError(	6✔
118	'%s style opening tags have been removed in PHP 7.0. Found "%s"',	6✔
119	$stackPtr,	6✔
120	$errorCode,	6✔
121	$data	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^2.0", PHPCS_VERSION="2.3.*" COVERALLS_VERSION="^2.0", and PHPCS_VERSION="dev-master" LINT=1 SNIFF=1 COVERALLS_VERSION="^2.0" ✔
122	);	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
123	return;	6✔
124	}
125
126	// If we're still here, we can't be sure if what we find was really intended as ASP open tags.
127	if ($openTag['code'] === T_INLINE_HTML && $this->aspTags === false) {	6✔
128	if (strpos($content, '<%') !== false) {	6✔
129	$error = 'Possible use of ASP style opening tags detected. ASP style opening tags have been removed in PHP 7.0. Found: %s';	6✔
130	$snippet = $this->getSnippet($content, '<%');	6✔
131	$data = array('<%'.$snippet);	6✔
132
133	$phpcsFile->addWarning($error, $stackPtr, 'MaybeASPOpenTagFound', $data);	6✔
134	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
135	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
136
137	}//end process()	6✔
138
139
140	/**
141	* Get a snippet from a HTML token.
142	*
143	* @param string $content The content of the HTML token.
144	* @param string $startAt Partial string to use as a starting point for the snippet.
145	* @param int $length The target length of the snippet to get. Defaults to 25.
146	*
147	* @return string
148	*/
149	protected function getSnippet($content, $startAt = '', $length = 25)
150	{
151	$startPos = 0;	6✔
152
153	if ($startAt !== '') {	6✔
154	$startPos = strpos($content, $startAt);	6✔
155	if ($startPos !== false) {	6✔
156	$startPos += strlen($startAt);	6✔
157	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
158	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
159
160	$snippet = substr($content, $startPos, $length);	6✔
161	if ((strlen($content) - $startPos) > $length) {	6✔
162	$snippet .= '...';	6✔
163	}	3 only PHPCS_VERSION=">=1.5.1,<2.0" COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", PHPCS_VERSION=">=2.0,<3.0" LINT=1 COVERALLS_VERSION="^1.0" PHPUNIT_VERSION="~4.5", and PHPCS_VERSION="dev-master" LINT=1 COVERALLS_VERSION="^1.0" ✔
164
165	return $snippet;	6✔
166
167	}//end getSnippet()
168
169	}//end class

PHPCompatibility / PHPCompatibility / 1599

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