geo_position 0.0.1 → 0.0.2

data/lib/geo_position/conversion/dms.rb

@@ -13,13 +13,11 @@ module GeoPosition
     #   => -12.061783333333333
     #
     class Dms
-      # Error that is raised if invalid directions are provided
-      InvalidDirectionError = Class.new(StandardError)
-
       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]
@@ -29,35 +27,55 @@ module GeoPosition
       #
       # @return [void]
       def initialize(degrees, minutes, seconds, direction)
-        raise InvalidDirectionError.new("Please provided a direction of N, S, E, or W") unless valid_direction?(direction)
+        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)
 
-        @degrees = degrees
+        @degrees = degrees # Can only be between 0 and 360
         @minutes = minutes
         @seconds = seconds
 
         @direction = direction
       end
 
+      # Returns the coerced degrees
+      #
+      # @return [Float] Positive float of the provided degrees
       def degrees
-        @degrees.to_f
+        @degrees.to_f.abs
       end
 
+      # Returns the coerced minutes
+      #
+      # @return [Float]
       def minutes
         @minutes.to_f
       end
 
+      # Returns the coerced seconds
+      #
+      # @return [Float]
       def seconds
         @seconds.to_f
       end
 
+      # Returns the uppercased direction
+      #
+      # @return [String] Uppercase direction
       def direction
         @direction.to_s.upcase
       end
 
+      # Returns the formatted string
+      #
+      # @return [String]
       def to_s
         "%s deg %s' %s\" %s" % [self.degrees.to_i, self.minutes.to_i, self.seconds, self.direction]
       end
 
+      # Returns the converted DMS to a float for use with latitude/longitude
+      #
+      # @return [Float]
       def to_f
         convert!
       end
@@ -67,6 +85,14 @@ module GeoPosition
         ALLOWED_DIRECTIONS.include?(dir[0,1])
       end
 
+      def valid_floats?(collection)
+        collection.all? { |arg| arg.respond_to?(:to_f) }
+      end
+
+      def valid_degrees?(deg)
+        deg.to_f.abs.between?(0.0, 360.0)
+      end
+
       def convert!
         result = (self.degrees + ((self.minutes/MINUTES_CONVERSION) + (self.seconds/SECONDS_CONVERSION)))
         if negative? then -(result) else result end

data/lib/geo_position/error/invalid_degrees_error.rb

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

data/lib/geo_position/error/invalid_direction_error.rb

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

data/lib/geo_position/error/invalid_float_error.rb

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

data/lib/geo_position/error.rb

@@ -0,0 +1,7 @@
+module GeoPosition
+  module Error
+    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')
+  end
+end

data/lib/geo_position/version.rb

@@ -1,3 +1,3 @@
 module GeoPosition
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/geo_position.rb

@@ -3,6 +3,9 @@ root = File.expand_path(File.dirname(__FILE__))
 # Version
 require File.join(root, 'geo_position', 'version')
 
+# Errors
+require File.join(root, 'geo_position', 'error')
+
 # Conversions
 require File.join(root, 'geo_position', 'conversion')
 require File.join(root, 'geo_position', 'conversion', 'dms')

data/spec/conversion/dms_spec.rb

@@ -1,7 +1,3 @@
-# With negative numbers
-# With nil
-# With empty strings
-# With strings
 require 'spec_helper'
 
 describe GeoPosition::Conversion::Dms do
@@ -15,8 +11,18 @@ describe GeoPosition::Conversion::Dms do
     subject.should respond_to(:to_s)
   end
 
-  it "raises an exception if invalid direction is given" do
-    lambda { described_class.new(12,12,23,'r') }.should raise_error(GeoPosition::Conversion::Dms::InvalidDirectionError)
+  context('Error Handling') do
+    it "raises an exception if invalid direction is given" do
+      lambda { described_class.new(12,12,23,'r') }.should raise_error(GeoPosition::Error::InvalidDirectionError)
+    end
+
+    it "raises an InvalidFloatError if any arguments can't be coerced to a float" 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)
+    end
   end
 
   it "coerces the degrees to a float" do
@@ -44,6 +50,26 @@ describe GeoPosition::Conversion::Dms do
     subject.to_f.should eql(-12.061783333333333)
   end
 
+  it "returns 0's if nil is provided" do
+    gp = described_class.new(nil, nil, nil, 'N')
+    gp.to_f.should eql(0.0)
+  end
+
+  it "returns 0's if empty strings are provided" do
+    gp = described_class.new('', '', '', 'N')
+    gp.to_f.should eql(0.0)
+  end
+
+  it "ensures the degrees are always positive" do
+    gp = described_class.new(-12, 3, 42.42, 'w')
+    gp.to_f.should eql(-12.061783333333333)
+  end
+
+  it "coerces string arguments to floats" do
+    gp = described_class.new('12', '3', '42.42', 'w')
+    gp.to_f.should eql(-12.061783333333333)
+  end
+
   context("North") do
     subject { described_class.new(12,3,42.42,'n') }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_position
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -93,6 +93,10 @@ files:
 - lib/geo_position.rb
 - lib/geo_position/conversion.rb
 - lib/geo_position/conversion/dms.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_float_error.rb
 - lib/geo_position/parser.rb
 - lib/geo_position/version.rb
 - reload_yard
@@ -112,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4563760366661124322
+      hash: 438636080150112414
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4563760366661124322
+      hash: 438636080150112414
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24