Add new full_slug property (#89)

Author: silasjoisten

src/Domain/Value/Link.php

@@ -26,6 +26,7 @@
     public Uuid $uuid;
     public ?Id $parentId;
     public string $name;
+    public ?string $fullSlug;
     public string $slug;
     public ?string $path;
     public string $realPath;
@@ -66,6 +67,15 @@ public function __construct(array $values)
         Assert::keyExists($values, 'name');
         $this->name = TrimmedNonEmptyString::fromString($values['name'], 'The value of the "name" key must be a non-empty, trimmed string. Got: %s')->toString();
 
+        // This field is only set when using the stories api with resolve_links flag.
+        $fullSlug = null;
+
+        if (\array_key_exists('full_slug', $values) && null !== $values['full_slug']) {
+            $fullSlug = TrimmedNonEmptyString::fromString($values['full_slug'], 'The value of the "full_slug" key must be a non-empty, trimmed string. Got: %s')->toString();
+        }
+
+        $this->fullSlug = $fullSlug;
+
         Assert::keyExists($values, 'slug');
         $this->slug = TrimmedNonEmptyString::fromString($values['slug'], 'The value of the "slug" key must be a non-empty, trimmed string. Got: %s')->toString();
 
@@ -130,7 +140,7 @@ public function isStory(): bool
     public function getSlug(?string $lang = null): string
     {
         if (null === $lang) {
-            return $this->slug;
+            return $this->fullSlug ?? $this->slug;
         }
 
         return $this->getAlternate($lang)->slug;

tests/Unit/Domain/Value/LinkTest.php

@@ -437,6 +437,73 @@ public function getSlugWithLangAndAlternate(): void
         self::assertSame($slug, (new Link($values))->getSlug($lang));
     }
 
+    #[Test]
+    public function fullSlug(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse(['full_slug' => $fullSlug = $faker->slug()]);
+
+        self::assertSame($fullSlug, (new Link($values))->fullSlug);
+    }
+
+    #[Test]
+    public function fullSlugIsOptional(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse();
+        unset($values['full_slug']);
+
+        self::assertNull((new Link($values))->fullSlug);
+    }
+
+    #[Test]
+    public function fullSlugIsOptionalWithNull(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse(['full_slug' => null]);
+
+        self::assertNull((new Link($values))->fullSlug);
+    }
+
+    #[DataProviderExternal(StringProvider::class, 'blank')]
+    #[Test]
+    public function fullSlugMustBeValidString(string $value): void
+    {
+        $values = self::faker()->linkResponse(['full_slug' => $value]);
+
+        self::expectExceptionMessage('The value of the "full_slug" key must be a non-empty, trimmed string. Got: ""');
+        self::expectException(\InvalidArgumentException::class);
+
+        new Link($values);
+    }
+
+    #[Test]
+    public function getSlugWithNullReturnsFullSlugWhenAvailable(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse([
+            'slug' => $faker->slug(),
+            'full_slug' => $fullSlug = $faker->slug(),
+        ]);
+
+        self::assertSame($fullSlug, (new Link($values))->getSlug());
+    }
+
+    #[Test]
+    public function getSlugWithNullReturnsSlugWhenFullSlugIsNull(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse(['slug' => $slug = $faker->word()]);
+        unset($values['full_slug']);
+
+        self::assertSame($slug, (new Link($values))->getSlug());
+    }
+
     #[Test]
     public function getSlugWithNullReturnsDefaultName(): void
     {