navigate 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53412925eb7c7c776e1e618bd00427542eed887e
-  data.tar.gz: 91ff503dde1685f6188940b5aa915179918e365b
+  metadata.gz: d65809740ba55a6fb3e05b3a19807e1bd5b611f5
+  data.tar.gz: edf223e53205e350915a40f2b79ee5629048ed1c
 SHA512:
-  metadata.gz: 2811b9ca2835e6ed8dfc9c0ee5036fbb4fb5b0b6644050f684f2dd88b34123b81be158e0bdce25b907f0326774256b626bb61ab5631ec98f214cb46c0a1c3469
-  data.tar.gz: 92b950abfda34c7be652384aac5c12e1639dd9be5b282fcd0e6e5010417f45998a3df1d2dfe436290e3bdc7dcda83accb08e6e8d5766efa8e62e3d5433051922
+  metadata.gz: dabd73770c433a9aa3eb0aceb2875e14776471ef378a459db1b4a329783f1a8cb5931bc5213884af74577e828b44a047faf83e7a32fb0688b753c9dccb1828ad
+  data.tar.gz: 606a843635d970e9705eab0bf0acafba287b6a97e054c52734708fcad572dc69de9e6ac30e35f75d9c43db3d597002979f8c24853f4d83b103bdec468641574c

data/Gemfile

@@ -13,6 +13,8 @@ group :development do
   gem "simplecov", ">= 0"
 end
 
+gem 'coveralls', require: false
+
 group :test do
   gem 'rake'
 end

data/Gemfile.lock

@@ -9,9 +9,17 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.3.8)
     builder (3.2.2)
+    coveralls (0.8.1)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
     git (1.2.9.1)
@@ -25,6 +33,8 @@ GEM
       oauth2
     hashie (3.4.1)
     highline (1.7.2)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
     i18n (0.7.0)
     jeweler (2.0.1)
       builder
@@ -37,11 +47,13 @@ GEM
       rdoc
     json (1.8.2)
     jwt (1.4.1)
+    mime-types (2.6.1)
     mini_portile (0.6.2)
     minitest (5.6.1)
     multi_json (1.11.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
+    netrc (0.10.3)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     oauth2 (1.0.0)
@@ -54,6 +66,10 @@ GEM
     rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
@@ -65,15 +81,23 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
     thread_safe (0.3.5)
+    tins (1.5.2)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
+  coveralls
   jeweler (~> 2.0.1)
   rake
   rdoc (~> 3.12)

data/README.md

@@ -1,4 +1,6 @@
 [![Build Status](https://travis-ci.org/jonatasrancan/navigate.svg?branch=master)](https://travis-ci.org/jonatasrancan/navigate)
+[![Gem Version](https://badge.fury.io/rb/navigate.svg)](http://badge.fury.io/rb/navigate)
+[![Coverage Status](https://coveralls.io/repos/jonatasrancan/navigate/badge.svg?branch=master)](https://coveralls.io/r/jonatasrancan/navigate?branch=master)
 ## navigate
 
 A simple gem with some functions, to calculate the distance, bearing between two positions or
@@ -51,7 +53,7 @@ Navigate::bearing(position1, position2)
 ```ruby
 position1 = Navigate::Position.new(-90.0, 180.0)
 
-Navigate::bearing(position1)
+Navigate::destination(position1)
 # => #<Navigate::Position:0x00000003edc7b0 @latitude=-89.10067966450693, @longitude=-90.0>
 ```
 By default the function will use a bearing = 90.0, distance = 100 KM
@@ -59,24 +61,24 @@ By default the function will use a bearing = 90.0, distance = 100 KM
 It receive a hash of options to pass the bearing, distance and the unit of the distance
 
 ```ruby
-Navigate::bearing(position1, bearing: 180.0, distance: 150, radius_unit: 'FT')
-# => #<Navigate::Position:0x00000003e9b198 @latitude=-90.0, @longitude=-180.0> 
+Navigate::destination(position1, bearing: 180.0, distance: 150, radius_unit: 'FT')
+# => #<Navigate::Position:0x00000003e9b198 @latitude=-90.0, @longitude=-180.0>
 ```
 
 Contributing to navigate
------------------------- 
+------------------------
  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.
 
 License

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.1

data/lib/navigate.rb

@@ -2,42 +2,15 @@ module Navigate
   EARTH_RADIUS = { 'KM' => 6371.009, 'MI' => 3958.761, 'NM' => 3440.070, 'YD' => 6967420, 'FT' => 20902260 }
 
   def self.distance_between(position1, position2, radius_unit = 'KM')
-    Math::acos(
-      Math::sin(position1.latitude.to_radians) * Math::sin(position2.latitude.to_radians) +
-      Math::cos(position1.latitude.to_radians) * Math::cos(position2.latitude.to_radians) *
-      Math::cos((position2.longitude - position1.longitude).to_radians)
-    ) * EARTH_RADIUS[radius_unit]
+    DistanceBetween.calculate(position1, position2, radius_unit)
   end
 
   def self.bearing(position1, position2)
-    dLon = (position2.longitude - position1.longitude).to_radians
-
-    y = Math::sin(dLon) * Math::cos(position2.latitude.to_radians)
-    x = Math::cos(position1.latitude.to_radians) * Math::sin(position2.latitude.to_radians) -
-        Math::sin(position1.latitude.to_radians) * Math::cos(position2.latitude.to_radians) * Math::cos(dLon)
-
-    Math::atan2(y, x).to_bearing
+    Bearing.calculate(position1, position2)
   end
 
   def self.destination(position, options = {})
-    radius = EARTH_RADIUS[options[:radius_unit] || 'KM']
-    distance = options[:distance] || 100.0
-    brng = options[:bearing] || 90.0
-
-    new_lat = Math::asin(
-            Math::sin(position.latitude.to_radians) * Math::cos(distance / radius) +
-            Math::cos(position.latitude.to_radians) * Math::sin(distance / radius) *
-            Math::cos(brng)
-          )
-
-    new_lon = position.longitude.to_radians + Math::atan2(
-                    Math::sin(brng) * Math::sin(distance / radius) * Math::cos(position.latitude.to_radians),
-                    Math::cos(distance / radius) - Math::sin(position.latitude.to_radians) * Math::sin(new_lat)
-                  )
-
-    new_lon = (new_lon + Math::PI) % (2 * Math::PI) - Math::PI
-
-    Position.new new_lat.to_degrees, new_lon.to_degrees
+    Destination.calculate(position, options)
   end
 end
 
@@ -45,3 +18,6 @@ path = File.expand_path(File.dirname(__FILE__))
 $:.unshift path unless $:.include?(path)
 require 'navigate/conversions'
 require 'navigate/position'
+require 'navigate/bearing'
+require 'navigate/distance_between'
+require 'navigate/destination'

data/lib/navigate/position.rb

@@ -22,8 +22,6 @@ module Navigate
     def valid?
       valid_latitude?
       valid_longitude?
-
-      true
     end
   end
 end

data/test/helper.rb

@@ -1,4 +1,6 @@
 require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
 
 module SimpleCov::Configuration
   def clean_filters

data/test/test_navigate.rb

@@ -1,39 +1,42 @@
 require 'helper'
 
 describe Navigate do
-  context "#distance" do
-    it 'calculates the distance between 2 positions in kilometers' do
-      position1 = Navigate::Position.new(90.0, 120.0)
-      position2 = Navigate::Position.new(90.0, 120.0)
+  before do
+    @position1 = Navigate::Position.new(90.0, 120.0)
+    @position2 = Navigate::Position.new(80.0, 120.0)
+  end
 
-      Navigate::distance_between(position1, position2).must_equal 0
+  describe "#distance_between" do
+    it 'calculates the distance between 2 positions in kilometers' do
+      Navigate::distance_between(@position1, @position1).must_equal 0
     end
 
     it 'calculates the distance between 2 positions in kilometers' do
-      position1 = Navigate::Position.new(90.0, 120.0)
-      position2 = Navigate::Position.new(80.0, 120.0)
-
-      km = Navigate::distance_between(position1, position2).round(2)
+      km = Navigate::distance_between(@position1, @position2).round(2)
 
       km.must_equal 1111.95
     end
 
     it 'calculates the distance between 2 positions in nautic miles' do
-      position1 = Navigate::Position.new(90.0, 120.0)
-      position2 = Navigate::Position.new(80.0, 120.0)
-
-      nm = Navigate::distance_between(position1, position2, 'NM').round(2)
+      nm = Navigate::distance_between(@position1, @position2, 'NM').round(2)
 
       nm.must_equal 600.41
     end
-  end
 
-  describe '#bearing' do
-    before do
-      @position1 = Navigate::Position.new(90.0, 120.0)
-      @position2 = Navigate::Position.new(80.0, 120.0)
+    it "raise exception when first arg isn't a Navigate::Position" do
+      exception = assert_raises(RuntimeError) { Navigate::distance_between('wrong type', 90.0) }
+
+      assert_match /First arg, must be a Navigate::Position instance/, exception.message
     end
 
+    it "raise exception when second arg isn't a Navigate::Position" do
+      exception = assert_raises(RuntimeError) { Navigate::distance_between(@position1, 500) }
+
+      assert_match /Second arg, must be a Navigate::Position instance/, exception.message
+    end
+  end
+
+  describe '#bearing' do
     it 'calculates the bearing between 2 positions' do
       bearing = Navigate::bearing(@position1, @position2)
 
@@ -45,13 +48,23 @@ describe Navigate do
 
       bearing.must_equal 0
     end
+
+    it "raise exception when first arg isn't a Navigate::Position" do
+      exception = assert_raises(RuntimeError) { Navigate::bearing('wrong type', 90.0) }
+
+      assert_match /First arg, must be a Navigate::Position instance/, exception.message
+    end
+
+    it "raise exception when second arg isn't a Navigate::Position" do
+      exception = assert_raises(RuntimeError) { Navigate::bearing(@position1, 500) }
+
+      assert_match /Second arg, must be a Navigate::Position instance/, exception.message
+    end
   end
 
   describe '#destination' do
     it 'returns a final position, using default radius unit, distance and bearing' do
-      position1 = Navigate::Position.new(90.0, 120.0)
-
-      destination = Navigate::destination(position1)
+      destination = Navigate::destination(@position1)
 
       assert_kind_of Navigate::Position, destination
 
@@ -60,12 +73,22 @@ describe Navigate do
     end
 
     it 'returns a final positions, passing custom radius unit, distance and bearing' do
-      position1 = Navigate::Position.new(90.0, 120.0)
-
-      destination = Navigate::destination(position1, bearing: 270, radius_unit: 'NM', distance: 200)
+      destination = Navigate::destination(@position1, bearing: 270, radius_unit: 'NM', distance: 200)
 
       destination.longitude.round(2).must_equal 30.0
       destination.latitude.round(2).must_equal 86.67
     end
+
+    it "raise exception when first arg isn't a Navigate::Position" do
+      exception = assert_raises(RuntimeError) { Navigate::destination('wrong type') }
+
+      assert_match /First arg, must be a Navigate::Position instance/, exception.message
+    end
+
+    it "raise exception when bearing is out of range" do
+      exception = assert_raises(RuntimeError) { Navigate::destination(@position1, bearing: 500) }
+
+      assert_match /Bearing must be between 0.0 and 360.0/, exception.message
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: navigate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jônatas Rancan de Souza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda