ffi-gdal 1.0.0.beta16 → 1.0.0

data/lib/ogr/feature_definition.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require_relative '../gdal'
 require_relative '../ogr'
-require_relative 'feature_definition_extensions'
 
 module OGR
   class FeatureDefinition
-    include FeatureDefinitionExtensions
+    # @param pointer [FFI::Pointer]
+    def self.release(pointer)
+      return unless pointer && !pointer.null?
+
+      FFI::OGR::API.OGR_FD_Release(pointer)
+    end
 
     # @return [FFI::Pointer] C pointer of the C FeatureDefn.
     attr_reader :c_pointer
@@ -15,39 +20,45 @@ module OGR
     #   FFI::Pointer, the new object will simply wrap the C FeatureDefinition
     #   at that address.
     def initialize(name_or_pointer)
-      @c_pointer = if name_or_pointer.is_a? String
-                     FFI::OGR::API.OGR_FD_Create(name_or_pointer)
-                   else
-                     name_or_pointer
-                   end
-
-      return if @c_pointer.is_a?(FFI::Pointer) && !@c_pointer.null?
+      pointer = if name_or_pointer.is_a? String
+                  FFI::OGR::API.OGR_FD_Create(name_or_pointer)
+                else
+                  name_or_pointer
+                end
+
+      if !pointer.is_a?(FFI::Pointer) || pointer.null?
+        raise OGR::InvalidFeatureDefinition, "Unable to create #{self.class.name} from #{name_or_pointer}"
+      end
 
-      raise OGR::InvalidFeatureDefinition, "Unable to create #{self.class.name} from #{name_or_pointer}"
+      @c_pointer = FFI::AutoPointer.new(pointer, FeatureDefinition.method(:release))
+      @c_pointer.autorelease = false
     end
 
     def release!
-      return unless @c_pointer
+      FeatureDefinition.release(@c_pointer)
 
-      FFI::OGR::API.OGR_FD_Release(@c_pointer)
       @c_pointer = nil
     end
 
     # @return [String]
     def name
-      FFI::OGR::API.OGR_FD_GetName(@c_pointer)
+      name, ptr = FFI::OGR::API.OGR_FD_GetName(@c_pointer)
+      ptr.autorelease = false
+
+      name
     end
 
-    # @return [Fixnum]
+    # @return [Integer]
     def field_count
       FFI::OGR::API.OGR_FD_GetFieldCount(@c_pointer)
     end
 
-    # @param index [Fixnum]
+    # @param index [Integer]
     # @return [OGR::FieldDefinition]
     def field_definition(index)
-      field_definition_ptr =
-        FFI::OGR::API.OGR_FD_GetFieldDefn(@c_pointer, index)
+      field_definition_ptr = FFI::OGR::API.OGR_FD_GetFieldDefn(@c_pointer, index)
+      field_definition_ptr.autorelease = false
+
       return nil if field_definition_ptr.null?
 
       OGR::FieldDefinition.new(field_definition_ptr, nil)
@@ -64,23 +75,23 @@ module OGR
       FFI::OGR::API.OGR_FD_AddFieldDefn(@c_pointer, field_definition_ptr)
     end
 
-    # @param index [Fixnum] Index of the field definition to delete.
-    # @return [Boolean]
+    # @param index [Integer] Index of the field definition to delete.
+    # @raise [OGR::Failure]
     def delete_field_definition(index)
-      ogr_err = FFI::OGR::API.OGR_FD_DeleteFieldDefn(
-        @c_pointer,
-        index
-      )
-
-      ogr_err.handle_result "Unable to delete field definition at index #{index}"
+      OGR::ErrorHandling.handle_ogr_err("Unable to delete field definition at index #{index}") do
+        FFI::OGR::API.OGR_FD_DeleteFieldDefn(
+          @c_pointer,
+          index
+        )
+      end
     end
 
     # @param name [String]
-    # @return [Fixnum] nil if no match found
+    # @return [Integer] nil if no match found
     def field_index(name)
       result = FFI::OGR::API.OGR_FD_GetFieldIndex(@c_pointer, name)
 
-      result < 0 ? nil : result
+      result.negative? ? nil : result
     end
 
     # @return [FFI::OGR::API::WKBGeometryType]
@@ -99,7 +110,7 @@ module OGR
     end
 
     # @param ignore [Boolean]
-    def ignore_geometry!(ignore = true)
+    def ignore_geometry!(ignore: true)
       FFI::OGR::API.OGR_FD_SetGeometryIgnored(@c_pointer, ignore)
     end
 
@@ -109,48 +120,45 @@ module OGR
     end
 
     # @param ignore [Boolean]
