added isFinal and isNotFinal rule (#241)

phparkitect · Feb 23, 2022 · ee33724 · ee33724
1 parent efc2ea8
commit ee33724
Show file tree

Hide file tree

Showing 13 changed files with 252 additions and 16 deletions.
diff --git a/src/Analyzer/ClassDescription.php b/src/Analyzer/ClassDescription.php
@@ -21,12 +21,21 @@ class ClassDescription
      */
     private $extends;
 
-    public function __construct(FullyQualifiedClassName $FQCN, array $dependencies, array $interfaces, ?FullyQualifiedClassName $extends)
-    {
+    /** @var bool */
+    private $final;
+
+    public function __construct(
+        FullyQualifiedClassName $FQCN,
+        array $dependencies,
+        array $interfaces,
+        ?FullyQualifiedClassName $extends,
+        bool $final
+    ) {
         $this->FQCN = $FQCN;
         $this->dependencies = $dependencies;
         $this->interfaces = $interfaces;
         $this->extends = $extends;
+        $this->final = $final;
     }
 
     public function setFullPath(string $fullPath): void
@@ -116,4 +125,9 @@ public function getExtends(): ?FullyQualifiedClassName
     {
         return $this->extends;
     }
+
+    public function isFinal(): bool
+    {
+        return $this->final;
+    }
 }
diff --git a/src/Analyzer/ClassDescriptionBuilder.php b/src/Analyzer/ClassDescriptionBuilder.php
@@ -20,6 +20,9 @@ class ClassDescriptionBuilder
     /** @var string */
     private $filePath;
 
+    /** @var bool */
+    private $final;
+
     private function __construct()
     {
     }
@@ -31,6 +34,7 @@ public static function create(string $FQCN): self
         $cdb->filePath = '';
         $cdb->classDependencies = [];
         $cdb->interfaces = [];
+        $cdb->final = false;
 
         return $cdb;
     }
@@ -67,9 +71,16 @@ public function setExtends(string $FQCN, int $line): self
 
     public function get(): ClassDescription
     {
-        $cd = new ClassDescription($this->FQCN, $this->classDependencies, $this->interfaces, $this->extend);
+        $cd = new ClassDescription($this->FQCN, $this->classDependencies, $this->interfaces, $this->extend, $this->final);
         $cd->setFullPath($this->filePath);
 
         return $cd;
     }
+
+    public function setFinal(bool $final): self
+    {
+        $this->final = $final;
+
+        return $this;
+    }
 }
diff --git a/src/Analyzer/FileVisitor.php b/src/Analyzer/FileVisitor.php
@@ -32,6 +32,10 @@ public function enterNode(Node $node): void
                 $this->classDescriptionBuilder
                     ->setExtends($node->extends->toString(), $node->getLine());
             }
