haversine 0.1.0 → 0.2.0

data/{README.rdoc → README.textile}

@@ -1,11 +1,36 @@
-= haversine
+h1. Haversine - geo distance calculations
 
 Calculates the haversine distance between two locations using longitude and latitude. 
 This is done using Math formulas without resorting to Active Record or SQL DB functionality
 
 This is meant to ba a replacement for all those geocode and geolocation utils out there that use built in SQL DB functionality for their calculations!
 
-== Contributing to haversine
+h2. Install & Usage
+
+<pre>require 'haversine'
+
+it "should work" do
+  lon1 = -104.88544
+  lat1 = 39.06546
+
+  lon2 = -104.80
+  lat2 = lat1
+
+  dist = Haversine.distance( lat1, lon1, lat2, lon2 )
+
+  puts "the distance from  #{lat1}, #{lon1} to #{lat2}, #{lon2} is: #{dist[:meters].number} meters"
+
+  puts "#{dist[:feet]}"
+  puts "#{dist.meters}"
+  puts "#{dist[:km]}"
+  puts "#{dist[:miles]}"
+  dist[:km].to_s.should match(/7\.376*/)
+end  
+</pre>
+
+Note: Haversine is used in the "geo_magic":https://github.com/kristianmandrup/geo_magic gem
+
+h2. Contributing to haversine
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -15,7 +40,7 @@ This is meant to ba a replacement for all those geocode and geolocation utils ou
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+h2. Copyright
 
 Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/haversine.gemspec

@@ -5,17 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{haversine}
-  s.version = "0.1.0"
+  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-12}
+  s.date = %q{2011-01-13}
   s.description = %q{Calculates the haversine distance between two locations using longitude and latitude. 
 This is done using Math formulas without resorting to Active Record or SQL DB functionality}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.textile"
   ]
   s.files = [
     ".document",
@@ -23,11 +23,12 @@ This is done using Math formulas without resorting to Active Record or SQL DB fu
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "haversine.gemspec",
     "lib/haversine.rb",
+    "lib/haversine/core_ext.rb",
     "spec/haversine_spec.rb",
     "spec/spec_helper.rb"
   ]

data/lib/haversine.rb

@@ -30,24 +30,72 @@
  
 # PI = 3.1415926535 
 
+require 'haversine/core_ext'
+
 class Haversine
 
   RAD_PER_DEG = 0.017453293  #  PI/180
  
-  # the great circle distance d will be in whatever units R is in
- 
-  Rmiles = 3956           # radius of the great circle in miles
-  Rkm = 6371              # radius in kilometers...some algorithms use 6367
-  Rfeet = Rmiles * 5282   # radius in feet
-  Rmeters = Rkm * 1000    # radius in meters
-
   # 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
-  
+
+  class << self            
+    def units 
+      [:miles, :km, :feet, :meters]
+    end
+  end
+    
   class Distance
-    class << self
-      
-      [:miles, :km, :feet, :meters].each do |unit|
+    attr_reader :distance
+
+    def initialize distance
+      @distance = distance
+    end
+    
+    def [] key               
+      method = :"delta_#{key}"
+      raise ArgumentError, "Invalid unit key #{key}" if !respond_to? method
+      Distance.send "in_#{key}", send(method)
+    end
+
+    Haversine.units.each do |unit|
+      class_eval %{
+        def #{unit}
+          self[:#{unit}]
+        end
+      }
+    end
+
+    protected
+
+    # the great circle distance d will be in whatever units R is in
+
+    Rmiles = 3956           # radius of the great circle in miles
+    Rkm = 6371              # radius in kilometers...some algorithms use 6367
+    Rfeet = Rmiles * 5282   # radius in feet
+    Rmeters = Rkm * 1000    # radius in meters
+    
+    # delta between the two points in miles
+    def delta_miles 
+      Rmiles * distance
+    end
+    
+    # delta in kilometers
+    def delta_km
+      Rkm * distance
+    end
+    
+    def delta_feet
+      Rfeet * distance
+    end
+    
+    def delta_meters
+      Rmeters * distance
+    end                  
+
+
+    class << self            
+      Haversine.units.each do |unit|
         class_eval %{
           def in_#{unit} number
             Unit.new :#{unit}, number
@@ -63,47 +111,46 @@ class Haversine
         @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.distances     
-    @distances ||= Hash.new   
-  end
  
   # given two lat/lon points, compute the distance between the two points using the haversine formula
   #  the result will be a Hash of distances which are key'd by 'mi','km','ft', and 'm'
  
-  def self.distance( lat1, lon1, lat2, lon2 ) 
+  def self.distance( lat1, lon1, lat2, lon2, units = :meters ) 
     dlon = lon2 - lon1
     dlat = lat2 - lat1
 
-    dlon_rad = dlon * RAD_PER_DEG
-    dlat_rad = dlat * RAD_PER_DEG
-
-    lat1_rad = lat1 * RAD_PER_DEG
-    lon1_rad = lon1 * RAD_PER_DEG
-
-    lat2_rad = lat2 * RAD_PER_DEG
-    lon2_rad = lon2 * RAD_PER_DEG
-
-    # puts "dlon: #{dlon}, dlon_rad: #{dlon_rad}, dlat: #{dlat}, dlat_rad: #{dlat_rad}"
-
-    a = (Math.sin(dlat_rad/2))**2 + Math.cos(lat1_rad) * Math.cos(lat2_rad) * (Math.sin(dlon_rad/2))**2
+    a = calc(dlat, lat1, lat2, dlon)
     c = 2 * Math.atan2( Math.sqrt(a), Math.sqrt(1-a))
 
-    dMi = Rmiles * c          # delta between the two points in miles
-    dKm = Rkm * c             # delta in kilometers
-    dFeet = Rfeet * c         # delta in feet
-    dMeters = Rmeters * c     # delta in meters
+    Distance.new c
+  end  
 
-    distances[:miles] = Distance.in_miles dMi
-    distances[:km] = Distance.in_km dKm
-    distances[:feet] = Distance.in_feet dFeet
-    distances[:meters] = Distance.in_meters dMeters
-    distances
+  def self.calc dlat, lat1, lat2, dlon
+    (Math.sin(dlat.rpd/2))**2 + Math.cos(lat1.rpd) * Math.cos((lat2.rpd)) * (Math.sin(dlon.rpd/2))**2    
+  end
+  
+  def self.wants? unit_opts, unit
+    unit_opts == unit || unit_opts[unit]    
   end
 end 

data/lib/haversine/core_ext.rb

@@ -0,0 +1,19 @@
+class Float
+  def round_to(x)
+    (self * 10**x).round.to_f / 10**x
+  end
+
+  def ceil_to(x)
+    (self * 10**x).ceil.to_f / 10**x
+  end
+
+  def floor_to(x)
+    (self * 10**x).floor.to_f / 10**x
+  end
+
+  RAD_PER_DEG = 0.017453293  #  PI/180
+  
+  def rpd
+    self * RAD_PER_DEG    
+  end  
+end

data/spec/haversine_spec.rb

@@ -10,15 +10,12 @@ describe "Haversine" do
 
     dist = Haversine.distance( lat1, lon1, lat2, lon2 )
 
-    puts "the distance from  #{lat1}, #{lon1} to #{lat2}, #{lon2} is:"
+    puts "the distance from  #{lat1}, #{lon1} to #{lat2}, #{lon2} is: #{dist[:meters].number} meters"
 
-    puts dist[:meters].number
-
-    puts "#{dist[:miles]}"
-    puts "#{dist[:km]}"
     puts "#{dist[:feet]}"
-    puts "#{dist[:meters]}"
-
+    puts "#{dist.meters}"
+    puts "#{dist[:km]}"
+    puts "#{dist[:miles]}"
     dist[:km].to_s.should match(/7\.376*/)
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-01-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,18 +85,19 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.textile
 files: 
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - haversine.gemspec
 - lib/haversine.rb
+- lib/haversine/core_ext.rb
 - spec/haversine_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -113,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2632364842243364495
+      hash: 3157735557663503756
       segments: 
       - 0
       version: "0"