geo_position 0.0.3 → 0.0.5

data/README.md

@@ -3,7 +3,8 @@
 A simple utility to allow you to convert DMS (Degrees, Minutes, Seconds)
 to a latitude and longitude. The initial driver for this utility was
 working on an application that took Geo Position information from EXIF
-data. 
+data and converted it to lat/lon for use in both the database storage
+and querying Google's API.
 
 ## Installation
 
@@ -21,7 +22,11 @@ Or install it yourself as:
 
 ## Usage
 
-Usage is very simple right now:
+I prefer smaller components that can be put together in different ways.
+
+Usage is simple:
+
+### Convert from Degrees, Minutes, Seconds, and Direction to a float
 
 ```ruby
 # This can be any positive number between 0 and 360. It will be coerced
@@ -47,12 +52,52 @@ conversion.to_f
 => -12.061783333333333
 ```
 
+### Convert from Latitude to DMS
+```ruby
+latitude = "70.4947"
+
+conversion = GeoPosition::Conversion::Latitude.new(latitude)
+
+conversion.to_s
+=> "70 deg 29' 40\" N"
+```
+
+### Convert from Longitude to DMS
+```ruby
+longitude = "-157.441"
+
+conversion = GeoPosition::Conversion::Longitude.new(longitude)
+
+conversion.to_s
+=> "157 deg 26' 27\" W"
+```
+
+### Parsing from a DMS string
+```ruby
+dms_string = "77 deg 8 42.00 W"
+
+parser = GeoPosition::Parser::Dms.new(dms_string)
+
+parser.degrees
+=> 77
+
+parser.minutes
+=> 8
+
+parser.seconds
+=> 42.0
+
+parser.direction
+=> "W"
+
+parser.to_hash
+=> {:degrees=>77, :minutes=>8, :seconds=>42.0, :direction=>"W"}
+```
+
+
+
 ## Todo
 
-* Add ability to parse from the EXIF string and extract into the
-  conversion object
-* Add ability to convert from lat/lon to DMS
-* Add simple methods in the root object to handle conversions
 * Add a command line component
 
 ## Contributing

data/lib/geo_position/conversion/dms.rb

@@ -13,12 +13,12 @@ module GeoPosition
     #   => -12.061783333333333
     #
     class Dms
-      ALLOWED_DEGREES    = (0.0..360.0)
+      ALLOWED_SECONDS    = (0.0..60.0)
+      ALLOWED_DEGREES    = (0.0..180.0)
       ALLOWED_DIRECTIONS = %w( N n E e S s W w )
       MINUTES_CONVERSION = 60
       SECONDS_CONVERSION = 3600
 
-
       # Creates a new instance of the DMS conversion object
       #
       # @param degrees [String,Integer]
@@ -31,8 +31,10 @@ module GeoPosition
         raise GeoPosition::Error::InvalidDirectionError.new("Please provided a direction of N, S, E, or W") unless valid_direction?(direction)
         raise GeoPosition::Error::InvalidFloatError.new("Arguments could not be coerced to a float") unless valid_floats?([degrees, minutes, seconds])
         raise GeoPosition::Error::InvalidDegreesError.new("Degrees must be between 0 and 360. %s was provided" % [degrees]) unless valid_degrees?(degrees)
+        raise GeoPosition::Error::InvalidMinutesError.new("Minutes must be between 0 and 60. %s was provided" % [minutes]) unless valid_minutes?(minutes)
+        raise GeoPosition::Error::InvalidSecondsError.new("Seonds must be between 0 and 60. %s was provided" % [seconds]) unless valid_seconds?(seconds)
 
-        @degrees = degrees # Can only be between 0 and 360
+        @degrees = degrees
         @minutes = minutes
         @seconds = seconds
 
@@ -94,9 +96,17 @@ module GeoPosition
         ALLOWED_DEGREES.include?(deg.to_f.abs)
       end
 
+      def valid_minutes?(min)
+        ALLOWED_SECONDS.include?(min.to_f.abs)
+      end
+
+      def valid_seconds?(sec)
+        ALLOWED_SECONDS.include?(sec.to_f.abs)
+      end
+
       def convert!
         result = (self.degrees + ((self.minutes/MINUTES_CONVERSION) + (self.seconds/SECONDS_CONVERSION)))
