Skip to content

refactor(PropertyDeclaration): Use upstream PSR2 sniff to avoid maintaining the code #251

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

Merged
merged 1 commit into from
Jan 2, 2025
Merged

refactor(PropertyDeclaration): Use upstream PSR2 sniff to avoid maintaining the code #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
101 changes: 24 additions & 77 deletions coder_sniffer/Drupal/Sniffs/Classes/PropertyDeclarationSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Verifies that properties are declared correctly.
* Verifies that the "var" keyword is not used for class properties.
*
* @category PHP
* @package PHP_CodeSniffer
Expand All @@ -10,106 +10,53 @@
namespace Drupal\Sniffs\Classes;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
use PHP_CodeSniffer\Util\Tokens;
use PHP_CodeSniffer\Sniffs\Sniff;

/**
* Largely copied from
* \PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\PropertyDeclarationSniff to have a fixer
* for the var keyword.
* Originally this was a fork of the PSR2 PropertyDeclarationSniff to have a fixer
* for the var keyword. Since we don't want to maintain all the forked code, this
* class was changed to only target the var keyword and provide a fixer for it.
*
* As a replacement PSR2.Classes.PropertyDeclaration is now included in ruleset.xml.
*
* @category PHP
* @package PHP_CodeSniffer
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class PropertyDeclarationSniff extends AbstractVariableSniff
class PropertyDeclarationSniff implements Sniff
{


/**
* Processes the function tokens within the class.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr The position where the token was found.
* Returns an array of tokens this test wants to listen for.
*
* @return void
* @return array<int|string>
*/
protected function processMemberVar(File $phpcsFile, $stackPtr)
public function register()
{
$tokens = $phpcsFile->getTokens();

if ($tokens[$stackPtr]['content'][1] === '_') {
$error = 'Property name "%s" should not be prefixed with an underscore to indicate visibility';
$data = [$tokens[$stackPtr]['content']];
$phpcsFile->addWarning($error, $stackPtr, 'Underscore', $data);
}

// Detect multiple properties defined at the same time. Throw an error
// for this, but also only process the first property in the list so we don't
// repeat errors.
$find = Tokens::$scopeModifiers;
$find = array_merge($find, [T_VARIABLE, T_VAR, T_SEMICOLON]);
$prev = $phpcsFile->findPrevious($find, ($stackPtr - 1));
if ($tokens[$prev]['code'] === T_VARIABLE) {
return;
}

if ($tokens[$prev]['code'] === T_VAR) {
$error = 'The var keyword must not be used to declare a property';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'VarUsed');
if ($fix === true) {
$phpcsFile->fixer->replaceToken($prev, 'public');
}
}
return [T_VAR];

$next = $phpcsFile->findNext([T_VARIABLE, T_SEMICOLON], ($stackPtr + 1));
if ($tokens[$next]['code'] === T_VARIABLE) {
$error = 'There must not be more than one property declared per statement';
$phpcsFile->addError($error, $stackPtr, 'Multiple');
}

$modifier = $phpcsFile->findPrevious(Tokens::$scopeModifiers, $stackPtr);
if (($modifier === false) || ($tokens[$modifier]['line'] !== $tokens[$stackPtr]['line'])) {
$error = 'Visibility must be declared on property "%s"';
$data = [$tokens[$stackPtr]['content']];
$phpcsFile->addError($error, $stackPtr, 'ScopeMissing', $data);
}

}//end processMemberVar()
}//end register()


/**
* Processes normal variables.
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr The position where the token was found.
* @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
*/
protected function processVariable(File $phpcsFile, $stackPtr)
public function process(File $phpcsFile, $stackPtr)
{
/*
We don't care about normal variables.
*/

}//end processVariable()


/**
* Processes variables in double quoted strings.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
* @param int $stackPtr The position where the token was found.
*
* @return void
*/
protected function processVariableInString(File $phpcsFile, $stackPtr)
{
/*
We don't care about normal variables.
*/
$error = 'The var keyword must not be used to declare a property';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'VarUsed');
if ($fix === true) {
$phpcsFile->fixer->replaceToken($stackPtr, 'public');
}

}//end processVariableInString()
}//end process()


}//end class
34 changes: 19 additions & 15 deletions coder_sniffer/Drupal/ruleset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,48 +68,52 @@
<rule ref="Generic.WhiteSpace.DisallowTabIndent"/>

<rule ref="MySource.Debug.DebugCode"/>

<!-- PEAR sniffs -->
<rule ref="PEAR.Files.IncludingFile"/>
<!-- Disable some error messages that we do not want. -->
<rule ref="PEAR.Files.IncludingFile.UseIncludeOnce">
<severity>0</severity>
</rule>
<rule ref="PEAR.Files.IncludingFile.UseInclude">
<severity>0</severity>
</rule>
<rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
<rule ref="PEAR.Files.IncludingFile.UseIncludeOnce">
<severity>0</severity>
</rule>
<rule ref="PEAR.Files.IncludingFile.UseRequire">
<severity>0</severity>
</rule>

<rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
<severity>0</severity>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature"/>
<!-- Disable some error messages that we already cover. -->
<rule ref="PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket">
<rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
<severity>0</severity>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket">
<rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
<severity>0</severity>
</rule>
<!-- Disable some error messages that we do not want. -->
<rule ref="PEAR.Functions.FunctionCallSignature.Indent">
<rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
<severity>0</severity>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
<rule ref="PEAR.Functions.FunctionCallSignature.Indent">
<severity>0</severity>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
<rule ref="PEAR.Functions.FunctionCallSignature.OpeningIndent">
<severity>0</severity>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
<!-- Disable some error messages that we already cover. -->
<rule ref="PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket">
<severity>0</severity>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.OpeningIndent">
<rule ref="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket">
<severity>0</severity>
</rule>

<rule ref="PEAR.Functions.ValidDefaultValue"/>

<!-- PSR-2 sniffs -->
<rule ref="PSR2.Classes.PropertyDeclaration">
<!-- Already covered by Drupal.Classes.PropertyDeclaration.VarUsed. -->
<exclude name="PSR2.Classes.PropertyDeclaration.VarUsed"/>
</rule>
<rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
<rule ref="PSR2.Namespaces.UseDeclaration"/>

Expand Down
2 changes: 1 addition & 1 deletion tests/Drupal/Classes/PropertyDeclarationUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class PropertyDeclarationUnitTest extends CoderSniffUnitTest
*/
protected function getErrorList(string $testFile): array
{
return [16 => 2];
return [16 => 1];

}//end getErrorList()

Expand Down
Loading