dimensional 1.0.1 → 1.1.1

data/CHANGELOG

@@ -1,5 +1,6 @@
 0.1.0
 0.1.1	Simpler conversion system-to-system and redefinition of preference semantics.
-0.1.2	Cleanup tests to work with gem check -t
-1.0.0	Production Release 1
-1.0.1	Use Rationals for default values and avoid the dreaded integer division = 0 problem
+0.1.2	Cleanup tests to work with gem check -t.
+1.0.0	Production Release 1.
+1.0.1	Use Rationals for default values and avoid the dreaded integer division = 0 problem.
+1.1.1	Add Metric.load constructor, improve docs and enhance scanner.

data/README

@@ -3,9 +3,22 @@
 # unit-oriented methods into Ruby standard classes -to perform operations, particularly across dimensions, you
 # will need to use basic conversion methods provided by this library combined with standard Ruby numerical oper-
 # ations.  There is no method_missing magic or large mixin of spiffy unit-like methods here.
-
-# The long-term objective for this library is to achieve compliance with the UCUM standard, with additional
-# facilities for simple parsing and formatting of measures according to localized standards, and conversion
-# of measures between units.  References:
+#
+# Here are some examples of what you can do with the Dimensional library:
+#
+# require 'dimensional'
+# require 'test/demo'
+# class Autonomy < Dimensional::Metric
+#   self.dimension = Dimensional::Dimension::L
+# end 
+# range = Autonomy.parse("15 nautical miles")
+# range.to_s	# => "15M"
+# range.base  # => <Rational(27780, 1) <meter>>
+# range.base.to_s # => "27780m"
+# usrange = range.convert(Dimensional::Unit[:L, :US, :yd])	# => <30380.5774278215 <yard>>
+#
+# The demo library in the test directory contains a good starter set of units.
+#
+# The long-term objective for this library is to achieve compliance with the UCUM standard.  References:
 #   UCUM Website: http://unitsofmeasure.org/
 #   UCUM Standard: http://aurora.regenstrief.org/~ucum/ucum.html

data/Rakefile

@@ -39,8 +39,9 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tttt #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.title = "Dimensional #{version}"
+  rdoc.rdoc_files.include(%w(README LICENSE CHANGELOG TODO))
+  rdoc.rdoc_files.include('test/demo.rb')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/TODO

@@ -0,0 +1 @@
+1. Fix parsing units like "6m3" for six cubic meters.

data/lib/dimensional/metric.rb

@@ -8,7 +8,7 @@ module Dimensional
     # A Measure string is composed of a number followed by a unit separated by optional whitespace.
     # A unit (optional) is composed of a non-digit character followed by zero or more word characters and terminated by some stuff.
     # Scientific notation is not currently supported.
-    NUMERIC_REGEXP = /((?=\d|\.\d)\d*(?:\.\d*)?)\s*(\D\w*?)?(?=\b|\d|\W|$)/
+    NUMERIC_REGEXP = /((?=\d|\.\d)\d*(?:\.\d*)?)\s*(\D.*?)?\s*(?=\d|$)/
 
     class << self
       attr_accessor :dimension, :base, :default
@@ -67,6 +67,11 @@ module Dimensional
           configuration[u][:preference] - oom_delta
         end
       end
+
+      # Create a new instance with the given value (assumed to be in the base unit) and convert it to the preferred unit.
+      def load(v)
+        new(v, base).preferred
+      end
     end
 
     attr_reader :unit

data/lib/dimensional/version.rb

@@ -1,3 +1,3 @@
 module Dimensional
-  VERSION = "1.0.1"
+  VERSION = "1.1.1"
 end

data/test/demo.rb

@@ -36,7 +36,7 @@ Configurator.start do
       base('meter', 'm', :detector => /\A(met(er|re)s?|m)\Z/) do
         derive('decimeter', 'dm', Rational(1, 10), :detector => /\A(decimet(er|re)s?|dm)\Z/, :preference => 0.5)
         derive('centimeter', 'cm', Rational(1, 100), :detector => /\A(centimet(er|re)s?|cm)\Z/)
-        derive('decameter', 'km', 10, :detector => /\A(de(c|k)amet(er|re)s?|dam)\Z/)
+        derive('decameter', 'dam', 10, :detector => /\A(de(c|k)amet(er|re)s?|dam)\Z/)
         derive('kilometer', 'km', 1000, :detector => /\A(kilomet(er|re)s?|km)\Z/)
         derive('nautical mile', 'M', 1852, :detector => /\A(nautical miles?|NMs?|nmis?)\Z/)
       end
@@ -70,8 +70,8 @@ Configurator.start do
       reference('mile', 'nm', Dimensional::Unit[:L, :SI, 'meter'], 1852.216, :detector => /\A((nautical )?mile|nm|nmi)\Z/) do
         derive('league', nil, 3, :detector => /\A(leagues?)\Z/)
         derive('cable', nil, Rational(1,10), :detector => /\A(cables?|cbls?)\Z/) do
