Fix SRID (#49)

* Fix tests to use valid latitude and longitude

* Add test to identify invalid latitude or longitude

* Fix docs to use correct latitude and longitude

* Use SRID in API.md

* Improve SpatialBuilder tests to use SRID

* Fix the code to use constant axis order

* Fix API.md

Co-authored-by: Matan Yadaev <matan@zerolimits.io>

Author: MatanYadaev

API.md

@@ -33,20 +33,20 @@ In addition, `GeometryCollection` also has these functions:
 $geometryCollection = new GeometryCollection([
         new Polygon([
             new LineString([
-                new Point(180, 0),
-                new Point(179, 1),
-                new Point(178, 2),
-                new Point(177, 3),
-                new Point(180, 0),
+                new Point(0, 180),
+                new Point(1, 179),
+                new Point(2, 178),
+                new Point(3, 177),
+                new Point(0, 180),
             ]),
         ]),
-        new Point(180, 0),
+        new Point(0, 180),
     ]),
 ]);
 
-echo $geometryCollection->getGeometries()[1]->latitude; // 180
+echo $geometryCollection->getGeometries()[1]->latitude; // 0
 // or access as an array:
-echo $geometryCollection[1]->latitude; // 180
+echo $geometryCollection[1]->latitude; // 0
 ```
 
 ## Available spatial scopes
@@ -79,20 +79,20 @@ Retrieves the distance between 2 geometry objects. Uses [ST_Distance](https://de
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 $placeWithDistance = Place::query()
-    ->withDistance('location', new Point(1, 1))
+    ->withDistance('location', new Point(1, 1, 4326))
     ->first();
 
-echo $placeWithDistance->distance; // 1.4142135623731
+echo $placeWithDistance->distance; // 156897.79947260793
 
 // when using alias:
 $placeWithDistance = Place::query()
-    ->withDistance('location', new Point(1, 1), 'distance_in_meters')
+    ->withDistance('location', new Point(1, 1, 4326), 'distance_in_meters')
     ->first();
 
-echo $placeWithDistance->distance_in_meters; // 1.4142135623731
+echo $placeWithDistance->distance_in_meters; // 156897.79947260793
 ```
 </details>
 