-        if negative? then -(result) else result end
+        if negative? then (result * -1) else result end
       end
 
       def negative?

data/lib/geo_position/conversion/latitude.rb

@@ -0,0 +1,62 @@
+module GeoPosition
+  module Conversion
+    class Latitude
+      BOUNDS = (-90.0..90.0)
+
+      def initialize(latitude)
+        raise GeoPosition::Error::InvalidFloatError.new("Arguments could not be coerced to a float") unless valid_float?(latitude)
+        raise GeoPosition::Error::InvalidLatitudeError.new("Latitde must be between -90 and 90 degrees: %s provided" % [latitude]) unless within_bounds?(latitude)
+
+        @latitude = latitude.to_f
+
+        @degrees = 0
+        @minutes = 0
+        @seconds = 0
+
+        convert!
+      end
+
+      def degrees
+        @degrees
+      end
+
+      def minutes
+        @minutes
+      end
+
+      def seconds
+        @seconds
+      end
+
+      def direction
+        determine_direction
+      end
+
+      def to_s
+        "%s deg %s' %s\" %s" % [self.degrees, self.minutes, self.seconds, self.direction]
+      end
+
+      private
+      def within_bounds?(lat)
+        BOUNDS.include?(lat.to_f)
+      end
+
+      def valid_float?(lat)
+        lat.respond_to?(:to_f)
+      end
+
+      def convert!
+        decimal = @latitude.abs
+        @degrees = decimal.floor
+
+        initial_seconds = (decimal - @degrees) * 3600
+        @minutes = initial_seconds.floor / 60
+        @seconds = (initial_seconds - (@minutes * 60)).floor
+      end
+
+      def determine_direction
+        if @latitude < 0 then 'S' else 'N' end
+      end
+    end
+  end
+end

data/lib/geo_position/conversion/longitude.rb

@@ -0,0 +1,62 @@
+module GeoPosition
+  module Conversion
+    class Longitude
+      BOUNDS = (-180.0..180.0)
+
+      def initialize(longitude)
+        raise GeoPosition::Error::InvalidFloatError.new("Arguments could not be coerced to a float") unless valid_float?(longitude)
+        raise GeoPosition::Error::InvalidLongitudeError.new("Latitde must be between -180 and 180 degrees: %s provided" % [longitude]) unless within_bounds?(longitude)
+
+        @longitude = longitude.to_f
+
+        @degrees = 0
+        @minutes = 0
+        @seconds = 0
+
+        convert!
+      end
+
+      def degrees
+        @degrees
+      end
+
+      def minutes
+        @minutes
+      end
+
+      def seconds
+        @seconds
+      end
+
+      def direction
+        determine_direction
+      end
+
+      def to_s
+        "%s deg %s' %s\" %s" % [self.degrees, self.minutes, self.seconds, self.direction]
+      end
+
+      private
+      def within_bounds?(lat)
+        BOUNDS.include?(lat.to_f)
+      end
+
+      def valid_float?(lat)
+        lat.respond_to?(:to_f)
+      end
+
+      def convert!
+        decimal = @longitude.abs
+        @degrees = decimal.floor
+
+        initial_seconds = (decimal - @degrees) * 3600
+        @minutes = initial_seconds.floor / 60
+        @seconds = (initial_seconds - (@minutes * 60)).floor
+      end
+
+      def determine_direction
+        if @longitude < 0 then 'W' else 'E' end
+      end
+    end
+  end
+end

data/lib/geo_position/error/invalid_dms_string_error.rb

@@ -0,0 +1,6 @@
+module GeoPosition
+  module Error
+    class InvalidDmsStringError < StandardError
+    end
+  end
+end

data/lib/geo_position/error/invalid_latitude_error.rb

@@ -0,0 +1,6 @@
+module GeoPosition
+  module Error
+    class InvalidLatitudeError < StandardError
+    end
+  end
+end

data/lib/geo_position/error/invalid_longitude_error.rb

@@ -0,0 +1,6 @@
+module GeoPosition
+  module Error
+    class InvalidLongitudeError < StandardError
+    end
+  end
+end

