Add Geometry@toSqlExpression method (#70)

* Add a manual casting function, fixes #69

* Requested changes for #70

* Update .run/Test.run.xml

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

* Update API.md

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

* Update tests/Objects/GeometryTest.php

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

* Update tests/Objects/GeometryTest.php

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

* Use expression generator in cast and builder, see #70

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

Author: Synchro

API.md

@@ -25,7 +25,7 @@ Geometry classes can be also created by these static methods:
 * `toWkt()` - Serializes the geometry object into a WKT.
 * `toWkb()` - Serializes the geometry object into a WKB.
 * `getCoordinates()` - Returns the coordinates of the geometry object.
-
+* `toSqlExpression(ConnectionInterface $connection)` - Serializes the geometry object into an SQL query.
 In addition, `GeometryCollection` also has these functions:
 
 * `getGeometries()` - Returns a geometry array. Can be used with `ArrayAccess` as well.

src/GeometryCast.php

@@ -7,7 +7,6 @@
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Query\Expression;
-use Illuminate\Support\Facades\DB;
 use InvalidArgumentException;
 use MatanYadaev\EloquentSpatial\Objects\Geometry;
 
@@ -73,17 +72,7 @@ public function set($model, string $key, $value, array $attributes): Expression|
       );
     }
 
-    $wkt = $value->toWkt();
-
-    $connection = $model->getConnection();
-
-    if (! (new AxisOrder)->supported($connection)) {
-      // @codeCoverageIgnoreStart
-      return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid})");
-      // @codeCoverageIgnoreEnd
-    }
-
-    return DB::raw("ST_GeomFromText('{$wkt}', {$value->srid}, 'axis-order=long-lat')");
+    return $value->toSqlExpression($model->getConnection());
   }
 
   private function extractWktFromExpression(Expression $expression): string

src/Objects/Geometry.php

@@ -9,10 +9,14 @@
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Contracts\Support\Jsonable;
+use Illuminate\Database\ConnectionInterface;
+use Illuminate\Database\Query\Expression;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Traits\Macroable;
 use InvalidArgumentException;
 use JsonException;
 use JsonSerializable;
+use MatanYadaev\EloquentSpatial\AxisOrder;
 use MatanYadaev\EloquentSpatial\Factory;
 use MatanYadaev\EloquentSpatial\GeometryCast;
 use Stringable;
@@ -203,4 +207,21 @@ public static function castUsing(array $arguments): CastsAttributes
   {
     return new GeometryCast(static::class);
   }
+
+  /**
+   * @param  ConnectionInterface  $connection
+   * @return Expression
+   */
+  public function toSqlExpression(ConnectionInterface $connection): Expression
+  {
+    $wkt = $this->toWkt();
+
+    if (! (new AxisOrder)->supported($connection)) {
+      // @codeCoverageIgnoreStart
+      return DB::raw("ST_GeomFromText('{$wkt}', {$this->srid})");
+      // @codeCoverageIgnoreEnd
+    }
+
+    return DB::raw("ST_GeomFromText('{$wkt}', {$this->srid}, 'axis-order=long-lat')");
+  }
 }

src/SpatialBuilder.php

@@ -289,17 +289,7 @@ public function whereSrid(
   protected function toExpression(Geometry|string $geometryOrColumn): Expression
   {
     if ($geometryOrColumn instanceof Geometry) {
-      $wkt = $geometryOrColumn->toWkt();
-
-      $connection = $this->getConnection();
-
-      if (! (new AxisOrder)->supported($connection)) {
-        // @codeCoverageIgnoreStart
-        return DB::raw("ST_GeomFromText('{$wkt}', {$geometryOrColumn->srid})");
-        // @codeCoverageIgnoreEnd
-      }
-
-      return DB::raw("ST_GeomFromText('{$wkt}', {$geometryOrColumn->srid}, 'axis-order=long-lat')");
+      return $geometryOrColumn->toSqlExpression($this->getConnection());
     }
 
     return DB::raw($this->getQuery()->getGrammar()->wrap($geometryOrColumn));

tests/Objects/GeometryTest.php

@@ -80,6 +80,20 @@
   })->toThrow(InvalidArgumentException::class);
 });
 
+it('creates an SQL expression from a geometry', function (): void {
+  $point = new Point(0, 180, 4326);
+
+  expect($point->toSqlExpression(DB::connection()))
+    ->toEqual("ST_GeomFromText('POINT(180 0)', 4326, 'axis-order=long-lat')");
+})->skip(fn () => ! (new AxisOrder)->supported(DB::connection()));
+
+it('creates an SQL expression from a geometry - without axis-order', function (): void {
+  $point = new Point(0, 180, 4326);
+
+  expect($point->toSqlExpression(DB::connection()))
+    ->toEqual("ST_GeomFromText('POINT(180 0)', 4326)");
+})->skip(fn () => (new AxisOrder)->supported(DB::connection()));
+
 it('creates a geometry object from a geo json array', function (): void {
   $point = new Point(0, 180);
   $pointGeoJsonArray = $point->toArray();