rgeo 2.1.0 → 2.3.1

data/lib/rgeo/feature/curve.rb

@@ -90,8 +90,13 @@ module RGeo
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
 
+      def closed?
+        raise Error::UnsupportedOperation, "Method Curve#closed? not defined."
+      end
+
       def is_closed?
-        raise Error::UnsupportedOperation, "Method Curve#is_closed? not defined."
+        warn "The is_closed? method is deprecated, please use the closed? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        closed?
       end
 
       # === SFS 1.1 Description
@@ -105,8 +110,13 @@ module RGeo
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
 
+      def ring?
+        raise Error::UnsupportedOperation, "Method Curve#ring? not defined."
+      end
+
       def is_ring?
-        raise Error::UnsupportedOperation, "Method Curve#is_ring? not defined."
+        warn "The is_ring? method is deprecated, please use the ring? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        ring?
       end
     end
   end

data/lib/rgeo/feature/geometry.rb

@@ -191,8 +191,13 @@ module RGeo
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
 
+      def empty?
+        raise Error::UnsupportedOperation, "Method Geometry#empty? not defined."
+      end
+
       def is_empty?
-        raise Error::UnsupportedOperation, "Method Geometry#is_empty? not defined."
+        warn "The is_empty? method is deprecated, please use the empty? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        empty?
       end
 
       # === SFS 1.1 Description
@@ -208,8 +213,13 @@ module RGeo
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
 
+      def simple?
+        raise Error::UnsupportedOperation, "Method Geometry#simple? not defined."
+      end
+
       def is_simple?
-        raise Error::UnsupportedOperation, "Method Geometry#is_simple? not defined."
+        warn "The is_simple? method is deprecated, please use the simple? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        simple?
       end
 
       # === SFS 1.1 Description

data/lib/rgeo/feature/linear_ring.rb

@@ -23,6 +23,16 @@ module RGeo
     module LinearRing
       include LineString
       extend Type
+
+      # Returns +true+ if the ring is oriented in a counter clockwise direction
+      # otherwise returns +false+.
+      #
+      # == Notes
+      #
+      # Not a standard SFS method for linear rings, but added for convenience.
+      def ccw?
+        raise Error::UnsupportedOperation, "Method LinearRing#ccw? not defined."
+      end
     end
   end
 end

data/lib/rgeo/feature/multi_curve.rb

@@ -65,8 +65,13 @@ module RGeo
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
 
+      def closed?
+        raise Error::UnsupportedOperation, "Method MultiCurve#closed? not defined."
+      end
+
       def is_closed?
-        raise Error::UnsupportedOperation, "Method MultiCurve#is_closed? not defined."
+        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

data/lib/rgeo/feature.rb

@@ -24,20 +24,20 @@
 # itself. The implementation should separately document any such
 # extensions that it may provide.
 
-require "rgeo/feature/factory"
-require "rgeo/feature/types"
-require "rgeo/feature/geometry"
-require "rgeo/feature/point"
-require "rgeo/feature/curve"
-require "rgeo/feature/line_string"
-require "rgeo/feature/linear_ring"
-require "rgeo/feature/line"
-require "rgeo/feature/surface"
-require "rgeo/feature/polygon"
-require "rgeo/feature/geometry_collection"
-require "rgeo/feature/multi_point"
-require "rgeo/feature/multi_curve"
-require "rgeo/feature/multi_line_string"
-require "rgeo/feature/multi_surface"
-require "rgeo/feature/multi_polygon"
-require "rgeo/feature/factory_generator"
+require_relative "feature/factory"
+require_relative "feature/types"
+require_relative "feature/geometry"
+require_relative "feature/point"
+require_relative "feature/curve"
+require_relative "feature/line_string"
+require_relative "feature/linear_ring"
+require_relative "feature/line"
+require_relative "feature/surface"
+require_relative "feature/polygon"
+require_relative "feature/geometry_collection"
+require_relative "feature/multi_point"
+require_relative "feature/multi_curve"
+require_relative "feature/multi_line_string"
+require_relative "feature/multi_surface"
+require_relative "feature/multi_polygon"
+require_relative "feature/factory_generator"

