units-system 0.1.1 → 0.2.0

data/README.rdoc

@@ -10,22 +10,28 @@ There's a couple of caveats for using this module from Ruby 1.8:
   (either global scope or a module or class definitions) where the expressions are goign to be used.
   Alternatively, expressions such as <tt>u{W}</tt> could be replaced by either
   <tt>u{W()}</tt>, <tt>u{self.W}</tt> (method invocation) or <tt>u{self::W}</tt> (qualified constant).
-* UTF-8 characters are liberally used in identifiers, so the code must be executed with the <tt>-Ku</tt> 
+  Units defined in text form, such as <tt>u('W*h')</tt> will work regardless of whether UseBlocks is
+  included or not.
+* UTF-8 characters are liberally used in identifiers, so the code must be executed with the <tt>-Ku</tt>
   option (or setting <tt>$KCODE='UTF8'</tt> before requiring this library.)
-  
+
 = Usage examples
-  
+
 == Ruby 1.9
-  
+
 For use with Ruby 1.9, this gem can be used simply by requiring:
 
   require 'units-system'
-    
+
+For versions other than 1.9.1 this is needed as in Ruby 1.8:
+
+  include Units::UseBlocks  # allow access to capitalized unit names from units/u blocks
+
 == Ruby 1.8
 
 This library has been designed for Ruby 1.9; when using it under older versions of Ruby there's
 a couple of precautions to be taken to use it (which can be used with Ruby 1.9 too):
-  
+
     $KCODE = 'UTF8'           # avoid errors when parsing the required library under Ruby 1.8
     require 'units-system'
     include Units::UseBlocks  # allow access to capitalized unit names from units/u blocks
@@ -36,7 +42,7 @@ The following examples use UTF-8 code; so they can should be used with a "encodi
 top of the file for Ruby 1.9, and/or with the ruby command line "-Ku" option for Ruby 1.8.
 
 To work with units a +units+ block can be used. Beware: in it +self+ is changed,
-so outer self methods or instance variables are not accessible, unless usigned to
+so outer self methods or instance variables are not accessible, unless assigned to
 local variables.
 
   require 'units-system'
@@ -44,7 +50,7 @@ local variables.
   Units.units do
 
     # In the units environment predefined variables are available for all units and they
-    # can b combined arithmetically:
+    # can be combined arithmetically:
     x = 3*m/s
     puts x                           # => 3.0*m/s
     # Note that SI prefixes (k for kilo, etc.) can be used as part of the unit names:
@@ -56,12 +62,12 @@ local variables.
     # Let's use some unit powers: convert 3 cubic meters to litres:
     puts (3*m**3).to(l)              # => 3000.0*l
 
-    # Now let's convert som imperial units to SI:
+    # Now let's convert some imperial units to SI:
     puts (100*mi/h).to_si            # => 44.704*m/s
 
     # Note that +in+ is a Ruby keyword, so to use inches you must use +self.in+:
     puts (10*cm).to(self.in)         # => 3.93700787401575*in
-    # ...or use tha alternative nonstandard name +inch+
+    # ...or use the alternative nonstandard name +inch+
     puts (10*cm).to(inch)            # => 3.93700787401575*inch
 
     # Now let's use derived units, e.g. power units:
@@ -74,6 +80,7 @@ local variables.
     puts x.base.abr                  # => 10000.0 (m^2 kg)/s^3
 
     # Note that unit names that start with uppercase letters are OK:
+    # (but see the notes on UseBlocks above if this doesn't work)
     puts 11*W                        # => 11.0*W
     puts (2*Mg).to(kg)               # => 2000.0*kg
 
@@ -125,6 +132,17 @@ For short expressions, the abbreviation +Units.u+ can be used instead of +Units.
   x = u{120*km/h}
   puts x.to(u{mi/h})                 # => 74.5645430684801*mi/h
 
+Text strings can also be used to define units:
+
+  puts Units.u('60*km + 10*mi')      # => 76.09344*km
+  puts Units.u('sin(45*°)')          # => 0.707106781186547
+  x = Units.u('120*km/h')
+  puts x.to(Units.u('mi/h'))         # => 74.5645430684801*mi/h
+
+And also as the right operand of binary arithmetic operators:
+
+  puts Units.u('20*km')/'h'          # => 20.0*km/h
+
 New units can be defined with +Units.define+
 
   Units.define :kph, 1, Units.u{km/h}
