measure 0.1.0 → 0.2.0

data/lib/measure/length.rb

@@ -6,54 +6,60 @@
 
 require 'measure'
 
-Measure.define_unit :meter, :length
-Measure.define_alias :m, :meter
-
-Measure.define_unit :kilo_meter, :length
-Measure.define_alias :km, :kilo_meter
-
-Measure.define_unit :centi_meter, :length
-Measure.define_alias :cm, :centi_meter
-
-Measure.define_unit :milli_meter, :length
-Measure.define_alias :mm, :milli_meter
-
-Measure.define_unit :micro_meter, :length
-Measure.define_alias :um, :micro_meter
-
-Measure.define_unit :nano_meter, :length
-Measure.define_alias :nm, :nano_meter
-
-Measure.define_unit :inch, :length
-Measure.define_alias :in, :inch
-
-Measure.define_unit :feet, :length
-Measure.define_alias :ft, :feet
-
-Measure.define_unit :yard, :length
-Measure.define_alias :yd, :yard
-
-Measure.define_conversion :m, :cm => 100, :mm => 1000, :um => 1000000, :nm => 1000000000
-Measure.define_conversion :km, :m => 1000
-Measure.define_conversion :cm, :mm => 10
-Measure.define_conversion :mm, :um => 1000
-Measure.define_conversion :um, :nm => 1000
-Measure.define_conversion :in, :m => 0.254, :cm => 2.54, :mm => 25.4
-Measure.define_conversion :ft, :in => 12
-Measure.define_conversion :yd, :in => 36, :ft => 3
-
-# for DTP
-
-Measure.define_unit :point, :length
-Measure.define_alias :pt, :point
-Measure.define_alias :didot_point, :point
-Measure.define_alias :dp, :didot_point
-
-Measure.define_unit :big_point, :length
-Measure.define_alias :bp, :big_point
-
-Measure.define_unit :pica, :length
-Measure.define_alias :pc, :pica
-
-Measure.define_conversion :in, :pt => 72.27, :bp => 72.0
-Measure.define_conversion :pc, :pt => 12
+class Measure
+  {
+    :m  => :meter,
+    :km => :kilo_meter,
+    :cm => :centi_meter,
+    :mm => :milli_meter,
+    :um => :micro_meter,
+    :nm => :nano_meter,
+    :in => :inch,
+    :ft => :feet,
+    :yd => :yard,
+  }.each do |a, u|
+    def_unit u, :length unless has_unit? u
+    def_alias a, u
+  end
+
+  def_conversion :m, :cm => 100, :mm => 1000, :um => 1000000, :nm => 1000000000
+  def_conversion :km, :m => 1000
+  def_conversion :cm, :mm => 10
+  def_conversion :mm, :um => 1000
+  def_conversion :um, :nm => 1000
+  def_conversion :in, :m => 0.254, :cm => 2.54, :mm => 25.4
+  def_conversion :ft, :in => 12
+  def_conversion :yd, :in => 36, :ft => 3
+
+  # for Physics
+
+  {
+    :aa => :angstrom,
+    :AU => :astronomical_unit,
+    :au => :astronomical_unit,
+    :ly => :light_year,
+  }.each do |a, u|
+    def_unit u, :length unless has_unit? u
+    def_alias a, u
+  end
+
+  def_conversion :m, :angstrom => 10000000000
+  def_conversion :AU, :m => 149_597_870_691
+  def_conversion :light_year, :m => 9_460_730_472_580_800
+
+  # for DTP
+
+  {
+    :pt          => :point,
+    :didot_point => :point,
+    :dp          => :didot_point,
+    :bp          => :big_point,
+    :pc          => :pica,
+  }.each do |a, u|
+    def_unit u, :length unless has_unit? u
+    def_alias a, u
+  end
+
+  def_conversion :in, :pt => 72.27, :bp => 72.0
+  def_conversion :pc, :pt => 12
+end

data/lib/measure/support.rb

