improve-scout

CHANGELOG.md

@@ -2,10 +2,6 @@
 
 All notable changes to `wireuse` will be documented in this file.
 
-## v2.1.3 - 2024-07-24
-
-**Full Changelog**: https://github.com/foxws/wireuse/compare/v2.1.2...v2.1.3
-
 ## v2.1.2 - 2024-07-20
 
 **Full Changelog**: https://github.com/foxws/wireuse/compare/v2.1.1...v2.1.2

config/wireuse.php

@@ -28,4 +28,21 @@
         ],
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Structure Discovery
+    |--------------------------------------------------------------------------
+    |
+    | This controls structure discovery.
+    |
+    | @doc https://github.com/spatie/php-structure-discoverer
+    |
+    */
+
+    'scout' => [
+        'cache_store' => null,
+
+        'cache_lifetime' => 60 * 60 * 24 * 7,
+    ],
+
 ];

src/Scout/ComponentScout.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Foxws\WireUse\Scout;
+
+use Foxws\WireUse\Support\Discover\ComponentStructureScout;
+use Illuminate\Support\Facades\Blade;
+
+class ComponentScout extends Scout
+{
+    public function register(): void
+    {
+        $this->get()->each(fn (array $component) => Blade::component(
+            class: $component['class'],
+            alias: $component['name'],
+        ));
+    }
+
+    protected function getComponentStructures(): ComponentStructureScout
+    {
+        return ComponentStructureScout::create()
+            ->path($this->path)
+            ->prefix("blade-structures-{$this->prefix}");
+    }
+}

src/Scout/LivewireScout.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Foxws\WireUse\Scout;
+
+use Foxws\WireUse\Support\Discover\LivewireStructureScout;
+use Livewire\Livewire;
+
+class LivewireScout extends Scout
+{
+    public function register(): void
+    {
+        $this->get()->each(fn (array $component) => Livewire::component(...$component));
+    }
+
+    protected function getComponentStructures(): LivewireStructureScout
+    {
+        return LivewireStructureScout::create()
+            ->path($this->path)
+            ->prefix("livewire-structures-{$this->prefix}");
+    }
+}

src/Scout/Scout.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Foxws\WireUse\Scout;
+
+use Foxws\WireUse\Support\Discover\ComponentStructureScout;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Cache;
+use Spatie\StructureDiscoverer\Data\DiscoveredStructure;
+
+abstract class Scout
+{
+    public function __construct(
+        public ?string $path = null,
+        public ?string $namespace = null,
+        public ?string $prefix = null,
+    ) {}
+
+    public static function create(
+        string $path,
+        string $namespace = 'App\\',
+        ?string $prefix = null,
+    ): static {
+        return new static(
+            path: $path,
+            namespace: $namespace,
+            prefix: $prefix,
+        );
+    }
+
+    public function get(): Collection
+    {
+        return Cache::store($this->getCacheStore())->remember(
+            $this->getCacheKey(),
+            $this->getCacheLifetime(),
+            fn () => $this->buildCollection()
+        );
+    }
+
+    abstract protected function getComponentStructures(): ComponentStructureScout;
+
+    protected function buildCollection(): Collection
+    {
+        $scout = $this->getComponentStructures();
+
+        return Collection::make($scout->get())
+            ->map(fn (DiscoveredStructure $class) => [
+                'class' => $class->getFcqn(),
+                'name' => $this->componentName($class),
+            ]);
+    }
+
+    protected function componentName(DiscoveredStructure $class): string
+    {
+        return str($class->name)
+            ->kebab()
+            ->prepend(
+                $this->componentPrefix(),
+                $this->componentNamespace($class)
+            );
+    }
+
+    protected function componentPrefix(): string
+    {
+        return str($this->prefix)
+            ->replace('\\', '.')
+            ->kebab();
+    }
+
+    protected function componentNamespace(DiscoveredStructure $class): string
+    {
+        return str($class->namespace)
+            ->after($this->namespace)
+            ->match('/(.*)\\\\/')
+            ->replace('\\', '.')
+            ->slug('.')
+            ->finish('.');
+    }
+
+    protected function getCacheKey(): string
+    {
+        return str('wireuse')
+            ->append(class_basename(static::class), $this->prefix)
+            ->snake();
+    }
+
+    protected function getCacheStore(): ?string
+    {
+        return config('wireuse.scout.cache_store');
+    }
+
+    protected function getCacheLifetime(): ?int
+    {
+        return config('wireuse.scout.cache_lifetime');
+    }
+}

