m9t 0.1.0 → 0.1.2

data/README.rdoc

@@ -1,20 +1,23 @@
 == m9t - Various units of measurement
 
-This package aims to handle the basic units of measure:
-* Distance
-* Temperature
-* Direction
-* Speed
+This package handles the basic units of measure:
+* distance,
+* direction,
+* speed,
+* temperature,
+* weight.
 
 The emphasis is on:
-* coherent interface
-* ease of translation
+* coherent interface,
+* ease of translation (using i18n).
 
 == Other Software
 
 * ruby-units
-  * doesn't handle i18n - very difficult to integrate
-  * monkey patches a lot of core classes
+  * Doesn't handle i18n:
+    * The library depends heavily on English string representations of units.
+  * Monkey patches a lot of core classes:
+    * Adds methods to e.g. Object.
 
 == License
 

data/Rakefile

@@ -22,7 +22,7 @@ spec = Gem::Specification.new do |s|
   s.author      = 'Joe Yates'
   s.email       = 'joe.g.yates@gmail.com'
 
-  s.files         = ['README.rdoc', 'COPYING', 'Rakefile'] + FileList['{lib,test}/**/*.rb']
+  s.files         = ['README.rdoc', 'COPYING', 'Rakefile'] + FileList['{lib,test}/**/*.rb'] + FileList['locales/**/*.{rb,yml}']
   s.require_paths = ['lib']
   s.add_dependency('i18n', '>= 0.3.5')
 

data/lib/m9t.rb

@@ -37,7 +37,7 @@ module M9t
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY = 0
+    TINY = 2
  
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/m9t/base.rb

@@ -6,7 +6,7 @@ module M9t
 
   module Base
 
-    def self.included(base)
+    def self.included(base) #:nodoc:
 
       base.instance_eval do
         # Returns the classes current options - see the specific class for defaults
@@ -32,12 +32,16 @@ module M9t
 
     attr_reader :value, :options
 
+    # ==== Parameters
+    # * +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])
     end
 
+    # Returns the string representation of the measurement,
+    # taking into account locale, desired units and abbreviation.
     def to_s
       value_in_units = self.class.send("to_#{ @options[:units] }", @value)
       localized_value = I18n.localize_float(value_in_units, {:format => "%0.#{ @options[:precision] }f"})

data/lib/m9t/direction.rb

@@ -16,21 +16,28 @@ module M9t
 
     class << self
 
+      # Identity conversion. Simply returns the supplied number
       def to_degrees(d)
-        d
+        d.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
         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?
         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)
         case
         when d < 0
@@ -44,6 +51,7 @@ module M9t
 
     end
 
+    # Handles the special case where compass directions are the desired output.
     def to_s
       if @options[:units] == :compass
         Direction.to_compass(@value)

data/lib/m9t/distance.rb

@@ -17,23 +17,27 @@ module M9t
 
     class << self
 
-      # Unit convertors: convert to meters
-      def miles(m)
-        m.to_f * METERS_PER_MILE
+      # Accepts a value in kilometers and returns the equivalent M9t::Distance
+      def kilometers(km, options = {})
+        new(km.to_f * METERS_PER_KILOMETER, options)
       end
 
-      def kilometers(km)
-        km.to_f * METERS_PER_KILOMETER
+      # Accepts a value in miles and returns the equivalent M9t::Distance
+      def miles(m, options = {})
+        new(m.to_f * METERS_PER_MILE, options)
       end
 
+      # Identity conversion. Simply returns the supplied number
       def to_meters(m)
         m.to_f
       end
 
+      # Converts meters into kilometers
       def to_kilometers(m)
         m.to_f / METERS_PER_KILOMETER
       end
 
+      # Converts meters into miles
       def to_miles(m)
         m.to_f / METERS_PER_MILE
       end
@@ -42,10 +46,12 @@ module M9t
 
     alias :to_meters :value
 
+    # Returns the value converted to kilometers
     def to_kilometers
       self.class.to_kilometers(@value)
     end
 
+    # Returns the value converted to miles
     def to_miles
       self.class.to_miles(@value)
     end

data/lib/m9t/i18n.rb

@@ -2,10 +2,12 @@
 require 'rubygems' if RUBY_VERSION < '1.9'
 require 'i18n'
 
-# Monkey patch I18n, adding:
-# - handling for non-English numerical separators
+# Monkey patch I18n
 module I18n
 
+  # Handle non-English numerical separators
+  # with I18n.locale = :it,
+  #   I18n.localize_float(5.23) => '5,23000'
   def I18n.localize_float(f, options = {})
     format = options[:format] || '%f'
     s = format % f

data/lib/m9t/speed.rb

@@ -18,23 +18,27 @@ module M9t
 
     class << self
 
-      # Unit convertors: convert to meters per second
-      def kilometers_per_hour(kmh)
-        kmh.to_f * MS_TO_KMH
+      # Accepts kilometers per hour and returns a M9t::Speed instance
+      def kilometers_per_hour(kmh, options = {})
+        new(kmh.to_f * MS_TO_KMH, options)
       end
 
-      def miles_per_hour(mph)
-        mph.to_f * MS_TO_MPH
+      # Accepts miles per hour and returns a M9t::Speed instance
+      def miles_per_hour(mph, options = {})
+        new(mph.to_f * MS_TO_MPH, options)
       end
 
+      # Identity conversion. Simply returns the supplied number
       def to_meters_per_second(mps)
         mps.to_f
       end
 
+      # Converts meters per second to kilometers per hour
       def to_kilometers_per_hour(mps)
         mps.to_f / MS_TO_KMH
       end
 
+      # Converts meters per second to miles per hour
       def to_miles_per_hour(mps)
         mps.to_f / MS_TO_MPH
       end
@@ -43,10 +47,12 @@ module M9t
 
     alias :to_meters_per_second :value
 
+    # Returns the value converted to kilometers per hour
     def to_kilometers_per_hour
       self.class.to_kilometers_per_hour(@value)
     end
 
+    # Returns the value converted to miles per hour
     def to_miles_per_hour
       self.class.to_miles_per_hour(@value)
     end

data/locales/en.yml

@@ -0,0 +1,45 @@
+# encoding: utf8
+en:
+  numbers:
+    thousands_separator: ','
+    decimal_separator: '.'
+  units:
+    distance:
+      meters:
+        full:
+          zero: meters
+          one: meter
+          other: meters
+        abbreviated: m
+      kilometers:
+        full:
+          zero: kilometers
+          one: kilometer
+          other: kilometers
+        abbreviated: km
+      miles:
+        full:
+          zero: miles
+          one: mile
+          other: miles
+    direction:
+      degrees:
+        full:
+          zero: degrees
+          one: degree
+          other: degrees
+        abbreviated: °
+    speed:
+      meters_per_second:
+        full:
+          zero: meters per second
+          one: meter per second
+          other: meters per second
+        abbreviated: m/s
+      knots:
+        full:
+          zero: knots
+          one: knot
+          other: knots
+  direction:
+    sectors: ['N', 'NNE', 'NE', 'ENE', 'E', 'ESE', 'SE', 'SSE', 'S', 'SSW', 'SW', 'WSW', 'W', 'WNW', 'NW', 'NNW', 'N']

data/locales/it.yml

@@ -0,0 +1,45 @@
+# encoding: utf8
+it:
+  numbers:
+    thousands_separator: '.'
+    decimal_separator: ','
+  units:
+    distance:
+      meters:
+        full:
+          zero: metri
+          one: metro
+          other: metri
+        abbreviated: m
+      kilometers:
+        full:
+          zero: chilometri
+          one: chilometro
+          other: chilometri
+        abbreviated: km
+      miles:
+        full:
+          zero: miglia
+          one: miglio
+          other: miglia
+    direction:
+      degrees:
+        full:
+          zero: gradi
+          one: grado
+          other: gradi
+        abbreviated: °
+    speed:
+      meters_per_second:
+        full:
+          zero: metri al second
+          one: metro al second
+          other: metri al second
+        abbreviated: m/s
+      knots:
+        full:
+          zero: nodi
+          one: nodo
+          other: nodi
+  direction:
+    sectors: ['N', 'NNE', 'NE', 'ENE', 'E', 'ESE', 'SE', 'SSE', 'S', 'SSO', 'SO', 'OSO', 'O', 'ONO', 'NO', 'NNO', 'N']

data/test/direction_test.rb

@@ -48,8 +48,8 @@ class TestM9tDirection < Test::Unit::TestCase
 
   def test_to_compass
     assert_equal('N', M9t::Direction.to_compass(0))
-    assert_equal('N', M9t::Direction.to_compass(7)) # Quantizing
-    assert_equal('E', M9t::Direction.to_compass(93)) # Quantizing
+    assert_equal('NE', M9t::Direction.to_compass(42)) # Quantizing up
+    assert_equal('E', M9t::Direction.to_compass(93)) # Quantizing down
     assert_equal('ESE', M9t::Direction.to_compass(113)) # 16ths
     I18n.locale = :it
     assert_equal('O', M9t::Direction.to_compass(270))

data/test/distance_test.rb

@@ -37,11 +37,11 @@ class TestM9tDistance < Test::Unit::TestCase
 
   # Conversion from non-SI units
   def test_kilometers
-    assert_equal(300.0, M9t::Distance.kilometers(0.3))
+    assert_equal(300.0, M9t::Distance.kilometers(0.3).value)
   end
 
   def test_miles
-    assert_equal(0.3 * 1609.344, M9t::Distance.miles(0.3))
+    assert_equal(0.3 * 1609.344, M9t::Distance.miles(0.3).value)
   end
 
   # Conversion to non-SI units
@@ -124,7 +124,7 @@ class TestM9tDistance < Test::Unit::TestCase
   end
 
   def test_miles_singular
-    distance = M9t::Distance.new(M9t::Distance.miles(1), {:units => :miles, :precision => 0})
+    distance = M9t::Distance.miles(1, {:units => :miles, :precision => 0})
     I18n.locale = :en
     assert_equal(distance.to_s, '1 mile')
     I18n.locale = :it

data/test/speed_test.rb

@@ -28,7 +28,7 @@ class TestM9tSpeed < Test::Unit::TestCase
   # input conversions
 
   def test_class_miles_per_hour
-    assert_equal(45, M9t::Speed.miles_per_hour(20.1168))
+    assert_equal(45, M9t::Speed.miles_per_hour(20.1168).value)
   end
 
   # output conversions

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Joe Yates
@@ -55,6 +55,8 @@ files:
 - test/distance_test.rb
 - test/test_all.rb
 - test/speed_test.rb
+- locales/it.yml
+- locales/en.yml
 has_rdoc: true
 homepage: http://github.com/joeyates/m9t
 licenses: []