Cleanup (add more rules, clean codebase, add tests) (#14)

* - 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;

* - activate DisallowMultipleAssignment (only one assignment per line);
- activate AssignmentInCondition rule;
- replace custom AbstractClassNameSniff by existing AbstractClassNamePrefix;
- replace custom InterfaceNameSniff by existing InterfaceNameSuffix;
- cleanup;

* - removed testing debug;
- update expected test output;

* - check for trait naming;

* - removed testing output;

* added more cs rules;

* - removed testing output;

* - error instead of warning;

* - removed debug output;

Co-authored-by: Richard Prillwitz <[email protected]>

Author: xellio

Proton/Sniffs/Architecture/ForbiddenNamespacedFunctionsSniff.php

@@ -9,6 +9,9 @@
 
 class ForbiddenNamespacedFunctionsSniff extends ForbiddenFunctionsSniff
 {
+    /**
+     * @inheritDoc
+     */
     protected function addError($phpcsFile, $stackPtr, $function, $pattern = null): void
     {
         $fqfn = NamespaceHelper::resolveName($phpcsFile, $function, 'function', $stackPtr);

Proton/Sniffs/Naming/AbstractClassNameSniff.php

@@ -9,11 +9,17 @@
 
 class ArrowFunctionSpacingSniff implements Sniff
 {
+    /**
+     * @inheritDoc
+     */
     public function register(): array
     {
         return [T_FN];
     }
 
+    /**
+     * @inheritDoc
+     */
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
@@ -22,7 +28,7 @@ public function process(File $phpcsFile, $stackPtr)
             $phpcsFile->addError(
                 'The fn arrow function token should always be followed by a space.',
                 $stackPtr,
-                'Found'
+                'Found',
             );
         }
     }

Proton/Sniffs/Naming/InterfaceNameSniff.php

@@ -26,12 +26,16 @@
     <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
     <rule ref="Generic.CodeAnalysis.EmptyPHPStatement"/>
     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
+    <rule ref="Generic.CodeAnalysis.AssignmentInCondition"/>
     <rule ref="Generic.Classes.DuplicateClassName"/>
     <rule ref="Generic.WhiteSpace.IncrementDecrementSpacing"/>
     <rule ref="Generic.WhiteSpace.SpreadOperatorSpacingAfter"/>
     <rule ref="Generic.VersionControl.GitMergeConflict"/>
     <rule ref="Generic.Files.OneClassPerFile"/>
     <rule ref="Generic.Files.OneInterfacePerFile"/>
+    <rule ref="Generic.NamingConventions.InterfaceNameSuffix"/>
+    <rule ref="Generic.NamingConventions.AbstractClassNamePrefix"/>
+    <rule ref="Generic.NamingConventions.TraitNameSuffix"/>
 
     <!-- Naming conventions -->
     <rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps"/>
@@ -94,11 +98,12 @@
 
     <rule ref="Generic.Metrics.CyclomaticComplexity">
         <properties>
-            <property name="complexity" value="15"/>
+            <property name="complexity" value="10"/>
             <property name="absoluteComplexity" value="20"/>
         </properties>
     </rule>
 
+    <rule ref="Squiz.PHP.DisallowMultipleAssignments"/>
     <rule ref="Squiz.PHP.NonExecutableCode"/>
     <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
     <rule ref="Squiz.Operators.ValidLogicalOperators"/> <!-- require `&&` and `||`, not `AND` and `OR` -->
@@ -158,7 +163,6 @@
     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
     <rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
     <rule ref="SlevomatCodingStandard.Namespaces.DisallowGroupUse"/>
-<!--    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses"/>-->
     <rule ref="SlevomatCodingStandard.Namespaces.UselessAlias"/>
     <rule ref="SlevomatCodingStandard.Namespaces.NamespaceSpacing"/>
     <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>
@@ -194,7 +198,17 @@
             <property name="nullPosition" value="last" />
         </properties>
     </rule>
-    <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments"/>
+    <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
+        <properties>
+            <property name="forbiddenCommentPatterns" type="array">
+                <element value="~^(?:(?!private|protected|static)\S+ )?(?:con|de)structor\.\z~i"/>
+                <element value="~^Created by .+\.\z~i"/>
+                <element value="~^(User|Date|Time): \S+\z~i"/>
+                <element value="~^\S+ [gs]etter\.\z~i"/>
+                <element value="~^Class \S+\z~i"/>
+            </property>
+        </properties>
+    </rule>
     <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration"/>
     <rule ref="SlevomatCodingStandard.Commenting.DeprecatedAnnotationDeclaration"/>
     <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration">
@@ -247,8 +261,38 @@
     </rule>
 
     <rule ref="Proton.Spacing.ArrowFunctionSpacing"/>
-    <rule ref="Proton.Naming.AbstractClassName"/>
-    <rule ref="Proton.Naming.InterfaceName"/>
+
+    <!-- PHP files should only contain code -->
+    <rule ref="Generic.Files.InlineHTML"/>
+
+    <!-- Force array element indentation with 4 spaces -->
+    <rule ref="Generic.Arrays.ArrayIndent">
+        <exclude name="Generic.Arrays.ArrayIndent.CloseBraceNotNewLine"/>
+    </rule>
+
+    <rule ref="Squiz.PHP.Eval"/>
+
+    <!-- Forbid empty statements -->
+    <rule ref="Generic.CodeAnalysis.EmptyStatement">
+        <!-- But allow empty catch -->
+        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch"/>
+    </rule>
+
+    <!-- Enforce strict comparisons -->
+    <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators"/>
+
+    <!-- Forbid empty comments -->
+    <rule ref="SlevomatCodingStandard.Commenting.EmptyComment"/>
+
+    <!-- Forbid unused use statements -->
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
+        <properties>
+            <property name="searchAnnotations" value="true"/>
+        </properties>
+    </rule>
+
+    <!-- Requires that attributes are always after documentation comment -->
+    <rule ref="SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment"/>
 
     <exclude-pattern>*/node_modules/*</exclude-pattern>
     <exclude-pattern>*/vendor/*</exclude-pattern>

Proton/Sniffs/Spacing/ArrowFunctionSpacingSniff.php

@@ -11,8 +11,8 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
-        "test-print": "phpcs --standard=tests/phpcs.xml --report=summary tests",
-        "test": "phpcs --standard=tests/phpcs.xml --report=csv tests | sort -r | cut -f 2,3,4,6 -d ',' > tests/out.csv && diff tests/expected_csv.txt tests/out.csv"
+        "test-print": "phpcs --standard=phpcs.xml --report=summary tests",
+        "test": "phpcs --standard=phpcs.xml --report=csv tests | sort -r | cut -f 2,3,4,6 -d ',' > tests/out.csv && diff tests/expected_csv.txt tests/out.csv"
     },
     "require": {
         "php": "^7.4 || ^8.0",

Proton/ruleset.xml

@@ -4,7 +4,7 @@
         Proton PHP Coding Standard
     </description>
 
-    <config name="installed_paths" value="../Proton"/>
+    <config name="installed_paths" value="Proton"/>
 
     <rule ref="Proton"/>
 

composer.json

@@ -12,4 +12,18 @@ public function getOne(): int
     {
         return 1;
     }
+
+    /**
+     * Method comment
+     */
+    #[Attribute1, Attribute2('var')]
+    #[Attribute3(), Attribute4]
+    public function method(
+        /** @param int $parameter */
+        #[Attribute1] #[Attribute2] #[Attribute3]
+        #[Attribute4] #[Attribute5] #[Attribute6]
+        int $parameter,
+    ): void {
+        echo $parameter;
+    }
 }

tests/phpcs.xml renamed to phpcs.xml

@@ -20,10 +20,15 @@ final class ClassOk
      * Foo.
      */
     protected array $foo = [];
+    private array $bar = [];
     private string $test = 'foo';
 
     public function __construct(array $config)
     {
+        $this->bar = [
+            'bar' => 'foo',
+        ];
+
         $this->foo = $config + [
             'foo' => 'bar',
         ];
@@ -42,6 +47,7 @@ public function ping(Request $request): mixed
             );
         } catch (\RuntimeException) {
             // ...
+        } catch (\Exception) {
         }
 
         return $request->query->get('test');
@@ -72,6 +78,10 @@ public function foo(string $a, string $b): bool|string
             throw new \RuntimeException();
         }
 
+        if ($a === 'y') {
+            throw new \Exception('');
+        }
+
         return false;
     }
 

tests/correct/AbstractClassOk.php

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