💄 Minor improvements

Vincent Langlet · Vincent Langlet · commit 05e0dc46293b · 2017-05-01T01:03:53.000+02:00
diff --git a/Symfony3Custom/Sniffs/Classes/PropertyDeclarationSniff.php b/Symfony3Custom/Sniffs/Classes/PropertyDeclarationSniff.php
@@ -5,15 +5,6 @@
  */
 class Symfony3Custom_Sniffs_Classes_PropertyDeclarationSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
diff --git a/Symfony3Custom/Sniffs/Commenting/DocCommentForbiddenTagsSniff.php b/Symfony3Custom/Sniffs/Commenting/DocCommentForbiddenTagsSniff.php
@@ -22,7 +22,9 @@ class Symfony3Custom_Sniffs_Commenting_DocCommentForbiddenTagsSniff implements P
      */
     public function register()
     {
-        return array(T_DOC_COMMENT_TAG);
+        return array(
+            T_DOC_COMMENT_TAG
+        );
     }
 
     /**
diff --git a/Symfony3Custom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php b/Symfony3Custom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php
@@ -48,7 +48,9 @@ class Symfony3Custom_Sniffs_Commenting_DocCommentGroupSameTypeSniff implements P
      */
     public function register()
     {
-        return array(T_DOC_COMMENT_OPEN_TAG);
+        return array(
+            T_DOC_COMMENT_OPEN_TAG
+        );
     }
 
     /**
diff --git a/Symfony3Custom/Sniffs/Commenting/FunctionCommentSniff.php b/Symfony3Custom/Sniffs/Commenting/FunctionCommentSniff.php
@@ -117,8 +117,6 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             $this->processParams($phpcsFile, $stackPtr, $commentStart);
             $this->processThrows($phpcsFile, $stackPtr, $commentStart);
         } else {
-            $this->processWhitespace($phpcsFile, $commentStart, $hasComment);
-
             if (count($realParams) > 0) {
                 foreach ($realParams as $neededParam) {
                     $error = 'Doc comment for parameter "%s" missing';
@@ -127,6 +125,8 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                 }
             }
         }
+
+        $this->processWhitespace($phpcsFile, $commentStart);
     }
 
     /**
@@ -284,8 +284,6 @@ protected function processParams(
             return;
         }
 
-        $this->processWhitespace($phpcsFile, $commentStart);
-
         parent::processParams($phpcsFile, $stackPtr, $commentStart);
     }
 
diff --git a/Symfony3Custom/Sniffs/Commenting/VariableCommentSniff.php b/Symfony3Custom/Sniffs/Commenting/VariableCommentSniff.php
@@ -114,7 +114,10 @@ protected function processWhitespace(
         $found = $startLine - $prevLine - 1;
 
         // Skip for class opening
-        if ($found < 1 && !(0 === $found && 'T_OPEN_CURLY_BRACKET' === $tokens[$before]['type'])) {
+        if ($found < 1
+            && !(0 === $found
+            && 'T_OPEN_CURLY_BRACKET' === $tokens[$before]['type'])
+        ) {
             if ($found < 0) {
                 $found = 0;
             }
diff --git a/Symfony3Custom/Sniffs/Formatting/BlankLineBeforeReturnSniff.php b/Symfony3Custom/Sniffs/Formatting/BlankLineBeforeReturnSniff.php
@@ -7,24 +7,16 @@
  */
 class Symfony3Custom_Sniffs_Formatting_BlankLineBeforeReturnSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-        'JS',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
      * @return array
      */
     public function register()
     {
-        return array(T_RETURN);
+        return array(
+            T_RETURN
+        );
     }
 
     /**
diff --git a/Symfony3Custom/Sniffs/Functions/ScopeOrderSniff.php b/Symfony3Custom/Sniffs/Functions/ScopeOrderSniff.php
@@ -5,15 +5,6 @@
  */
 class Symfony3Custom_Sniffs_Functions_ScopeOrderSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
