rgeo 2.4.0 → 3.0.0

data/lib/rgeo/feature/geometry.rb

@@ -78,7 +78,6 @@ module RGeo
     # Therefore, if an implementation cannot provide a suitable test for
     # their equivalence types, they must degrade to use a stronger form
     # of equivalence.
-
     module Geometry
       extend Type
 
@@ -90,7 +89,7 @@ module RGeo
       # operations on them.)
 
       def factory
-        raise Error::UnsupportedOperation, "Method Geometry#factory not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#factory not defined."
       end
 
       # === SFS 1.1 Description
@@ -105,7 +104,37 @@ module RGeo
       # point geometries, 1 for curves, and 2 for surfaces.
 
       def dimension
-        raise Error::UnsupportedOperation, "Method Geometry#dimension not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#dimension not defined."
+      end
+
+      # === SFS 1.2 Description
+      #
+      # The coordinate dimension is the dimension of direct positions (coordinate tuples) used in
+      # the definition of this geometric object
+      #
+      # === Notes
+      #
+      # Difference between this and dimension is that this is the dimension of the coordinate
+      # not the dimension of the geometry.
+      #
+      # @return [Integer]
+      def coordinate_dimension
+        raise Error::UnsupportedOperation, "Method #{self.class}#coordinate_dimension not defined."
+      end
+
+      # === SFS 1.2 Description
+      #
+      # The spatial dimension is the dimension of the spatial portion of the direct positions
+      # (coordinate tuples) used in the definition of this geometric object. If the direct positions
+      # do not carry a measure coordinate, this will be equal to the coordinate dimension.
+      #
+      # === Notes
+      #
+      # Similar to coordinate_dimension except it will ignore the M component always.
+      #
+      # @return [Integer]
+      def spatial_dimension
+        raise Error::UnsupportedOperation, "Method #{self.class}#spatial_dimension not defined."
       end
 
       # === SFS 1.1 Description
@@ -122,7 +151,7 @@ module RGeo
       # call the +type_name+ method of the returned module.
 
       def geometry_type
-        raise Error::UnsupportedOperation, "Method Geometry#geometry_type not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#geometry_type not defined."
       end
 
       # === SFS 1.1 Description
@@ -137,7 +166,7 @@ module RGeo
       # stored in either the same or some other datastore.
 
       def srid
-        raise Error::UnsupportedOperation, "Method Geometry#srid not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#srid not defined."
       end
 
       # === SFS 1.1 Description
@@ -151,7 +180,7 @@ module RGeo
       # Returns an object that supports the Geometry interface.
 
       def envelope
-        raise Error::UnsupportedOperation, "Method Geometry#envelope not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#envelope not defined."
       end
 
       # === SFS 1.1 Description
@@ -164,7 +193,7 @@ module RGeo
       # Returns an ASCII string.
 
       def as_text
-        raise Error::UnsupportedOperation, "Method Geometry#as_text not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#as_text not defined."
       end
 
       # === SFS 1.1 Description
@@ -177,7 +206,7 @@ module RGeo
       # Returns a binary string.
 
       def as_binary
-        raise Error::UnsupportedOperation, "Method Geometry#as_binary not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#as_binary not defined."
       end
 
       # === SFS 1.1 Description
@@ -192,12 +221,7 @@ module RGeo
       # specification, which stipulates an integer return value.
 
       def empty?
-        raise Error::UnsupportedOperation, "Method Geometry#empty? not defined."
-      end
-
-      def is_empty?
-        warn "The is_empty? method is deprecated, please use the empty? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
-        empty?
+        raise Error::UnsupportedOperation, "Method #{self.class}#empty? not defined."
       end
 
       # === SFS 1.1 Description
@@ -214,12 +238,29 @@ module RGeo
       # specification, which stipulates an integer return value.
 
       def simple?
-        raise Error::UnsupportedOperation, "Method Geometry#simple? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#simple? not defined."
       end
 
-      def is_simple?
-        warn "The is_simple? method is deprecated, please use the simple? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
-        simple?
+      # === SFS 1.2 Description
+      #
+      # Returns 1 (TRUE) if this geometric object has z coordinate values.
+      #
+      # === Notes
+      #
+      # @return [Boolean]
+      def is_3d?
+        raise Error::UnsupportedOperation, "Method #{self.class}#is_3d? not defined."
+      end
+
+      # === SFS 1.2 Description
+      #
+      # Returns 1 (TRUE) if this geometric object has m coordinate values.
+      #
+      # === Notes
+      #
+      # @return [Boolean]
+      def measured?
+        raise Error::UnsupportedOperation, "Method #{self.class}#measured? not defined."
       end
 
       # === SFS 1.1 Description
