Refactor canonicable publication field internals

packages/framework/src/Console/Commands/MakePublicationCommand.php

@@ -18,7 +18,6 @@
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 use Hyde\Framework\Features\Publications\PublicationService;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Str;
 use function implode;
 use function in_array;
 use InvalidArgumentException;
@@ -188,8 +187,7 @@ protected function captureOtherFieldInput(PublicationField $field): ?Publication
             return null;
         }
 
-        $namespace = Str::beforeLast(PublicationFieldValue::class, '\\');
-        $className = "$namespace\\{$field->type->name}Field";
+        $className = $field->type->fieldClass();
 
         return new $className($selection);
     }

packages/framework/src/Console/Commands/MakePublicationTypeCommand.php

@@ -8,11 +8,11 @@
 use Hyde\Console\Concerns\ValidatingCommand;
 use Hyde\Framework\Actions\CreatesNewPublicationType;
 use Hyde\Framework\Features\Publications\Models\PublicationField;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts\Canonicable;
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 use Hyde\Hyde;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
-use function in_array;
 use InvalidArgumentException;
 use function is_dir;
 use function is_file;
@@ -130,7 +130,7 @@ protected function getFieldType(): PublicationFieldTypes
     protected function getCanonicalField(): PublicationField
     {
         $selectableFields = $this->fields->reject(function (PublicationField $field): bool {
-            return in_array($field, PublicationFieldTypes::canonicable());
+            return ! is_a($field->type->fieldClass(), Canonicable::class, true);
         });
 
         if ($this->option('use-defaults')) {

packages/framework/src/Framework/Features/Publications/Models/PublicationFieldValues/Concerns/CanonicableTrait.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns;
+
+use RuntimeException;
+use function substr;
+
+trait CanonicableTrait
+{
+    public function __toString(): string
+    {
+        return $this->getCanonicalValue();
+    }
+
+    public function getCanonicalValue(): string
+    {
+        return substr($this->value, 0, 64) ?: throw new RuntimeException('Canonical value cannot be empty');
+    }
+}

packages/framework/src/Framework/Features/Publications/Models/PublicationFieldValues/Contracts/Canonicable.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts;
+
+use Stringable;
+
+interface Canonicable extends Stringable
+{
+    public function getCanonicalValue(): string;
+}

packages/framework/src/Framework/Features/Publications/Models/PublicationFieldValues/DatetimeField.php

@@ -5,10 +5,14 @@
 namespace Hyde\Framework\Features\Publications\Models\PublicationFieldValues;
 
 use DateTime;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns\CanonicableTrait;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts\Canonicable;
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 
-final class DatetimeField extends PublicationFieldValue
+final class DatetimeField extends PublicationFieldValue implements Canonicable
 {
+    use CanonicableTrait;
+
     public const TYPE = PublicationFieldTypes::Datetime;
 
     protected static function parseInput(string $input): DateTime

packages/framework/src/Framework/Features/Publications/Models/PublicationFieldValues/IntegerField.php

@@ -4,10 +4,14 @@
 
 namespace Hyde\Framework\Features\Publications\Models\PublicationFieldValues;
 
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns\CanonicableTrait;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts\Canonicable;
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 
-final class IntegerField extends PublicationFieldValue
+final class IntegerField extends PublicationFieldValue implements Canonicable
 {
+    use CanonicableTrait;
+
     public const TYPE = PublicationFieldTypes::Integer;
 
     protected static function parseInput(string $input): int

packages/framework/src/Framework/Features/Publications/Models/PublicationFieldValues/StringField.php

@@ -4,10 +4,14 @@
 
 namespace Hyde\Framework\Features\Publications\Models\PublicationFieldValues;
 
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns\CanonicableTrait;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts\Canonicable;
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 
-final class StringField extends PublicationFieldValue
+final class StringField extends PublicationFieldValue implements Canonicable
 {
+    use CanonicableTrait;
+
     public const TYPE = PublicationFieldTypes::String;
 
     protected static function parseInput(string $input): string

packages/framework/src/Framework/Features/Publications/Models/PublicationFieldValues/TextField.php

@@ -4,11 +4,15 @@
 
 namespace Hyde\Framework\Features\Publications\Models\PublicationFieldValues;
 
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns\CanonicableTrait;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts\Canonicable;
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 use function trim;
 
-final class TextField extends PublicationFieldValue
+final class TextField extends PublicationFieldValue implements Canonicable
 {
+    use CanonicableTrait;
+
     public const TYPE = PublicationFieldTypes::Text;
 
     protected static function parseInput(string $input): string

packages/framework/src/Framework/Features/Publications/PublicationFieldTypes.php

@@ -4,8 +4,10 @@
 
 namespace Hyde\Framework\Features\Publications;
 
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\PublicationFieldValue;
 use Hyde\Framework\Features\Publications\Validation\BooleanRule;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 
 /**
  * The supported field types for publication types.
@@ -63,18 +65,10 @@ public static function getRules(self $type): array
         };
     }
 
-    /**
-     * The types that can be used for canonical fields (used to generate file names).
-     *
-     * @return \Hyde\Framework\Features\Publications\PublicationFieldTypes[]
-     */
-    public static function canonicable(): array
+    public function fieldClass(): string
     {
-        return [
-            self::String,
-            self::Integer,
-            self::Datetime,
-            self::Text,
-        ];
+        $namespace = Str::beforeLast(PublicationFieldValue::class, '\\');
+
+        return "$namespace\\{$this->name}Field";
     }
 }

packages/framework/tests/Feature/PublicationFieldTypesEnumTest.php

@@ -79,14 +79,4 @@ public function testNamesReturnsArrayOfCaseNames()
             9 => 'Tag',
         ], PublicationFieldTypes::names());
     }
-
-    public function testCanonicable()
-    {
-        $this->assertSame([
-            PublicationFieldTypes::String,
-            PublicationFieldTypes::Integer,
-            PublicationFieldTypes::Datetime,
-            PublicationFieldTypes::Text,
-        ], PublicationFieldTypes::canonicable());
-    }
 }

packages/framework/tests/Features/Publications/Models/PublicationFieldValues/Concerns/CanonicableTraitTest.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Framework\Testing\Features\Publications\Models\PublicationFieldValues\Concerns;
+
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns\CanonicableTrait;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Contracts\Canonicable;
+use Hyde\Framework\Features\Publications\Models\PublicationFieldValues\PublicationFieldValue;
+use Hyde\Testing\TestCase;
+use RuntimeException;
+
+/**
+ * @covers \Hyde\Framework\Features\Publications\Models\PublicationFieldValues\Concerns\CanonicableTrait
+ */
+class CanonicableTraitTest extends TestCase
+{
+    public function test__toString()
+    {
+        $class = new CanonicableTraitTestClass('foo');
+
+        $this->assertSame('foo', (string) $class);
+    }
+
+    public function testGetCanonicalValue()
+    {
+        $class = new CanonicableTraitTestClass('foo');
+
+        $this->assertSame('foo', $class->getCanonicalValue());
+    }
+
+    public function test__toStringReturnsGetCanonicalValue()
+    {
+        $class = new CanonicableTraitTestClass('foo');
+
+        $this->assertSame($class->getCanonicalValue(), $class->__toString());
+    }
+
+    public function testGetCanonicalValueTruncatesValuesLongerThan64Characters()
+    {
+        $class = new CanonicableTraitTestClass(str_repeat('a', 65));
+
+        $this->assertSame(str_repeat('a', 64), $class->getCanonicalValue());
+        $this->assertSame(64, strlen($class->getCanonicalValue()));
+    }
+
+    public function testCanonicableValueCannotBeEmpty()
+    {
+        $class = new CanonicableTraitTestClass('');
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Canonical value cannot be empty');
+
+        $class->getCanonicalValue();
+    }
+}
+
+class CanonicableTraitTestClass extends PublicationFieldValue implements Canonicable
+{
+    use CanonicableTrait;
+
+    protected static function parseInput(string $input): string
+    {
+        return $input;
+    }
+}