Merge pull request #29 from flyeralarm/IN-1729-sniff

IN-1729 - Add sniff to make and CI to apply code style check on self

Author: vukanac

.github/workflows/php.yml

@@ -38,5 +38,8 @@ jobs:
     - name: phpcs version
       run: vendor/bin/phpcs --version
 
+    - name: Validate code style
+      run: vendor/bin/phpcs -w -p -s --standard=ruleset.xml --ignore="tests/*not-allowed*" custom-standards/ tests/
+
     - name: Run test suite
       run: php tests/runner.php

Makefile

@@ -4,17 +4,16 @@ COMPOSER_BIN=$(PHP_BIN) composer.phar
 # ---------------------------------------------
 
 # make
-.DEFAULT_GOAL := install-dev
+.DEFAULT_GOAL := install
 
-# make test
-test:
-	$(PHP_BIN) tests/runner.php
-
-# make install
 install:
+	$(COMPOSER_BIN) install
 
-# ---------------------------------------------
-# functions
+sniff:
+	$(PHP_BIN) vendor/bin/phpcs -w -p -s --standard=ruleset.xml --ignore="tests/*not-allowed*" custom-standards/ tests/
 
-install-dev:
-	$(COMPOSER_BIN) install
+sniff-fix:
+	$(PHP_BIN) vendor/bin/phpcbf -w -p -s --standard=ruleset.xml --ignore="tests/*not-allowed*" custom-standards/ tests/
+
+test:
+	$(PHP_BIN) tests/runner.php

README.md

@@ -23,7 +23,13 @@ interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt).
 
 To prepare run command:
 ```bash
-make
+make install
+```
+
+To check code style compliance or to fix what can be autofixed run commands:
+```bash
+make sniff
+make sniff-fix
 ```
 
 To test ruleset run command:

custom-standards/Flyeralarm/Sniffs/Classes/FullyQualifiedSniff.php

