dimensional 0.0.2 → 0.0.3

data/Rakefile

@@ -16,7 +16,7 @@ Rake::Task['test'].comment = "Run all tests in test/*_test.rb"
 spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = %q{dimensional}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
   s.required_ruby_version = '>= 1.6.8'
   s.date = %q{2009-10-09}
   s.authors = ["Chris Hapgood"]

data/lib/dimensional.rb

@@ -4,5 +4,5 @@ require 'dimensional/unit'
 require 'dimensional/measure'
 
 module Dimensional
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/dimensional/configurator.rb

@@ -39,7 +39,6 @@ module Dimensional
       if block
         self.class.new(new_context).instance_eval &block
       else
-        @context = new_context
         self # Allow chaining
       end
     end

data/lib/dimensional/measure.rb

@@ -50,6 +50,29 @@ module Dimensional
       new_value = self * unit.convert(new_unit)
       self.class.new(new_value, new_unit, metric)
     end
+    
+    # Convert this measure to the most appropriate unit in the given system
+    # A heuristic approach is used that considers the resulting measure's order-of-magnitude (similar
+    # is good) and membership in the preferred units of the measure's metric (membership is good).
+    def change_system(system, fallback = false)
+      system = System[system] unless system.kind_of?(System)
+      units = metric.units.select{|u| system == u.system}
+      if units.empty?
+        if fallback
+          units = metric.units
+        else
+          raise "No suitable units available in #{system}"
+        end
+      end
+      target_oom = Math.log10(self.unit.factor)
+      units = units.sort_by do |u|
+        oom_delta = (Math.log10(u.factor) - target_oom).abs #  == Math.log10(self.unit.factor / u.factor)
+        magnitude_fit = Math.exp(-0.20 * oom_delta) # decay function
+        0.75 * magnitude_fit + 0.25 * metric.preference(u)
+      end
+      u = units.last
+      convert(u)
+    end
 
     # Return a new dimensional value expressed in the base unit
     # DEPRECATE: this method has dubious semantics for composed units as there may be no defined unit with

data/lib/dimensional/metric.rb

@@ -37,16 +37,21 @@ module Dimensional
       raise "Unit #{unit} is not compatible with dimension #{dimension || '<nil>'}." unless unit.dimension == dimension
       @units[unit] = options
     end
-    
+
     def units
       baseline = parent ? parent.units : @units.keys
-      baseline.sort{|a,b| (@units.has_key?(b) ? 1 : 0) <=> (@units.has_key?(a) ? 1 : 0)}
+      baseline.sort_by{|u| 1.0 - preference(u)}
     end
   
     def preferences(u)
       baseline = parent ? parent.preferences(u) : {} 
       baseline.merge(@units[u])
     end
+    
+    # How "preferred" is the given unit for this metric?
+    def preference(u)
+      @units.has_key?(u) ? 1 : 0
+    end
 
     def each
       units.each

data/test/configurator_test.rb

@@ -59,6 +59,21 @@ class ConfiguratorTest < Test::Unit::TestCase
     end
   end
 
+  def test_preserve_context_within_block
+    test_context = self
+    Dimensional::Configurator.start do
+      dimension(:L) do
+        system(:SI) do
+          base('meter') do
+            test_context.assert uc = context.unit
+            derive('centimeter', 1e-2)
+            test_context.assert_same uc, context.unit
+          end
+        end
+      end
+    end
+  end
+
   def test_build_base_unit
     Configurator.start(:system => System::SI, :dimension => Dimension::L) do
       base('meter', :detector => /\A(meters?|m)\Z/, :abbreviation => 'm')

data/test/measure_test.rb

@@ -112,6 +112,47 @@ class MeasureTest < Test::Unit::TestCase
     new_value = old_value.convert(new_unit)
     assert_equal old_value, new_value
   end
+  
+  # These system-conversion tests rely on very specific constants in the heuristics of #change_system
+  def test_change_system_yd
+    u0 = Unit[:L, :US, 'yd']
+    m0 = Measure.new(1, u0, :length_over_all)
+    u1 = Unit[:L, :SI, 'm']
+    assert m1 = m0.change_system(:SI)
+    assert_same u1, m1.unit
+  end
+
+  def test_change_system_with_metric_override
+    u0 = Unit[:L, :US, 'in']
+    m0 = Measure.new(1, u0, :length_over_all)
+    u1 = Unit[:L, :SI, 'm']
+    assert m1 = m0.change_system(:SI)
+    assert_same u1, m1.unit
+  end
+
+  def test_change_system_with_oom_dominance
+    u0 = Unit[:L, :US, 'in']
+    m0 = Measure.new(1, u0, :L)
+    u1 = Unit[:L, :SI, 'cm']
+    assert m1 = m0.change_system(:SI)
+    assert_same u1, m1.unit
+  end
+
+  def test_change_system_ft
+    u0 = Unit[:L, :US, 'ft']
+    m0 = Measure.new(1, u0, :length_over_all)
+    u1 = Unit[:L, :SI, 'm']
+    assert m1 = m0.change_system(:SI)
+    assert_same u1, m1.unit
+  end
+
+  def test_change_system_mile
+    u0 = Unit[:L, :US, 'mile']
+    m0 = Measure.new(1, u0, :length_over_all)
+    u1 = Unit[:L, :SI, 'km']
+    assert m1 = m0.change_system(:SI)
+    assert_same u1, m1.unit
+  end
 
   def test_return_base
     u = Unit[:L, :BA, 'fathom']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dimensional
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chris Hapgood