Merge pull request #46 from laravel/feat/function-attributes

Adds Function Attributes support

Author: taylorotwell

README.md

@@ -51,7 +51,8 @@ echo $closure(); // james;
 
 ### Caveats
 
-Creating **anonymous classes** within closures is not supported.
+1. Creating **anonymous classes** within closures is not supported.
+2. Using attributes within closures is not supported.
 
 ## Contributing
 

src/Support/ReflectionClosure.php

@@ -676,6 +676,30 @@ public function getCode()
         $this->isShortClosure = $isShortClosure;
         $this->isBindingRequired = $isUsingThisObject;
         $this->isScopeRequired = $isUsingScope;
+
+        if (PHP_VERSION_ID >= 80100) {
+            $attributesCode = array_map(function ($attribute) {
+                $arguments = $attribute->getArguments();
+
+                $name = $attribute->getName();
+                $arguments = implode(', ', array_map(function ($argument, $key) {
+                    $argument = sprintf("'%s'", str_replace("'", "\\'", $argument));
+
+                    if (is_string($key)) {
+                        $argument = sprintf('%s: %s', $key, $argument);
+                    }
+
+                    return $argument;
+                }, $arguments, array_keys($arguments)));
+
+                return "#[$name($arguments)]";
+            }, $this->getAttributes());
+
+            if (! empty($attributesCode)) {
+                $code = implode("\n", array_merge($attributesCode, [$code]));
+            }
+        }
+
         $this->code = $code;
 
         return $this->code;

tests/Fixtures/ModelAttribute.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Tests\Fixtures;
+
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)]
+class ModelAttribute
+{
+    // ..
+}

tests/ReflectionClosurePhp81Test.php

@@ -284,6 +284,74 @@ enum ScopedBackedEnum: string {
     expect($f)->toBeCode($e);
 });
 
+test('function attributes without arguments', function () {
+    $model = new Model();
+
+    $f = #[MyAttribute] function () {
+        return true;
+    };
+
+    $e = <<<EOF
+#[MyAttribute()]
+function () {
+        return true;
+    }
+EOF;
+
+    expect($f)->toBeCode($e);
+});
+
+test('function attributes with arguments', function () {
+    $model = new Model();
+
+    $f = #[MyAttribute('My " \' Argument 1', Model::class)] function () {
+        return true;
+    };
+
+    $e = <<<EOF
+#[MyAttribute('My " \' Argument 1', 'Tests\Fixtures\Model')]
+function () {
+        return true;
+    }
+EOF;
+
+    expect($f)->toBeCode($e);
+});
+
+test('function attributes with named arguments', function () {
+    $model = new Model();
+
+    $f = #[MyAttribute(string: 'My " \' Argument 1', model:Model::class)] function () {
+        return false;
+    };
+
+    $e = <<<EOF
+#[MyAttribute(string: 'My " \' Argument 1', model: 'Tests\Fixtures\Model')]
+function () {
+        return false;
+    }
+EOF;
+
+    expect($f)->toBeCode($e);
+});
+
+test('function attributes with first-class callable with methods', function () {
+    $model = new Model();
+
+    $f = (new SerializerPhp81Controller())->publicGetter(...);
+
+    $e = <<<EOF
+#[Tests\Fixtures\ModelAttribute()]
+#[MyAttribute('My " \' Argument 1', 'Tests\Fixtures\Model')]
+function ()
+    {
+        return \$this->privateGetter();
+    }
+EOF;
+
+    expect($f)->toBeCode($e);
+});
+
 class ReflectionClosurePhp81Service
 {
 }

tests/SerializerPhp81Test.php

@@ -1,6 +1,7 @@
 <?php
 
 use Tests\Fixtures\Model;
+use Tests\Fixtures\ModelAttribute;
 
 enum SerializerGlobalEnum {
     case Admin;
@@ -302,6 +303,97 @@ enum SerializerScopedBackedEnum: string {
     expect($f(new Model))->toBeInstanceOf(Model::class);
 })->with('serializers');
 
+test('function attributes without arguments', function () {
+    $model = new Model();
+
+    $f = #[MyAttribute] function () {
+        return true;
+    };
+
+    $f = s($f);
+
+    $reflector = new ReflectionFunction($f);
+
+    expect($reflector->getAttributes())->sequence(
+        fn ($attribute) => $attribute
+            ->getName()->toBe(MyAttribute::class)
+            ->getArguments()->toBeEmpty(),
+    );
+
+    expect($f())->toBeTrue();
+})->with('serializers');
+
+test('function attributes with arguments', function () {
+    $model = new Model();
+
+    $f = #[MyAttribute('My " \' Argument 1', Model::class)] function () {
+        return false;
+    };
+
+    $f = s($f);
+
+    $reflector = new ReflectionFunction($f);
+
+    expect($reflector->getAttributes())->sequence(
+        fn ($attribute) => $attribute
+            ->getName()->toBe(MyAttribute::class)
+            ->getArguments()->toBe([
+                'My " \' Argument 1', Model::class,
+            ])
+    );
+
+    expect($f())->toBeFalse();
+})->with('serializers');
+
+test('function attributes with named arguments', function () {
+    $model = new Model();
+
+    $f = #[MyAttribute(string: 'My " \' Argument 1', model:Model::class)] function () {
+        return false;
+    };
+
+    $f = s($f);
+
+    $reflector = new ReflectionFunction($f);
+
+    expect($reflector->getAttributes())->sequence(function ($attribute) {
+
+        $attribute
+            ->getName()->toBe(MyAttribute::class)
+            ->getArguments()->toBe([
+                'string' => 'My " \' Argument 1',
+                'model' => Model::class,
+            ]);
+
+        expect($attribute->value->newInstance())
+            ->string->toBe('My " \' Argument 1')
+            ->model->toBe(Model::class);
+    });
+
+    expect($f())->toBeFalse();
+})->with('serializers');
+
+test('function attributes with first-class callable with methods', function () {
+    $f = (new SerializerPhp81Controller())->publicGetter(...);
+
+    $f = s($f);
+
+    $reflector = new ReflectionFunction($f);
+
+    expect($reflector->getAttributes())->sequence(
+        fn ($attribute) => $attribute
+            ->getName()->toBe(ModelAttribute::class)
+            ->getArguments()->toBe([]),
+        fn ($attribute) => $attribute
+            ->getName()->toBe(MyAttribute::class)
+            ->getArguments()->toBe([
+                'My " \' Argument 1', Model::class,
+            ])
+    );
+
+    expect($f())->toBeInstanceOf(SerializerPhp81Service::class);
+})->with('serializers');
+
 interface SerializerPhp81HasId {}
 interface SerializerPhp81HasName {}
 
@@ -318,6 +410,8 @@ public function __construct(
         // ..
     }
 
+    #[ModelAttribute]
+    #[MyAttribute('My " \' Argument 1', Model::class)]
     public function publicGetter()
     {
         return $this->privateGetter();
@@ -374,3 +468,12 @@ public function getSelf(self $instance): self
     }
 }
 
+#[Attribute(Attribute::TARGET_METHOD|Attribute::TARGET_FUNCTION)]
+class MyAttribute
+{
+    public function __construct(public $string, public $model)
+    {
+        // ..
+    }
+}
+