m9t 0.1.2 → 0.1.3

data/lib/m9t.rb

@@ -37,14 +37,16 @@ module M9t
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY = 2
+    TINY = 3
  
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 
+  # Base class for all M9t exceptions
   class M9tError < StandardError
   end
 
+  # Raised when a M9t class receives an unrecogized ':units' value
   class UnitError < M9tError
   end
 

data/lib/m9t/base.rb

@@ -36,8 +36,7 @@ module M9t
     # * +options+ - See individual classes for options
     def initialize(value, options = self.class.options.clone)
       @value, @options = value.to_f, self.class.options.merge(options)
-      raise M9t::UnitError.new("Unknown units '#{ @options[:units] }'. Known: #{ self.class::KNOWN_UNITS.collect{|unit| unit.to_s}.join(', ') }") \
-        if not self.class::KNOWN_UNITS.find_index(@options[:units])
+      units_error(@options[:units]) if not self.class::KNOWN_UNITS.find_index(@options[:units])
     end
 
     # Returns the string representation of the measurement,
@@ -53,6 +52,11 @@ module M9t
       "#{ localized_value }%s#{ unit }" % (@options[:abbreviated] ? '' : ' ')
     end
 
+    private
+
+    def units_error(units)
+      raise M9t::UnitError.new("Unknown units '#{ units }'. Known: #{ self.class::KNOWN_UNITS.collect{|unit| unit.to_s}.join(', ') }")
+    end
   end
 
 end

data/lib/m9t/direction.rb

@@ -4,6 +4,7 @@ require 'i18n'
 
 module M9t
 
+  # Represents a geographical direction
   class Direction
     DEFAULT_OPTIONS = {:units => :degrees, :abbreviated => false, :decimals => 5}
     KNOWN_UNITS     = [:degrees, :compass]
@@ -17,35 +18,35 @@ module M9t
     class << self
 
       # Identity conversion. Simply returns the supplied number
-      def to_degrees(d)
-        d.to_f
+      def to_degrees(degrees)
+        degrees.to_f
       end
 
       # Given a value in degrees, returns the nearest (localized) compass direction
       #  M9t::Directions.to_compass(42) => 'NE'
-      def to_compass(d)
-        sector = (normalize(d) / COMPASS_SECTOR_DEGREES).round
+      def to_compass(degrees)
+        sector = (normalize(degrees) / COMPASS_SECTOR_DEGREES).round
         I18n.t(self.measurement_name + '.sectors')[sector]
       end
 
       # Accepts a localized compass direction (e.g. 'N') and returns the equivalent M9t::Direction
       #  M9t::Direction.compass('NE') => #<M9t::Direction:0xb76cc750 @value=45.0, @options={:units=>:degrees, :decimals=>5, :abbreviated=>false}>
-      def compass(s)
-        sector = I18n.t(self.measurement_name + '.sectors').find_index(s)
-        raise "Compass direction '#{ s }' not recognised" if sector.nil?
+      def compass(compass_direction)
+        sector = I18n.t(self.measurement_name + '.sectors').find_index(compass_direction)
+        raise "Compass direction '#{ compass_direction }' not recognised" if sector.nil?
         new(sector.to_f * COMPASS_SECTOR_DEGREES)
       end
 
       # Reduce directions in degrees to the range [0, 360)
       #  M9t::Direction.normalize(1000) => 280.0
-      def normalize(d)
+      def normalize(degrees)
         case
-        when d < 0
-          normalize(d + CIRCLE)
-        when d >= CIRCLE
-          normalize(d - CIRCLE)
+        when degrees < 0
+          normalize(degrees + CIRCLE)
+        when degrees >= CIRCLE
+          normalize(degrees - CIRCLE)
         else
-          d
+          degrees
         end
       end
 

data/lib/m9t/distance.rb

@@ -5,6 +5,7 @@ require File.join(File.expand_path(File.dirname(__FILE__)), 'base')
 
 module M9t
 
+  # Represents a distance
   class Distance
     DEFAULT_OPTIONS      = {:units => :meters, :abbreviated => false, :precision => 5}
     KNOWN_UNITS          = [:meters, :miles, :kilometers]
@@ -23,23 +24,23 @@ module M9t
       end
 
       # Accepts a value in miles and returns the equivalent M9t::Distance
-      def miles(m, options = {})
-        new(m.to_f * METERS_PER_MILE, options)
+      def miles(miles, options = {})
+        new(miles.to_f * METERS_PER_MILE, options)
       end
 
       # Identity conversion. Simply returns the supplied number
-      def to_meters(m)
-        m.to_f
+      def to_meters(meters)
+        meters.to_f
       end
 
       # Converts meters into kilometers
-      def to_kilometers(m)
-        m.to_f / METERS_PER_KILOMETER
+      def to_kilometers(meters)
+        meters.to_f / METERS_PER_KILOMETER
       end
 
       # Converts meters into miles
-      def to_miles(m)
-        m.to_f / METERS_PER_MILE
+      def to_miles(meters)
+        meters.to_f / METERS_PER_MILE
       end
 
     end

data/lib/m9t/i18n.rb

@@ -8,10 +8,10 @@ module I18n
   # Handle non-English numerical separators
   # with I18n.locale = :it,
   #   I18n.localize_float(5.23) => '5,23000'
-  def I18n.localize_float(f, options = {})
+  def I18n.localize_float(float, options = {})
     format = options[:format] || '%f'
-    s = format % f
-    integers, decimal = s.split('.')
+    english = format % float
+    integers, decimal = english.split('.')
     integers ||= ''
 
     thousands_separator = I18n.t('numbers.thousands_separator')

data/lib/m9t/speed.rb

@@ -5,6 +5,7 @@ require File.join(File.expand_path(File.dirname(__FILE__)), 'distance')
 
 module M9t
 
+  # Represents a speed
   class Speed
     DEFAULT_OPTIONS = {:units => :meters_per_second, :abbreviated => false, :precision => 5}
     KNOWN_UNITS     = [:meters_per_second, :kilometers_per_hour, :miles_per_hour, :knots]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Joe Yates