Clean up PublicationFieldTypes enum

packages/publications/src/Actions/SeedsPublicationFiles.php

@@ -95,7 +95,7 @@ protected function generateFieldData(PublicationFieldDefinition $field): string|
             'boolean' => rand(0, 100) < 50,
             'datetime' => $this->getDateTimeValue(),
             'float' => ((mt_rand() / mt_getrandmax()) * (200000)) + -100000,
-            'image' => 'https://picsum.photos/id/'.rand(1, 1000).'/400/400',
+            'media' => 'https://picsum.photos/id/'.rand(1, 1000).'/400/400',
             'integer' => rand(-100000, 100000),
             'string' => substr($this->fakeSentence(10), 0, rand(1, 255)),
             'tag' => $this->getTags($field->tagGroup),

packages/publications/src/Actions/ValidatesPublicationField.php

@@ -42,7 +42,7 @@ public function validate(mixed $input = null): array
 
     protected function makeDynamicRules(): array
     {
-        if ($this->fieldDefinition->type == PublicationFieldTypes::Image) {
+        if ($this->fieldDefinition->type == PublicationFieldTypes::Media) {
             $mediaFiles = PublicationService::getMediaForPubType($this->publicationType);
             $valueList = $mediaFiles->implode(',');
 

packages/publications/src/Commands/MakePublicationCommand.php

@@ -120,7 +120,7 @@ protected function captureFieldInput(PublicationFieldDefinition $field): ?Public
         return match ($field->type) {
             PublicationFieldTypes::Text => $this->captureTextFieldInput($field),
             PublicationFieldTypes::Array => $this->captureArrayFieldInput($field),
-            PublicationFieldTypes::Image => $this->captureImageFieldInput($field),
+            PublicationFieldTypes::Media => $this->captureMediaFieldInput($field),
             PublicationFieldTypes::Tag => $this->captureTagFieldInput($field),
             default => $this->captureOtherFieldInput($field),
         };
@@ -140,7 +140,7 @@ protected function captureArrayFieldInput(PublicationFieldDefinition $field): Pu
         return new PublicationFieldValue(PublicationFieldTypes::Array, InputStreamHandler::call());
     }
 
-    protected function captureImageFieldInput(PublicationFieldDefinition $field): ?PublicationFieldValue
+    protected function captureMediaFieldInput(PublicationFieldDefinition $field): ?PublicationFieldValue
     {
         $this->infoComment('Select file for image field', $field->name);
 
@@ -149,7 +149,7 @@ protected function captureImageFieldInput(PublicationFieldDefinition $field): ?P
             return $this->handleEmptyOptionsCollection($field, 'media file', "No media files found in directory _media/{$this->publicationType->getIdentifier()}/");
         }
 
-        return new PublicationFieldValue(PublicationFieldTypes::Image, $this->choice('Which file would you like to use?', $mediaFiles->toArray()));
+        return new PublicationFieldValue(PublicationFieldTypes::Media, $this->choice('Which file would you like to use?', $mediaFiles->toArray()));
     }
 
     protected function captureTagFieldInput(PublicationFieldDefinition $field): ?PublicationFieldValue

packages/publications/src/Models/PublicationFieldValue.php

@@ -57,7 +57,7 @@ public static function parseFieldValue(PublicationFieldTypes $fieldType, string|
             PublicationFieldTypes::Boolean => self::parseBooleanValue($value),
             PublicationFieldTypes::Integer => self::parseIntegerValue($value),
             PublicationFieldTypes::Float => self::parseFloatValue($value),
-            PublicationFieldTypes::Image => self::parseImageValue($value),
+            PublicationFieldTypes::Media => self::parseImageValue($value),
             PublicationFieldTypes::Array => self::parseArrayValue($value),
             PublicationFieldTypes::Text => self::parseTextValue($value),
             PublicationFieldTypes::Url => self::parseUrlValue($value),

packages/publications/src/PublicationFieldTypes.php

@@ -20,11 +20,11 @@ enum PublicationFieldTypes: string
     case Boolean = 'boolean';
     case Integer = 'integer';
     case Float = 'float';
-    case Image = 'image'; // TODO Rename to media and move down in the list
     case Array = 'array';
+    case Media = 'media';
     case Text = 'text';
-    case Url = 'url';
     case Tag = 'tag';
+    case Url = 'url';
 
     /** Get the default validation rules for this field type. */
     public function rules(): array
@@ -56,13 +56,13 @@ public static function getRules(self $type): array
             self::String => ['string'],
             self::Datetime => ['date'],
             self::Boolean => [new BooleanRule],
-            self::Integer => ['integer', 'numeric'],
+            self::Integer => ['integer'],
             self::Float => ['numeric'],
-            self::Image => [],
             self::Array => ['array'],
+            self::Media => ['string'],
             self::Text => ['string'],
-            self::Url => ['url'],
             self::Tag => [],
+            self::Url => ['url'],
         };
     }
 
@@ -75,8 +75,8 @@ public static function canonicable(): array
     {
         return [
             self::String,
-            self::Integer,
             self::Datetime,
+            self::Integer,
             self::Text,
         ];
     }

packages/publications/src/Validation/BooleanRule.php

@@ -11,6 +11,8 @@
  * Extended boolean rule that allows for 'true' and 'false' strings in order to support console inputs.
  *
  * @see https://github.com/illuminate/validation/blob/3f63f1046f67377a64779baaa86d7f1997b5f748/Concerns/ValidatesAttributes.php#L448-L453
+ *
+ * @todo See if we can set this dynamically in the validating command.
  */
 class BooleanRule implements InvokableRule
 {

packages/publications/tests/Feature/MakePublicationCommandTest.php

@@ -279,15 +279,15 @@ public function test_command_with_array_input()
         );
     }
 
-    public function test_command_with_image_input()
+    public function test_command_with_media_input()
     {
         $this->directory('_media/test-publication');
         $this->file('_media/test-publication/image.jpg');
         $this->makeSchemaFile([
             'canonicalField' => '__createdAt',
             'fields'         =>  [[
-                'type' => 'image',
-                'name' => 'image',
+                'type' => 'media',
+                'name' => 'media',
             ],
             ],
         ]);
@@ -297,10 +297,10 @@ public function test_command_with_image_input()
              ->assertExitCode(0);
 
         $this->assertDatedPublicationExists();
-        $this->assertCreatedPublicationMatterEquals('image: _media/test-publication/image.jpg');
+        $this->assertCreatedPublicationMatterEquals('media: _media/test-publication/image.jpg');
     }
 
-    public function test_image_input_selects_the_right_file()
+    public function test_media_input_selects_the_right_file()
     {
         $this->directory('_media/test-publication');
         $this->file('_media/test-publication/foo.jpg');
@@ -310,8 +310,8 @@ public function test_image_input_selects_the_right_file()
         $this->makeSchemaFile([
             'canonicalField' => '__createdAt',
             'fields'         =>  [[
-                'type' => 'image',
-                'name' => 'image',
+                'type' => 'media',
+                'name' => 'media',
             ],
             ],
         ]);
@@ -321,7 +321,7 @@ public function test_image_input_selects_the_right_file()
              ->assertExitCode(0);
 
         $this->assertDatedPublicationExists();
-        $this->assertCreatedPublicationMatterEquals('image: _media/test-publication/bar.png');
+        $this->assertCreatedPublicationMatterEquals('media: _media/test-publication/bar.png');
     }
 
     public function test_command_with_single_tag_input()
@@ -374,14 +374,14 @@ public function test_command_with_multiple_tag_inputs()
     - bar');
     }
 
-    public function test_image_input_with_no_images()
+    public function test_media_input_with_no_images()
     {
         config(['app.throw_on_console_exception' => false]);
         $this->makeSchemaFile([
             'canonicalField' => '__createdAt',
             'fields'         =>  [[
-                'type' => 'image',
-                'name' => 'image',
+                'type' => 'media',
+                'name' => 'media',
             ],
             ],
         ]);
@@ -395,13 +395,13 @@ public function test_image_input_with_no_images()
         $this->assertFileDoesNotExist(Hyde::path('test-publication/2022-01-01-000000.md'));
     }
 
-    public function test_image_input_with_no_images_but_skips()
+    public function test_media_input_with_no_files_but_skips()
     {
         $this->makeSchemaFile([
             'canonicalField' => '__createdAt',
             'fields'         =>  [[
-                'type' => 'image',
-                'name' => 'image',
+                'type' => 'media',
+                'name' => 'media',
             ],
             ],
         ]);
@@ -531,7 +531,7 @@ public function test_with_custom_validation_rules()
 
         $this->artisan('make:publication test-publication')
             ->expectsQuestion('Enter data for field </>[<comment>integer</comment>]', 'string')
-            ->expectsOutput('The integer must be a number.')
+            ->expectsOutput('The integer must be an integer.')
             ->expectsQuestion('Enter data for field </>[<comment>integer</comment>]', 15)
             ->expectsOutput('The integer must not be greater than 10.')
             ->expectsQuestion('Enter data for field </>[<comment>integer</comment>]', 5)

packages/publications/tests/Feature/MakePublicationTypeCommandTest.php

@@ -20,6 +20,7 @@ class MakePublicationTypeCommandTest extends TestCase
 {
     protected const selectPageSizeQuestion = 'How many links should be shown on the listing page? <fg=gray>(any value above 0 will enable <href=https://docs.hydephp.com/search?query=pagination>pagination</>)</>';
     protected const selectCanonicalNameQuestion = 'Choose a canonical name field <fg=gray>(this will be used to generate filenames, so the values need to be unique)</>';
+    protected const expectedEnumCases = ['String', 'Datetime', 'Boolean', 'Integer', 'Float', 'Array', 'Media', 'Text', 'Tag', 'Url'];
 
     protected function setUp(): void
     {
@@ -46,11 +47,11 @@ public function test_command_creates_publication_type()
                 'Boolean',
                 'Integer',
                 'Float',
-                'Image',
                 'Array',
+                'Media',
                 'Text',
-                'Url',
                 'Tag',
+                'Url',
             ], true)
             ->expectsConfirmation('Field #1 added! Add another field?')
 
@@ -203,7 +204,7 @@ public function testWithTagFieldInput()
         $this->artisan('make:publicationType "Test Publication"')
             ->expectsQuestion('Enter name for field #1', 'MyTag')
             ->expectsChoice('Enter type for field #1', 'Tag',
-                ['String', 'Datetime', 'Boolean', 'Integer', 'Float', 'Image', 'Array', 'Text', 'Url', 'Tag'])
+                self::expectedEnumCases)
             ->expectsChoice('Enter tag group for field #1', 'foo', ['bar', 'foo'], true)
 
             ->expectsConfirmation('Field #1 added! Add another field?')
@@ -247,7 +248,7 @@ public function testWithTagFieldInputButNoTags()
         $this->artisan('make:publicationType "Test Publication"')
             ->expectsQuestion('Enter name for field #1', 'MyTag')
             ->expectsChoice('Enter type for field #1', 'Tag',
-                ['String', 'Datetime', 'Boolean', 'Integer', 'Float', 'Image', 'Array', 'Text', 'Url', 'Tag'], true)
+                self::expectedEnumCases, true)
             ->expectsOutput('No tag groups have been added to tags.json')
             ->expectsConfirmation('Would you like to add some tags now?')
             ->expectsOutput('Error: Can not create a tag field without any tag groups defined in tags.json')
@@ -265,7 +266,7 @@ public function testWithTagFieldInputButNoTagsCanPromptToCreateTags()
         $this->artisan('make:publicationType "Test Publication"')
             ->expectsQuestion('Enter name for field #1', 'MyTag')
             ->expectsChoice('Enter type for field #1', 'Tag',
-                ['String', 'Datetime', 'Boolean', 'Integer', 'Float', 'Image', 'Array', 'Text', 'Url', 'Tag'])
+                self::expectedEnumCases)
             ->expectsOutput('No tag groups have been added to tags.json')
             ->expectsConfirmation('Would you like to add some tags now?', 'yes')
             ->expectsQuestion('Tag name', 'foo')

packages/publications/tests/Feature/PublicationFieldTypesEnumTest.php

@@ -25,21 +25,21 @@ public function testCases()
         $this->assertSame('url', PublicationFieldTypes::Url->value);
         $this->assertSame('array', PublicationFieldTypes::Array->value);
         $this->assertSame('text', PublicationFieldTypes::Text->value);
-        $this->assertSame('image', PublicationFieldTypes::Image->value);
+        $this->assertSame('media', PublicationFieldTypes::Media->value);
         $this->assertSame('tag', PublicationFieldTypes::Tag->value);
     }
 
     public function testGetRules()
     {
         $this->assertSame(['string'], PublicationFieldTypes::String->rules());
         $this->assertEquals([new BooleanRule()], PublicationFieldTypes::Boolean->rules());
-        $this->assertSame(['integer', 'numeric'], PublicationFieldTypes::Integer->rules());
+        $this->assertSame(['integer'], PublicationFieldTypes::Integer->rules());
         $this->assertSame(['numeric'], PublicationFieldTypes::Float->rules());
         $this->assertSame(['date'], PublicationFieldTypes::Datetime->rules());
         $this->assertSame(['url'], PublicationFieldTypes::Url->rules());
         $this->assertSame(['string'], PublicationFieldTypes::Text->rules());
         $this->assertSame(['array'], PublicationFieldTypes::Array->rules());
-        $this->assertSame([], PublicationFieldTypes::Image->rules());
+        $this->assertSame(['string'], PublicationFieldTypes::Media->rules());
         $this->assertSame([], PublicationFieldTypes::Tag->rules());
     }
 
