rgeo 2.3.1 → 3.0.0.pre.rc.2

data/lib/rgeo/error.rb

@@ -29,5 +29,20 @@ module RGeo
     # Parsing failed
     class ParseError < RGeoError
     end
+
+    # Standard error messages from
+    # https://github.com/locationtech/jts/blob/0afbfb1956ec24912a8b4dc4edff0f1200442857/modules/core/src/main/java/org/locationtech/jts/operation/valid/TopologyValidationError.java#L98-L110
+    TOPOLOGY_VALIDATION_ERR = "Topology Validation Error"
+    REPEATED_POINT = "Repeated Point"
+    HOLE_OUTSIDE_SHELL = "Hole lies outside shell"
+    NESTED_HOLES = "Holes are nested"
+    DISCONNECTED_INTERIOR = "Interior is disconnected"
+    SELF_INTERSECTION = "Self-intersection"
+    RING_SELF_INTERSECTION = "Ring Self-intersection"
+    NESTED_SHELLS = "Nested shells"
+    DUPLICATE_RINGS = "Duplicate Rings"
+    TOO_FEW_POINTS = "Too few distinct points in geometry component"
+    INVALID_COORDINATE = "Invalid Coordinate"
+    UNCLOSED_RING = "Ring is not closed"
   end
 end

data/lib/rgeo/feature/factory_generator.rb

@@ -66,9 +66,6 @@ module RGeo
       #   CoordSys::CS::CoordinateSystem, or as a string in WKT format.
       #   This is usually an optional parameter; the default is usually
       #   nil.
-      # [<tt>:srs_database</tt>]
-      #   If provided, look up the Proj4 and OGC coordinate systems from
-      #   the given database and SRID.
       # [<tt>:has_z_coordinate</tt>]
       #   Support Z coordinates. Default is usually false.
       # [<tt>:has_m_coordinate</tt>]

data/lib/rgeo/feature/geometry.rb

@@ -90,7 +90,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 +105,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 +152,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 +167,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 +181,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 +194,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 +207,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,7 +222,7 @@ module RGeo
       # specification, which stipulates an integer return value.
 
       def empty?
-        raise Error::UnsupportedOperation, "Method Geometry#empty? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#empty? not defined."
       end
 
       def is_empty?
@@ -214,7 +244,7 @@ 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?
@@ -222,6 +252,28 @@ module RGeo
         simple?
       end
 
+      # === 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
       #
       # Returns the closure of the combinatorial boundary of this geometric
@@ -234,7 +286,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
@@ -253,7 +305,7 @@ module RGeo
       # from different factories is undefined.
 
       def equals?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#equals? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#equals? not defined."
       end
 
       # === SFS 1.1 Description
@@ -272,7 +324,7 @@ module RGeo
       # from different factories is undefined.
 
       def disjoint?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#disjoint? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#disjoint? not defined."
       end
 
       # === SFS 1.1 Description
@@ -291,7 +343,7 @@ module RGeo
       # from different factories is undefined.
 
       def intersects?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#intersects? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#intersects? not defined."
       end
 
       # === SFS 1.1 Description
@@ -310,7 +362,7 @@ module RGeo
       # from different factories is undefined.
 
       def touches?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#touches? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#touches? not defined."
       end
 
       # === SFS 1.1 Description
@@ -329,7 +381,7 @@ module RGeo
       # from different factories is undefined.
 
       def crosses?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#crosses? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#crosses? not defined."
       end
 
       # === SFS 1.1 Description
@@ -348,7 +400,7 @@ module RGeo
       # from different factories is undefined.
 
       def within?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#within? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#within? not defined."
       end
 
       # === SFS 1.1 Description
@@ -367,7 +419,7 @@ module RGeo
       # from different factories is undefined.
 
       def contains?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#contains? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#contains? not defined."
       end
 
       # === SFS 1.1 Description
@@ -386,7 +438,7 @@ module RGeo
       # from different factories is undefined.
 
       def overlaps?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#overlaps? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#overlaps? not defined."
       end
 
       # === SFS 1.1 Description
@@ -412,7 +464,34 @@ module RGeo
       # from different factories is undefined.
 
       def relate?(another_geometry, _intersection_pattern_matrix_)
