🎨 Improve the Block class (#227)

src/AcfComposer.php

@@ -96,13 +96,13 @@ public function boot(): void
 
         foreach ($this->composers as $namespace => $composers) {
             foreach ($composers as $i => $composer) {
-                $this->composers[$namespace][$i] = $composer->compose();
+                $this->composers[$namespace][$i] = $composer->handle();
             }
         }
 
         foreach ($this->deferredComposers as $namespace => $composers) {
             foreach ($composers as $index => $composer) {
-                $this->composers[$namespace][] = $composer->compose();
+                $this->composers[$namespace][] = $composer->handle();
             }
         }
 

src/Block.php

@@ -276,7 +276,15 @@ public function getStyle(): ?string
         return Str::of($this->block->className ?? null)
             ->matchAll('/is-style-(\S+)/')
             ->get(0) ??
-            Arr::get(collect($this->getStyles())->firstWhere('isDefault'), 'name');
+            Arr::get($this->getDefaultStyle(), 'name');
+    }
+
+    /**
+     * Retrieve the default style.
+     */
+    public function getDefaultStyle(): array
+    {
+        return collect($this->getStyles())->firstWhere('isDefault') ?? [];
     }
 
     /**
@@ -316,21 +324,65 @@ public function getInlineStyle(): string
     {
         return collect([
             'padding' => ! empty($this->block->style['spacing']['padding'])
-                ? collect($this->block->style['spacing']['padding'])->map(function ($value, $side) {
-                    return $this->formatCss($value, $side);
-                })->implode(' ')
+                ? collect($this->block->style['spacing']['padding'])
+                    ->map(fn ($value, $side) => $this->formatCss($value, $side))
+                    ->implode(' ')
                 : null,
+
             'margin' => ! empty($this->block->style['spacing']['margin'])
-                ? collect($this->block->style['spacing']['margin'])->map(function ($value, $side) {
-                    return $this->formatCss($value, $side, 'margin');
-                })->implode(' ')
+                ? collect($this->block->style['spacing']['margin'])
+                    ->map(fn ($value, $side) => $this->formatCss($value, $side, 'margin'))
+                    ->implode(' ')
                 : null,
+
             'color' => ! empty($this->block->style['color']['gradient'])
                 ? sprintf('background: %s;', $this->block->style['color']['gradient'])
                 : null,
         ])->filter()->implode(' ');
     }
 
+    /**
+     * Retrieve the block classes.
+     */
+    public function getClasses(): string
+    {
+        $classes = collect([
+            'slug' => Str::of($this->slug)->slug()->start('wp-block-')->toString(),
+
+            'className' => $this->block->className ?? null,
+
+            'align' => ! empty($this->block->align)
+                ? Str::start($this->block->align, 'align')
+                : null,
+
+            'backgroundColor' => ! empty($this->block->backgroundColor)
+                ? sprintf('has-background has-%s-background-color', $this->block->backgroundColor)
+                : null,
+
+            'textColor' => ! empty($this->block->textColor)
+                ? sprintf('has-%s-color', $this->block->textColor)
+                : null,
+
+            'gradient' => ! empty($this->block->gradient)
+                ? sprintf('has-%s-gradient-background', $this->block->gradient)
+                : null,
+        ]);
+
+        if ($alignText = $this->block->alignText ?? $this->block->align_text ?? null) {
+            $classes->add(Str::start($alignText, 'align-text-'));
+        }
+
+        if ($alignContent = $this->block->alignContent ?? $this->block->align_content ?? null) {
+            $classes->add(Str::start($alignContent, 'is-position-'));
+        }
+
+        if ($this->block->fullHeight ?? $this->block->full_height ?? null) {
+            $classes->add('full-height');
+        }
+
+        return $classes->filter()->implode(' ');
+    }
+
     /**
      * Handle the block template.
      */
@@ -360,17 +412,9 @@ public function compose(): ?self
             return null;
         }
 
