Simplify the PublicationField class

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

@@ -68,7 +68,7 @@ public function safeHandle(): int
                 foreach ($publication->type->fields as $field) {
                     $countFields++;
                     $fieldName = $field['name'];
-                    $pubTypeField = new PublicationField($field['type'], $fieldName, $field['tagGroup'] ?? null, $pubType);
+                    $pubTypeField = new PublicationField($field['type'], $fieldName, $field['tagGroup'] ?? null);
 
                     try {
                         if ($verbose) {
@@ -79,8 +79,11 @@ public function safeHandle(): int
                             throw new Exception("Field [$fieldName] is missing from publication");
                         }
 
-                        $pubTypeField->validate($publication->matter->{$fieldName} ?? null,
-                                                $publicationFieldRules->{$fieldName} ?? null);
+                        $pubTypeField->validate(
+                            $publication->matter->{$fieldName} ?? null,
+                            $publicationFieldRules->{$fieldName} ?? null,
+                            $pubType
+                        );
                         $this->output->writeln(" <fg=green>$checkmark</>");
                     } catch (Exception $e) {
                         $countErrors++;

packages/framework/src/Framework/Features/Publications/Models/PublicationField.php

@@ -4,6 +4,7 @@
 
 namespace Hyde\Framework\Features\Publications\Models;
 
+use function array_filter;
 use function collect;
 use Hyde\Framework\Features\Publications\PublicationFieldTypes;
 use Hyde\Framework\Features\Publications\PublicationService;
@@ -26,35 +27,35 @@ class PublicationField implements SerializableContract
     public readonly PublicationFieldTypes $type;
     public readonly string $name;
     public readonly ?string $tagGroup;
-    public readonly ?PublicationType $publicationType; // Only used for validation command, interactive command doesn't need this
 
     public static function fromArray(array $array): static
     {
         return new static(...$array);
     }
 
-    public function __construct(PublicationFieldTypes|string $type, string $name, ?string $tagGroup = null, PublicationType $publicationType = null)
+    public function __construct(PublicationFieldTypes|string $type, string $name, ?string $tagGroup = null)
     {
         $this->type = $type instanceof PublicationFieldTypes ? $type : PublicationFieldTypes::from(strtolower($type));
         $this->name = Str::kebab($name);
         $this->tagGroup = $tagGroup;
-        $this->publicationType = $publicationType;
     }
 
     public function toArray(): array
     {
-        return [
+        return array_filter([
             'type' => $this->type->value,
             'name' => $this->name,
             'tagGroup' => $this->tagGroup,
-        ];
+        ]);
     }
 
     /**
+     * @param  \Hyde\Framework\Features\Publications\Models\PublicationType|null  $publicationType  Required only when using the 'image' type.
+     *
      * @see \Hyde\Framework\Testing\Unit\PublicationFieldTypeValidationRulesTest
      * @see https://laravel.com/docs/9.x/validation#available-validation-rules
      */
-    public function getValidationRules(bool $reload = true): Collection
+    public function getValidationRules(?PublicationType $publicationType = null): Collection
     {
         $defaultRules = Collection::create(PublicationFieldTypes::values());
         $fieldRules = Collection::create($defaultRules->get($this->type->value));
@@ -75,12 +76,12 @@ public function getValidationRules(bool $reload = true): Collection
             case 'text':
                 break;
             case 'image':
-                $mediaFiles = PublicationService::getMediaForPubType($this->publicationType, $reload);
+                $mediaFiles = PublicationService::getMediaForPubType($publicationType);
                 $valueList = $mediaFiles->implode(',');
                 $fieldRules->add("in:$valueList");
                 break;
             case 'tag':
-                $tagValues = PublicationService::getValuesForTagName($this->tagGroup, $reload) ?? collect([]);
+                $tagValues = PublicationService::getValuesForTagName($this->tagGroup) ?? collect([]);
                 $valueList = $tagValues->implode(',');
                 $fieldRules->add("in:$valueList");
                 break;
@@ -92,10 +93,11 @@ public function getValidationRules(bool $reload = true): Collection
         return $fieldRules;
     }
 
-    public function validate(mixed $input = null, Collection $fieldRules = null): array
+    /** @param \Hyde\Framework\Features\Publications\Models\PublicationType|null $publicationType Required only when using the 'image' type. */
+    public function validate(mixed $input = null, Collection $fieldRules = null, ?PublicationType $publicationType = null): array
     {
         if (! $fieldRules) {
-            $fieldRules = $this->getValidationRules(false);
+            $fieldRules = $this->getValidationRules($publicationType);
         }
 
         $validator = validator([$this->name => $input], [$this->name => $fieldRules->toArray()]);

packages/framework/src/Framework/Features/Publications/Models/PublicationType.php

@@ -106,15 +106,12 @@ public function getFields(): Collection
         return Collection::create($result, false);
     }
 
-    /**
-     * @param  bool  $reload
-     * @return \Rgasch\Collection\Collection<string, \Rgasch\Collection\Collection>
-     */
-    public function getFieldRules(bool $reload = false): Collection
+    /** @return \Rgasch\Collection\Collection<string, \Rgasch\Collection\Collection> */
+    public function getFieldRules(): Collection
     {
         return Collection::create(
-            $this->getFields()->mapWithKeys(function (PublicationField $field) use ($reload) {
-                return [$field->name => $field->getValidationRules($reload)];
+            $this->getFields()->mapWithKeys(function (PublicationField $field) {
+                return [$field->name => $field->getValidationRules($this)];
             }), false);
     }
 

packages/framework/tests/Feature/Commands/MakePublicationTypeCommandTest.php

@@ -75,8 +75,7 @@ public function test_command_creates_publication_type()
                 "fields": [
                     {
                         "type": "string",
-                        "name": "publication-title",
-                        "tagGroup": null
+                        "name": "publication-title"
                     }
                 ]
             }

packages/framework/tests/Feature/PublicationFieldTest.php

@@ -16,7 +16,7 @@ class PublicationFieldTest extends TestCase
 {
     public function test_can_instantiate_class()
     {
-        $field = $this->makeField();
+        $field = new PublicationField('string', 'test');
         $this->assertInstanceOf(PublicationField::class, $field);
 
         $this->assertSame(PublicationFieldTypes::String, $field->type);
@@ -41,13 +41,26 @@ public function test_can_get_field_as_array()
         $this->assertSame([
             'type' => 'string',
             'name' => 'test',
-            'tagGroup' => null,
-        ], $this->makeField()->toArray());
+        ], (new PublicationField('string', 'test'))->toArray());
+    }
+
+    public function test_can_get_field_with_tag_group_as_array()
+    {
+        $this->assertSame([
+            'type' => 'string',
+            'name' => 'test',
+            'tagGroup' => 'foo',
+        ], (new PublicationField('string', 'test', 'foo'))->toArray());
     }
 
     public function test_can_encode_field_as_json()
     {
-        $this->assertSame('{"type":"string","name":"test","tagGroup":null}', json_encode($this->makeField()));
+        $this->assertSame('{"type":"string","name":"test"}', json_encode(new PublicationField('string', 'test')));
+    }
+
+    public function test_can_encode_field_with_tag_group_as_json()
+    {
+        $this->assertSame('{"type":"string","name":"test","tagGroup":"foo"}', json_encode(new PublicationField('string', 'test', 'foo')));
     }
 
     public function test_can_construct_type_using_enum_case()
@@ -85,9 +98,4 @@ public function test_validate_input_against_rules()
     {
         $this->markTestIncomplete('TODO: Implement this method.');
     }
-
-    protected function makeField(): PublicationField
-    {
-        return new PublicationField('string', 'test');
-    }
 }

packages/framework/tests/Unit/PublicationFieldValidationRulesTest.php

@@ -79,7 +79,7 @@ public function testGetRulesForImage()
         $this->directory('_media/foo');
         $this->file('_media/foo/bar.jpg');
         $this->file('_media/foo/baz.png');
-        $rules = (new PublicationField('image', 'myImage', null, publicationType: new PublicationType('foo')))->getValidationRules();
+        $rules = (new PublicationField('image', 'myImage'))->getValidationRules(publicationType: new PublicationType('foo'));
         $this->assertSame(['in:_media/foo/bar.jpg,_media/foo/baz.png'], $rules->toArray());
     }