haversine 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+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.
+group :development do
+  gem "rspec", ">= 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    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)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (>= 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,22 @@
+= haversine
+
+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
+ 
+* 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
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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
+
+Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "haversine"
+  gem.homepage = "http://github.com/kristianmandrup/haversine"
+  gem.license = "MIT"
+  gem.summary = %Q{Calculates the haversine distance between two locations using longitude and latitude}
+  gem.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}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "haversine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/haversine.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{haversine}
+  s.version = "0.1.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.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"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "haversine.gemspec",
+    "lib/haversine.rb",
+    "spec/haversine_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/haversine}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Calculates the haversine distance between two locations using longitude and latitude}
+  s.test_files = [
+    "spec/haversine_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_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<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<rcov>, [">= 0"])
+  end
+end
+

data/lib/haversine.rb

@@ -0,0 +1,109 @@
+#
+# haversine formula to compute the great circle distance between two points given their latitude and longitudes
+#
+# Copyright (C) 2008, 360VL, Inc
+# Copyright (C) 2008, Landon Cox
+#
+# http://www.esawdust.com (Landon Cox)
+# contact:
+# http://www.esawdust.com/blog/businesscard/businesscard.html
+#
+# LICENSE: GNU Affero GPL v3
+# The ruby implementation of the Haversine formula is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation. 
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
+# License version 3 for more details.  http://www.gnu.org/licenses/
+#
+# Landon Cox - 9/25/08
+#
+# Notes:
+#
+# translated into Ruby based on information contained in:
+#   http://mathforum.org/library/drmath/view/51879.html  Doctors Rick and Peterson - 4/20/99
+#   http://www.movable-type.co.uk/scripts/latlong.html
+#   http://en.wikipedia.org/wiki/Haversine_formula
+#
+# This formula can compute accurate distances between two points given latitude and longitude, even for
+# short distances.
+ 
+# PI = 3.1415926535 
+
+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 Distance
+    class << self
+      
+      [:miles, :km, :feet, :meters].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 to_s
+        "#{number} #{name}"
+      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 ) 
+    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
+    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
+
+    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
+  end
+end 

data/spec/haversine_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "Haversine" do
+  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:"
+
+    puts dist[:meters].number
+
+    puts "#{dist[:miles]}"
+    puts "#{dist[:km]}"
+    puts "#{dist[:feet]}"
+    puts "#{dist[:meters]}"
+
+    dist[:km].to_s.should match(/7\.376*/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'haversine'
+
+# 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

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: haversine
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: |-
+  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
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- haversine.gemspec
+- lib/haversine.rb
+- spec/haversine_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/haversine
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2632364842243364495
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Calculates the haversine distance between two locations using longitude and latitude
+test_files: 
+- spec/haversine_spec.rb
+- spec/spec_helper.rb