geo-distance2 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 523c3c087965f4be5c678ae45c5a5b8f47d08732
+  data.tar.gz: 2cd2ad476d2a3fc4b23be27af6a4905341147b9c
+SHA512:
+  metadata.gz: 3b6dd41efd4b5682730f9548624533b429effee4cf799b449b214f7d8cee5d8d5004c06c09c1b9497a57643f45c085fb367eed10434f1b3de4b9467a742e185b
+  data.tar.gz: 5435d9e8b786fd2dea3d575968089e0c98d8d7bd433d16a8923a34e284df29b91773ed3c04bb7771be9ebff4e82cadc9cb44d01cde7eeb0cd69587b74a902956

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'geo_point', '~> 0.2.5'
+gem 'geo_units', '~> 0.2.4.1'
+
+group :development do
+  gem "rspec",    ">= 2.6.0"
+  gem "bundler",  "~> 1.10.6"
+  gem "jeweler",  "~> 1.6.2"
+  gem "simplecov",     ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.9)
+    diff-lcs (1.1.2)
+    docile (1.1.5)
+    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)
+    i18n (0.6.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.8.3)
+    rake (0.9.2)
+    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.6.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sugar-high (0.4.6.4)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.10.6)
+  geo_point (~> 0.2.5)
+  geo_units (~> 0.2.4.1)
+  jeweler (~> 1.6.2)
+  rspec (>= 2.6.0)
+  simplecov
+
+BUNDLED WITH
+   1.10.6

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.textile

@@ -0,0 +1,83 @@
+h1. GeoDistance - geo distance calculations
+
+Calculates the Geo distance between two locations using longitude and latitude. 
+This is done using "pure" Math formulas without resorting to Active Record or SQL DB functionality
+
+This gem is meant to be a replacement for those geo distance utils out there that use built in SQL DB functionality for their calculations!
+
+The formulas curently supported are
+
+* _Haversine_
+* _Spherical_
+* _Vincenty_
+* _Flat_
+
+h2. Install & Usage
+
+<pre>require 'geo-distance'
+
+it "should work" do
+  lon1 = -104.88544
+  lat1 = 39.06546
+
+  lon2 = -104.80
+  lat2 = lat1
+
+  dist = GeoDistance.distance( lat1, lon1, lat2, lon2 ) # in radians  
+
+  dist = GeoDistance::Haversine.geo_distance( lat1, lon1, lat2, lon2 ).to_meters
+
+  # 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>   
+
+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
+
+You can also set a default algorithm to use...
+The following will use the _Haversine_ algorithm:
+
+<pre>
+  GeoDistance.default_algorithm = :haversine
+  dist = GeoDistance.distance( lat1, lon1, lat2, lon2 )  
+</pre>
+
+GeoDistance is used in the "geo_magic":https://github.com/kristianmandrup/geo_magic gem
+
+h2. Contributing to geo-distance
+ 
+* Check out the specs and add specs to spec any added features or changes!
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* 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.
+
+h2. 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 = "geo-distance2"
+  gem.homepage = "http://github.com/olignyf/geo-distance2"
+  gem.license = "MIT"
+  gem.summary = %Q{Calculates the geo distance between two locations using longitude and latitude, using Haversine, Speherical or Vincenty formula}
+  gem.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}
+  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 = "geo-distance #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/geo-distance.gemspec

@@ -0,0 +1,87 @@
+# 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{geo-distance2}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Francois Oligny-Lemieux}, %q{Kristian Mandrup}]
+  s.date = %q{2015-12-09}
+  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{frank.quebec@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "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/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/olignyf/geo-distance2}
+  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}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      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<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<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

@@ -0,0 +1,18 @@
+require 'geo_point'
+
+class GeoDistance
+  autoload :Conversion,   'geo-distance/conversion'
+  autoload :Scale,        'geo-distance/scale'
+  autoload :ClassMethods, 'geo-distance/class_methods'
+
+  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  
+
+require 'geo-distance/distance'
+require 'geo-distance/core_ext'
+require 'geo-distance/formula'
+

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

data/lib/geo-distance/conversion.rb

@@ -0,0 +1,67 @@
+class GeoDistance
+  module Conversion
+    autoload :Meters,   'geo-distance/conversion/meters'
+    autoload :Radians,  'geo-distance/conversion/radians'
+    
+    def self.included(base)
+      base.send :include, Meters
+      base.send :include, Radians
+    end
+    
+    # return new GeoDistance instance with distance converted to specific unit
+    ::GeoDistance.units.each do |unit|
+      class_eval %{
+        def to_#{unit}
+          cloned = self.dup
+          un = GeoUnits.key :#{unit}
+          cloned.distance = in_meters * GeoUnits.meters_map[un]
+          cloned.unit = un
+          cloned
+        end
+      }
+    end
+
+    # in_ and as_ return distance as a Float
+    # to_xxx! and similar, modify distance (self) directly
+    (::GeoDistance.units - [:meters]).each do |unit|
+      class_eval %{
+        def in_#{unit}
+          dist = (unit == :radians) ? in_radians : distance            
+          conv_unit = GeoUnits.key :#{unit}
+          convert_to_meters(dist) * GeoUnits.meters_map[conv_unit]
+        end
+        alias_method :as_#{unit}, :in_#{unit}
+
+        def to_#{unit}!
+          conv_unit = GeoUnits.key :#{unit}
+          self.distance = in_meters * GeoUnits.meters_map[conv_unit]
+          self.unit = conv_unit
+          self
+        end
+        alias_method :in_#{unit}!, :to_#{unit}!
+        alias_method :as_#{unit}!, :to_#{unit}!
+      } 
+    end
+    
+    ::GeoDistance.all_units.each do |unit|
+      class_eval %{
+        def #{unit}
+          un = GeoUnits.key :#{unit}
+          send(:"as_\#{un}")
+        end
+      }
+    end
+        
+    protected
+
+    # distance delta 
+    GeoDistance.units.each do |unit|
+      class_eval %{
+        def delta_#{unit}
+          unit = GeoUnits.key(:#{unit})
+          GeoDistance.earth_radius[:#{unit}] * distance
+        end
+      }
+    end       
+  end
+end