measurement 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.2.3 Group formats
+
 v0.2.2 Better formatting functions
 
 v0.2.1 Added methods to Float, Fixnum and String - to_measurement

data/lib/measurement/length.rb

@@ -21,14 +21,14 @@ require File.join(File.dirname(__FILE__), '..', 'measurement')
 #   puts Length.parse('180.34cm').in_feet_and_inches => 5' 11"
 #
 class Length < Measurement::Base
-  base :metre, :metres, :suffix => 'm'
-  unit 1000, :kilometre, :kilometres, :km, :suffix => 'km'
-  unit 0.01, :centimetre, :centimetres, :cm, :suffix => 'cm'
-  unit 0.001, :millimetre, :mm, :suffix => 'mm'
+  base :metre, :metres, :suffix => 'm', :group => :metric
+  unit 1000, :kilometre, :kilometres, :km, :suffix => 'km', :group => :metric
+  unit 0.01, :centimetre, :centimetres, :cm, :suffix => 'cm', :group => :metric
+  unit 0.001, :millimetre, :mm, :suffix => 'mm', :group => :metric
   
-  unit 0.0254, :inch, :inches, :suffix => '"'
-  unit 0.3048, :feet, :foot, :suffix => "'"
-  unit 1609.34, :mile, :miles, :suffix => ' miles'
+  unit 0.0254, :inch, :inches, :suffix => '"', :group => :imperial
+  unit 0.3048, :feet, :foot, :suffix => "'", :group => :imperial
+  unit 1609.34, :mile, :miles, :suffix => ' miles', :group => :imperial
   unit 0.1016, :hand, :hands, :suffix => ' hands'
   
   unit 299792458, :light_seconds, :suffix => ' light seconds'

data/lib/measurement/unit.rb

@@ -1,16 +1,27 @@
 module Measurement
   class Unit
-    attr_reader :names
+    include Comparable
+    
+    attr_reader :names, :scale, :groups
     
     def initialize(scale, *args)
       @options = args.last.is_a?(Hash) ? args.pop : {}
       @names = args
       @scale = scale
+      @groups = [@options[:group]].flatten
+    end
+    
+    def <=>(anOther)
+      scale <=> anOther.scale
     end
     
     def has_name?(name)
       names.include?(name)
     end
+    
+    def in_group?(group)
+      groups.include?(group.to_sym)
+    end
   
     def from(amount)
       amount.to_f * @scale

data/lib/measurement/weight.rb

@@ -16,9 +16,10 @@ require File.join(File.dirname(__FILE__), '..', 'measurement')
 #   puts Length.parse('100kg').in_lbs_and_oz => 220lbs 7oz
 #
 class Weight < Measurement::Base
-  base :gram, :grams, :suffix => 'g'
-  unit 1000.0, :kilogram, :kilograms, :kg, :kgs, :suffix => 'kg'
-  unit 453.59236, :pounds, :pound, :lbs, :suffix => 'lbs'
-  unit 28.3495231, :ounces, :ounce, :oz, :suffix => 'oz'
-  unit 6350.29318, :stone, :st, :suffix => 'st'
+  base :gram, :grams, :suffix => 'g', :group => :metric
+  unit 1000.0, :kilogram, :kilograms, :kg, :kgs, :suffix => 'kg', :group => :metric
+  
+  unit 453.59236, :pounds, :pound, :lbs, :suffix => 'lbs', :group => [:imperial, :us]
+  unit 28.3495231, :ounces, :ounce, :oz, :suffix => 'oz', :group => :us
+  unit 6350.29318, :stone, :st, :suffix => 'st', :group => :imperial
 end

data/lib/measurement.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(__FILE__), 'measurement', 'unit')
+require File.join(File.dirname(__FILE__), 'measurement', 'unit_group')
 
 module Measurement
   class NoUnitFoundException < Exception
@@ -62,21 +63,23 @@ module Measurement
     end
     
     def self.register_measurement
-      method_name = name.gsub(/\s/, '_').gsub(/.[A-Z]/) do |s|
-        s[0,1] + '_' + s[1,1].downcase
-      end.downcase
+      if name && name.length > 0
+        method_name = name.gsub(/\s/, '_').gsub(/.[A-Z]/) do |s|
+          s[0,1] + '_' + s[1,1].downcase
+        end.downcase
       
-      [Fixnum, Float].each do |klass|
-        klass.class_eval %Q{
-        def to_#{method_name}
-          #{name}.new(self)
-        end}
-      end
+        [Fixnum, Float].each do |klass|
+          klass.class_eval %Q{
+          def to_#{method_name}
+            #{name}.new(self)
+          end}
+        end
       
-      String.class_eval %Q{
-        def to_#{method_name}
-          #{name}.parse(self)
-        end}
+        String.class_eval %Q{
+          def to_#{method_name}
+            #{name}.parse(self)
+          end}
+      end
     end
     
     def self.units # :nodoc:
@@ -101,6 +104,7 @@ module Measurement
     #
     # * <tt>prefix</tt> - A prefix to use when formatting the unit.
     # * <tt>suffix</tt> - A suffix to use when formatting the unit.
+    # * <tt>group</tt> - A group that can be used when formatting to combine the unit formats.
     #
     def self.unit(unit, *args)
       add_unit(Unit.new(unit, *args))
@@ -109,14 +113,29 @@ module Measurement
     def self.add_unit(unit) # :nodoc:
       units << unit
     end
+    
+    def self.fetch_group(scale) # :nodoc:
+      scale = scale.to_sym
+      @groups ||= {}
+      @groups[scale] ||= begin
+        group = units.inject([]) do |m,n|
+          m << n if n.in_group?(scale)
+          m
+        end
+      
+        if group.any?
+          UnitGroup.new(group)
+        end
+      end
+    end
   
-    def self.fetch_scale(scale = nil) # :nodoc:
+    def self.fetch_scale(scale = nil, raise_error = true) # :nodoc:
       unit = (scale.nil? ? base : units.detect do |unit|
         unit.has_name?(scale.to_sym)
-      end)
+      end) || fetch_group(scale)
       
       unless unit
-        raise NoUnitFoundException.new(scale)
+        raise NoUnitFoundException.new(scale) if raise_error
       else
         unit
       end
@@ -252,25 +271,22 @@ module Measurement
     #
     #   Length.new(1.8034).in_feet_and_inches => 5' 11"
     #
+    # The unit group can also be specified to get a similar effect:
+    #
+    #   Length.new(1.8034).to_s(:metric) => '1m 80cm 3mm'
+    #
     # A precision can be specified, otherwise the measurement
     # is rounded to the nearest integer.
     def to_s(unit = nil, precision = 0)
       if unit.to_s =~ /_and_/
-        units = unit.to_s.split('_and_')
-        amount = @amount
-        strs = []
-    
-        while unit = units.shift
-          n_in = self.class.to(amount, unit.to_sym)
-          n_in = n_in.floor unless units.empty?        
-          n_out = self.class.from(n_in, unit.to_sym)
-          amount -= self.class.from(n_in, unit.to_sym)
-          strs << self.class.format(n_out, unit.to_sym, 0)
+        units = unit.to_s.split('_and_').map do |unit|
+          self.class.fetch_scale(unit)
         end
-    
-        strs.join(' ')
+        
+        UnitGroup.new(units).format(@amount, precision)
       else
-        self.class.format(@amount, unit, precision)
+        unit = self.class.fetch_scale(unit)
+        unit.format(@amount, precision)
       end
     end
     alias_method :format, :to_s

data/measurement.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{measurement}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Wells"]
-  s.date = %q{2010-02-28}
+  s.date = %q{2010-03-01}
   s.description = %q{A library for holding, converting and formatting measurements}
   s.email = %q{jemmyw@gmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/measurement.rb", "lib/measurement/length.rb", "lib/measurement/unit.rb", "lib/measurement/weight.rb"]

data/spec/lib/measurement_spec.rb

@@ -105,4 +105,41 @@ describe Measurement::Base do
       length.in_cm_and_mm.should == length.to_s(:cm_and_mm)
     end
   end
+  
+  describe '#to_s' do
+    before do
+      @klass = Class.new(Measurement::Base)
+      @klass.base :grams, :group => :metric, :suffix => 'g'
+      @klass.unit 1000, :kilograms, :group => :metric, :suffix => 'kg'
+      @instance = @klass.new(1500)
+    end
+    
+    it 'should return the base unit format if no unit is specified' do
+      @instance.to_s.should == '1500g'
+    end
+    
+    it 'should return the unit format if a unit is specified' do
+      @instance.to_s(:kilograms).should == '2kg'
+    end
+    
+    it 'should return the unit format with precision if specified' do
+      @instance.to_s(:kilograms, 1).should == '1.5kg'
+    end
+    
+    it 'should return the combined unit formats if separated by and' do
+      @instance.to_s(:kilograms_and_grams).should == '1kg 500g'
+    end
+    
+    it 'should return the combined unit formats if a group is specified' do
+      @instance.to_s(:metric).should == '1kg 500g'
+    end
+    
+    it 'should not return any lower bound measurments if they are 0' do
+      @klass.new(10000).to_s(:metric).should == '10kg'
+    end
+    
+    it 'should not return any upper bound measurements if they are 0' do
+      @klass.new(10).to_s(:metric).should == '10g'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: measurement
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 +13:00
+date: 2010-03-01 00:00:00 +13:00
 default_executable: 
 dependencies: []