-    def ignore_style!(ignore = true)
+    def ignore_style!(ignore: true)
       FFI::OGR::API.OGR_FD_SetStyleIgnored(@c_pointer, ignore)
     end
 
-    # @return [Fixnum]
+    # @return [Integer]
     def geometry_field_count
       FFI::OGR::API.OGR_FD_GetGeomFieldCount(@c_pointer)
     end
 
-    # @param index [Fixnum]
+    # @param index [Integer]
     # @return [OGR::GeometryFieldDefinition]
     def geometry_field_definition(index)
-      geometry_field_definition_ptr =
-        FFI::OGR::API.OGR_FD_GetGeomFieldDefn(@c_pointer, index)
+      geometry_field_definition_ptr = FFI::OGR::API.OGR_FD_GetGeomFieldDefn(@c_pointer, index)
+
       return nil if geometry_field_definition_ptr.null?
 
       OGR::GeometryFieldDefinition.new(geometry_field_definition_ptr)
     end
 
     # @param name [String]
-    # @return [Fixnum]
+    # @return [Integer]
     def geometry_field_index(name)
       result = FFI::OGR::API.OGR_FD_GetGeomFieldIndex(@c_pointer, name)
 
-      result < 0 ? nil : result
+      result.negative? ? nil : result
     end
 
     # @param geometry_field_definition [OGR::GeometryFieldDefinition, FFI::Pointer]
     def add_geometry_field_definition(geometry_field_definition)
-      geometry_field_definition_ptr = GDAL._pointer(OGR::GeometryFieldDefinition,
-        geometry_field_definition)
-      FFI::OGR::API.OGR_FD_AddGeomFieldDefn(@c_pointer,
-        geometry_field_definition_ptr)
+      geometry_field_definition_ptr = GDAL._pointer(OGR::GeometryFieldDefinition, geometry_field_definition)
+      FFI::OGR::API.OGR_FD_AddGeomFieldDefn(@c_pointer, geometry_field_definition_ptr)
     end
 
-    # @param index [Fixnum]
-    # @return [Boolean]
+    # @param index [Integer]
+    # @raise [OGR::Failure]
     def delete_geometry_field_definition(index)
-      ogr_err = FFI::OGR::API.OGR_FD_DeleteGeomFieldDefn(@c_pointer,
-        index)
-
-      ogr_err.handle_result "Unable to delete geometry field definition at index #{index}"
+      OGR::ErrorHandling.handle_ogr_err("Unable to delete geometry field definition at index #{index}") do
+        FFI::OGR::API.OGR_FD_DeleteGeomFieldDefn(@c_pointer, index)
+      end
     end
 
     # @param other_feature_definition [OGR::Feature, FFI::Pointer]

data/lib/ogr/field.rb

@@ -2,6 +2,7 @@
 
 require 'date'
 require_relative '../ogr'
+require_relative '../gdal'
 
 module OGR
   class Field
@@ -18,23 +19,23 @@ module OGR
       @c_struct.to_ptr
     end
 
-    # @return [Fixnum]
+    # @return [Integer]
     def integer
       @c_struct[:integer]
     end
     alias to_i integer
 
-    # @param new_int [Fixnum]
+    # @param new_int [Integer]
     def integer=(new_int)
       @c_struct[:integer] = new_int
     end
 
-    # @return [Bignum]
+    # @return [Integer]
     def integer64
       @c_struct[:integer64]
     end
 
-    # @param new_int64 [Bignum]
+    # @param new_int64 [Integer]
     def integer64=(new_int64)
       @c_struct[:integer64] = new_int64
     end
@@ -61,7 +62,7 @@ module OGR
       @c_struct[:string] = FFI::MemoryPointer.from_string(new_string)
     end
 
-    # @return [Array<Fixnum>]
+    # @return [Array<Integer>]
     def integer_list
       il = @c_struct[:integer_list]
       return [] if il[:count].zero?
@@ -69,7 +70,7 @@ module OGR
       il[:list].read_array_of_int(il[:count])
     end
 
-    # @param new_integer_list [Array<Fixnum>]
+    # @param new_integer_list [Array<Integer>]
     def integer_list=(new_integer_list)
       list_ptr = FFI::MemoryPointer.new(:int, new_integer_list.length)
       list_ptr.write_array_of_int(new_integer_list)
@@ -81,7 +82,7 @@ module OGR
       @c_struct[:integer_list] = il
     end
 
-    # @return [Array<Bignum>]
+    # @return [Array<Integer>]
     def integer64_list
       il = @c_struct[:integer_list]
       return [] if il[:count].zero?
@@ -90,7 +91,7 @@ module OGR
     end
     alias to_bignum integer64_list
 