-        raise Error::UnsupportedOperation, "Method Geometry#relate not defined."
+        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
@@ -431,7 +510,7 @@ module RGeo
       # distance between objects from different factories is undefined.
 
       def distance(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#distance not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#distance not defined."
       end
 
       # === SFS 1.1 Description
@@ -446,7 +525,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 +538,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
@@ -477,7 +556,7 @@ module RGeo
       # operations on objects from different factories is undefined.
 
       def intersection(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#intersection not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#intersection not defined."
       end
 
       # === SFS 1.1 Description
@@ -495,7 +574,7 @@ module RGeo
       # operations on objects from different factories is undefined.
 
       def union(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#union not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#union not defined."
       end
 
       # === SFS 1.1 Description
@@ -513,7 +592,7 @@ module RGeo
       # operations on objects from different factories is undefined.
 
       def difference(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#difference not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#difference not defined."
       end
 
       # === SFS 1.1 Description
@@ -531,7 +610,7 @@ module RGeo
       # operations on objects from different factories is undefined.
 
       def sym_difference(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#sym_difference not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#sym_difference not defined."
       end
 
       # Returns true if this geometric object is representationally
@@ -543,7 +622,7 @@ module RGeo
       # from different factories is undefined.
 
       def rep_equals?(another_geometry)
-        raise Error::UnsupportedOperation, "Method Geometry#rep_equals? not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#rep_equals? not defined."
       end
 
       # Unions a collection of Geometry or a single Geometry
@@ -560,7 +639,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?

data/lib/rgeo/feature/geometry_collection.rb

@@ -44,7 +44,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
@@ -59,7 +59,7 @@ module RGeo
       # in that it does not support negative indexes.
 
       def geometry_n(n)
-        raise Error::UnsupportedOperation, "Method GeometryCollection#geometry_n not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class}#geometry_n not defined."
       end
 
       # Alias of the num_geometries method.
@@ -79,13 +79,13 @@ module RGeo
       # returns nil, where [-1] returns the last element of the collection.
 
       def [](n)
-        raise Error::UnsupportedOperation, "Method GeometryCollection#[] not defined."
+        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.
@@ -96,7 +96,15 @@ module RGeo
       # include the Enumerable mixin.
 
       def each(&block)
-        raise Error::UnsupportedOperation, "Method GeometryCollection#each not defined."
+        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

@@ -34,7 +34,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
@@ -48,14 +48,14 @@ module RGeo
       # Does not support negative indexes.
 
       def point_n(n)
-        raise Error::UnsupportedOperation, "Method LineString#point_n not defined."
+        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/multi_surface.rb

@@ -43,7 +43,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 +56,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 +68,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

@@ -47,7 +47,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 +59,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 +69,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 +79,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/surface.rb

@@ -49,7 +49,7 @@ module RGeo
       # Returns a floating-point scalar value.
 
       def area
-        raise Error::UnsupportedOperation, "Method Surface#area not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class.name}#area not defined."
       end
 
       # === SFS 1.1 Description
@@ -62,7 +62,7 @@ module RGeo
       # Returns an object that supports the Point interface.
 
       def centroid
-        raise Error::UnsupportedOperation, "Method Surface#centroid not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class.name}#centroid not defined."
       end
 
       # === SFS 1.1 Description
@@ -74,7 +74,7 @@ module RGeo
       # Returns an object that supports the Point interface.
 
       def point_on_surface
-        raise Error::UnsupportedOperation, "Method Surface#point_on_surface not defined."
+        raise Error::UnsupportedOperation, "Method #{self.class.name}#point_on_surface not defined."
       end
     end
   end

data/lib/rgeo/geographic/factory.rb

@@ -31,6 +31,11 @@ module RGeo
         @multi_polygon_class = Geographic.const_get("#{impl_prefix}MultiPolygonImpl")
         @support_z = opts[:has_z_coordinate] ? true : false
         @support_m = opts[:has_m_coordinate] ? true : false
+        @coordinate_dimension = 2
+        @coordinate_dimension += 1 if @support_z
+        @coordinate_dimension += 1 if @support_m
+        @spatial_dimension = @support_z ? 3 : 2
+
         @srid = (opts[:srid] || 4326).to_i
         @proj4 = opts[:proj4]
         if @proj4 && CoordSys.check!(:proj4)
@@ -42,7 +47,6 @@ module RGeo
         if @coord_sys.is_a?(String)
           @coord_sys = CoordSys::CS.create_from_wkt(@coord_sys)
         end
-        @lenient_assertions = opts[:uses_lenient_assertions] ? true : false
         @buffer_resolution = opts[:buffer_resolution].to_i
         @buffer_resolution = 1 if @buffer_resolution < 1
 
@@ -76,6 +80,7 @@ module RGeo
         end
         @projector = nil
       end
+      attr_reader :coordinate_dimension, :spatial_dimension
 
       # Equivalence test.
 
@@ -106,7 +111,6 @@ module RGeo
           "wkbg" => @wkb_generator.properties,
           "wktp" => @wkt_parser.properties,
           "wkbp" => @wkb_parser.properties,
-          "lena" => @lenient_assertions,
           "bufr" => @buffer_resolution
         }
         hash_["proj4"] = @proj4.marshal_dump if @proj4
@@ -138,7 +142,6 @@ module RGeo
           wkb_generator: symbolize_hash(data_["wkbg"]),
           wkt_parser: symbolize_hash(data_["wktp"]),
           wkb_parser: symbolize_hash(data_["wkbp"]),
-          uses_lenient_assertions: data_["lena"],
           buffer_resolution: data_["bufr"],
           proj4: proj4,
           coord_sys: coord_sys
@@ -164,7 +167,6 @@ module RGeo
         coder["wkb_generator"] = @wkb_generator.properties
         coder["wkt_parser"] = @wkt_parser.properties
         coder["wkb_parser"] = @wkb_parser.properties
-        coder["lenient_assertions"] = @lenient_assertions
         coder["buffer_resolution"] = @buffer_resolution
         if @proj4
           str = @proj4.original_str || @proj4.canonical_str
@@ -201,7 +203,6 @@ module RGeo
           wkb_generator: symbolize_hash(coder["wkb_generator"]),
           wkt_parser: symbolize_hash(coder["wkt_parser"]),
           wkb_parser: symbolize_hash(coder["wkb_parser"]),
-          uses_lenient_assertions: coder["lenient_assertions"],
           buffer_resolution: coder["buffer_resolution"],
           proj4: proj4,
           coord_sys: coord_sys
@@ -293,8 +294,6 @@ module RGeo
           @support_z
         when :has_m_coordinate
           @support_m
-        when :uses_lenient_assertions
-          @lenient_assertions
         when :buffer_resolution
           @buffer_resolution
         when :is_geographic