Merge pull request #891 from ash-jc-allen/feature/invokable-arch-expectation

Add `toBeInvokable` arch expectation

src/Expectation.php

@@ -693,4 +693,17 @@ final class Expectation
     {
         return ToBeUsedInNothing::make($this);
     }
+
+    /**
+     * Asserts that the given expectation dependency is an invokable class.
+     */
+    public function toBeInvokable(): ArchExpectation
+    {
+        return Targeted::make(
+            $this,
+            fn (ObjectDescription $object): bool => $object->reflectionClass->hasMethod('__invoke'),
+            'to be invokable',
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class'))
+        );
+    }
 }

src/Expectations/OppositeExpectation.php

@@ -365,6 +365,19 @@ final class OppositeExpectation
         throw InvalidExpectation::fromMethods(['not', 'toBeUsedInNothing']);
     }
 
+    /**
+     * Asserts that the given expectation dependency is not an invokable class.
+     */
+    public function toBeInvokable(): ArchExpectation
+    {
+        return Targeted::make(
+            $this->original,
+            fn (ObjectDescription $object): bool => ! $object->reflectionClass->hasMethod('__invoke'),
+            'to not be invokable',
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class'))
+        );
+    }
+
     /**
      * Handle dynamic method calls into the original expectation.
      *

tests/Features/Expect/toBeInvokable.php

@@ -0,0 +1,29 @@
+<?php
+
+use Pest\Arch\Exceptions\ArchExpectationFailedException;
+
+test('class is invokable')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClass')
+    ->toBeInvokable();
+
+test('opposite class is invokable')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClass')
+    ->not->toBeInvokable();
+
+test('class is invokable via a parent class')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClassViaParent')
+    ->toBeInvokable();
+
+test('class is invokable via a trait')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsInvokable\\InvokableClassViaTrait')
+    ->toBeInvokable();
+
+test('failure when the class is not invokable')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsNotInvokable\\IsNotInvokableClass')
+    ->toBeInvokable();
+
+test('class is not invokable')
+    ->expect('Tests\\Fixtures\\Arch\\ToBeInvokable\\IsNotInvokable\\IsNotInvokableClass')
+    ->not->toBeInvokable();

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class InvokableClass
+{
+    public function __invoke(): void
+    {
+
+    }
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaParent.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class InvokableClassViaParent extends ParentInvokableClass
+{
+    //
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaTrait.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class InvokableClassViaTrait
+{
+    use InvokableTrait;
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableTrait.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+trait InvokableTrait
+{
+    public function __invoke(): void
+    {
+        //
+    }
+}

tests/Fixtures/Arch/ToBeInvokable/IsInvokable/ParentInvokableClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsInvokable;
+
+class ParentInvokableClass
+{
+    public function __invoke(): void
+    {
+
+    }
+}

tests/Fixtures/Arch/ToBeInvokable/IsNotInvokable/IsNotInvokableClass.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToBeInvokable\IsNotInvokable;
+
+class IsNotInvokableClass
+{
+    public function handle(): void
+    {
+
+    }
+}