geodesy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5895d5c7c414ff0ead805f95cafa9bd69580c9cc
+  data.tar.gz: de52ebeb588d32fe325d6fe2597796ae8843e87e
+SHA512:
+  metadata.gz: 6ccd58b4bf1bfae19720d938e49ab57337686b4881e0793f8b4978802c8ac4a8116e6f2b33d5704147ffb34a6b5d89837944d27e29264c8beefcb779d7400116
+  data.tar.gz: ab3c1e4bccdfb2f6e911ac94b790ba65ddf00aeab7fd570df0251bfd6b11bf86eaf6cb3af90123d4947762033959ea147468b7b5feeab6d2309a1abf8a221add

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.2.0'
+
+# Specify your gem's dependencies in geodesy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Robert Evans
+
+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 @@
+# Geodesy

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => 'test'

data/geodesy.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geodesy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "geodesy"
+  spec.version       = Geodesy::VERSION
+  spec.authors       = ["Robert Evans"]
+  spec.email         = ["robert@codewranglers.org"]
+  spec.summary       = %q{Some simple Geo-Calculations}
+  spec.description   = %q{Simple Geo-Calculations}
+  spec.homepage      = "http://www.codewranglers.org"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/geodesy/bearing.rb

@@ -0,0 +1,32 @@
+
+module Geodesy
+  class Bearing
+    using FloatExtension
+
+    attr_reader :starting_point, :ending_point
+
+    #
+    # start_point is a Geodesy::Coordinates
+    # end_point is a Geodesy::Coordinates
+    #
+    def initialize(start_point, end_point)
+      @starting_point = start_point
+      @ending_point   = end_point
+    end
+
+    def calculate
+      start_lat_in_radians  = starting_point.lat.to_radians
+      end_lat_in_radians    = ending_point.lat.to_radians
+      delta                 = (ending_point.lng.angle - starting_point.lng.angle).to_radians
+
+      # formula: http://mathforum.org/library/drmath/view/55417.html
+      y = Math.sin(delta) * Math.cos(end_lat_in_radians)
+      x = ( Math.cos(start_lat_in_radians) * Math.sin(end_lat_in_radians) ) -
+          ( Math.sin(start_lat_in_radians) * Math.cos(end_lat_in_radians) * Math.cos(delta) )
+      z = Math.atan2(y, x)
+
+      ( z.to_degrees + 360 ) % 360
+    end
+
+  end
+end

data/lib/geodesy/conversions.rb

@@ -0,0 +1,42 @@
+
+module Geodesy
+  COMPASS_POINTS      = %w[N NE E SE S SW W NW]
+  EARTH_RADIUS        = 6371.0
+  KM_TO_MI            = 0.621371192
+  DEGREES_PER_RADIAN  = 57.2957795
+  YARDS_PER_METER     = 1.09361
+  METERS_TO_YARDS     = 0.9144
+
+  module Conversions
+    extend self
+
+    def kilometers_to_miles
+      KM_TO_MI
+    end
+
+    def miles_to_kilometers
+      1.0 / KM_TO_MI
+    end
+
+    def meters_to_yards
+      METERS_TO_YARDS
+    end
+
+    def yards_to_meters
+      YARDS_PER_METER
+    end
+
+    def feet_to_yards
+      3
+    end
+
+    def yards_to_feet
+      3
+    end
+
+    def feet_to_inches
+      12
+    end
+
+  end
+end

data/lib/geodesy/coordinates.rb

@@ -0,0 +1,16 @@
+require_relative 'latitude'
+require_relative 'longitude'
+
+module Geodesy
+  class Coordinates
+    attr_reader :lat, :lng, :altitude, :radius
+
+    def initialize(lat, lng, altitude = nil)
+      @lat      = Geodesy::Latitude.new(lat)
+      @lng      = Geodesy::Longitude.new(lng)
+      @altitude = altitude
+      @radius   = Geodesy::EARTH_RADIUS # in kilometers
+    end
+
+  end
+end

data/lib/geodesy/core_ext/float_extension.rb

@@ -0,0 +1,40 @@
+
+module FloatExtension
+  refine Float do
+
+    # Assumes degrees to radians
+    def to_radians
+      self * Math::PI / 180
+    end
+
+    # assumes radians to degrees
+    def to_degrees
+      self * 180  / Math::PI
+    end
+
+    def to_kilometers(miles)
+      miles * Geodesy::Conversions.miles_to_kilometers
+    end
+
+    def to_miles(kilometers)
+      kilometers * Geodesy::Conversions.kilometers_to_miles
+    end
+
+    def to_meters(yards)
+      yards * Geodesy::Conversions.yards_to_meters
+    end
+
+    def to_yards(meters)
+      meters * Geodesy::Conversions.meters_to_yards
+    end
+
+    def to_feet(yards)
+      yards * Geodesy::Conversions.yards_to_feet
+    end
+
+    def to_inches(feet)
+      feet * Geodesy::Conversions.feet_to_inches
+    end
+
+  end
+end

