geo-distance 0.1.2 → 0.2.0

data/lib/geo-distance/scale.rb

@@ -0,0 +1,18 @@
+class GeoDistance
+  module Scale
+    def * arg
+      multiply arg
+    end
+
+    def / arg
+      multiply(1.0/arg)
+      self
+    end
+
+    def multiply arg
+      check_numeric! arg
+      self.distance *= arg
+      self
+    end
+  end
+end

data/spec/geo_distance/class_methods_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+GeoPoint.coord_mode = :lng_lat
+
+describe "GeoDistance class methods" do
+  describe '#earth_radius' do
+    it 'should return in kms' do
+      GeoDistance.earth_radius(:kms).should be_between(6371, 6380)
+    end
+
+    it 'should return in meters' do
+      GeoDistance.earth_radius(:meters).should be_between(6371000, 6380000)
+    end
+  end
+
+  describe '#radians_ratio unit' do
+    it 'should return in kms' do
+      puts GeoDistance.radians_ratio unit(:kms) #.should be_between(6371, 6380)
+    end
+
+    it 'should return in meters' do
+      puts GeoDistance.radians_ratio unit(:meters) #.should be_between(6371000, 6380000)
+    end
+  end
+  
+  describe '#default_algorithm' do
+    let(:from)  { [-104.88544, 39.06546].geo_point }
+    let(:to)    { [-104.80, 39.06546].geo_point }
+
+    it "should NOT set it to :haver" do
+      lambda { GeoDistance.default_algorithm = :haver}.should raise_error
+    end
+
+    it "should set it to :haversine" do
+      GeoDistance.default_algorithm = :haversine
+
+      dist = GeoDistance.geo_distance(from, to)
+
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+
+      dist.feet.should == 24193.0
+      dist.to_feet.should == 24193.0
+      dist.kms.to_s.should match(/7\.376*/)
+    end
+
+    it "should set it to :flat" do
+      GeoDistance.default_algorithm = :flat
+
+      dist = GeoDistance.geo_distance(from, to)
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+      dist.feet.should be_between(23500, 25000)
+    end
+
+    it "should set it to :sphere" do
+      GeoDistance.default_algorithm = :sphere
+
+      dist = GeoDistance.geo_distance(from, to)
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+      dist.feet.should be_between(23500, 25000)
+    end
+
+    it "should set it to :vincenty" do
+      GeoDistance.default_algorithm = :vincenty
+
+      dist = GeoDistance.geo_distance(from, to)
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+      dist.feet.should be_between(23500, 25000)
+    end
+  end
+end

data/spec/geo_distance/core_ext_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe "GeoDistance core extensions" do
+  
+  describe 'unit_to(other)' do  
+    describe '#radians_to' do  
+      it 'should convert radians to kms' do
+        5.radians_to(:kms).should be_within(2).of 556
+      end
+    end
+
+    describe '#kms_to' do  
+      it 'should convert radians to kms' do
+        5.kms_to(:feet).should be_within(1000).of 16000
+      end
+    end
+  end
+
+  describe '#radians' do  
+    it 'should convert Fixnum to GeoDistance' do
+      5.radians.should be_a GeoDistance
+      5.radians.distance.should == 5
+      5.radians.unit.should == :radians
+      5.radians.as_kms.should be_within(2).of 556
+    end
+  end
+
+  describe '#kms' do  
+    it 'should convert Fixnum to GeoDistance' do
+      5.kms.should be_a GeoDistance
+      5.kms.distance.should == 5
+      5.kms.unit.should == :kms
+    end
+  end
+
+  describe '#kms' do  
+    it 'should convert Float to GeoDistance' do
+      5.2.kms.should be_a GeoDistance
+      5.2.kms.distance.should == 5.2
+      5.2.kms.unit.should == :kms
+    end
+  end
+
+  describe '#meters' do  
+    it 'should convert Float to GeoDistance' do
+      5.2.meters.should be_a GeoDistance
+      5.2.meters.distance.should == 5.2
+      5.2.meters.unit.should == :meters
+    end
+  end
+
+  describe '#meter' do  
+    it 'should convert Float to GeoDistance' do
+      2.meter.should be_a GeoDistance
+      5.2.meter.distance.should == 5.2
+      5.2.meter.unit.should == :meters
+    end
+  end
+
+  describe '#to_radians' do  
+    it 'should convert degrees to radians' do
+      180.to_radians.should be_within(0.1).of 3.14159274
+    end
+  end
+end