@@ -134,7 +152,7 @@ New units can be defined with +Units.define+
 
 Note that Ruby variable definition rules imply that this:
   m = Units.u{m}
-Results is a nil value (the outter m assignment defines a local m variable even before executing the block, so
+Results is a nil value (the outer m assignment defines a local m variable even before executing the block, so
 the m in the block refers to that, yet-unassigned, variable and not to the meter unit)
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/units-system.rb

@@ -10,7 +10,7 @@ module Units
 
   # This must be included in any module or class from which units expressions
   # are to be used in units or u blocks.
-  # It is not needed in Ruby 1.9.1 due to they way constant loop-up is done in that version,
+  # It is not needed in Ruby 1.9.1 due to they way constant look-up is done in that version,
   # but Ruby 1.9.2 has changed that an requires this again.
   module UseBlocks
     def self.append_features(target)

data/lib/units/measure.rb

@@ -118,14 +118,16 @@ module Units
     end
 
     def /(other)
+      other = Units.units(other) if other.kind_of?(String)
       self * (other.kind_of?(Numeric) ? 1.0/other : other.inverse)
     end
 
     def inspect
-      "Measure(#{@magnitude.inspect}, #{@units.inspect})"
+      "Units::Measure[#{@magnitude.inspect}, #{@units.inspect}]"
     end
 
     def *(other)
+      other = Units.units(other) if other.kind_of?(String)
       case other
       when Numeric
         mag = self.magnitude*other
@@ -147,10 +149,12 @@ module Units
     end
 
     def +(other)
+      other = Units.units(other) if other.kind_of?(String)
       Measure.new self.magnitude+other.to(self.units).magnitude, self.units
     end
 
     def -(other)
+      other = Units.units(other) if other.kind_of?(String)
       self + (-other)
     end
 
@@ -177,6 +181,7 @@ module Units
     end
 
     def in(other, mode=:absolute)
+      other = Units.units(other) if other.kind_of?(String)
       other = Measure.new(1.0, other) unless other.kind_of?(Measure)
       other = other.base
       this = self.base
@@ -199,6 +204,7 @@ module Units
     end
 
     def to(units, mode=:absolute)
+      units = Units.units(units) if units.kind_of?(String)
       units = units.u if units.kind_of?(Measure)
       Measure.new self.in(units, mode), units
     end
@@ -223,7 +229,8 @@ module Units
     end
 
     def coerce(other)
-      [Measure.new(other, {}), self]
+      # other = Units.units(other) if other.kind_of?(String)
+      [Measure[other], self]
     end
 
     def u # dimension? unit? only_units? strip_units? units_measure?

data/test/test_units-system.rb

@@ -116,4 +116,30 @@ class TestUnitsSystem < Test::Unit::TestCase
     assert_raise(ArgumentError){Units.u("m"){m}}
   end
 
+  should "admit units defined as text for conversion arguments" do
+    assert_equal 75, Units.u{(270*km/h)}.in('m/s')
+    assert_equal 270, Units.u{(75*m/s)}.in('km/h')
+    assert_in_delta Units.u{g*cm/s**2}.magnitude, Units.u{dyn}.to('g*cm/s**2').magnitude, Float::EPSILON
+  end
+
+  should "handle well capitalized units names" do
+    assert_nothing_raised{Units.units{W}}
+    assert_nothing_raised{Units.units{3*W}}
+    assert_nothing_raised{Units.units{3*N}}
+    assert_nothing_raised{Units.units{3*A}}
+  end
+
+  should "render valid code when inspecting measures" do
+    assert_equal Units.u{m}, eval(Units.u{m}.inspect)
+    assert_equal Units.u{3*m/s}, eval(Units.u{3*m/s}.inspect)
+    assert_equal Units.u{3*m/s+2*km/h}, eval(Units.u{3*m/s+2*km/h}.inspect)
+  end
+
+  should "allow arithmetic between measures and text" do
+    assert_equal Units.u{m/s}, Units.u{m}/'s'
+    assert_equal Units.u{m*s}, Units.u{m}*'s'
+    assert_equal Units.u{m+km}, Units.u{m}+'km'
+    assert_equal Units.u{m-km}, Units.u{m}-'km'
+  end
+
 end

data/units-system.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "units-system"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javier Goizueta"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: units-system
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -129,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4083810323229241626
+      hash: 1858258133218816942
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: