proj4rb 4.1.0 → 5.0.0

data/lib/proj/session.rb

@@ -4,7 +4,9 @@ module Proj
 
     # @!visibility private
     def self.finalize(context, pointer)
+      life_span = context.life_span
       proc do
+        next unless life_span.alive?
         Api.proj_insert_object_session_destroy(context, pointer)
       end
     end

data/lib/proj/transformation.rb

@@ -1,102 +1,102 @@
-module Proj
-  # Transformations are {CoordinateOperationMixin coordinate operations} that
-  # convert {Coordinate coordinates} from one {Crs} to another.
-  # In Proj they are defined as operations that exert a change in reference frame
-  # while {Conversion conversions } do not.
-  class Transformation < PjObject
-    include CoordinateOperationMixin
-
-    # Create a Transformation
-    #
-    # @param context [Context] Context
-    # @param name [String] Name of the transformation. Default is nil.
-    # @param auth_name [String] Transformation authority name. Default is nil.
-    # @param code [String] Transformation code. Default is nil.
-    # @param source_crs [CoordinateSystem] Source CRS
-    # @param target_crs [CoordinateSystem] Target CRS
-    # @param interpolation_crs [CoordinateSystem] Interpolation. Default is nil
-    # @param method_name [String] Method name. Default is nil.
-    # @param method_auth_name [String] Method authority name. Default is nil.
-    # @param method_code [String] Method code. Default is nil.
-    # @param params [Array<Parameter>] Parameter descriptions
-    # @param accuracy [Float] Accuracy of the transformation in meters. A negative value means unknown.
-    #
-    # @return [Transformation]
-    def self.create(context, name: nil, auth_name: nil, code: nil,
-                    source_crs:, target_crs:, interpolation_crs: nil,
-                    method_name: nil, method_auth_name: nil, method_code: nil,
-                    params:, accuracy:)
-
-      params_ptr = FFI::MemoryPointer.new(Api::PJ_PARAM_DESCRIPTION, params.size)
-      params.each_with_index do |param, i|
-        param_description_target = Api::PJ_PARAM_DESCRIPTION.new(params_ptr[i])
-        param_description_source = param.to_description
-        param_description_target.to_ptr.__copy_from__(param_description_source.to_ptr, Api::PJ_PARAM_DESCRIPTION.size)
-      end
-
-      ptr = Api.proj_create_transformation(context, name, auth_name, code,
-                                           source_crs, target_crs, interpolation_crs,
-                                           method_name, method_auth_name, method_code,
-                                           params.count, params_ptr, accuracy)
-      self.create_object(ptr, context)
-    end
-
-    # Transforms a {Coordinate} from the source {Crs} to the target {Crs}. Coordinates should be expressed in
-    # the units and axis order of the definition of the source CRS. The returned transformed coordinate will
-    # be in the units and axis order of the definition of the target CRS.
-    #
-    # For most geographic Crses, the units will be in degrees. For geographic CRS defined by the EPSG authority,
-    # the order of coordinates is latitude first, longitude second. When using a PROJ initialization string,
-    # on contrary, the order will be longitude first, latitude second.
-    #
-    # For projected CRS, the units may vary (metre, us-foot, etc..).
-    #
-    # For projected CRS defined by the EPSG authority, and with EAST / NORTH directions, the axis order might be
-    # easting first, northing second, or the reverse. When using a PROJ string, the order will be
-    # easting first, northing second, except if the +axis parameter modifies it.
-    #
-    # @see https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs_from_pj
-    # @see  https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs proj_create_crs_to_crs
-    #
-    # @param source [Crs, String] The source Crs. See the Crs documentation for the string format
-    # @param target [Crs, String] The target Crs. See the Crs documentation for the string format
-    # @param area [Area] If an area is specified a more accurate transformation between two given systems can be chosen
-    # @param context [Context]
-    # @param authority [String] Restricts the authority of coordinate operations looked up in the database
-    # @param accuracy [Float] Sets the minimum desired accuracy (in metres) of the candidate coordinate operations
-    # @param allow_ballpark [Boolean] Set to false to disallow the use of Ballpark transformation in the candidate coordinate operations.
-    # @param only_best [Boolean] Set to true to cause PROJ to error out if the best transformation cannot be used. Requires Proj 9.2 and higher
-    #
-    # @return [Transformation] A new transformation
-    def initialize(source, target, context=nil,
-                   area: nil, authority: nil, accuracy: nil, allow_ballpark: nil, only_best: nil, force_over: nil)
-
-      context ||= Context.current
-
-      options = {"AUTHORITY": authority,
-                 "ACCURACY": accuracy.nil? ? nil : accuracy.to_s,
-                 "ALLOW_BALLPARK": allow_ballpark.nil? ? nil : (allow_ballpark ? "YES" : "NO"),
-                 "ONLY_BEST": only_best.nil? ? nil : (only_best ? "YES" : "NO"),
-                 "FORCE_OVER": force_over.nil? ? nil : (force_over ? "YES" : "NO")}
-      options_ptr = create_options_pointer(options)
-
-      ptr = if source.is_a?(Crs) && target.is_a?(Crs)
-              if Api.method_defined?(:proj_create_crs_to_crs_from_pj)
-                Api.proj_create_crs_to_crs_from_pj(context, source, target, area, options_ptr)
-              else
-                Api.proj_create_crs_to_crs(context, source.definition, target.definition, area)
-              end
-            else
-              Api.proj_create_crs_to_crs(context, source, target, nil)
-            end
-
-      if ptr.null?
-        Error.check_context(context)
-        # If that does not raise an error then no operation was found
-        raise(Error, "No operation found matching criteria")
-      end
-
-      super(ptr, context)
-    end
-  end
-end
+module Proj
+  # Transformations are {CoordinateOperationMixin coordinate operations} that
+  # convert {Coordinate coordinates} from one {Crs} to another.
+  # In Proj they are defined as operations that exert a change in reference frame
+  # while {Conversion conversions } do not.
+  class Transformation < PjObject
+    include CoordinateOperationMixin
+
+    # Create a Transformation
+    #
+    # @param context [Context] Context
+    # @param name [String] Name of the transformation. Default is nil.
+    # @param auth_name [String] Transformation authority name. Default is nil.
+    # @param code [String] Transformation code. Default is nil.
+    # @param source_crs [CoordinateSystem] Source CRS
+    # @param target_crs [CoordinateSystem] Target CRS
+    # @param interpolation_crs [CoordinateSystem] Interpolation. Default is nil
+    # @param method_name [String] Method name. Default is nil.
+    # @param method_auth_name [String] Method authority name. Default is nil.
+    # @param method_code [String] Method code. Default is nil.
+    # @param params [Array<Parameter>] Parameter descriptions
+    # @param accuracy [Float] Accuracy of the transformation in meters. A negative value means unknown.
+    #
+    # @return [Transformation]
+    def self.create(context, name: nil, auth_name: nil, code: nil,
+                    source_crs:, target_crs:, interpolation_crs: nil,
+                    method_name: nil, method_auth_name: nil, method_code: nil,
+                    params:, accuracy:)
+      Error.validate_context!(context)
+
+      params_ptr = FFI::MemoryPointer.new(Api::PjParamDescription, params.size)
+      params.each_with_index do |param, i|
+        param_description_target = Api::PjParamDescription.new(params_ptr[i])
+        param_description_source = param.to_description
+        param_description_target.to_ptr.__copy_from__(param_description_source.to_ptr, Api::PjParamDescription.size)
+      end
+
+      ptr = Api.proj_create_transformation(context, name, auth_name, code,
+                                           source_crs, target_crs, interpolation_crs,
+                                           method_name, method_auth_name, method_code,
+                                           params.count, params_ptr, accuracy)
+      self.create_object(ptr, context)
+    end
+
+    # Transforms a {Coordinate} from the source {Crs} to the target {Crs}. Coordinates should be expressed in
+    # the units and axis order of the definition of the source CRS. The returned transformed coordinate will
+    # be in the units and axis order of the definition of the target CRS.
+    #
+    # For most geographic Crses, the units will be in degrees. For geographic CRS defined by the EPSG authority,
+    # the order of coordinates is latitude first, longitude second. When using a PROJ initialization string,
+    # on contrary, the order will be longitude first, latitude second.
+    #
+    # For projected CRS, the units may vary (metre, us-foot, etc..).
+    #
+    # For projected CRS defined by the EPSG authority, and with EAST / NORTH directions, the axis order might be
+    # easting first, northing second, or the reverse. When using a PROJ string, the order will be
+    # easting first, northing second, except if the +axis parameter modifies it.
+    #
+    # @see https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs_from_pj
+    # @see  https://proj.org/development/reference/functions.html#c.proj_create_crs_to_crs proj_create_crs_to_crs
+    #
+    # @param source [Crs, String] The source Crs. See the Crs documentation for the string format
+    # @param target [Crs, String] The target Crs. See the Crs documentation for the string format
+    # @param area [Area] If an area is specified a more accurate transformation between two given systems can be chosen
+    # @param context [Context]
+    # @param authority [String] Restricts the authority of coordinate operations looked up in the database
+    # @param accuracy [Float] Sets the minimum desired accuracy (in metres) of the candidate coordinate operations
+    # @param allow_ballpark [Boolean] Set to false to disallow the use of Ballpark transformation in the candidate coordinate operations.
+    # @param only_best [Boolean] Set to true to cause PROJ to error out if the best transformation cannot be used. Requires Proj 9.2 and higher
+    #
+    # @return [Transformation] A new transformation
+    def initialize(source, target, context=nil,
+                   area: nil, authority: nil, accuracy: nil, allow_ballpark: nil, only_best: nil, force_over: nil)
+
+      context ||= Context.current
+
+      options = Options.new("AUTHORITY": authority,
+                            "ACCURACY": accuracy.nil? ? nil : accuracy.to_s,
+                            "ALLOW_BALLPARK": allow_ballpark.nil? ? nil : (allow_ballpark ? "YES" : "NO"),
+                            "ONLY_BEST": only_best.nil? ? nil : (only_best ? "YES" : "NO"),
+                            "FORCE_OVER": force_over.nil? ? nil : (force_over ? "YES" : "NO"))
+
+      ptr = if source.is_a?(Crs) && target.is_a?(Crs)
+              if Api.method_defined?(:proj_create_crs_to_crs_from_pj)
+                Api.proj_create_crs_to_crs_from_pj(context, source, target, area, options)
+              else
+                Api.proj_create_crs_to_crs(context, source.definition, target.definition, area)
+              end
+            else
+              Api.proj_create_crs_to_crs(context, source, target, nil)
+            end
+
+      if ptr.null?
+        Error.check_context(context)
+        # If that does not raise an error then no operation was found
+        raise(Error, "No operation found matching criteria")
+      end
+
+      super(ptr, context)
+    end
+  end
+end

