Refactored custom CodeSniffer rules

Author: shudd3r

src/Sniffer/Sniffs/Arrays/AmbiguousAssociativitySniff.php

@@ -17,6 +17,8 @@
 
 class AmbiguousAssociativitySniff implements Sniff
 {
+    private const WARNING = 'Array should be either associative or list of values';
+
     private array $tokens;
 
     public function register(): array
@@ -28,7 +30,7 @@ public function process(File $phpcsFile, $stackPtr): void
     {
         $this->tokens = $phpcsFile->getTokens();
         if ($this->isValidArray($phpcsFile, $stackPtr)) { return; }
-        $phpcsFile->addWarning('Array should be either associative or list of values', $stackPtr, 'Found');
+        $phpcsFile->addWarning(self::WARNING, $stackPtr, 'Found');
     }
 
     private function isValidArray(File $file, int $idx): bool
@@ -58,7 +60,7 @@ private function isValidArray(File $file, int $idx): bool
                     break 2;
             }
         }
-        return $expected === T_DOUBLE_ARROW ? $this->isTrailingComma($idx) : true;
+        return $expected !== T_DOUBLE_ARROW || $this->isTrailingComma($idx);
     }
 
     private function isTrailingComma(int $idx): bool

src/Sniffer/Sniffs/PhpDoc/CallableDefinitionSniff.php

@@ -17,14 +17,21 @@
 
 final class CallableDefinitionSniff implements Sniff
 {
-    public string $syntax;
-    public bool   $includeClosure = true;
+    private const WARNING = 'Callable description should contain definition';
+
+    private const FORMAT_EXPLAIN = [
+        'short' => 'fn(ArgType,...) => ReturnType',
+        'long'  => 'function(ArgType,...): ReturnType'
+    ];
 
-    private $regexp = [
+    private const FORMAT_REGEXP = [
         'short' => '#fn\([?a-zA-Z\\\\, |]*\) => \??[a-zA-Z\\\\|]+#',
         'long'  => '#function\([?a-zA-Z\\\\, |]*\): \??[a-zA-Z\\\\|]+#'
     ];
 
+    public string $syntax         = 'both';
+    public bool   $includeClosure = true;
+
     public function register(): array
     {
         return [T_CLASS, T_TRAIT, T_INTERFACE];
@@ -38,25 +45,23 @@ public function process(File $phpcsFile, $stackPtr): void
             if ($tag !== '@param' && $tag !== '@return') { continue; }
 
             if (!$this->validDescription($tokens[$stackPtr + 2]['content'], $tag === '@param')) {
-                $phpcsFile->addWarning('Callable param description should contain definition', $stackPtr, 'Found');
+                $phpcsFile->addWarning($this->warningMessage(), $stackPtr, 'Found');
             }
         }
     }
 
-    private function validDescription(string $line, bool $variable = true): bool
+    private function validDescription(string $line, bool $forArgument): bool
     {
         if (!$this->isLambda($line)) { return true; }
 
-        $varStart         = $variable ? strpos($line, '$', 8) : 1;
+        $varStart         = $forArgument ? strpos($line, '$', 8) : 1;
         $descriptionStart = $varStart ? strpos($line, ' ', $varStart) : 0;
         $description      = $descriptionStart ? trim(substr($line, $descriptionStart)) : '';
         if (!$description) { return false; }
 
-        if (isset($this->syntax, $this->regexp[$this->syntax])) {
-            return (bool) preg_match($this->regexp[$this->syntax], $description);
-        }
-
-        foreach ($this->regexp as $syntax => $pattern) {
+        $selected = self::FORMAT_REGEXP[$this->syntax] ?? null;
+        $patterns = $selected ? [$selected] : array_values(self::FORMAT_REGEXP);
+        foreach ($patterns as $pattern) {
             if (preg_match($pattern, $description)) { return true; }
         }
 
@@ -75,6 +80,13 @@ private function isLambda(string $line): bool
             $type = substr($type, 0, -2);
         }
 
-        return $type === 'callable' || ($this->includeClosure && $type === 'Closure');
+        return $type === 'callable' || $this->includeClosure && $type === 'Closure';
+    }
+
+    private function warningMessage(): string
+    {
+        $selected = self::FORMAT_EXPLAIN[$this->syntax] ?? null;
+        $format   = $selected ?: implode('` or `', self::FORMAT_EXPLAIN);
+        return self::WARNING . ' [format: `' . $format . '`]';
     }
 }

src/Sniffer/Sniffs/PhpDoc/RequiredForPublicApiSniff.php

@@ -20,6 +20,8 @@
 
 final class RequiredForPublicApiSniff implements Sniff
 {
+    private const WARNING = 'Missing phpDoc comment for original public method signature';
+
     private array $tokens;
 
     public function register(): array
@@ -51,7 +53,7 @@ public function process(File $phpcsFile, $stackPtr): void
 
         foreach ($undocumented as [$methodName, $stackPtr]) {
             if (isset($ancestorMethods[$methodName])) { continue; }
-            $phpcsFile->addWarning('Missing phpDoc comment for original public method signature', $stackPtr, 'Missing');
+            $phpcsFile->addWarning(self::WARNING, $stackPtr, 'Missing');
         }
     }
 

…rrays/InvalidMixedArrayTypeSniffTest.php …rays/AmbiguousAssociativitySniffTest.phptests/Sniffer/Sniffs/Arrays/InvalidMixedArrayTypeSniffTest.php renamed to tests/Sniffer/Sniffs/Arrays/AmbiguousAssociativitySniffTest.php tests/Sniffer/Sniffs/Arrays/InvalidMixedArrayTypeSniffTest.php renamed to tests/Sniffer/Sniffs/Arrays/AmbiguousAssociativitySniffTest.php

@@ -15,7 +15,7 @@
 use Polymorphine\Dev\Sniffer\Sniffs\Arrays\AmbiguousAssociativitySniff;
 
 
-class InvalidMixedArrayTypeSniffTest extends SnifferTest
+class AmbiguousAssociativitySniffTest extends SnifferTest
 {
     public function testAssocArrayWithNonAssocValuesGivesWarning()
     {