Refactor toWkt (#48)

MatanYadaev · Matan Yadaev · web-flow · commit 983503580fa9 · 2022-07-21T00:28:29.000+03:00
* Add tests

* Refactor WKT logic

Co-authored-by: Matan Yadaev &lt;matan@zerolimits.io&gt;
diff --git a/src/Objects/Geometry.php b/src/Objects/Geometry.php
@@ -20,7 +20,9 @@ abstract class Geometry implements Castable, Arrayable, Jsonable, JsonSerializab
 {
   public int $srid = 0;
 
-  abstract public function toWkt(bool $withFunction = true): string;
+  abstract public function toWkt(): string;
+
+  abstract public function getWktData(): string;
 
   /**
    * @param  int  $options
diff --git a/src/Objects/GeometryCollection.php b/src/Objects/GeometryCollection.php
@@ -37,11 +37,20 @@ public function __construct(Collection|array $geometries, int $srid = 0)
     $this->validateGeometriesCount();
   }
 
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = $this->toCollectionWkt(withFunction: true);
+    $wktData = $this->getWktData();
 
-    return "GEOMETRYCOLLECTION({$wkt})";
+    return "GEOMETRYCOLLECTION({$wktData})";
+  }
+
+  public function getWktData(): string
+  {
+    return $this->geometries
+      ->map(static function (Geometry $geometry): string {
+        return $geometry->toWkt();
+      })
+      ->join(', ');
   }
 
   /**
@@ -152,15 +161,6 @@ protected function validateGeometriesType(): void
     });
   }
 
-  protected function toCollectionWkt(bool $withFunction): string
-  {
-    return $this->geometries
-      ->map(static function (Geometry $geometry) use ($withFunction): string {
-        return $geometry->toWkt($withFunction);
-      })
-      ->join(', ');
-  }
-
   /**
    * Checks whether the class is used directly or via a sub-class.
    *
diff --git a/src/Objects/LineString.php b/src/Objects/LineString.php
@@ -8,14 +8,19 @@ class LineString extends PointCollection
 {
   protected int $minimumGeometries = 2;
 
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = $this->toCollectionWkt(withFunction: false);
+    $wktData = $this->getWktData();
 
-    if ($withFunction) {
-      return "LINESTRING(${wkt})";
-    }
+    return "LINESTRING({$wktData})";
+  }
 
-    return "(${wkt})";
+  public function getWktData(): string
+  {
+    return $this->geometries
+      ->map(static function (Point $point): string {
+        return $point->getWktData();
+      })
+      ->join(', ');
   }
 }
diff --git a/src/Objects/MultiLineString.php b/src/Objects/MultiLineString.php
@@ -32,10 +32,21 @@ public function __construct(Collection|array $geometries, int $srid = 0)
     parent::__construct($geometries, $srid);
   }
 
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = $this->toCollectionWkt(withFunction: false);
+    $wktData = $this->getWktData();
 
-    return "MULTILINESTRING({$wkt})";
+    return "MULTILINESTRING({$wktData})";
+  }
+
+  public function getWktData(): string
+  {
+    return $this->geometries
+      ->map(static function (LineString $lineString): string {
+        $wktData = $lineString->getWktData();
+
+        return "({$wktData})";
+      })
+      ->join(', ');
   }
 }
diff --git a/src/Objects/MultiPoint.php b/src/Objects/MultiPoint.php
@@ -8,10 +8,19 @@ class MultiPoint extends PointCollection
 {
   protected int $minimumGeometries = 1;
 
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = $this->toCollectionWkt(withFunction: false);
+    $wktData = $this->getWktData();
 
-    return "MULTIPOINT({$wkt})";
+    return "MULTIPOINT({$wktData})";
+  }
+
+  public function getWktData(): string
+  {
+    return $this->geometries
+      ->map(static function (Point $point): string {
+        return $point->getWktData();
+      })
+      ->join(', ');
   }
 }
diff --git a/src/Objects/MultiPolygon.php b/src/Objects/MultiPolygon.php
@@ -32,10 +32,21 @@ public function __construct(Collection|array $geometries, int $srid = 0)
     parent::__construct($geometries, $srid);
   }
 
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = $this->toCollectionWkt(withFunction: false);
+    $wktData = $this->getWktData();
 
-    return "MULTIPOLYGON({$wkt})";
+    return "MULTIPOLYGON({$wktData})";
+  }
+
+  public function getWktData(): string
+  {
+    return $this->geometries
+      ->map(static function (Polygon $polygon): string {
+        $wktData = $polygon->getWktData();
+
+        return "({$wktData})";
+      })
+      ->join(', ');
   }
 }
diff --git a/src/Objects/Point.php b/src/Objects/Point.php
@@ -17,15 +17,16 @@ public function __construct(float $latitude, float $longitude, int $srid = 0)
     $this->srid = $srid;
   }
 
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = "{$this->longitude} {$this->latitude}";
+    $wktData = $this->getWktData();
 
-    if ($withFunction) {
-      return "POINT({$wkt})";
-    }
+    return "POINT({$wktData})";
+  }
 
-    return $wkt;
+  public function getWktData(): string
+  {
+    return "{$this->longitude} {$this->latitude}";
   }
 
   /**
diff --git a/src/Objects/Polygon.php b/src/Objects/Polygon.php
@@ -6,14 +6,21 @@
 
 class Polygon extends MultiLineString
 {
-  public function toWkt(bool $withFunction = true): string
+  public function toWkt(): string
   {
-    $wkt = $this->toCollectionWkt(withFunction: false);
+    $wktData = $this->getWktData();
 
-    if ($withFunction) {
-      return "POLYGON({$wkt})";
-    }
+    return "POLYGON({$wktData})";
+  }
+
+  public function getWktData(): string
+  {
+    return $this->geometries
+      ->map(static function (LineString $lineString): string {
+        $wktData = $lineString->getWktData();
 
-    return "(${wkt})";
+        return "({$wktData})";
+      })
+      ->join(', ');
   }
 }
diff --git a/src/SpatialBuilder.php b/src/SpatialBuilder.php
@@ -263,7 +263,7 @@ public function whereSrid(
   protected function toExpression(Geometry|string $geometryOrColumn): Expression
   {
     if ($geometryOrColumn instanceof Geometry) {
-      $wkt = $geometryOrColumn->toWkt(withFunction: true);
+      $wkt = $geometryOrColumn->toWkt();
 
       return DB::raw("ST_GeomFromText('{$wkt}')");
     }
diff --git a/tests/Objects/GeometryCollectionTest.php b/tests/Objects/GeometryCollectionTest.php
@@ -161,7 +161,7 @@
     new Point(180, 0),
   ]);
 
-  $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((0 180, 1 179, 2 178, 3 177, 0 180)),POINT(0 180))');
+  $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((0 180, 1 179, 2 178, 3 177, 0 180)), POINT(0 180))');
 
   expect($geometryCollectionFromWkt)->toEqual($geometryCollection);
 });
@@ -180,11 +180,31 @@
     new Point(180, 0),
   ], 4326);
 
-  $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((0 180, 1 179, 2 178, 3 177, 0 180)),POINT(0 180))', 4326);
+  $geometryCollectionFromWkt = GeometryCollection::fromWkt('GEOMETRYCOLLECTION(POLYGON((0 180, 1 179, 2 178, 3 177, 0 180)), POINT(0 180))', 4326);
 
   expect($geometryCollectionFromWkt)->toEqual($geometryCollection);
 });
 
+it('generates geometry collection WKT', function (): void {
+  $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(180, 0),
+  ]);
+
+  $wkt = $geometryCollection->toWkt();
+
+  $expectedWkt = 'GEOMETRYCOLLECTION(POLYGON((0 180, 1 179, 2 178, 3 177, 0 180)), POINT(0 180))';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates geometry collection from WKB', function (): void {
   $geometryCollection = new GeometryCollection([
     new Polygon([
diff --git a/tests/Objects/LineStringTest.php b/tests/Objects/LineStringTest.php
@@ -101,6 +101,18 @@
   expect($lineStringFromWkt)->toEqual($lineString);
 });
 
+it('generates line string WKT', function (): void {
+  $lineString = new LineString([
+    new Point(180, 0),
+    new Point(179, 1),
+  ]);
+
+  $wkt = $lineString->toWkt();
+
+  $expectedWkt = 'LINESTRING(0 180, 1 179)';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates line string from WKB', function (): void {
   $lineString = new LineString([
     new Point(180, 0),
diff --git a/tests/Objects/MultiLineStringTest.php b/tests/Objects/MultiLineStringTest.php
@@ -117,6 +117,20 @@
   expect($multiLineStringFromWkt)->toEqual($multiLineString);
 });
 
+it('generates multi line string WKT', function (): void {
+  $multiLineString = new MultiLineString([
+    new LineString([
+      new Point(180, 0),
+      new Point(179, 1),
+    ]),
+  ]);
+
+  $wkt = $multiLineString->toWkt();
+
+  $expectedWkt = 'MULTILINESTRING((0 180, 1 179))';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates multi line string from WKB', function (): void {
   $multiLineString = new MultiLineString([
     new LineString([
diff --git a/tests/Objects/MultiPointTest.php b/tests/Objects/MultiPointTest.php
@@ -93,6 +93,17 @@
   expect($multiPointFromWkt)->toEqual($multiPoint);
 });
 
+it('generates multi point WKT', function (): void {
+  $multiPoint = new MultiPoint([
+    new Point(180, 0),
+  ]);
+
+  $wkt = $multiPoint->toWkt();
+
+  $expectedWkt = 'MULTIPOINT(0 180)';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates multi point from WKB', function (): void {
   $multiPoint = new MultiPoint([
     new Point(180, 0),
diff --git a/tests/Objects/MultiPolygonTest.php b/tests/Objects/MultiPolygonTest.php
@@ -158,6 +158,25 @@
   expect($multiPolygonFromWkt)->toEqual($multiPolygon);
 });
 
+it('generates multi polygon WKT', function (): void {
+  $multiPolygon = new MultiPolygon([
+    new Polygon([
+      new LineString([
+        new Point(180, 0),
+        new Point(179, 1),
+        new Point(178, 2),
+        new Point(177, 3),
+        new Point(180, 0),
+      ]),
+    ]),
+  ]);
+
+  $wkt = $multiPolygon->toWkt();
+
+  $expectedWkt = 'MULTIPOLYGON(((0 180, 1 179, 2 178, 3 177, 0 180)))';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates multi polygon from WKB', function (): void {
   $multiPolygon = new MultiPolygon([
     new Polygon([
diff --git a/tests/Objects/PointTest.php b/tests/Objects/PointTest.php
@@ -41,7 +41,7 @@
   expect($pointFromJson)->toEqual($point);
 });
 
-it('generates point json', function (): void {
+it('generates point JSON', function (): void {
   $point = new Point(180, 0);
 
   $json = $point->toJson();
@@ -72,6 +72,15 @@
   expect($pointFromWkt)->toEqual($point);
 });
 
+it('generates point WKT', function (): void {
+  $point = new Point(180, 0);
+
+  $wkt = $point->toWkt();
+
+  $expectedWkt = 'POINT(0 180)';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates point from WKB', function (): void {
   $point = new Point(180, 0);
 
diff --git a/tests/Objects/PolygonTest.php b/tests/Objects/PolygonTest.php
@@ -141,6 +141,23 @@
   expect($polygonFromWkt)->toEqual($polygon);
 });
 
+it('generates polygon WKT', function (): void {
+  $polygon = new Polygon([
+    new LineString([
+      new Point(180, 0),
+      new Point(179, 1),
+      new Point(178, 2),
+      new Point(177, 3),
+      new Point(180, 0),
+    ]),
+  ]);
+
+  $wkt = $polygon->toWkt();
+
+  $expectedWkt = 'POLYGON((0 180, 1 179, 2 178, 3 177, 0 180))';
+  expect($wkt)->toBe($expectedWkt);
+});
+
 it('creates polygon from WKB', function (): void {
   $polygon = new Polygon([
     new LineString([

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@ abstract class Geometry implements Castable, Arrayable, Jsonable, JsonSerializab`
`20`	`20`	`{`
`21`	`21`	`public int $srid = 0;`
`22`	`22`
`23`		`- abstract public function toWkt(bool $withFunction = true): string;`
	`23`	`+ abstract public function toWkt(): string;`
	`24`	`+`
	`25`	`+ abstract public function getWktData(): string;`
`24`	`26`
`25`	`27`	`/**`
`26`	`28`	`* @param int $options`
Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,19 @@ class LineString extends PointCollection`
`8`	`8`	`{`
`9`	`9`	`protected int $minimumGeometries = 2;`
`10`	`10`
`11`		`- public function toWkt(bool $withFunction = true): string`
	`11`	`+ public function toWkt(): string`
`12`	`12`	`{`
`13`		`- $wkt = $this->toCollectionWkt(withFunction: false);`
	`13`	`+ $wktData = $this->getWktData();`
`14`	`14`
`15`		`- if ($withFunction) {`
`16`		`- return "LINESTRING(${wkt})";`
`17`		`- }`
	`15`	`+ return "LINESTRING({$wktData})";`
	`16`	`+ }`
`18`	`17`
`19`		`- return "(${wkt})";`
	`18`	`+ public function getWktData(): string`
	`19`	`+ {`
	`20`	`+ return $this->geometries`
	`21`	`+ ->map(static function (Point $point): string {`
	`22`	`+ return $point->getWktData();`
	`23`	`+ })`
	`24`	`+ ->join(', ');`
`20`	`25`	`}`
`21`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,21 @@ public function __construct(Collection\|array $geometries, int $srid = 0)`
`32`	`32`	`parent::__construct($geometries, $srid);`
`33`	`33`	`}`
`34`	`34`
`35`		`- public function toWkt(bool $withFunction = true): string`
	`35`	`+ public function toWkt(): string`
`36`	`36`	`{`
`37`		`- $wkt = $this->toCollectionWkt(withFunction: false);`
	`37`	`+ $wktData = $this->getWktData();`
`38`	`38`
`39`		`- return "MULTILINESTRING({$wkt})";`
	`39`	`+ return "MULTILINESTRING({$wktData})";`
	`40`	`+ }`
	`41`	`+`
	`42`	`+ public function getWktData(): string`
	`43`	`+ {`
	`44`	`+ return $this->geometries`
	`45`	`+ ->map(static function (LineString $lineString): string {`
	`46`	`+ $wktData = $lineString->getWktData();`
	`47`	`+`
	`48`	`+ return "({$wktData})";`
	`49`	`+ })`
	`50`	`+ ->join(', ');`
`40`	`51`	`}`
`41`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,19 @@ class MultiPoint extends PointCollection`
`8`	`8`	`{`
`9`	`9`	`protected int $minimumGeometries = 1;`
`10`	`10`
`11`		`- public function toWkt(bool $withFunction = true): string`
	`11`	`+ public function toWkt(): string`
`12`	`12`	`{`
`13`		`- $wkt = $this->toCollectionWkt(withFunction: false);`
	`13`	`+ $wktData = $this->getWktData();`
`14`	`14`
`15`		`- return "MULTIPOINT({$wkt})";`
	`15`	`+ return "MULTIPOINT({$wktData})";`
	`16`	`+ }`
	`17`	`+`
	`18`	`+ public function getWktData(): string`
	`19`	`+ {`
	`20`	`+ return $this->geometries`
	`21`	`+ ->map(static function (Point $point): string {`
	`22`	`+ return $point->getWktData();`
	`23`	`+ })`
	`24`	`+ ->join(', ');`
`16`	`25`	`}`
`17`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,15 +17,16 @@ public function __construct(float $latitude, float $longitude, int $srid = 0)`
`17`	`17`	`$this->srid = $srid;`
`18`	`18`	`}`
`19`	`19`
`20`		`- public function toWkt(bool $withFunction = true): string`
	`20`	`+ public function toWkt(): string`
`21`	`21`	`{`
`22`		`- $wkt = "{$this->longitude} {$this->latitude}";`
	`22`	`+ $wktData = $this->getWktData();`
`23`	`23`
`24`		`- if ($withFunction) {`
`25`		`- return "POINT({$wkt})";`
`26`		`- }`
	`24`	`+ return "POINT({$wktData})";`
	`25`	`+ }`
`27`	`26`
`28`		`- return $wkt;`
	`27`	`+ public function getWktData(): string`
	`28`	`+ {`
	`29`	`+ return "{$this->longitude} {$this->latitude}";`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ public function whereSrid(`
`263`	`263`	`protected function toExpression(Geometry\|string $geometryOrColumn): Expression`
`264`	`264`	`{`
`265`	`265`	`if ($geometryOrColumn instanceof Geometry) {`
`266`		`- $wkt = $geometryOrColumn->toWkt(withFunction: true);`
	`266`	`+ $wkt = $geometryOrColumn->toWkt();`
`267`	`267`
`268`	`268`	`return DB::raw("ST_GeomFromText('{$wkt}')");`
`269`	`269`	`}`