feat(type): Introduce Editable value object (#43)

Author: silasjoisten

src/Bridge/Faker/Generator.php

@@ -27,6 +27,7 @@
  * @method array  datasourceEntryResponse(array $overrides = [])
  * @method array  datasourceResponse(array $overrides = [])
  * @method array  datasourcesResponse(array $overrides = [])
+ * @method string editable(?string $uid = null, ?string $id = null, ?string $name = null, ?string $space = null)
  * @method array  linkAlternateResponse(array $overrides = [])
  * @method array  linkResponse(array $overrides = [])
  * @method array  linksResponse(array $overrides = [])

src/Bridge/Faker/Provider/StoryblokProvider.php

@@ -16,6 +16,7 @@
 
 use Faker\Provider\Base as BaseProvider;
 use function Safe\array_replace_recursive;
+use function Safe\json_encode;
 
 /**
  * @author Silas Joisten <[email protected]>
@@ -582,4 +583,20 @@ public function relation(): string
             $this->generator->word(),
         );
     }
+
+    public function editable(
+        ?string $uid = null,
+        ?string $id = null,
+        ?string $name = null,
+        ?string $space = null,
+    ): string {
+        $payload = [
+            'uid' => $uid ?? $this->generator->uuid(),
+            'id' => $id ?? (string) $this->generator->numberBetween(1),
+            'name' => $name ?? $this->generator->word(),
+            'space' => $space ?? (string) $this->generator->numberBetween(1),
+        ];
+
+        return \sprintf('<!--#storyblok#%s-->', json_encode($payload));
+    }
 }

src/Domain/Type/Editable.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Domain\Type;
+
+use OskarStark\Value\TrimmedNonEmptyString;
+use Storyblok\Api\Domain\Value\Id;
+use Storyblok\Api\Domain\Value\Uuid;
+use Webmozart\Assert\Assert;
+use function Safe\json_decode;
+use function Safe\json_encode;
+use function Symfony\Component\String\u;
+
+/**
+ * @experimental This class is experimental and may change in future versions.
+ *
+ * @author Silas Joisten <[email protected]>
+ */
+final readonly class Editable
+{
+    public Uuid $uuid;
+    public Id $id;
+    public string $name;
+    public string $space;
+
+    public function __construct(string $value)
+    {
+        TrimmedNonEmptyString::fromString($value);
+        Assert::startsWith($value, '<!--#storyblok#');
+        Assert::endsWith($value, '-->');
+
+        $values = json_decode(
+            rtrim(ltrim($value, '<!--#storyblok#'), '-->'),
+            true,
+        );
+
+        Assert::keyExists($values, 'uid');
+        Assert::uuid($values['uid']);
+        $this->uuid = new Uuid($values['uid']);
+
+        Assert::keyExists($values, 'id');
+        $this->id = new Id((int) $values['id']);
+
+        Assert::keyExists($values, 'name');
+        $this->name = TrimmedNonEmptyString::fromString($values['name'])->toString();
+
+        Assert::keyExists($values, 'space');
+        $this->space = $values['space'];
+    }
+
+    public function __toString(): string
+    {
+        return \sprintf('<!--#storyblok#%s-->', json_encode($this->toArray()));
+    }
+
+    /**
+     * @return array{
+     *     uid: string,
+     *     id: string,
+     *     name: string,
+     *     space: string,
+     * }
+     */
+    public function toArray(): array
+    {
+        return [
+            'uid' => $this->uuid->value,
+            'id' => (string) $this->id->value,
+            'name' => $this->name,
+            'space' => $this->space,
+        ];
+    }
+}

tests/Unit/Domain/Type/EditableTest.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Tests\Unit\Domain\Type;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Storyblok\Api\Domain\Type\Editable;
+use Storyblok\Api\Tests\Util\FakerTrait;
+
+/**
+ * @author Silas Joisten <[email protected]>
+ */
+final class EditableTest extends TestCase
+{
+    use FakerTrait;
+
+    #[Test]
+    public function uuid(): void
+    {
+        $faker = self::faker();
+        $values = $faker->editable(uid: $uuid = $faker->uuid());
+
+        self::assertSame($uuid, (new Editable($values))->uuid->value);
+    }
+
+    #[Test]
+    public function id(): void
+    {
+        $faker = self::faker();
+        $values = $faker->editable(id: $id = (string) $faker->numberBetween(1, 1000));
+
+        self::assertSame((int) $id, (new Editable($values))->id->value);
+    }
+
+    #[Test]
+    public function validName(): void
+    {
+        $faker = self::faker();
+        $values = $faker->editable(name: $name = $faker->word());
+
+        self::assertSame($name, (new Editable($values))->name);
+    }
+
+    #[Test]
+    public function space(): void
+    {
+        $faker = self::faker();
+        $values = $faker->editable(space: $space = (string) $faker->randomNumber());
+
+        self::assertSame($space, (new Editable($values))->space);
+    }
+
+    #[Test]
+    public function stringable(): void
+    {
+        $values = self::faker()->editable();
+
+        self::assertSame($values, (new Editable($values))->__toString());
+        self::assertSame($values, (string) new Editable($values));
+    }
+}