data/lib/geodesy/destination.rb

@@ -0,0 +1,44 @@
+#
+# Will return a coordinate based on a starting point, the bearing,
+# and the distance.
+#
+module Geodesy
+  class Destination
+    using FloatExtension
+
+    attr_reader :starting_point, :distance, :bearing, :radius
+
+    #
+    # StartingPoint is a Coordinate Object
+    # Bearing is a Float Object
+    # Distance is an Integer or Float Object - default units: meters
+    #
+    def initialize(starting_point, bearing, distance)
+      @starting_point = starting_point
+      @radius         = Geodesy::EARTH_RADIUS
+      @bearing        = bearing
+      @distance       = distance
+    end
+
+    def calculate
+      angular_distance    = distance / radius
+      bearing_to_radians  = bearing.to_radians
+      lat_radians         = starting_point.lat.to_radians
+      lng_radians         = starting_point.lng.to_radians
+
+      x = Math.asin(
+                      ( Math.sin(lat_radians) * Math.cos(angular_distance) ) +
+                      ( Math.cos(lat_radians) * Math.sin(angular_distance) * Math.cos(bearing_to_radians) )
+                    )
+      y = lng_radians + Math.atan2(
+                                   Math.sin(bearing_to_radians) * Math.sin(angular_distance) * Math.cos(lat_radians),
+                                   Math.cos(angular_distance) - Math.sin(lat_radians) * Math.sin(x)
+                                   )
+      # normalize y to -180°..+180°
+      z = ( y + 3 * Math::PI ) % ( 2 * Math::PI ) - Math::PI
+
+      Coordinates.new( x.to_degrees, z.to_degrees )
+    end
+
+  end
+end

data/lib/geodesy/latitude.rb

@@ -0,0 +1,17 @@
+
+module Geodesy
+  class Latitude
+    using FloatExtension
+
+    attr_reader :angle
+
+    def initialize(lat)
+      @angle = lat
+    end
+
+    def to_radians
+      angle.to_radians
+    end
+
+  end
+end

data/lib/geodesy/longitude.rb

@@ -0,0 +1,17 @@
+
+module Geodesy
+  class Longitude
+    using FloatExtension
+
+    attr_reader :angle
+
+    def initialize(lng)
+      @angle = lng
+    end
+
+    def to_radians
+      angle.to_radians
+    end
+
+  end
+end

data/lib/geodesy/version.rb

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

data/lib/geodesy.rb

@@ -0,0 +1,45 @@
+require "geodesy/version"
+require 'geodesy/conversions'
+require 'geodesy/core_ext/float_extension'
+require 'geodesy/coordinates'
+require 'geodesy/bearing'
+require 'geodesy/destination'
+
+
+module Geodesy
+  extend self
+
+  #
+  # starting is an array of [ lat, lng ]
+  # ending is an array of [ lat, lng ]
+  #
+  ### Returns
+  #
+  # It returns a floating point number
+  #
+  def bearing(starting, ending)
+    Bearing.new(
+      Coordinates.new(*starting),
+      Coordinates.new(*ending)
+    ).calculate
+  end
+
+
+  #
+  # starting is an array of [ lat, lng ]
+  # bearing is a float
+  # distance is an integer or float - units: meters
+  #
+  ### Returns
+  #
+  # It returns a Coordinates Object
+  #
+  def final_coordinate(starting, bearing, distance = 10)
+    Destination.new(
+      Coordinates.new(*starting),
+      bearing,
+      distance
+    ).calculate
+  end
+
+end

data/test/bearing_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+module Geodesy
+  class BearingTest < Minitest::Test
+
+    def tee_point
+      @tee_point ||= Coordinates.new(33.27254375003685, -117.2873803284383)
+    end
+
+    def green_point
+      @green_point ||= Coordinates.new(33.269139395705295, -117.28715699010904)
+    end
+
+
+    def test_initialization
+      bearing = Bearing.new(tee_point, green_point)
+
+      assert_equal tee_point, bearing.starting_point
+      assert_equal green_point, bearing.ending_point
+    end
+
+
+    def test_calculation
+      bearing = Bearing.new(tee_point, green_point)
+
+      assert_equal 176.86038830369012, bearing.calculate
+    end
+
+  end
+end

data/test/coordinates_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class CoordinatesTest < Minitest::Test
+  def lat
+    @lat ||= Geodesy::Latitude.new(33.26926373135873)
+  end
+
+  def lng
+    @lng ||= Geodesy::Longitude.new(-117.2871651469912)
+  end
+
+  def test_initialization
+    coord = Geodesy::Coordinates.new(33.26926373135873,
+                                     -117.2871651469912)
+
+    assert_equal lat.angle, coord.lat.angle
+    assert_equal lng.angle, coord.lng.angle
+    assert_nil coord.altitude
+    assert_equal Geodesy::EARTH_RADIUS, coord.radius
+  end
+
+end