data/spec/geo_distance/distance_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe GeoDistance do
+  
+  describe 'initialize' do
+    describe 'Numeric macro' do
+      it 'should create distance from number' do
+        500.kms.should be_a(GeoDistance)
+        500.kms.unit.should == :kms
+        500.kms.units.should == :kms
+        500.kms.distance.should == 500
+      end
+    end
+  end
+
+  context '500 kms' do
+    let(:distance) { 500.kms }
+
+    describe 'comparable' do  
+      it '52 kms is less than 52500 meters' do
+        52.kms.should < (52.thousand + 500.hundred).meters
+      end
+    end
+  
+    describe '#meters' do  
+      it 'should be in meters' do
+        distance.meters.should == 500.thousand
+      end
+    end
+
+    describe '#in_meters' do  
+      it 'should be in meters' do
+        distance.in_meters.should == 500.thousand
+      end
+    end
+
+    describe '#as_meters' do  
+      it 'should be in meters' do
+        distance.as_meters.should == 500.thousand
+      end
+    end
+
+    describe '#as_meters!' do  
+      it 'should be in meters' do
+        dist = distance.as_meters!
+        dist.should == distance
+        dist.distance.should == 500.thousand
+      end
+    end
+
+    describe '#to_meters!' do  
+      it 'should be in meters' do
+        dist = distance.to_meters!
+        dist.should == distance
+        dist.distance.should == 500.thousand
+      end
+    end
+
+    describe '#feet' do
+      it 'should be in feet' do
+        distance.feet.should be_within(10.thousand).of(500.thousand * 3.3)
+      end
+    end
+
+    describe '#to_feet' do
+      it 'should return new GeoDistance converted to feet' do
+        new_dist = distance.to_feet
+        new_dist.should_not == distance
+
+        new_dist.distance.should be_within(10.thousand).of(500.thousand * 3.3)
+      end
+    end
+  end
+end    

data/spec/geo_distance/formula/flat_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe GeoDistance::Flat do
+  let(:from) do 
+    [45, 10].geo_point
+  end
+
+  let(:to) do   
+    b = [42, 11].geo_point
+  end
+
+  describe '#distance' do
+    it "should calculate flat distance as Float" do
+      dist = GeoDistance::Flat.distance(from, to, :units => :kms)
+      dist.should be_a(Float)
+
+      puts "the distance from #{from} to #{to} is: #{dist.kms_to(:meters)} meters"
+      dist.should be_within(10).of 340
+    end
+  end
+
+  describe '#geo_distance' do
+    it "should calculate haversine distance as GeoDistance" do
+      dist = GeoDistance::Flat.geo_distance(from, to)
+      dist.should be_a(GeoDistance)
+
+      # puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+      dist.kms.should be_within(10).of 340
+    end
+  end
+end

data/spec/geo_distance/formula/haversine_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GeoDistance::Haversine do
+  let(:from) do 
+    [45, 10].geo_point
+  end
+
+  let(:to) do   
+    b = [42, 11].geo_point
+  end
+
+  describe '#distance' do
+    it "should calculate haversine distance as Float" do
+      dist = GeoDistance::Haversine.distance(from, to)
+
+      dist.should be_a(Float)
+
+      puts "the distance from #{from} to #{to} is: #{dist.kms_to(:meters)} meters"
+      dist.should be_within(20).of 340
+    end
+  end
+
+  describe '#geo_distance' do
+    it "should calculate haversine distance as GeoDistance" do
+      dist = GeoDistance::Haversine.geo_distance(from, to)
+      dist.should be_a(GeoDistance)
+
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+
+      dist.kms.should be_within(20).of 340
+    end
+  end
+end

data/spec/geo_distance/formula/n_vector.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GeoDistance::NVector do
+  let(:from) do 
+    [45, 10].geo_point
+  end
+
+  let(:to) do   
+    b = [42, 11].geo_point
+  end
+
+  describe '#distance' do
+    it "should calculate N-vector distance as Float" do
+      dist = GeoDistance::NVector.distance(from, to)
+
+      dist.should be_a(Float)
+
+      puts "the distance from #{from} to #{to} is: #{dist.kms_to(:meters)} meters"
+      dist.should be_within(20).of 340
+    end
+  end
+
+  describe '#geo_distance' do
+    it "should calculate N-vector distance as GeoDistance" do
+      dist = GeoDistance::NVector.geo_distance(from, to)
+      dist.should be_a(GeoDistance)
+
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+
+      dist.kms.should be_within(20).of 340
+    end
+  end
+end

data/spec/geo_distance/formula/spherical_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GeoDistance::Spherical do
+    let(:from) do 
+      [45, 10].geo_point
+    end
+
+    let(:to) do   
+      b = [42, 11].geo_point
+    end
+
+    describe '#distance' do
+      it "should calculate spherical distance as Float" do
+        dist = GeoDistance::Spherical.distance(from, to)
+
+        dist.should be_a(Float)
+
+        puts "the distance from #{from} to #{to} is: #{dist.kms_to(:meters)} meters"
+        dist.should be_within(20).of 340
+      end
+    end
+
+    describe '#geo_distance' do
+      it "should calculate spherical distance as GeoDistance" do
+        dist = GeoDistance::Spherical.geo_distance(from, to)
+        dist.should be_a(GeoDistance)
+
+        puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+
+        dist.kms.should be_within(20).of 340
+      end
+    end
+  end

data/spec/geo_distance/formula/vincenty_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GeoDistance::Vincenty do
+  let(:from) do 
+    [45, 10].geo_point
+  end
+
+  let(:to) do   
+    b = [42, 11].geo_point
+  end
+
+  describe '#distance' do
+    it "should calculate vincenty distance as Float" do
+      dist = GeoDistance::Vincenty.distance(from, to)
+
+      dist.should be_a(Float)
+
+      puts "the distance from #{from} to #{to} is: #{dist.kms_to(:meters)} meters"
+      dist.should be_within(20).of 340
+    end
+  end
+
+  describe '#geo_distance' do
+    it "should calculate vincenty distance as GeoDistance" do
+      dist = GeoDistance::Vincenty.geo_distance(from, to)
+      dist.should be_a(GeoDistance)
+
+      puts "the distance from #{from} to #{to} is: #{dist.meters} meters"
+
+      dist.kms.should be_within(20).of 340
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,12 +1,2 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'geo-distance'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-  
-end

metadata

@@ -1,92 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: geo-distance
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Kristian Mandrup
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-14 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geo_point
+  requirement: &2153874980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153874980
+- !ruby/object:Gem::Dependency
+  name: geo_units
+  requirement: &2153874380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153874380
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153873740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 0
-        version: 2.3.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2153873740
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2153873060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2153873060
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2153871480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
+      - !ruby/object:Gem::Version
+        version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2153871480
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2153870700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-description: |-
-  Calculates the geo distance between two locations using longitude and latitude using Haversine, Speherical or Vincenty formula. 
-  This is done using Math formulas without resorting to Active Record or SQL DB functionality
+  version_requirements: *2153870700
+description: ! "Calculates the geo distance between two locations using longitude
+  and latitude using Haversine, Speherical or Vincenty formula. \nThis is done using
+  Math formulas without resorting to Active Record or SQL DB functionality"
 email: kmandrup@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.textile
-files: 
+files:
 - .document
 - .rspec
 - Gemfile
@@ -97,54 +97,55 @@ files:
 - VERSION
 - geo-distance.gemspec
 - lib/geo-distance.rb
+- lib/geo-distance/class_methods.rb
+- lib/geo-distance/conversion.rb
+- lib/geo-distance/conversion/meters.rb
+- lib/geo-distance/conversion/radians.rb
 - lib/geo-distance/core_ext.rb
+- lib/geo-distance/distance.rb
 - lib/geo-distance/formula.rb
-- lib/geo-distance/haversine.rb
-- lib/geo-distance/spherical.rb
-- lib/geo-distance/vincenty.rb
-- spec/core_ext_spec.rb
-- spec/dist_default_spec.rb
-- spec/dist_haversine_spec.rb
-- spec/dist_spherical_spec.rb
-- spec/dist_vincenty_spec.rb
+- lib/geo-distance/formula/flat.rb
+- lib/geo-distance/formula/haversine.rb
+- lib/geo-distance/formula/n_vector.rb
+- lib/geo-distance/formula/spherical.rb
+- lib/geo-distance/formula/vincenty.rb
+- lib/geo-distance/scale.rb
+- spec/geo_distance/class_methods_spec.rb
+- spec/geo_distance/core_ext_spec.rb
+- spec/geo_distance/distance_spec.rb
+- spec/geo_distance/formula/flat_spec.rb
+- spec/geo_distance/formula/haversine_spec.rb
+- spec/geo_distance/formula/n_vector.rb
+- spec/geo_distance/formula/spherical_spec.rb
+- spec/geo_distance/formula/vincenty_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/kristianmandrup/geo-distance
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 1850876785159146324
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -358498389682454250
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Calculates the geo distance between two locations using longitude and latitude, using Haversine, Speherical or Vincenty formula
-test_files: 
-- spec/core_ext_spec.rb
-- spec/dist_default_spec.rb
-- spec/dist_haversine_spec.rb
-- spec/dist_spherical_spec.rb
-- spec/dist_vincenty_spec.rb
-- spec/spec_helper.rb
+summary: Calculates the geo distance between two locations using longitude and latitude,
+  using Haversine, Speherical or Vincenty formula
+test_files: []