geodistance 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in geodistance.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,3 @@
+Please go to Wiki for help
+
+Any questions? E-mail denniss@cal.berkeley.edu

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/geodistance.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "geodistance/version"
+
+Gem::Specification.new do |s|
+  s.name        = "geodistance"
+  s.version     = Geodistance::VERSION
+  s.authors     = ["Dennis Suratna"]
+  s.email       = ["denniss@cal.berkeley.edu"]
+  s.homepage    = ""
+  s.summary     = %q{These are helper methods for doing any geolocation operation}
+  s.description = %q{Helper methods for calculating geolocation distance based on longitude and latitude. It will also have other methods that I feel are tedious and boring to re-write}
+
+  s.rubyforge_project = "geodistance"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/lib/geodistance.rb

@@ -0,0 +1,82 @@
+require "geodistance/version"
+
+module Geodistance
+  UNITS_OF_DISTANCE = [:mile, :kilometer]
+  EARTH_RADIUS_IN_MILE = 3959
+  EARTH_RADIUS_IN_KILOMETER = 6371
+
+  def haversine_distance(lon, lat)
+    distance_in_unit(haversine(lon, lat))
+  end
+
+  def distance(lon, lat)
+    distance_in_unit(spherical_law_of_cosines(lon, lat))
+  end
+
+  def distance_in_unit(delta_sigma_hat)
+    case __unit
+      when :mile
+        EARTH_RADIUS_IN_MILE * delta_sigma_hat
+      else
+        EARTH_RADIUS_IN_KILOMETER * delta_sigma_hat
+    end
+  end
+
+  def haversine(lon, lat)
+    phi_s = to_rad __latitude
+    lambda_s = to_rad __longitude
+    phi_f = to_rad lat
+    lambda_f = to_rad lon
+    delta_lambda = (lambda_f - lambda_s).abs
+    delta_phi = (phi_f - phi_s).abs
+
+    a = Math.sin(delta_phi/2)**2
+    b = Math.cos(phi_s) * Math.cos(phi_f) * Math.sin(delta_lambda/2)**2
+    2 * Math.asin(Math.sqrt(a + b)) #delta sigma hat
+  end
+
+  def spherical_law_of_cosines(lon, lat)
+    phi_s = to_rad __latitude
+    lambda_s = to_rad __longitude
+    phi_f = to_rad lat
+    lambda_f = to_rad lon
+    delta_lambda = (lambda_f - lambda_s).abs
+
+    Math.acos(Math.sin(phi_s) * Math.sin(phi_f) + Math.cos(phi_s) * Math.cos(phi_f) * Math.cos(delta_lambda))
+  end
+
+  def __longitude
+    self.instance_variable_get("@#{self.class.instance_variable_get(:@longitude_attr)}".to_sym)
+  end
+
+  def __latitude
+    self.instance_variable_get("@#{self.class.instance_variable_get(:@latitude_attr)}".to_sym)
+  end
+
+  def __unit
+    self.class.instance_variable_get(:@unit_of_distance)
+  end
+
+  module ClassMethods
+    def longitude_attr(name)
+      @longitude_attr = name
+    end
+
+    def latitude_attr(name)
+      @latitude_attr = name
+    end
+
+    def unit_of_distance(name)
+      raise "Unrecognize unit of distance #{name}. Use one of these: #{UNITS_OF_DISTANCE} " unless UNITS_OF_DISTANCE.include? name.to_sym
+      @unit_of_distance = name
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def to_rad(angle)
+    angle/180 * Math::PI
+  end
+end

data/lib/geodistance/version.rb

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

data/spec/geodistance_spec.rb

@@ -0,0 +1,129 @@
+require File.expand_path('../../lib/geodistance.rb', __FILE__)
+
+
+describe Geodistance do
+  describe ".longitude_attr" do
+    it "should set the attribute to get the longitude" do
+      class TestClass
+        include Geodistance
+        longitude_attr :lon
+      end
+      TestClass.instance_variable_get(:@longitude_attr).should == :lon
+    end
+  end
+
+  describe ".latitude_attr" do
+    it "should set the attribute to get the latitude" do
+      class TestClass
+        include Geodistance
+        latitude_attr :lat
+      end
+      TestClass.instance_variable_get(:@latitude_attr).should == :lat
+    end
+  end
+
+  describe ".unit_of_distance" do
+    context "with invalid unit of distance" do
+      it "raises an error" do
+        lambda { Class.new do
+          include Geodistance
+          unit_of_distance :rofl
+        end }.should raise_error
+      end
+    end
+
+    context "with valid unit of distance" do
+      it "sets the instance variable with the right unit" do
+        class TestClass
+          include Geodistance
+          unit_of_distance :mile
+        end
+        TestClass.instance_variable_get(:@unit_of_distance).should == :mile
+      end
+    end
+  end
+
+  describe "longitude and latitude and unit" do
+    before do
+      class DummyClass
+        include Geodistance
+        latitude_attr :lat
+        longitude_attr :lon
+        unit_of_distance :mile
+
+        def initialize(lon, lat)
+          @lon = lon
+          @lat = lat
+        end
+      end
+
+      @dummy = DummyClass.new(30, 20)
+    end
+
+    it "longitude returns the longitude" do
+      @dummy.__longitude.should == 30
+    end
+
+    it "latitude returns the latitude" do
+      @dummy.__latitude.should == 20
+    end
+
+    it "unit returns unit of distance" do
+      @dummy.__unit.should == :mile
+    end
+  end
+
+  describe "haversine_distance" do
+    before do
+      class DummyClass
+        include Geodistance
+        latitude_attr :lat
+        longitude_attr :lon
+        unit_of_distance :kilometer
+
+        def initialize(lon, lat)
+          @lon = lon
+          @lat = lat
+        end
+      end
+      lon_s = -22.534 #22 32 2 W
+      lat_s = 40.512 #40 30 43 N
+
+      @dummy = DummyClass.new(lon_s, lat_s)
+
+      @lon_f = 53.456 #53 27 22 E
+      @lat_f = 62.123 #62 7 23 N
+    end
+
+    it "gives right distance" do
+      @dummy.haversine_distance(@lon_f, @lat_f).should be_within(1).of(5413)
+    end
+  end
+
+  describe "distance" do
+    before do
+      class DummyClass
+        include Geodistance
+        latitude_attr :lat
+        longitude_attr :lon
+        unit_of_distance :kilometer
+
+        def initialize(lon, lat)
+          @lon = lon
+          @lat = lat
+        end
+      end
+      lon_s = -86.67
+      lat_s = 36.12
+
+      @dummy = DummyClass.new(lon_s, lat_s)
+
+      @lon_f = -118.40
+      @lat_f = 33.94
+    end
+
+    it "gives right distance" do
+      @dummy.distance(@lon_f, @lat_f).should be_within(1).of(2887)
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: geodistance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dennis Suratna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-31 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152693500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152693500
+description: Helper methods for calculating geolocation distance based on longitude
+  and latitude. It will also have other methods that I feel are tedious and boring
+  to re-write
+email:
+- denniss@cal.berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- geodistance.gemspec
+- lib/geodistance.rb
+- lib/geodistance/version.rb
+- spec/geodistance_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: geodistance
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: These are helper methods for doing any geolocation operation
+test_files:
+- spec/geodistance_spec.rb