data/test/destination_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+module Geodesy
+  class DestinationTest < Minitest::Test
+
+    def starting_point
+      @starting_points ||= Coordinates.new(33.269139395705295,
+                                           -117.28715699010904)
+    end
+
+    def bearing
+      176.86038830369012
+    end
+
+
+    def test_initialization
+      dest = Destination.new(starting_point, bearing, 20)
+
+      assert_equal starting_point,  dest.starting_point
+      assert_equal bearing,         dest.bearing
+      assert_equal 20,              dest.distance
+      assert_equal 6371.0,          dest.radius
+    end
+
+
+    def test_calculate
+      dest = Destination.new(starting_point, bearing, 20)
+
+      assert_equal 33.08954448933676,   dest.calculate.lat.angle
+      assert_equal -117.27539907324454, dest.calculate.lng.angle
+    end
+
+  end
+end

data/test/float_extension_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class Point
+  using FloatExtension
+
+  attr_reader :lat, :lng
+
+  def initialize(point)
+    @lat, @lng = *point
+  end
+
+  def lat_to_radians
+    lat.to_radians
+  end
+
+  def lng_to_radians
+    lng.to_radians
+  end
+
+
+  def to_degrees(radians)
+    radians.to_degrees
+  end
+
+end
+
+class FloatExtensionTest < Minitest::Test
+  def point
+    @point ||= Point.new([33.26926373135873, -117.2871651469912])
+  end
+
+  def test_initialization
+    assert_equal 33.26926373135873,   point.lat
+    assert_equal -117.2871651469912,  point.lng
+  end
+
+
+  def test_radians
+    assert_equal 0.5806581918265441,  point.lat_to_radians
+    assert_equal -2.0470472021453356, point.lng_to_radians
+  end
+
+
+  def test_degrees
+    assert_equal 33.269263731358734, point.to_degrees(point.lat_to_radians)
+    assert_equal point.lng, point.to_degrees(point.lng_to_radians).round(13)
+  end
+
+end

data/test/geodesy_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class GeodesyTest < Minitest::Test
+  def starting_point
+    [ 33.27254375003685,
+      -117.2873803284383 ]
+  end
+
+  def ending_point
+    [ 33.269139395705295,
+      -117.28715699010904]
+  end
+
+  def bearing
+    176.86038830369012
+  end
+
+
+  def test_bearing
+    assert_equal bearing,
+      Geodesy.bearing(starting_point,
+                      ending_point)
+  end
+
+
+  def test_final_coordinate
+    final_coord = Geodesy.final_coordinate(
+      ending_point,
+      bearing,
+      20
+    )
+
+    assert_equal 33.08954448933676,
+      final_coord.lat.angle
+
+    assert_equal -117.27539907324454,
+      final_coord.lng.angle
+  end
+
+end

data/test/latitude_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class LatitudeTest < Minitest::Test
+
+  def lat
+    33.26926373135873
+  end
+
+  def test_initialization
+    assert_equal lat, Geodesy::Latitude.new(lat).angle
+  end
+
+  def test_radians
+    assert_equal 0.5806581918265441,
+        Geodesy::Latitude.new(lat).to_radians
+  end
+
+end

data/test/longitude_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class LongitudeTest < Minitest::Test
+
+  def lng
+    -117.2871651469912
+  end
+
+  def test_initialization
+    assert_equal lng,
+      Geodesy::Longitude.new(lng).angle
+  end
+
+  def test_radians
+    assert_equal -2.0470472021453356,
+        Geodesy::Longitude.new(lng).to_radians
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'geodesy'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: geodesy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Geo-Calculations
+email:
+- robert@codewranglers.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- geodesy.gemspec
+- lib/geodesy.rb
+- lib/geodesy/bearing.rb
+- lib/geodesy/conversions.rb
+- lib/geodesy/coordinates.rb
+- lib/geodesy/core_ext/float_extension.rb
+- lib/geodesy/destination.rb
+- lib/geodesy/latitude.rb
+- lib/geodesy/longitude.rb
+- lib/geodesy/version.rb
+- test/bearing_test.rb
+- test/coordinates_test.rb
+- test/destination_test.rb
+- test/float_extension_test.rb
+- test/geodesy_test.rb
+- test/latitude_test.rb
+- test/longitude_test.rb
+- test/test_helper.rb
+homepage: http://www.codewranglers.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Some simple Geo-Calculations
+test_files:
+- test/bearing_test.rb
+- test/coordinates_test.rb
+- test/destination_test.rb
+- test/float_extension_test.rb
+- test/geodesy_test.rb
+- test/latitude_test.rb
+- test/longitude_test.rb
+- test/test_helper.rb
+has_rdoc: