Merge pull request #115 from wgevaert/main

Refactor point types

Fixes #114

Author: transistive

src/Formatter/Specialised/BoltOGMTranslator.php

@@ -27,6 +27,8 @@
 use Bolt\structures\Time as BoltTime;
 use Bolt\structures\UnboundRelationship as BoltUnboundRelationship;
 use function call_user_func;
+use Laudis\Neo4j\Types\Abstract3DPoint;
+use Laudis\Neo4j\Types\AbstractPoint;
 use Laudis\Neo4j\Types\Cartesian3DPoint;
 use Laudis\Neo4j\Types\CartesianPoint;
 use Laudis\Neo4j\Types\CypherList;
@@ -42,6 +44,8 @@
 use Laudis\Neo4j\Types\Relationship;
 use Laudis\Neo4j\Types\Time;
 use Laudis\Neo4j\Types\UnboundRelationship;
+use Laudis\Neo4j\Types\WGS843DPoint;
+use Laudis\Neo4j\Types\WGS84Point;
 use UnexpectedValueException;
 
 /**
@@ -185,14 +189,24 @@ private function makeFromBoltUnboundRelationship(BoltUnboundRelationship $rel):
         );
     }
 
-    private function makeFromBoltPoint2D(BoltPoint2d $x): CartesianPoint
+    private function makeFromBoltPoint2D(BoltPoint2d $x): AbstractPoint
     {
-        return new CartesianPoint($x->x(), $x->y(), 'cartesian', $x->srid());
+        if ($x->srid() === CartesianPoint::SRID) {
+            return new CartesianPoint($x->x(), $x->y());
+        } elseif ($x->srid() === WGS84Point::SRID) {
+            return new WGS84Point($x->x(), $x->y());
+        }
+        throw new UnexpectedValueException('An srid of '.$x->srid().' has been returned, which has not been implemented.');
     }
 
-    private function makeFromBoltPoint3D(BoltPoint3D $x): Cartesian3DPoint
+    private function makeFromBoltPoint3D(BoltPoint3D $x): Abstract3DPoint
     {
-        return new Cartesian3DPoint($x->x(), $x->y(), $x->z(), 'cartesian', $x->srid());
+        if ($x->srid() === Cartesian3DPoint::SRID) {
+            return new Cartesian3DPoint($x->x(), $x->y(), $x->z());
+        } elseif ($x->srid() === WGS843DPoint::SRID) {
+            return new WGS843DPoint($x->x(), $x->y(), $x->z());
+        }
+        throw new UnexpectedValueException('An srid of '.$x->srid().' has been returned, which has not been implemented.');
     }
 
     private function makeFromBoltPath(BoltPath $path): Path

src/Formatter/Specialised/HttpOGMTranslator.php

@@ -42,6 +42,7 @@
 use stdClass;
 use function str_pad;
 use function substr;
+use UnexpectedValueException;
 
 /**
  * @psalm-immutable
@@ -278,50 +279,39 @@ private function translatePoint(stdClass $value): PointInterface
     {
         /** @var stdClass $crs */
         $crs = $value->crs;
-        /** @var "cartesian"|"cartesian-3d"|"wgs-84"|"wgs-84-3d" */
-        $name = $crs->name;
         /** @var array{0: float, 1: float, 2:float} $coordinates */
         $coordinates = $value->coordinates;
         /** @var int $srid */
         $srid = $crs->srid;
