Refactor module() helper function and Blade directive to improve flexibility and consistency

The helper function should return the module status by default instead of the instance, as this is the common usage.

Author: solomon-ochepa

src/LaravelModulesServiceProvider.php

@@ -38,6 +38,11 @@ public function boot()
         AboutCommand::add('Laravel-Modules', [
             'Version' => fn () => InstalledVersions::getPrettyVersion('nwidart/laravel-modules'),
         ]);
+
+        // Create @module() blade directive.
+        Blade::if('module', function (string $name) {
+            return module($name);
+        });
     }
 
     /**
@@ -53,11 +58,6 @@ public function register()
         $this->registerTranslations();
 
         $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'modules');
-
-        // Create @module() blade directive.
-        Blade::if('module', function (string $name) {
-            return module($name, true);
-        });
     }
 
     /**

src/helpers.php

@@ -7,13 +7,13 @@
 
 if (! function_exists('module')) {
     /**
-     * Retrieves a module instance or its status.
+     * Retrieves a module status or its instance.
      *
      * @param  string  $name  The name of the module.
-     * @param  bool  $status  Whether to return the module's status instead of the instance. Defaults to false.
-     * @return Module|bool The module instance or its status.
+     * @param  bool  $instance  Whether to return the module's instance instead of the status. Defaults to false [status].
+     * @return bool|Module The module instance or its status.
      */
-    function module(string $name, bool $status = false): Module|bool
+    function module(string $name, bool $instance = false): bool|Module
     {
         $modules = app('modules');
         if (! $modules->has($name)) {
@@ -22,7 +22,7 @@ function module(string $name, bool $status = false): Module|bool
             return false;
         }
 
-        return $status ? $modules->isEnabled($name) : $modules->find($name);
+        return $instance ? $modules->find($name) : $modules->isEnabled($name);
     }
 }
 

tests/ModuleHelperTest.php

@@ -33,36 +33,47 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    public function test_module_returns_instance_when_exists()
+    public function test_module_returns_true_when_found()
     {
-        $module = module('Blog');
-
-        $this->assertInstanceOf(Module::class, $module);
-        $this->assertEquals('Blog', $module->getName());
+        $this->assertTrue(module('Blog'));
     }
 
-    public function test_module_returns_false_when_not_found()
+    public function test_module_returns_false_and_log_error_when_not_found()
     {
         Log::shouldReceive('error')->once()->with("Module 'Blogs' not found.");
 
         $this->assertFalse(module('Blogs'));
     }
 
-    public function test_module_returns_false_when_not_found_and_status_parameter_is_true()
+    public function test_module_returns_false_and_log_error_when_not_found_and_instance_parameter_is_true()
     {
         Log::shouldReceive('error')->once()->with("Module 'Blogs' not found.");
 
-        $this->assertFalse(module('Blogs'));
+        $this->assertFalse(module('Blogs', true));
+    }
+
+    public function test_module_returns_instance_when_instance_parameter_is_true()
+    {
+        $module = module('Blog', true);
+
+        $this->assertInstanceOf(Module::class, $module);
+        $this->assertEquals('Blog', $module->getName());
     }
 
-    public function test_module_returns_status_when_status_parameter_is_true()
+    public function test_module_returns_false_when_disabled()
     {
-        $this->assertTrue(module('Blog', true));
+        Artisan::call('module:disable Blog');
+
+        $this->assertFalse(module('Blog'));
     }
 
-    public function test_module_returns_status_when_status_parameter_is_true_and_module_is_disabled()
+    public function test_module_returns_instance_when_disabled_and_instance_parameter_is_true()
     {
         Artisan::call('module:disable Blog');
-        $this->assertFalse(module('Blog', true));
+
+        $module = module('Blog', true);
+
+        $this->assertInstanceOf(Module::class, $module);
+        $this->assertEquals('Blog', $module->getName());
     }
 }