Merge pull request #3 from edersoares/builder

Custom Builder

config/anything.php

@@ -3,5 +3,7 @@
 declare(strict_types=1);
 
 return [
-    // dex/anything
+    'search' => [
+        'operator' => env('ANYTHING_SEARCH_OPERATOR', 'ilike'),
+    ],
 ];

phpunit.xml.dist

@@ -6,6 +6,9 @@
     </testsuite>
   </testsuites>
   <coverage/>
+  <php>
+    <server name="ANYTHING_SEARCH_OPERATOR" value="LIKE"/>
+  </php>
   <source>
     <include>
       <directory suffix=".php">src</directory>

src/Http/Controllers/AnythingController.php

@@ -15,10 +15,11 @@ class AnythingController
      */
     public function __invoke(Request $request): Collection
     {
-        return Anything::query()
-            ->when($search = $request->query('search'), function ($query) use ($search) {
-                $query->where('slug', 'like', "%{$search}%");
-            })
+        /** @var Collection<int, Anything> $result */
+        $result = Anything::query()
+            ->whereSearch((string) $request->string('search'))
             ->get();
+
+        return $result;
     }
 }

src/Http/Controllers/FetchAnythingController.php

@@ -16,7 +16,7 @@ public function __invoke(string $type): Collection
     {
         /** @var Collection<int, Anything> $anything */
         $anything = Anything::query()
-            ->where('type', $type)
+            ->whereType($type)
             ->get();
 
         return $anything;

src/Models/Anything.php

@@ -4,9 +4,11 @@
 
 namespace Dex\Laravel\Anything\Models;
 
+use Dex\Laravel\Anything\Models\Builders\AnythingBuilder;
 use Dex\Laravel\Anything\Models\Concerns\AnythingMorphed;
 use Dex\Laravel\Anything\Models\Concerns\HasAnythingType;
 use Dex\Laravel\Anything\Models\Concerns\HasSlug;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 
@@ -15,6 +17,10 @@
  * @property string $type
  * @property string $slug
  * @property string $label
+ *
+ * @method static Builder whereType(string $type)
+ * @method static Builder whereSlug(string $slug)
+ * @method static AnythingBuilder query()
  */
 class Anything extends Model
 {
@@ -33,10 +39,15 @@ public static function get(string $slug, ?string $type = null): static
 
         /** @var static $model */
         $model = static::query()
-            ->where('type', $type)
-            ->where('slug', $slug)
+            ->whereType($type)
+            ->whereSlug($slug)
             ->first();
 
         return $model;
     }
+
+    public function newEloquentBuilder($query): AnythingBuilder
+    {
+        return new AnythingBuilder($query);
+    }
 }

src/Models/Builders/AnythingBuilder.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dex\Laravel\Anything\Models\Builders;
+
+use Dex\Laravel\Anything\Models\Anything;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * @extends Builder<Anything>
+ */
+class AnythingBuilder extends Builder
+{
+    public function whereSearch(string $search): self
+    {
+        $likeOperator = ($temp = config('anything.search.operator')) && is_string($temp) ? $temp : null;
+
+        return $this->when($search, function ($q) use ($search, $likeOperator) {
+            $q->whereAny([
+                'label',
+                'slug',
+            ], $likeOperator, '%' . $search . '%');
+        });
+    }
+
+    public function whereType(string $type): self
+    {
+        return $this->where('type', $type);
+    }
+
+    public function whereSlug(string $slug): self
+    {
+        return $this->where('slug', $slug);
+    }
+}

src/Models/Concerns/HasAnythingType.php

@@ -5,7 +5,7 @@
 namespace Dex\Laravel\Anything\Models\Concerns;
 
 use Dex\Laravel\Anything\Models\Anything;
-use Illuminate\Database\Eloquent\Builder;
+use Dex\Laravel\Anything\Models\Builders\AnythingBuilder;
 
 /**
  * @mixin Anything
@@ -20,7 +20,7 @@ public static function bootHasAnythingType(): void
             }
         });
 
-        static::addGlobalScope(function (Builder $builder) {
+        static::addGlobalScope(function (AnythingBuilder $builder) {
             /** @var Anything $model */
             $model = $builder->getModel();
 
@@ -31,7 +31,7 @@ public static function bootHasAnythingType(): void
                 return;
             }
 
-            $builder->where('type', $type);
+            $builder->whereType($type);
         });
     }