ffi-geos 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21720e245fc36802f809c92b874bc75906ba6994
-  data.tar.gz: d819af55af7872bbd1ae042ec18f0b5409db4636
+  metadata.gz: 6bc526266d55420dc48080bdd5e692892c7dbb2a
+  data.tar.gz: f7677af86f57eb3d0a9be0b8b1755b3ddc423ffb
 SHA512:
-  metadata.gz: c2fcc8382ee2256513cd1d71e81b00883b836e9a0265d4186e00820737feeb66d34a7db798e2c386846887b27e23fc324a2a89044d954f280321e86fb63eaedd
-  data.tar.gz: 2d32149dac875f01b70aa1604e02b07d047871981d6410989e668d5a9cef3ff487e379d726e42cb32e83237591cf70b376309256a540cae0c19e033f82a5a08f
+  metadata.gz: 203cff10e29ac37807026ddc9a2d70965fe368df68ca2a03ea3fa74c28f5604ac86a03e33f5430461e0d0b109194bec66036c24d32058285ce6b03a6a815b33e
+  data.tar.gz: 35a98846b51df19ab97ccc39f610ee442b59a5f1c423b9b58870cda443d66476dff0dccad0340909a8906da1eacb86611eabbc287412ae0456f6bdcd8d92d4c8

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - 1.8.7
-  - rbx
+  - rbx-2
 before_install:
   - sudo apt-get update
   - sudo apt-get install libgeos-dev

data/README.rdoc

@@ -9,10 +9,10 @@
 
 Ruby versions known to work:
 
-* Ruby MRI 1.8.7, 1.9.2, 1.9.3, 2.0.0 x86_64, OSX 10.6.5+
-* Ruby MRI 1.8.7, 1.9.2, 1.9.3, 2.0.0 i386, linux
-* Ruby MRI 1.8.7, 1.9.2, 1.9.3, 2.0.0 x86_64, linux
-* JRuby 1.6, x86_64 OSX 10.6.5+
+* Ruby MRI 1.8.7, 1.9.2, 1.9.3, 2.0+ x86_64, OSX 10.6.5+
+* Ruby MRI 1.8.7, 1.9.2, 1.9.3, 2.0+ i386, linux
+* Ruby MRI 1.8.7, 1.9.2, 1.9.3, 2.0+ x86_64, linux
+* JRuby 1.6+, x86_64 OSX 10.6.5+
 
 === JRuby Notes
 
@@ -67,102 +67,16 @@ Ruby bindings along with the following enhancements and additions:
   copying in either a lenient or a strict sort of manner. See the documentation
   for Geos.srid_copy_policy= for details.
 
-=== Geos
-
-* Many new Geos.create_* methods, such as Geos.create_linear_ring, etc.
-
-* Geos.srid_copy_policy, srid_copy_policy=, srid_copy_policy_default and
-  srid_copy_policy_default=.
-
-=== Geos::Geometry
-
-* Geos::almost_equals?
-* Geos::coord_seq
-* Geos::covered_by?
-* Geos::covers?
-* Geos::delaunay_triangulation
-* Geos::end_point
-* Geos::eql_almost?
-* Geos::equals?
-* Geos::equals_almost?
-* Geos::equals_exact?
-* Geos::exactly_equals?
-* Geos::extract_unique_points - Geos::Geometry#unique_points
-* Geos::hausdorff_distance
-* Geos::interpolate
-* Geos::interpolate_normalized
-* Geos::nearest_points
-* Geos::node
-* Geos::normalize!
-* Geos::num_coordinates
-* Geos::polygonize
-* Geos::polygonize_cut_edges
-* Geos::polygonize_full
-* Geos::project
-* Geos::project_normalized
-* Geos::relate_boundary_node_rule
-* Geos::representative_point
-* Geos::shared_paths
-* Geos::snap
-* Geos::snap_to
-* Geos::start_point
-* Geos::symmetric_difference
-* Geos::to_prepared
-* Geos::unary_union
-* Geos::union_cascaded - Geos::Geometry#union can also be called
-  without a geometry argument to produce the same effect.
-* Geos::unique_points - Geos::Geometry#extract_unique_points
-* Geos::valid_detail
-* Geos::valid_reason
-
-=== Geos::LineString and Geos::LinearRing
-
-* Geos::LineString#[]
-* Geos::LineString#closed?
-* Geos::LineString#each
-* Geos::LineString#num_points
-* Geos::LineString#offset_curve
-* Geos::LineString#point_n
-* Geos::LineString#slice
-* Geos::LinearRing#to_line_string
-* Geos::LinearRing#to_polygon
-
-=== Geos::WktWriter
-
-* Geos::WktWriter#old_3d
-* Geos::WktWriter#old_3d=
-* Geos::WktWriter#output_dimensions
-* Geos::WktWriter#output_dimensions=
-* Geos::WktWriter#rounding_precision
-* Geos::WktWriter#rounding_precision=
-* Geos::WktWriter#trim
-* Geos::WktWriter#trim=
-
-=== Geos::CoordinateSequence
-
-* Geos::CoordinateSequence#has_z?
-* Geos::CoordinateSequence#to_line_string
-* Geos::CoordinateSequence#to_linear_ring
-* Geos::CoordinateSequence#to_point
-* Geos::CoordinateSequence#to_polygon
-
-=== Geos::Polygon
-
-* Geos::Polygon#interior_ring
-* Geos::Polygon#interior_rings
-
-=== Geos::Utils
-
-* Geos::Utils.orientation_index
-* Geos::Utils.relate_match
-
-=== Geos::Interrupt
-
-* Geos::Interrupt.available?
-* Geos::Interrupt.register
-* Geos::Interrupt.request
-* Geos::Interrupt.cancel
-* Geos::Interrupt.clear
+* There are many, many new methods added all over the place. Pretty much the
+  entire GEOS C API is represented in ffi-geos along with all sorts of useful
+  convenience methods and geometry conversion and manipulation methods.
+
+* *NEW IN ffi-geos 1.0.0* -- all errors thrown by ffi-geos are now instances of
+  `Geos::Error` or subclasses thereof. `Geos::Error` itself is a descendant
+  of `RuntimeError` as is the case with the native Geos extension. This means
+  that code like `rescue RuntimeError` should still work but you can now
+  further capture more precise error types by capturing errors like
+  `Geos::Error`, `Geos::ParseError`, etc.
 
 == Thanks
 

data/lib/ffi-geos.rb

@@ -1023,7 +1023,7 @@ module Geos
     end
 
     def error_handler(*args)
-      raise RuntimeError.new(args[0] % args[1])
+      raise Geos::GEOSException.new(args[0] % args[1])
     end
   end
 
@@ -1110,7 +1110,7 @@ module Geos
       create_empty_collection
       create_empty_linear_ring
     }.each do |m|
-      self.class_eval <<-EOF
+      self.class_eval(<<-EOF, __FILE__, __LINE__ + 1)
         def #{m}(*args)
           Geos::Utils.#{m}(*args)
         end
@@ -1178,12 +1178,27 @@ module Geos
     ].freeze
   end
 
-  class MixedSRIDsError < RuntimeError
+  class Error < ::RuntimeError
+  end
+
+  class GEOSException < Error
+  end
+
+  class IndexBoundsError < Error
+    def initialize(*)
+      super("Index out of bounds")
+    end
+  end
+
+  class MixedSRIDsError < Error
     def initialize(srid_a, srid_b)
       super("Operation on mixed SRIDs (#{srid_a} vs. #{srid_b})")
     end
   end
 
+  class ParseError < Error
+  end
+
   include GeomTypes
   include VersionConstants
 end

data/lib/ffi-geos/coordinate_sequence.rb

@@ -4,7 +4,7 @@ module Geos
 
   # A CoordinateSequence is a list of coordinates in a Geometry.
   class CoordinateSequence
-    class ParseError < ArgumentError
+    class ParseError < Geos::ParseError
     end
 
     class CoordinateAccessor
@@ -262,7 +262,7 @@ module Geos
 
     def check_bounds(idx) #:nodoc:
       if idx < 0 || idx >= self.length
-        raise RuntimeError.new("Index out of bounds")
+        raise Geos::IndexBoundsError.new("Index out of bounds")
       end
     end
 

data/lib/ffi-geos/geometry.rb

@@ -6,6 +6,12 @@ module Geos
 
     attr_reader :ptr
 
+    class CouldntNormalizeError < Geos::Error
+      def initialize(klass)
+        super("Couldn't normalize #{klass}")
+      end
+    end
+
     # For internal use. Geometry objects should be created via WkbReader,
     # WktReader and the various Geos.create_* methods.
     def initialize(ptr, options = {})
@@ -48,7 +54,7 @@ module Geos
 
     def normalize!
       if FFIGeos.GEOSNormalize_r(Geos.current_handle, self.ptr) == -1