-        if ($name === 'cartesian') {
+        if ($srid === CartesianPoint::SRID) {
             return new CartesianPoint(
                 $coordinates[0],
                 $coordinates[1],
-                $name,
-                $srid
             );
         }
-        if ($name === 'cartesian-3d') {
+        if ($srid === Cartesian3DPoint::SRID) {
             return new Cartesian3DPoint(
                 $coordinates[0],
                 $coordinates[1],
                 $coordinates[2],
-                $name,
-                $srid
             );
         }
-        if ($name === 'wgs-84') {
+        if ($srid === WGS84Point::SRID) {
             return new WGS84Point(
                 $coordinates[0],
                 $coordinates[1],
+            );
+        }
+        if ($srid === WGS843DPoint::SRID) {
+            return new WGS843DPoint(
                 $coordinates[0],
                 $coordinates[1],
-                $name,
-                $srid
+                $coordinates[2],
             );
         }
-
-        return new WGS843DPoint(
-            $coordinates[0],
-            $coordinates[1],
-            $coordinates[2],
-            $coordinates[0],
-            $coordinates[1],
-            $coordinates[2],
-            $name,
-            $srid
-        );
+        /** @var string $name */
+        $name = $crs->name;
+        throw new UnexpectedValueException('A point with srid '.$srid.' and name '.$name.' has been returned, which has not been implemented.');
     }
 
     /**

src/Types/Abstract3DPoint.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Types;
+
+use Bolt\structures\IStructure;
+use Bolt\structures\Point3D;
+use Laudis\Neo4j\Contracts\BoltConvertibleInterface;
+use Laudis\Neo4j\Contracts\PointInterface;
+
+/**
+ * A cartesian point in three dimensional space.
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-point-cartesian-3d
+ *
+ * @psalm-immutable
+ *
+ * @psalm-import-type Crs from \Laudis\Neo4j\Contracts\PointInterface
+ */
+abstract class Abstract3DPoint extends AbstractPoint implements PointInterface, BoltConvertibleInterface
+{
+    private float $z;
+
+    public function convertToBolt(): IStructure
+    {
+        return new Point3D($this->getSrid(), $this->getX(), $this->getY(), $this->getZ());
+    }
+
+    /**
+     * @param Crs $crs
+     */
+    public function __construct(float $x, float $y, float $z)
+    {
+        parent::__construct($x, $y);
+        $this->z = $z;
+    }
+
+    public function getZ(): float
+    {
+        return $this->z;
+    }
+
+    /**
+     * @return array{x: float, y: float, z: float, srid: int, crs: Crs}
+     */
+    public function toArray(): array
+    {
+        $tbr = parent::toArray();
+
+        $tbr['z'] = $this->z;
+
+        return $tbr;
+    }
+}

src/Types/AbstractPoint.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Types;
+
+use Bolt\structures\IStructure;
+use Bolt\structures\Point2D;
+use Laudis\Neo4j\Contracts\BoltConvertibleInterface;
+use Laudis\Neo4j\Contracts\PointInterface;
+
+/**
+ * A cartesian point in two dimensional space.
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/functions/spatial/#functions-point-cartesian-2d
+ *
+ * @psalm-immutable
+ *
+ * @psalm-import-type Crs from \Laudis\Neo4j\Contracts\PointInterface
+ */
+abstract class AbstractPoint extends AbstractPropertyObject implements PointInterface, BoltConvertibleInterface
+{
+    private float $x;
+    private float $y;
+
+    /**
+     * @param Crs $crs
+     */
+    public function __construct(float $x, float $y)
+    {
+        $this->x = $x;
+        $this->y = $y;
+    }
+
+    abstract public function getCrs(): string;
+
+    abstract public function getSrid(): int;
+
+    public function convertToBolt(): IStructure
+    {
+        return new Point2D($this->getSrid(), $this->getX(), $this->getY());
+    }
+
+    public function getX(): float
+    {
+        return $this->x;
+    }
+
+    public function getY(): float
+    {
+        return $this->y;
+    }
+
+    public function getProperties(): CypherMap
+    {
+        /** @psalm-suppress InvalidReturnStatement False positive */
+        return new CypherMap($this);
+    }
+
+    /**
+     * @psalm-suppress ImplementedReturnTypeMismatch False positive
+     *
+     * @return array{x: float, y: float, crs: Crs, srid: int}
+     */
+    public function toArray(): array
+    {
+        return [
+            'x' => $this->x,
+            'y' => $this->y,
+            'crs' => $this->getCrs(),
+            'srid' => $this->getSrid(),
+        ];
+    }
+}

src/Types/Cartesian3DPoint.php

@@ -13,8 +13,6 @@
 
 namespace Laudis\Neo4j\Types;
 
-use Bolt\structures\IStructure;
-use Bolt\structures\Point3D;
 use Laudis\Neo4j\Contracts\BoltConvertibleInterface;
 use Laudis\Neo4j\Contracts\PointInterface;
 
@@ -27,38 +25,18 @@
  *
  * @psalm-import-type Crs from \Laudis\Neo4j\Contracts\PointInterface
  */
-class Cartesian3DPoint extends CartesianPoint implements PointInterface, BoltConvertibleInterface
+final class Cartesian3DPoint extends Abstract3DPoint implements PointInterface, BoltConvertibleInterface
 {
-    private float $z;
+    public const SRID = 9157;
+    public const CRS = 'cartesian-3d';
 
-    public function convertToBolt(): IStructure
+    public function getSrid(): int
     {
-        return new Point3D($this->getSrid(), $this->getX(), $this->getY(), $this->getZ());
+        return self::SRID;
     }
 
-    /**
-     * @param Crs $crs
-     */
-    public function __construct(float $x, float $y, float $z, string $crs, int $srid)
+    public function getCrs(): string
     {
-        parent::__construct($x, $y, $crs, $srid);
-        $this->z = $z;
-    }
-
-    public function getZ(): float
-    {
-        return $this->z;
-    }
-
-    /**
-     * @return array{x: float, y: float, z: float, srid: int, crs: Crs}
-     */
-    public function toArray(): array
-    {
-        $tbr = parent::toArray();
-
-        $tbr['z'] = $this->z;
-
-        return $tbr;
+        return self::CRS;
     }
 }