proj4rb 4.1.0 → 5.0.0

data/test/file_api_example.rb

@@ -0,0 +1,58 @@
+module Proj
+  # The FileApiExample class is a simple file api implementation that delegates
+  # to Ruby's built-in File operations.
+  class FileApiExample
+    include FileApiCallbacks
+
+    def initialize(context)
+      install_callbacks(context)
+    end
+
+    def open(path, access_mode)
+      case access_mode
+      when :PROJ_OPEN_ACCESS_READ_ONLY
+        File.open(path, mode: 'rb') if File.exist?(path)
+      when :PROJ_OPEN_ACCESS_READ_UPDATE
+        File.exist?(path) ? File.open(path, mode: 'r+b') : File.open(path, mode: 'w+b')
+      when :PROJ_OPEN_ACCESS_CREATE
+        File.open(path, mode: 'w+b')
+      end
+    end
+
+    def read(file, size_bytes)
+      file.read(size_bytes)
+    end
+
+    def write(file, data)
+      file.write(data)
+    end
+
+    def seek(file, offset, whence)
+      file.seek(offset, whence)
+    end
+
+    def tell(file)
+      file.tell
+    end
+
+    def close(file)
+      file.close
+    end
+
+    def exists(path)
+      File.exist?(path)
+    end
+
+    def mkdir(path)
+      Dir.mkdir(path)
+    end
+
+    def unlink(path)
+      File.unlink(path) if File.exist?(path)
+    end
+
+    def rename(original_path, new_path)
+      File.rename(original_path, new_path)
+    end
+  end
+end

data/test/file_api_test.rb

@@ -1,66 +1,74 @@
-# encoding: UTF-8
-
-require_relative './abstract_test'
-
-class FileApiTest < AbstractTest
-  def setup
-    super
-    # Make sure FileAPI callbacks are not GCed
-    #GC.stress = true
-  end
-
-  def teardown
-    super
-    GC.stress = false
-  end
-
-
-  def test_read
-    skip "This test causes a segfault due to the way Proj cleans up on shutdown"
-    context = Proj::Context.new
-    # Network needs to be on for grid delete to work
-    context.network_enabled = true
-
-    # Create a grid
-    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
-    grid.delete
-
-    grid.download
-    assert(grid.downloaded?)
-    context.network_enabled = false
-
-    # Hook up a custom FileApiImpl
-    context.set_file_api(Proj::FileApiImpl)
-
-    conversion = Proj::Conversion.new(<<~EOS, context)
-          +proj=pipeline
-          +step +proj=unitconvert +xy_in=deg +xy_out=rad
-          +step +proj=vgridshift +grids=dk_sdfe_dvr90.tif +multiplier=1
-          +step +proj=unitconvert +xy_in=rad +xy_out=deg
-        EOS
-
-    coord = Proj::Coordinate.new(lon: 12, lat: 56, z: 0)
-    new_coord = conversion.forward(coord)
-    assert_in_delta(12, new_coord.lon)
-    assert_in_delta(56, new_coord.lat)
-    assert_in_delta(36.5909996032715, new_coord.z, 1e-10)
-
-    context.destroy
-  end
-
-  def test_write
-    skip "This test causes a segfault due to the way Proj cleans up on shutdown"
-
-    context = Proj::Context.new
-    context.network_enabled = true
-
-    # Create a grid
-    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
-    grid.delete
-
-    context.set_file_api(Proj::FileApiImpl)
-    grid.download
-
-    assert(grid.downloaded?)
-  end
-end
+# encoding: UTF-8
+
+require_relative './abstract_test'
+require_relative './file_api_example'
+
+class FileApiTest < AbstractTest
+  def setup
+    super
+    # Make sure FileAPI callbacks are not GCed
+    GC.stress = true
+  end
+
+  def teardown
+    # Clean up downloaded grid so other tests aren't affected
+    context = Proj::Context.new
+    context.network_enabled = true
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+    grid.delete
+    super
+    GC.stress = false
+  end
+
+
+  def test_read
+    context = Proj::Context.new
+    # Network needs to be on for grid delete to work
+    context.network_enabled = true
+
+    # Create a grid
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+    grid.delete
+
+    grid.download
+    assert(grid.downloaded?)
+    context.network_enabled = false
+
+    # Hook up a custom FileApiImpl
+    context.set_file_api(Proj::FileApiExample)
+
+    conversion = Proj::Conversion.new(<<~EOS, context)
+          +proj=pipeline
+          +step +proj=unitconvert +xy_in=deg +xy_out=rad
+          +step +proj=vgridshift +grids=dk_sdfe_dvr90.tif +multiplier=1
+          +step +proj=unitconvert +xy_in=rad +xy_out=deg
+        EOS
+
+    coord = Proj::Coordinate.new(lon: 12, lat: 56, z: 0)
+    new_coord = conversion.forward(coord)
+    assert_in_delta(12, new_coord.lon)
+    assert_in_delta(56, new_coord.lat)
+    assert_in_delta(36.5909996032715, new_coord.z, 1e-10)
+
+    # Release the grid file handle so teardown can delete the file (Windows)
+    conversion.destroy
+    context.destroy
+  end
+
+  def test_write
+    context = Proj::Context.new
+    context.network_enabled = true
+
+    # Create a grid
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+    grid.delete
+
+    context.set_file_api(Proj::FileApiExample)
+    grid.download
+
+    assert(grid.downloaded?)
+
+    # Release the grid file handle so teardown can delete the file (Windows)
+    context.destroy
+  end
+end