-        raise RuntimeError.new("Couldn't normalize #{self.class}")
+        raise Geos::Geometry::CouldntNormalizeError.new(self.class)
       end
 
       self

data/lib/ffi-geos/interrupt.rb

@@ -12,10 +12,10 @@ module Geos
         # Registers an interrupt method or block that may be called during
         # certain operations such as Geos::Geometry#buffer. During these
         # blocks you can interrupt the current operation using
-        # Geos.request_interrupt and cancel that interrupt request using
-        # Geos.clear_interrupt.
+        # Geos::Interrupt.request and cancel that interrupt request using
+        # Geos::Interrupt.clear.
         #
-        # The return value for Geos.register_interrupt is a reference to the
+        # The return value for Geos::Interrupt.register is a reference to the
         # previously registered callback, allowing you to chain interrupt
         # calls together by calling #call on the previously registered callback.
         #
@@ -25,9 +25,9 @@ module Geos
         # up in unexpected ways while interrupts are firing.
         def register(method_or_block = nil, &block)
           if method_or_block.nil? && !block_given?
-            raise ArgumentError.new("Expected either a method or a block for Geos.register_interrupt")
+            raise ArgumentError.new("Expected either a method or a block for Geos::Interrupt.register")
           elsif !method_or_block.nil? && block_given?
-            raise ArgumentError.new("Cannot use both a method and a block for Geos.register_interrupt")
+            raise ArgumentError.new("Cannot use both a method and a block for Geos::Interrupt.register")
           else
             retval = @current_interrupt_callback
 
@@ -44,7 +44,7 @@ module Geos
         end
 
         # Interrupt the current operation. This method should generally be
-        # called from within a callback registered with Geos.register_interrupt
+        # called from within a callback registered with Geos::Interrupt.register
         # but can be called at any time to interrupt the next interruptable
         # operation.
         def request
@@ -53,7 +53,7 @@ module Geos
 
         # Cancel a request to interrupt the current operation. This method
         # should be called from within a callback registered with
-        # Geos.register_interrupt but can be called at any time all the same.
+        # Geos::Interrupt.register but can be called at any time all the same.
         def cancel
           FFIGeos.GEOS_interruptCancel
         end

data/lib/ffi-geos/line_string.rb

@@ -29,7 +29,7 @@ module Geos
 
     def point_n(n)
       if n < 0 || n >= self.num_points