@@ -110,11 +110,11 @@ Filters records by distance. Uses [ST_Distance](https://dev.mysql.com/doc/refman
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
-Place::create(['location' => new Point(100, 100)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
+Place::create(['location' => new Point(50, 50, 4326)]);
 
 $placesCountWithinDistance = Place::query()
-    ->whereDistance('location', new Point(1, 1), '<', 1.5)
+    ->whereDistance('location', new Point(1, 1, 4326), '<', 160000)
     ->count();
 
 echo $placesCountWithinDistance; // 1
@@ -136,15 +136,15 @@ Orders records by distance. Uses [ST_Distance](https://dev.mysql.com/doc/refman/
 ```php
 Place::create([
     'name' => 'first',
-    'location' => new Point(0, 0),
+    'location' => new Point(0, 0, 4326),
 ]);
 Place::create([
     'name' => 'second',
-    'location' => new Point(100, 100),
+    'location' => new Point(50, 50, 4326),
 ]);
 
 $places = Place::query()
-    ->orderByDistance('location', new Point(1, 1), 'desc')
+    ->orderByDistance('location', new Point(1, 1, 4326), 'desc')
     ->get();
 
 echo $places[0]->name; // second
@@ -165,20 +165,20 @@ Retrieves the spherical distance between 2 geometry objects. Uses [ST_Distance_S
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 $placeWithDistance = Place::query()
-    ->withDistanceSphere('location', new Point(1, 1))
+    ->withDistanceSphere('location', new Point(1, 1, 4326))
     ->first();
 
-echo $placeWithDistance->distance; // 157249.0357231545
+echo $placeWithDistance->distance; // 157249.59776850493
 
 // when using alias:
 $placeWithDistance = Place::query()
-    ->withDistanceSphere('location', new Point(1, 1), 'distance_in_meters')
+    ->withDistanceSphere('location', new Point(1, 1, 4326), 'distance_in_meters')
     ->first();
 
-echo $placeWithDistance->distance_in_meters; // 157249.0357231545
+echo $placeWithDistance->distance_in_meters; // 157249.59776850493
 ```
 </details>
 
@@ -196,11 +196,11 @@ Filters records by spherical distance. Uses [ST_Distance_Sphere](https://dev.mys
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
-Place::create(['location' => new Point(100, 100)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
+Place::create(['location' => new Point(50, 50, 4326)]);
 
 $placesCountWithinDistance = Place::query()
-    ->whereDistanceSphere('location', new Point(1, 1), '<', 160000)
+    ->whereDistanceSphere('location', new Point(1, 1, 4326), '<', 160000)
     ->count();
 
 echo $placesCountWithinDistance; // 1
@@ -222,15 +222,15 @@ Orders records by spherical distance. Uses [ST_Distance_Sphere](https://dev.mysq
 ```php
 Place::create([
     'name' => 'first',
-    'location' => new Point(0, 0),
+    'location' => new Point(0, 0, 4326),
 ]);
 Place::create([
     'name' => 'second',
-    'location' => new Point(100, 100),
+    'location' => new Point(100, 100, 4326),
 ]);
 
 $places = Place::query()
-    ->orderByDistanceSphere('location', new Point(1, 1), 'desc')
+    ->orderByDistanceSphere('location', new Point(1, 1, 4326), 'desc')
     ->get();
 
 echo $places[0]->name; // second
@@ -250,7 +250,7 @@ Filters records by the [ST_Within](https://dev.mysql.com/doc/refman/8.0/en/spati
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 Place::query()
     ->whereWithin('location', Polygon::fromJson('{"type":"Polygon","coordinates":[[[-1,-1],[1,-1],[1,1],[-1,1],[-1,-1]]]}'))
@@ -273,7 +273,7 @@ Filters records by the [ST_Contains](https://dev.mysql.com/doc/refman/8.0/en/spa
 Place::create(['area' => Polygon::fromJson('{"type":"Polygon","coordinates":[[[-1,-1],[1,-1],[1,1],[-1,1],[-1,-1]]]}'),]);
 
 Place::query()
-    ->whereContains('area', new Point(0, 0))
+    ->whereContains('area', new Point(0, 0, 4326))
     ->exists(); // true
 ```
 </details>
@@ -290,7 +290,7 @@ Filters records by the [ST_Touches](https://dev.mysql.com/doc/refman/8.0/en/spat
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 Place::query()
     ->whereTouches('location', Polygon::fromJson('{"type":"Polygon","coordinates":[[[-1,-1],[0,-1],[0,0],[-1,0],[-1,-1]]]}'))
@@ -310,7 +310,7 @@ Filters records by the [ST_Intersects](https://dev.mysql.com/doc/refman/8.0/en/s
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 Place::query()
     ->whereIntersects('location', Polygon::fromJson('{"type":"Polygon","coordinates":[[[-1,-1],[1,-1],[1,1],[-1,1],[-1,-1]]]}'))
@@ -350,7 +350,7 @@ Filters records by the [ST_Disjoint](https://dev.mysql.com/doc/refman/8.0/en/spa
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 Place::query()
     ->whereDisjoint('location', Polygon::fromJson('{"type":"Polygon","coordinates":[[[-1,-1],[-0.5,-1],[-0.5,-0.5],[-1,-0.5],[-1,-1]]]}'))
@@ -370,10 +370,10 @@ Filters records by the [ST_Equal](https://dev.mysql.com/doc/refman/8.0/en/spatia
 <details><summary>Example</summary>
 
 ```php
-Place::create(['location' => new Point(0, 0)]);
+Place::create(['location' => new Point(0, 0, 4326)]);
 
 Place::query()
-    ->whereEquals('location', new Point(0, 0))
+    ->whereEquals('location', new Point(0, 0, 4326))
     ->exists(); // true
 ```
 </details>

src/GeometryCast.php

@@ -71,19 +71,19 @@ public function set($model, string $key, $value, array $attributes): Expression|
 
     $wkt = $value->toWkt();
 
-    return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid})");
+    return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid}, 'axis-order=long-lat')");
   }
 
   private function extractWktFromExpression(Expression $expression): string
   {
-    preg_match('/ST_GeomFromText\(\'(.+)\', .+\)/', (string) $expression, $match);
+    preg_match('/ST_GeomFromText\(\'(.+)\', .+, .+\)/', (string) $expression, $match);
 
     return $match[1];
   }
 
   private function extractSridFromExpression(Expression $expression): int
   {
-    preg_match('/ST_GeomFromText\(\'.+\', (.+)\)/', (string) $expression, $match);
+    preg_match('/ST_GeomFromText\(\'.+\', (.+), .+\)/', (string) $expression, $match);
 
     return (int) $match[1];
   }

src/SpatialBuilder.php

@@ -265,7 +265,7 @@ protected function toExpression(Geometry|string $geometryOrColumn): Expression
     if ($geometryOrColumn instanceof Geometry) {
       $wkt = $geometryOrColumn->toWkt();
 
-      return DB::raw("ST_GeomFromText('{$wkt}')");
+      return DB::raw("ST_GeomFromText('{$wkt}', {$geometryOrColumn->srid}, 'axis-order=long-lat')");
     }
 
     return DB::raw("`{$geometryOrColumn}`");

tests/GeometryCastTest.php

@@ -16,7 +16,7 @@
 });
 
 it('updates a model record', function (): void {
-  $point = new Point(180, 0);
+  $point = new Point(0, 180);
   $point2 = new Point(0, 0);
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['point' => $point]);
@@ -28,7 +28,7 @@
 });
 
 it('updates a model record with null geometry', function (): void {
-  $point = new Point(180, 0);
+  $point = new Point(0, 180);
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['point' => $point]);
 
@@ -38,7 +38,7 @@
 });
 
 it('gets original geometry field', function (): void {
-  $point = new Point(180, 0, 4326);
+  $point = new Point(0, 180, 4326);
   $point2 = new Point(0, 0, 4326);
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['point' => $point]);
@@ -51,7 +51,7 @@
 });
 
 it('serializes a model record to array with geometry', function (): void {
-  $point = new Point(180, 0);
+  $point = new Point(0, 180);
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['point' => $point]);
 
@@ -62,7 +62,7 @@
 });
 
 it('serializes a model record to json with geometry', function (): void {
-  $point = new Point(180, 0);
+  $point = new Point(0, 180);
   /** @var TestPlace $testPlace */
   $testPlace = TestPlace::factory()->create(['point' => $point]);
 
@@ -78,8 +78,8 @@
   expect(function (): void {
     TestPlace::factory()->make([
       'point' => new LineString([
-        new Point(180, 0),
-        new Point(179, 1),
+        new Point(0, 180),
+        new Point(1, 179),
       ]),
     ]);
   })->toThrow(InvalidArgumentException::class);