Avoid checking abstract functions (#13)

* - added sniff for abstract class naming convention;
- added sniff for interface naming convention;
- added basic tests (consistent to existing ones);

* - code styling;

* - code styling;

* - enable worflow;

* - added some debugging output for fixing/checking the github workflow;

* - fix expected result;

* - revert workflow changes;

* - added return type hint;

* - check only class on AbstractClassNameSniff;
- optimized reading of the class name;

* cleanup;

* debugging testing output;

* removed test debugging output;

Co-authored-by: Richard Prillwitz <richard.prillwitz@proton.ch>

Author: xellio

Proton/Sniffs/Naming/AbstractClassNameSniff.php

@@ -12,23 +12,32 @@ class AbstractClassNameSniff implements Sniff
 {
     public function register(): array
     {
-        return [T_ABSTRACT];
+        return [T_CLASS];
     }
 
     public function process(File $phpcsFile, $stackPtr): void
     {
+        if (!TokenHelper::findPrevious($phpcsFile, T_ABSTRACT, $stackPtr)) {
+            return;
+        }
+
         $tokens = $phpcsFile->getTokens();
 
-        if ($tokens[$stackPtr]['code'] === T_ABSTRACT) {
-            $namePointer = TokenHelper::findNext($phpcsFile, T_STRING, $stackPtr + 1);
+        $opener = $tokens[$stackPtr]['scope_opener'];
+        $nameStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), $opener, true);
+        $nameEnd = $phpcsFile->findNext([T_WHITESPACE, T_COLON], $nameStart, $opener);
+        if ($nameEnd === false) {
+            $name = $tokens[$nameStart]['content'];
+        } else {
+            $name = trim($phpcsFile->getTokensAsString($nameStart, ($nameEnd - $nameStart)));
+        }
 
-            if (substr($tokens[$namePointer]['content'], 0, 8) !== 'Abstract') {
-                $phpcsFile->addError(
-                    'An abstract class should always start with `Abstract`',
-                    $namePointer,
-                    'Found',
-                );
-            }
+        if (substr($name, 0, 8) !== 'Abstract') {
+            $phpcsFile->addError(
+                'An abstract class should always start with `Abstract`',
+                $nameStart,
+                'Found',
+            );
         }
     }
 }

Proton/Sniffs/Naming/InterfaceNameSniff.php

@@ -19,17 +19,26 @@ public function process(File $phpcsFile, $stackPtr): void
     {
         $tokens = $phpcsFile->getTokens();
 
-        if ($tokens[$stackPtr]['code'] === T_INTERFACE) {
-            $namePointer = TokenHelper::findNext($phpcsFile, T_STRING, $stackPtr + 1);
-            $className   = $tokens[$namePointer]['content'];
-
-            if (substr($className, strlen($className) - 9, 9) !== 'Interface') {
-                $phpcsFile->addError(
-                    'An interface should always end with `Interface`',
-                    $namePointer,
-                    'Found',
-                );
-            }
+        if ($tokens[$stackPtr]['code'] !== T_INTERFACE) {
+            return;
         }
+
+        $opener = $tokens[$stackPtr]['scope_opener'];
+        $nameStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), $opener, true);
+        $nameEnd = $phpcsFile->findNext([T_WHITESPACE, T_COLON], $nameStart, $opener);
+        if ($nameEnd === false) {
+            $name = $tokens[$nameStart]['content'];
+        } else {
+            $name = trim($phpcsFile->getTokensAsString($nameStart, ($nameEnd - $nameStart)));
+        }
+
+        if (substr($name, strlen($name) - 9, 9) !== 'Interface') {
+            $phpcsFile->addError(
+                'An interface should always end with `Interface`',
+                $nameStart,
+                'Found',
+            );
+        }
+
     }
 }

tests/correct/AbstractClassOk.php

@@ -6,6 +6,8 @@
 
 abstract class AbstractClassOk
 {
+    abstract public function setOne(int $one = 1): void;
+
     public function getOne(): int
     {
         return 1;

tests/expected_csv.txt

@@ -2,6 +2,8 @@ Line,Column,Type,Source
 4,10,error,PSR2.Files.EndFileNewline.NoneFound
 1,1,error,SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
 7,11,error,Proton.Naming.InterfaceName.Found
+8,1,error,SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces.IncorrectEmptyLinesAfterOpeningBrace
+8,1,error,PSR12.Classes.OpeningBraceSpace.Found
 7,16,error,Proton.Naming.AbstractClassName.Found
 6,12,warning,Generic.Metrics.NestingLevel.TooHigh
 6,12,error,SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint

tests/wrong/ClassWrongAbstract.php

@@ -6,6 +6,9 @@
 
 abstract class ClassWrongAbstract
 {
+
+    abstract public function setOne(int $one = 1): void;
+
     public function getOne(): int
     {
         return 1;