-    # @param new_integer64_list [Array<Bignum>]
+    # @param new_integer64_list [Array<Integer>]
     def integer64_list=(new_integer64_list)
       list_ptr = FFI::MemoryPointer.new(:int64, new_integer64_list.size)
       list_ptr.write_array_of_int64(new_integer64_list)
@@ -149,7 +150,7 @@ module OGR
     def binary
       b = @c_struct[:binary]
 
-      b[:count] > 0 ? b[:data].read_bytes(b[:count]) : ''
+      b[:count].positive? ? b[:data].read_bytes(b[:count]) : ''
     end
 
     # @param new_binary [String] Binary string of 8-bit, unsigned data (uchar).
@@ -170,7 +171,7 @@ module OGR
       { marker1: @c_struct[:set][:marker1], marker2: @c_struct[:set][:marker2] }
     end
 
-    # @param new_set [Hash{marker1 => Fixnum, marker2 => Fixnum}]
+    # @param new_set [Hash{marker1 => Integer, marker2 => Integer}]
     def set=(new_set)
       set = FFI::OGR::FieldTypes::Set.new
       set[:marker1] = new_set[:marker1]
@@ -185,16 +186,13 @@ module OGR
       return if c_date[:year].zero? || c_date[:month].zero? || c_date[:day].zero?
 
       formatted_tz = OGR._format_time_zone_for_ruby(c_date[:tz_flag].to_i)
-
-      # rubocop:disable Style/DateTime
       DateTime.new(c_date[:year],
-        c_date[:month],
-        c_date[:day],
-        c_date[:hour],
-        c_date[:minute],
-        c_date[:second],
-        formatted_tz)
-      # rubocop:enable Style/DateTime
+                   c_date[:month],
+                   c_date[:day],
+                   c_date[:hour],
+                   c_date[:minute],
+                   c_date[:second],
+                   formatted_tz)
     end
 
     # @param new_date [Date, Time, DateTime]

data/lib/ogr/field_definition.rb

@@ -4,27 +4,36 @@ require_relative '../ogr'
 
 module OGR
   class FieldDefinition
+    # @param pointer [FFI::Pointer]
+    def self.release(pointer)
+      return unless pointer && !pointer.null?
+
+      FFI::OGR::API.OGR_Fld_Destroy(pointer)
+    end
+
     # @return [FFI::Pointer] C pointer to the C FieldDefn.
     attr_reader :c_pointer
 
     # @param name_or_pointer [String, FFI::Pointer]
     # @param type [FFI::OGR::FieldType]
     def initialize(name_or_pointer, type)
-      @c_pointer = if name_or_pointer.is_a? String
-                     FFI::OGR::API.OGR_Fld_Create(name_or_pointer, type)
-                   else
-                     name_or_pointer
-                   end
-
-      return if @c_pointer.is_a?(FFI::Pointer) && !@c_pointer.null?
-
-      raise OGR::InvalidFieldDefinition, "Unable to create #{self.class.name} from #{name_or_pointer}"
+      pointer = if name_or_pointer.is_a? String
+                  FFI::OGR::API.OGR_Fld_Create(name_or_pointer, type)
+                else
+                  name_or_pointer
+                end
+
+      if !pointer.is_a?(FFI::Pointer) || pointer.null?
+        raise OGR::InvalidFieldDefinition, "Unable to create #{self.class.name} from #{name_or_pointer}"
+      end
+
+      @c_pointer = FFI::AutoPointer.new(pointer, FieldDefinition.method(:release))
+      @c_pointer.autorelease = false
     end
 
     def destroy!
-      return unless @c_pointer
+      FieldDefinition.release(@c_pointer)
 
-      FFI::OGR::API.OGR_Fld_Destroy(@c_pointer)
       @c_pointer = nil
     end
 
@@ -32,8 +41,8 @@ module OGR
     #
     # @param name [String]
     # @param type [FFI::OGR::FieldType]
