Adds appliesTo to verify if a given rule should be applied (#454)

Author: micheleorselli

.gitignore

@@ -11,4 +11,5 @@ phparkitect.phar
 composer.lock
 .php-version
 composer.phar
-.phpunit.cache/
+.phpunit.cache/
+.vscode

.php-cs-fixer.dist.php

@@ -5,7 +5,6 @@
     ->exclude('vendor/')
     ->notPath('tests/E2E/_fixtures/parse_error/Services/CartService.php');
 
-
 return (new PhpCsFixer\Config())
     ->setFinder($finder)
     ->setRiskyAllowed(true)
@@ -24,7 +23,7 @@
         'modernize_types_casting' => true, // Replaces intval, floatval, doubleval, strval and boolval function calls with according type casting operator.
         'multiline_whitespace_before_semicolons' => true, // Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls.
         'no_unreachable_default_argument_value' => true, // In function arguments there must not be arguments with default values before non-default ones.
-	'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],// To avoid problems of compatibility with the old php-cs-fixer version used on PHP 7.3
+        'no_superfluous_phpdoc_tags' => ['allow_mixed' => true], // To avoid problems of compatibility with the old php-cs-fixer version used on PHP 7.3
         'no_useless_else' => true,
         'no_useless_return' => true,
         'ordered_class_elements' => true, // Orders the elements of classes/interfaces/traits.

src/Analyzer/FileVisitor.php

@@ -224,15 +224,6 @@ public function enterNode(Node $node): void
                     ->addDependency(new ClassDependency($returnType->toString(), $returnType->getLine()));
             }
         }
-
-        if ($node instanceof Node\Attribute) {
-            $nodeName = $node->name;
-
-            if ($nodeName instanceof Node\Name\FullyQualified) {
-                $this->classDescriptionBuilder
-                    ->addDependency(new ClassDependency(implode('\\', $nodeName->getParts()), $node->getLine()));
-            }
-        }
     }
 
     public function getClassDescriptions(): array

src/CLI/PhpArkitectApplication.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Arkitect\CLI;

src/Expression/Expression.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Arkitect\Expression;
@@ -20,6 +21,16 @@ interface Expression
      */
     public function describe(ClassDescription $theClass, string $because): Description;
 
+    /**
+     * Checks if the expression applies to the class passed as parameter.
+     * If the current expression does not apply to the class, this method should return false.
+     *
+     * eg: IsAbstract does not applies to interfaces, traits, readonly classes
+     *
+     * Not included directly in the interface to allow incremental implementation of it in the rules.
+     */
+    //public function appliesTo(ClassDescription $theClass): bool;
+
     /**
      * Evaluates the expression for the class passed as parameter.
      * It should adds violations if rule is violated.

src/Expression/ForClasses/IsAbstract.php

@@ -18,10 +18,14 @@ public function describe(ClassDescription $theClass, string $because): Descripti
         return new Description("{$theClass->getName()} should be abstract", $because);
     }
 
+    public function appliesTo(ClassDescription $theClass): bool
+    {
+        return !($theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum() || $theClass->isFinal());
+    }
+
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
-        if ($theClass->isAbstract() || $theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum()
-            || $theClass->isFinal()) {
+        if ($theClass->isAbstract()) {
             return;
         }
 

src/Expression/ForClasses/IsFinal.php

@@ -18,10 +18,14 @@ public function describe(ClassDescription $theClass, string $because): Descripti
         return new Description("{$theClass->getName()} should be final", $because);
     }
 
+    public function appliesTo(ClassDescription $theClass): bool
+    {
+        return !($theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum() || $theClass->isAbstract());
+    }
+
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
-        if ($theClass->isAbstract() || $theClass->isInterface() || $theClass->isFinal() || $theClass->isTrait()
-            || $theClass->isEnum()) {
+        if ($theClass->isFinal()) {
             return;
         }
 

src/Expression/ForClasses/IsNotAbstract.php

@@ -18,6 +18,11 @@ public function describe(ClassDescription $theClass, string $because): Descripti
         return new Description("{$theClass->getName()} should not be abstract", $because);
     }
 
+    public function appliesTo(ClassDescription $theClass): bool
+    {
+        return !($theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum() || $theClass->isFinal());
+    }
+
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
         if (!$theClass->isAbstract()) {

src/Expression/ForClasses/IsNotFinal.php

@@ -18,6 +18,11 @@ public function describe(ClassDescription $theClass, string $because): Descripti
         return new Description("{$theClass->getName()} should not be final", $because);
     }
 
+    public function appliesTo(ClassDescription $theClass): bool
+    {
+        return !($theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum() || $theClass->isAbstract());
+    }
+
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
         if (!$theClass->isFinal()) {

src/Expression/ForClasses/IsNotReadonly.php

@@ -18,6 +18,11 @@ public function describe(ClassDescription $theClass, string $because): Descripti
         return new Description("{$theClass->getName()} should not be readonly", $because);
     }
 
+    public function appliesTo(ClassDescription $theClass): bool
+    {
+        return !($theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum());
+    }
+
     public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
     {
         if (!$theClass->isReadonly()) {