-        if (! empty($this->name) && empty($this->slug)) {
-            $this->slug = Str::slug(Str::kebab($this->name));
-        }
-
-        if (empty($this->view)) {
-            $this->view = Str::start($this->slug, 'blocks.');
-        }
-
-        if (empty($this->namespace)) {
-            $this->namespace = Str::start($this->slug, $this->prefix);
-        }
+        $this->slug = $this->slug ?: Str::slug(Str::kebab($this->name));
+        $this->view = $this->view ?: Str::start($this->slug, 'blocks.');
+        $this->namespace = $this->namespace ?? Str::start($this->slug, $this->prefix);
 
         if (! Arr::has($this->fields, 'location.0.0')) {
             Arr::set($this->fields, 'location.0.0', [
@@ -469,7 +513,7 @@ public function toJson(): string
         ])->put('acf', [
             'mode' => $this->mode,
             'renderTemplate' => $this::class,
-        ]);
+        ])->put('name', $this->namespace);
 
         return $settings->filter()->toJson(JSON_PRETTY_PRINT);
     }
@@ -483,7 +527,7 @@ public function jsonPath(): string
     }
 
     /**
-     * Determine if the block has a JSON file.
+     * Determine if the Block has a JSON file.
      */
     public function hasJson(): bool
     {
@@ -512,40 +556,11 @@ public function render($block, $content = '', $preview = false, $post_id = 0, $w
 
         $this->post = get_post($post_id);
 
-        $this->classes = collect([
-            'slug' => Str::start(
-                Str::slug($this->slug),
-                'wp-block-'
-            ),
-            'align' => ! empty($this->block->align) ?
-                Str::start($this->block->align, 'align') :
-                false,
-            'align_text' => ! empty($this->supports['align_text']) ?
-                Str::start($this->block->align_text, 'align-text-') :
-                false,
-            'align_content' => ! empty($this->supports['align_content']) ?
-                Str::start($this->block->align_content, 'is-position-') :
-                false,
-            'full_height' => ! empty($this->supports['full_height'])
-                && ! empty($this->block->full_height) ?
-                'full-height' :
-                false,
-            'classes' => $this->block->className ?? false,
-            'backgroundColor' => ! empty($this->block->backgroundColor) ?
-                sprintf('has-background has-%s-background-color', $this->block->backgroundColor) :
-                false,
-            'textColor' => ! empty($this->block->textColor) ?
-                sprintf('has-%s-color', $this->block->textColor) :
-                false,
-            'gradient' => ! empty($this->block->gradient) ?
-                sprintf('has-%s-gradient-background', $this->block->gradient) :
-                false,
-        ])->filter()->implode(' ');
-
         $this->template = is_array($this->template)
             ? $this->handleTemplate($this->template)->toJson()
             : $this->template;
 
+        $this->classes = $this->getClasses();
         $this->style = $this->getStyle();
         $this->inlineStyle = $this->getInlineStyle();
 

src/Builder/FlexibleContentBuilder.php

@@ -63,11 +63,9 @@ class FlexibleContentBuilder extends FieldBuilder
      */
     public function addLayout($layout, $args = [])
     {
-        if ($layout instanceof FieldsBuilder) {
-            $layout = clone $layout;
-        } else {
-            $layout = Builder::make($layout, $args);
-        }
+        $layout = is_a($layout, FieldsBuilder::class)
+            ? clone $layout
+            : Builder::make($layout, $args);
 
         $layout = $this->initializeLayout($layout, $args);
 

src/Composer.php

@@ -6,11 +6,12 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Log1x\AcfComposer\Concerns\InteractsWithPartial;
+use Log1x\AcfComposer\Contracts\Composer as ComposerContract;
 use Log1x\AcfComposer\Contracts\Field as FieldContract;
 use Roots\Acorn\Application;
 use StoutLogic\AcfBuilder\FieldsBuilder;
 
-abstract class Composer implements FieldContract
+abstract class Composer implements ComposerContract, FieldContract
 {
     use InteractsWithPartial;
 
@@ -62,6 +63,36 @@ public static function make(AcfComposer $composer): self
         return new static($composer);
     }
 
+    /**
+     * Handle the Composer instance.
+     */
+    public function handle(): self
+    {
+        $this->beforeRegister();
+
+        $this->compose();
+
+        $this->afterRegister();
+
+        return $this;
+    }
+
+    /**
+     * Actions to run before registering the Composer.
+     */
+    public function beforeRegister(): void
+    {
+        //
+    }
+
+    /**
+     * Actions to run after registering the Composer.
+     */
+    public function afterRegister(): void
+    {
+        //
+    }
+
     /**
      * Register the field group with Advanced Custom Fields.
      */

src/Console/CacheCommand.php

@@ -47,9 +47,11 @@ public function handle()
         }
 
         if ($this->option('status')) {
-            return $this->composer->manifest()->exists()
-                ? $this->components->info('The <fg=blue>ACF Composer</> field groups are currently <fg=green;options=bold>cached</>.')
-                : $this->components->info('The <fg=blue>ACF Composer</> field groups are currently <fg=red;options=bold>not cached</>.');
+            $status = $this->composer->manifest()->exists()
+                ? '<fg=green;options=bold>cached</>'
+                : '<fg=red;options=bold>not cached</>';
+
+            return $this->components->info("<fg=blue>ACF Composer</> is currently {$status}.");
         }
 
         $composers = collect(
@@ -78,6 +80,6 @@ public function handle()
             ? $this->composer->manifest()->writeBlocks()
             : 0;
 
-        $this->components->info("Successfully cached <fg=blue>{$manifest}</> field(s) and <fg=blue>{$blocks}</> block(s).");
+        $this->components->info("Successfully cached <fg=blue>{$manifest}</> field group(s) and <fg=blue>{$blocks}</> block(s).");
     }
 }

src/Console/UpgradeCommand.php

@@ -71,7 +71,7 @@ public function handle()
 
         $this->components->bulletList($files);
 
-        if (! $this->components->confirm("Found <fg=blue>{$classes->count()}</> ACF Composer classes to upgrade. Do you wish to <fg=blue>continue</>?")) {
+        if (! $this->components->confirm("Found <fg=blue>{$classes->count()}</> ACF Composer classes to upgrade. Do you wish to <fg=blue>continue</>?", true)) {
             return $this->components->error('The ACF Composer upgrade has been <fg=red>cancelled</>.');
         }
 

src/Contracts/Composer.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Log1x\AcfComposer\Contracts;
+
+interface Composer
+{
+    /**
+     * Compose the fields.
+     *
+     * @return mixed
+     */
+    public function compose();
+}

src/Contracts/Field.php

@@ -7,7 +7,7 @@ interface Field
     /**
      * The field group.
      *
-     * @return \StoutLogic\AcfBuilder\FieldsBuilder|array
+     * @return \Log1x\AcfComposer\Builder|array
      */
     public function fields();
 }

src/Field.php

@@ -74,7 +74,7 @@ public function getFields(bool $cache = true): array
     /**
      * Compose and register the defined field groups with ACF.
      *
-     * @return void
+     * @return mixed
      */
     public function compose()
     {

src/Options.php

@@ -114,7 +114,7 @@ public function updatedMessage()
     /**
      * Compose and register the defined ACF field groups.
      *
-     * @return void
+     * @return mixed
      */
     public function compose()
     {

src/Partial.php

@@ -7,7 +7,7 @@ abstract class Partial extends Composer
     /**
      * Compose and register the defined field groups with ACF.
      *
-     * @return void
+     * @return mixed
      */
     public function compose()
     {

src/Widget.php

@@ -50,7 +50,7 @@ abstract class Widget extends Composer implements WidgetContract
     /**
      * Compose and register the defined ACF field groups.
      *
-     * @return void
+     * @return mixed
      */
     public function compose()
     {