data/lib/rgeo/geographic/interface.rb

@@ -222,7 +222,8 @@ module RGeo
           wkt_generator: opts[:wkt_generator],
           wkb_generator: opts[:wkb_generator],
           has_z_coordinate: opts[:has_z_coordinate],
-          has_m_coordinate: opts[:has_m_coordinate])
+          has_m_coordinate: opts[:has_m_coordinate],
+          uses_lenient_assertions: opts[:uses_lenient_assertions])
         projector = Geographic::SimpleMercatorProjector.new(factory,
           buffer_resolution: opts[:buffer_resolution],
           lenient_multi_polygon_assertions: opts[:lenient_multi_polygon_assertions],

data/lib/rgeo/geographic/projected_feature_methods.rb

@@ -22,12 +22,22 @@ module RGeo
         factory.unproject(projection.envelope)
       end
 
+      def empty?
+        projection.empty?
+      end
+
       def is_empty?
-        projection.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?
+      end
+
+      def simple?
+        projection.simple?
       end
 
       def is_simple?
-        projection.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?
       end
 
       def boundary

data/lib/rgeo/geographic/spherical_feature_classes.rb

@@ -47,6 +47,7 @@ module RGeo
       include ImplHelper::BasicGeometryMethods
       include ImplHelper::BasicPolygonMethods
       include SphericalGeometryMethods
+      include SphericalPolygonMethods
     end
 
     class SphericalGeometryCollectionImpl # :nodoc:

data/lib/rgeo/geographic/spherical_feature_methods.rb

@@ -97,7 +97,7 @@ module RGeo
         end
       end
 
-      def is_simple?
+      def simple?
         len = arcs.length
         return false if arcs.any?(&:degenerate?)
         return true if len == 1
@@ -120,6 +120,11 @@ module RGeo
         true
       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?
+      end
+
       def length
         arcs.inject(0.0) { |sum, arc| sum + arc.length } * SphericalMath::RADIUS
       end
@@ -130,5 +135,28 @@ module RGeo
         inject(0.0) { |sum, geom| sum + geom.length }
       end
     end
+
+    module SphericalPolygonMethods # :nodoc:
+      def centroid
+        return super unless num_interior_rings == 0
+
+        centroid_lat = 0.0
+        centroid_lng = 0.0
+        signed_area = 0.0
+
+        exterior_ring.points.each_cons(2) do |p0, p1|
+          area = (p0.x * p1.y) - (p1.x * p0.y)
+          signed_area += area
+          centroid_lat += (p0.x + p1.x) * area
+          centroid_lng += (p0.y + p1.y) * area
+        end
+
+        signed_area *= 0.5
+        centroid_lat /= (6.0 * signed_area)
+        centroid_lng /= (6.0 * signed_area)
+
+        RGeo::Geographic.spherical_factory.point(centroid_lat, centroid_lng)
+      end
+    end
   end
 end

data/lib/rgeo/geographic.rb

@@ -18,13 +18,13 @@
 # See the various class methods of Geographic for more information on
 # the behaviors of the factories they generate.
 
-require "rgeo/geographic/factory"
-require "rgeo/geographic/projected_window"
-require "rgeo/geographic/interface"
-require "rgeo/geographic/spherical_math"
-require "rgeo/geographic/spherical_feature_methods"
-require "rgeo/geographic/spherical_feature_classes"
-require "rgeo/geographic/proj4_projector"
-require "rgeo/geographic/simple_mercator_projector"
-require "rgeo/geographic/projected_feature_methods"
-require "rgeo/geographic/projected_feature_classes"
+require_relative "geographic/factory"
+require_relative "geographic/projected_window"
+require_relative "geographic/interface"
+require_relative "geographic/spherical_math"
+require_relative "geographic/spherical_feature_methods"
+require_relative "geographic/spherical_feature_classes"
+require_relative "geographic/proj4_projector"
+require_relative "geographic/simple_mercator_projector"
+require_relative "geographic/projected_feature_methods"
+require_relative "geographic/projected_feature_classes"

data/lib/rgeo/geos/capi_factory.rb

@@ -297,7 +297,11 @@ module RGeo
         if (wkb_parser_ = _wkb_parser)
           wkb_parser_.parse(str_)
         else
-          _parse_wkb_impl(str_)
+          if str_[0] == "\x00" || str_[0] == "\x01"
+            _parse_wkb_impl(str_)
+          else
+            _parse_wkb_impl([str_].pack('H*'))
+          end
         end
       end
 

data/lib/rgeo/geos/capi_feature_classes.rb

@@ -11,6 +11,16 @@ module RGeo
     module CAPIGeometryMethods # :nodoc:
       include Feature::Instance
 
+      def is_empty? # rubocop:disable Naming/PredicateName
+        warn "The is_empty? method is deprecated, please use the empty? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        empty?
+      end
+
+      def is_simple? # rubocop:disable Naming/PredicateName
+        warn "The is_simple? method is deprecated, please use the simple? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        simple?
+      end
+
       def inspect
         "#<#{self.class}:0x#{object_id.to_s(16)} #{as_text.inspect}>"
       end
@@ -50,6 +60,25 @@ module RGeo
       alias to_s as_text
     end
 
+    module CAPIMultiLineStringMethods # :nodoc:
+      def is_closed? # rubocop:disable Naming/PredicateName
+        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
+
+    module CAPILineStringMethods # :nodoc:
+      def is_closed? # rubocop:disable Naming/PredicateName
+        warn "The is_closed? method is deprecated, please use the closed? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        closed?
+      end
+
+      def is_ring? # rubocop:disable Naming/PredicateName
+        warn "The is_ring? method is deprecated, please use the ring? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        ring?
+      end
+    end
+
     module CAPIGeometryCollectionMethods # :nodoc:
       include Enumerable
     end
@@ -72,6 +101,10 @@ module RGeo
       include CAPIGeometryMethods
       include CAPILineStringMethods
       include CAPILinearRingMethods
+
+      def ccw?
+        RGeo::Cartesian::Analysis.ccw?(self)
+      end
     end
 
     class CAPILineImpl # :nodoc:

data/lib/rgeo/geos/ffi_feature_methods.rb

@@ -113,14 +113,24 @@ module RGeo
         @factory.generate_wkb(self)
       end
 
-      def is_empty?
+      def empty?
         @fg_geom.empty?
       end
 
-      def is_simple?
+      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?
+      end
+
+      def simple?
         @fg_geom.simple?
       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?
+      end
+
       def equals?(rhs)
         return false unless rhs.is_a?(RGeo::Feature::Instance)
         fg = factory.convert_to_fg_geometry(rhs)
@@ -367,14 +377,24 @@ module RGeo
         end
       end
 
-      def is_closed?
+      def closed?
         @fg_geom.closed?
       end
 
-      def is_ring?
+      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
+
+      def ring?
         @fg_geom.ring?
       end
 
+      def is_ring?
+        warn "The is_ring? method is deprecated, please use the ring? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        ring?
+      end
+
       def rep_equals?(rhs)
         rhs.class == self.class && rhs.factory.eql?(@factory) &&
           Utils.ffi_coord_seqs_equal?(rhs.fg_geom.coord_seq, @fg_geom.coord_seq, @factory._has_3d)
@@ -393,6 +413,10 @@ module RGeo
       def geometry_type
         Feature::LinearRing
       end
+
+      def ccw?
+        RGeo::Cartesian::Analysis.ccw?(self)
+      end
     end
 
     module FFILineMethods # :nodoc:
@@ -549,7 +573,7 @@ module RGeo
         @fg_geom.length
       end
 
-      def is_closed?
+      def closed?
         size = num_geometries
         size.times do |n|
           return false unless @fg_geom.get_geometry_n(n).closed?
@@ -557,6 +581,11 @@ module RGeo
         true
       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
+
       def coordinates
         each.map(&:coordinates)
       end

data/lib/rgeo/geos/interface.rb

@@ -31,32 +31,47 @@ module RGeo
       # Returns true if the given feature is a CAPI GEOS feature, or if
       # the given factory is a CAPI GEOS factory.
 
-      def is_capi_geos?(object)
+      def capi_geos?(object)
         CAPI_SUPPORTED &&
           (CAPIFactory === object || CAPIGeometryMethods === object ||
           ZMFactory === object && CAPIFactory === object.z_factory ||
           ZMGeometryMethods === object && CAPIGeometryMethods === object.z_geometry)
       end
 
+      def is_capi_geos?(object)
+        warn "The is_capi_geos? method is deprecated, please use the capi_geos? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        capi_geos?(object)
+      end
+
       # Returns true if the given feature is an FFI GEOS feature, or if
       # the given factory is an FFI GEOS factory.
 
-      def is_ffi_geos?(object)
+      def ffi_geos?(object)
         FFI_SUPPORTED &&
           (FFIFactory === object || FFIGeometryMethods === object ||
           ZMFactory === object && FFIFactory === object.z_factory ||
           ZMGeometryMethods === object && FFIGeometryMethods === object.z_geometry)
       end
 
+      def is_ffi_geos?(object)
+        warn "The is_ffi_geos? method is deprecated, please use the ffi_geos? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        ffi_geos?(object)
+      end
+
       # Returns true if the given feature is a GEOS feature, or if the given
       # factory is a GEOS factory. Does not distinguish between CAPI and FFI.
 
-      def is_geos?(object)
+      def geos?(object)
         CAPI_SUPPORTED && (CAPIFactory === object || CAPIGeometryMethods === object) ||
           FFI_SUPPORTED && (FFIFactory === object || FFIGeometryMethods === object) ||
           ZMFactory === object || ZMGeometryMethods === object
       end
 
+      def is_geos?(object)
+        warn "The is_geos? method is deprecated, please use the geos? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        geos?(object)
+      end
+
       # Returns the GEOS library version as a string of the format "x.y.z".
       # Returns nil if GEOS is not available.
 
@@ -174,7 +189,6 @@ module RGeo
       #   operation that would benefit from it is called. The latter
       #   never automatically generates a prepared geometry (unless you
       #   generate one explicitly using the <tt>prepare!</tt> method).
-
       def factory(opts = {})
         if supported?
           native_interface = opts[:native_interface] || Geos.preferred_native_interface

data/lib/rgeo/geos/zm_feature_methods.rb

@@ -65,12 +65,22 @@ module RGeo
         @factory.instance_variable_get(:@wkb_generator).generate(self)
       end
 
+      def empty?
+        @zgeometry.empty?
+      end
+
       def is_empty?
-        @zgeometry.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?
+      end
+
+      def simple?
+        @zgeometry.simple?
       end
 
       def is_simple?
-        @zgeometry.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?
       end
 
       def boundary
@@ -222,12 +232,22 @@ module RGeo
         point_n(num_points - 1)
       end
 
+      def closed?
+        @zgeometry.closed?
+      end
+
       def is_closed?
-        @zgeometry.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
+
+      def ring?
+        @zgeometry.ring?
       end
 
       def is_ring?
-        @zgeometry.is_ring?
+        warn "The is_ring? method is deprecated, please use the ring? counterpart, will be removed in v3" unless ENV["RGEO_SILENCE_DEPRECATION"]
+        ring?
       end
 
       def num_points
@@ -323,8 +343,13 @@ module RGeo
         @zgeometry.length
       end
 
+      def closed?
+        @zgeometry.closed?
+      end
+
       def is_closed?
-        @zgeometry.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
 
       def coordinates

data/lib/rgeo/geos.rb

@@ -21,24 +21,24 @@
 
 module RGeo
   module Geos
-    require "rgeo/geos/utils"
-    require "rgeo/geos/interface"
+    require_relative "geos/utils"
+    require_relative "geos/interface"
     begin
-      require "rgeo/geos/geos_c_impl"
+      require_relative "geos/geos_c_impl"
     rescue LoadError
       # continue
     end
     CAPI_SUPPORTED = RGeo::Geos.const_defined?(:CAPIGeometryMethods)
     if CAPI_SUPPORTED
-      require "rgeo/geos/capi_feature_classes"
-      require "rgeo/geos/capi_factory"
+      require_relative "geos/capi_feature_classes"
+      require_relative "geos/capi_factory"
     end
-    require "rgeo/geos/ffi_feature_methods"
-    require "rgeo/geos/ffi_feature_classes"
-    require "rgeo/geos/ffi_factory"
-    require "rgeo/geos/zm_feature_methods"
-    require "rgeo/geos/zm_feature_classes"
-    require "rgeo/geos/zm_factory"
+    require_relative "geos/ffi_feature_methods"
+    require_relative "geos/ffi_feature_classes"
+    require_relative "geos/ffi_factory"
+    require_relative "geos/zm_feature_methods"
+    require_relative "geos/zm_feature_classes"
+    require_relative "geos/zm_factory"
 
     # Determine ffi support.
     begin

data/lib/rgeo/impl_helper/basic_geometry_collection_methods.rb

@@ -9,6 +9,8 @@
 module RGeo
   module ImplHelper # :nodoc:
     module BasicGeometryCollectionMethods # :nodoc:
+      include Enumerable
+
       attr_reader :elements
 
       def initialize(factory, elements)
@@ -37,6 +39,10 @@ module RGeo
         @elements.each(&block)
       end
 
+      def geometries
+        @elements
+      end
+
       def dimension
         @dimension ||= @elements.map(&:dimension).max || -1
       end
@@ -45,10 +51,15 @@ module RGeo
         Feature::GeometryCollection
       end
 
-      def is_empty?
+      def empty?
         @elements.size == 0
       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?
+      end
+
       def rep_equals?(rhs)
         if rhs.is_a?(self.class) && rhs.factory.eql?(@factory) && @elements.size == rhs.num_geometries
           rhs.each_with_index { |p, i| return false unless @elements[i].rep_equals?(p) }
@@ -87,8 +98,13 @@ module RGeo
         Feature::MultiLineString
       end
 
+      def closed?
+        all?(&:closed?)
+      end
+
       def is_closed?
-        all?(&: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
 
       def length
@@ -98,7 +114,7 @@ module RGeo
       def boundary
         hash = {}
         @elements.each do |line|
-          if !line.is_empty? && !line.is_closed?
+          if !line.empty? && !line.closed?
             add_boundary(hash, line.start_point)
             add_boundary(hash, line.end_point)
           end
@@ -114,6 +130,12 @@ module RGeo
         @elements.map(&:coordinates)
       end
 
+      def contains?(rhs)
+        return super unless Feature::Point === rhs
+
+        @elements.any? { |line| line.contains?(rhs) }
+      end
+
       private
 
       def add_boundary(hash, point)
@@ -168,15 +190,21 @@ module RGeo
       def boundary
         array = []
         @elements.each do |poly|
-          array << poly.exterior_ring unless poly.is_empty?
+          array << poly.exterior_ring unless poly.empty?
           array.concat(poly.interior_rings)
         end
-        factory.multilinestring(array)
+        factory.multi_line_string(array)
       end
 
       def coordinates
         @elements.map(&:coordinates)
       end
+
+      def contains?(rhs)
+        return super unless Feature::Point === rhs
+
+        @elements.any? { |poly| poly.contains?(rhs) }
+      end
     end
   end
 end