@@ -22,7 +22,7 @@ module MeasureSupport
 
       def method_missing(name, *args)
         if MeasureSupport.enable?
-          return Measure.new(self, name) if Measure.defined?(name)
+          return Measure.new(self, name) if Measure.has_unit?(name)
         end
         return measure_support_saved_method_missing(name, *args)
       end
@@ -31,7 +31,7 @@ module MeasureSupport
 end
 
 class << Measure
-  def with_short_form
+  def short_form
     begin
       MeasureSupport.enable
       return yield
@@ -40,7 +40,17 @@ class << Measure
     end
   end
 
-  alias form with_short_form
+  def enable_short_form
+    MeasureSupport.enable
+  end
+
+  def disable_short_form
+    MeasureSupport.disable
+  end
+
+  def short_form_available?
+    MeasureSupport.enable?
+  end
 end
 
 class Integer

data/lib/measure/version.rb

@@ -6,7 +6,7 @@ class Measure
   module VERSION
     unless defined? MAJOR
       MAJOR = 0
-      MINOR = 1
+      MINOR = 2
       TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/measure/weight.rb

@@ -0,0 +1,43 @@
+# = Definitions of the weight dimension units
+#
+# Author::    Kenta Murata
+# Copyright:: Copyright (C) 2008 Kenta Murata
+# License::   LGPL version 3.0
+
+require 'measure'
+
+class Measure
+  {
+    :kg    => :kilo_gram,
+    :g     => :gram,
+    :t     => :ton,
+    :mg    => :milli_gram,
+    :ug    => :micro_gram,
+    :gr    => :grain,
+    :oz    => :ounce,
+    :oz_av => :ounce,
+    :oz_tr => :troy_ounce,
+    :toz   => :troy_ounce,
+    :lb    => :pound,
+    :lb_av => :pound,
+    :lb_tr => :troy_pound,
+    :kin   => :catty,
+    :ryo   => :tael,
+  }.each do |a, u|
+    def_unit u, :weight unless has_unit? u
+    def_alias a, u
+  end
+
+  def_conversion :kg, :g => 1_000, :mg => 1_000_000, :ug => 1_000_000_000
+  def_conversion :t, :kg => 1_000
+  def_conversion :gr, :mg => 64.79891
+  def_conversion :oz_av, :gr => 437.5
+  def_conversion :oz_tr, :gr => 480, :g => 31.1034768
+  def_conversion :lb_av, :gr => 7000, :oz => 16, :kg => 0.45359237
+  def_conversion :lb_tr, :gr => 5760, :oz => 12, :kg => 0.3732417216, :lb_av => 144.0/175.0
+
+  def_unit :momme, :weight
+  def_conversion :momme, :g => 3.75
+  def_conversion :kin, :momme => 160
+  def_conversion :kin, :ryo => 16
+end

data/spec/measure_spec.rb

@@ -1,36 +1,141 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 require 'measure'
 
-describe Measure do
+describe Measure, 'with five pre-defined units in order to unit management' do
   before :each do
+    # Pre-define the following conversion scheme
+    #
+    #      2     5      10
+    #  a <--- b ---> c <--- d
+    #         |
+    #         `----> e
+    #           10
+    #
+    Measure.define_unit :a, :test
+    Measure.define_unit :b, :test
+    Measure.define_unit :c, :test
+    Measure.define_unit :d, :test
+    Measure.define_unit :e, :test
+    Measure.define_conversion :b, :a => 2
+    Measure.define_conversion :b, :c => 5
+    Measure.define_conversion :b, :e => 10
+    Measure.define_conversion :d, :c => 10
   end
 
-  it 'has no units when nothing is defined' do
-    Measure.num_units.should be_equal 0
-    Measure.units.should be_empty
+  it 'has five units' do
+    Measure.num_units.should == 5
   end
 
