Integrate matanyadaev/laravel-eloquent-spatial

Author: masterix21

.phpunit.cache/test-results

@@ -1 +1 @@
-{"version":"pest_3.6.0","defects":{"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_unmarked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_addresses_collection_when_eloquent_has_addresses":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_unmarked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_marked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_marked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_unmarked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_empty_addresses_collection_when_eloquent_has_no_addresses":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_marked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_lat_lng":8},"times":{"P\\Tests\\ArchTest::__pest_evaluable_it_will_not_use_debugging_functions":0.055,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_unmarked_event_on_make_primary":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_marked_event_on_make_primary":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_addresses_collection_when_eloquent_has_addresses":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_marked_event_on_make_primary":0.007,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_unmarked_event_on_make_primary":0.005,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_marked_event_on_make_primary":0.046,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_empty_addresses_collection_when_eloquent_has_no_addresses":0.003,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_unmarked_event_on_make_primary":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_lat_lng":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_lat_lng_and_retrieve_correctly":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_and_retrieves_lat_lng_correctly":0.006}}
+{"version":"pest_3.6.0","defects":{"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_unmarked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_addresses_collection_when_eloquent_has_addresses":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_unmarked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_marked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_marked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_unmarked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_empty_addresses_collection_when_eloquent_has_no_addresses":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_marked_event_on_make_primary":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_lat_lng":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_retrieves_all_address_within_10_km":8,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_and_retrieves_lat_lng_correctly":8,"P\\Tests\\ArchTest::__pest_evaluable_it_will_not_use_debugging_functions":7},"times":{"P\\Tests\\ArchTest::__pest_evaluable_it_will_not_use_debugging_functions":0.064,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_unmarked_event_on_make_primary":0.021,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_marked_event_on_make_primary":0.018,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_addresses_collection_when_eloquent_has_addresses":0.026,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_marked_event_on_make_primary":0.024,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_shipping_address_primary_unmarked_event_on_make_primary":0.025,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_address_primary_marked_event_on_make_primary":0.089,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_return_empty_addresses_collection_when_eloquent_has_no_addresses":0.026,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_fires_billing_address_primary_unmarked_event_on_make_primary":0.029,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_lat_lng":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_lat_lng_and_retrieve_correctly":0.004,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_stores_and_retrieves_lat_lng_correctly":0.029,"P\\Tests\\Feature\\Models\\AddressTest::__pest_evaluable_it_retrieves_all_address_within_10_km":0.089}}

README.md

@@ -7,6 +7,8 @@
 
 This package adds to any Eloquent model the addresses: in this way will be easier to support a billing address, the shipment addresses or others. 
 
+It uses the great package `matanyadaev/laravel-eloquent-spatial` by Matan Yadaev. 
+
 ## Support us
 
 If you like my work, you can [sponsoring me](https://github.com/masterix21).
@@ -98,13 +100,23 @@ $billingAddress->save();
 ```php
 // Take all addresses within 10 km
 $addresses = Address::query()
-  ->withPositionDistance(new Point(38.90852, 16.5894), 10000)
-  ->get();
+    ->whereDistanceSphere(
+        column: 'coordinates',
+        geometryOrColumn: new Point(45.4391, 9.1906, config('addressable.srid')),
+        operator: '<=',
+        value: 10_000
+    )
+    ->get();
 
 // Take all addresses over 10 km
 $addresses = Address::query()
-  ->withPositionDistance(new Point(38.90852, 16.5894), 10000, '>=')
-  ->get();
+    ->whereDistanceSphere(
+        column: 'coordinates',
+        geometryOrColumn: new Point(45.4391, 9.1906, config('addressable.srid')),
+        operator: '>=',
+        value: 10_000
+    )
+    ->get();
 ```
 
 ## Testing
@@ -131,6 +143,7 @@ If you discover any security related issues, please email [email protected] inst
 ## Credits
 
 - [Luca Longo](https://github.com/masterix21)
+- [Matan Yadaev](https://github.com/MatanYadaev/laravel-eloquent-spatial)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -17,7 +17,8 @@
     ],
     "require": {
         "php": "^8.2|^8.3|^8.4",
-        "illuminate/contracts": "^11.23"
+        "illuminate/contracts": "^11.23",
+        "matanyadaev/laravel-eloquent-spatial": "^4.4"
     },
     "require-dev": {
         "larastan/larastan": "^2.9",

database/factories/AddressFactory.php

@@ -2,10 +2,10 @@
 
 namespace Masterix21\Addressable\Database\Factories;
 
-use Clickbar\Magellan\Data\Geometries\Point;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Database\Eloquent\Model;
 use Masterix21\Addressable\Models\Address;
+use MatanYadaev\EloquentSpatial\Objects\Point;
 
 class AddressFactory extends Factory
 {
@@ -24,7 +24,11 @@ public function definition(): array
             'city' => $this->faker->city,
             'state' => $this->faker->state,
             'country' => $this->faker->countryCode,
-            'coordinates' => ['lat' => $this->faker->latitude, 'lng' => $this->faker->longitude],
+            'coordinates' => new Point(
+                latitude: $this->faker->latitude,
+                longitude: $this->faker->longitude,
+                srid: config('addressable.srid')
+            ),
         ];
     }
 

phpunit.xml.dist

@@ -28,4 +28,12 @@
             <directory suffix=".php">./src</directory>
         </include>
     </source>
+    <php>
+        <env name="DB_CONNECTION" value="mysql"/>
+        <env name="DB_HOST" value="127.0.0.1"/>
+        <env name="DB_PORT" value="3306"/>
+        <env name="DB_DATABASE" value="test"/>
+        <env name="DB_USERNAME" value="root"/>
+        <env name="DB_PASSWORD" value=""/>
+    </php>
 </phpunit>

src/Models/Address.php

@@ -2,15 +2,18 @@
 
 namespace Masterix21\Addressable\Models;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
-use Masterix21\Addressable\Models\Casts\GeographyCast;
 use Masterix21\Addressable\Models\Concerns\ImplementsMarkPrimary;
+use MatanYadaev\EloquentSpatial\Objects\Point;
+use MatanYadaev\EloquentSpatial\Traits\HasSpatial;
 
 class Address extends Model
 {
     use HasFactory;
+    use HasSpatial;
     use ImplementsMarkPrimary;
 
     protected $fillable = [
@@ -37,9 +40,11 @@ class Address extends Model
         'is_primary' => 'bool',
         'is_billing' => 'bool',
         'is_shipping' => 'bool',
-        'coordinates' => GeographyCast::class,
+        'coordinates' => Point::class,
     ];
 
+
+
     public function displayAddress(): Attribute
     {
         return Attribute::get(function () {
@@ -58,21 +63,4 @@ public function displayAddress(): Attribute
                 ->join(' - ');
         });
     }
-
-    public function latitude(): Attribute
-    {
-        return Attribute::get(fn () => $this->coordinates['lat'] ?? null);
-    }
-
-    public function longitude(): Attribute
-    {
-        return Attribute::get(fn () => $this->coordinates['lng'] ?? null);
-    }
-
-    public function setCoordinates(float $latitude, float $longitude): self
-    {
-        $this->coordinates = compact('latitude', 'longitude');
-
-        return $this;
-    }
 }

src/Models/Casts/GeographyCast.php

@@ -10,6 +10,7 @@
 use Masterix21\Addressable\Models\Address;
 use Masterix21\Addressable\Tests\TestCase;
 use Masterix21\Addressable\Tests\TestClasses\User;
+use MatanYadaev\EloquentSpatial\Objects\Point;
 
 uses(TestCase::class);
 
@@ -107,16 +108,56 @@
 
     $address = Address::factory()->addressable($user)->primary()->shipping()->createOne();
 
-    expect($address->latitude)->not->toBeNull()
-        ->and($address->longitude)->not->toBeNull();
+    expect($address->coordinates->latitude)->not->toBeNull()
+        ->and($address->coordinates->longitude)->not->toBeNull();
 
     $newLat = fake()->latitude();
     $newLng = fake()->longitude();
 
-    $address
-        ->setCoordinates($newLat, $newLng)
-        ->save();
+    $address->coordinates = new Point($newLat, $newLng, config('addressable.srid'));
+    $address->save();
 
-    expect($address->latitude)->toBe($newLat)
-        ->and($address->longitude)->toBe($newLng);
+    expect($address->coordinates->latitude)->toBe($newLat)
+        ->and($address->coordinates->longitude)->toBe($newLng);
+});
+
+it('retrieves all address within 10 km', function () {
+    $user = User::factory()->createOne();
+
+    $homeAddress = Address::factory()->addressable($user)
+        ->state(['coordinates' => new Point(45.4642, 9.19, config('addressable.srid'))])
+        ->createOne();
+
+    // Within 10km
+    Address::factory()->addressable($user)->state(['coordinates' => new Point(45.4391, 9.1906, config('addressable.srid'))])->createOne();
+    Address::factory()->addressable($user)->state(['coordinates' => new Point(45.4535, 9.1898, config('addressable.srid'))])->createOne();
+    Address::factory()->addressable($user)->state(['coordinates' => new Point(45.4940, 9.1893, config('addressable.srid'))])->createOne();
+
+    // Within 20km
+    Address::factory()->addressable($user)->state(['coordinates' => new Point(45.5436, 9.4197, config('addressable.srid'))])->createOne();
+    Address::factory()->addressable($user)->state(['coordinates' => new Point(45.6374, 9.2595, config('addressable.srid'))])->createOne();
+
+    $result = Address::query()
+        ->where('id', '!=', $homeAddress->id)
+        ->whereDistanceSphere(
+            column: 'coordinates',
+            geometryOrColumn: new Point(45.4391, 9.1906, config('addressable.srid')),
+            operator: '<=',
+            value: 10_000
+        )
+        ->count();
+
+    expect($result)->toBe(3);
+
+    $result = Address::query()
+        ->where('id', '!=', $homeAddress->id)
+        ->whereDistanceSphere(
+            column: 'coordinates',
+            geometryOrColumn: new Point(45.4391, 9.1906, config('addressable.srid')),
+            operator: '>=',
+            value: 10_000
+        )
+        ->count();
+
+    expect($result)->toBe(2);
 });

tests/Feature/Models/AddressTest.php

@@ -22,6 +22,8 @@ function (string $modelName) {
                 return 'Masterix21\\Addressable\\Database\\Factories\\'.class_basename($modelName).'Factory';
             }
         );
+
+        $this->migrateDb();
     }
 
     protected function getPackageProviders($app): array
@@ -33,14 +35,15 @@ protected function getPackageProviders($app): array
 
     public function getEnvironmentSetUp($app): void
     {
-        $app['config']->set('database.default', 'sqlite');
-        $app['config']->set('database.connections.sqlite', [
-            'driver' => 'sqlite',
-            'database' => ':memory:',
-            'prefix' => '',
+        $app['config']->set('database.default', 'mysql');
+        $app['config']->set('database.connections.mysql', [
+            'driver' => 'mysql',
+            'username' => env('DB_USERNAME', 'root'),
+            'host' => env('DB_HOST', '127.0.0.1'),
+            'port' => env('DB_PORT', '3306'),
+            'password' => env('DB_PASSWORD'),
+            'database' => env('DB_NAME', 'test'),
         ]);
-
-        $this->migrateDb();
     }
 
     public function migrateDb(): void