data/test/grid_cache_test.rb

@@ -1,72 +1,72 @@
-# encoding: UTF-8
-
-require_relative './abstract_test'
-
-class GridCacheTest < AbstractTest
-  def download(grid)
-    begin
-      grid.download
-    ensure
-      grid.delete
-    end
-  end
-
-  def test_clear
-    context = Proj::Context.new
-    context.network_enabled = true
-    context.cache.enabled = true
-
-    cache_path = File.join(context.user_directory, "cache.db")
-    context.cache.clear
-    refute(File.exist?(cache_path))
-  end
-
-  def test_disable
-    context = Proj::Context.new
-    cache_path = File.join(context.user_directory, "cache.db")
-
-    context.network_enabled = true
-    context.cache.clear
-    context.cache.enabled = false
-    refute(File.exist?(cache_path))
-
-    database = Proj::Database.new(context)
-    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
-
-    # Download the file to create the cache
-    download(grid)
-
-    refute(File.exist?(cache_path))
-  end
-
-  def test_set_path
-    context = Proj::Context.new
-    context.network_enabled = true
-    database = Proj::Database.new(context)
-    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
-
-    # Custom path
-    cache_path = context.cache.path = File.join(Dir.tmpdir, "proj_cache_test.db")
-    refute(File.exist?(cache_path))
-
-    # Download the file to create the cache
-    download(grid)
-
-    assert(File.exist?(cache_path))
-
-    context.cache.clear
-    refute(File.exist?(cache_path))
-  end
-
-  def test_ttl
-    context = Proj::Context.new
-    context.cache.ttl = 60
-    assert(true)
-  end
-
-  def test_max_size
-    context = Proj::Context.new
-    context.cache.max_size = 100
-    assert(true)
-  end
-end
+# encoding: UTF-8
+
+require_relative './abstract_test'
+
+class GridCacheTest < AbstractTest
+  def download(grid)
+    begin
+      grid.download
+    ensure
+      grid.delete
+    end
+  end
+
+  def test_clear
+    context = Proj::Context.new
+    context.network_enabled = true
+    context.cache.enabled = true
+
+    cache_path = File.join(context.user_directory, "cache.db")
+    context.cache.clear
+    refute(File.exist?(cache_path))
+  end
+
+  def test_disable
+    context = Proj::Context.new
+    cache_path = File.join(context.user_directory, "cache.db")
+
+    context.network_enabled = true
+    context.cache.clear
+    context.cache.enabled = false
+    refute(File.exist?(cache_path))
+
+    database = Proj::Database.new(context)
+    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
+
+    # Download the file to create the cache
+    download(grid)
+
+    refute(File.exist?(cache_path))
+  end
+
+  def test_set_path
+    context = Proj::Context.new
+    context.network_enabled = true
+    database = Proj::Database.new(context)
+    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
+
+    # Custom path
+    cache_path = context.cache.path = File.join(Dir.tmpdir, "proj_cache_test.db")
+    refute(File.exist?(cache_path))
+
+    # Download the file to create the cache
+    download(grid)
+
+    assert(File.exist?(cache_path))
+
+    context.cache.clear
+    refute(File.exist?(cache_path))
+  end
+
+  def test_ttl
+    context = Proj::Context.new
+    context.cache.ttl = 60
+    assert(true)
+  end
+
+  def test_max_size
+    context = Proj::Context.new
+    context.cache.max_size = 100
+    assert(true)
+  end
+end

data/test/grid_test.rb

