Naming sniffs (#11)

- added sniff for abstract class naming convention
- added sniff for interface naming convention
- added basic tests (consistent to existing ones)
- enable worflow
- added some debugging output for fixing/checking the github workflow
- fix expected result
- added return type hint

Author: xellio

.gitignore

@@ -2,4 +2,5 @@
 .vscode
 .phpintel
 /vendor/
-out.csv
+out.csv
+composer.lock

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 
+Copyright (c) 2022
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Proton/Sniffs/Naming/AbstractClassNameSniff.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proton\Sniffs\Naming;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+
+class AbstractClassNameSniff implements Sniff
+{
+    public function register(): array
+    {
+        return [T_ABSTRACT];
+    }
+
+    public function process(File $phpcsFile, $stackPtr): void
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        if ($tokens[$stackPtr]['code'] === T_ABSTRACT) {
+            $namePointer = TokenHelper::findNext($phpcsFile, T_STRING, $stackPtr + 1);
+
+            if (substr($tokens[$namePointer]['content'], 0, 8) !== 'Abstract') {
+                $phpcsFile->addError(
+                    'An abstract class should always start with `Abstract`',
+                    $namePointer,
+                    'Found',
+                );
+            }
+        }
+    }
+}

Proton/Sniffs/Naming/InterfaceNameSniff.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proton\Sniffs\Naming;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+
+class InterfaceNameSniff implements Sniff
+{
+    public function register(): array
+    {
+        return [T_INTERFACE];
+    }
+
+    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',
+                );
+            }
+        }
+    }
+}

Proton/ruleset.xml

@@ -247,6 +247,8 @@
     </rule>
 
     <rule ref="Proton.Spacing.ArrowFunctionSpacing"/>
+    <rule ref="Proton.Naming.AbstractClassName"/>
+    <rule ref="Proton.Naming.InterfaceName"/>
 
     <exclude-pattern>*/node_modules/*</exclude-pattern>
     <exclude-pattern>*/vendor/*</exclude-pattern>

tests/correct/AbstractClassOk.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proton\Test;
+
+abstract class AbstractClassOk
+{
+    public function getOne(): int
+    {
+        return 1;
+    }
+}

tests/correct/ValidInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proton\Test;
+
+interface ValidInterface
+{
+    public function example(): void;
+}

tests/expected.txt

@@ -3,11 +3,13 @@ PHP CODE SNIFFER REPORT SUMMARY
 ------------------------------------------------------------------------------------------------
 FILE                                                                            ERRORS  WARNINGS
 ------------------------------------------------------------------------------------------------
-/Users/Username/dev/Proton/php-coding-standard/tests/wrong/Class1.php           39      4
-/Users/Username/dev/Proton/php-coding-standard/tests/wrong/ClassMetrics.php     4       2
-/Users/Username/dev/Proton/php-coding-standard/tests/wrong/file.php             2       0
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/Class1.php                 39      4
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/ClassMetrics.php           4       2
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/ClassWrongAbstract.php     1       0
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/file.php                   2       0
+/Users/Username/dev/Proton/php-coding-standard/tests/wrong/InterfaceWrong.php         1       0
 ------------------------------------------------------------------------------------------------
-A TOTAL OF 37 ERRORS AND 5 WARNINGS WERE FOUND IN 3 FILES
+A TOTAL OF 39 ERRORS AND 5 WARNINGS WERE FOUND IN 5 FILES
 ------------------------------------------------------------------------------------------------
 PHPCBF CAN FIX 29 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
 ------------------------------------------------------------------------------------------------

tests/expected_csv.txt

@@ -1,6 +1,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
+7,16,error,Proton.Naming.AbstractClassName.Found
 6,12,warning,Generic.Metrics.NestingLevel.TooHigh
 6,12,error,SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
 6,12,error,SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
@@ -65,4 +67,5 @@ Line,Column,Type,Source
 10,27,error,SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces.IncorrectEmptyLinesAfterOpeningBrace
 10,27,error,PSR2.Classes.ClassDeclaration.OpenBraceNewLine
 10,27,error,PSR12.Classes.OpeningBraceSpace.Found
+10,22,error,Proton.Naming.AbstractClassName.Found
 1,1,error,SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing

tests/wrong/ClassWrongAbstract.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace wrong;
+
+abstract class ClassWrongAbstract
+{
+    public function getOne(): int
+    {
+        return 1;
+    }
+}