-          derive('fathom', 'fm', Rational(1,10), :detector => /\A(fathoms?|fms?)\Z/) do
-            derive('yard', 'yd', Rational(1,6), :detector => /\A(yards?|yds?)\Z/) do
+          derive('fathom', 'fm', Rational(1,100), :detector => /\A(fathoms?|fms?)\Z/) do
+            derive('yard', 'yd', Rational(1,2), :detector => /\A(yards?|yds?)\Z/) do
               derive('foot', 'ft', Rational(1,3), :detector => /\A(foot|feet|ft|')\Z/) do
                 derive('inch', 'in', Rational(1,12), :detector => /\A(inch|inches|in|")\Z/)
               end
@@ -137,6 +137,7 @@ Configurator.start do
           derive('township', 'twp', 36, :detector => /\Atownships?\Z/)
         end
       end
+      combine('square foot', 'ft2', {Unit[:L, :US, :ft] => 2}, :detector => /ft2/)
     end
   end
 
@@ -250,7 +251,6 @@ Configurator.start do
     end
     system(:US) do
       # Using the definition for mechanical horsepower, http://en.wikipedia.org/wiki/Horsepower
-#      reference('horsepower', 'hp', Dimensional::Unit[:P, :SI, 'watt'], 745.69987158227022, :detector => /\A(horsepower|hp)\Z/)
       combine('horsepower', 'hp', {Unit[:E, :US, :'ft-lbf'] => 1, Unit[:T, :SI, :m] => -1}, {:reference_factor => 33000})
     end
   end
@@ -303,13 +303,14 @@ end
 
 class Length < Dimensional::Metric
   self.dimension = Dimensional::Dimension::L
-  self.default = Unit[:L, :SI, :m]
+  self.base = Unit[:L, :SI, :m]
+  self.default = base
 end
 
 class Autonomy < Dimensional::Metric
   self.dimension = Dimension::L
-  self.default = Unit[:L, :BA, :nm]
   self.base = Unit[:L, :SI, :m]
+  self.default = Unit[:L, :BA, :nm]
   configure(Unit[:L, :SI, :km], {:preference => 2})
   configure(Unit[:L, :US, :mi], {:preference => 3.5})
   configure(Unit[:L, :Imp, :mi], {:preference => 3.5})
@@ -317,13 +318,13 @@ end
 
 class EngineDisplacement < Dimensional::Metric
   self.dimension = Dimensional::Dimension::V
-  self.default = Unit[:V, :SI, :l]
-  self.base = default
+  self.base = Unit[:V, :SI, :l]
+  self.default = base
   configure(Unit[:V, :US, :in3], {:preference => 2})
 end
 
 class MechanicalPower < Dimensional::Metric
   self.dimension = Dimensional::Dimension::P
-  self.default = Unit[:P, :SI, :W]
-  self.base = default
+  self.base = Unit[:P, :SI, :W]
+  self.default = base
 end

data/test/metric_test.rb

@@ -15,6 +15,7 @@ class MetricTest < Test::Unit::TestCase
     @meter = Unit.register('meter', System::SI, Dimension::L, {:abbreviation => 'm'})
     @kilometer = Unit.register('kilometer', System::SI, Dimension::L, {:reference_units => {@meter => 1}, :reference_factor => 1000, :abbreviation => 'km'})
     @centimeter = Unit.register('centimeter', System::SI, Dimension::L, {:reference_units => {@meter => 1}, :reference_factor => Rational(1,100), :abbreviation => 'cm'})
+    @international_nautical_mile = Unit.register('nautical mile', System::SI, Dimension::L, {:reference_units => {@meter => 1}, :reference_factor => Rational(1852,1), :abbreviation => 'M', :preference => -3})
     # Length Units - US
     @yard_us = Unit.register('yard', System::US, Dimension::L, {:reference_units => {@meter => 1}, :reference_factor => 0.9144, :abbreviation => 'yd'})
     @foot_us = Unit.register('foot', System::US, Dimension::L, {:reference_units => {@yard_us => 1}, :reference_factor => Rational(1,3), :abbreviation => 'ft'})
@@ -74,6 +75,18 @@ class MetricTest < Test::Unit::TestCase
     assert_equal @yard_us, m.unit
   end
 
+  def test_load_metric
+    range = Class.new(Metric)
+    range.instance_eval do
+      self.dimension = Dimension::L
+      self.base = Unit[:L, :SI, :m]
+      configure Unit[:L, :SI, :M], :preference => 0
+    end
+    assert r = range.load(200000)
+    assert_in_delta(108, r, 0.1)
+    assert_same @international_nautical_mile, r.unit
+  end
+
   def test_find_unit
     depth = Class.new(Metric)
     depth.dimension = Dimension::L
@@ -81,6 +94,18 @@ class MetricTest < Test::Unit::TestCase
     assert_same @foot_us, depth.find_unit('foot', :US)
   end
 
+  def test_scanner
+    assert_equal [%w(3 m)], "3m".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [%w(3 m)], "3 m".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [%w(.3 m)], ".3m".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [%w(0.3 m)], "0.3m".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [%w(01.32 m)], "01.32m".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [%w(6 '), %w(4 ")], "6'4\"".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [%w(6 feet), %w(4 inches)], "6 feet 4 inches".scan(Metric::NUMERIC_REGEXP)
+    assert_equal [["1.32", "nautical miles"]], "1.32 nautical miles".scan(Metric::NUMERIC_REGEXP)
+#    assert_equal [%w(.3 m3)], ".3m3".scan(Metric::NUMERIC_REGEXP)
+  end
+
   def test_parse
     depth = Class.new(Metric)
     depth.dimension = Dimension::L
@@ -97,6 +122,14 @@ class MetricTest < Test::Unit::TestCase
     assert_equal 15, m
   end
 
+  def test_parse_with_multiword_unit
+    range = Class.new(Metric)
+    range.dimension = Dimension::L
+    m = range.parse("15 nautical miles", :SI)
+    assert_same @international_nautical_mile, m.unit
+    assert_equal 15, m
+  end
+
   def test_parse_compound
     depth = Class.new(Metric)
     depth.dimension = Dimension::L

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dimensional
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Chris Hapgood
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README
+- TODO
 files: 
 - CHANGELOG
 - LICENSE
@@ -42,6 +43,7 @@ files:
 - test/metric_test.rb
 - test/system_test.rb
 - test/unit_test.rb
+- TODO
 has_rdoc: true
 homepage: http://cho.hapgoods.com/dimensional
 licenses: []