data/lib/proj/unit.rb

@@ -1,109 +1,82 @@
-module Proj
-  class Unit
-    # @!attribute [r] auth_name
-    #   @return [String] Authority name
-    # @!attribute [r] code
-    #   @return [String] Object code
-    # @!attribute [r] name
-    #   @return [String] Object name. For example "metre", "US survey foot", etc
-    # @!attribute [r] category
-    #   @return [String] Category of the unit: one of "linear", "linear_per_time", "angular", "angular_per_time", "scale", "scale_per_time" or "time"
-    # @!attribute [r] conv_factor
-    #   @return [String] Conversion factor to apply to transform from that unit to the corresponding SI unit (metre for "linear", radian for "angular", etc.). It might be 0 in some cases to indicate no known conversion factor
-    # @!attribute [r] proj_short_name
-    #   @return [String] PROJ short name, like "m", "ft", "us-ft", etc... Might be nil
-    # @!attribute [r] deprecated
-    #   @return [Boolean] Whether the object is deprecated
-    attr_reader :auth_name, :code, :name, :category, :conv_factor, :proj_short_name, :deprecated
-
-    # Returns a list of built in Units. This is deprecated. Use Database#units instead
-    def self.built_in(auth_name: nil, category: nil, allow_deprecated: false)
-      # First get linear units
-      pointer_to_array = FFI::Pointer.new(Api::PJ_UNITS, Api.proj_list_units)
-      result = Array.new
-      0.step do |i|
-        unit_info = Api::PJ_UNITS.new(pointer_to_array[i])
-        break if unit_info[:id].nil?
-        result << self.new('PROJ', unit_info[:id], unit_info[:name],
-                           'length', unit_info[:factor], unit_info[:id], false)
-      end
-
-      # Now get angular linear units
-      if Api.method_defined?(:proj_list_angular_units)
-        pointer_to_array = FFI::Pointer.new(Api::PJ_UNITS, Api.proj_list_angular_units)
-        0.step do |i|
-          unit_info = Api::PJ_UNITS.new(pointer_to_array[i])
-          break result if unit_info[:id].nil?
-          result << self.new('PROJ', unit_info[:id], unit_info[:name],
-                             'angular', unit_info[:factor], unit_info[:id], false)
-        end
-      end
-
-      if auth_name
-        result = result.find_all {|unit_info| unit_info.auth_name == auth_name}
-      end
-
-      if category
-        result = result.find_all {|unit_info| unit_info.category == category}
-      end
-      result
-    end
-
-    # Create a new Unit
-    # 
-    # @param auth_name [String] Authority name
-    # @param code [String] Object code
-    # @param name [String] Object name. For example "metre", "US survey foot", etc
-    # @param category [String] Category of the unit: one of "linear", "linear_per_time", "angular", "angular_per_time", "scale", "scale_per_time" or "time"
-    # @param conv_factor [String] Conversion factor to apply to transform from that unit to the corresponding SI unit (metre for "linear", radian for "angular", etc.). It might be 0 in some cases to indicate no known conversion factor
-    # @param proj_short_name [String] PROJ short name, like "m", "ft", "us-ft", etc... Might be nil
-    # @param deprecated [Boolean] Whether the object is deprecated
-    #
-    # @return [Unit]
-    def initialize(auth_name, code, name, category, conv_factor, proj_short_name, deprecated)
-      @auth_name = auth_name
-      @code = code
-      @name = name
-      @category = category
-      @conv_factor = conv_factor
-      @proj_short_name = proj_short_name
-      @deprecated = deprecated
-    end
-
-    def <=>(other)
-      self.name <=> other.name
-    end
-
-    def ==(other)
-      self.auth_name == other.auth_name &&
-      self.code == other.code
-    end
-
-    def unit_type
-      case self.category
-      when "linear"
-        :PJ_UT_LINEAR
-      when "linear_per_time"
-        :PJ_UT_LINEAR
-      when "angular"
-        :PJ_UT_ANGULAR
-      when "angular_per_time"
-        :PJ_UT_ANGULAR
-      when "scale"
-        :PJ_UT_SCALE
-      when "scale_per_time"
-        :PJ_UT_SCALE
-      when "time"
-        :PJ_UT_TIME
-      end
-    end
-
-    def to_s
-      self.name
-    end
-    
-    def inspect
-      "#<#{self.class} authority=\"#{auth_name}\", code=\"#{code}\", name=\"#{name}\">"
-    end
-  end
+module Proj
+  class Unit
+    # @!attribute [r] auth_name
+    #   @return [String] Authority name
+    # @!attribute [r] code
+    #   @return [String] Object code
+    # @!attribute [r] name
+    #   @return [String] Object name. For example "metre", "US survey foot", etc
+    # @!attribute [r] category
+    #   @return [String] Category of the unit: one of "linear", "linear_per_time", "angular", "angular_per_time", "scale", "scale_per_time" or "time"
+    # @!attribute [r] conv_factor
+    #   @return [String] Conversion factor to apply to transform from that unit to the corresponding SI unit (metre for "linear", radian for "angular", etc.). It might be 0 in some cases to indicate no known conversion factor
+    # @!attribute [r] proj_short_name
+    #   @return [String] PROJ short name, like "m", "ft", "us-ft", etc... Might be nil
+    # @!attribute [r] deprecated
+    #   @return [Boolean] Whether the object is deprecated
+    attr_reader :auth_name, :code, :name, :category, :conv_factor, :proj_short_name, :deprecated
+
+    # Returns a list of built in Units.
+    def self.built_in(auth_name: nil, category: nil, allow_deprecated: false)
+      database = Database.new(Context.current)
+      database.units(auth_name: auth_name, category: category, allow_deprecated: allow_deprecated)
+    end
+
+    # Create a new Unit
+    # 
+    # @param auth_name [String] Authority name
+    # @param code [String] Object code
+    # @param name [String] Object name. For example "metre", "US survey foot", etc
+    # @param category [String] Category of the unit: one of "linear", "linear_per_time", "angular", "angular_per_time", "scale", "scale_per_time" or "time"
+    # @param conv_factor [String] Conversion factor to apply to transform from that unit to the corresponding SI unit (metre for "linear", radian for "angular", etc.). It might be 0 in some cases to indicate no known conversion factor
+    # @param proj_short_name [String] PROJ short name, like "m", "ft", "us-ft", etc... Might be nil
+    # @param deprecated [Boolean] Whether the object is deprecated
+    #
+    # @return [Unit]
+    def initialize(auth_name, code, name, category, conv_factor, proj_short_name, deprecated)
+      @auth_name = auth_name
+      @code = code
+      @name = name
+      @category = category
+      @conv_factor = conv_factor
+      @proj_short_name = proj_short_name
+      @deprecated = deprecated
+    end
+
+    def <=>(other)
+      self.name <=> other.name
+    end
+
+    def ==(other)
+      self.auth_name == other.auth_name &&
+      self.code == other.code
+    end
+
+    def unit_type
+      case self.category
+      when "linear"
+        :PJ_UT_LINEAR
+      when "linear_per_time"
+        :PJ_UT_LINEAR
+      when "angular"
+        :PJ_UT_ANGULAR
+      when "angular_per_time"
+        :PJ_UT_ANGULAR
+      when "scale"
+        :PJ_UT_SCALE
+      when "scale_per_time"
+        :PJ_UT_SCALE
+      when "time"
+        :PJ_UT_TIME
+      end
+    end
+
+    def to_s
+      self.name
+    end
+    
+    def inspect
+      "#<#{self.class} authority=\"#{auth_name}\", code=\"#{code}\", name=\"#{name}\">"
+    end
+  end
 end

