Initial project layout

Author: supagroova

.gitignore

@@ -0,0 +1,4 @@
+spec/examples.txt
+tmp
+lib/h3_ruby/*.bundle
+lib/h3_ruby/*.so

.rspec

@@ -0,0 +1 @@
+--require spec_helper

.ruby-version

@@ -0,0 +1 @@
+2.4.4

Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+ruby "2.4.4" # Ideally, the same one as stuart-api.
+
+gem "rake-compiler", "~> 1.0.5"
+gem "rspec",         "~> 3.8.0"

Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    geocoder (1.5.0)
+    rake (12.3.2)
+    rake-compiler (1.0.5)
+      rake
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  geocoder (~> 1.5.0)
+  rake-compiler (~> 1.0.5)
+  rspec (~> 3.8.0)
+
+RUBY VERSION
+   ruby 2.4.4p296
+
+BUNDLED WITH
+   1.17.1

README.md

@@ -0,0 +1,5 @@
+# H3 Ruby
+
+Ruby bindings for Uber's [H3 library](https://uber.github.io/h3/).
+
+TODO: Include h3/h3api.h and add wrapper functions

Rakefile

@@ -0,0 +1,5 @@
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("h3") do |ext|
+  ext.lib_dir = "lib/h3_ruby"
+end

bin/compile

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# With --silent, compilation is silent when there is nothing to do, otherwise
+# you'll see stuff happening, and of course errors if there are any.
+bundle exec rake compile --silent

bin/console

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+if bin/compile;
+then
+    bundle exec irb -Ilib -rh3_ruby "$@"
+fi

bin/rspec

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+if bin/compile;
+then
+    bundle exec rspec "$@"
+fi

bin/run

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+if bin/compile;
+then
+    bundle exec ruby -Ilib -rh3_ruby "$@"
+fi

ext/.DS_Store

@@ -0,0 +1,2 @@
+require "mkmf"
+create_makefile "h3/h3"

ext/h3/extconf.rb

@@ -0,0 +1,16 @@
+#include <ruby.h>
+// #include <h3/h3api.h>
+
+static VALUE hello_world(VALUE mod)
+{
+  return rb_str_new2("hello world");
+}
+
+/* --- Initialization -------------------------------------------------------------------------- */
+
+/* This function has a special name and it is invoked by Ruby to initialize the extension. */
+void Init_h3()
+{
+    VALUE h3_ruby = rb_define_module("H3Ruby");
+    rb_define_singleton_method(h3_ruby, "hello_world", hello_world, 0);
+}

ext/h3/h3.c

@@ -0,0 +1,21 @@
+$: << File.expand_path("lib", __dir__)
+require "h3_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name     = "h3-ruby"
+  spec.version  = H3Ruby::VERSION
+  spec.licenses = ["Nonstandard"] # Avoids a warning when building the gem.
+  spec.summary  = "C Bindings for Uber's H3 library"
+  spec.homepage = "https://github.com/StuartApp/h3_ruby"
+  spec.author   = "Lachlan Laycock"
+  spec.email    = "l.laycock@stuart.com"
+
+  spec.extensions = %w(ext/h3/extconf.rb)
+  spec.require_paths = %w(lib)
+  spec.files = %w(
+    ext/h3/extconf.rb
+    ext/h3/h3.c
+    lib/h3_ruby.rb
+    lib/h3_ruby/version.rb
+  )
+end

ext/h3/lib/libh3.a

@@ -0,0 +1,8 @@
+require "h3_ruby/h3"
+require "h3_ruby/version"
+
+module H3Ruby
+  def self.bearing_between(from, to, options={})
+    _bearing_between(from, to, options[:method] == :spherical)
+  end
+end

h3_ruby.gemspec

@@ -0,0 +1,3 @@
+module H3Ruby
+  VERSION = "0.0.1"
+end

lib/h3_ruby.rb

@@ -0,0 +1,13 @@
+require "bigdecimal"
+
+RSpec.describe H3Ruby do
+  describe ".hello_world" do
+    subject(:hello_world) { H3Ruby.hello_world }
+
+    let(:result) { "hello world" }
+
+    it "returns the expected result" do
+      expect(hello_world).to eq(result)
+    end
+  end
+end

lib/h3_ruby/version.rb

@@ -0,0 +1,101 @@
+require "h3_ruby"
+
+require_relative "support/models"
+require_relative "support/matchers"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = "doc"
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

spec/h3_ruby_spec.rb

@@ -0,0 +1,16 @@
+require "rspec/expectations"
+
+RSpec::Matchers.define :approx do |expected|
+  delta = 1e-11
+
+  match do |actual|
+    case actual
+    when Array
+      actual.zip(expected).each do |a, e|
+        expect(a).to approx(e)
+      end
+    else
+      expect(actual).to be_within(delta).of(expected)
+    end
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,18 @@
+class Location
+  attr_reader :lat, :lon
+
+  def initialize(lat, lon)
+    @lat = lat
+    @lon = lon
+  end
+
+  def to_coordinates
+    [@lat, @lon]
+  end
+
+  def to_radians
+    to_coordinates.map do |degrees|
+      degrees*Math::PI/180.0
+    end
+  end
+end