Make Geomtry objects stringable (#58)

* added __toString magic method

I needed a way to cast the geometry to a string.

* implement Stringable and return toWkt

* Object cast to string unit tests

Author: devinfd

src/Objects/Geometry.php

@@ -14,16 +14,25 @@
 use JsonSerializable;
 use MatanYadaev\EloquentSpatial\Factory;
 use MatanYadaev\EloquentSpatial\GeometryCast;
+use Stringable;
 use WKB as geoPHPWkb;
 
-abstract class Geometry implements Castable, Arrayable, Jsonable, JsonSerializable
+abstract class Geometry implements Castable, Arrayable, Jsonable, JsonSerializable, Stringable
 {
   public int $srid = 0;
 
   abstract public function toWkt(): string;
 
   abstract public function getWktData(): string;
 
+  /**
+   * @return string
+   */
+  public function __toString(): string
+  {
+    return $this->toWkt();
+  }
+
   /**
    * @param  int  $options
    * @return string

tests/Objects/GeometryCollectionTest.php

@@ -348,3 +348,20 @@
     $polygon[1] = new Point(0, 180);
   })->toThrow(InvalidArgumentException::class);
 });
+
+it('casts a GeometryCollection to a string', function (): void {
+  $geometryCollection = new GeometryCollection([
+    new Polygon([
+      new LineString([
+        new Point(0, 180),
+        new Point(1, 179),
+        new Point(2, 178),
+        new Point(3, 177),
+        new Point(0, 180),
+      ]),
+    ]),
+    new Point(0, 180),
+  ]);
+
+  expect($geometryCollection->__toString())->toEqual('GEOMETRYCOLLECTION(POLYGON((180 0, 179 1, 178 2, 177 3, 180 0)), POINT(180 0))');
+});

tests/Objects/LineStringTest.php

@@ -151,3 +151,12 @@
     ]);
   })->toThrow(InvalidArgumentException::class);
 });
+
+it('casts a LineString to a string', function (): void {
+  $lineString = new LineString([
+    new Point(0, 180),
+    new Point(1, 179),
+  ]);
+
+  expect($lineString->__toString())->toEqual('LINESTRING(180 0, 179 1)');
+});

tests/Objects/MultiLineStringTest.php

@@ -171,3 +171,14 @@
     ]);
   })->toThrow(InvalidArgumentException::class);
 });
+
+it('casts a MultiLineString to a string', function (): void {
+  $multiLineString = new MultiLineString([
+    new LineString([
+      new Point(0, 180),
+      new Point(1, 179),
+    ]),
+  ]);
+
+  expect($multiLineString->__toString())->toEqual('MULTILINESTRING((180 0, 179 1))');
+});

tests/Objects/MultiPointTest.php

@@ -138,3 +138,11 @@
     ]);
   })->toThrow(InvalidArgumentException::class);
 });
+
+it('casts a MultiPoint to a string', function (): void {
+  $multiPoint = new MultiPoint([
+    new Point(0, 180),
+  ]);
+
+  expect($multiPoint->__toString())->toEqual('MULTIPOINT(180 0)');
+});

tests/Objects/MultiPolygonTest.php

@@ -227,3 +227,19 @@
     ]);
   })->toThrow(InvalidArgumentException::class);
 });
+
+it('casts a MultiPolygon to a string', function (): void {
+  $multiPolygon = new MultiPolygon([
+    new Polygon([
+      new LineString([
+        new Point(0, 180),
+        new Point(1, 179),
+        new Point(2, 178),
+        new Point(3, 177),
+        new Point(0, 180),
+      ]),
+    ]),
+  ], 4326);
+
+  expect($multiPolygon->__toString())->toEqual('MULTIPOLYGON(((180 0, 179 1, 178 2, 177 3, 180 0)))');
+});

tests/Objects/PointTest.php

@@ -96,3 +96,9 @@
 
   expect($pointFromWkb)->toEqual($point);
 });
+
+it('casts a Point to a string', function (): void {
+  $point = new Point(0, 180, 4326);
+
+  expect($point->__toString())->toEqual('POINT(180 0)');
+});

tests/Objects/PolygonTest.php

@@ -204,3 +204,17 @@
     ]);
   })->toThrow(InvalidArgumentException::class);
 });
+
+it('casts a Polygon to a string', function (): void {
+  $polygon = $polygon = new Polygon([
+    new LineString([
+      new Point(0, 180),
+      new Point(1, 179),
+      new Point(2, 178),
+      new Point(3, 177),
+      new Point(0, 180),
+    ]),
+  ]);
+
+  expect($polygon->__toString())->toEqual('POLYGON((180 0, 179 1, 178 2, 177 3, 180 0))');
+});