-    # @param width [Fixnum]
-    # @param precision [Fixnum]
+    # @param width [Integer]
+    # @param precision [Integer]
     # @param justification [FFI::OGR::Justification]
     def set(name, type, width, precision, justification)
       FFI::OGR::API.OGR_Fld_Set(
@@ -48,7 +57,10 @@ module OGR
 
     # @return [String]
     def name
-      FFI::OGR::API.OGR_Fld_GetNameRef(@c_pointer)
+      name, ptr = FFI::OGR::API.OGR_Fld_GetNameRef(@c_pointer)
+      ptr.autorelease = false
+
+      name
     end
 
     # @param new_value [String]
@@ -66,12 +78,12 @@ module OGR
       FFI::OGR::API.OGR_Fld_SetJustify(@c_pointer, new_value)
     end
 
-    # @return [Fixnum]
+    # @return [Integer]
     def precision
       FFI::OGR::API.OGR_Fld_GetPrecision(@c_pointer)
     end
 
-    # @param new_value [Fixnum]
+    # @param new_value [Integer]
     def precision=(new_value)
       FFI::OGR::API.OGR_Fld_SetPrecision(@c_pointer, new_value)
     end
@@ -86,12 +98,12 @@ module OGR
       FFI::OGR::API.OGR_Fld_SetType(@c_pointer, new_value)
     end
 
-    # @return [Fixnum]
+    # @return [Integer]
     def width
       FFI::OGR::API.OGR_Fld_GetWidth(@c_pointer)
     end
 
-    # @param new_value [Fixnum]
+    # @param new_value [Integer]
     def width=(new_value)
       FFI::OGR::API.OGR_Fld_SetWidth(@c_pointer, new_value)
     end

data/lib/ogr/geocoder.rb

@@ -5,6 +5,13 @@ require_relative '../ogr'
 module OGR
   # Geocode things!  http://www.gdal.org/ogr__geocoding_8h.html
   class Geocoder
+    # @param pointer [FFI::Pointer]
+    def self.release(pointer)
+      return unless pointer && !pointer.null?
+
+      FFI::GDAL::GDAL.OGRGeocodeDestroySession(pointer)
+    end
+
     # @return [FFI::Pointer] C pointer to the C geocoding session.
     attr_reader :c_pointer
 
@@ -36,13 +43,13 @@ module OGR
 
       options_ptr = GDAL::Options.pointer(converted_options)
 
-      @c_pointer = FFI::GDAL::GDAL.OGRGeocodeCreateSession(options_ptr)
+      pointer = FFI::GDAL::GDAL.OGRGeocodeCreateSession(options_ptr)
+      @c_pointer = FFI::AutoPointer.new(pointer, Geocoder.method(:release))
     end
 
     def destroy!
-      return unless @c_pointer
+      Geocoder.release(@c_pointer)
 
-      FFI::GDAL::GDAL.OGRGeocodeDestroySession(@c_pointer)
       @c_pointer = nil
     end
 
@@ -52,7 +59,7 @@ module OGR
     #   the address into elements.  Only works with some geocoding services.
     # @option options countrycodes [Array<String, Symbol>] Limit the search to a
     #   specific country or countries.  Only works with some geocoding services.
-    # @option options limit [Fixnum] Limit the number of records returned.  Only
+    # @option options limit [Integer] Limit the number of records returned.  Only
     #   works with some geocoding services.
     # @option options raw_feature ["YES"] Adds a raw feature to the returned
     #   feature that includes that raw XML response body.

data/lib/ogr/geometries/line_string.rb

@@ -6,6 +6,7 @@ module OGR
   class LineString
     include OGR::Geometry
     include GeometryTypes::Curve
+
     def self.approximate_arc_angles(center_x, center_y, z, primary_radius, secondary_radius,
       rotation, start_angle, end_angle, max_angle_step_size_degrees = 0)
       geometry_ptr = FFI::GDAL::GDAL.OGR_G_ApproximateArcAngles(

data/lib/ogr/geometries/line_string_25d.rb

@@ -10,14 +10,5 @@ module OGR
       geometry_ptr ||= OGR::Geometry.create(:wkbLineString25D)
       super(geometry_ptr, spatial_reference: spatial_reference)
     end
-
-    # Adds a point to a LineString or Point geometry.
-    #
-    # @param x [Float]
-    # @param y [Float]
-    # @param z [Float]
-    def add_point(x, y, z)
-      super(x, y, z)
-    end
   end
 end

data/lib/ogr/geometries/linear_ring.rb

@@ -7,8 +7,8 @@ module OGR
     # @param [FFI::Pointer] geometry_ptr
     def initialize(geometry_ptr = nil, spatial_reference: nil)
       geometry_ptr ||= OGR::Geometry.create(:wkbLinearRing)
-      initialize_from_pointer(geometry_ptr)
-      self.spatial_reference = spatial_reference if spatial_reference
+
+      super(geometry_ptr, spatial_reference: spatial_reference)
     end
 
     def to_line_string

data/lib/ogr/geometries/point.rb

@@ -38,15 +38,6 @@ module OGR
     end
     alias point_value point
 
-    # Wrapper around {#point_value} to provide API parity with other geometries
-    # that can have multiple points.
-    #
-    # @return [Array<Array<Float, Float>>]
-    # TODO: move to an extension
-    def point_values
-      [point]
-    end
-
     # @param x [Number]
     # @param y [Number]
     def set_point(x, y)