cartier 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Patrick Jones
+
+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,32 @@
+# Cartier
+
+    Cartier is a gem used to simplify some common GPS type calcuations from a current project I've been working on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cartier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cartier
+
+## Usage
+
+    After installation one will need to create at minimum two instances of the Cartier::GPSLocation type.
+    For example, the CN Tower location would be created as such: cn_tower = Cartier::GPSLocation.new("43.64775237227008", "-79.38707828521729")
+    To determine the distance between two locations: Cartier::Navigation.haversine_distance(cn_tower, ago)
+    
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cartier.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cartier/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Patrick Jones"]
+  gem.email         = ["patrick@patrickjones.ca"]
+  gem.description   = %q{Cartier is a gem to be used to simply dealing with GPS data calculations such as distance, location, and bearing.}
+  gem.summary       = %q{Cartier is a gem to be used to simply dealing with GPS data calculations such as distance, location, and bearing.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cartier"
+  gem.require_paths = ["lib"]
+  gem.version       = Cartier::VERSION
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "factory_girl"
+end

data/lib/cartier.rb

@@ -0,0 +1,7 @@
+require "cartier/version"
+require "cartier/navigation"
+require "cartier/gps_location"
+
+module Cartier
+  
+end

data/lib/cartier/gps_location.rb

@@ -0,0 +1,24 @@
+module Cartier
+  class GPSLocation
+    attr_accessor :latitude, :longitude, :decimal_notation, :imperial
+    #
+    #
+    # * *Args*    :
+    #   - +latitude+ -> Latitude in Degree Notation (i.e. 37.0428759)
+    #   - +longitude+ -> Longitude in Degree Notation (i.e. 37.0428759)
+    #   - +decimal_notation+ -> Defaulting to true for now
+    #   - +imperial+ -> Defaulting to Imperial system instead of metric (for now)
+    # * *Returns* :
+    #   - a GPSLocation object
+    # * *Raises* :
+    #  - ++ ->
+    #
+    def initialize(latitude=nil, longitude=nil, decimal_notation=true, imperial=true)
+      self.latitude = latitude
+      self.longitude = longitude
+      self.decimal_notation = decimal_notation
+      self.imperial = imperial
+    end  
+    
+  end
+end

data/lib/cartier/navigation.rb

@@ -0,0 +1,62 @@
+module Cartier
+
+  # Encapsulating class for Navigation calculations
+  class Navigation
+    EARTH_RADIUS = 6371
+    
+    #
+    #
+    # * *Args*    :
+    #   - +location+ -> GPSLocation object representing current location
+    #   - +longitude+ -> GPSLocation object representing current destination
+    # * *Returns* :
+    #   - distance in miles
+    
+    def self.haversine_distance(location, destination)
+      delta_lat = (destination.latitude.to_f - location.latitude.to_f) * Math::PI/180
+      delta_long = (destination.longitude.to_f - location.longitude.to_f) * Math::PI/180
+    
+      latitude_1 = (location.latitude.to_f) * Math::PI/180
+      latitude_2 = (destination.latitude.to_f) * Math::PI/180
+    
+      a = Math.sin(delta_lat/2)**2 + Math.sin(delta_long/2)**2 * Math.cos(latitude_1) * Math.cos(latitude_2)
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
+      EARTH_RADIUS * c  
+    end
+    
+    #
+    #
+    # * *Args*    :
+    #   - +location_here+ -> GPSLocation object representing current location
+    #   - +array_of_locations+ -> an Array of GPSLocation objects
+    # * *Returns* :
+    #   - GPSLocation object representing closest location
+    #
+    def self.closest_point(location_here, array_of_locations=nil)
+      array_of_locations.sort do |a, b| 
+        self.haversine_distance(location_here, a) <=> self.haversine_distance(location_here, b) 
+      end.first
+    end
+    
+    #
+    #
+    # * *Args*    :
+    #   - +location+ -> GPSLocation object representing current location
+    #   - +destination+ -> GPSLocation object representing destination
+    # * *Returns* :
+    #   - Bearing in Degrees (not radians)
+    #
+    def self.get_bearing(location, destination)
+      location_long = location.longitude.to_f
+      location_latitude = location.latitude.to_f
+      destination_long = destination.longitude.to_f
+      destination_latitude = destination.latitude.to_f
+      
+      delta_long = (destination_long - location_long)
+      y = Math.sin(delta_long) * Math.cos(destination_latitude)
+      x = Math.cos(location_latitude) * Math.sin(destination_latitude) - Math.sin(location_latitude) * Math.cos(destination_latitude) * Math.cos(delta_long)
+      (Math.atan2(y, x) / Math::PI) * 180
+    end
+    
+  end
+end

data/lib/cartier/version.rb

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

data/spec/cartier_spec.rb

@@ -0,0 +1,8 @@
+
+describe "Cartier" do
+
+  it "should exist and function" do
+    Cartier.should be_a Module
+  end
+
+end

data/spec/factories/location_factory.rb

@@ -0,0 +1,25 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+  
+  factory :cn_tower, class: Cartier::GPSLocation do |f|
+    f.latitude  "43.64775237227008"
+    f.longitude "-79.38707828521729"
+  end
+  
+  factory :ago, class: Cartier::GPSLocation do
+    latitude "43.653476"
+    longitude "-79.392686"
+  end
+  
+  factory :washington_monument, class: Cartier::GPSLocation do
+    latitude "38.89514125082739"
+    longitude "-77.03527450561523"
+  end
+  
+  factory :union_station, class: Cartier::GPSLocation do
+    latitude "38.897102"
+    longitude "-77.006355"
+  end
+  
+end

data/spec/gps_location_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'factories/location_factory'
+
+include Cartier
+
+describe "Cartier::GPSLocation" do
+  
+  it "GPSLocation should build correctly" do
+    @location = FactoryGirl.build(:cn_tower)
+    @location.latitude.should ==  "43.64775237227008"
+    @location.longitude.should == "-79.38707828521729"
+  end
+  
+end

data/spec/naviation_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'factories/location_factory'
+
+include Cartier
+
+describe Cartier::Navigation do
+  it "distance to self should be 0.0" do
+    @location = FactoryGirl.build(:cn_tower)
+    Cartier::Navigation.haversine_distance(@location, @location).should == 0.0
+  end
+  
+  it "distance to washington monument should not be zero" do
+    @cn_tower = FactoryGirl.build(:cn_tower)
+    @washington_monument = FactoryGirl.build(:washington_monument)
+    Cartier::Navigation.haversine_distance(@cn_tower, @washington_monument).should == 563.7658958719776
+  end
+  
+  it ".closest_point should find the closest point" do
+    @here = FactoryGirl.build(:cn_tower)
+    @ago = FactoryGirl.build(:ago)
+    @washington_monument = FactoryGirl.build(:washington_monument)
+    Cartier::Navigation.closest_point(@here, [@ago, @washington_monument]).should == @ago
+  end
+  
+  it ".get_bearing should calculate the bearing between cn_tower and ago properly" do
+    @here = FactoryGirl.build(:cn_tower)
+    @ago = FactoryGirl.build(:ago)
+    Cartier::Navigation.get_bearing(@here, @ago).should == -42.86284026213279
+  end
+  
+  it ".get_bearing should calculate the bearing between two points" do
+    @here = FactoryGirl.build(:cn_tower)
+    @ago = FactoryGirl.build(:washington_monument)
+    Cartier::Navigation.get_bearing(@here, @ago).should == 18.121412196238214
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cartier'
+require 'rspec'
+require 'factory_girl'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cartier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Patrick Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: Cartier is a gem to be used to simply dealing with GPS data calculations
+  such as distance, location, and bearing.
+email:
+- patrick@patrickjones.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cartier.gemspec
+- lib/cartier.rb
+- lib/cartier/gps_location.rb
+- lib/cartier/navigation.rb
+- lib/cartier/version.rb
+- spec/cartier_spec.rb
+- spec/factories/location_factory.rb
+- spec/gps_location_spec.rb
+- spec/naviation_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Cartier is a gem to be used to simply dealing with GPS data calculations
+  such as distance, location, and bearing.
+test_files:
+- spec/cartier_spec.rb
+- spec/factories/location_factory.rb
+- spec/gps_location_spec.rb
+- spec/naviation_spec.rb
+- spec/spec_helper.rb