Merge pull request #934 from hungthai1401/to_have_attribute_expectation

[2.x] Add `toHaveAttribute` expectation

src/Expectation.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Pest;
 
+use Attribute;
 use BadMethodCallException;
 use Closure;
 use InvalidArgumentException;
@@ -846,4 +847,19 @@ final class Expectation
 
         return $this;
     }
+
+    /**
+     * Asserts that the given expectation target to have the given attribute.
+     *
+     * @param  class-string<Attribute>  $attribute
+     */
+    public function toHaveAttribute(string $attribute): ArchExpectation
+    {
+        return Targeted::make(
+            $this,
+            fn (ObjectDescription $object): bool => $object->reflectionClass->getAttributes($attribute) !== [],
+            "to have attribute '{$attribute}'",
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
+        );
+    }
 }

src/Expectations/OppositeExpectation.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Pest\Expectations;
 
+use Attribute;
 use Pest\Arch\Contracts\ArchExpectation;
 use Pest\Arch\Expectations\Targeted;
 use Pest\Arch\Expectations\ToBeUsedIn;
@@ -391,6 +392,21 @@ final class OppositeExpectation
         );
     }
 
+    /**
+     * Asserts that the given expectation target not to have the given attribute.
+     *
+     * @param  class-string<Attribute>  $attribute
+     */
+    public function toHaveAttribute(string $attribute): ArchExpectation
+    {
+        return Targeted::make(
+            $this->original,
+            fn (ObjectDescription $object): bool => $object->reflectionClass->getAttributes($attribute) === [],
+            "to not have attribute '{$attribute}'",
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class'))
+        );
+    }
+
     /**
      * Handle dynamic method calls into the original expectation.
      *

tests/Features/Expect/toHaveAttribute.php

@@ -0,0 +1,18 @@
+<?php
+
+use Pest\Arch\Exceptions\ArchExpectationFailedException;
+
+test('class has attribute')
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveAttribute\\HaveAttribute')
+    ->toHaveAttribute('Tests\\Fixtures\\Arch\\ToHaveAttribute\\Attributes\\AsAttribute');
+
+test('opposite class has attribute')
+    ->throws(ArchExpectationFailedException::class)
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveAttribute\\HaveAttribute')
+    ->not
+    ->toHaveAttribute('Tests\\Fixtures\\Arch\\ToHaveAttribute\\Attributes\\AsAttribute');
+
+test('class not has attribute')
+    ->expect('Tests\\Fixtures\\Arch\\ToHaveAttribute\\NotHaveAttribute')
+    ->not
+    ->toHaveAttribute('Tests\\Fixtures\\Arch\\ToHaveAttribute\\Attributes\\AsAttribute');

tests/Fixtures/Arch/ToHaveAttribute/Attributes/AsAttribute.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHaveAttribute\Attributes;
+
+use Attribute;
+
+#[Attribute()]
+class AsAttribute
+{
+}

tests/Fixtures/Arch/ToHaveAttribute/HaveAttribute/HaveAttributeClass.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHaveAttribute\HaveAttribute;
+
+use Tests\Fixtures\Arch\ToHaveAttribute\Attributes\AsAttribute;
+
+#[AsAttribute]
+class HaveAttributeClass
+{
+}

tests/Fixtures/Arch/ToHaveAttribute/NotHaveAttribute/NotHaveAttributeClass.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Arch\ToHaveAttribute\NotHaveAttribute;
+
+class NotHaveAttributeClass
+{
+}