haversine_distance_c 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 903489d9dc23644af74b57ffad89a61d7fddbdfb
+  data.tar.gz: 775349207a5278f09939ce990301dadff6816678
+SHA512:
+  metadata.gz: 7ccaa6456f64356905c42bf263a993e3346808afdadd9bba362e76dcc244c19598ce29bffb784b20a16051897f7439122c233e0d63953ae212d90f95ffc05513
+  data.tar.gz: 37c99cee94179366680d4c2c577fc2a588c38d2d187bd7d4bdbb79e270d0184e3b43c07a2e243cda2c93ce423701baf13b98d521b71954e56d004e42ad7676ea

data/.gitignore

@@ -0,0 +1,5 @@
+tmp
+.DS_Store
+.byebug_history
+*.gem
+*.bundle

data/README.md

@@ -0,0 +1,19 @@
+# Haversine distance
+
+Just a simple gem to compute Haversine Distance in C
+
+
+## Usage
+
+Add to your Gemfile:
+
+```
+gem 'haversine_c', '~> 0.0.2'
+```
+
+Then:
+
+```
+meters = HaversineDistance.m(point_a.lat,point_a.long,point_b.lat,point_b.long)
+km = HaversineDistance.km(point_a.lat,point_a.long,point_b.lat,point_b.long)
+```

data/Rakefile

@@ -0,0 +1,76 @@
+require './lib/haversine_distance/version'
+require 'fileutils'
+require 'English'
+
+task :config do
+  def version
+    HaversineDistance::VERSION
+  end
+  # e.g. 2.13.3 becomes HaversineDistance__2-13-3
+  def version_tag
+    "HaversineDistance_#{version.gsub('.','-')}"
+  end
+  # e.g. 2.13.3 becomes haversine_distance_-2.13.3.gem
+  def gem_name
+    "haversine_distance_c-#{version}.gem"
+  end
+
+  def base
+    File.expand_path('..', __FILE__)
+  end
+end
+
+desc 'abort when repo is not clean or has uncommited code'
+task :assert_clean_repo do
+  sh('git diff --exit-code')
+  abort 'Git repo not clean' unless $CHILD_STATUS.success?
+  sh('git diff-index --quiet --cached HEAD')
+  abort 'Git repo not commited' unless $CHILD_STATUS.success?
+end
+
+desc 'build gem'
+task :build => [:config] do
+  sh 'gem build -V haversine_distance_c.gemspec'
+  if $CHILD_STATUS.success?
+    FileUtils.mkdir_p(File.join(base, 'pkg'))
+    FileUtils.mv(File.join(base, gem_name), 'pkg')
+  else
+    STDERR.puts 'Could not build gem'
+    exit $CHILD_STATUS.exitstatus
+  end
+end
+
+task :push_and_tag => [:build] do
+  sh "gem push #{File.join(base, 'pkg', gem_name)}"
+  if $CHILD_STATUS.success?
+    sh "git tag -a -m \"Version #{version}\" #{version_tag}"
+    STDOUT.puts "Tagged #{version_tag}."
+    sh 'git push'
+    sh 'git push --tags'
+  else
+    abort 'tagging aborted pushing gem failed'
+  end
+end
+
+desc 'Release'
+task :release => [:assert_clean_repo, :push_and_tag]
+
+desc 'Release and build the legacy way'
+task :legacy_release=> ['legacy:README.html', 'legacy:extconf', 'legacy:doc', 'legacy:manifest', 'release']
+
+
+require 'rake/extensiontask'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::ExtensionTask.new('haversine_distance') do |ext|
+  ext.ext_dir = 'ext/haversine_distance_c'
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+end
+
+task :test => :compile
+task :spec => :compile

data/ext/haversine_distance_c/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+extension_name = 'haversine_distance'
+
+dir_config(extension_name)
+create_makefile(extension_name)

data/ext/haversine_distance_c/haversine_distance.c

