From 011bd3ba827b33d3f7ab617c9a57ae3ab004a830 Mon Sep 17 00:00:00 2001
From: Ash Allen <mail@ashallendesign.co.uk>
Date: Tue, 1 Aug 2023 12:09:18 +0100
Subject: [PATCH] Added "toBeInvokable" arch expectation.

---
 src/Expectation.php                           | 13 +++++++++
 src/Expectations/OppositeExpectation.php      | 13 +++++++++
 tests/Features/Expect/toBeInvokable.php       | 29 +++++++++++++++++++
 .../IsInvokable/InvokableClass.php            | 13 +++++++++
 .../IsInvokable/InvokableClassViaParent.php   | 10 +++++++
 .../IsInvokable/InvokableClassViaTrait.php    | 10 +++++++
 .../IsInvokable/InvokableTrait.php            | 13 +++++++++
 .../IsInvokable/ParentInvokableClass.php      | 13 +++++++++
 .../IsNotInvokable/IsNotInvokableClass.php    | 13 +++++++++
 9 files changed, 127 insertions(+)
 create mode 100644 tests/Features/Expect/toBeInvokable.php
 create mode 100644 tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClass.php
 create mode 100644 tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaParent.php
 create mode 100644 tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaTrait.php
 create mode 100644 tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableTrait.php
 create mode 100644 tests/Fixtures/Arch/ToBeInvokable/IsInvokable/ParentInvokableClass.php
 create mode 100644 tests/Fixtures/Arch/ToBeInvokable/IsNotInvokable/IsNotInvokableClass.php

diff --git a/src/Expectation.php b/src/Expectation.php
index 32e22d3c..185acef6 100644
--- a/src/Expectation.php
+++ b/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'))
+        );
+    }
 }
diff --git a/src/Expectations/OppositeExpectation.php b/src/Expectations/OppositeExpectation.php
index 367dfb92..4f24cb76 100644
--- a/src/Expectations/OppositeExpectation.php
+++ b/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.
      *
diff --git a/tests/Features/Expect/toBeInvokable.php b/tests/Features/Expect/toBeInvokable.php
new file mode 100644
index 00000000..c36567f7
--- /dev/null
+++ b/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();
diff --git a/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClass.php b/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClass.php
new file mode 100644
index 00000000..24cbb979
--- /dev/null
+++ b/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
+    {
+
+    }
+}
diff --git a/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaParent.php b/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaParent.php
new file mode 100644
index 00000000..542ebcd2
--- /dev/null
+++ b/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
+{
+    //
+}
diff --git a/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaTrait.php b/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableClassViaTrait.php
new file mode 100644
index 00000000..69ec3490
--- /dev/null
+++ b/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;
+}
diff --git a/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableTrait.php b/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/InvokableTrait.php
new file mode 100644
index 00000000..cfbe9659
--- /dev/null
+++ b/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
+    {
+        //
+    }
+}
diff --git a/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/ParentInvokableClass.php b/tests/Fixtures/Arch/ToBeInvokable/IsInvokable/ParentInvokableClass.php
new file mode 100644
index 00000000..89bc5904
--- /dev/null
+++ b/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
+    {
+
+    }
+}
diff --git a/tests/Fixtures/Arch/ToBeInvokable/IsNotInvokable/IsNotInvokableClass.php b/tests/Fixtures/Arch/ToBeInvokable/IsNotInvokable/IsNotInvokableClass.php
new file mode 100644
index 00000000..c645a0c3
--- /dev/null
+++ b/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
+    {
+
+    }
+}