src/Support/Discover/ComponentScout.php → src/Support/Discover/ComponentStructureScout.php

@@ -7,7 +7,7 @@
 use Spatie\StructureDiscoverer\Discover;
 use Spatie\StructureDiscoverer\StructureScout;
 
-class ComponentScout extends StructureScout
+class ComponentStructureScout extends StructureScout
 {
     public ?string $path = null;
 

src/Support/Discover/LivewireScout.php → src/Support/Discover/LivewireStructureScout.php

@@ -5,7 +5,7 @@
 use Livewire\Component;
 use Spatie\StructureDiscoverer\Discover;
 
-class LivewireScout extends ComponentScout
+class LivewireStructureScout extends ComponentStructureScout
 {
     protected function definition(): Discover
     {

src/WireUse.php

@@ -2,80 +2,7 @@
 
 namespace Foxws\WireUse;
 
-use Foxws\WireUse\Support\Discover\ComponentScout;
-use Foxws\WireUse\Support\Discover\LivewireScout;
-use Illuminate\Support\Facades\Blade;
-use Illuminate\Support\Stringable;
-use Livewire\LivewireManager;
-use Spatie\StructureDiscoverer\Data\DiscoveredStructure;
-
 class WireUse
 {
-    public static function registerComponents(
-        string $path,
-        string $namespace = 'App\\',
-        string $prefix = '',
-    ): void {
-        $scout = ComponentScout::create()
-            ->path($path)
-            ->prefix("laravel-components-{$prefix}")
-            ->get();
-
-        collect($scout)
-            ->each(function (DiscoveredStructure $class) use ($namespace, $prefix) {
-                $name = static::componentName($class, $namespace, $prefix);
-
-                Blade::component($class->getFcqn(), $name->value());
-            });
-    }
-
-    public static function registerLivewireComponents(
-        string $path,
-        string $namespace = 'App\\',
-        string $prefix = '',
-    ): void {
-        $scout = LivewireScout::create()
-            ->path($path)
-            ->prefix("livewire-components-{$prefix}")
-            ->get();
-
-        $manager = app(LivewireManager::class);
-
-        collect($scout)
-            ->each(function (DiscoveredStructure $class) use ($manager, $namespace, $prefix) {
-                $name = static::componentName($class, $namespace, $prefix);
-
-                $fcqn = $class->getFcqn();
-
-                if ($manager->isDiscoverable($fcqn)) {
-                    $manager->component($name->value(), $fcqn);
-                }
-            });
-    }
-
-    public static function componentName(DiscoveredStructure $class, string $namespace, string $prefix): Stringable
-    {
-        return str($class->name)
-            ->kebab()
-            ->prepend(
-                static::componentPrefix($prefix),
-                static::componentNamespace($class, $namespace)
-            );
-    }
-
-    public static function componentPrefix(string $prefix): Stringable
-    {
-        return str($prefix)
-            ->kebab()
-            ->finish('::');
-    }
-
-    public static function componentNamespace(DiscoveredStructure $class, string $namespace): Stringable
-    {
-        return str($class->namespace)
-            ->after($namespace)
-            ->match('/(.*)\\\\/')
-            ->kebab()
-            ->finish('-');
-    }
+    //
 }

src/WireUseServiceProvider.php

@@ -2,7 +2,8 @@
 
 namespace Foxws\WireUse;
 
-use Spatie\LaravelPackageTools\Commands\InstallCommand;
+use Foxws\WireUse\Scout\ComponentScout;
+use Foxws\WireUse\Scout\LivewireScout;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -12,21 +13,22 @@ public function configurePackage(Package $package): void
     {
         $package
             ->name('wireuse')
-            ->hasConfigFile()
-            ->hasViews()
-            ->hasInstallCommand(function (InstallCommand $command) {
-                $command
-                    ->publishConfigFile();
-            });
+            ->hasConfigFile();
     }
 
-    public function bootingPackage(): void
+    public function packageBooted(): void
     {
         $this
             ->registerFeatures()
             ->registerMixins();
     }
 
+    public function packageRegistered(): void
+    {
+        $this->app->singleton(ComponentScout::class, fn () => new ComponentScout);
+        $this->app->singleton(LivewireScout::class, fn () => new LivewireScout);
+    }
+
     protected function registerFeatures(): static
     {
         foreach ([