data/lib/proj.rb

@@ -1,7 +1,10 @@
 # encoding: UTF-8
 
-require_relative 'api/api'
+require_relative 'api/proj_ffi'
 
+require_relative 'proj/pj_axis_description'
+require_relative 'proj/pj_param_description'
+require_relative 'proj/options'
 require_relative 'proj/pj_object'
 require_relative 'proj/pj_objects'
 require_relative 'proj/coordinate_operation_mixin'
@@ -13,20 +16,24 @@ require_relative 'proj/transformation'
 require_relative 'proj/area'
 require_relative 'proj/axis_info'
 require_relative 'proj/bounds'
+require_relative 'proj/bounds3d'
+require_relative 'proj/coordinate_metadata'
 require_relative 'proj/coordinate_system'
 require_relative 'proj/crs_info'
+require_relative 'proj/life_span'
 require_relative 'proj/context'
 require_relative 'proj/coordinate'
 require_relative 'proj/database'
 require_relative 'proj/datum'
+require_relative 'proj/domain'
 require_relative 'proj/datum_ensemble'
 require_relative 'proj/ellipsoid'
 require_relative 'proj/error'
-require_relative 'proj/file_api'
+require_relative 'proj/file_api_callbacks'
 require_relative 'proj/grid'
 require_relative 'proj/grid_cache'
 require_relative 'proj/grid_info'