-  it 'has the [meter] after this is defined' do
-    Measure.define_unit :meter, :length
-    Measure.should have_unit :meter
-    Measure.should be_defined :meter
+  it 'has defined units and has not undefined units' do
+    Measure.should have_unit(:a)
+    Measure.should have_unit(:b)
+    Measure.should have_unit(:c)
+    Measure.should have_unit(:d)
+    Measure.should have_unit(:e)
+    Measure.should_not have_unit(:f)
+    Measure.should_not have_unit(:g)
+    Measure.should_not have_unit(:h)
   end
 
-  it 'returns the number of defined units when call Measure.num_units' do
-    Measure.define_unit :meter, :length
-    Measure.define_unit :inch, :length
-    Measure.num_units.should == 2
+  it 'can define an unit which has not been defined yet' do
+    lambda { Measure.define_unit :f, :test }.
+      should_not raise_error(Exception)
   end
 
-  it 'raises Measure::UnitRedefinitionError ' +
-    'when the [meter] is defined twice with different dimensions' do
-    Measure.define_unit :meter, :length
-    lambda { Measure.define_unit :meter, :length }.
+  it 'can undefine a unit which has been already defined' do
+    Measure.define_unit :f, :test
+    Measure.should have_unit(:f)
+    lambda { Measure.undefine_unit :f }.
+      should_not raise_error(Exception)
+    Measure.should_not have_unit(:f)
+  end
+
+  it 'raises UnitRedefinitionError' +
+    ' when an unit is about to be redefined as a different dimension' do
+    lambda { Measure.define_unit :a, :other }.
+      should raise_error(Measure::UnitRedefinitionError)
+  end
+
+  it 'does not raise UnitRedefinitionError' +
+    ' when an unit is about to be redefined as a same dimension' do
+    lambda { Measure.define_unit :a, :test }.
       should_not raise_error(Measure::UnitRedefinitionError)
-    lambda { Measure.define_unit :meter, :weight }.
+  end
+
+  it 'can define and undefine aliases' do
+    lambda { Measure.define_alias :alias_a, :a }.
+      should_not raise_error(Exception)
+    Measure.should have_unit(:alias_a)
+    lambda { Measure.undefine_unit :alias_a }.
+      should_not raise_error(Exception)
+    Measure.should_not have_unit(:alias_a)
+  end
+
+  it 'raises UnitRedefinitionError when the unit is redefined as an alias' do
+    lambda { Measure.define_alias :b, :a }.
       should raise_error(Measure::UnitRedefinitionError)
   end
 
+  it 'can define a scheme of conversion from an alias' do
+    Measure.define_alias :alias_a, :a
+    lambda { Measure.define_conversion :alias_a, :b => 10 }.
+      should_not raise_error(Exception)
+    Measure.should be_direct_compatible(:alias_a, :b)
+  end
+
+  it 'can convert between two connected units' +
+    ' through multiple direct conversions' do
+    Measure.find_conversion_route(:a, :d).should_not be_nil
+    Measure.find_conversion_route(:d, :e).should_not be_nil
+  end
+
+  it 'can define conversion by a Proc' do
+    Measure.define_unit :f, :test
+    lambda { Measure.define_conversion :f, :a => lambda {|x| x + 2 } }.
+      should_not raise_error(Exception)
+  end
+
+  it 'can not convert commutatively by a Proc ' do
+    Measure.define_unit :f, :test
+    lambda { Measure.define_conversion :f, :a => lambda {|x| x + 2 } }.
+      should_not raise_error(Exception)
+    Measure.should be_direct_compatible(:f, :a)
+    Measure.should_not be_direct_compatible(:a, :f)
+  end
+
+  it 'can not find conversion route include inverse of a Proc ' do
+    Measure.define_unit :f, :test
+    lambda { Measure.define_conversion :f, :a => lambda {|x| x + 2 } }.
+      should_not raise_error(Exception)
+    #
+    #            2      5     10
+    # f ===> a <--- b ---> c <--- d
+    #               |
+    #               `----> e
+    #                 10
+    #
+    #  ===> : incommutative conversion
+    Measure.should be_direct_compatible(:f, :a)
+    Measure.should_not be_direct_compatible(:a, :f)
+    Measure.find_conversion_route(:f, :d).should_not be_nil
+    Measure.find_conversion_route(:d, :f).should be_nil
+  end
+
+  after :each do
+    Measure.clear_units
+  end
+end
+
+describe Measure, 'with no pre-defined units' do
+  before :each do
+    Measure.clear_units
+  end
+
+  it 'has no units when nothing is defined' do
+    Measure.num_units.should be_equal(0)
+    Measure.units.should be_empty
+  end
+
   it 'returns length units when call units(:length)' do
     length_units = [:meter, :feet, :inch]
     length_units.each {|u| Measure.define_unit u, :length }
