ffi-gdal 1.0.0.beta16 → 1.0.0

data/Dockerfile.gdal3

@@ -0,0 +1,73 @@
+# syntax=docker/dockerfile:1
+FROM osgeo/gdal:ubuntu-small-3.5.0 as base
+
+#------------------------------------------------------------------------------
+# Dev setup 1
+#------------------------------------------------------------------------------
+FROM base as ruby_builder
+
+RUN apt-get update -yqq \
+  && apt-get upgrade -yqq \
+  && apt-get install -yqq --no-install-recommends \
+  build-essential \
+  libffi-dev \
+  libgeos-dev \
+  libproj-dev \
+  libyaml-dev \
+  && rm -rf /var/lib/apt/lists/*
+
+ENV GEM_HOME /gems
+ENV BUNDLE_SILENCE_ROOT_WARNING=1 \
+  BUNDLE_APP_CONFIG="$GEM_HOME"
+ENV PATH $GEM_HOME/bin:$PATH
+RUN mkdir -p "$GEM_HOME" && chmod 777 "$GEM_HOME"
+
+COPY --from=ruby:3.1.2 --chown=root /usr/local/bin/* /usr/local/bin/
+
+COPY --from=ruby:3.1.2 --chown=root /usr/local/lib/libruby.so.3.1.2 /usr/local/lib/
+RUN ln -s /usr/local/lib/libruby.so.3.1.2 /usr/local/lib/libruby.so
+
+COPY --from=ruby:3.1.2 --chown=root /usr/local/lib/pkgconfig/ruby-3.1.pc /usr/local/lib/pkgconfig/
+COPY --from=ruby:3.1.2 --chown=root /usr/local/lib/ruby/3.1.0 /usr/local/lib/ruby/3.1.0
+COPY --from=ruby:3.1.2 --chown=root /usr/local/lib/ruby/gems /usr/local/lib/ruby/gems
+COPY --from=ruby:3.1.2 --chown=root /usr/local/lib/ruby/site_ruby /usr/local/lib/ruby/site_ruby
+COPY --from=ruby:3.1.2 --chown=root /usr/local/lib/ruby/vendor_ruby /usr/local/lib/ruby/vendor_ruby
+
+COPY --from=ruby:3.1.2 --chown=root /usr/local/include/ruby-3.1.0 /usr/local/include/ruby-3.1.0
+
+COPY --from=ruby:3.1.2 --chown=root /usr/local/etc/gemrc /usr/local/etc/gemrc
+
+# Link the libraries after copying them over from the ruby image.
+RUN ldconfig
+
+RUN gem update --system \
+  && gem install bundler
+
+#------------------------------------------------------------------------------
+# Dev setup 1
+#------------------------------------------------------------------------------
+FROM ruby_builder as dev_builder
+
+RUN apt-get update -yqq \
+  && apt-get install -yqq --no-install-recommends \
+  git \
+  librttopo-dev \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY ./ffi-gdal.gemspec /usr/src/ffi-gdal/
+COPY ./lib/ffi/gdal/version.rb /usr/src/ffi-gdal/lib/ffi/gdal/
+COPY ./Gemfile* /usr/src/ffi-gdal/
+
+WORKDIR /usr/src/ffi-gdal
+
+# Use a docker volume for storing gems
+ENV BUNDLE_PATH /gems
+RUN bundle install
+
+#------------
+# Copy over the rest of the lib
+COPY . .
+
+CMD ["tail", "-f", "/dev/null"]
+# vim:ft=dockerfile

data/README.md

@@ -1,16 +1,13 @@
-ffi-gdal
-========
+# ffi-gdal
 
 Ruby wrapper around GDAL, using FFI, along with some helper methods.
 
-Installation
-------------
+## Installation
 
 For Ubuntu you need to install libgdal-dev via:
 
     sudo apt-get install libgdal-dev
 
-
 Add this line to your application's Gemfile:
 
     gem 'ffi-gdal'
@@ -23,12 +20,11 @@ Or install it yourself as:
 
     $ gem install ffi-gdal
 
-Usage
------
+## Usage
 
 ffi-gdal provides two interfaces, really: the direct FFI wrapper around GDAL's
 C API, and a Ruby-fied interface that uses the FFI wrapper to make use more
-like using an object-oriented library instead of a functional one.  Most likely
+like using an object-oriented library instead of a functional one. Most likely
 you'll just want to use the Ruby-fied library, but if for some reason that
 doesn't get you what you want, direct access to the FFI wrapper (which is
 really just direct access to the C API) is available.
@@ -49,17 +45,32 @@ For classes that are enabled with logging capabilities, you can turn logging on
 and off like `GDAL::RasterBand.logging_enabled = true`. If you're using ffi-gdal
 in Rails, you can `GDAL::Logger.logger = Rails.logger`.
 
-Additional Libraries
---------------------
+## Additional Libraries
 
-[ffi-gdal-extensions](https://bitbucket.org/agrian/ffi-gdal-extensions) provides
+[ffi-gdal-extensions](https://github.com/agrian-inc/ffi-gdal-extensions) provides
 additional functionality, not provided in this core, GDAL-wrapper library.
 
-Contributing
-------------
+## Contributing
 
-1. Fork it ( https://bitbucket.org/agrian/ffi-gdal/fork )
+1. Fork it ( https://github.com/agrian-inc/ffi-gdal/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### Docker
+
+There are a couple `Dockerfile`s that allow doing development/testing against
+GDAL 2.4 and 3.x.
+
+...for GDAL2:
+
+```sh
+docker-compose run gdal2 bundle exec rake spec
+```
+
+...for GDAL3:
+
+```sh
+docker-compose run gdal3 bundle exec rake spec
+```

data/Rakefile

@@ -2,14 +2,6 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new do |t|
-  t.fail_on_error = false
-  t.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
-  t.options = %w[--out tmp/checkstyle.xml]
-  t.requires = ['rubocop/formatter/checkstyle_formatter']
-end
 
 namespace :spec do
   RSpec::Core::RakeTask.new(:unit) do |t|

data/Tiltfile

@@ -0,0 +1,91 @@
+# ╭─────────────────────────────────────────────────────────╮
+# │ Enforce a minimum Tilt version, so labels are supported │
+# │ https://docs.tilt.dev/api.html#api.version_settings     │
+# ╰─────────────────────────────────────────────────────────╯
+version_settings(constraint='>=0.22.1')
+
+docker_build(
+  "ffi-gdal_gdal2",
+  context='.',
+  dockerfile='./Dockerfile.gdal2',
+  build_args={"GDAL_VERSION": "2.4.4"},
+  ignore=[
+    "tmp/*",
+    "coverage/",
+    "spec/examples.txt",
+    "Gemfile.lock"
+  ],
+  live_update=[
+    sync('.', '/usr/src/ffi-gdal'),
+    run('bundle install', trigger='ffi-gdal.gemspec'), restart_container()
+  ]
+)
+
+docker_build(
+  "ffi-gdal_gdal3",
+  context='.',
+  dockerfile='./Dockerfile.gdal3',
+  ignore=[
+    "tmp/*",
+    "coverage/",
+    "spec/examples.txt",
+    "Gemfile.lock"
+  ],
+  live_update=[
+    sync('.', '/usr/src/ffi-gdal'),
+    run('bundle install', trigger='ffi-gdal.gemspec'), restart_container()
+  ]
+)
+
+# ╓────────────╖
+# ║ UI Buttons ║
+# ╙────────────╜
+load('ext://uibutton', 'cmd_button')
+
+# ╭──────────────────────────────────────────────────────╮
+# │ Make the same buttons for gdal2 and gdal3 containers │
+# ╰──────────────────────────────────────────────────────╯
+for gdal_version in ['gdal2', 'gdal3']:
+  cmd_button(gdal_version + ":bundle install",
+             argv=['docker', 'compose', 'run', gdal_version, 'bin/bundle', 'install'],
+             resource=gdal_version,
+             icon_name='install_desktop',
+             text='bundle install'
+             )
+  cmd_button(gdal_version + ":bundle update",
+             argv=['docker', 'compose', 'run', gdal_version, 'bin/bundle', 'update'],
+             resource=gdal_version,
+             icon_name='refresh',
+             text='bundle update'
+             )
+  cmd_button(gdal_version + ":rake spec",
+             argv=['docker', 'compose', 'run', gdal_version, 'bin/rake', 'spec'],
+             resource=gdal_version,
+             icon_name='bolt',
+             text='rake spec'
+             )
+  cmd_button(gdal_version + ":rubocop",
+             argv=['docker', 'compose', 'run', gdal_version, 'bin/rubocop'],
+             resource=gdal_version,
+             icon_name='search_check',
+             text='rubocop'
+             )
+  cmd_button(gdal_version + ":rubocop fix (safe)",
+             argv=['docker', 'compose', 'run', gdal_version, 'bin/rubocop', '-a'],
+             resource=gdal_version,
+             icon_name='done_outline',
+             text='rubocop -a'
+             )
+  cmd_button(gdal_version + ":rubocop fix (all)",
+             argv=['docker', 'compose', 'run', gdal_version, 'bin/rubocop', '-A'],
+             resource=gdal_version,
+             icon_name='done_all',
+             text='rubocop -A'
+             )
+
+docker_compose("docker-compose.yml")
+
+dc_resource('gdal2')
+dc_resource('gdal3')
+
+# vim:ft=Tiltfile syntax=python

data/bin/bundle

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($PROGRAM_NAME) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV.fetch('BUNDLER_VERSION', nil)
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless 'update'.start_with?(ARGV.first || ' ') # must be running `bundle update`
+
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      bundler_version = a if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/o
+
+      bundler_version = Regexp.last_match(1)
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV.fetch('BUNDLE_GEMFILE', nil)
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path('../Gemfile', __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when 'gems.rb' then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/o
+
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version || cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem.rubygems_version < Gem::Version.new('2.7.0')
+
+    requirement += '.a' if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV['BUNDLE_GEMFILE'] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem 'bundler', bundler_requirement
+    end
+    return if gem_error.nil?
+
+    require_error = activation_error_handling do
+      require 'bundler/version'
+    end
+    if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+      return
+    end
+
+    warn <<~MSG
+      Activating bundler (#{bundler_requirement}) failed:
+      #{gem_error.message}
+
+      To install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`
+    MSG
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+load Gem.bin_path('bundler', 'bundle') if m.invoked_as_script?

data/bin/docker-clean

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# ╭───────────────────────────────────────────────────────────────────────╮
+# │Using Tilt ends up generating a bunch of local images; I thought Tilt  │
+# │is supposed to be resposible for cleaning these up, but it doesn't look│
+# │like it does?                                                          │
+# ╰───────────────────────────────────────────────────────────────────────╯
+docker images -a | grep 'gdal' | awk '{print $3}' | xargs docker rmi

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/docker-compose.yml

@@ -0,0 +1,25 @@
+---
+version: "3"
+
+services:
+  gdal2:
+    build:
+      context: .
+      args:
+        GDAL_VERSION: "2.4.4"
+      dockerfile: Dockerfile.gdal2
+    volumes:
+      - .:/usr/src/ffi-gdal
+      - gem_cache2:/gems
+
+  gdal3:
+    build:
+      context: .
+      dockerfile: Dockerfile.gdal3
+    volumes:
+      - .:/usr/src/ffi-gdal
+      - gem_cache3:/gems
+
+volumes:
+  gem_cache2:
+  gem_cache3:

data/examples/extract_and_colorize.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'pry'
 require 'ffi-gdal'
 
 GDAL::Logger.logging_enabled = true
@@ -40,18 +39,6 @@ floyd.extract_ndvi('ndvi_uint16.tif', band_order: %i[nir red green blue],
                                       remove_negatives: true,
                                       photometric: 'PALETTE').close
 
-# GNDVI as Byte
-floyd.extract_gndvi('gndvi_byte.tif', band_order: %i[nir red green blue],
-                                      data_type: :GDT_Byte,
-                                      remove_negatives: true,
-                                      photometric: 'PALETTE').close
-
-# GNDVI as UInt16
-floyd.extract_gndvi('gndvi_uint16.tif', band_order: %i[nir red green blue],
-                                        data_type: :GDT_UInt16,
-                                        remove_negatives: true,
-                                        photometric: 'PALETTE').close
-
 #---
 # Colorize after extraction...
 #---

data/examples/geometries.rb

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'pry'
 require 'ffi-gdal'
+require 'ogr'
 
-data_source = OGR::DataSource.open('spec/support/shapefiles/states_21basic/states.shp', 'r')
+_data_source = OGR::DataSource.open('spec/support/shapefiles/states_21basic/states.shp', 'r')
 
 point_wkt = 'POINT (1 2)'
-point = OGR::Geometry.create_from_wkt(point_wkt)
-other_point_wkt = 'POINT (1 2)'
-other_point = OGR::Geometry.create_from_wkt(point_wkt)
+_point = OGR::Geometry.create_from_wkt(point_wkt)
+_other_point_wkt = 'POINT (1 2)'
+_other_point = OGR::Geometry.create_from_wkt(point_wkt)
 
 line_string_wkt = 'LINESTRING (1 2, 10 30, 40 40, 1 2)'
-line_string = OGR::Geometry.create_from_wkt(line_string_wkt)
+_line_string = OGR::Geometry.create_from_wkt(line_string_wkt)
 other_line_string_wkt = 'LINESTRING (10 10, 0 30, 40 10)'
-other_line_string = OGR::Geometry.create_from_wkt(other_line_string_wkt)
+_other_line_string = OGR::Geometry.create_from_wkt(other_line_string_wkt)
 
 polygon_wkt = 'POLYGON ((0 0,4 0,4 4,0 4,0 0), (1 1, 2 1, 2 2, 1 1))'
-polygon = OGR::Geometry.create_from_wkt(polygon_wkt)
+_polygon = OGR::Geometry.create_from_wkt(polygon_wkt)
 other_polygon_wkt = 'POLYGON ((1 1,5 1,5 5,1 5,1 1), (10 10, 20 10, 20 20, 10 10))'
-other_polygon = OGR::Geometry.create_from_wkt(other_polygon_wkt)
+_other_polygon = OGR::Geometry.create_from_wkt(other_polygon_wkt)
 
 multi_point_wkt = 'MULTIPOINT ((10 40), (40 30), (20 20), (30 10))'
-multi_point = OGR::Geometry.create_from_wkt(multi_point_wkt)
+_multi_point = OGR::Geometry.create_from_wkt(multi_point_wkt)
 
 multi_line_string_wkt = 'MULTILINESTRING ((10 10, 20 20, 10 40), (40 40, 30 30, 40 20, 30 10))'
-multi_line_string = OGR::Geometry.create_from_wkt(multi_line_string_wkt)
+_multi_line_string = OGR::Geometry.create_from_wkt(multi_line_string_wkt)
 
 multi_polygon_wkt = <<-WKT
   MULTIPOLYGON (((-120.03296317083633 44.226828996384285, -120.03199741570855 44.230616638863914,
@@ -93,7 +93,7 @@ multi_polygon_wkt = <<-WKT
   -120.0331825583669 44.22634017780693, -120.03296317083633 44.226828996384285)))
 WKT
 
-multi_polygon = OGR::Geometry.create_from_wkt(multi_polygon_wkt)
+_multi_polygon = OGR::Geometry.create_from_wkt(multi_polygon_wkt)
 
 # point_wkt = 'POINT (1 2)'
 # point =  OGR::Geometry.create_from_wkt(point_wkt)
@@ -112,5 +112,5 @@ multi_polygon = OGR::Geometry.create_from_wkt(multi_polygon_wkt)
 #
 
 geometry = geometry.clone
-ls = geometry.to_line_string
-mls = geometry.to_multi_line_string
+_ls = geometry.to_line_string
+_mls = geometry.to_multi_line_string

data/examples/ogr_layer_to_layer.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'pry'
 require 'ffi-gdal'
 
-include GDAL::Logger
+include GDAL::Logger # rubocop:disable Style/MixinUsage
 GDAL::Logger.logging_enabled = true
 
 # http://pcjericks.github.io/py-gdalogr-cookbook/vector_layers.html#create-a-new-layer-from-the-extent-of-an-existing-layer
@@ -14,7 +13,6 @@ data_source = OGR::DataSource.open('../spec/support/shapefiles/states_21basic/st
 layer = data_source.layer(0)
 extent = layer.extent
 
-# extent = geometry.envelope.world_to_pixels(floyd.geo_transform)
 # x_min = extent[:x_origin]
 # x_max = extent[:x_max]
 # y_min = extent[:y_origin]

data/examples/raster_erasing.rb

@@ -5,6 +5,7 @@ require 'thor'
 require 'fileutils'
 require 'gdal/dataset'
 require 'gdal/raster_band'
+require 'gdal/raster_band/algorithm_extensions'
 
 GDAL::Logger.logging_enabled = true
 

data/examples/remove_small_polygons.rb

@@ -11,7 +11,7 @@ GDAL::Logger.logging_enabled = true
 module Examples
   class RemoveSmallPolygons < ::Thor
     desc 'filter SOURCE_PATH DEST_PATH SIZE',
-      'Removes polygons from SOURCE that are under SIZE'
+         'Removes polygons from SOURCE that are under SIZE'
     option :band_number, type: :numeric, default: 1
     def filter(source_path, dest_path, size)
       puts "Copying source '#{source_path}' to '#{dest_path}'..."