navigate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53412925eb7c7c776e1e618bd00427542eed887e
+  data.tar.gz: 91ff503dde1685f6188940b5aa915179918e365b
+SHA512:
+  metadata.gz: 2811b9ca2835e6ed8dfc9c0ee5036fbb4fb5b0b6644050f684f2dd88b34123b81be158e0bdce25b907f0326774256b626bb61ab5631ec98f214cb46c0a1c3469
+  data.tar.gz: 92b950abfda34c7be652384aac5c12e1639dd9be5b282fcd0e6e5010417f45998a3df1d2dfe436290e3bdc7dcda83accb08e6e8d5766efa8e62e3d5433051922

data/.document

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

data/Gemfile

@@ -0,0 +1,18 @@
+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 "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.1)
+    highline (1.7.2)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.4.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)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rake
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jônatas Rancan de Souza
+
+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,85 @@
+[![Build Status](https://travis-ci.org/jonatasrancan/navigate.svg?branch=master)](https://travis-ci.org/jonatasrancan/navigate)
+## navigate
+
+A simple gem with some functions, to calculate the distance, bearing between two positions or
+the next position considering a initial position, distance and bearing.
+
+## Usage
+
+In your Gemfile
+
+```ruby
+gem 'navigate'
+```
+or just install
+```ruby
+gem install navigate
+```
+
+###Distance between 2 positions
+```ruby
+# the firs param is the latitude, second is the longitude
+position1 = Navigate::Position.new(80.0, 120.0)
+position2 = Navigate::Position.new(90.0, 45.0)
+
+Navigate::distance_between(position1, position2)
+# => 1111.9508372419155
+```
+By default the function will return the distane in kilometers
+
+It has a third optional param, to define the unit of the return
+
+```ruby
+Navigate::distance_between(position1, position2, 'NM')
+# => 600.4054799908141
+```
+Available units
+```ruby
+{ 'KM', 'MI', 'NM', 'YD', 'FT' }
+```
+
+### Bearing between two positions
+```ruby
+position1 = Navigate::Position.new(-90.0, 180.0)
+position2 = Navigate::Position.new(90.0, 45.0)
+
+Navigate::bearing(position1, position2)
+# => 292.5
+```
+
+### Return a new position based on a initial position, bearing and distance
+```ruby
+position1 = Navigate::Position.new(-90.0, 180.0)
+
+Navigate::bearing(position1)
+# => #<Navigate::Position:0x00000003edc7b0 @latitude=-89.10067966450693, @longitude=-90.0>
+```
+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> 
+```
+
+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
+-------
+The navigate gem is distributed under the MIT License.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "navigate"
+  gem.homepage = "http://github.com/jonatasrancan/navigate"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem to help you calculate the distance, bearing or the next position on the globe}
+  gem.description = %Q{A gem to help you calculate the distance, bearing or the next position on the globe}
+  gem.email = "jonatasrancan@gmail.com"
+  gem.authors = ["Jônatas Rancan de Souza"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "navigate #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/navigate/conversions.rb

@@ -0,0 +1,16 @@
+class Float
+  # degrees to radians
+  def to_radians
+    self * Math::PI / 180.0
+  end
+
+  # radians to bearing
+  def to_bearing
+    (self.to_degrees + 360.0) % 360.0
+  end
+
+  # radians to degree
+  def to_degrees
+    self * 180 / Math::PI
+  end
+end

data/lib/navigate/position.rb

@@ -0,0 +1,29 @@
+module Navigate
+  class Position
+    attr_accessor :latitude, :longitude
+
+    def initialize(latitude, longitude)
+      @latitude = latitude
+      @longitude = longitude
+
+      valid?
+    end
+
+    private
+
+    def valid_latitude?
+      raise 'Latitude must be between -90.0 and 90.0' unless (-90.0..90.0).include? latitude
+    end
+
+    def valid_longitude?
+      raise 'Longitude must be between -180.0 and 180.0' unless (-180.0..180.0).include? longitude
+    end
+
+    def valid?
+      valid_latitude?
+      valid_longitude?
+
+      true
+    end
+  end
+end

data/lib/navigate.rb

@@ -0,0 +1,47 @@
+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]
+  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
+  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
+  end
+end
+
+path = File.expand_path(File.dirname(__FILE__))
+$:.unshift path unless $:.include?(path)
+require 'navigate/conversions'
+require 'navigate/position'

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+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 'minitest/autorun'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'navigate'
+
+class MiniTest::Test
+end

data/test/test_navigate.rb

@@ -0,0 +1,71 @@
+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)
+
+      Navigate::distance_between(position1, position2).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.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.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)
+    end
+
+    it 'calculates the bearing between 2 positions' do
+      bearing = Navigate::bearing(@position1, @position2)
+
+      bearing.must_equal 180
+    end
+
+    it 'calculates the bearing between 2 positions' do
+      bearing = Navigate::bearing(@position2, @position1)
+
+      bearing.must_equal 0
+    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)
+
+      assert_kind_of Navigate::Position, destination
+
+      destination.longitude.round(2).must_equal -150.0
+      destination.latitude.round(2).must_equal 89.1
+    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.longitude.round(2).must_equal 30.0
+      destination.latitude.round(2).must_equal 86.67
+    end
+  end
+end

data/test/test_position.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+describe Navigate::Position do
+  context 'validations fails' do
+    it "raise an exception when latitude isn't between -90 and 90" do
+
+      exception = assert_raises(RuntimeError) { Navigate::Position.new(200, 100) }
+
+      assert_match /Latitude must be between -90.0 and 90.0/, exception.message
+    end
+
+    it "raise an exception when longitude isn't between -180 and 180" do
+
+      exception = assert_raises(RuntimeError) { Navigate::Position.new(50, 200) }
+
+      assert_match /Longitude must be between -180.0 and 180.0/, exception.message
+    end
+  end
+
+  context 'validations pass' do
+    it "create a new Navigate::Positions" do
+      position = Navigate::Position.new(90.0, 100.0)
+
+      assert_kind_of Navigate::Position, position
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: navigate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jônatas Rancan de Souza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: A gem to help you calculate the distance, bearing or the next position
+  on the globe
+email: jonatasrancan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/navigate.rb
+- lib/navigate/conversions.rb
+- lib/navigate/position.rb
+- test/helper.rb
+- test/test_navigate.rb
+- test/test_position.rb
+homepage: http://github.com/jonatasrancan/navigate
+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.3
+signing_key: 
+specification_version: 4
+summary: A gem to help you calculate the distance, bearing or the next position on
+  the globe
+test_files: []
+has_rdoc: