Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ReturnType Sniff #1084

Closed
wants to merge 5 commits into from
Closed

Add ReturnType Sniff #1084

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
09100f7
Add ReturnType Sniff
GaryJones Aug 4, 2017
7bcea29
ReturnType: Flip array and use isset()
GaryJones Aug 4, 2017
177fd7c
ReturnType: Apply first round of feedback
GaryJones Aug 6, 2017
333c97f
ReturnType: Apply more of first round of feedback
GaryJones Aug 6, 2017
007e2d2
ReportType: Handle unusually placed comments
GaryJones Aug 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 27 additions & 41 deletions WordPress/Sniffs/Functions/ReturnTypeSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,19 @@ public function register() {
* Processes this test, when one of its tokens is encountered.
*
* @param int $stackPtr The position of the current token in the stack.
* @return null Return before end if Return type declaration contains an invalid token.
* @return void Return before end if return type declaration contains an invalid token.
*/
public function process_token( $stackPtr ) {
$colon = (int) $this->phpcsFile->findPrevious( T_COLON, $stackPtr - 1 );
$colon = $this->phpcsFile->findPrevious( T_COLON, $stackPtr - 1, null, false, null, true );

if ( false === $colon ) {
// Shouldn't happen, but just in case.
return;
}

// Space before colon disallowed.
if ( T_CLOSE_PARENTHESIS !== $this->tokens[ $colon - 1 ]['code'] ) {
$error = 'There must be no space before colon before a return type.';
if ( isset( $this->tokens[ $colon - 1 ] ) && T_CLOSE_PARENTHESIS !== $this->tokens[ $colon - 1 ]['code'] ) {
$error = 'There must be no space between the closing parenthesis and the colon when declaring a return type for a function.';
$fix = $this->phpcsFile->addFixableError( $error, $colon - 1, 'SpaceBeforeColon' );

if ( true === $fix ) {
Expand All @@ -74,67 +79,48 @@ public function process_token( $stackPtr ) {
do {
$this->phpcsFile->fixer->replaceToken( $token, '' );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The token type for tokens to be removed should be checked here to be T_WHITESPACE, otherwise comments could be accidentally removed.

This check should be done before the error is thrown so as not to throw an unfixable fixableError. See: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/blob/master/WordPress/Sniffs/Arrays/ArrayDeclarationSpacingSniff.php#L101-L105 for some example code dealing with a similar situation.

Unit test:

function abc() /* Return declaration. */ : array {
	return array();
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd come across the disappearing comments but removed them from the tests until I'd come up with a solution.

-- $token;
} while ( T_CLOSE_PARENTHESIS !== $this->tokens[ $token ]['code'] );
} while ( isset( $this->tokens[ $token ] ) && T_CLOSE_PARENTHESIS !== $this->tokens[ $token ]['code'] );
$this->phpcsFile->fixer->endChangeset();
}
}

// Only one space after colon.
if ( T_WHITESPACE !== $this->tokens[ $colon + 1 ]['code'] ) {
$error = 'There must be a space after colon and before return type declaration.';
$error = 'There must be one space between the colon and the return type. None found.';
$fix = $this->phpcsFile->addFixableError( $error, $colon, 'NoSpaceAfterColon' );
if ( true === $fix ) {
$this->phpcsFile->fixer->addContent( $colon, ' ' );
}
} elseif ( ' ' !== $this->tokens[ $colon + 1 ]['content'] ) {
$error = 'There must be exactly one space after colon and before return type declaration.';
$fix = $this->phpcsFile->addFixableError( $error, $colon + 1, 'TooManySpacesAfterColon' );
$error = 'There must be exactly one space between the colon and the return type. Found: %s';
$data = array( 'more than one' ); /* @var @todo Count actual whitespaces */
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WIP :-)

$fix = $this->phpcsFile->addFixableError( $error, $colon + 1, 'TooManySpacesAfterColon', $data );
if ( true === $fix ) {
$this->phpcsFile->fixer->replaceToken( $colon + 1, ' ' );
}
}

$nullable = (int) $this->phpcsFile->findNext( T_NULLABLE, $colon + 1, $stackPtr );
if ( $nullable ) {
// Check if there is space after nullable operator.
if ( T_WHITESPACE === $this->tokens[ $nullable + 1 ]['code'] ) {
$error = 'Space is not not allowed after nullable operator.';
$fix = $this->phpcsFile->addFixableError( $error, $nullable + 1, 'SpaceAfterNullable' );
if ( $fix ) {
$this->phpcsFile->fixer->replaceToken( $nullable + 1, '' );
}
}
}

$first = $this->phpcsFile->findNext( Tokens::$emptyTokens, ( $nullable ?: $colon ) + 1, null, true );
$end = $this->phpcsFile->findNext( array( T_SEMICOLON, T_OPEN_CURLY_BRACKET ), $stackPtr + 1 );
$last = $this->phpcsFile->findPrevious( Tokens::$emptyTokens, $end - 1, null, true );
$invalid = (int) $this->phpcsFile->findNext( array( T_STRING, T_NS_SEPARATOR, T_RETURN_TYPE ), $first, $last + 1, true );
if ( $invalid ) {
$error = 'Return type declaration contains invalid token %s';
$data = array( $this->tokens[ $invalid ]['type'] );
$fix = $this->phpcsFile->addFixableError( $error, $invalid, 'InvalidToken', $data );
$nullable = $this->phpcsFile->findNext( T_NULLABLE, $colon + 1, $stackPtr );
// Check if there is space after nullable operator.
if ( false !== $nullable && T_WHITESPACE === $this->tokens[ $nullable + 1 ]['code'] ) {
$error = 'Space is not allowed after nullable operator.';
$fix = $this->phpcsFile->addFixableError( $error, $nullable + 1, 'SpaceAfterNullable' );
if ( true === $fix ) {
$this->phpcsFile->fixer->replaceToken( $invalid, '' );
$this->phpcsFile->fixer->replaceToken( $nullable + 1, '' );
}

return;
}

$return_type = trim( $this->phpcsFile->getTokensAsString( $first, $last - $first + 1 ) );

if ( $first === $last
&& ! in_array( $return_type, $this->simple_return_types, true )
&& ! isset( $this->simple_return_types[ $return_type ] )
) {
$contentLC = strtolower( $this->tokens[ $stackPtr ]['content'] );
// Check if simple return type is in lowercase.
if ( isset( $this->simple_return_types[ $contentLC ] ) && $contentLC !== $this->tokens[ $stackPtr ]['content'] ) {
$error = 'Simple return type must be lowercase. Found "%s", expected "%s"';
$data = array(
$return_type,
strtolower( $return_type ),
$this->tokens[ $stackPtr ]['content'],
$contentLC,
);
$fix = $this->phpcsFile->addFixableError( $error, $first, 'LowerCaseSimpleType', $data );
$fix = $this->phpcsFile->addFixableError( $error, $stackPtr, 'LowerCaseSimpleType', $data );
if ( true === $fix ) {
$this->phpcsFile->fixer->replaceToken( $stackPtr, strtolower( $return_type ) );
$this->phpcsFile->fixer->replaceToken( $stackPtr, $contentLC );
}
}
}
Expand Down
1 change: 0 additions & 1 deletion WordPress/Tests/Functions/ReturnTypeUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,4 @@ interface MyInterface
public function w():?\DateTime;

public function y($a, $b, $c) : \My\TestClass;
public function z():? \ReturnType \MyType;
}
1 change: 0 additions & 1 deletion WordPress/Tests/Functions/ReturnTypeUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,4 @@ interface MyInterface
public function w(): ?\DateTime;

public function y($a, $b, $c): \My\TestClass;
public function z(): ?\ReturnType\MyType;
}
1 change: 0 additions & 1 deletion WordPress/Tests/Functions/ReturnTypeUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ public function getErrorList() {
79 => 2,
80 => 1,
82 => 1,
83 => 3,
);
}

Expand Down