Adds appliesTo to verify if a given rule should be applied

.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()) {

src/Expression/ForClasses/IsReadonly.php

@@ -18,9 +18,14 @@ public function describe(ClassDescription $theClass, string $because): Descripti
         return new Description("{$theClass->getName()} should 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() || $theClass->isInterface() || $theClass->isTrait() || $theClass->isEnum()) {
+        if ($theClass->isReadonly()) {
             return;
         }
 

src/PHPUnit/ArchRuleCheckerConstraintAdapter.php

@@ -66,11 +66,18 @@
             $this->parsingErrors
         );
 
-        return 0 === $this->violations->count();
+        $violationsCount = $this->violations->count();
+        $parsingErrorsCount = $this->parsingErrors->count();
+
+        return 0 === $violationsCount && 0 === $parsingErrorsCount;
     }
 
     protected function failureDescription($other): string
     {
+        if ($this->parsingErrors->count() > 0) {
+            return "\n".$this->parsingErrors->toString();
+        }
+
         return "\n".$this->violations->toString();
     }
 }

src/Rules/ArchRule.php

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

src/Rules/Constraints.php

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

src/Rules/Specs.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Arkitect\Rules;
@@ -20,6 +21,15 @@ public function allSpecsAreMatchedBy(ClassDescription $classDescription, string
     {
         /** @var Expression $spec */
         foreach ($this->expressions as $spec) {
+            // incremental way to introduce this method
+            if (method_exists($spec, 'appliesTo')) {
+                $canApply = $spec->appliesTo($classDescription);
+
+                if (false === $canApply) {
+                    return false;
+                }
+            }
+
             $violations = new Violations();
             $spec->evaluate($classDescription, $violations, $because);
 

tests/E2E/PHPUnit/ArchRuleTestCase.php

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

tests/E2E/PHPUnit/CheckClassHaveAttributeTest.php

@@ -1,61 +1,62 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Arkitect\Tests\E2E\PHPUnit;
 
-use Arkitect\ClassSet;
 use Arkitect\Expression\ForClasses\HaveAttribute;
 use Arkitect\Expression\ForClasses\HaveNameMatching;
 use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
 use Arkitect\Rules\Rule;
-use PHPUnit\Framework\ExpectationFailedException;
+use Arkitect\Tests\Utils\TestRunner;
 use PHPUnit\Framework\TestCase;
 
-/**
- * @requires PHP >= 8.0
- */
 final class CheckClassHaveAttributeTest extends TestCase
 {
     public function test_entities_should_reside_in_app_model(): void
     {
-        $set = ClassSet::fromDir(__DIR__.'/../_fixtures/mvc');
+        $runner = TestRunner::create('8.4');
 
         $rule = Rule::allClasses()
             ->that(new HaveAttribute('Entity'))
             ->should(new ResideInOneOfTheseNamespaces('App\Model'))
             ->because('we use an ORM');
 
-        ArchRuleTestCase::assertArchRule($rule, $set);
+        $runner->run(__DIR__.'/../_fixtures/mvc', $rule);
+
+        $this->assertCount(0, $runner->getViolations());
+        $this->assertCount(0, $runner->getParsingErrors());
     }
 
     public function test_controllers_should_have_name_ending_in_controller(): void
     {
-        $set = ClassSet::fromDir(__DIR__.'/../_fixtures/mvc');
+        $runner = TestRunner::create('8.4');
 
         $rule = Rule::allClasses()
             ->that(new HaveAttribute('AsController'))
             ->should(new HaveNameMatching('*Controller'))
             ->because('its a symfony thing');
 
-        $expectedExceptionMessage = '
-App\Controller\Foo has 1 violations
-  should have a name that matches *Controller because its a symfony thing';
+        $runner->run(__DIR__.'/../_fixtures/mvc', $rule);
 
-        $this->expectException(ExpectationFailedException::class);
-        $this->expectExceptionMessage($expectedExceptionMessage);
+        $this->assertCount(1, $runner->getViolations());
+        $this->assertCount(0, $runner->getParsingErrors());
 
-        ArchRuleTestCase::assertArchRule($rule, $set);
+        $this->assertEquals('App\Controller\Foo', $runner->getViolations()->get(0)->getFqcn());
     }
 
     public function test_controllers_should_have_controller_attribute(): void
     {
-        $set = ClassSet::fromDir(__DIR__.'/../_fixtures/mvc');
+        $runner = TestRunner::create('8.4');
 
         $rule = Rule::allClasses()
             ->that(new HaveNameMatching('*Controller'))
             ->should(new HaveAttribute('AsController'))
             ->because('it configures the service container');
 
-        ArchRuleTestCase::assertArchRule($rule, $set);
+        $runner->run(__DIR__.'/../_fixtures/mvc', $rule);
+
+        $this->assertCount(0, $runner->getViolations());
+        $this->assertCount(0, $runner->getParsingErrors());
     }
 }