data/lib/geo_position/error/invalid_minutes_error.rb

@@ -0,0 +1,6 @@
+module GeoPosition
+  module Error
+    class InvalidMinutesError < StandardError
+    end
+  end
+end

data/lib/geo_position/error/invalid_seconds_error.rb

@@ -0,0 +1,6 @@
+module GeoPosition
+  module Error
+    class InvalidSecondsError < StandardError
+    end
+  end
+end

data/lib/geo_position/error.rb

@@ -3,5 +3,11 @@ module GeoPosition
     autoload :InvalidDirectionError,    File.join(File.dirname(__FILE__), 'error/invalid_direction_error')
     autoload :InvalidFloatError,        File.join(File.dirname(__FILE__), 'error/invalid_float_error')
     autoload :InvalidDegreesError,      File.join(File.dirname(__FILE__), 'error/invalid_degrees_error')
+    autoload :InvalidMinutesError,      File.join(File.dirname(__FILE__), 'error/invalid_minutes_error')
+    autoload :InvalidSecondsError,      File.join(File.dirname(__FILE__), 'error/invalid_seconds_error')
+
+    autoload :InvalidDmsStringError,    File.join(File.dirname(__FILE__), 'error/invalid_dms_string_error')
+    autoload :InvalidLatitudeError,     File.join(File.dirname(__FILE__), 'error/invalid_latitude_error')
+    autoload :InvalidLongitudeError,    File.join(File.dirname(__FILE__), 'error/invalid_longitude_error')
   end
 end

data/lib/geo_position/parser/dms.rb