@@ -56,11 +56,11 @@ public function testValuesReturnsArrayOfCaseValues()
             2 => 'boolean',
             3 => 'integer',
             4 => 'float',
-            5 => 'image',
-            6 => 'array',
+            5 => 'array',
+            6 => 'media',
             7 => 'text',
-            8 => 'url',
-            9 => 'tag',
+            8 => 'tag',
+            9 => 'url',
         ], PublicationFieldTypes::values());
     }
 
@@ -72,20 +72,20 @@ public function testNamesReturnsArrayOfCaseNames()
             2 => 'Boolean',
             3 => 'Integer',
             4 => 'Float',
-            5 => 'Image',
-            6 => 'Array',
+            5 => 'Array',
+            6 => 'Media',
             7 => 'Text',
-            8 => 'Url',
-            9 => 'Tag',
+            8 => 'Tag',
+            9 => 'Url',
         ], PublicationFieldTypes::names());
     }
 
     public function testCanonicable()
     {
         $this->assertSame([
             PublicationFieldTypes::String,
-            PublicationFieldTypes::Integer,
             PublicationFieldTypes::Datetime,
+            PublicationFieldTypes::Integer,
             PublicationFieldTypes::Text,
         ], PublicationFieldTypes::canonicable());
     }

packages/publications/tests/Feature/PublicationFieldValueTest.php

@@ -327,24 +327,24 @@ public function testUrlFieldWithInvalidInput()
         new PublicationFieldValue(PublicationFieldTypes::from('url'), 'foo');
     }
 
-    // ImageField tests
+    // MediaField tests
 
-    public function testImageFieldConstruct()
+    public function testMediaFieldConstruct()
     {
-        $field = $this->makeFieldType('image', 'foo');
+        $field = $this->makeFieldType('media', 'foo');
 
         $this->assertInstanceOf(PublicationFieldValue::class, $field);
-        $this->assertSame(PublicationFieldTypes::Image, $field->type);
+        $this->assertSame(PublicationFieldTypes::Media, $field->type);
     }
 
-    public function testImageFieldGetValue()
+    public function testMediaFieldGetValue()
     {
-        $this->assertSame('foo', $this->makeFieldType('image', 'foo')->getValue());
+        $this->assertSame('foo', $this->makeFieldType('media', 'foo')->getValue());
     }
 
-    public function testImageFieldToYaml()
+    public function testMediaFieldToYaml()
     {
-        $this->assertSame('foo', $this->getYaml(new PublicationFieldValue(PublicationFieldTypes::from('image'), 'foo')));
+        $this->assertSame('foo', $this->getYaml(new PublicationFieldValue(PublicationFieldTypes::from('media'), 'foo')));
     }
 
     // TagField tests
@@ -392,9 +392,9 @@ public function testDefaultValidationRules()
             'string' => ['string'],
             'datetime' => ['date'],
             'boolean' => [new BooleanRule],
-            'integer' => ['integer', 'numeric'],
+            'integer' => ['integer'],
             'float' => ['numeric'],
-            'image' => [],
+            'media' => ['string'],
             'array' => ['array'],
             'text' => ['string'],
             'url' => ['url'],

packages/publications/tests/Feature/SeedsPublicationFilesTest.php

@@ -94,16 +94,16 @@ public function testWithFloatType()
         $this->assertIsFloat($publication->matter('price'));
     }
 
-    public function testWithImageType()
+    public function testWithMediaType()
     {
-        $this->updateSchema('image', 'image');
+        $this->updateSchema('media', 'media');
         (new SeedsPublicationFiles($this->pubType))->create();
 
         $publication = $this->firstPublication();
 
         $this->assertBaseline($publication);
-        $this->assertIsString($publication->matter('image'));
-        $this->assertStringStartsWith('https://picsum.photos/id/', $publication->matter('image'));
+        $this->assertIsString($publication->matter('media'));
+        $this->assertStringStartsWith('https://picsum.photos/id/', $publication->matter('media'));
     }
 
     public function testWithIntegerType()