@@ -13,7 +13,7 @@ class FullyQualifiedSniff implements Sniff
      */
     public function register()
     {
-        return array(T_DOUBLE_COLON, T_NEW, T_EXTENDS, T_IMPLEMENTS);
+        return [T_DOUBLE_COLON, T_NEW, T_EXTENDS, T_IMPLEMENTS];
     }
 
     /**

custom-standards/Flyeralarm/Sniffs/ControlStructures/YodaSniff.php

@@ -12,7 +12,7 @@ class YodaSniff implements Sniff
      */
     public function register()
     {
-        return array(T_IF, T_ELSEIF, T_WHILE);
+        return [T_IF, T_ELSEIF, T_WHILE];
     }
 
     /**
@@ -87,21 +87,25 @@ private function checkConditionalOrderForArithmeticExpression(
 
         // e.g. if ($foo = true)
         // e.g. if ($foo = 'bar')
-        if (in_array($leftOperandTokenId, $functionAndVariableTokenIds)
+        if (
+            in_array($leftOperandTokenId, $functionAndVariableTokenIds)
             && in_array($rightOperandTokenId, $languageTypeTokenIds)
         ) {
             return;
         }
         // e.g. if (count(..) > $test)
         // e.g. if ($foo == $bar)
-        if (in_array($leftOperandTokenId, $functionAndVariableTokenIds)
+        if (
+            in_array($leftOperandTokenId, $functionAndVariableTokenIds)
             && in_array($rightOperandTokenId, $functionAndVariableTokenIds)
         ) {
             return;
         }
         // e.g. if ('foo' == 'bar')
-        if (in_array($leftOperandTokenId, $languageTypeTokenIds)
-            && in_array($rightOperandTokenId, $languageTypeTokenIds)) {
+        if (
+            in_array($leftOperandTokenId, $languageTypeTokenIds)
+            && in_array($rightOperandTokenId, $languageTypeTokenIds)
+        ) {
             return;
         }
 

custom-standards/Flyeralarm/Sniffs/Docblock/ExpectedExceptionMessageSniff.php

@@ -12,7 +12,7 @@ class ExpectedExceptionMessageSniff implements Sniff
      */
     public function register()
     {
-        return array(T_DOC_COMMENT_OPEN_TAG);
+        return [T_DOC_COMMENT_OPEN_TAG];
     }
 
     /**
@@ -25,8 +25,10 @@ public function process(File $phpcsFile, $stackPtr)
         if (!$this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedException')) {
             return;
         }
-        if ($this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedExceptionMessage')
-            || $this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedExceptionMessageRegExp')) {
+        if (
+            $this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedExceptionMessage')
+            || $this->hasAnnotationInDoc($phpcsFile, $stackPtr, '@expectedExceptionMessageRegExp')
+        ) {
             return;
         }
 

custom-standards/Flyeralarm/Sniffs/File/ExceptionMessageSniff.php

@@ -2,6 +2,7 @@
 
 namespace Flyeralarm\CodingGuidelines\Flyeralarm\Sniffs\File;
 
+use PHP_CodeSniffer\Exceptions\RuntimeException;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
 
@@ -12,26 +13,26 @@ class ExceptionMessageSniff implements Sniff
      */
     public function register()
     {
-        return array(T_CLASS);
+        return [T_CLASS];
     }
 
     /**
      * @param File $phpcsFile
      * @param int $stackPtr
-     * @return int|void
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException
+     * @return void
+     * @throws RuntimeException
      */
     public function process(File $phpcsFile, $stackPtr)
     {
         $className = $phpcsFile->getDeclarationName($stackPtr);
 
-        if (strpos($className, 'Exception') === false) {
+        if (! $this->doesStringEndsWith($className, 'Exception')) {
             return;
         }
 
         $tokens = $phpcsFile->getTokens();
         $ptr = -1;
-        while($ptr = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $ptr + 1)) {
+        while ($ptr = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, $ptr + 1)) {
             if (strpos($tokens[$ptr]['content'], '!') !== false) {
                 $phpcsFile->addError(
                     'Exclamationmarks are not allowed in Exceptionmessages',
@@ -49,4 +50,13 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
     }
+
+    /**
+     * @alias str_ends_with in PHP8+
+     */
+    public function doesStringEndsWith(string $className, string $suffix): bool
+    {
+        $suffixLength = strlen($suffix);
+        return ($suffixLength === 0 || 0 === substr_compare($className, $suffix, - $suffixLength));
+    }
 }

custom-standards/Flyeralarm/Sniffs/File/ForbiddenKeywordsSniff.php

@@ -12,7 +12,7 @@ class ForbiddenKeywordsSniff implements Sniff
      */
     public function register()
     {
-        return array(T_CLASS, T_ABSTRACT, T_TRAIT);
+        return [T_CLASS, T_ABSTRACT, T_TRAIT];
     }
 
     /**

custom-standards/Flyeralarm/Sniffs/File/NamespacesSniff.php

@@ -12,7 +12,7 @@ class NamespacesSniff implements Sniff
      */
     public function register()
     {
-        return array(T_CLASS, T_ABSTRACT, T_TRAIT, T_INTERFACE);
+        return [T_CLASS, T_ABSTRACT, T_TRAIT, T_INTERFACE];
     }
 
     /**
@@ -24,7 +24,7 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
         $ptr = -1;
-        while($ptr = $phpcsFile->findNext(T_NS_SEPARATOR, $ptr + 1)) {
+        while ($ptr = $phpcsFile->findNext(T_NS_SEPARATOR, $ptr + 1)) {
             if (strpos($tokens[$ptr + 1]['content'], '_') !== false) {
                 $phpcsFile->addError(
                     'Using underscore within namespaces is discouraged',

custom-standards/Flyeralarm/Sniffs/File/NoClassKindSuffixSniff.php

@@ -12,7 +12,7 @@ class NoClassKindSuffixSniff implements Sniff
      */
     public function register()
     {
-        return array(T_INTERFACE, T_CLASS, T_TRAIT);
+        return [T_INTERFACE, T_CLASS, T_TRAIT];
     }
 
     /**