proj4rb 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9e88b214716f78e690e7265c6a9edc9e2c9c77cbb6e40c32883eec61320cc5
-  data.tar.gz: 4102575947ce82e7fdc40d6feeb37bb4b34f024dbfeda66fe20a1909b4a93ccd
+  metadata.gz: 26b50da982077e9d6cd97efc8746bd4e888bccf689d7bb3a8e0a752493165181
+  data.tar.gz: 3001ce9757d511e27bc4c7c0118bf2da986ab8e811c106c1517d5a5cf3cdd6a9
 SHA512:
-  metadata.gz: 87926009a11eb4a4d71cedcd79a4d72b8196e57df4ac7b59cb28c6b75da5635b89291fa564a1153fb4d2cd5cd910e5ff2c489695177aac54d5a6302a90d1cb26
-  data.tar.gz: 412e2777701a836b9b7d76f00e0e8526a5488711adf10051ea34f9603999a25d290d74b073d2e0f7940e68efc210c416f5a14b6f74e01e4572883caafe620738
+  metadata.gz: 6da17b22219016b19b4e93b78a3bbb01a4794b1a21d57b2ef76cff54eb7d4c5ef50ef73679c9f91497774a10690c359f1d7bdd297892ab5745c0149bf1a3eeec
+  data.tar.gz: 991f95662e5d10663da570b9e6efed6b37ba2c2b86d94389d485050e385c50ed6a13ad44aa84ac42b29d6a74830350739fa47a2ae5f736b09325fc5db439f5dc

data/ChangeLog

@@ -1,3 +1,14 @@
+4.1.1 - January 30, 2024
+======================
+* Update tests for Proj 9.3
+* Initial support for CoordinateMetadata in Proj 9.4 (not released yet)
+
+4.1.0 - March 12, 2023
+======================
+* Fix YARD warnings
+* Fix YARD types to match RBS types
+* Don't use type as attribute or method name to avoid conflicts with RBS
+
 4.0.0 - March 12, 2023
 ======================
 * Support Proj 9

data/README.rdoc

@@ -1,20 +1,19 @@
 = Proj4rb