@@ -1,141 +1,126 @@
-# encoding: UTF-8
-
-require_relative './abstract_test'
-
-class GridTest < AbstractTest
-  def test_grid
-    database = Proj::Database.new(Proj::Context.current)
-    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
-
-    assert_equal("au_icsm_GDA94_GDA2020_conformal.tif", grid.name)
-    assert(grid.full_name.empty?)
-    assert(grid.package_name.empty?)
-    assert_equal("https://cdn.proj.org/au_icsm_GDA94_GDA2020_conformal.tif", grid.url.to_s)
-    assert(grid.downloadable?)
-    assert(grid.open_license?)
-    refute(grid.available?)
-  end
-
-  def test_grid_proj6_name
-    database = Proj::Database.new(Proj::Context.current)
-    grid = database.grid("GDA94_GDA2020_conformal.gsb")
-
-    assert_equal("GDA94_GDA2020_conformal.gsb", grid.name)
-    assert(grid.full_name.empty?)
-    assert(grid.package_name.empty?)
-    assert_instance_of(URI::HTTPS, grid.url)
-    assert_equal("https://cdn.proj.org/au_icsm_GDA94_GDA2020_conformal.tif", grid.url.to_s)
-    assert(grid.downloadable?)
-    assert(grid.open_license?)
-    refute(grid.available?)
-  end
-
-  def test_downloaded_network_disabled
-    context = Proj::Context.new
-    context.network_enabled = false
-
-    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
-    refute(grid.downloaded?)
-  end
-
-  def test_downloaded_network_enabled
-    context = Proj::Context.new
-    context.network_enabled = true
-
-    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
-    refute(grid.downloaded?)
-  end
-
-  def test_download
-    context = Proj::Context.new
-    context.network_enabled = true
-
-    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
-    refute(grid.path)
-
-    begin
-      grid.download
-      assert(grid.path)
-      assert(grid.downloaded?)
-    ensure
-      grid.delete
-    end
-  end
-
-  def test_download_with_progress
-    context = Proj::Context.new
-    context.network_enabled = true
-
-    database = Proj::Database.new(context)
-    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
-
-    progress_values = Array.new
-    begin
-      downloaded = grid.download do |progress|
-        progress_values << progress
-      end
-      assert(downloaded)
-    ensure
-      grid.delete
-    end
-
-    assert(progress_values.count > 1)
-    assert(progress_values.include?(1.0))
-  end
-
-  def test_download_with_progress_cancel
-    context = Proj::Context.new
-    context.network_enabled = true
-
-    database = Proj::Database.new(context)
-    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
-
-    progress_values = Array.new
-    begin
-      downloaded = grid.download do |progress|
-        progress_values << progress
-        # Cancel download
-        false
-      end
-      refute(downloaded)
-    ensure
-      grid.delete
-    end
-
-    assert_equal(1, progress_values.count)
-    refute(progress_values.include?(1.0))
-  end
-
-  def test_grid_info
-    context = Proj::Context.new
-    context.network_enabled = true
-    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
-
-    begin
-      assert(grid.info.filename.empty?)
-      #assert_equal("dk_sdfe_dvr90.tif", grid.info.gridname)
-      # assert_equal("gtiff", grid.info.format)
-      # assert_in_delta(0, grid.info.lower_left[:lam])
-      # assert_in_delta(0, grid.info.lower_left[:phi])
-      # assert_in_delta(0, grid.info.upper_right[:lam])
-      # assert_in_delta(0, grid.info.upper_right[:phi])
-      # assert_in_delta(0, grid.info.size_lon)
-      # assert_in_delta(0, grid.info.size_lat)
-      # assert_in_delta(0, grid.info.cell_size_lon)
-      # assert_in_delta(0, grid.info.cell_size_lat)
-    ensure
-      grid.delete
-    end
-  end
-
-  def test_grid_invalid
-    skip "This test sometimes raises an error and sometimes doesn't."
-    database = Proj::Database.new(Proj::Context.current)
-    grid = database.grid("invalid")
-
-    error = assert_raises(Proj::Error) do
-      grid = database.grid("invalid")
-    end
-    assert_equal("Unknown error (code 4096)", error.to_s)
-  end
-end
+# encoding: UTF-8
+
+require_relative './abstract_test'
+
+class GridTest < AbstractTest
+  def test_grid
+    database = Proj::Database.new(Proj::Context.current)
+    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
+
+    assert_equal("au_icsm_GDA94_GDA2020_conformal.tif", grid.name)
+    assert(grid.package_name.empty?)
+    assert_equal("https://cdn.proj.org/au_icsm_GDA94_GDA2020_conformal.tif", grid.url.to_s)
+    assert(grid.downloadable?)
+    assert(grid.open_license?)
+  end
+
+  def test_grid_proj6_name
+    database = Proj::Database.new(Proj::Context.current)
+    grid = database.grid("GDA94_GDA2020_conformal.gsb")
+
+    assert_equal("GDA94_GDA2020_conformal.gsb", grid.name)
+    assert(grid.package_name.empty?)
+    assert_instance_of(URI::HTTPS, grid.url)
+    assert_equal("https://cdn.proj.org/au_icsm_GDA94_GDA2020_conformal.tif", grid.url.to_s)
+    assert(grid.downloadable?)
+    assert(grid.open_license?)
+  end
+
+  def test_downloaded_network_disabled
+    context = Proj::Context.new
+    context.network_enabled = false
+
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+    refute(grid.downloaded?)
+  end
+
+  def test_downloaded_network_enabled
+    context = Proj::Context.new
+    context.network_enabled = true
+
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+    refute(grid.downloaded?)
+  end
+
+  def test_download
+    context = Proj::Context.new
+    context.network_enabled = true
+
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+    refute(grid.path)
+
+    begin
+      grid.download
+      assert(grid.path)
+      assert(grid.downloaded?)
+    ensure
+      grid.delete
+    end
+  end
+
+  def test_download_with_progress
+    context = Proj::Context.new
+    context.network_enabled = true
+
+    database = Proj::Database.new(context)
+    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
+
+    progress_values = Array.new
+    begin
+      downloaded = grid.download do |progress|
+        progress_values << progress
+      end
+      assert(downloaded)
+    ensure
+      grid.delete
+    end
+
+    assert(progress_values.count > 1)
+    assert(progress_values.include?(1.0))
+  end
+
+  def test_download_with_progress_cancel
+    context = Proj::Context.new
+    context.network_enabled = true
+
+    database = Proj::Database.new(context)
+    grid = database.grid("au_icsm_GDA94_GDA2020_conformal.tif")
+
+    progress_values = Array.new
+    begin
+      downloaded = grid.download do |progress|
+        progress_values << progress
+        # Cancel download
+        false
+      end
+      refute(downloaded)
+    ensure
+      grid.delete
+    end
+
+    assert_equal(1, progress_values.count)
+    refute(progress_values.include?(1.0))
+  end
+
+  def test_grid_info
+    context = Proj::Context.new
+    context.network_enabled = true
+    grid = Proj::Grid.new("dk_sdfe_dvr90.tif", context)
+
+    begin
+      assert(grid.info.filename.empty?)
+      #assert_equal("dk_sdfe_dvr90.tif", grid.info.gridname)
+      # assert_equal("gtiff", grid.info.format)
+      # assert_in_delta(0, grid.info.lower_left[:lam])
+      # assert_in_delta(0, grid.info.lower_left[:phi])
+      # assert_in_delta(0, grid.info.upper_right[:lam])
+      # assert_in_delta(0, grid.info.upper_right[:phi])
+      # assert_in_delta(0, grid.info.size_lon)
+      # assert_in_delta(0, grid.info.size_lat)
+      # assert_in_delta(0, grid.info.cell_size_lon)
+      # assert_in_delta(0, grid.info.cell_size_lat)
+    ensure
+      grid.delete
+    end
+  end
+end

