Merge pull request #883 from aanastasiou/rc/5.5.1_fix#882

Fixes #882

Author: mariusconjeaud

neomodel/contrib/spatial_properties.py

@@ -220,47 +220,47 @@ def crs(self):
         @property
         def x(self):
             if not self._crs.startswith("cartesian"):
-                raise AttributeError(
+                raise TypeError(
                     f'Invalid coordinate ("x") for points defined over {self.crs}'
                 )
             return super().x
 
         @property
         def y(self):
             if not self._crs.startswith("cartesian"):
-                raise AttributeError(
+                raise TypeError(
                     f'Invalid coordinate ("y") for points defined over {self.crs}'
                 )
             return super().y
 
         @property
         def z(self):
             if self._crs != "cartesian-3d":
-                raise AttributeError(
+                raise TypeError(
                     f'Invalid coordinate ("z") for points defined over {self.crs}'
                 )
             return super().z
 
         @property
         def latitude(self):
             if not self._crs.startswith("wgs-84"):
-                raise AttributeError(
+                raise TypeError(
                     f'Invalid coordinate ("latitude") for points defined over {self.crs}'
                 )
             return super().y
 
         @property
         def longitude(self):
             if not self._crs.startswith("wgs-84"):
-                raise AttributeError(
+                raise TypeError(
                     f'Invalid coordinate ("longitude") for points defined over {self.crs}'
                 )
             return super().x
 
         @property
         def height(self):
             if self._crs != "wgs-84-3d":
-                raise AttributeError(
+                raise TypeError(
                     f'Invalid coordinate ("height") for points defined over {self.crs}'
                 )
             return super().z
@@ -511,7 +511,7 @@ def __eq__(self, other):
             Compare objects by value
             """
             if not isinstance(other, (ShapelyPoint, NeomodelPoint)):
-                raise ValueException(
+                raise ValueError(
                     f"NeomodelPoint equality comparison expected NeomodelPoint or Shapely Point, received {type(other)}"
                 )
             else:

test/test_contrib/test_spatial_props.py

@@ -0,0 +1,122 @@
+from neomodel.contrib.spatial_properties import NeomodelPoint
+import pytest
+
+def test_failed_initialisation():
+    """
+    Tests that a NeomodelPoint cannot be instantiated in an erroneous state
+    """
+
+    # Must be instantiated with a meaningful CRS
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint(crs="blah")
+
+    # Must be instantiated with the right dimensionality of coordinates (either 2 or 3)
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint([0,0,0,0])
+
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint([0,])
+
+    # Copy constructor only on the right type of object
+    with pytest.raises(TypeError):
+        p1 = NeomodelPoint("Definitely not a Neomodel point")
+
+    # Cannot be instantiated in a cartesian or geographical CRS at the same time
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint(x=0, y=0, z=0, longitude=0, latitude=0, height=0)
+
+    # Cannot be instantiated without actually pointing somehwere in space
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint()
+
+    # CRS and supplied arguments should match (3 for a 3d crs, 2 for a 2d crs)
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint(x=0, y=0, z=0, crs="cartesian")
+
+    with pytest.raises(ValueError):
+        p1 = NeomodelPoint(x=0, y=0, crs="cartesian-3d")
+
+def test_succesful_initialisation():
+    """
+    Expected initialisation and copy constructor
+    """
+
+    p1 = NeomodelPoint(x=0, y=0)
+    p2 = NeomodelPoint(x=0, y=0, z=0)
+    p3 = NeomodelPoint(longitude=0, latitude=0)
+    p4 = NeomodelPoint(longitude=0, latitude=0, height=0)
+    p5 = NeomodelPoint([0,0])
+    p6 = NeomodelPoint([0,0,0])
+    p7 = NeomodelPoint(p6)
+
+    assert p1.crs=="cartesian" and p1.x==0 and p1.y==0
+    assert p2.crs=="cartesian-3d" and p2.x==0 and p2.y==0 and p2.z==0
+
+    assert p5.crs=="cartesian" and p5.x==0 and p5.y==0
+    assert p6.crs=="cartesian-3d" and p6.x==0 and p6.y==0 and p6.z==0
+
+    assert p3.crs=="wgs-84" and p3.longitude==0 and p3.latitude==0
+    assert p4.crs=="wgs-84-3d" and p4.longitude==0 and p4.latitude==0 and p4.height==0
+
+    assert p7.crs=="cartesian-3d" and p7.x==0 and p7.y==0 and p7.z==0
+
+def test_property_access():
+    """
+    Points initialised as 2d cannot offer access to 3d coordinates
+    """
+
+    p1 = NeomodelPoint(x=0,y=0)
+    p2 = NeomodelPoint(longitude=0, latitude=0, height=0)
+
+    with pytest.raises(TypeError):
+        assert p1.longitude == 0
+
+    with pytest.raises(TypeError):
+        assert p1.latitude == 0
+
+    with pytest.raises(TypeError):
+        assert p1.height == 0
+
+    with pytest.raises(TypeError):
+        assert p2.x == 0
+
+    with pytest.raises(TypeError):
+        assert p2.y == 0
+
+    with pytest.raises(TypeError):
+        assert p2.z == 0
+
+def test_equality_success():
+    """
+    Points with identical coordinates and CRS are equal in value
+    """
+    p1 = NeomodelPoint(x=0, y=0, z=0)
+    p2 = NeomodelPoint(x=0, y=0, z=0)
+
+    assert p1 == p2
+
+def test_equality_fails():
+    """
+    Points are comparable only with points
+    """
+    p1 = NeomodelPoint(x=0, y=0, z=0)
+
+    with pytest.raises(ValueError):
+        assert p1 == 4
+
+
+def test_equality_successful():
+    """
+    Points with identical coordinates and CRS are equal in value
+    """
+    p1 = NeomodelPoint(x=0, y=0, z=0)
+    p2 = NeomodelPoint(x=0, y=0, z=0)
+    p3 = NeomodelPoint(longitude=0, latitude=0, height=0)
+    p4 = NeomodelPoint(longitude=0, latitude=0, height=0)
+
+    assert p1 == p2
+    assert p3 == p4
+    assert p1!=p4
+    assert p3!=p2
+
+