🎨 Remove the need for providing a key on modules

roots · Dec 21, 2023 · f9db4bc · f9db4bc
1 parent dd21915
commit f9db4bc
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 27 deletions.
diff --git a/src/Modules/AbstractModule.php b/src/Modules/AbstractModule.php
@@ -3,6 +3,7 @@
 namespace Roots\AcornPretty\Modules;
 
 use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 use Roots\Acorn\Application;
 use Roots\AcornPretty\Contracts\Module;
 
@@ -13,11 +14,6 @@ abstract class AbstractModule implements Module
      */
     protected Application $app;
 
-    /**
-     * The module key.
-     */
-    protected string $key = '';
-
     /**
      * The module config.
      */
@@ -28,14 +24,8 @@ abstract class AbstractModule implements Module
      */
     public function __construct(Application $app, Collection $config)
     {
-        if (empty($this->key)) {
-            throw new LifecycleException(
-                sprintf('Module %s is missing the key property.', get_class($this))
-            );
-        }
-
         $this->app = $app;
-        $this->config = $config->get($this->key);
+        $this->config = $config->get($this->getKey());
 
         $this->boot();
     }
@@ -71,6 +61,19 @@ protected function enabled(): bool
             (! is_admin() || wp_doing_ajax());
     }
 
+    /**
+     * Get the module key.
+     */
+    protected function getKey(): string
+    {
+        $class = get_class($this);
+
+        return Str::of($class)
+            ->afterLast('\\')
+            ->beforeLast('Module')
+            ->snake('-');
+    }
+
     /**
      * Filter a hook handled by a method.
      */

diff --git a/src/Modules/CleanUpModule.php b/src/Modules/CleanUpModule.php
@@ -7,11 +7,6 @@
 
 class CleanUpModule extends AbstractModule
 {
-    /**
-     * The module key.
-     */
-    protected string $key = 'clean-up';
-
     /**
      * Handle the module.
      */

diff --git a/src/Modules/NiceSearchModule.php b/src/Modules/NiceSearchModule.php
@@ -4,11 +4,6 @@
 
 class NiceSearchModule extends AbstractModule
 {
-    /**
-     * The module key.
-     */
-    protected string $key = 'nice-search';
-
     /**
      * The default search endpoint.
      */

diff --git a/src/Modules/RelativeUrlsModule.php b/src/Modules/RelativeUrlsModule.php
@@ -6,11 +6,6 @@
 
 class RelativeUrlsModule extends AbstractModule
 {
-    /**
-     * The module key.
-     */
-    protected string $key = 'relative-urls';
-
     /**
      * Determine if the module is enabled.
      */