Merge pull request #293 from koriym/link-self

Self link

phpcs.xml

@@ -45,6 +45,7 @@
         <exclude name="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.MissingVariable"/>
         <exclude name="SlevomatCodingStandard.Commenting.UselessInheritDocComment.UselessInheritDocComment"/>
         <exclude name="Squiz.Commenting.FunctionComment.InvalidNoReturn"/>
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/>
         <!-- /Base -->
         <!-- Option -->
 <!--        <exclude name="SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed"/>-->

src/EmbedInterceptor.php

@@ -14,10 +14,13 @@
 use function array_shift;
 use function assert;
 use function is_array;
+use function is_string;
 use function uri_template;
 
 final class EmbedInterceptor implements MethodInterceptor
 {
+    private const SELF_LINK = '_self';
+
     private readonly ResourceInterface $resource;
 
     public function __construct(
@@ -71,6 +74,12 @@ private function embedResource(array $embeds, ResourceObject $ro, array $query):
                     throw new LinkException($embed->rel); // @codeCoverageIgnore
                 }
 
+                if ($embed->rel === self::SELF_LINK) {
+                    $this->linkSelf($request, $ro);
+
+                    continue;
+                }
+
                 $ro->body[$embed->rel] = clone $request;
             } catch (BadRequestException $e) {
                 // wrap ResourceNotFound or Uri exception
@@ -101,4 +110,18 @@ private function getArgsByInvocation(MethodInvocation $invocation): array
 
         return $namedParameters;
     }
+
+    public function linkSelf(Request $request, ResourceObject $ro): void
+    {
+        $result = $request();
+        assert(is_array($result->body));
+        /** @var mixed $value */
+        foreach ($result->body as $key => $value) {
+            assert(is_string($key));
+            /** @psalm-suppress MixedArrayAssignment */
+            $ro->body[$key] = $value; // @phpstan-ignore-line
+        }
+
+        $ro->code = $result->code;
+    }
 }

tests/EmbedInterceptorTest.php

@@ -37,6 +37,14 @@ public function testInvoke(): Birds
         return $result;
     }
 
+    public function testSelfLink(): void
+    {
+        $embeded = $this->resource->uri('app://self/bird/child')(['id' => 1]);
+        $result = $this->resource->uri('app://self/bird/self-link')(['id' => 1]);
+        $this->assertSame($result->body, $embeded->body);
+        $this->assertSame($result->code, $embeded->code);
+    }
+
     public function testInvokeRelativePath(): BirdsRel
     {
         $result = $this->resource->uri('app://self/bird/birds-rel')(['id' => 1]);

tests/Fake/FakeVendor/Sandbox/Resource/App/Bird/Child.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FakeVendor\Sandbox\Resource\App\Bird;
+
+use BEAR\Resource\ResourceObject;
+
+class Child extends ResourceObject
+{
+    public $code = 100;
+
+    public function onGet(string $id)
+    {
+        $this->body = [
+            'id' => $id
+        ];
+
+        return $this;
+    }
+}

tests/Fake/FakeVendor/Sandbox/Resource/App/Bird/SelfLink.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FakeVendor\Sandbox\Resource\App\Bird;
+
+use BEAR\Resource\Annotation\Embed;
+use BEAR\Resource\Annotation\Link;
+use BEAR\Resource\ResourceObject;
+
+class SelfLink extends ResourceObject
+{
+    #[Embed(rel: "_self", src: "app://self/bird/child{?id}")]
+    public function onGet(string $id)
+    {
+        return $this;
+    }
+}