latitude 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p545

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.1"
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in latitude.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Trey Springer
+
+MIT License
+
+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.md

@@ -0,0 +1,50 @@
+# Latitude
+
+[![Build
+Status](https://travis-ci.org/umtrey/latitude-gem.svg?branch=master)](https://travis-ci.org/umtrey/latitude-gem)
+
+Latitude is a simple gem for calculating distances and headings between two
+geographic locations, using great circle math.
+
+For now, this gem uses the WGS84 measurements for the shape of the
+earth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'latitude'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install latitude
+
+## Usage
+
+Note that coordinates are positive for N/E and negative for S/W.
+
+`Latitude.great_circle_distance(start_latitude, start_longitude, end_latitude,
+end_longitude)`
+
+Calculates the great circle distance in kilometers between two
+coordinates.
+
+```
+Latitude.initial_heading(start_latitude, start_longitude, end_latitude, end_longitude)
+Latitude.final_heading(start_latitude, start_longitude, end_latitude, end_longitude)
+```
+
+Calculates the initial and final headings if traveling between two
+points using a great circle path.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/latitude/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/latitude.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'latitude/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "latitude"
+  spec.version       = Latitude::VERSION
+  spec.authors       = ["Trey Springer"]
+  spec.email         = ["dfsiii@gmail.com"]
+  spec.summary       = %q{Calculates distances between two geographic coordinates.}
+  spec.description   = %q{Uses the great-circle distance calculation to determine the distance between two locations with just latitudes and longitudes.}
+  spec.homepage      = "http://www.treyspringer.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/latitude/version.rb

@@ -0,0 +1,3 @@
+module Latitude
+  VERSION = "0.0.1"
+end

data/lib/latitude/vincenty.rb

@@ -0,0 +1,112 @@
+# thanks to http://www.movable-type.co.uk/scripts/latlong-vincenty.html
+
+module Vincenty
+  extend self
+
+  # in meters
+  WGS84_A = 6378137
+  WGS84_B = 6356752.314245
+  WGS84_F = 1 / 298.257223563
+
+  def great_circle_distance(start_lat, start_long, end_lat, end_long)
+    return 0 if (start_lat == end_lat) && (start_long == end_long)
+
+    solution_set(start_lat, start_long, end_lat, end_long)[:distance]
+  end
+
+  def initial_bearing(start_lat, start_long, end_lat, end_long)
+    return nil if (start_lat == end_lat) && (start_long == end_long)
+
+    solution_set(start_lat, start_long, end_lat, end_long)[:initial_bearing]
+  end
+
+  def final_bearing(start_lat, start_long, end_lat, end_long)
+    return nil if (start_lat == end_lat) && (start_long == end_long)
+
+    solution_set(start_lat, start_long, end_lat, end_long)[:final_bearing]
+  end
+
+private
+  def solution_set(start_lat, start_long, end_lat, end_long)
+    a = WGS84_A
+    b = WGS84_B
+    f = WGS84_F
+
+    phi_1 = to_radians(start_lat)
+    lambda_1 = to_radians(start_long)
+    phi_2 = to_radians(end_lat)
+    lambda_2 = to_radians(end_long)
+
+    iterative_solver(phi_1, lambda_1,
+                     phi_2, lambda_2,
+                     a, b, f)
+  end
+
+  def iterative_solver(phi_1, lambda_1, phi_2, lambda_2, a, b, f)
+    l = lambda_2 - lambda_1
+    sin_u1, cos_u1, tan_u1 = get_trig_trio(phi_1, f)
+    sin_u2, cos_u2, tan_u2 = get_trig_trio(phi_2, f)
+
+    lam = l
+    iterations = 0
+
+    begin
+      sin_lam = Math.sin(lam)
+      cos_lam = Math.cos(lam)
+
+      sin_sigma = Math.sqrt((cos_u2 * sin_lam)**2 + ((cos_u1 * sin_u2) - (sin_u1 * cos_u2 * cos_lam))**2)
+      return 0 if sin_sigma == 0 # co-incident points
+
+      cos_sigma = (sin_u1 * sin_u2) + (cos_u1 * cos_u2 * cos_lam)
+      sigma = Math.atan2(sin_sigma, cos_sigma)
+
+      sin_alpha = cos_u1 * cos_u2 * sin_lam / sin_sigma
+      cos_sq_alpha = 1 - sin_alpha**2
+
+      if cos_sq_alpha == 0
+        cos_2sigma_m = 0
+      else
+        cos_2sigma_m = cos_sigma - 2 * sin_u1 * sin_u2 / cos_sq_alpha
+      end
+
+      c = f/16 * cos_sq_alpha * (4 + f*(4 - 3*cos_sq_alpha))
+      lam_prime = lam
+      lam = l + (1 - c) * f * sin_alpha *
+              (sigma + c * sin_sigma * (cos_2sigma_m + c * cos_sigma * (-1 + 2 * cos_2sigma_m**2)))
+    end while ((lam - lam_prime).abs >= 1e-12) && ((iterations += 1) < 100)
+
+    raise Exception("Failed to converge") if iterations >= 100
+
+    u_sq = cos_sq_alpha * (a**2 - b**2) / (b**2)
+    big_a = 1 + u_sq/16384 * (4096 + u_sq * (-768 + u_sq * (320 - 175 * u_sq)))
+    big_b = u_sq/1024 * (256 + u_sq * (-128 + u_sq * (74-47 * u_sq)))
+    delta_sigma = big_b * sin_sigma * (cos_2sigma_m + big_b/4 * (cos_sigma * (-1 + 2*(cos_2sigma_m**2)) -
+                    big_b/6 * cos_2sigma_m * (-3 + 4*(sin_sigma**2)) * (-3 + 4*(cos_sigma**2))))
+
+    distance = (b * big_a * (sigma - delta_sigma)).round(3) # 1mm precision
+    fwd_az = Math.atan2(cos_u2 * sin_lam, (cos_u1 * sin_u2) - (sin_u1 * cos_u2 * cos_lam))
+    rev_az = Math.atan2(cos_u1 * sin_lam, (cos_u1 * sin_u2 * cos_lam) - (sin_u1 * cos_u2))
+
+    # var fwdAz = Math.atan2(cosU2*sinλ,  cosU1*sinU2-sinU1*cosU2*cosλ);
+    # var revAz = Math.atan2(cosU1*sinλ, -sinU1*cosU2+cosU1*sinU2*cosλ);
+    # return { distance: s, initialBearing: fwdAz.toDegrees(), finalBearing: revAz.toDegrees() };
+    { :distance => distance,
+      :initial_bearing => to_degrees(fwd_az),
+      :final_bearing => to_degrees(rev_az) }
+  end
+
+  def to_radians(degrees)
+    degrees * Math::PI / 180
+  end
+
+  def to_degrees(rads)
+    rads * 180 / Math::PI
+  end
+
+  def get_trig_trio(rads, f)
+    tan = (1-f) * Math.tan(rads)
+    cos = 1 / Math.sqrt(1 + tan**2)
+    sin = tan * cos
+    [sin, cos, tan]
+  end
+end

data/lib/latitude.rb

@@ -0,0 +1,24 @@
+require "latitude/version"
+require "latitude/vincenty"
+
+module Latitude
+  extend self
+  def great_circle_distance(start_latitude, start_longitude, end_latitude, end_longitude)
+    # in kilometers
+    m_distance = Vincenty.great_circle_distance(start_latitude, start_longitude,
+                                                end_latitude, end_longitude)
+
+    return m_distance / 1000.0
+  end
+
+  def initial_bearing(start_latitude, start_longitude, end_latitude, end_longitude)
+    Vincenty.initial_bearing(start_latitude, start_longitude,
+                            end_latitude, end_longitude)
+  end
+
+  def final_bearing(start_latitude, start_longitude, end_latitude, end_longitude)
+    Vincenty.final_bearing(start_latitude, start_longitude,
+                          end_latitude, end_longitude)
+  end
+
+end

data/spec/latitude_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Latitude do
+  describe "#great_circle_distance" do
+    it "should return 0 if both coordinates are equal" do
+      expect(Latitude.great_circle_distance(0,0,0,0)).to eq(0)
+    end
+
+    it "should use the vincenty formulae to calculate the great-circle distance between two coordinates" do
+      expect(Latitude.great_circle_distance(50, -5, 58, -3)).to be_within(0.001).of(899.937706)
+      expect(Latitude.great_circle_distance(50, -5, -58, 3)).to be_within(0.001).of(11994.498924)
+      expect(Latitude.great_circle_distance(10, 10, 50, 50)).to be_within(0.001).of(5758.331041)
+    end
+  end
+
+  describe "#initial_bearing" do
+    it "should return nil if both coordinates are equal" do
+      expect(Latitude.initial_bearing(0,0,0,0)).to be_nil
+    end
+
+    it "should use the vincenty formulae to calculate the initial bearing from one point to another along the great circle route" do
+      expect(Latitude.initial_bearing(50, -5, 58, -3)).to be_within(0.001).of(7.575056)
+      expect(Latitude.initial_bearing(50, -5, -58, 3)).to be_within(0.001).of(175.531128)
+      expect(Latitude.initial_bearing(10, 10, 50, 50)).to be_within(0.001).of(31.830619)
+    end
+  end
+
+  describe "#final_bearing" do
+    it "should return nil if both coordinates are equal" do
+      expect(Latitude.initial_bearing(0,0,0,0)).to be_nil
+    end
+
+    it "should use the vincenty formulae to calculate the initial bearing from one point to another along the great circle route" do
+      expect(Latitude.final_bearing(50, -5, 58, -3)).to be_within(0.001).of(9.197103)
+      expect(Latitude.final_bearing(50, -5, -58, 3)).to be_within(0.001).of(174.579117)
+      expect(Latitude.final_bearing(10, 10, 50, 50)).to be_within(0.001).of(53.758428)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+require 'latitude'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: latitude
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Trey Springer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses the great-circle distance calculation to determine the distance
+  between two locations with just latitudes and longitudes.
+email:
+- dfsiii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- latitude.gemspec
+- lib/latitude.rb
+- lib/latitude/version.rb
+- lib/latitude/vincenty.rb
+- spec/latitude_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.treyspringer.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Calculates distances between two geographic coordinates.
+test_files:
+- spec/latitude_spec.rb
+- spec/spec_helper.rb