Configuration improvements (#18)

Author: ryanmitchell

resources/views/edit.blade.php

@@ -1,10 +1,10 @@
 @extends('statamic::layout')
 
-@section('title', __('Config'))
+@section('title', $title)
 
 @section('content')
     <publish-form
-        title='Configuration'
+        title='{{ $title }}'
         action={{ $route }}
         :blueprint='@json($blueprint)'
         :meta='@json($meta)'

src/ConfigController.php

@@ -4,6 +4,7 @@
 
 use Edalzell\Forma\Events\ConfigSaved;
 use Illuminate\Http\Request;
+use Statamic\Extend\Addon;
 use Statamic\Facades\Blueprint as BlueprintAPI;
 use Statamic\Facades\Path;
 use Statamic\Facades\YAML;
@@ -17,7 +18,9 @@ public function edit(Request $request)
     {
         $slug = $request->segment(2);
 
-        $blueprint = $this->getBlueprint($slug);
+        $addon = Forma::findBySlug($slug);
+
+        $blueprint = $this->getBlueprint($addon);
 
         $fields = $blueprint
             ->fields()
@@ -28,6 +31,7 @@ public function edit(Request $request)
             'blueprint' => $blueprint->toPublishArray(),
             'meta' => $fields->meta(),
             'route' => cp_route("{$slug}.config.update", ['handle' => $slug]),
+            'title' => $this->cpTitle($addon),
             'values' => $fields->values(),
         ]);
     }
@@ -36,7 +40,9 @@ public function update(Request $request)
     {
         $slug = $request->segment(2);
 
-        $blueprint = $this->getBlueprint($slug);
+        $addon = Forma::findBySlug($slug);
+
+        $blueprint = $this->getBlueprint($addon);
 
         // Get a Fields object, and populate it with the submitted values.
         $fields = $blueprint->fields()->addValues($request->all());
@@ -47,18 +53,22 @@ public function update(Request $request)
 
         $data = $this->postProcess($fields->process()->values()->toArray());
 
-        ConfigWriter::writeMany($slug, $data);
+        $write = ConfigWriter::writeMany($slug, $data);
 
-        ConfigSaved::dispatch($data);
+        ConfigSaved::dispatch($data, $addon);
     }
 
-    private function getBlueprint(string $slug): Blueprint
+    private function getBlueprint(Addon $addon): Blueprint
     {
-        $addon = Forma::findBySlug($slug);
-
         $path = Path::assemble($addon->directory(), 'resources', 'blueprints', 'config.yaml');
 
-        return BlueprintAPI::makeFromFields(YAML::file($path)->parse());
+        $yaml = YAML::file($path)->parse();
+
+        if ($yaml['tabs'] ?? false) {
+            return BlueprintAPI::make()->setContents($yaml);
+        }
+
+        return BlueprintAPI::makeFromFields($yaml);
     }
 
     protected function postProcess(array $values): array
@@ -70,4 +80,19 @@ protected function preProcess(string $handle): array
     {
         return config($handle);
     }
+
+    public static function cpIcon()
+    {
+        return 'settings-horizontal';
+    }
+
+    public static function cpSection()
+    {
+        return __('Settings');
+    }
+
+    private function cpTitle(Addon $addon)
+    {
+        return __(':name Settings', ['name' => $addon->name()]);
+    }
 }

src/Events/ConfigSaved.php

@@ -4,12 +4,13 @@
 
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
+use Statamic\Extend\Addon;
 
 class ConfigSaved
 {
     use Dispatchable, SerializesModels;
 
-    public function __construct(public array $config)
+    public function __construct(public array $config, public Addon $addon)
     {
     }
 }

src/FormaAddon.php

@@ -8,6 +8,7 @@
 use Statamic\Facades\Addon as AddonAPI;
 use Statamic\Facades\Blink;
 use Statamic\Facades\CP\Nav as NavAPI;
+use Statamic\Facades\Permission;
 use Statamic\Statamic;
 
 class FormaAddon
@@ -24,6 +25,7 @@ public function __construct(string $package, ?string $controller)
     public function boot()
     {
         $this->bootNav();
+        $this->bootPermissions();
         $this->registerRoutes();
     }
 
@@ -33,12 +35,25 @@ private function bootNav()
             return;
         }
 
+        $controllerInstance = app($this->controller);
+
         NavAPI::extend(fn (Nav $nav) => $nav
             ->content($addon->name())
-            ->section('Settings')
-            ->can('manage addon settings')
+            ->section($controllerInstance::cpSection())
+            ->can('manage '.$addon->slug().' settings')
             ->route($addon->slug() . '.config.edit')
-            ->icon('settings-horizontal'));
+            ->icon($controllerInstance::cpIcon())
+        );
+    }
+
+    private function bootPermissions()
+    {
+        if (! $addon = $this->getAddon()) {
+            return;
+        }
+
+        Permission::register('manage '.$addon->slug().' settings')
+            ->label('Manage '.$addon->name().' Settings');
     }
 
     private function getAddon(): ?Addon

src/ServiceProvider.php

@@ -2,7 +2,6 @@
 
 namespace Edalzell\Forma;
 
-use Statamic\Facades\Permission;
 use Statamic\Providers\AddonServiceProvider;
 use Statamic\Statamic;
 
@@ -18,14 +17,7 @@ public function boot()
         parent::boot();
 
         Statamic::booted(function () {
-            $this->bootPermissions();
             Forma::all()->each->boot();
         });
     }
-
-    private function bootPermissions()
-    {
-        Permission::register('manage addon settings')
-            ->label('Manage Addon Settings');
-    }
 }