@@ -0,0 +1,46 @@
+#include "ruby.h"
+
+#define RADIAN_PER_DEGREE 0.017453292519943
+#define EARTH_RADIUS 6371
+
+// Defining a space for information and references about the module to be stored internally
+VALUE HaversineDistance = Qnil;
+
+// Prototype for the initialization method - Ruby calls this, not you
+void Init_haversine_distance();
+
+VALUE method_km(VALUE self, VALUE lat1_v, VALUE lng1_v, VALUE lat2_v, VALUE lng2_v);
+VALUE method_m(VALUE self, VALUE lat1_v, VALUE lng1_v, VALUE lat2_v, VALUE lng2_v);
+
+// The initialization method for this module
+void Init_haversine_distance() {
+  HaversineDistance = rb_define_module("HaversineDistance");
+  rb_define_singleton_method(HaversineDistance, "km", method_km, 4);
+  rb_define_singleton_method(HaversineDistance, "m", method_m, 4);
+}
+
+double compute_km(double lat1, double lng1, double lat2, double lng2) {
+  double lat1_radians = lat1 * RADIAN_PER_DEGREE;
+  double lat2_radians = lat2 * RADIAN_PER_DEGREE;
+  double distance_lat = (lat2-lat1) * RADIAN_PER_DEGREE;
+  double distance_lng = (lng2-lng1) * RADIAN_PER_DEGREE;
+  double a = pow(sin(distance_lat/2.0), 2.0) + cos(lat1_radians) * cos(lat2_radians) * pow(sin(distance_lng/2.0), 2.0);
+  double c = 2.0 * atan2(sqrt(a), sqrt(1.0-a));
+  return EARTH_RADIUS * c;
+}
+
+VALUE method_km(VALUE self, VALUE lat1_v, VALUE lng1_v, VALUE lat2_v, VALUE lng2_v) {
+  double lat1 = NUM2DBL(lat1_v);
+  double lng1 = NUM2DBL(lng1_v);
+  double lat2 = NUM2DBL(lat2_v);
+  double lng2 = NUM2DBL(lng2_v);
+  return DBL2NUM(compute_km(lat1, lng1, lat2, lng2));
+}
+
+VALUE method_m(VALUE self, VALUE lat1_v, VALUE lng1_v, VALUE lat2_v, VALUE lng2_v) {
+  double lat1 = NUM2DBL(lat1_v);
+  double lng1 = NUM2DBL(lng1_v);
+  double lat2 = NUM2DBL(lat2_v);
+  double lng2 = NUM2DBL(lng2_v);
+  return DBL2NUM(compute_km(lat1, lng1, lat2, lng2) * 1000);
+}

data/haversine_distance_c.gemspec

@@ -0,0 +1,28 @@
+require './lib/haversine_distance/version'
+
+
+Gem::Specification.new do |s|
+  s.name = 'haversine_distance_c'
+  s.version = HaversineDistance::VERSION
+  s.date = Date.today.to_s
+  s.summary = 'C calculation of the Haversine Distance'
+  s.description = 'Calculates the distance between two points using the haversine distance'
+  s.authors = ['Ivan Pirlik']
+  s.email = 'ivan.pirlik@deliveroo.co.uk'
+  s.license = 'MIT'
+
+  tracked_files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  file_exclusion_regex = %r{(\Alib/rvg/to_c.rb)}
+  files         = tracked_files.reject{|file| file[file_exclusion_regex] }
+  test_files    = files.grep(%r{^(test|spec|features)/})
+
+  s.files                       = files
+  s.test_files                  = test_files
+  s.require_paths << 'ext'
+
+  s.extensions = %w{ext/haversine_distance_c/extconf.rb}
+  s.has_rdoc = false
+
+  s.add_development_dependency 'rake-compiler'
+  s.add_development_dependency 'rspec', '~> 3.2.0'
+end

data/lib/haversine_distance/version.rb

@@ -0,0 +1,3 @@
+module HaversineDistance
+  VERSION = '0.0.2'
+end

data/spec/haversine_distance/haversine_distance_spec.rb

@@ -0,0 +1,29 @@
+require 'haversine_distance'
+require 'byebug'
+
+describe HaversineDistance do
+  describe '.km' do
+    let(:point1) { [ -0.141833514017446, 51.4956699956174 ] }
+    let(:point2) { [ -0.171055, 51.485144 ] }
+
+    context 'when lat-long for both points are same' do
+      it do
+       expect(described_class.km(point1[0], point1[1], point1[0], point1[1])).to eql(0.0)
+     end
+    end
+
+    context 'when lat-long for both points are not same' do
+      it { expect(described_class.km(point1[0], point1[1], point2[0], point2[1]).round(2)).to eql(3.45) }
+    end
+  end
+
+  describe '.m' do
+    let(:point1) { [ -0.141833514017446, 51.4956699956174 ] }
+    let(:point2) { [ -0.171055, 51.485144 ] }
+    let(:precision) { 2 }
+
+    context 'when lat-long for both points are not same' do
+      it { expect(described_class.m(point1[0], point1[1], point2[0], point2[1]).round(2)).to eql(3453.66) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'haversine_distance'
+
+root_dir = File.expand_path('../..', __FILE__)

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: haversine_distance_c
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ivan Pirlik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Calculates the distance between two points using the haversine distance
+email: ivan.pirlik@deliveroo.co.uk
+executables: []
+extensions:
+- ext/haversine_distance_c/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- ext/haversine_distance_c/extconf.rb
+- ext/haversine_distance_c/haversine_distance.c
+- haversine_distance_c.gemspec
+- lib/haversine_distance/version.rb
+- spec/haversine_distance/haversine_distance_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: C calculation of the Haversine Distance
+test_files:
+- spec/haversine_distance/haversine_distance_spec.rb
+- spec/spec_helper.rb