-This gem provides Ruby bindings for the Proj Library (https://proj.org). The Proj Library supports converting coordinates
-between a number of different coordinate systems and projections.
+This gem provides Ruby bindings for the Proj Library (https://proj.org). The Proj Library supports converting coordinates between a number of different coordinate systems and projections. Note the Proj library used to be know as Proj4.
+
+The bindings support Proj version 4 through the current version (9.3.1). The Proj library and API were completelely written during this time. To support all these versions, the gem dynamically loads code based on the installed Proj version.
 
 == Documentation
 Reference documentation is available at https://rubydoc.info/github/cfis/proj4rb.
 
-Examples can be found in this README file as well as in the {file:Examples.rdoc Examples} file. In addition, the test suite has exapmles of calling almost every API so when in doubt take a look at them!
+Examples can be found in this README file as well as in the Examples file. In addition, the test suite has exapmles of calling almost every API so when in doubt take a look at them!
 
 == Installation
-First install the gem in the usual manner:
+First install the gem:
 
     gem install proj4rb
 
-Next install the Proj Library. This of course varies per system, but you want to install the latest version Proj
-possible. Once installed, you'll need to make sure that libproj is installed on your operating system's
-load path.
+Next install the Proj Library. This of course varies per system, but you want to install the latest version Proj possible. Once installed, you'll need to make sure that libproj is installed on your operating system's load path.
 
 == Usage
 To get started first require the gem:
@@ -58,19 +57,16 @@ To create a coordinate system, you can use CRS codes, well-known text (WKT) stri
 
 Notice when using the old-style Proj4 string, the addition of the "+type=crs" value.
 
-If you are using Proj 5, then you should create a transformation using epsg strings (see below). If you are using Proj 4,
-you need to use the deprecated Projection class (see documentation).
+If you are using Proj 5 or newer, then you should create a transformation using epsg strings (see below). If you are using Proj 4, you need to use the deprecated Projection class (see documentation).
 
 === Transformation
-After you have created two coordinate systems, you can then create a transformation. For example, if you want to
-convert coordinates from the "3-degree Gauss-Kruger zone 3" coordinate system to WGS84 (one version of lat-long)
-first create a transformation:
+After you have created two coordinate systems, you can then create a transformation. For example, if you want to convert coordinates from the "3-degree Gauss-Kruger zone 3" coordinate system to WGS84 (one version of lat-long) first create a transformation:
 
     crs_gk  = Proj::Crs.new('EPSG:31467')
     crs_wgs84 = Proj::Crs.new('EPSG:4326')
     transform = Proj::Transformation.new(crs_gk, crs_wgs84)
 
-Alternatively, or if you are using Proj 5, you can create a transformation without first
+Alternatively, or if you are using Proj 5 or later, you can create a transformation without first
 creating Crs instances. Instead, pass the EPSG information directly to the transformation:
 
     transform = Proj::Transformation.new('EPSG:31467', 'EPSG:4326')
@@ -105,8 +101,7 @@ Transformations are a type of Coordinate Operation. PROJ divides coordinate oper
 
 Conversions are coordinate operations that do not exert a change in reference frame. The Ruby bindings support these via the Conversion class. See https://proj.org/operations/conversions/index.html for more information.
 
-Projections are cartographic mappings of the sphere onto the plane. Technically projections are conversions (according to ISO standards), but PROJ distinguishes them from conversions. The Ruby bindings support these
- via the Projection module which has methods to create many common projections. A list can be found at https://proj.org/operations/projections/index.html.
+Projections are cartographic mappings of the sphere onto the plane. Technically projections are conversions (according to ISO standards), but PROJ distinguishes them from conversions. The Ruby bindings support these via the Projection module which has methods to create many common projections. A list can be found at https://proj.org/operations/projections/index.html.
 
 Transformations are coordinate operations that do cause a change in reference frames. The Ruby bindings support these via the Transformation class.
 
@@ -116,9 +111,7 @@ For more information see https://proj.org/operations/index.html
 The OperationFactoryContext class can be used to build coordinate operations between two CRSes. This is done by first creating a factory and setting appropiate filters. These include spatial filters, accuracy filters, grid availability filters, etc. Once filters are set, then the factory can be queried for a list of possible conversions. For examples, please see the operation_factory_context_test.rb file.
 
 === Coordinate
-Notice the examples above transform Coordinate objects. A Coordinate consists
-of up to four double values to represent three directions plus time. In general
-you will need to fill out at least the first two values:
+Notice the examples above transform Coordinate objects. A Coordinate consists of up to four double values to represent three directions plus time. In general you will need to fill out at least the first two values:
 
     from = Proj::Coordinate.new(x: 5428192.0, y: 3458305.0, z: -5.1790915237)
     from = Proj::Coordinate.new(lam: 48.9906726079, phi: 8.4302123334)
@@ -138,41 +131,31 @@ If you prefer to work with a uniform axis order, regardless of the axis orders m
 
 The normalized transformation will return output coordinates in longitude, latitude order for geographic CRSes and easting, northing for most projected CRSes.
 
-For more information see {https://proj.org/faq.html#why-is-the-axis-ordering-in-proj-not-consistent Why Is The Axis Ordering In Proj Not Consistent?}
+For more information see https://proj.org/faq.html#why-is-the-axis-ordering-in-proj-not-consistent.
 
 === Context
-Contexts are used to support multi-threaded programs. The bindings expose this object via Context.current
-and store it using thread local storage. Use the context object to access error codes, set proj4
-compatability settings, set the logging level and to install custom logging code.
+Contexts are used to support multi-threaded programs. The bindings expose this object via Context.current and store it using thread local storage. Use the context object to access error codes, set proj4 compatability settings, set the logging level and to install custom logging code.
 
-Both Crs and Transformation objects take a context object in their constructors. If none is passed, they default
-to using Context.current
+Both Crs and Transformation objects take a context object in their constructors. If none is passed, they default to using Context.current
 
 == Network Access
-Proj supports downloading grid files on demand if network access is enabled (it is disabled by default). To enable network use the method {Context#network_enabled=}. To specify the url endpoint use {Context#url=}. Advanced users can replace Proj's networking code, which uses libcurl, with their own implementation. To do this see the NetworkApi class.
+Proj supports downloading grid files on demand if network access is enabled (it is disabled by default). To enable network use the method Context#network_enabled=. To specify the url endpoint use Context#url=. Advanced users can replace Proj's networking code, which uses libcurl, with their own implementation. To do this see the NetworkApi class.
 
-Downloaded grids are cached in a sqlite file named cache.db. To specify the location, size and other characteristics of the cache file refer to the {GridCache} class which is accessible via Context#cache. By default the cache size is 300MB. Caching is on by default but can be disabled via GridCache#enabled=.
+Downloaded grids are cached in a sqlite file named cache.db. To specify the location, size and other characteristics of the cache file refer to the GridCache class which is accessible via Context#cache. By default the cache size is 300MB. Caching is on by default but can be disabled via GridCache#enabled=.
 
 == Error handling
-When an error occurs, a Proj::Error instance will be thrown with the underlying message provided
-from the Proj library.
+When an error occurs, a Proj::Error instance will be thrown with the underlying message provided from the Proj library.
 
 == Finding Proj Library (PROJ_LIB_PATH)
-proj4rb will search in a number of well-known locations for the libproj shared library. You
-can override this by specifying the full path to the library using the PROJ_LIB_PATH
-environmental variable.
+proj4rb will search in a number of well-known locations for the libproj shared library. You can override this by specifying the full path to the library using the PROJ_LIB_PATH environmental variable.
 
 == Finding Proj Files (PROJ_DATA)
-Starting with version 6, Proj stores its information (datums, ellipsoids, prime meridians, coordinate systems,
-units, etc) in a sqlite file called proj.db. If Proj cannot find its database an exception will be
-raised. In this case, you can set the environmental variable PROJ_DATA to point to the folder that
-contains the proj.db file. Note PROJ_LIB must be set by whatever launches your Ruby program.
-The Ruby program itself cannot set this variable and have it work correctly (at least not on windows).
+Starting with version 6, Proj stores its information (datums, ellipsoids, prime meridians, coordinate systems, units, etc) in a sqlite file called proj.db. If Proj cannot find its database an exception will be raised. In this case, you can set the environmental variable PROJ_DATA to point to the folder that contains the proj.db file. Note PROJ_LIB must be set by whatever launches your Ruby program. The Ruby program itself cannot set this variable and have it work correctly (at least not on windows).
 
 For more information see https://proj.org/resource_files.html
 
 == Class Hierarchy
-The proj4rb class hierarchy is based on Proj's class hiearchy which, in turn, is derived from {http://docs.opengeospatial.org/as/18-005r5/18-005r5.html ISO 19111:2019}. It is:
+The proj4rb class hierarchy is based on Proj's class hiearchy which, in turn, is derived from http://docs.opengeospatial.org/as/18-005r5/18-005r5.html. It is:
 
    PjObject
      CoordinateOperationMixin
@@ -194,8 +177,7 @@ The PjObject class defines several methods to create new objects:
 The methods will return instances of the correct subclass.
 
 == Tests
-Proj4rb ships with a full test suite designed to work using Proj 6. If you are using an earlier version of Proj,
-then expect *many* test failures.
+Proj4rb ships with a full test suite designed to work using Proj 6. If you are using an earlier version of Proj, then expect *many* test failures.
 
 == License
 Proj4rb is released under the MIT license.
@@ -204,4 +186,4 @@ Proj4rb is released under the MIT license.
 The proj4rb Ruby bindings were started by Guilhem Vellut with most of the code 
 written by Jochen Topf.  Charlie Savage ported the code to Windows and added 
 the Windows build infrastructure. Later, he rewrote the code to support
-Proj version 5 and 6 and ported it to use FFI.
+Proj version 5, 6, 7, 8 and 9 and ported it to use FFI.

data/lib/api/api.rb

@@ -5,6 +5,9 @@ module Proj
   module Api
     extend FFI::Library
 
+    # List of knows PROJ library versions
+    #
+    # @return [Array<String>]
     def self.library_versions
       ["25", # 9.2
        "9_1", # 9.1
@@ -18,6 +21,9 @@ module Proj
        "11"] # 4.9
     end
 
+    # Search paths to use when looking for PROJ library
+    #
+    # @return [Array<String>]
     def self.search_paths
       result = case RbConfig::CONFIG['host_os']
                  when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
@@ -33,18 +39,27 @@ module Proj
       result
     end
 
+    # Windows search paths for PROJ library
+    #
+    # @return [Array<String>]
     def self.windows_search_paths
       self.library_versions.map do |version|
         ["libproj-#{version}", "libproj_#{version}"]
       end.flatten
     end
 
+    # Linux search paths for PROJ library
+    #
+    # @return [Array<String>]
     def self.linux_search_paths
       self.library_versions.map do |version|
         "libproj.so.#{version}"
       end
     end
 
+    # MacOS search paths for PROJ library
+    #
+    # @return [Array<String>]
     def self.macos_search_paths
       # On MacOS only support HomeBrew since the MacPort is unsupported and ancient (5.2).
       self.library_versions.map do |version|
@@ -52,6 +67,9 @@ module Proj
       end
     end
 
+    # Load PROJ library
+    #
+    # @return [FFI::DynamicLibrary]
     def self.load_library
       if ENV["PROJ_LIB_PATH"]
         ffi_lib ENV["PROJ_LIB_PATH"]
@@ -62,6 +80,9 @@ module Proj
       ffi_libraries.first
     end
 
+    # Load API files based on PROJ version
+    #
+    # @return [nil]
     def self.load_api
       # First load the base 5.0 api so we can determine the Proj Version
       require_relative './api_5_0'
@@ -72,7 +93,7 @@ module Proj
                   '6.0.0', '6.1.0', '6.2.0', '6.3.0',
                   '7.0.0', '7.1.0', '7.2.0',
                   '8.0.0', '8.1.0', '8.2.0',
-                  '9.1.0', '9.2.0']
+                  '9.1.0', '9.2.0', '9.4.0']
 
       versions.each do |version|
         api_version = Gem::Version.new(version)

data/lib/api/api_5_0.rb

@@ -28,7 +28,6 @@ module Proj
              :PJ,    :pointer,  # projection entry point
              :descr, :pointer   # description text
     end
-    PJ_OPERATIONS = PJ_LIST
 
     class PJ_ELLPS < FFI::Struct
       layout :id, :string, # ellipse keyword name
@@ -197,6 +196,7 @@ module Proj
              :lastupdate, [:string, 16] # Date of last update in YYYY-MM-DD format
     end
 
+    # @return [Symbol]
     PJ_LOG_LEVEL = enum(:PJ_LOG_NONE , 0,
                         :PJ_LOG_ERROR, 1,
                         :PJ_LOG_DEBUG, 2,
@@ -206,11 +206,13 @@ module Proj
                         :PJ_LOG_DEBUG_MINOR, 3) # for proj_api.h compatibility
 
     # Apply transformation to observation - in forward or inverse direction
+    # @return [Symbol]
     PJ_DIRECTION = enum(:PJ_FWD, 1,   # Forward
                         :PJ_IDENT, 0, # Do nothing
                         :PJ_INV, -1)  # Inverse
 
     # Object category
+    # @return [Symbol]
     PJ_CATEGORY = enum(:PJ_CATEGORY_ELLIPSOID,
                        :PJ_CATEGORY_PRIME_MERIDIAN,
                        :PJ_CATEGORY_DATUM,
@@ -218,6 +220,7 @@ module Proj
                        :PJ_CATEGORY_COORDINATE_OPERATION,
                        :PJ_CATEGORY_DATUM_ENSEMBLE)
 
+    # @return [Symbol]
     PJ_TYPE = enum(:PJ_TYPE_UNKNOWN,
                    :PJ_TYPE_ELLIPSOID,
                    :PJ_TYPE_PRIME_MERIDIAN,
@@ -256,9 +259,11 @@ module Proj
 
                    :PJ_TYPE_COORDINATE_METADATA)
 
+    # @return [Symbol]
     PJ_PROJ_STRING_TYPE = enum(:PJ_PROJ_5,
                                :PJ_PROJ_4)
 
+    # @return [Symbol]
     PJ_COORDINATE_SYSTEM_TYPE = enum(:PJ_CS_TYPE_UNKNOWN,
                                      :PJ_CS_TYPE_CARTESIAN,
                                      :PJ_CS_TYPE_ELLIPSOIDAL,
@@ -270,6 +275,7 @@ module Proj
                                      :PJ_CS_TYPE_TEMPORALCOUNT,
                                      :PJ_CS_TYPE_TEMPORALMEASURE)
 
+    # @return [Symbol]
     PJ_WKT_TYPE = enum(:PJ_WKT2_2015,
                        :PJ_WKT2_2015_SIMPLIFIED,
                        :PJ_WKT2_2019,

data/lib/api/api_6_0.rb

@@ -1,11 +1,13 @@
 module Proj
   module Api
     # Comparison criteria
+    # @return [Symbol]
     PJ_COMPARISON_CRITERION = enum(:PJ_COMP_STRICT, # All properties are identical
                                    :PJ_COMP_EQUIVALENT, # The objects are equivalent for the purpose of coordinate operations. They can differ by the name of their objects, identifiers, other metadata. Parameters may be expressed in different units, provided that the value is (with some tolerance) the same once expressed in a common unit.
                                    :PJ_COMP_EQUIVALENT_EXCEPT_AXIS_ORDER_GEOGCRS) # Same as EQUIVALENT, relaxed with an exception that the axis order of the base CRS of a DerivedCRS/ProjectedCRS or the axis order of a GeographicCRS is ignored. Only to be used with DerivedCRS/ProjectedCRS/GeographicCRS
 
     #Guessed WKT "dialect"
+    # @return [Symbol]
     PJ_GUESSED_WKT_DIALECT = enum(:PJ_GUESSED_WKT2_2019,
                                   :PJ_GUESSED_WKT2_2018,
                                   :PJ_GUESSED_WKT2_2015,
@@ -65,9 +67,9 @@ module Proj
                 :type, PJ_TYPE, # Object type
                 :deprecated, :int, # Whether the object is deprecated
                 :bbox_valid, :int, # Whether bbox values in degrees are valid
-                :west_lon_degree, :double,  # Western-most longitude of the area of use, in degrees.
+                :west_lon_degree, :double, # Western-most longitude of the area of use, in degrees.
                 :south_lat_degree, :double, # Southern-most latitude of the area of use, in degrees.
-                :east_lon_degree, :double,  # Eastern-most longitude of the area of use, in degrees.
+                :east_lon_degree, :double, # Eastern-most longitude of the area of use, in degrees.
                 :north_lat_degree, :double, # Northern-most latitude of the area of use, in degrees.
                 :area_name, :string, # Name of the area of use
                 :projection_method_name, :string] # Name of the projection method for a projected CRS. Might be NULL even for projected CRS in some cases.

data/lib/api/api_7_0.rb

@@ -4,6 +4,7 @@ module Proj
     typedef :pointer, :PROJ_FILE_HANDLE
     typedef :pointer, :USER_DATA
 
+    # @return [Symbol]
     PROJ_OPEN_ACCESS = enum(:PROJ_OPEN_ACCESS_READ_ONLY, # Read-only access. Equivalent to "rb"
                             :PROJ_OPEN_ACCESS_READ_UPDATE, # Read-update access. File should be created if not existing. Equivalent to "r+b
                             :PROJ_OPEN_ACCESS_CREATE) # Create access. File should be truncated to 0-byte if already existing. Equivalent to "w+b"

data/lib/api/api_9_4.rb

@@ -0,0 +1,6 @@
+module Proj
+  module Api
+    attach_function :proj_coordinate_metadata_create, [:PJ_CONTEXT, :PJ, :double], :PJ
+    attach_function :proj_crs_has_point_motion_operation, [:PJ_CONTEXT, :PJ], :int
+  end
+end

data/lib/api/api_experimental.rb

@@ -1,17 +1,21 @@
 module Proj
   module Api
     if Api::PROJ_VERSION >= Gem::Version.new('6.0.0')
+
+      # @return [Symbol]
       PJ_UNIT_TYPE = enum(:PJ_UT_ANGULAR,
                           :PJ_UT_LINEAR,
                           :PJ_UT_SCALE,
                           :PJ_UT_TIME)
 
+      # @return [Symbol]
       PJ_CARTESIAN_CS_2D_TYPE = enum(:PJ_CART2D_EASTING_NORTHING,
                                      :PJ_CART2D_NORTHING_EASTING,
                                      :PJ_CART2D_NORTH_POLE_EASTING_SOUTH_NORTHING_SOUTH,
                                      :PJ_CART2D_SOUTH_POLE_EASTING_NORTH_NORTHING_NORTH,
                                      :PJ_CART2D_WESTING_SOUTHING)
 
+      # @return [Symbol]
       PJ_ELLIPSOIDAL_CS_2D_TYPE = enum(:PJ_ELLPS2D_LONGITUDE_LATITUDE,
                                        :PJ_ELLPS2D_LATITUDE_LONGITUDE)
 
@@ -156,6 +160,7 @@ module Proj
     end
 
     if Api::PROJ_VERSION >= Gem::Version.new('6.3.0')
+      # @return [Symbol]
       PJ_ELLIPSOIDAL_CS_3D_TYPE = enum(:PJ_ELLPS3D_LONGITUDE_LATITUDE_HEIGHT,
                                        :PJ_ELLPS3D_LATITUDE_LONGITUDE_HEIGHT)
 

data/lib/proj/area.rb

@@ -6,6 +6,7 @@ module Proj
   class Area
     attr_reader :name, :west_lon_degree, :south_lat_degree, :east_lon_degree, :north_lat_degree
 
+    # @!visibility private
     def self.finalize(pointer)
       proc do
         Api.proj_area_destroy(pointer)

data/lib/proj/axis_info.rb

@@ -38,7 +38,7 @@ module Proj
     def unit_type
       database = Database.new(Context.default)
       unit = database.unit(self.unit_auth_name, self.unit_code)
-      unit.type
+      unit.unit_type
     end
   end
 end

data/lib/proj/context.rb

@@ -23,6 +23,7 @@ module Proj
       Thread.current[:proj_context] ||= Context.new
     end
 
+    # @!visibility private
     def self.finalize(pointer)
       proc do
         Api.proj_context_destroy(pointer)
@@ -177,7 +178,7 @@ module Proj
     #
     # @see https://proj.org/development/reference/functions.html#c.proj_context_get_user_writable_directory
     #
-    # @param [Boolean] If set to TRUE, create the directory if it does not exist already. Defaults to false
+    # @param create [Boolean] If true create the directory if it does not exist already. Defaults to false.
     #
     # @return [String] Directory
     def user_directory(create = false)
@@ -206,7 +207,7 @@ module Proj
       end
     end
 
-    # Installs a new {FileApi FileApiImpl}
+    # Installs a new {FileApiImpl FileApi}
     #
     # @see https://proj.org/development/reference/functions.html#c.proj_context_set_fileapi
     def set_file_api(file_api_klass)
@@ -219,7 +220,7 @@ module Proj
       @file_api = file_api_klass.new(self)
     end
 
-    # Installs a new {NetworkApi NetworkApiImpl}
+    # Installs a new {NetworkApiImpl NetworkApi}
     #
     # @see https://proj.org/development/reference/functions.html#c.proj_context_set_network_callbacks
     def set_network_api(network_api_klass)

data/lib/proj/conversion.rb

@@ -2,7 +2,7 @@
 require 'stringio'
 
 module Proj
-  # Conversions are {CoordinateOperationMix coordinate operations} that convert a source
+  # Conversions are {CoordinateOperationMixin coordinate operations} that convert a source
   # {Coordinate coordinate} to a new value. In Proj they are defined as operations that
   # do not exert a change in reference frame while {Transformation transformations } do.
   class Conversion < PjObject
@@ -20,7 +20,6 @@ module Proj
     # @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 [Double] Accuracy of the transformation in meters. A negative value means unknown.
     #
     # @return [Conversion]
     def self.create_conversion(context, name:, auth_name:, code:, method_name:, method_auth_name:, method_code:, params:)

data/lib/proj/coordinate_metadata.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+module Proj
+  # Coordinate metadata is the information required to make coordinates unambiguous. For a
+  # coordinate set referenced to a static CRS it is the CRS definition. For a
+  # coordinate set referenced to a dynamic CRS it is the CRS definition together
+  # with the coordinate epoch of the coordinates in the coordinate set.
+  #
+  # In a dynamic CRS, coordinates of a point on the surface of the Earth may change with time.
+  # To be unambiguous the coordinates must always be qualified with the epoch at which they
+  # are valid. The coordinate epoch is not necessarily the epoch at which the observation
+  # was collected.
+  class CoordinateMetadata < PjObject
+    # Create a CoordinateMetadata object
+    #
+    # @param crs [Crs] The associated Crs
+    # @param context [Context]. An optional Context
+    # @param epoch [Double]. Epoch at wich the CRS is valid
+    #
+    # @return [CoordinateMetadata]
+    def initialize(crs, context=nil, epoch=nil)
+      ptr = Api.proj_coordinate_metadata_create(context || Context.current, crs, epoch)
+
+      if ptr.null?
+        Error.check_object(self)
+      end
+
+      super(ptr, context)
+    end
+
+    # Returns the coordinate epoch
+    #
+    # @return [Double]
+    def epoch
+      Api.proj_coordinate_metadata_get_epoch(self.context, self)
+    end
+  end
+end

data/lib/proj/coordinate_operation_mixin.rb

@@ -6,7 +6,7 @@ module Proj
                      :unit_conv_factor, :unit_name, :unit_auth_name, :unit_code, :unit_category,
                      keyword_init: true)
 
-  # Coordinate Operations convert {Coordinate coordintates} to a new value. In Proj they are
+  # Coordinate Operations convert {Coordinate coordinates} to a new value. In Proj they are
   # can either by {Conversion conversions} that do not exert a change in reference frame
   # or {Transformation transformations} which do.
   module CoordinateOperationMixin
@@ -168,8 +168,8 @@ module Proj
       self.transform(coord, :PJ_INV)
     end
 
-    # Transforms a {Coordinate} in the specified direction. See {CoordinateOperation#forward forward} and
-    # {CoordinateOperation#inverse inverse}
+    # Transforms a {Coordinate} in the specified direction. See {CoordinateOperationMixin#forward forward} and
+    # {CoordinateOperationMixin#inverse inverse}
     #
     # @see https://proj.org/development/reference/functions.html#c.proj_trans
     #
@@ -212,7 +212,7 @@ module Proj
     # Transforms an array of {Coordinate coordinates}. Individual points that fail to transform
     # will have their components set to Infinity.
     #
-    # @param array [Array<Coordinate>] Coordinates to transform
+    # @param coordinates [Array<Coordinate>] Coordinates to transform
     # @param direction [PJ_DIRECTION] The direction of the transformation
     #
     # @return [Array<Coordinate>] Array of transformed coordinates
@@ -245,7 +245,7 @@ module Proj
     # @param iterations [Integer] The number of roundtrip transformations
     # @param coordinate [Coordinate] The input coordinate
     #
-    # @return [Double] The euclidean distance of the starting point coordinate and the last coordinate after n iterations back and forth.
+    # @return [Float] The euclidean distance of the starting point coordinate and the last coordinate after n iterations back and forth.
     def roundtrip(direction, iterations, coordinate)
       Api.proj_roundtrip(self, direction, iterations, coordinate.pj_coord)
     end
@@ -254,7 +254,7 @@ module Proj
     #
     # @see https://proj.org/development/reference/functions.html#c.proj_normalize_for_visualization
     #
-    # @return [CoordinateOperation] A new CoordinateOperation or nil in case of error
+    # @return [CoordinateOperationMixin] A new CoordinateOperation or nil in case of error
     def normalize_for_visualization
       ptr = Api.proj_normalize_for_visualization(self.context, self)
       self.class.create_object(ptr, self.context)
@@ -264,7 +264,7 @@ module Proj
     #
     # @see }https://proj.org/development/reference/functions.html#c.proj_trans_get_last_used_operation proj_trans_get_last_used_operation
     #
-    # @return [CoordinateOperation] The last used operation
+    # @return [CoordinateOperationMixin] The last used operation
     def last_used_operation
       ptr = Api.proj_trans_get_last_used_operation(self)
       self.class.create_object(ptr, self.context)
@@ -284,7 +284,7 @@ module Proj
     #
     # @see https://proj.org/development/reference/functions.html#c.proj_coordoperation_get_accuracy
     #
-    # @return [Double] The accuracy, or a negative value if unknown or in case of error.
+    # @return [Float] The accuracy, or a negative value if unknown or in case of error.
     def accuracy
       Api.proj_coordoperation_get_accuracy(self.context, self)
     end
@@ -348,7 +348,7 @@ module Proj
     #
     # @param error_if_incompatible [Boolean] If true an exception is thrown if the coordinate operation is not compatible with a WKT1 TOWGS84 representation
     #
-    # @return [Array<Double>] Array of 7 numbers that represent translation, rotation and scale parameters.
+    # @return [Array<Float>]] Array of 7 numbers that represent translation, rotation and scale parameters.
     #                          Rotation and scale difference terms might be zero if the transformation only includes translation parameters
     def to_wgs84(error_if_incompatible = false)
       parameter_count = 7

data/lib/proj/coordinate_system.rb

@@ -6,11 +6,11 @@ module Proj
     # Create a CoordinateSystem
     #
     # @param context [Context] The context associated with the CoordinateSystem
-    # @param type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
+    # @param cs_type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
     # @param axes [Array<PJ_AXIS_DESCRIPTION>] Array of Axes
     #
     # @return [CoordinateSystem]
-    def self.create(type, axes, context)
+    def self.create(cs_type, axes, context)
       axes_ptr = FFI::MemoryPointer.new(Api::PJ_AXIS_DESCRIPTION, axes.size)
       axes.each_with_index do |axis, i|
         axis_description_target = Api::PJ_AXIS_DESCRIPTION.new(axes_ptr[i])
@@ -18,7 +18,7 @@ module Proj
         axis_description_target.to_ptr.__copy_from__(axis_description_source.to_ptr, Api::PJ_AXIS_DESCRIPTION.size)
       end
 
-      pointer = Api.proj_create_cs(context, type, axes.count, axes_ptr)
+      pointer = Api.proj_create_cs(context, cs_type, axes.count, axes_ptr)
       Error.check_context(context)
       self.create_object(pointer, context)
     end
@@ -26,13 +26,13 @@ module Proj
     # Create an Ellipsoidal 2D CoordinateSystem
     #
     # @param context [Context] The context associated with the CoordinateSystem
-    # @param type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
+    # @param cs_type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
     # @param unit_name [String] Name of the angular units. Or nil for degree
-    # @param unit_conv_factor [Double] Conversion factor from the angular unit to radian. Set to 0 if unit name is degree
+    # @param unit_conv_factor [Float] Conversion factor from the angular unit to radian. Set to 0 if unit name is degree
     #
     # @return [CoordinateSystem]
-    def self.create_ellipsoidal_2d(type, context, unit_name: nil, unit_conv_factor: 0)
-      pointer = Api.proj_create_ellipsoidal_2D_cs(context, type, unit_name, unit_conv_factor)
+    def self.create_ellipsoidal_2d(cs_type, context, unit_name: nil, unit_conv_factor: 0)
+      pointer = Api.proj_create_ellipsoidal_2D_cs(context, cs_type, unit_name, unit_conv_factor)
       Error.check_context(context)
       self.create_object(pointer, context)
     end
@@ -40,15 +40,15 @@ module Proj
     # Create an Ellipsoidal 3D CoordinateSystem
     #
     # @param context [Context] The context associated with the CoordinateSystem
-    # @param type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
+    # @param cs_type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
     # @param horizontal_angular_unit_name [String] Name of the angular units. Or nil for degree
-    # @param horizontal_angular_unit_conv_factor [Double] Conversion factor from the angular unit to radian. Set to 0 if horizontal_angular_unit_name name is degree
-    # @param vertical_linear_unit_name [String] Name of the angular units. Or nil for meter
-    # @param vertical_linear_unit_conv_factor [Double] Conversion factor from the linear unit to meter. Set to 0 if vertical_linear_unit_name name is meter
+    # @param horizontal_angular_unit_conv_factor [Float] Conversion factor from the angular unit to radian. Set to 0 if horizontal_angular_unit_name name is degree
+    # @param vertical_linear_unit_name [String] Name of the linear units. Or nil for meters.
+    #     # @param vertical_linear_unit_conv_factor [Float] Conversion factor from the linear unit to meter. Set to 0 if vertical_linear_unit_name is meter.
     #
     # @return [CoordinateSystem]
-    def self.create_ellipsoidal_3d(type, context, horizontal_angular_unit_name: nil, horizontal_angular_unit_conv_factor: 0, vertical_linear_unit_name: nil, vertical_linear_unit_conv_factor: 0)
-      pointer = Api.proj_create_ellipsoidal_3D_cs(context, type, horizontal_angular_unit_name, horizontal_angular_unit_conv_factor, vertical_linear_unit_name, vertical_linear_unit_conv_factor)
+    def self.create_ellipsoidal_3d(cs_type, context, horizontal_angular_unit_name: nil, horizontal_angular_unit_conv_factor: 0, vertical_linear_unit_name: nil, vertical_linear_unit_conv_factor: 0)
+      pointer = Api.proj_create_ellipsoidal_3D_cs(context, cs_type, horizontal_angular_unit_name, horizontal_angular_unit_conv_factor, vertical_linear_unit_name, vertical_linear_unit_conv_factor)
       Error.check_context(context)
       self.create_object(pointer, context)
     end
@@ -56,13 +56,13 @@ module Proj
     # Create a CartesiansCS 2D coordinate system
     #
     # @param context [Context] The context associated with the CoordinateSystem
-    # @param type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
+    # @param cs_type [PJ_COORDINATE_SYSTEM_TYPE] Coordinate system type
     # @param unit_name [String] Name of the unit. Default is nil.
-    # @param unit_conv_factor [Double] Unit conversion factor to SI. Default is 0.
+    # @param unit_conv_factor [Float] Unit conversion factor to SI. Default is 0.
     #
     # @return [CoordinateSystem]
-    def self.create_cartesian_2d(context, type, unit_name: nil, unit_conv_factor: 0)
-      pointer = Api.proj_create_cartesian_2D_cs(context, type, unit_name, unit_conv_factor)
+    def self.create_cartesian_2d(context, cs_type, unit_name: nil, unit_conv_factor: 0)
+      pointer = Api.proj_create_cartesian_2D_cs(context, cs_type, unit_name, unit_conv_factor)
       Error.check_context(context)
       self.create_object(pointer, context)
     end
@@ -72,7 +72,7 @@ module Proj
     # @see https://proj.org/development/reference/functions.html#c.proj_cs_get_type
     #
     # @return [PJ_COORDINATE_SYSTEM_TYPE]
-    def type
+    def cs_type
       result = Api.proj_cs_get_type(self.context, self)
       if result == :PJ_CS_TYPE_UNKNOWN
         Error.check_object(self)