@@ -51,8 +156,8 @@ describe Measure do
     Measure.define_unit :meter, :length
     Measure.define_unit :inch, :length
     Measure.define_conversion :meter, :inch => 0.254
-    Measure.compatible?(:meter, :inch).should be_true
-    Measure.compatible?(:inch, :meter).should be_true
+    Measure.should be_direct_compatible(:meter, :inch)
+    Measure.should be_direct_compatible(:inch, :meter)
   end
 
   it 'can convert meter to centimeter after define_conversion(:meter, :centimeter => 100)' do
@@ -68,21 +173,6 @@ describe Measure do
     Measure(1, :meter).to_s.should == '1 [meter]'
   end
 
-  it 'can define aliases' do
-    Measure.define_unit :meter, :length
-    Measure.define_alias :m, :meter
-    Measure.should be_defined :m
-    Measure.dimension(:m).should == :length
-
-    Measure.define_unit :centimeter, :length
-    lambda { Measure.define_alias :centimeter, :meter }.
-      should raise_error(Measure::UnitRedefinitionError)
-
-    Measure.define_conversion :meter, :centimeter => 100
-    lambda { Measure(1, :m).as_centimeter }.
-      should_not raise_error(StandardError)
-  end
-
   it 'can perform multi-hop conversion' do
     Measure.define_unit :millimeter, :length
     Measure.define_unit :inch, :length
@@ -92,8 +182,30 @@ describe Measure do
     Measure(1, :feet).as_millimeter.should be_close(Measure(12.0 * 25.4, :millimeter), 1e-9)
   end
 
+  it 'can convert by a Proc' do
+    Measure.define_unit :deg_c, :temperature
+    Measure.define_unit :deg_f, :temperature
+    Measure.define_conversion :deg_f, :deg_c => lambda {|x| 5.0*(x - 32)/9.0 }
+    Measure.define_conversion :deg_c, :deg_f => lambda {|x| 9.0*x/5.0 + 32 }
+    Measure.should be_direct_compatible(:deg_f, :deg_c)
+    Measure.should be_direct_compatible(:deg_c, :deg_f)
+    lambda { Measure(40, :deg_c).as_deg_f }.should_not raise_error(Exception)
+  end
+
+  it 'coerce a Number to a Measure with unit 1' do
+    Measure.define_unit :a, :test
+    Measure(1, :a).coerce(10)[0].unit.should == 1
+  end
+
+  it 'can multiply any units by unit 1' do
+    Measure.define_unit :a, :test
+    lambda { Measure(1, :a) * Measure(1, 1) }.
+      should_not raise_error(Exception)
+    lambda { Measure(1, 1) * Measure(1, :a) }.
+      should_not raise_error(Exception)
+  end
+
   after :each do
-    Measure.clear_units
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: measure
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kenta Murata
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-11 00:00:00 +09:00
+date: 2009-06-13 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README
 - CHANGES
+- COPYING
 - COPYING.LIB
 files: 
 - ChangeLog
@@ -34,6 +35,7 @@ files:
 - lib/measure/length.rb
 - lib/measure/support.rb
 - lib/measure/version.rb
+- lib/measure/weight.rb
 - lib/measure.rb
 - spec/measure_spec.rb
 - spec/spec.opts
@@ -65,9 +67,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: measure
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: measure version 0.1.0
+summary: measure version 0.2.0
 test_files: []