-require_relative 'proj/network_api'
+require_relative 'proj/network_api_callbacks'
 require_relative 'proj/parameter'
 require_relative 'proj/operation'
 require_relative 'proj/operation_factory_context'

data/lib/proj4.rb

@@ -1,6 +1,6 @@
-# encoding: UTF-8
-
-# This file is for backwards compatibility to the Proj4 namespace
-require_relative './proj'
-
+# encoding: UTF-8
+
+# This file is for backwards compatibility to the Proj4 namespace
+require_relative './proj'
+
 Proj4 = Proj

data/proj4rb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = 'proj4rb'
-  spec.version = '4.1.0'
+  spec.version = '5.0.0'
   spec.summary = 'Ruby bindings for the Proj coordinate transformation library'
   spec.description = <<-EOF
     Ruby bindings for the Proj coordinate transformation library
@@ -13,18 +13,23 @@ Gem::Specification.new do |spec|
 
   spec.requirements << 'Proj Library'
   spec.require_path = 'lib'
-  spec.files = Dir['ChangeLog',
+  spec.files = Dir['CHANGELOG.md',
                    'Gemfile',
                    'MIT-LICENSE',
                    'proj4rb.gemspec',
                    'Rakefile',
-                   'README.rdoc',
+                   'README.md',
                    'lib/**/*.rb',
                    'test/*.rb']
 
-  spec.test_files = Dir["test/test_*.rb"]
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => 'https://github.com/cfis/proj4rb',
+    'changelog_uri' => 'https://github.com/cfis/proj4rb/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://cfis.github.io/proj4rb/'
+  }
 
-  spec.add_dependency "ffi"
+  spec.add_dependency "ffi", ">=1.17.4"
 
   spec.add_development_dependency('bundler')
   spec.add_development_dependency('rake')

data/test/abstract_test.rb

@@ -1,29 +1,8 @@
-require 'bundler/setup'
-require 'minitest/autorun'
-require 'proj'
-
-class AbstractTest < Minitest::Test
-  def self.proj7?
-    Proj::Api::PROJ_VERSION >= Gem::Version.new("7.0.0")
-  end
-
-  def self.proj8?
-    Proj::Api::PROJ_VERSION >= Gem::Version.new("8.0.0")
-  end
-
-  def self.proj9?
-    Proj::Api::PROJ_VERSION >= Gem::Version.new("9.0.0")
-  end
-
-  def proj7?
-    self.class.proj7?
-  end
-
-  def proj8?
-    self.class.proj8?
-  end
-
-  def proj9?
-    self.class.proj9?
-  end
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'proj'
+
+Minitest.load_plugins
+
+class AbstractTest < Minitest::Test
 end