Refactor: Simplify component path handling and improve code readability in Livewire components

Author: solomon-ochepa

src/Providers/LivewireComponentServiceProvider.php

@@ -10,11 +10,14 @@
 use Livewire\Livewire;
 use Mhmiton\LaravelModulesLivewire\Support\ModuleVoltComponentRegistry;
 use Mhmiton\LaravelModulesLivewire\View\ModuleVoltViewFactory;
+use Nwidart\Modules\Traits\PathNamespace;
 use ReflectionClass;
 use Symfony\Component\Finder\SplFileInfo;
 
 class LivewireComponentServiceProvider extends ServiceProvider
 {
+    use PathNamespace;
+
     /**
      * Register the service provider.
      */
@@ -42,15 +45,13 @@ protected function registerModuleComponents()
         $modulesLivewireNamespace = config('livewire.class_namespace', 'App\\Livewire');
 
         $modules->each(function ($module) use ($modulesLivewireNamespace) {
-            $directory = (string) Str::of($module->getAppPath())
-                ->append('/'.$modulesLivewireNamespace)
-                ->replace(['\\'], '/');
+            $directory = Str::of($module->app_path($modulesLivewireNamespace))->toString();
 
             $moduleNamespace = method_exists($module, 'getNamespace')
                 ? $module->getNamespace()
                 : config('modules.namespace', 'Modules');
 
-            $namespace = $moduleNamespace.'\\'.$module->getName().'\\'.$modulesLivewireNamespace;
+            $namespace = $this->namespace($moduleNamespace.'\\'.$module->getName().'\\'.$modulesLivewireNamespace);
 
             $this->registerComponentDirectory($directory, $namespace, $module->getLowerName().'::');
 

src/Traits/LivewireComponentParser.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
+use Nwidart\Modules\Helpers\Path;
 
 trait LivewireComponentParser
 {
@@ -15,6 +16,8 @@ trait LivewireComponentParser
 
     protected $directories;
 
+    protected $file;
+
     protected function parser(): self|bool
     {
         if (! $module = $this->getModule()) {
@@ -23,9 +26,10 @@ protected function parser(): self|bool
 
         $this->module = $module;
 
-        $this->directories = collect(
-            preg_split('/[.\/(\\\\)]+/', $this->argument('component'))
-        )->map([Str::class, 'studly']);
+        $this->file = Path::studly($this->argument('component'));
+
+        $this->directories = collect(preg_split('/[.\/(\\\\)]+/', Path::directory($this->argument('component'))))
+            ->map([Str::class, 'studly']);
 
         $this->component = $this->getComponent();
 
@@ -43,50 +47,36 @@ protected function getComponent()
 
     protected function class()
     {
-        $modulePath = $this->getModulePath(true);
-
-        $moduleLivewireNamespace = $this->getModuleLivewireNamespace();
-
-        $classDir = (string) Str::of($modulePath)
-            ->append('/'.$moduleLivewireNamespace)
-            ->replace(['\\'], '/');
-
-        $classPath = $this->directories->implode('/');
-
-        $namespace = $this->getNamespace($classPath);
-
-        $className = $this->directories->last();
-
-        $componentTag = $this->getComponentTag();
+        $dir = $this->path($this->getModulePath($this->getModuleLivewirePath())); // todo: examine app/ path handling.
+        $path = $this->directories->implode('/');
+        $filename = Path::join($dir, $this->file);
 
         return (object) [
-            'dir' => $classDir,
-            'path' => $classPath,
-            'file' => $classDir.'/'.$classPath.'.php',
-            'namespace' => $namespace,
-            'name' => $className,
-            'tag' => $componentTag,
+            'name' => Path::filename($this->file),
+            'path' => $path,
+            'namespace' => $this->getNamespace($path),
+            'file' => "{$filename}.php",
+            'dir' => $dir,
+            'tag' => $this->getComponentTag(),
         ];
     }
 
     protected function view()
     {
-        $moduleLivewireViewDir = $this->getModuleLivewireViewDir();
-
-        $path = $this->directories
-            ->map([Str::class, 'kebab'])
-            ->implode('/');
-
+        $dir = $this->getModuleLivewireViewDir();
+        $path = $this->directories->map([Str::class, 'kebab'])->implode('/');
         if ($this->option('view')) {
             $path = strtr($this->option('view'), ['.' => '/']);
         }
+        $file = Path::lower($this->file);
+        $filename = Path::join($dir, $file);
 
         return (object) [
-            'dir' => $moduleLivewireViewDir,
+            'name' => strtr($file, ['/' => '.']),
             'path' => $path,
-            'folder' => Str::after($moduleLivewireViewDir, 'views/'),
-            'file' => $moduleLivewireViewDir.'/'.$path.'.blade.php',
-            'name' => strtr($path, ['/' => '.']),
+            'file' => "{$filename}.blade.php",
+            'folder' => Str::after($dir, 'views/'),
+            'dir' => $dir,
         ];
     }
 
@@ -186,20 +176,17 @@ protected function getViewSourcePath()
 
     protected function getComponentTag()
     {
-        $directoryAsView = $this->directories
-            ->map([Str::class, 'kebab'])
-            ->implode('.');
-
+        $directoryAsView = Str::of($this->file)->explode('/')->map([Str::class, 'kebab'])->implode('.');
         $tag = "<livewire:{$this->getModuleLowerName()}::{$directoryAsView} />";
 
-        $tagWithOutIndex = Str::replaceLast('.index', '', $tag);
-
-        return $tagWithOutIndex;
+        return Str::replaceLast('.index', '', $tag);
     }
 
     protected function getComponentQuote()
     {
-        return "The <code>{$this->getClassName()}</code> livewire component is loaded from the ".($this->isCustomModule() ? 'custom ' : '')."<code>{$this->getModuleName()}</code> module.";
+        $file = Str::of($this->file)->explode('/')->implode(' / ');
+
+        return "<code>{$this->getModuleName()}".($this->isCustomModule() ? ' (custom)' : '').": {$file}</code>";
     }
 
     /**