ffi-geos 2.3.1 → 2.5.0

data/.rubocop_todo.yml

@@ -1,24 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 10000`
-# on 2022-02-25 00:43:48 UTC using RuboCop version 1.24.1.
+# on 2024-04-19 02:14:33 UTC using RuboCop version 1.62.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-Lint/BinaryOperatorWithIdenticalOperands:
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/DeprecatedAttributeAssignment:
   Exclude:
-    - 'test/geometry_tests.rb'
+    - 'ffi-geos.gemspec'
 
 # Offense count: 6
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/ffi-geos/coordinate_sequence.rb'
     - 'lib/ffi-geos/line_string.rb'
     - 'lib/ffi-geos/utils.rb'
-    - 'test/geometry_tests.rb'
+    - 'test/geometry/polygonize_tests.rb'
 
 # Offense count: 2
 # Configuration parameters: CountComments, Max, CountAsOne.
@@ -28,7 +31,7 @@ Metrics/ClassLength:
     - 'lib/ffi-geos/geometry.rb'
 
 # Offense count: 3
-# Configuration parameters: IgnoredMethods, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'lib/ffi-geos/coordinate_sequence.rb'
@@ -46,17 +49,27 @@ Metrics/ParameterLists:
   Exclude:
     - 'lib/ffi-geos/utils.rb'
 
-# Offense count: 4
-# Configuration parameters: IgnoredMethods, Max.
+# Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
     - 'lib/ffi-geos/coordinate_sequence.rb'
     - 'lib/ffi-geos/tools.rb'
-    - 'test/geometry_tests.rb'
+    - 'test/geometry/sym_difference_tests.rb'
+    - 'test/geometry/union_tests.rb'
+    - 'test/geometry/voronoi_diagram_tests.rb'
+    - 'test/line_string_tests.rb'
+
+# Offense count: 5
+Minitest/AssertRaisesCompoundBody:
+  Exclude:
+    - 'test/geometry/polygonize_tests.rb'
+    - 'test/utils_tests.rb'
 
-# Offense count: 8
+# Offense count: 9
 Naming/AccessorMethodName:
   Exclude:
+    - 'lib/ffi-geos/geojson_writer.rb'
     - 'lib/ffi-geos/point.rb'
     - 'lib/ffi-geos/wkb_writer.rb'
     - 'lib/ffi-geos/wkt_writer.rb'
@@ -69,7 +82,7 @@ Naming/FileName:
   Exclude:
     - 'lib/ffi-geos.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
 # NamePrefix: is_, has_, have_
 # ForbiddenPrefixes: is_, has_, have_
@@ -77,17 +90,15 @@ Naming/FileName:
 # MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:
-    - 'lib/ffi-geos/coordinate_sequence.rb'
     - 'lib/ffi-geos/geometry.rb'
 
-# Offense count: 2
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
-Naming/VariableNumber:
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowedReceivers.
+# AllowedReceivers: Thread.current
+Style/HashEachMethods:
   Exclude:
-    - 'lib/ffi-geos.rb'
-    - 'lib/ffi-geos/geometry.rb'
+    - 'lib/ffi-geos/strtree.rb'
 
 # Offense count: 4
 # Configuration parameters: AllowedMethods.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2021 J Smith <dark.panda@gmail.com>
+Copyright (c) 2010-2022 J Smith <dark.panda@gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.rdoc

@@ -54,6 +54,8 @@ Ruby bindings along with the following enhancements and additions:
   GEOS library and perform other work or cancel GEOS calls outright. The
   interruption API was added in GEOS 3.4.0.
 
+* Geos::GeoJSONReader and Geos::GeoJSONWriter support on GEOS 3.10+.
+
 == New Methods and Additions (not exhaustive)
 
 * SRIDs can be copied on many operations. GEOS doesn't usually copy SRIDs

data/ffi-geos.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version = Geos::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 2.7'
 
   s.authors = ['J Smith']
   s.description = 'An ffi wrapper for GEOS, a C++ port of the Java Topology Suite (JTS).'
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
-  s.homepage = 'http://github.com/dark-panda/ffi-geos'
+  s.homepage = 'https://github.com/dark-panda/ffi-geos'
   s.require_paths = ['lib']
 
   s.add_dependency('ffi', ['>= 1.0.0'])

data/lib/ffi-geos/coordinate_sequence.rb

@@ -154,9 +154,10 @@ module Geos
     end
     alias slice []
 
-    def has_z?
+    def z?
       dimensions == 3
     end
+    alias has_z? z?
 
     # Sets the x value of a coordinate. Can also be set via #x[]=.
     def set_x(idx, val)

data/lib/ffi-geos/geojson_reader.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Geos
+  class GeoJSONReader
+    include Geos::Tools
+
+    attr_reader :ptr
+
+    class ParseError < Geos::ParseError
+    end
+
+    def initialize(*args)
+      ptr = if args.first.is_a?(FFI::Pointer)
+        args.first
+      else
+        FFIGeos.GEOSGeoJSONReader_create_r(Geos.current_handle_pointer, *args)
+      end
+
+      @ptr = FFI::AutoPointer.new(
+        ptr,
+        self.class.method(:release)
+      )
+    end
+
+    def read(json, options = {})
+      cast_geometry_ptr(FFIGeos.GEOSGeoJSONReader_readGeometry_r(Geos.current_handle_pointer, ptr, json), srid: options[:srid])
+    rescue Geos::GEOSException => e
+      raise ParseError, e
+    end
+
+    def self.release(ptr) # :nodoc:
+      FFIGeos.GEOSGeoJSONReader_destroy_r(Geos.current_handle_pointer, ptr)
+    end
+  end
+end

data/lib/ffi-geos/geojson_writer.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Geos
+  class GeoJSONWriter
+    attr_accessor :indentation
+    attr_reader :ptr
+
+    def initialize(options = {})
+      options = {
+        indentation: -1
+      }.merge(options)
+
+      ptr = FFIGeos.GEOSGeoJSONWriter_create_r(Geos.current_handle_pointer)
+      @ptr = FFI::AutoPointer.new(
+        ptr,
+        self.class.method(:release)
+      )
+
+      set_options(options)
+    end
+
+    def self.release(ptr) # :nodoc:
+      FFIGeos.GEOSGeoJSONWriter_destroy_r(Geos.current_handle_pointer, ptr)
+    end
+
+    def set_options(options) # :nodoc:
+      [:indentation].each do |k|
+        send("#{k}=", options[k]) if respond_to?("#{k}=") && options.key?(k)
+      end
+    end
+    private :set_options
+
+    # Options can be set temporarily for individual writes using an options
+    # Hash. Options include :indentation.
+    def write(geom, options = nil)
+      unless options.nil?
+        old_options = {
+          indentation: indentation
+        }
+
+        set_options(options)
+      end
+
+      FFIGeos.GEOSGeoJSONWriter_writeGeometry_r(Geos.current_handle_pointer, ptr, geom.ptr, indentation)
+    ensure
+      set_options(old_options) unless options.nil?
+    end
+  end
+end

data/lib/ffi-geos/geometry.rb

@@ -59,6 +59,18 @@ module Geos
     end
     alias normalize normalize!
 
+    if FFIGeos.respond_to?(:GEOSOrientPolygons_r)
+      def orient_polygons!(exterior_cw = false)
+        raise Geos::GEOSException, self.class if FFIGeos.GEOSOrientPolygons_r(Geos.current_handle_pointer, ptr, bool_to_int(exterior_cw)) == -1
+
+        self
+      end
+
+      def orient_polygons(exterior_cw = false)
+        dup.orient_polygons!(exterior_cw)
+      end
+    end
+
     def srid
       FFIGeos.GEOSGetSRID_r(Geos.current_handle_pointer, ptr)
     end
@@ -140,10 +152,43 @@ module Geos
       end
     end
 
+    if FFIGeos.respond_to?(:GEOSDensify_r)
+      def densify(tolerance = 0.0)
+        cast_geometry_ptr(FFIGeos.GEOSDensify_r(Geos.current_handle_pointer, ptr, tolerance), srid_copy: srid)
+      end
+    end
+
     def convex_hull
       cast_geometry_ptr(FFIGeos.GEOSConvexHull_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
     end
 
+    if FFIGeos.respond_to?(:GEOSConcaveHull_r) && FFIGeos.respond_to?(:GEOSConcaveHullByLength_r)
+      def concave_hull(ratio: 0.0, allow_holes: false, length: nil)
+        cast_geometry_ptr(
+          case length
+            when Numeric
+              FFIGeos.GEOSConcaveHullByLength_r(Geos.current_handle_pointer, ptr, length, bool_to_int(allow_holes))
+            else
+              FFIGeos.GEOSConcaveHull_r(Geos.current_handle_pointer, ptr, ratio, bool_to_int(allow_holes))
+          end,
+          srid_copy: srid
+        )
+      end
+    end
+
+    if FFIGeos.respond_to?(:GEOSPolygonHullSimplify_r) && FFIGeos.respond_to?(:GEOSPolygonHullSimplifyMode_r)
+      def polygon_hull_simplify(parameter, outer: false, mode: :vertex_ratio)
+        check_enum_value(Geos::PolygonHullSimplifyModes, mode)
+
+        case mode
+          when :vertex_ratio
+            cast_geometry_ptr(FFIGeos.GEOSPolygonHullSimplify_r(Geos.current_handle_pointer, ptr, bool_to_int(outer), parameter), srid_copy: srid)
+          when :area_ratio
+            cast_geometry_ptr(FFIGeos.GEOSPolygonHullSimplifyMode_r(Geos.current_handle_pointer, ptr, bool_to_int(outer), 2, parameter), srid_copy: srid)
+        end
+      end
+    end
+
     def difference(geom, precision: nil)
       check_geometry(geom)
 
@@ -199,6 +244,13 @@ module Geos
       end
     end
 
+    if FFIGeos.respond_to?(:GEOSDisjointSubsetUnion_r)
+      # Added in GEOS 3.12+
+      def disjoint_subset_union
+        cast_geometry_ptr(FFIGeos.GEOSDisjointSubsetUnion_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
+      end
+    end
+
     if FFIGeos.respond_to?(:GEOSUnaryUnion_r)
       # Available in GEOS 3.3+
       def unary_union(precision = nil)
@@ -235,6 +287,15 @@ module Geos
     end
     alias center centroid
 
+    if FFIGeos.respond_to?(:GEOSHilbertCode_r)
+      def hilbert_code(extent, level)
+        check_geometry(extent)
+        code_ptr = FFI::MemoryPointer.new(:uint)
+        FFIGeos.GEOSHilbertCode_r(Geos.current_handle_pointer, ptr, extent.ptr, level, code_ptr)
+        code_ptr.read_uint
+      end
+    end
+
     if FFIGeos.respond_to?(:GEOSMinimumBoundingCircle_r)
       # Added in GEOS 3.8+. Does not yet support the radius or center
       # arguments.
@@ -273,6 +334,19 @@ module Geos
       cast_geometry_ptr(FFIGeos.GEOSLineMerge_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
     end
 
+    if FFIGeos.respond_to?(:GEOSLineMergeDirected_r)
+      def line_merge_directed
+        cast_geometry_ptr(FFIGeos.GEOSLineMergeDirected_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
+      end
+    end
+
+    if FFIGeos.respond_to?(:GEOSLineSubstring_r)
+      # Added in GEOS 3.12+
+      def line_substring(start_fraction, end_fraction)
+        cast_geometry_ptr(FFIGeos.GEOSLineSubstring_r(Geos.current_handle_pointer, ptr, start_fraction, end_fraction), srid_copy: srid)
+      end
+    end
+
     def simplify(tolerance)
       cast_geometry_ptr(FFIGeos.GEOSSimplify_r(Geos.current_handle_pointer, ptr, tolerance), srid_copy: srid)
     end
@@ -384,6 +458,14 @@ module Geos
     alias equals_exact? eql_exact?
     alias exactly_equals? eql_exact?
 
+    if FFIGeos.respond_to?(:GEOSEqualsIdentical_r)
+      def eql_identical?(other)
+        check_geometry(other)
+        bool_result(FFIGeos.GEOSEqualsIdentical_r(Geos.current_handle_pointer, ptr, other.ptr))
+      end
+      alias equals_identical? eql_identical?
+    end
+
     def eql_almost?(other, decimal = 6)
       check_geometry(other)
       bool_result(FFIGeos.GEOSEqualsExact_r(Geos.current_handle_pointer, ptr, other.ptr, 0.5 * (10 ** -decimal)))
@@ -439,6 +521,12 @@ module Geos
       bool_result(FFIGeos.GEOSHasZ_r(Geos.current_handle_pointer, ptr))
     end
 
+    if FFIGeos.respond_to?(:GEOSHasM_r)
+      def has_m?
+        bool_result(FFIGeos.GEOSHasM_r(Geos.current_handle_pointer, ptr))
+      end
+    end
+
     # GEOS versions prior to 3.3.0 didn't handle exceptions and can crash on
     # bad input.
     if FFIGeos.respond_to?(:GEOSProject_r) && Geos::GEOS_NICE_VERSION >= '030300'
@@ -533,7 +621,7 @@ module Geos
         check_geometry(geom)
         nearest_points_ptr = FFIGeos.GEOSNearestPoints_r(Geos.current_handle_pointer, ptr, geom.ptr)
 
-        return CoordinateSequence.new(nearest_points_ptr) unless nearest_points_ptr.null?
+        CoordinateSequence.new(nearest_points_ptr) unless nearest_points_ptr.null?
       end
     end
 
@@ -637,6 +725,12 @@ module Geos
       end
     end
 
+    if FFIGeos.respond_to?(:GEOSConstrainedDelaunayTriangulation_r)
+      def constrained_delaunay_triangulation
+        cast_geometry_ptr(FFIGeos.GEOSConstrainedDelaunayTriangulation_r(Geos.current_handle_pointer, ptr))
+      end
+    end
+
     if FFIGeos.respond_to?(:GEOSVoronoiDiagram_r)
       # Available in GEOS 3.5.0+
       #
@@ -699,6 +793,12 @@ module Geos
       end
     end
 
+    if FFIGeos.respond_to?(:GEOSConcaveHullOfPolygons_r)
+      def concave_hull_of_polygons(length_ratio, tight: false, allow_holes: false)
+        cast_geometry_ptr(FFIGeos.GEOSConcaveHullOfPolygons_r(Geos.current_handle_pointer, ptr, length_ratio, bool_to_int(tight), bool_to_int(allow_holes)), srid_copy: srid)
+      end
+    end
+
     if FFIGeos.respond_to?(:GEOSMinimumRotatedRectangle_r)
       def minimum_rotated_rectangle
         cast_geometry_ptr(FFIGeos.GEOSMinimumRotatedRectangle_r(Geos.current_handle_pointer, ptr))

data/lib/ffi-geos/geometry_collection.rb

@@ -46,7 +46,7 @@ module Geos
 
     %w{ x y z }.each do |dimension|
       %w{ max min }.each do |op|
-        native_method = "GEOSGeom_get#{dimension.upcase}#{op[0].upcase}#{op[1..-1]}_r"
+        native_method = "GEOSGeom_get#{dimension.upcase}#{op[0].upcase}#{op[1..]}_r"
 
         if FFIGeos.respond_to?(native_method)
           class_eval(<<-RUBY, __FILE__, __LINE__ + 1)

data/lib/ffi-geos/line_string.rb

@@ -146,7 +146,7 @@ module Geos
 
     %w{ max min }.each do |op|
       %w{ x y }.each do |dimension|
-        native_method = "GEOSGeom_get#{dimension.upcase}#{op[0].upcase}#{op[1..-1]}_r"
+        native_method = "GEOSGeom_get#{dimension.upcase}#{op[0].upcase}#{op[1..]}_r"
 
         if FFIGeos.respond_to?(native_method)
           class_eval(<<-RUBY, __FILE__, __LINE__ + 1)

data/lib/ffi-geos/point.rb

@@ -41,6 +41,15 @@ module Geos
     end
     alias z get_z
 
+    if FFIGeos.respond_to?(:GEOSGeomGetM_r)
+      def get_m
+        double_ptr = FFI::MemoryPointer.new(:double)
+        FFIGeos.GEOSGeomGetM_r(Geos.current_handle_pointer, ptr, double_ptr)
+        double_ptr.read_double
+      end
+      alias m get_m
+    end
+
     def area
       0
     end

data/lib/ffi-geos/polygon.rb

@@ -78,7 +78,7 @@ module Geos
 
     %w{ max min }.each do |op|
       %w{ x y }.each do |dimension|
-        native_method = "GEOSGeom_get#{dimension.upcase}#{op[0].upcase}#{op[1..-1]}_r"
+        native_method = "GEOSGeom_get#{dimension.upcase}#{op[0].upcase}#{op[1..]}_r"
 
         if FFIGeos.respond_to?(native_method)
           class_eval(<<-RUBY, __FILE__, __LINE__ + 1)

data/lib/ffi-geos/prepared_geometry.rb

@@ -77,5 +77,25 @@ module Geos
       check_geometry(geom)
       bool_result(FFIGeos.GEOSPreparedWithin_r(Geos.current_handle_pointer, ptr, geom.ptr))
     end
+
+    def distance(geom)
+      check_geometry(geom)
+      double_ptr = FFI::MemoryPointer.new(:double)
+      FFIGeos.GEOSPreparedDistance_r(Geos.current_handle_pointer, ptr, geom.ptr, double_ptr)
+      double_ptr.read_double
+    end
+
+    def distance_within?(geom, distance)
+      check_geometry(geom)
+      bool_result(FFIGeos.GEOSPreparedDistanceWithin_r(Geos.current_handle_pointer, ptr, geom.ptr, distance))
+    end
+
+    def nearest_points(geom)
+      check_geometry(geom)
+
+      coord_seq_ptr = FFIGeos.GEOSPreparedNearestPoints_r(Geos.current_handle_pointer, ptr, geom.ptr)
+
+      Geos::CoordinateSequence.new(coord_seq_ptr)
+    end
   end
 end

data/lib/ffi-geos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geos
-  VERSION = '2.3.1'
+  VERSION = '2.5.0'
 end

data/lib/ffi-geos/wkb_writer.rb

@@ -83,6 +83,18 @@ module Geos
       FFIGeos.GEOSWKBWriter_setByteOrder_r(Geos.current_handle_pointer, ptr, val)
     end
 
+    if FFIGeos.respond_to?(:GEOSWKBWriter_getFlavor_r)
+      def flavor
+        FFIGeos.GEOSWKBWriter_getFlavor_r(Geos.current_handle_pointer, ptr)
+      end
+    end
+
+    if FFIGeos.respond_to?(:GEOSWKBWriter_setFlavor_r)
+      def flavor=(val)
+        FFIGeos.GEOSWKBWriter_setFlavor_r(Geos.current_handle_pointer, ptr, val)
+      end
+    end
+
     private
 
       def set_options(options) # :nodoc: