geo-distance 0.1.2 → 0.2.0

data/Gemfile

@@ -1,13 +1,11 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem 'geo_point', '~> 0.2.5'
+gem 'geo_units', '~> 0.2.4.1'
+
 group :development do
-  gem "rspec", ">= 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+  gem "rspec",    ">= 2.6.0"
+  gem "bundler",  "~> 1.0.10"
+  gem "jeweler",  "~> 1.6.2"
+  gem "rcov",     ">= 0"
 end

data/Gemfile.lock

@@ -1,28 +1,45 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.9)
     diff-lcs (1.1.2)
+    geo_calc (0.7.6)
+      activesupport (>= 3.0.1)
+      geo_units (~> 0.2.1)
+      i18n
+      require_all (~> 1.2.0)
+      sugar-high (~> 0.4.6.3)
+    geo_point (0.2.5)
+      geo_calc (~> 0.7.5)
+      geo_units (~> 0.2.1)
+    geo_units (0.2.4.1)
+      sugar-high (~> 0.4.6.2)
     git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    i18n (0.6.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
+    rake (0.9.2)
     rcov (0.9.9)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    require_all (1.2.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.6.0)
+    sugar-high (0.4.6.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  bundler (~> 1.0.10)
+  geo_point (~> 0.2.5)
+  geo_units (~> 0.2.4.1)
+  jeweler (~> 1.6.2)
   rcov
-  rspec (>= 2.3.0)
+  rspec (>= 2.6.0)

data/README.textile

@@ -10,6 +10,7 @@ The formulas curently supported are
 * _Haversine_
 * _Spherical_
 * _Vincenty_
+* _Flat_
 
 h2. Install & Usage
 
@@ -22,17 +23,36 @@ it "should work" do
   lon2 = -104.80
   lat2 = lat1
 
-  dist = GeoDistance::Haversine.distance( lat1, lon1, lat2, lon2 )
+  dist = GeoDistance.distance( lat1, lon1, lat2, lon2 ) # in radians  
 
-  puts "the distance from  #{lat1}, #{lon1} to #{lat2}, #{lon2} is: #{dist[:meters].number} meters"
+  dist = GeoDistance::Haversine.geo_distance( lat1, lon1, lat2, lon2 ).to_meters
 
-  puts "#{dist[:feet]}"
-  puts "#{dist.meters}"
-  puts "#{dist[:km]}"
-  puts "#{dist[:miles]}"
-  dist[:km].to_s.should match(/7\.376*/)
+  # Change to (lng, lat) mode
+  GeoPoint.coord_mode = :lng_lat
+
+  p1, p2 = [[lon1, lat1].geo_point, [lon2, lat2].geo_point]
+
+  dist = GeoDistance::Haversine.geo_distance( lon1, lat1, lon2, lat2)
+  dist = GeoDistance::Haversine.geo_distance( p1, p2).to_miles
+
+  puts "the distance from  #{lat1}, #{lon1} to #{lat2}, #{lon2} is: #{dist.meters} meters"
+
+  dist.feet
+  dist.meters
+  dist.kms
+  dist.miles
 end  
-</pre>
+</pre>   
+
+h2. Distance API
+
+The call to distance returns an instance of GeoDistance
+
+@dist = GeoDistance::Haversine.distance( lat1, lon1, lat2, lon2 )@
+
+The #kms, #meters, #miles and #feet methods return an instance og GeoUnit
+
+@dist.kms@
 
 h3. Setting default algorithm
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/geo-distance.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo-distance}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kristian Mandrup"]
-  s.date = %q{2011-01-14}
+  s.authors = [%q{Kristian Mandrup}]
+  s.date = %q{2011-06-23}
   s.description = %q{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}
   s.email = %q{kmandrup@gmail.com}
@@ -28,51 +28,59 @@ This is done using Math formulas without resorting to Active Record or SQL DB fu
     "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"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/geo-distance}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{Calculates the geo distance between two locations using longitude and latitude, using Haversine, Speherical or Vincenty formula}
-  s.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"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<geo_point>, ["~> 0.2.5"])
+      s.add_runtime_dependency(%q<geo_units>, ["~> 0.2.4.1"])
+      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.10"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<geo_point>, ["~> 0.2.5"])
+      s.add_dependency(%q<geo_units>, ["~> 0.2.4.1"])
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.10"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<geo_point>, ["~> 0.2.5"])
+    s.add_dependency(%q<geo_units>, ["~> 0.2.4.1"])
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.10"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end
 end

data/lib/geo-distance.rb

@@ -1,136 +1,18 @@
-module GeoDistance 
-  # this is global because if computing lots of track point distances, it didn't make 
-  # sense to new a Hash each time over potentially 100's of thousands of points
+require 'geo_point'
 
-  class << self
-    # radius of the great circle in miles
-    # radius in kilometers...some algorithms use 6367
-    def earth_radius
-      {:km => 6371, :miles => 3956, :feet => 20895592, :meters => 6371000}                     
-    end
+class GeoDistance
+  autoload :Conversion,   'geo-distance/conversion'
+  autoload :Scale,        'geo-distance/scale'
+  autoload :ClassMethods, 'geo-distance/class_methods'
 
-    def radians_per_degree
-      0.017453293  #  PI/180
-    end    
-    
-    def units 
-      [:miles, :km, :feet, :meters]
-    end
-    
-    def radians_ratio unit
-      GeoDistance.radians_per_degree * earth_radius[unit]          
-    end
-    
-    def default_algorithm= name
-      raise ArgumentError, "Not a valid algorithm. Must be one of: #{algorithms}" if !algorithms.include?(name.to_sym)
-      @default_algorithm = name 
-    end
-    
-    def distance( lat1, lon1, lat2, lon2) 
-      klass = case default_algorithm
-      when :haversine
-        GeoDistance::Haversine
-      when :spherical
-        GeoDistance::Spherical        
-      when :vincenty
-        GeoDistance::Vincenty
-      else
-        raise ArgumentError, "Not a valid algorithm. Must be one of: #{algorithms}"
-      end
-      klass.distance lat1, lon1, lat2, lon2
-    end
-    
-    def default_algorithm 
-      @default_algorithm || :haversine
-    end
-    
-    protected
-    
-    def algorithms
-      [:haversine, :spherical, :vincenty]
-    end
-  end
-    
-  class Distance
-    attr_reader :distance, :unit
+  autoload :Haversine,    'geo-distance/formula/haversine'
+  autoload :Spherical,    'geo-distance/formula/spherical'
+  autoload :Vincenty,     'geo-distance/formula/vincenty'
+  autoload :NVector,      'geo-distance/formula/n_vector'
+  autoload :Flat,         'geo-distance/formula/flat'
+end  
 
-    def initialize distance, unit = nil
-      @distance = distance
-      return if !unit
+require 'geo-distance/distance'
+require 'geo-distance/core_ext'
+require 'geo-distance/formula'
 
-      raise ArgumentError, "Invalid unit: #{unit} - must be one of #{GeoDistance.units}" if !GeoDistance.units.include?(unit.to_sym)
-      @unit = unit.to_sym
-    end
-    
-    def [] key               
-      method = :"delta_#{key}"
-      raise ArgumentError, "Invalid unit key #{key}" if !respond_to? method
-      Distance.send "in_#{key}", send(method)
-    end
-
-    GeoDistance.units.each do |unit|
-      class_eval %{
-        def #{unit}
-          self[:#{unit}]
-        end
-      }
-    end
-
-    protected
-    
-    # delta between the two points in miles
-    GeoDistance.units.each do |unit|
-      class_eval %{
-        def delta_#{unit}
-          GeoDistance.earth_radius[:#{unit}] * distance
-        end
-      }
-    end
-
-    class << self            
-      GeoDistance.units.each do |unit|
-        class_eval %{
-          def in_#{unit} number
-            Unit.new :#{unit}, number
-          end
-        }
-      end
-    end
-    
-    class Unit
-      attr_accessor :name, :number
-      
-      def initialize name, number = 0
-        @name = name
-        @number = number
-      end
-
-      def number
-        @number.round_to(precision[name])
-      end
-      
-      def to_s
-        "#{number} #{name}"
-      end
-      
-      private
-      
-      def precision
-        {
-          :feet => 0,
-          :meters => 2,
-          :km => 4,
-          :miles => 4
-        }
-      end      
-    end
-  end
-   
-  def self.wants? unit_opts, unit
-    unit_opts == unit || unit_opts[unit]    
-  end
-end
-
-require 'geo-distance/haversine'
-require 'geo-distance/spherical'
-require 'geo-distance/vincenty'

data/lib/geo-distance/class_methods.rb

@@ -0,0 +1,71 @@
+class GeoDistance 
+  # this is global because if computing lots of track point distances, it didn't make 
+  # sense to new a Hash each time over potentially 100's of thousands of points
+
+  module ClassMethods
+    # radius of the great circle in miles
+    # radius in kilometers...some algorithms use 6367
+        
+    def distance(*args) 
+      klass = case default_algorithm
+      when :flat
+        GeoDistance::Flat
+      when :haversine
+        GeoDistance::Haversine
+      when :spherical
+        GeoDistance::Spherical        
+      when :vincenty
+        GeoDistance::Vincenty
+      when :nvector
+        GeoDistance::NVector
+      else
+        raise ArgumentError, "Not a valid algorithm. Must be one of: #{algorithms}"
+      end
+      klass.distance *args
+    end
+
+    def default_units= name
+      raise ArgumentError, "Not a valid units. Must be one of: #{all_units}" if !all_units.include?(name.to_sym)
+      @default_units = GeoUnits.key(name)
+    end
+
+    def default_units
+      @default_units || :kms
+    end
+
+    def default_algorithm= name
+      raise ArgumentError, "Not a valid algorithm. Must be one of: #{algorithms}" if !algorithms.include?(name.to_sym)
+      @default_algorithm = name 
+    end
+    
+    def default_algorithm 
+      @default_algorithm || :haversine
+    end
+
+    def earth_radius units
+      GeoUnits.earth_radius units
+    end
+
+    def radians_per_degree
+      0.017453293  #  PI/180
+    end    
+        
+    def radians_ratio unit
+      GeoDistance.radians_per_degree * earth_radius[unit]          
+    end
+
+    def all_units
+      GeoUnits.all_units
+    end
+
+    def units 
+      GeoUnits.units
+    end
+    
+    def algorithms
+      [:flat, :haversine, :spherical, :vincenty, :nvector]
+    end
+  end
+  
+  extend ClassMethods       
+end