wip refactor html fields templates

antoine · antoine · commit 633a04452c04 · 2024-11-04T18:45:01.000+01:00
diff --git a/demo/app/Sharp/Posts/Blocks/AbstractPostBlockForm.php b/demo/app/Sharp/Posts/Blocks/AbstractPostBlockForm.php
@@ -24,7 +24,12 @@ public function buildFormFields(FieldsContainer $formFields): void
         $formFields
             ->addField(
                 SharpFormHtmlField::make('type')
-                    ->setInlineTemplate('Post block type: <strong>{{name}}</strong><div class="small" v-if="help">{{help}}</div>'),
+                    ->setTemplate(<<<'blade'
+                        Post block type: <strong>{{ $name }}</strong>
+                        @if($help)
+                            <div><small>{{ $help }}</small></div>
+                        @endif'
+                    blade),
             );
 
         if ($field = $this->getContentField()) {
diff --git a/demo/app/Sharp/Posts/Commands/ComposeEmailWithPostsWizardCommand.php b/demo/app/Sharp/Posts/Commands/ComposeEmailWithPostsWizardCommand.php
@@ -121,7 +121,7 @@ public function buildFormFieldsForStepChooseRecipients(FieldsContainer $formFiel
         $formFields
             ->addField(
                 SharpFormHtmlField::make('message')
-                    ->setInlineTemplate('<div style="max-height: 100px; overflow: auto; border: 1px solid #ddd; padding: 10px 15px; font-size: .85em;" v-html="text"></div>')
+                    ->setTemplate('<div style="max-height: 100px; overflow: auto; border: 1px solid #ddd; padding: 10px 15px; font-size: .85em;">{!! $text !!}</div>')
                     ->setLabel('Message'),
             )
             ->addField(
diff --git a/demo/app/Sharp/TestForm/TestForm.php b/demo/app/Sharp/TestForm/TestForm.php
@@ -104,7 +104,7 @@ public function buildFormFields(FieldsContainer $formFields): void
             ->addField(
                 SharpFormHtmlField::make('html')
                     ->setLabel('Html')
-                    ->setInlineTemplate('Your name is <strong>{{name}}</strong>'),
+                    ->setTemplate('Your name is <strong>{{ $name }}</strong>'),
             )
             ->addField(
                 SharpFormListField::make('list')
diff --git a/resources/js/form/components/fields/Html.vue b/resources/js/form/components/fields/Html.vue
@@ -1,5 +1,4 @@
 <script setup lang="ts" >
-    import { TemplateRenderer } from '@/components';
     import { FormHtmlFieldData } from "@/types";
     import FormFieldLayout from "@/form/components/FormFieldLayout.vue";
     import { FormFieldProps } from "@/form/types";
@@ -9,11 +8,7 @@
 
 <template>
     <FormFieldLayout v-bind="props">
-        <div class="text-sm">
-            <TemplateRenderer
-                :template="field.template"
-                :template-data="value"
-            />
+        <div class="text-sm" v-html="props.value">
         </div>
     </FormFieldLayout>
 </template>
diff --git a/resources/js/form/components/fields/list/List.vue b/resources/js/form/components/fields/list/List.vue
@@ -73,8 +73,8 @@
     });
 
     let itemKeyIndex = 0;
-    const itemKey = Symbol('itemKey');
-    const errorIndex = Symbol('errorIndex');
+    const itemKey = Symbol('itemKey') as unknown as string;
+    const errorIndex = Symbol('errorIndex') as unknown as string;
 
     watch(() => form.errors, () => {
         emit('input', props.value?.map(((item, index) => ({ ...item, [errorIndex]: index }))));
diff --git a/src/Auth/TwoFactor/Commands/Activate2faViaTotpWizardCommandTrait.php b/src/Auth/TwoFactor/Commands/Activate2faViaTotpWizardCommandTrait.php
@@ -86,7 +86,7 @@ protected function buildFormFieldsForStepConfirm(FieldsContainer $formFields): v
             ->addField(
                 SharpFormHtmlField::make('qr')
                     ->setLabel(trans('sharp::auth.2fa.totp.commands.activate.qrcode_field_label'))
-                    ->setInlineTemplate('<div style="text-align: center; margin: 1em 0;" v-html="svg"></div>')
+                    ->setTemplate('<div style="text-align: center; margin: 1em 0;">{!! $svg !!}</div>')
             )
             ->addField(
                 SharpFormTextField::make('code')
diff --git a/src/Form/Fields/Formatters/HtmlFormatter.php b/src/Form/Fields/Formatters/HtmlFormatter.php
@@ -3,9 +3,18 @@
 namespace Code16\Sharp\Form\Fields\Formatters;
 
 use Code16\Sharp\Form\Fields\SharpFormField;
+use Code16\Sharp\Form\Fields\SharpFormHtmlField;
 
 class HtmlFormatter extends AbstractSimpleFormatter
 {
+    /**
+     * @param SharpFormHtmlField $field
+     */
+    public function toFront(SharpFormField $field, $value)
+    {
+        return $value ? $field->render($value) : null;
+    }
+    
     public function fromFront(SharpFormField $field, string $attribute, $value)
     {
         return null;
diff --git a/src/Form/Fields/SharpFormHtmlField.php b/src/Form/Fields/SharpFormHtmlField.php
@@ -3,56 +3,38 @@
 namespace Code16\Sharp\Form\Fields;
 
 use Code16\Sharp\Form\Fields\Formatters\HtmlFormatter;
-use Code16\Sharp\Form\Fields\Utils\SharpFormFieldWithTemplates;
+use Illuminate\Contracts\View\View;
+use Illuminate\Support\Facades\Blade;
 
 class SharpFormHtmlField extends SharpFormField
 {
-    use SharpFormFieldWithTemplates {
-        setTemplatePath as protected parentSetTemplatePath;
-        setInlineTemplate as protected parentSetInlineTemplate;
-        template as protected parentTemplate;
-    }
-
     const FIELD_TYPE = 'html';
-
+    
+    private View|string $template;
+    
     public static function make(string $key): self
     {
         return new static($key, static::FIELD_TYPE, new HtmlFormatter);
     }
-
-    public function setTemplatePath(string $templatePath): self
-    {
-        return $this->parentSetTemplatePath($templatePath, 'html');
-    }
-
-    public function setInlineTemplate(string $template): self
-    {
-        return $this->parentSetInlineTemplate($template, 'html');
-    }
-
-    public function setAdditionalTemplateData(array $data): self
-    {
-        return $this->setTemplateData($data);
-    }
-
-    public function template(): ?string
+    
+    public function toArray(): array
     {
-        return $this->parentTemplate('html');
+        return parent::buildArray([]);
     }
-
-    protected function validationRules(): array
+    
+    public function setTemplate(View|string $template): self
     {
-        return [
-            'template' => 'required',
-            'templateData' => 'nullable|array',
-        ];
+        $this->template = $template;
+        
+        return $this;
     }
-
-    public function toArray(): array
+    
+    public function render(array $data): string
     {
-        return parent::buildArray([
-            'template' => $this->template(),
-            'templateData' => $this->additionalTemplateData,
-        ]);
+        if (is_string($this->template)) {
+            return Blade::render($this->template, $data);
+        }
+        
+        return $this->template->with($data)->render();
     }
 }
diff --git a/src/Form/Fields/SharpFormListField.php b/src/Form/Fields/SharpFormListField.php
@@ -3,7 +3,6 @@
 namespace Code16\Sharp\Form\Fields;
 
 use Code16\Sharp\Form\Fields\Formatters\ListFormatter;
-use Code16\Sharp\Form\Fields\Utils\SharpFormFieldWithTemplates;
 
 class SharpFormListField extends SharpFormField
 {
diff --git a/src/Form/Fields/Utils/SharpFormFieldWithTemplates.php b/src/Form/Fields/Utils/SharpFormFieldWithTemplates.php
diff --git a/src/Show/Fields/Formatters/HtmlFormatter.php b/src/Show/Fields/Formatters/HtmlFormatter.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Code16\Sharp\Show\Fields\Formatters;
+
+use Code16\Sharp\Form\Fields\Formatters\AbstractSimpleFormatter;
+use Code16\Sharp\Form\Fields\SharpFormField;
+use Code16\Sharp\Form\Fields\SharpFormHtmlField;
+use Code16\Sharp\Show\Fields\SharpShowField;
+use Code16\Sharp\Show\Fields\SharpShowHtmlField;
+
+class HtmlFormatter extends SharpShowFieldFormatter
+{
+    /**
+     * @param SharpShowHtmlField $field
+     */
+    public function toFront(SharpShowField $field, $value)
+    {
+        return $value ? $field->render($value) : null;
+    }
+}
diff --git a/src/Show/Fields/SharpShowHtmlField.php b/src/Show/Fields/SharpShowHtmlField.php
@@ -2,65 +2,47 @@
 
 namespace Code16\Sharp\Show\Fields;
 
-use Code16\Sharp\Form\Fields\Utils\SharpFormFieldWithTemplates;
+use Code16\Sharp\Show\Fields\Formatters\HtmlFormatter;
+use Illuminate\Contracts\View\View;
+use Illuminate\Support\Facades\Blade;
 
 class SharpShowHtmlField extends SharpShowField
 {
-    use SharpFormFieldWithTemplates {
-        setTemplatePath as protected parentSetTemplatePath;
-        setInlineTemplate as protected parentSetInlineTemplate;
-        template as protected parentTemplate;
-    }
-
     const FIELD_TYPE = 'html';
-
+    
     protected ?string $label = null;
-
+    private View|string $template;
+    
     public static function make(string $key): SharpShowHtmlField
     {
-        return new static($key, static::FIELD_TYPE);
+        return new static($key, static::FIELD_TYPE, new HtmlFormatter());
     }
-
+    
     public function setLabel(string $label): self
     {
         $this->label = $label;
-
+        
         return $this;
     }
-
-    public function setTemplatePath(string $templatePath): self
-    {
-        return $this->parentSetTemplatePath($templatePath, 'html');
-    }
-
-    public function setInlineTemplate(string $template): self
-    {
-        return $this->parentSetInlineTemplate($template, 'html');
-    }
-
-    public function setAdditionalTemplateData(array $data): self
-    {
-        return $this->setTemplateData($data);
-    }
-
-    public function template(): ?string
+    
+    public function toArray(): array
     {
-        return $this->parentTemplate('html');
+        return parent::buildArray([]);
     }
-
-    protected function validationRules(): array
+    
+    public function setTemplate(View|string $template): self
     {
-        return [
-            'template' => 'required',
-            'templateData' => 'nullable|array',
-        ];
+        $this->template = $template;
+        
+        return $this;
     }
-
-    public function toArray(): array
+    
+    public function render(array $data): string
     {
-        return parent::buildArray([
-            'template' => $this->template(),
-            'templateData' => $this->additionalTemplateData,
-        ]);
+        if (is_string($this->template)) {
+            return Blade::render($this->template, $data);
+        }
+        
+        return $this->template->with($data)->render();
     }
 }
diff --git a/tests/Http/ShowControllerTest.php b/tests/Http/ShowControllerTest.php
@@ -130,7 +130,7 @@ public function find($id): array
         public function buildShowFields(FieldsContainer $showFields): void
         {
             $showFields->addField(SharpShowTextField::make('name'))
-                ->addField(SharpShowHtmlField::make('bio')->setInlineTemplate('<div></div>'));
+                ->addField(SharpShowHtmlField::make('bio')->setTemplate('<div></div>'));
         }
     });
 
@@ -154,7 +154,7 @@ public function buildShowFields(FieldsContainer $showFields): void
         public function buildShowFields(FieldsContainer $showFields): void
         {
             $showFields->addField(SharpShowTextField::make('name'))
-                ->addField(SharpShowHtmlField::make('bio')->setInlineTemplate('<div></div>'));
+                ->addField(SharpShowHtmlField::make('bio')->setTemplate('<div></div>'));
         }
 
         public function buildShowLayout(ShowLayout $showLayout): void
diff --git a/tests/Unit/Form/Eloquent/SharpFormEloquentUpdaterTest.php b/tests/Unit/Form/Eloquent/SharpFormEloquentUpdaterTest.php
@@ -97,7 +97,7 @@ public function update($id, array $data)
 
         public function buildFormFields(FieldsContainer $formFields): void
         {
-            $formFields->addField(SharpFormHtmlField::make('name')->setInlineTemplate('HTML'));
+            $formFields->addField(SharpFormHtmlField::make('name')->setTemplate('HTML'));
         }
 
         public function update($id, array $data)
diff --git a/tests/Unit/Form/Fields/Formatters/HtmlFormatterTest.php b/tests/Unit/Form/Fields/Formatters/HtmlFormatterTest.php
@@ -7,11 +7,11 @@
 it('allows to format value to front', function () {
     $value = Str::random();
 
-    $this->assertEquals($value, (new HtmlFormatter())->toFront(SharpFormHtmlField::make('html'), $value));
+    expect((new HtmlFormatter())->toFront(SharpFormHtmlField::make('html')->setTemplate('{{ $text }}'), ['text' => $value]))
+        ->toEqual($value);
 });
 
 it('allows to format value from front', function () {
-    $this->assertNull(
-        (new HtmlFormatter())->fromFront(SharpFormHtmlField::make('html'), 'attribute', Str::random()),
-    );
+    expect((new HtmlFormatter())->fromFront(SharpFormHtmlField::make('html'), 'attribute', Str::random()))
+        ->toBeNull();
 });
diff --git a/tests/Unit/Form/Fields/SharpFormHtmlFieldTest.php b/tests/Unit/Form/Fields/SharpFormHtmlFieldTest.php
@@ -5,7 +5,7 @@
 
 it('allows to define inline template', function () {
     $defaultFormField = SharpFormHtmlField::make('html')
-        ->setInlineTemplate('<b>test</b>');
+        ->setTemplate('<b>test</b>');
 
     expect($defaultFormField->toArray())
         ->toEqual([
@@ -22,15 +22,3 @@
     $defaultFormField->toArray();
 });
 
-it('allows to define templateData', function () {
-    $formField = SharpFormHtmlField::make('html')
-        ->setInlineTemplate('<b>test</b>')
-        ->setAdditionalTemplateData([
-            'lang' => ['fr', 'de'],
-        ]);
-
-    expect($formField->toArray())
-        ->toHaveKey('templateData', [
-            'lang' => ['fr', 'de'],
-        ]);
-});
diff --git a/tests/Unit/Show/Fields/Formatters/HtmlFormatterTest.php b/tests/Unit/Show/Fields/Formatters/HtmlFormatterTest.php

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public function buildFormFieldsForStepChooseRecipients(FieldsContainer $formFiel`
`121`	`121`	`$formFields`
`122`	`122`	`->addField(`
`123`	`123`	`SharpFormHtmlField::make('message')`
`124`		`- ->setInlineTemplate('<div style="max-height: 100px; overflow: auto; border: 1px solid #ddd; padding: 10px 15px; font-size: .85em;" v-html="text"></div>')`
	`124`	`+ ->setTemplate('<div style="max-height: 100px; overflow: auto; border: 1px solid #ddd; padding: 10px 15px; font-size: .85em;">{!! $text !!}</div>')`
`125`	`125`	`->setLabel('Message'),`
`126`	`126`	`)`
`127`	`127`	`->addField(`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public function buildFormFields(FieldsContainer $formFields): void`
`104`	`104`	`->addField(`
`105`	`105`	`SharpFormHtmlField::make('html')`
`106`	`106`	`->setLabel('Html')`
`107`		`- ->setInlineTemplate('Your name is <strong>{{name}}</strong>'),`
	`107`	`+ ->setTemplate('Your name is <strong>{{ $name }}</strong>'),`
`108`	`108`	`)`
`109`	`109`	`->addField(`
`110`	`110`	`SharpFormListField::make('list')`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ protected function buildFormFieldsForStepConfirm(FieldsContainer $formFields): v`
`86`	`86`	`->addField(`
`87`	`87`	`SharpFormHtmlField::make('qr')`
`88`	`88`	`->setLabel(trans('sharp::auth.2fa.totp.commands.activate.qrcode_field_label'))`
`89`		`- ->setInlineTemplate('<div style="text-align: center; margin: 1em 0;" v-html="svg"></div>')`
	`89`	`+ ->setTemplate('<div style="text-align: center; margin: 1em 0;">{!! $svg !!}</div>')`
`90`	`90`	`)`
`91`	`91`	`->addField(`
`92`	`92`	`SharpFormTextField::make('code')`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`namespace Code16\Sharp\Form\Fields;`
`4`	`4`
`5`	`5`	`use Code16\Sharp\Form\Fields\Formatters\ListFormatter;`
`6`		`-use Code16\Sharp\Form\Fields\Utils\SharpFormFieldWithTemplates;`
`7`	`6`
`8`	`7`	`class SharpFormListField extends SharpFormField`
`9`	`8`	`{`