-        raise RuntimeError.new("Index out of bounds")
+        raise Geos::IndexBoundsError.new
       else
         cast_geometry_ptr(
           FFIGeos.GEOSGeomGetPointN_r(Geos.current_handle, self.ptr, n), {
@@ -68,5 +68,20 @@ module Geos
         bool_result(FFIGeos.GEOSisClosed_r(Geos.current_handle, self.ptr))
       end
     end
+
+    def to_linear_ring
+      if self.closed?
+        Geos.create_linear_ring(self.coord_seq, :srid => pick_srid_according_to_policy(self.srid))
+      else
+        self_cs = self.coord_seq.to_a
+        self_cs.push(self_cs[0])
+
+        Geos.create_linear_ring(self_cs, :srid => pick_srid_according_to_policy(self.srid))
+      end
+    end
+
+    def to_polygon
+      self.to_linear_ring.to_polygon
+    end
   end
 end

data/lib/ffi-geos/point.rb

@@ -69,7 +69,7 @@ module Geos
       envelope
       topology_preserve_simplify
     }.each do |method|
-      self.class_eval(<<-EOF)
+      self.class_eval(<<-EOF, __FILE__, __LINE__ + 1)
         def #{method}(*args)
           self.dup.tap { |ret|
             ret.srid = pick_srid_according_to_policy(ret.srid)

data/lib/ffi-geos/polygon.rb

@@ -8,7 +8,7 @@ module Geos
 
     def interior_ring_n(n)
       if n < 0 || n >= self.num_interior_rings
-        raise RuntimeError.new("Index out of bounds")
+        raise Geos::IndexBoundsError.new
       else
         cast_geometry_ptr(
           FFIGeos.GEOSGetInteriorRingN_r(Geos.current_handle, self.ptr, n), {

data/lib/ffi-geos/strtree.rb

@@ -9,6 +9,12 @@ module Geos
 
     undef :clone, :dup
 
+    class AlreadyBuiltError < Geos::Error
+      def initialize(*)
+        super("STRtree has already been built")
+      end
+    end
+
     # :call-seq:
     #   new(capacity)
     #   new(geoms_and_objects)
@@ -71,7 +77,7 @@ module Geos
 
     def insert(geom, item)
       if self.built?
-        raise RuntimeError.new("STRtree has already been built")
+        raise AlreadyBuiltError.new
       else
         check_geometry(geom)
 

data/lib/ffi-geos/tools.rb

@@ -1,6 +1,24 @@
 # encoding: UTF-8
 
 module Geos
+  class NullPointerError < Geos::Error
+    def initialize(*)
+      super("Tried to create a Geometry from a NULL pointer!")
+    end
+  end
+
+  class InvalidGeometryTypeError < Geos::Error
+    def initialize(*)
+      super("Invalid geometry type")
+    end
+  end
+
+  class UnexpectedBooleanResultError < Geos::Error
+    def initialize(result)
+      super("Unexpected boolean result: #{result}")
+    end
+  end
+
   module Tools
     include GeomTypes
 
@@ -10,7 +28,7 @@ module Geos
       }.merge(options)
 
       if geom_ptr.null?
-        raise RuntimeError.new("Tried to create a Geometry from a NULL pointer!")
+        raise Geos::NullPointerError.new
       end
 
       klass = case FFIGeos.GEOSGeomTypeId_r(Geos.current_handle, geom_ptr)
@@ -31,7 +49,7 @@ module Geos
         when GEOS_GEOMETRYCOLLECTION
           GeometryCollection
         else
-          raise RuntimeError.new("Invalid geometry type")
+          raise Geos::InvalidGeometryTypeError.new
       end
 
       klass.new(geom_ptr, options).tap { |ret|
@@ -76,14 +94,14 @@ module Geos
       end
     end
 
-    def bool_result(r)
-      case r
+    def bool_result(result)
+      case result
       when 1
         true
       when 0
         false
       else
-        raise RuntimeError.new("Unexpected boolean result: #{r}")
+        raise Geos::UnexpectedBooleanResultError.new(result)
       end
     end
 
@@ -100,6 +118,14 @@ module Geos
       end
     end
 
+    def extract_options!(args)
+      if args.last.is_a?(Hash)
+        args.pop
+      else
+        {}
+      end
+    end
+
     class << self
       include Geos::Tools
     end

data/lib/ffi-geos/utils.rb

@@ -28,11 +28,7 @@ module Geos
       end
 
       def create_point(*args)
-        options = if args.last.is_a?(Hash)
-          args.pop
-        else
-          {}
-        end
+        options = extract_options!(args)
 
         if args.length == 1
           cs = args.first
@@ -47,7 +43,7 @@ module Geos
         end
 
         if cs.length != 1
-          raise RuntimeError.new("IllegalArgumentException: Point coordinate list must contain a single element")
+          raise ArgumentError.new("IllegalArgumentException: Point coordinate list must contain a single element")
         end
 
         cs_dup = cs.dup
@@ -62,7 +58,7 @@ module Geos
         cs = cs_from_cs_or_geom(cs)
 
         if cs.length <= 1 && cs.length != 0
-          raise RuntimeError.new("IllegalArgumentException: point array must contain 0 or >1 elements")
+          raise ArgumentError.new("IllegalArgumentException: point array must contain 0 or >1 elements")
         end
 
         cs_dup = cs.dup
@@ -77,7 +73,7 @@ module Geos
         cs = cs_from_cs_or_geom(cs)
 
         if cs.length <= 1 && cs.length != 0
-          raise RuntimeError.new("IllegalArgumentException: point array must contain 0 or >1 elements")
+          raise ArgumentError.new("IllegalArgumentException: point array must contain 0 or >1 elements")
         end
 
         cs.ptr.autorelease = false
@@ -88,11 +84,7 @@ module Geos
       end
 
       def create_polygon(outer, *args)
-        options = if args.last.is_a?(Hash)
-          args.pop
-        else
-          {}
-        end
+        options = extract_options!(args)
 
         inner_dups = Array(args).flatten.collect { |i|
           force_to_linear_ring(i) or
@@ -174,11 +166,7 @@ module Geos
             Geos::Geometry
         end
 
-        options = if args.last.is_a?(Hash)
-          args.pop
-        else
-          {}
-        end
+        options = extract_options!(args)
 
         geoms = Array(args).flatten.tap { |i|
           if i.detect { |g| !g.is_a?(klass) }