@@ -234,7 +275,7 @@ module RGeo
       # Returns an object that supports the Geometry interface.
 
       def boundary
-        raise Error::UnsupportedOperation, "Method Geometry#boundary not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#boundary not defined."
       end
 
       # === SFS 1.1 Description
@@ -252,8 +293,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def equals?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#equals? not defined."
+      def equals?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#equals? not defined."
       end
 
       # === SFS 1.1 Description
@@ -271,8 +312,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def disjoint?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#disjoint? not defined."
+      def disjoint?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#disjoint? not defined."
       end
 
       # === SFS 1.1 Description
@@ -290,8 +331,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def intersects?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#intersects? not defined."
+      def intersects?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#intersects? not defined."
       end
 
       # === SFS 1.1 Description
@@ -309,8 +350,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def touches?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#touches? not defined."
+      def touches?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#touches? not defined."
       end
 
       # === SFS 1.1 Description
@@ -328,8 +369,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def crosses?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#crosses? not defined."
+      def crosses?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#crosses? not defined."
       end
 
       # === SFS 1.1 Description
@@ -347,8 +388,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def within?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#within? not defined."
+      def within?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#within? not defined."
       end
 
       # === SFS 1.1 Description
@@ -366,8 +407,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def contains?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#contains? not defined."
+      def contains?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#contains? not defined."
       end
 
       # === SFS 1.1 Description
@@ -385,8 +426,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def overlaps?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#overlaps? not defined."
+      def overlaps?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#overlaps? not defined."
       end
 
       # === SFS 1.1 Description
@@ -411,8 +452,35 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def relate?(another_geometry, _intersection_pattern_matrix_)
-        raise Error::UnsupportedOperation, "Method Geometry#relate not defined."
+      def relate?(_another_geometry, _intersection_pattern_matrix_)
+        raise Error::UnsupportedOperation, "Method #{self.class}#relate not defined."
+      end
+
+      # === SFS 1.2 Description
+      #
+      # Returns a derived geometry collection value that matches the
+      # specified m coordinate value.
+      #
+      # === Notes
+      #
+      # @param m_value [Float] value to find matches for
+      # @return [RGeo::Feature::GeometryCollection]
+      def locate_along
+        raise Error::UnsupportedOperation, "Method #{self.class}#locate_along not defined."
+      end
+
+      # === SFS 1.2 Description
+      #
+      # Returns a derived geometry collection value
+      # that matches the specified range of m coordinate values inclusively
+      #
+      # === Notes
+      #
+      # @param m_start [Float] lower bound of value range
+      # @param m_end [Float] upper bound of value range
+      # @return [RGeo::Feature::GeometryCollection]
+      def locate_between
+        raise Error::UnsupportedOperation, "Method #{self.class}#locate_between not defined."
       end
 
       # === SFS 1.1 Description
@@ -430,8 +498,8 @@ module RGeo
       # this geometry, strictly speaking, the result of measuring the
       # distance between objects from different factories is undefined.
 
-      def distance(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#distance not defined."
+      def distance(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#distance not defined."
       end
 
       # === SFS 1.1 Description
@@ -446,7 +514,7 @@ module RGeo
       # Returns an object that supports the Geometry interface.
 
       def buffer(_distance_)
-        raise Error::UnsupportedOperation, "Method Geometry#buffer not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#buffer not defined."
       end
 
       # === SFS 1.1 Description
@@ -459,7 +527,7 @@ module RGeo
       # Returns an object that supports the Geometry interface.
 
       def convex_hull
-        raise Error::UnsupportedOperation, "Method Geometry#convex_hull not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#convex_hull not defined."
       end
 
       # === SFS 1.1 Description
@@ -476,8 +544,8 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def intersection(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#intersection not defined."
+      def intersection(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#intersection not defined."
       end
 
       # === SFS 1.1 Description
@@ -494,8 +562,8 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def union(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#union not defined."
+      def union(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#union not defined."
       end
 
       # === SFS 1.1 Description
@@ -512,8 +580,8 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def difference(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#difference not defined."
+      def difference(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#difference not defined."
       end
 
       # === SFS 1.1 Description
@@ -530,8 +598,8 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def sym_difference(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#sym_difference not defined."
+      def sym_difference(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#sym_difference not defined."
       end
 
       # Returns true if this geometric object is representationally
@@ -542,8 +610,8 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def rep_equals?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#rep_equals? not defined."
+      def rep_equals?(_another_geometry)
+        raise Error::UnsupportedOperation, "Method #{self.class}#rep_equals? not defined."
       end
 
       # Unions a collection of Geometry or a single Geometry
@@ -560,7 +628,7 @@ module RGeo
       # returns nil.
       #
       def unary_union
-        raise Error::UnsupportedOperation, "Method Geometry#unary_union not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#unary_union not defined."
       end
 
       # This method should behave almost the same as the rep_equals?
@@ -578,12 +646,12 @@ module RGeo
       # representational equivalence test, this method must fall back on
       # objective equivalence.
 
-      def eql?(rhs)
-        if rhs.is_a?(RGeo::Feature::Instance)
+      def eql?(other)
+        if other.is_a?(RGeo::Feature::Instance)
           begin
-            rep_equals?(rhs)
+            rep_equals?(other)
           rescue Error::UnsupportedOperation
-            equal?(rhs)
+            equal?(other)
           end
         else
           false
@@ -604,12 +672,12 @@ module RGeo
       # test, the == operator must fall back on representational or
       # objective equivalence.
 
-      def ==(rhs)
-        if rhs.is_a?(RGeo::Feature::Instance)
+      def ==(other)
+        if other.is_a?(RGeo::Feature::Instance)
           begin
-            equals?(rhs)
+            equals?(other)
           rescue Error::UnsupportedOperation
-            eql?(rhs)
+            eql?(other)
           end
         else
           false
@@ -621,8 +689,8 @@ module RGeo
       # types is not specified; an implementation may choose to provide
       # additional capabilities as appropriate.
 
-      def -(rhs)
-        difference(rhs)
+      def -(other)
+        difference(other)
       end
 
       # If the given rhs is a geometry object, this operator must behave
@@ -630,8 +698,8 @@ module RGeo
       # is not specified; an implementation may choose to provide
       # additional capabilities as appropriate.
 
-      def +(rhs)
-        union(rhs)
+      def +(other)
+        union(other)
       end
 
       # If the given rhs is a geometry object, this operator must behave
@@ -639,8 +707,20 @@ module RGeo
       # types is not specified; an implementation may choose to provide
       # additional capabilities as appropriate.
 
-      def *(rhs)
-        intersection(rhs)
+      def *(other)
+        intersection(other)
+      end
+
+      # Convenience method to transform/project a geometry
+      # to a different coordinate system from the geometry itself
+      # instead of the cast method.
+      #
+      # @note: Not an OGC SFS method
+      #
+      # @param [RGeo::Feature::Factory] other_factory
+      # @return [RGeo::Feature::Geometry]
+      def transform(other_factory)
+        Feature.cast(self, factory: other_factory, project: true)
       end
     end
   end

data/lib/rgeo/feature/geometry_collection.rb

@@ -28,7 +28,6 @@ module RGeo
     # include this module itself. Therefore, you should not depend on the
     # kind_of? method to check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-
     module GeometryCollection
       include Geometry
       extend Type
@@ -44,7 +43,7 @@ module RGeo
       # Returns an integer.
 
       def num_geometries
-        raise Error::UnsupportedOperation, "Method GeometryCollection#num_geometries not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#num_geometries not defined."
       end
 
       # === SFS 1.1 Description
@@ -58,8 +57,8 @@ module RGeo
       # Also note that this method is different from GeometryCollection#[]
       # in that it does not support negative indexes.
 
-      def geometry_n(n)
-        raise Error::UnsupportedOperation, "Method GeometryCollection#geometry_n not defined."
+      def geometry_n(_idx)
+        raise Error::UnsupportedOperation, "Method #{self.class}#geometry_n not defined."
       end
 
       # Alias of the num_geometries method.
@@ -78,14 +77,14 @@ module RGeo
       # the same way Ruby's array indexing works. Hence, geometry_n(-1)
       # returns nil, where [-1] returns the last element of the collection.
 
-      def [](n)
-        raise Error::UnsupportedOperation, "Method GeometryCollection#[] not defined."
+      def [](_idx)
+        raise Error::UnsupportedOperation, "Method #{self.class}#[] not defined."
       end
 
       # Nodes the linework in a list of Geometries
       #
       def node
-        raise Error::UnsupportedOperation, "Method GeometryCollection#node not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#node not defined."
       end
 
       # Iterates over the geometries of this GeometryCollection.
@@ -95,8 +94,16 @@ module RGeo
       # Note that all GeometryCollection implementations must also
       # include the Enumerable mixin.
 
-      def each(&block)
-        raise Error::UnsupportedOperation, "Method GeometryCollection#each not defined."
+      def each(&_block)
+        raise Error::UnsupportedOperation, "Method #{self.class}#each not defined."
+      end
+
+      # Gives a point that is guaranteed to be within the geometry.
+      #
+      # Extends OGC SFS 1.1 and follows PostGIS standards.
+      # @see https://postgis.net/docs/ST_PointOnSurface.html
+      def point_on_surface
+        raise Error::UnsupportedOperation, "Method #{self.class}#each not defined."
       end
     end
   end

data/lib/rgeo/feature/line_string.rb

@@ -20,7 +20,6 @@ module RGeo
     # include this module itself. Therefore, you should not depend on the
     # kind_of? method to check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-
     module LineString
       include Curve
       extend Type
@@ -34,7 +33,7 @@ module RGeo
       # Returns an integer.
 
       def num_points
-        raise Error::UnsupportedOperation, "Method LineString#num_points not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#num_points not defined."
       end
 
       # === SFS 1.1 Description
@@ -47,15 +46,15 @@ module RGeo
       # if the given N is out of range. N is zero-based.
       # Does not support negative indexes.
 
-      def point_n(n)
-        raise Error::UnsupportedOperation, "Method LineString#point_n not defined."
+      def point_n(_idx)
+        raise Error::UnsupportedOperation, "Method #{self.class}#point_n not defined."
       end
 
       # Returns the constituent points as an array of objects that
       # support the Point interface.
 
       def points
-        raise Error::UnsupportedOperation, "Method LineString#points not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#points not defined."
       end
     end
   end

data/lib/rgeo/feature/linear_ring.rb

@@ -19,7 +19,6 @@ module RGeo
     # include this module itself. Therefore, you should not depend on the
     # kind_of? method to check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-
     module LinearRing
       include LineString
       extend Type

data/lib/rgeo/feature/multi_curve.rb

@@ -37,7 +37,6 @@ module RGeo
     # include this module itself. Therefore, you should not depend on the
     # kind_of? method to check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-
     module MultiCurve
       include GeometryCollection
       extend Type
@@ -68,11 +67,6 @@ module RGeo
       def closed?
         raise Error::UnsupportedOperation, "Method MultiCurve#closed? not defined."
       end
-
-      def is_closed?
-        warn "The is_closed? method is deprecated, please use the closed? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
-        closed?
-      end
     end
   end
 end

data/lib/rgeo/feature/multi_surface.rb

@@ -28,7 +28,6 @@ module RGeo
     # include this module itself. Therefore, you should not depend on the
     # kind_of? method to check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-
     module MultiSurface
       include GeometryCollection
       extend Type
@@ -43,7 +42,7 @@ module RGeo
       # Returns a floating-point scalar value.
 
       def area
-        raise Error::UnsupportedOperation, "Method MultiSurface#area not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#area not defined."
       end
 
       # === SFS 1.1 Description
@@ -56,7 +55,7 @@ module RGeo
       # Returns an object that supports the Point interface.
 
       def centroid
-        raise Error::UnsupportedOperation, "Method MultiSurface#centroid not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#centroid not defined."
       end
 
       # === SFS 1.1 Description
@@ -68,7 +67,7 @@ module RGeo
       # Returns an object that supports the Point interface.
 
       def point_on_surface
-        raise Error::UnsupportedOperation, "Method MultiSurface#point_on_surface not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#point_on_surface not defined."
       end
     end
   end

data/lib/rgeo/feature/point.rb

@@ -33,7 +33,6 @@ module RGeo
     # replace them with empty GeometryCollection objects. Therefore,
     # currently, every RGeo Point object represents an actual location
     # with real coordinates.
-
     module Point
       include Geometry
       extend Type
@@ -47,7 +46,7 @@ module RGeo
       # Returns a floating-point scalar value.
 
       def x
-        raise Error::UnsupportedOperation, "Method Point#x not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#x not defined."
       end
 
       # === SFS 1.1 Description
@@ -59,7 +58,7 @@ module RGeo
       # Returns a floating-point scalar value.
 
       def y
-        raise Error::UnsupportedOperation, "Method Point#y not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#y not defined."
       end
 
       # Returns the z-coordinate for this Point as a floating-point
@@ -69,7 +68,7 @@ module RGeo
       # not support Z coordinates.
 
       def z
-        raise Error::UnsupportedOperation, "Method Point#z not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#z not defined."
       end
 
       # Returns the m-coordinate for this Point as a floating-point
@@ -79,7 +78,7 @@ module RGeo
       # not support M coordinates.
 
       def m
-        raise Error::UnsupportedOperation, "Method Point#m not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#m not defined."
       end
     end
   end

data/lib/rgeo/feature/polygon.rb

@@ -45,7 +45,6 @@ module RGeo
     # include this module itself. Therefore, you should not depend on the
     # kind_of? method to check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-
     module Polygon
       include Surface
       extend Type
@@ -84,7 +83,7 @@ module RGeo
       # if the given N is out of range. N is zero-based.
       # Does not support negative indexes.
 
-      def interior_ring_n(n)
+      def interior_ring_n(_idx)
         raise Error::UnsupportedOperation, "Method Polygon#interior_ring_n not defined."
       end