+
+            if ($node->isFinal()) {
+                $this->classDescriptionBuilder->setFinal(true);
+            }
         }
 
         /**

diff --git a/src/Expression/ForClasses/IsFinal.php b/src/Expression/ForClasses/IsFinal.php
@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace Arkitect\Expression\ForClasses;
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\Expression\Description;
+use Arkitect\Expression\Expression;
+use Arkitect\Expression\PositiveDescription;
+use Arkitect\Rules\Violation;
+use Arkitect\Rules\Violations;
+
+class IsFinal implements Expression
+{
+    public function describe(ClassDescription $theClass): Description
+    {
+        return new PositiveDescription("{$theClass->getName()} should be final");
+    }
+
+    public function evaluate(ClassDescription $theClass, Violations $violations): void
+    {
+        if ($theClass->isFinal()) {
+            return;
+        }
+
+        $violation = Violation::create(
+            $theClass->getFQCN(),
+            $this->describe($theClass)->toString()
+        );
+
+        $violations->add($violation);
+    }
+}
diff --git a/src/Expression/ForClasses/IsNotFinal.php b/src/Expression/ForClasses/IsNotFinal.php
@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace Arkitect\Expression\ForClasses;
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\Expression\Description;
+use Arkitect\Expression\Expression;
+use Arkitect\Expression\PositiveDescription;
+use Arkitect\Rules\Violation;
+use Arkitect\Rules\Violations;
+
+class IsNotFinal implements Expression
+{
+    public function describe(ClassDescription $theClass): Description
+    {
+        return new PositiveDescription("{$theClass->getName()} should not be final");
+    }
+
+    public function evaluate(ClassDescription $theClass, Violations $violations): void
+    {
+        if (!$theClass->isFinal()) {
+            return;
+        }
+
+        $violation = Violation::create(
+            $theClass->getFQCN(),
+            $this->describe($theClass)->toString()
+        );
+
+        $violations->add($violation);
+    }
+}
diff --git a/tests/Unit/Analyzer/ClassDescriptionBuilderTest.php b/tests/Unit/Analyzer/ClassDescriptionBuilderTest.php
@@ -28,4 +28,30 @@ public function test_it_should_create_builder_with_dependency_and_interface(): v
         $this->assertEquals($FQCN, $classDescription->getName());
         $this->assertEquals($FQCN, $classDescription->getFQCN());
     }
+
+    public function test_it_should_create_final_class(): void
+    {
+        $FQCN = 'HappyIsland';
+        $classDescriptionBuilder = ClassDescriptionBuilder::create($FQCN);
+        $classDescriptionBuilder->setFinal(true);
+
+        $classDescription = $classDescriptionBuilder->get();
+
+        $this->assertInstanceOf(ClassDescription::class, $classDescription);
+
+        $this->assertTrue($classDescription->isFinal());
+    }
+
+    public function test_it_should_create_not_final_class(): void
+    {
+        $FQCN = 'HappyIsland';
+        $classDescriptionBuilder = ClassDescriptionBuilder::create($FQCN);
+        $classDescriptionBuilder->setFinal(false);
+
+        $classDescription = $classDescriptionBuilder->get();
+
+        $this->assertInstanceOf(ClassDescription::class, $classDescription);
+
+        $this->assertFalse($classDescription->isFinal());
+    }
 }
diff --git a/tests/Unit/Expressions/ForClasses/ExtendTest.php b/tests/Unit/Expressions/ForClasses/ExtendTest.php
@@ -20,7 +20,8 @@ public function test_it_should_return_violation_error(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [],
-            FullyQualifiedClassName::fromString('My\AnotherClass')
+            FullyQualifiedClassName::fromString('My\AnotherClass'),
+            false
         );
 
         $violationError = $extend->describe($classDescription)->toString();
@@ -40,7 +41,8 @@ public function test_it_should_return_violation_error_if_extend_is_null(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [],
-            null
+            null,
+            false
         );
 
         $violationError = $extend->describe($classDescription)->toString();

diff --git a/tests/Unit/Expressions/ForClasses/ImplementTest.php b/tests/Unit/Expressions/ForClasses/ImplementTest.php
@@ -21,7 +21,8 @@ public function test_it_should_return_violation_error(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [],
-            null
+            null,
+            false
         );
 
         $violationError = $implementConstraint->describe($classDescription)->toString();
@@ -42,7 +43,8 @@ public function test_it_should_return_true_if_not_depends_on_namespace(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [FullyQualifiedClassName::fromString('foo')],
-            null
+            null,
+            false
         );
 
         $violations = new Violations();
@@ -59,7 +61,8 @@ public function test_it_should_return_false_if_depends_on_namespace(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [FullyQualifiedClassName::fromString('interface')],
-            null
+            null,
+            false
         );
 
         $violations = new Violations();

diff --git a/tests/Unit/Expressions/ForClasses/IsFinalTest.php b/tests/Unit/Expressions/ForClasses/IsFinalTest.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Tests\Unit\Expressions\ForClasses;
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\Analyzer\FullyQualifiedClassName;
+use Arkitect\Expression\ForClasses\IsFinal;
+use Arkitect\Rules\Violations;
+use PHPUnit\Framework\TestCase;
+
+class IsFinalTest extends TestCase
+{
+    public function test_it_should_return_violation_error(): void
+    {
+        $isFinal = new IsFinal();
+        $classDescription = new ClassDescription(
+            FullyQualifiedClassName::fromString('HappyIsland'),
+            [],
+            [],
+            null,
+            false
+        );
+
+        $violationError = $isFinal->describe($classDescription)->toString();
+
+        $violations = new Violations();
+        $isFinal->evaluate($classDescription, $violations);
+        self::assertNotEquals(0, $violations->count());
+
+        $this->assertEquals('HappyIsland should be final', $violationError);
+    }
+
+    public function test_it_should_return_true_if_is_final(): void
+    {
+        $class = 'myClass';
+
+        $isFinal = new IsFinal();
+        $classDescription = new ClassDescription(
+            FullyQualifiedClassName::fromString('HappyIsland'),
+            [],
+            [],
+            null,
+            true
+        );
+
+        $violations = new Violations();
+        $isFinal->evaluate($classDescription, $violations);
+        self::assertEquals(0, $violations->count());
+    }
+}
diff --git a/tests/Unit/Expressions/ForClasses/IsNotFinalTest.php b/tests/Unit/Expressions/ForClasses/IsNotFinalTest.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Tests\Unit\Expressions\ForClasses;
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\Analyzer\FullyQualifiedClassName;
+use Arkitect\Expression\ForClasses\IsNotFinal;
+use Arkitect\Rules\Violations;
+use PHPUnit\Framework\TestCase;
+
+class IsNotFinalTest extends TestCase
+{
+    public function test_it_should_return_violation_error(): void
+    {
+        $isFinal = new IsNotFinal();
+        $classDescription = new ClassDescription(
+            FullyQualifiedClassName::fromString('HappyIsland'),
+            [],
+            [],
+            null,
+            true
+        );
+
+        $violationError = $isFinal->describe($classDescription)->toString();
+
+        $violations = new Violations();
+        $isFinal->evaluate($classDescription, $violations);
+        self::assertNotEquals(0, $violations->count());
+
+        $this->assertEquals('HappyIsland should not be final', $violationError);
+    }
+
+    public function test_it_should_return_true_if_is_final(): void
+    {
+        $isFinal = new IsNotFinal();
+        $classDescription = new ClassDescription(
+            FullyQualifiedClassName::fromString('HappyIsland'),
+            [],
+            [],
+            null,
+            false
+        );
+
+        $violations = new Violations();
+        $isFinal->evaluate($classDescription, $violations);
+        self::assertEquals(0, $violations->count());
+    }
+}
diff --git a/tests/Unit/Expressions/ForClasses/NotExtendTest.php b/tests/Unit/Expressions/ForClasses/NotExtendTest.php
@@ -20,7 +20,8 @@ public function test_it_should_return_violation_error(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [],
-            FullyQualifiedClassName::fromString('My\BaseClass')
+            FullyQualifiedClassName::fromString('My\BaseClass'),
+            false
         );
 
         $violationError = $notExtend->describe($classDescription)->toString();

diff --git a/tests/Unit/Expressions/ForClasses/NotHaveDependencyOutsideNamespaceTest.php b/tests/Unit/Expressions/ForClasses/NotHaveDependencyOutsideNamespaceTest.php
@@ -21,7 +21,8 @@ public function test_it_should_return_violation_error(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [],
             [],
-            null
+            null,
+            false
         );
 
         $violationError = $notHaveDependencyOutsideNamespace->describe($classDescription)->toString();
@@ -36,7 +37,8 @@ public function test_it_should_return_true_if_not_depends_on_namespace(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [new ClassDependency('myNamespace', 100)],
             [],
-            null
+            null,
+            false
         );
 
         $violations = new Violations();
@@ -51,7 +53,8 @@ public function test_it_should_return_false_if_depends_on_namespace(): void
             FullyQualifiedClassName::fromString('HappyIsland'),
             [new ClassDependency('myNamespace', 100), new ClassDependency('another\class', 200)],
             [],
-            null
+            null,
+            false
         );
 
         $violations = new Violations();
@@ -66,7 +69,8 @@ public function test_it_should_not_return_violation_error_if_dependency_excluded
             FullyQualifiedClassName::fromString('HappyIsland'),
             [new ClassDependency('foo', 100)],
             [],
-            null
+            null,
+            false
         );
 
         $violations = new Violations();