@@ -0,0 +1,49 @@
+module GeoPosition
+  module Parser
+    class Dms
+      FORMAT_REGEX = Regexp.new(/^(?<degrees>[\d]+)\s{1}[^\d]*(?<minutes>[\d]+)\s{1}(?<seconds>[\d]+(\.?[\d]+))\s{1}(?<direction>[nNsSeEwW]{1})/)
+
+      def initialize(dms_string)
+        sanitize_string!(dms_string)
+
+        raise GeoPosition::Error::InvalidDmsStringError.new('String could not be parsed') unless valid_string?(dms_string)
+
+        @dms_string = dms_string.to_s
+      end
+
+      def degrees
+        parsed[:degrees].to_i
+      end
+
+      def minutes
+        parsed[:minutes].to_i
+      end
+
+      def seconds
+        parsed[:seconds].to_f
+      end
+
+      def direction
+        parsed[:direction].upcase
+      end
+
+      def to_hash
+        keys = [:degrees, :minutes, :seconds, :direction]
+        keys.inject({}) { |hsh, key| hsh[key] = self.send(key); hsh }
+      end
+
+      private
+      def valid_string?(str)
+        FORMAT_REGEX.match(str.to_s)
+      end
+
+      def sanitize_string!(str)
+        str.gsub!(/['"]/, '')
+      end
+
+      def parsed
+        @dms_string.match(FORMAT_REGEX)
+      end
+    end
+  end
+end

data/lib/geo_position/version.rb

@@ -1,3 +1,3 @@
 module GeoPosition
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/geo_position.rb

@@ -9,9 +9,26 @@ require File.join(root, 'geo_position', 'error')
 # Conversions
 require File.join(root, 'geo_position', 'conversion')
 require File.join(root, 'geo_position', 'conversion', 'dms')
+require File.join(root, 'geo_position', 'conversion', 'latitude')
+require File.join(root, 'geo_position', 'conversion', 'longitude')
 
 # Parsers
 require File.join(root, 'geo_position', 'parser')
+require File.join(root, 'geo_position', 'parser', 'dms')
 
 module GeoPosition
+  def self.from_dms(degrees, minutes, seconds, direction)
+    conversion = GeoPosition::Conversion::Dms.new(degrees, minutes, seconds, direction)
+    conversion.to_f
+  end
+
+  def self.from_latitude(latitude)
+    conversion = GeoPosition::Conversion::Latitude.new(latitude)
+    conversion.to_s
+  end
+
+  def self.from_longitude(longitude)
+    conversion = GeoPosition::Conversion::Longitude.new(longitude)
+    conversion.to_s
+  end
 end

data/spec/conversion/dms_spec.rb

@@ -20,8 +20,16 @@ describe GeoPosition::Conversion::Dms do
       lambda { described_class.new([12], [3], [42.42], 'w') }.should raise_error(GeoPosition::Error::InvalidFloatError)
     end
 
-    it "raises an exception if degrees are greater than 360" do
-      lambda{ described_class.new(361, 12, 123, 'n') }.should raise_error(GeoPosition::Error::InvalidDegreesError)
+    it "raises an exception if degrees are greater than 180" do
+      lambda{ described_class.new(181, 12, 123, 'n') }.should raise_error(GeoPosition::Error::InvalidDegreesError)
+    end
+
+    it "raises an exception if minutes are greater than 60" do
+      lambda { described_class.new(12, 61, 12, 'n') }.should raise_error(GeoPosition::Error::InvalidMinutesError)
+    end
+
+    it "raises an exception if seconds are greater than 60" do
+      lambda { described_class.new(12, 30, 61, 'n') }.should raise_error(GeoPosition::Error::InvalidSecondsError)
     end
   end
 

data/spec/conversion/latitude_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe GeoPosition::Conversion::Latitude do
+  let(:latitude) { '70.4947' }
+  subject { described_class.new(latitude) }
+
+  context('Error Handling') do
+    it "raises an exception if latitude is greater than 90" do
+      lambda { described_class.new(91) }.should raise_error(GeoPosition::Error::InvalidLatitudeError)
+    end
+
+    it "raises an exception if latitude is greater than -90" do
+      lambda { described_class.new(-91) }.should raise_error(GeoPosition::Error::InvalidLatitudeError)
+    end
+
+    it "raises an exception if latitude cannot be coerced to a float" do
+      lambda { described_class.new([12]) }.should raise_error(GeoPosition::Error::InvalidFloatError)
+    end
+  end
+
+  it "responds to #to_s" do
+    subject.should respond_to(:to_s)
+  end
+
+  it "returns 'N' for the direction" do
+    subject.direction.should == 'N'
+  end
+
+  it "returns 'S' for the direction" do
+    south = latitude.to_f * -1
+    lc = described_class.new(south)
+    lc.direction.should == 'S'
+  end
+
+  it "returns 70 degrees" do
+    subject.degrees.should eql(70)
+  end
+
+  it "returns 29 minutes" do
+    subject.minutes.should eql(29)
+  end
+
+  it "returns 40 seconds" do
+    subject.seconds.should eql(40)
+  end
+
+  it "returns the DMS string" do
+    subject.to_s.should == "70 deg 29' 40\" N"
+  end
+end

data/spec/conversion/longitude_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe GeoPosition::Conversion::Longitude do
+  let(:longitude) { '-157.441' }
+  subject { described_class.new(longitude) }
+
+  context('Error Handling') do
+    it "raises an exception if longitude is greater than 180" do
+      lambda { described_class.new(181) }.should raise_error(GeoPosition::Error::InvalidLongitudeError)
+    end
+
+    it "raises an exception if longitude is greater than -180" do
+      lambda { described_class.new(-181) }.should raise_error(GeoPosition::Error::InvalidLongitudeError)
+    end
+
+    it "raises an exception if longitude cannot be coerced to a float" do
+      lambda { described_class.new([12]) }.should raise_error(GeoPosition::Error::InvalidFloatError)
+    end
+  end
+
+  it "responds to #to_s" do
+    subject.should respond_to(:to_s)
+  end
+
+  it "returns 'W' for the direction" do
+    subject.direction.should == 'W'
+  end
+
+  it "returns 'E' for the direction" do
+    east = longitude.to_f * -1
+    lc = described_class.new(east)
+    lc.direction.should == 'E'
+  end
+
+  it "returns 157 degrees" do
+    subject.degrees.should eql(157)
+  end
+
+  it "returns 26 minutes" do
+    subject.minutes.should eql(26)
+  end
+
+  it "returns 27 seconds" do
+    subject.seconds.should eql(27)
+  end
+
+  it "returns the DMS string" do
+    subject.to_s.should == "157 deg 26' 27\" W"
+  end
+end

data/spec/parser/dms_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe GeoPosition::Parser::Dms do
+  let(:dms_string) { "40 deg 20' 13.20\" N" }
+  subject { described_class.new(dms_string) }
+
+  context('Error Handling') do
+    it "raises an exception if the string is not in an accepted format" do
+      lambda { described_class.new('invalid format') }.should raise_error(GeoPosition::Error::InvalidDmsStringError)
+    end
+  end
+
+  context("Simple format") do
+    let(:simple_string) { "12 12 42.42 n" }
+    subject { described_class.new(simple_string) }
+
+    it "returns 12 degrees" do
+      subject.degrees.should eql(12)
+    end
+
+    it "returns 12 minutes" do
+      subject.minutes.should eql(12)
+    end
+
+    it "returns 42.42 seconds" do
+      subject.seconds.should eql(42.42)
+    end
+
+    it "returns 'W' for the direction" do
+      subject.direction.should == "N"
+    end
+
+    it "serializes to a hash" do
+      expected = {
+        :degrees   => 12,
+        :minutes   => 12,
+        :seconds   => 42.42,
+        :direction => 'N'
+      }
+      subject.to_hash.should == expected
+    end
+  end
+
+  context("With 'deg' in the name") do
+    it "returns 40 degrees" do
+      subject.degrees.should eql(40)
+    end
+
+    it "returns 20 minutes" do
+      subject.minutes.should eql(20)
+    end
+
+    it "returns 13.20 seconds" do
+      subject.seconds.should eql(13.20)
+    end
+
+    it "returns 'N' for the direction" do
+      subject.direction.should  == "N"
+    end
+
+    it "serializes to a hash" do
+      expected = {
+        :degrees   => 40,
+        :minutes   => 20,
+        :seconds   => 13.20,
+        :direction => 'N'
+      }
+      subject.to_hash.should == expected
+    end
+  end
+
+  it "responds to #degrees" do
+    subject.should respond_to(:degrees)
+  end
+
+  it "responds to #minutes" do
+    subject.should respond_to(:minutes)
+  end
+
+  it "responds to #seconds" do
+    subject.should respond_to(:seconds)
+  end
+
+  it "responds to #direction" do
+    subject.should respond_to(:direction)
+  end
+
+  it "responds to #to_hash" do
+    subject.should respond_to(:to_hash)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_position
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-03 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -93,14 +93,25 @@ files:
 - lib/geo_position.rb
 - lib/geo_position/conversion.rb
 - lib/geo_position/conversion/dms.rb
+- lib/geo_position/conversion/latitude.rb
+- lib/geo_position/conversion/longitude.rb
 - lib/geo_position/error.rb
 - lib/geo_position/error/invalid_degrees_error.rb
 - lib/geo_position/error/invalid_direction_error.rb
+- lib/geo_position/error/invalid_dms_string_error.rb
 - lib/geo_position/error/invalid_float_error.rb
+- lib/geo_position/error/invalid_latitude_error.rb
+- lib/geo_position/error/invalid_longitude_error.rb
+- lib/geo_position/error/invalid_minutes_error.rb
+- lib/geo_position/error/invalid_seconds_error.rb
 - lib/geo_position/parser.rb
+- lib/geo_position/parser/dms.rb
 - lib/geo_position/version.rb
 - reload_yard
 - spec/conversion/dms_spec.rb
+- spec/conversion/latitude_spec.rb
+- spec/conversion/longitude_spec.rb
+- spec/parser/dms_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/archivability/geo_position
 licenses: []
@@ -116,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3480515325090187080
+      hash: 1503743246014824343
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3480515325090187080
+      hash: 1503743246014824343
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -134,5 +145,8 @@ specification_version: 3
 summary: Converting between Deciman/Hours/Seconds and Latitude/Longitude
 test_files:
 - spec/conversion/dms_spec.rb
+- spec/conversion/latitude_spec.rb
+- spec/conversion/longitude_spec.rb
+- spec/parser/dms_spec.rb
 - spec/spec_helper.rb
 has_rdoc: