Create a HasCorrespondingUnit expression

This will allow us to ensure that certain classes always have a test,
or that every test has a matching class and their namespaces are correct.

Author: Herberto Graca

Diff for: src/Expression/ForClasses/HasCorrespondingUnit.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Expression\ForClasses;
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\Expression\Description;
+use Arkitect\Expression\Expression;
+use Arkitect\Rules\Violation;
+use Arkitect\Rules\Violations;
+use Closure;
+
+final class HasCorrespondingUnit implements Expression
+{
+    /** @var Closure */
+    private $inferFqnFunction;
+
+    public function __construct(Closure $inferFqnFunction)
+    {
+        $this->inferFqnFunction = $inferFqnFunction;
+    }
+
+    public function describe(ClassDescription $theClass, string $because): Description
+    {
+        $correspondingFqn = $this->inferCorrespondingFqn($theClass);
+
+        return new Description("should have a matching test class named: '$correspondingFqn'", $because);
+    }
+
+    public function evaluate(ClassDescription $theClass, Violations $violations, string $because): void
+    {
+        $correspondingFqn = $this->inferCorrespondingFqn($theClass);
+
+        if (
+            !trait_exists($correspondingFqn)
+            && !class_exists($correspondingFqn)
+            && !interface_exists($correspondingFqn)
+        ) {
+            $violations->add(
+                new Violation(
+                    $theClass->getFQCN(),
+                    $this->describe($theClass, $because)->toString()
+                )
+            );
+        }
+    }
+
+    /**
+     * @return class-string
+     */
+    public function inferCorrespondingFqn(ClassDescription $theClass): string
+    {
+        $inferFqn = $this->inferFqnFunction;
+
+        return $inferFqn($theClass->getFQCN());
+    }
+}

Diff for: tests/Unit/Expressions/ForClasses/DummyClasses/Cat.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Tests\Unit\Expressions\ForClasses\DummyClasses;
+
+final readonly class Cat
+{
+
+}

Diff for: tests/Unit/Expressions/ForClasses/DummyClasses/CatTestCase.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Tests\Unit\Expressions\ForClasses\DummyClasses;
+
+final readonly class CatTestCase
+{
+
+}

Diff for: tests/Unit/Expressions/ForClasses/DummyClasses/Dog.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Tests\Unit\Expressions\ForClasses\DummyClasses;
+
+final class Dog
+{
+
+}

Diff for: tests/Unit/Expressions/ForClasses/HasCorrespondingUnitTest.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arkitect\Tests\Unit\Expressions\ForClasses;
+
+use Arkitect\Analyzer\ClassDescription;
+use Arkitect\Analyzer\FullyQualifiedClassName;
+use Arkitect\Expression\ForClasses\HasCorrespondingUnit;
+use Arkitect\Rules\Violations;
+use Arkitect\Tests\Unit\Expressions\ForClasses\DummyClasses\Cat;
+use Arkitect\Tests\Unit\Expressions\ForClasses\DummyClasses\Dog;
+use PHPUnit\Framework\TestCase;
+
+class HasCorrespondingUnitTest extends TestCase
+{
+    public function test_it_should_pass_the_validation(): void
+    {
+        $class = Cat::class;
+        $classDescription = new ClassDescription(
+            FullyQualifiedClassName::fromString($class),
+            [],
+            [],
+            null,
+            false,
+            false,
+            false,
+            false,
+            false
+        );
+        $constraint = new HasCorrespondingUnit(
+            function ($fqn) {
+                return $fqn . 'TestCase';
+            }
+        );
+
+        $because = 'we want all our command handlers to have a test';
+        $violations = new Violations();
+        $constraint->evaluate($classDescription, $violations, $because);
+
+        self::assertEquals(0, $violations->count());
+    }
+
+    public function test_it_should_return_violation_error(): void
+    {
+        $class = Dog::class;
+        $classDescription = new ClassDescription(
+            FullyQualifiedClassName::fromString($class),
+            [],
+            [],
+            null,
+            false,
+            false,
+            false,
+            false,
+            false
+        );
+        $constraint = new HasCorrespondingUnit(
+            function ($fqn) {
+                return $fqn . 'TestCase';
+            }
+        );
+
+        $because = 'we want all our command handlers to have a test';
+        $violations = new Violations();
+        $constraint->evaluate($classDescription, $violations, $because);
+
+        self::assertNotEquals(0, $violations->count());
+
+        $violationError = $constraint->describe($classDescription, $because)->toString();
+        $this->assertEquals(
+            "should have a matching test class named: "
+            . "'Arkitect\Tests\Unit\Expressions\ForClasses\DummyClasses\DogTestCase' because $because",
+            $violationError
+        );
+    }
+
+}