data/test/network_api_example.rb

@@ -0,0 +1,48 @@
+require 'net/http'
+
+module Proj
+  # The NetworkApiExample class is a simple network api implementation that
+  # delegates to Ruby's built-in Net::HTTP.
+  class NetworkApiExample
+    include NetworkApiCallbacks
+
+    def initialize(context)
+      install_callbacks(context)
+    end
+
+    def open(uri, offset, size_to_read)
+      http = Net::HTTP.new(uri.host, uri.port)
+      if uri.scheme == "https"
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+      http.start
+
+      data, response = read_data(http, uri, offset, size_to_read)
+      { http: http, uri: uri, response: response, data: data }
+    end
+
+    def close(connection)
+      connection[:http].finish
+    end
+
+    def header_value(connection, name)
+      connection[:response][name]
+    end
+
+    def read_range(connection, offset, size_to_read)
+      data, response = read_data(connection[:http], connection[:uri], offset, size_to_read)
+      connection[:response] = response
+      data
+    end
+
+    private
+
+    def read_data(http, uri, offset, size_to_read)
+      headers = {"Range": "bytes=#{offset}-#{offset + size_to_read - 1}"}
+      request = Net::HTTP::Get.new(uri.request_uri, headers)
+      response = http.request(request)
+      [response.body.force_encoding("ASCII-8BIT"), response]
+    end
+  end
+end