Add HasSpatial trait (#75)

* Reusable trait rather than adding a method

* corrections from PR review
- update readme instruction
- restore phpdoc ide hint
- trailing newline for phpcs

* Add HasSpatial trait #75
- typo & cs-fixer fix

* Update README.md

Co-authored-by: Matan Yadaev <[email protected]>

Author: lukevi

README.md

@@ -56,7 +56,7 @@ Run the migration:
 php artisan migrate
 ```
 
-Fill the `$fillable` and `$casts` arrays and add custom eloquent builder to your new model:
+Fill the `$fillable` and `$casts` arrays and use the `HasSpatial` trait in your new model:
 
 ```php
 namespace App\Models;
@@ -65,6 +65,7 @@ use Illuminate\Database\Eloquent\Model;
 use MatanYadaev\EloquentSpatial\SpatialBuilder;
 use MatanYadaev\EloquentSpatial\Objects\Point;
 use MatanYadaev\EloquentSpatial\Objects\Polygon;
+use MatanYadaev\EloquentSpatial\Traits\HasSpatial;
 
 /**
  * @property Point $location
@@ -73,6 +74,8 @@ use MatanYadaev\EloquentSpatial\Objects\Polygon;
  */
 class Place extends Model
 {
+    use HasSpatial;
+
     protected $fillable = [
         'name',
         'location',
@@ -83,11 +86,6 @@ class Place extends Model
         'location' => Point::class,
         'area' => Polygon::class,
     ];
-    
-    public function newEloquentBuilder($query): SpatialBuilder
-    {
-        return new SpatialBuilder($query);
-    }
 }
 ```
 

src/Traits/HasSpatial.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace MatanYadaev\EloquentSpatial\Traits;
+
+use MatanYadaev\EloquentSpatial\SpatialBuilder;
+
+trait HasSpatial
+{
+  public function newEloquentBuilder($query): SpatialBuilder
+  {
+    return new SpatialBuilder($query);
+  }
+}

tests/TestModels/TestPlace.php

@@ -13,6 +13,7 @@
 use MatanYadaev\EloquentSpatial\Objects\Polygon;
 use MatanYadaev\EloquentSpatial\SpatialBuilder;
 use MatanYadaev\EloquentSpatial\Tests\TestFactories\TestPlaceFactory;
+use MatanYadaev\EloquentSpatial\Traits\HasSpatial;
 
 /**
  * @property Point $point
@@ -30,7 +31,7 @@
  */
 class TestPlace extends Model
 {
-  use HasFactory;
+  use HasFactory, HasSpatial;
 
   protected $fillable = [
     'address',
@@ -55,16 +56,6 @@ class TestPlace extends Model
     'point_with_line_string_cast' => LineString::class,
   ];
 
-  /**
-   * @param $query
-   * @return SpatialBuilder<TestPlace>
-   */
-  public function newEloquentBuilder($query): SpatialBuilder
-  {
-    // @phpstan-ignore-next-line
-    return new SpatialBuilder($query);
-  }
-
   protected static function newFactory(): TestPlaceFactory
   {
     return new TestPlaceFactory;