diff --git a/Symfony3Custom/Sniffs/NamingConventions/ValidClassNameSniff.php b/Symfony3Custom/Sniffs/NamingConventions/ValidClassNameSniff.php
@@ -5,15 +5,6 @@
  */
 class Symfony3Custom_Sniffs_NamingConventions_ValidClassNameSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
diff --git a/Symfony3Custom/Sniffs/Objects/ObjectInstantiationSniff.php b/Symfony3Custom/Sniffs/Objects/ObjectInstantiationSniff.php
@@ -5,15 +5,6 @@
  */
 class Symfony3Custom_Sniffs_Objects_ObjectInstantiationSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
diff --git a/Symfony3Custom/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php b/Symfony3Custom/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php
@@ -6,16 +6,6 @@
  */
 class Symfony3Custom_Sniffs_WhiteSpace_CloseBracketSpacingSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-        'JS',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
@@ -42,13 +32,6 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
-        // Ignore curly brackets in javascript files.
-        if (T_CLOSE_CURLY_BRACKET === $tokens[$stackPtr]['code']
-            && 'JS' === $phpcsFile->tokenizerType
-        ) {
-            return;
-        }
-
         if (isset($tokens[($stackPtr - 1)]) === true
             && T_WHITESPACE === $tokens[($stackPtr - 1)]['code']
         ) {
diff --git a/Symfony3Custom/Sniffs/WhiteSpace/EmptyLinesSniff.php b/Symfony3Custom/Sniffs/WhiteSpace/EmptyLinesSniff.php
@@ -5,25 +5,16 @@
  */
 class Symfony3Custom_Sniffs_WhiteSpace_EmptyLinesSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-        'JS',
-        'CSS',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
      * @return array
      */
     public function register()
     {
-        return array(T_WHITESPACE);
+        return array(
+            T_WHITESPACE
+        );
     }
 
     /**
diff --git a/Symfony3Custom/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php b/Symfony3Custom/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php
@@ -6,16 +6,6 @@
  */
 class Symfony3Custom_Sniffs_WhiteSpace_OpenBracketSpacingSniff implements PHP_CodeSniffer_Sniff
 {
-    /**
-     * A list of tokenizers this sniff supports.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = array(
-        'PHP',
-        'JS',
-    );
-
     /**
      * Returns an array of tokens this test wants to listen for.
      *
@@ -42,24 +32,21 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
-        // Ignore curly brackets in javascript files.
-        if (T_OPEN_CURLY_BRACKET === $tokens[$stackPtr]['code']
-            && 'JS' === $phpcsFile->tokenizerType
-        ) {
-            return;
-        }
-
         if (isset($tokens[($stackPtr + 1)]) === true
             && T_WHITESPACE === $tokens[($stackPtr + 1)]['code']
             && strpos($tokens[($stackPtr + 1)]['content'], $phpcsFile->eolChar) === false
         ) {
             $error = 'There should be no space after an opening "%s"';
-            $phpcsFile->addError(
+            $fix = $phpcsFile->addFixableError(
                 $error,
                 ($stackPtr + 1),
                 'OpeningWhitespace',
                 array($tokens[$stackPtr]['content'])
             );
+
+            if (true === $fix) {
+                $phpcsFile->fixer->replaceToken($stackPtr + 1, '');
+            }
         }
     }
 }
diff --git a/Symfony3Custom/Sniffs/WhiteSpace/UnaryOperatorSpacingSniff.php b/Symfony3Custom/Sniffs/WhiteSpace/UnaryOperatorSpacingSniff.php
@@ -37,8 +37,8 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
         // Check decrement / increment.
         if (T_DEC === $tokens[$stackPtr]['code'] || T_INC === $tokens[$stackPtr]['code']) {
-            $modifyLeft = substr($tokens[($stackPtr - 1)]['content'], 0, 1) === '$' ||
-                ';' === $tokens[($stackPtr + 1)]['content'];
+            $modifyLeft = substr($tokens[($stackPtr - 1)]['content'], 0, 1) === '$'
+                || ';' === $tokens[($stackPtr + 1)]['content'];
 
             if (true === $modifyLeft && T_WHITESPACE === $tokens[($stackPtr - 1)]['code']) {
                 $error = 'There must not be a single space before a unary operator statement';
diff --git a/Symfony3Custom/Tests/Formatting/YodaConditionUnitTest.inc b/Symfony3Custom/Tests/Formatting/YodaConditionUnitTest.inc
@@ -1,92 +1,98 @@
 <?php
-if ( $true == true || $false == false ) {  // Bad x 2 (in an 'if').
+if ($true == true || $false == false) {// Bad x 2 (in an 'if').
     echo 'True';
-} elseif ( $true == true && $false == true ) { // Bad x 2 (in an 'elseif').
+} elseif ($true == true && $false == true) {// Bad x 2 (in an 'elseif').
     echo 'False';
-} elseif ( false == $true && true == $false ) { // Good - this is the correct way to do conditional checks.
+} elseif (false == $true && true == $false) {// Good - this is the correct way to do conditional checks.
     echo 'False';
 }
 
 // Test for 'equals' conditional.
-if ( $true == true ) { // Bad x 1.
+if ($true == true) {// Bad x 1.
     echo 'True';
-} elseif ( false == $true ) { // Good.
+} elseif (false == $true) {// Good.
     echo 'False';
 }
 
 // Test for 'not equals' conditional.
-if ( $true != true ) { // Bad x 1.
+if ($true != true) {// Bad x 1.
     echo 'True';
-} elseif ( false != $true ) { // Good.
+} elseif (false != $true) {// Good.
     echo 'False';
 }
 
 // Test for 'exactly equals' conditional.
-if ( $true === true ) { // Bad x 1.
+if ($true === true) {// Bad x 1.
     echo 'True';
-} elseif ( false === $true ) { // Good.
+} elseif (false === $true) {// Good.
     echo 'False';
 }
 
 // Test for 'not exactly equals' conditional.
-if ( $true !== true ) { // Bad x 1.
+if ($true !== true) {// Bad x 1.
     echo 'True';
-} elseif ( false !== $true ) { // Good.
+} elseif (false !== $true) {// Good.
     echo 'False';
 }
 
 // Make sure the test excludes functions on the conditional check.
-if ( strtolower( $check ) == $true  ) { // Good.
+if (strtolower($check) == $true) {// Good.
     echo 'True';
 }
 // Makes sure the test excludes variable casting in the conditional check.
-if ( true == (bool) $true ) { // Good.
+if (true == (bool) $true) {// Good.
     echo 'True';
-} elseif ( false == $true ) { // Good.
+} elseif (false == $true) {// Good.
     echo 'False';
 }
 // Testing for string comparison.
-if ( $true == 'true' ) { // Bad x 1.
+if ($true == 'true') {// Bad x 1.
     echo 'True';
-} elseif ( 'false' == $true ) { // Good x 1.
+} elseif ('false' == $true) {// Good x 1.
     echo 'False';
 }
 // Testing for integer comparison.
-if ( $true == 0 ) { // Bad x 1.
+if ($true == 0) {// Bad x 1.
     echo 'True';
-} elseif ( 1 == $false ) { // Good x 1.
+} elseif (1 == $false) {// Good x 1.
     echo 'False';
 }
 
 // Testing constant comparison.
-if ( $taxonomy === MyClass::TAXONOMY_SLUG ) { // Bad.
+if ($taxonomy === MyClass::TAXONOMY_SLUG) {// Bad.
     $link = true;
-} elseif ( MyClass::TAXONOMY_SLUG === $taxonomy ) { // Ok.
+} elseif (MyClass::TAXONOMY_SLUG === $taxonomy) {// Ok.
     $link = false;
 }
 
-if ( $foo === FOO_CONSTANT ) { // Bad.
+if ($foo === FOO_CONSTANT) {// Bad.
     $link = true;
-} elseif ( FOO_CONSTANT === $foo ) { // Ok.
+} elseif (FOO_CONSTANT === $foo) {// Ok.
     $link = false;
 }
 
-if ( $foo == $bar ) {} // Ok.
+if ($foo == $bar) {
+} // Ok.
 
-$accessibility_mode = ( 'on' === sanitize_key( $_GET['accessibility-mode'] ) ) ? 'on' : 'off'; // Ok.
+$accessibility_mode = ('on' === sanitize_key($_GET['accessibility-mode'])) ? 'on' : 'off'; // Ok.
 
-if ( $on !== self::$network_mode ) { // Ok.
+if ($on !== self::$network_mode) {// Ok.
     self::$network_mode = (bool) $on;
 }
 
-return 0 === strpos( $foo, 'a' ); // Ok.
+return 0 === strpos($foo, 'a'); // Ok.
+
 return 0 == $foo; // Ok.
+
 return $foo == 0; // Bad.
 
-if ( (int) $a['interval'] === (int) $b['interval'] ) {} // Ok.
+if ((int) $a['interval'] === (int) $b['interval']) {
+} // Ok.
 
-if ( $GLOBALS['wpdb']->num_rows === 0 ) {} // Bad.
+if ($GLOBALS['wpdb']->num_rows === 0) {
+} // Bad.
 
-if ( $true == strtolower( $check ) ) {} // Bad.
+if ($true == strtolower($check)) {
+} // Bad.
 
-$update = 'yes' === strtolower( $this->from_post( 'update' ) ); // Ok.
+$update = 'yes' === strtolower($this->from_post('update')); // Ok.
diff --git a/Symfony3Custom/Tests/Formatting/YodaConditionUnitTest.php b/Symfony3Custom/Tests/Formatting/YodaConditionUnitTest.php

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,9 @@ class Symfony3Custom_Sniffs_Commenting_DocCommentForbiddenTagsSniff implements P`
`22`	`22`	`*/`
`23`	`23`	`public function register()`
`24`	`24`	`{`
`25`		`- return array(T_DOC_COMMENT_TAG);`
	`25`	`+ return array(`
	`26`	`+ T_DOC_COMMENT_TAG`
	`27`	`+ );`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ class Symfony3Custom_Sniffs_Commenting_DocCommentGroupSameTypeSniff implements P`
`48`	`48`	`*/`
`49`	`49`	`public function register()`
`50`	`50`	`{`
`51`		`- return array(T_DOC_COMMENT_OPEN_TAG);`
	`51`	`+ return array(`
	`52`	`+ T_DOC_COMMENT_OPEN_TAG`
	`53`	`+ );`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -117,8 +117,6 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)`
`117`	`117`	`$this->processParams($phpcsFile, $stackPtr, $commentStart);`
`118`	`118`	`$this->processThrows($phpcsFile, $stackPtr, $commentStart);`
`119`	`119`	`} else {`
`120`		`- $this->processWhitespace($phpcsFile, $commentStart, $hasComment);`
`121`		`-`
`122`	`120`	`if (count($realParams) > 0) {`
`123`	`121`	`foreach ($realParams as $neededParam) {`
`124`	`122`	`$error = 'Doc comment for parameter "%s" missing';`
`@@ -127,6 +125,8 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)`
`127`	`125`	`}`
`128`	`126`	`}`
`129`	`127`	`}`
	`128`	`+`
	`129`	`+ $this->processWhitespace($phpcsFile, $commentStart);`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`/**`
`@@ -284,8 +284,6 @@ protected function processParams(`
`284`	`284`	`return;`
`285`	`285`	`}`
`286`	`286`
`287`		`- $this->processWhitespace($phpcsFile, $commentStart);`
`288`		`-`
`289`	`287`	`parent::processParams($phpcsFile, $stackPtr, $commentStart);`
`290`	`288`	`}`
`291`	`289`