unitwise 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebcd2779e6a54ca23cc3cd644f3720bd9de8846d
-  data.tar.gz: 4bc1072fe92630814f05e9402e5cc5ac8983ce94
+  metadata.gz: 2cb7a8a61e366794106f2f13a5b18bce3ca3be61
+  data.tar.gz: 6c430a9fb789f8aafb7911ba6832056bd47af100
 SHA512:
-  metadata.gz: 5de61cb9d586961307d03e8c3db35ba3d851d6cc8dcdfd8944c2c6d4b6e9e6833abe82c0fe498d1924bd3a23927c980a7c0fa252ba5e931d848afd10fa278672
-  data.tar.gz: 9b01d1fc8f63294e72bd20060f411c8a54d5ffffe7cb872b504728aa0ea8e4c189f2df696a50bb392b291c1582629c852e7dcbeab2634429b61f3883f4f95f46
+  metadata.gz: c683c3397398221d6d80903b7cbb5b393868f132c9a73e67579f0c8f18f03817ce39b7956b6afdd9f8823876777579d07bd3e3e5e9f298fa9fcdd304fb228fa0
+  data.tar.gz: ad2a38986b46e8e5ad356dc92ff6076e11d4c1fb2bba01000f40fd89a4b9f36902e95a497dc6666f8fbb6f4a7f40f6f2664eaaba619b75f7f56bad9783f47ae4

data/README.md

@@ -1,4 +1,4 @@
-# Unitwise
+# [Unitwise](//github.com/joshwlewis/unitwise)
 
 [![Gem Version](https://badge.fury.io/rb/unitwise.png)](http://badge.fury.io/rb/unitwise)
 [![Build Status](https://travis-ci.org/joshwlewis/unitwise.png)](https://travis-ci.org/joshwlewis/unitwise)
@@ -7,33 +7,76 @@
 [![Code Climate](https://codeclimate.com/github/joshwlewis/unitwise.png)](https://codeclimate.com/github/joshwlewis/unitwise)
 
 
-Unitwise is a library for performing mathematical operations and conversions on all units defined by the [Unified Code for Units of Measure(UCUM)](http://unitsofmeasure.org/).
+Unitwise is a Ruby library for unit measurement conversion and math.
 
-Unitwise supports a vast number of units. At the time of writing, it supports 95 metric units, 199 non-metric units, and 24 unit prefixes. That's approximately 2,500 basic units, but these can also be combined through multiplication and/or division to create an infinite number of possibilities.
+For an over the top example, consider a car (2800 lb) completing the quarter
+mile in 10 seconds (with uniform acceleration).
+
+```ruby
+distance = 0.25.mile # => #<Unitwise::Measurement value=0.25 unit=mile>
+time = 10.second # => #<Unitwise::Measurement value=10 unit=second>
+mass = 2800.pound # => #<Unitwise::Measurement value=2800 unit=pound>
+
+acceleration = 2 * distance / time ** 2
+# => #<Unitwise::Measurement value=0.005 unit=[mi_us]/s2>
+
+force = (mass * acceleration).to_lbf
+# => #<Unitwise::Measurement value=2297.5084316991147 unit=lbf>
+
+power = (force * distance / time).to_horsepower
+# => #<Unitwise::Measurement value=551.4031264140402 unit=horsepower>
+
+speed = ((2 * acceleration * distance) ** 0.5).convert_to("mile/hour")
+# => #<Unitwise::Measurement value=180.0 unit=mile/hour>
+```
+
+## Rationale
+
+Unitwise is based on the [Unified Code for Units of Measure(UCUM)](http://unitsofmeasure.org/),
+which aims to maintain a cross-platform list of units and their conversions.
+This gives Unitwise a few key advantages:
+
+- An enormous list of units. At the time of writing, there are 96 metric units,
+211 non-metric units, and 24 unit prefixes. Whatever unit/units you need, they
+are here.
+
+- An accurate and up to date set of units. The units, prefixes, and conversions
+are maintained by UCUM, and are imported into this library with a rake task.
+
+One of the objectives of Unitwise was that it should comprehend any combination
+of units. For instance it needed to understand that a unit of
+'kilogram.(meter/second)2' was equivalent to 'kilogram.meter.(meter/second2)'.
+This resulted in two unique features:
+
+- An expression grammer built with a PEG parser. This makes expression
+parsing more efficient and allows nestable parentheses. For example, this is possible: '(kilogram.(meter/second)2)2'
+
+- Smart compatibility detection. Each unit is reduced down to its most elementary
+atoms to determine compatibility with another unit. For example, it knows that
+'meter/second2' should be considered compatible with 'kilogram.foot.minute-2/pound'.
 
 ## Usage
 
 ### Initialization:
 
-Instantiate measurements with `Unitwise()`
+Measurements can be instantiated with `Unitwise()`.
 
 ```ruby
 require 'unitwise'
 
-Unitwise(2.3, 'kilogram') # => <Unitwise::Measurement 2.3 kilogram>
-Unitwise('pound')         # => <Unitwise::Measurement 1 pound>
+Unitwise(2.3, 'kilogram') # => #<Unitwise::Measurement value=2.3 unit=kilogram>
+Unitwise('pound')         # => #<Unitwise::Measurement value=1 unit=pound>
 ```
 
-or require the core extensions for some syntactic sugar.
+Unitwise doesn't mess with the Ruby core library by default. So if you want
+the syntactic sugar shown throughout this document, you'll need to require the
+core extensions.
 
 ```ruby
 require 'unitwise/ext'
 
-1.convert('liter')
-# => <Unitwise::Measurement 1 liter>
-
-4.teaspoon
-# => <Unitwise::Measurement 4 teaspoon>
+1.convert_to('liter') # => #<Unitwise::Measurement value=1 unit=liter>
+4.teaspoon            # => #<Unitwise::Measurement value=4 unit=teaspoon>
 ```
 
 ### Conversion
@@ -42,22 +85,17 @@ Unitwise is able to convert any unit within the UCUM spec to any other
 compatible unit.
 
 ```ruby
-distance = Unitwise(5, 'kilometer') 
-# => <Unitwise::Measurement 5 kilometer>
-
-distance.convert('mile')
-# => <Unitwise::Measurement 3.106849747474748 mile>
+5.kilometer.convert_to('mile')
+# => #<Unitwise::Measurement value=3.106849747474748 unit=mile>
 ```
 
-The prettier version of `convert(unit)` is just calling the unit as a method
-name:
+The prettier version of `convert_to(unit)` is appending the unit code, name, etc.
+to a `to_` message.
+name.
 
 ```ruby
-distance = 26.2.mile
-# => <Unitwise::Measurement 26.2 mile>
-
-distance.kilometer
-# => <Unitwise::Measurement 42.164897129794255 kilometer>
+Unitwise(26.2, 'mile').to_kilometer
+# => #<Unitwise::Measurement value=42.164897129794255 unit=kilometer>
 ```
 
 ### Comparison
@@ -66,11 +104,10 @@ It also has the ability to compare measurements with the same or different units
 
 ```ruby
 12.inch == 1.foot # => true
-
 1.meter > 1.yard # => true
 ```
 
-Again, you have to compare compatible units. For example, comparing two 
+Again, you have to compare compatible units. For example, comparing two
 temperatures will work, comparing a mass to a length would fail.
 
 ### SI abbreviations
@@ -78,8 +115,8 @@ temperatures will work, comparing a mass to a length would fail.
 You can use shorthand for SI units.
 
 ```ruby
-1.m  # => <Unitwise::Measurement 1 meter>
-1.ml #=> <Unitwise::Measurement 1 milliliter>
+1000.m == 1.km # => true
+1.ml == 0.001.l # => true
 ```
 
 ### Complex Units
@@ -89,17 +126,17 @@ them -- they can still be converted, compared, or operated on.
 
 ```ruby
 speed = Unitwise(60, 'mile/hour')
-# => <Unitwise::Measurement 60 mile/hour>
+# => #<Unitwise::Measurement value=60 unit=mile/hour>
 
-speed.convert('m/s')
-# => <Unitwise::Measurement 26.822453644907288 m/s>
+speed.convert_to('m/s')
+# => #<Unitwise::Measurement value=26.822453644907288 unit=m/s>
 ```
 
 Exponents and parenthesis are supported as well.
 
 ```ruby
-Unitwise(1000, 'kg.s-1.(m/s)2').watt
-# => <Unitwise::Measurement 1000 watt>
+Unitwise(1000, 'kg.s-1.(m/s)2').to_kilowatt
+# => #<Unitwise::Measurement value=1.0 unit=kilowatt>
 ```
 
 ### Math
@@ -108,39 +145,30 @@ You can add or subtract compatible measurements.
 
 ```ruby
 2.meter + 3.inch - 1.yard
-# => <Unitwise::Measurement 1.1618 meter>
+# => #<Unitwise::Measurement value=1.1618 unit=meter>
 ```
 
 You can multiply or divide measurements and numbers.
 
 ```ruby
 110.volt * 2
-# => <Unitwise::Measurement 220 volt>
+# => #<Unitwise::Measurement value=220 unit=volt>
 ```
 
-You can multiply or divide measurements with measurements. Here is a fun example
-from Physics 101
+You can multiply or divide measurements with measurements.
 
 ```ruby
-m = 20.kg # => <Unitwise::Measurement 20 kg>
-
-a = 10.m / 1.s2 # => <Unitwise::Measurement 10 m/s2>
+20.milligram / 1.liter
+# => #<Unitwise::Measurement value=20 unit=mg/l>
 
-f = m * a # => <Unitwise::Measurement 50 kg.m/s2>
-
-f.newton # => <Unitwise::Measurement 50 newton>
 ```
 
-### Unit Compatibility
-
-Unitwise is fairly intelligent about unit compatibility. It boils each unit down
-to it's basic composition to determine if they are compatible. For instance,
-energy (say a Joule, which can be expressed as kg*m2/s2) would have the 
-components mass<sup>1</sup>, length<sup>2</sup>, and 
-time<sup>-2</sup>. Any unit that could be reduced to this same composition 
-would be considered compatible. 
+Exponentiation is also supported.
 
-I've extracted this datatype into it's own gem ([SignedMultiset](//github.com/joshwlewis/signed_multiset)) if you find this construct interesting.
+```ruby
+(10.cm ** 3).to_liter
+# => #<Unitwise::Measurement value=1.0 unit=liter>
+```
 
 ### Unit Names and Atom Codes
 
@@ -157,30 +185,28 @@ Just as an example, you can see here that there are actually a few versions of i
 and foot:
 
 ```ruby
-1.convert('[ft_i]') == 1.convert('[ft_us]') # => false
+1.convert_to('[ft_i]') == 1.convert_to('[ft_us]') # => false
 
-3.convert('[in_br]') == 3.convert('[in_i]') # => false
+3.convert_to('[in_br]') == 3.convert_to('[in_i]') # => false
 ```
 
 ### Available Units
 
-If you are looking for a particular unit (or 'atom' in the UCUM spec), chances 
-are that it is in here. There is a rudimentary search function for both
-`Unitwise::Atom` and `Unitwise::Prefix`.
+If you are looking for a particular unit, you can search with a string or
+Regexp.
 
 ```ruby
-Unitwise::Atom.search('fathom')
-# => [ ... ]
-Unitwise::Prefix.search('milli')
+Unitwise.search('fathom')
 # => [ ... ]
+
 ```
 
-You can also get the official list from the UCUM website in XML format at 
-[unitsofmeasure.org/ucum-essence.xml](http://unitsofmeasure.org/ucum-essence.xml) 
-or a YAML version within this repo 
+You can also get the official list from the UCUM website in XML format at
+[unitsofmeasure.org/ucum-essence.xml](http://unitsofmeasure.org/ucum-essence.xml)
+or a YAML version within this repo
 [github.com/joshwlewis/unitwise/tree/master/data](//github.com/joshwlewis/unitwise/tree/master/data).
 
-### Supported Ruby Versions
+## Supported Ruby Versions
 
 This library aims to support and is tested against the following Ruby
 implementations:

data/lib/unitwise/atom.rb

@@ -41,26 +41,29 @@ module Unitwise
     # prefixes.
     # @return [true, false]
     # @api public
-    def metric?
-      base? ? true : !!metric
+    def metric
+      base? ? true : !!@metric
     end
+    alias_method :metric?, :metric
 
     # Determine if a unit is special. Special atoms are not defined on a
     # traditional ratio scale.
     # @return [true, false]
     # @api public
-    def special?
-      !!special
+    def special
+      !!@special
     end
+    alias_method :special?, :special
 
     # Determine if a unit is arbitrary. Arbitrary atoms are not of any specific 
     # dimension and have no general meaning, therefore cannot be compared with
     # any other unit.
     # @return [true, false]
     # @api public
-    def arbitrary?
-      !!arbitrary
+    def arbitrary
+      !!@arbitrary
     end
+    alias_method :arbitrary?, :arbitrary
 
     # Determine how far away a unit is from a base unit.
     # @return [Integer]

data/lib/unitwise/base.rb

@@ -7,11 +7,7 @@ module Unitwise
       @all ||= data.map{|d| self.new d }
     end
 
-    def self.find(term)
-      all.find { |i| i.search_strings.any? { |string| string == term } }
-    end
-
-    def self.find_by(method, string)
+    def self.find(string, method=:primary_code)
       self.all.find do |i|
         key = i.send(method)
         if key.respond_to?(:each)
@@ -22,12 +18,6 @@ module Unitwise
       end
     end
 
-    def self.search(term)
-      self.all.select do |i|
-        i.search_strings.any? { |string| string =~ /#{term}/i }
-      end
-    end
-
     def names=(names)
       @names = Array(names)
     end
@@ -38,10 +28,6 @@ module Unitwise
       end
     end
 
-    def search_strings
-      [primary_code, secondary_code, names, slugs, symbol].flatten.compact
-    end
-
     def to_s
       primary_code
     end

data/lib/unitwise/compound.rb

@@ -0,0 +1,76 @@
+module Unitwise
+  # A compound is a combination of an atom and a prefix.
+  # This class is isolated from the rest of the code base and primarily exists
+  # for the convenience of listing and searching possible combinations
+  # of atoms and prefixes.
+  class Compound < Liner.new(:atom, :prefix)
+    # List all possible compounds
+    # @return [Array]
+    # @api public
+    def self.all
+      @all || build
+    end
+
+    # Builds up the list of possible compounds. Only required if you are
+    # defining your own atoms/prefixes.
+    # @return [Array]
+    # @api public
+    def self.build
+      compounds = Atom.all.map { |a| new(a) }
+      Atom.all.select(&:metric).each do |a|
+        Prefix.all.each do |p|
+          compounds << new(a, p)
+        end
+      end
+      @all = compounds
+    end
+
+    # Search for compounds with a search term
+    # @param [String, Regexp] What to search for
+    # @return [Array]
+    # @api public
+    def self.search(term)
+      all.select do |compound|
+        compound.search_strings.any? { |string| Regexp.new(term).match(string) }
+      end
+    end
+
+    [:primary_code, :secondary_code, :symbol].each do |attr|
+      define_method attr do
+        instance_variable_get("@#{attr}") ||
+        instance_variable_set("@#{attr}",
+          prefix ? "#{prefix.send attr}#{atom.send attr}" : atom.send(attr))
+      end
+    end
+
+    [:names, :slugs].each do |attr|
+      define_method attr do
+        instance_variable_get("@#{attr}") ||
+        instance_variable_set("@#{attr}",
+          if prefix
+            prefix.send(attr).zip(atom.send(attr)).map{ |set| set.join('') }
+          else
+            atom.send(attr)
+          end)
+      end
+    end
+
+    def atom=(value)
+      value.is_a?(Atom) ? super(value) : super(Atom.find value)
+    end
+
+    def prefix=(value)
+      value.is_a?(Prefix) ? super(value) : super(Prefix.find value)
+    end
+
+    def search_strings
+      @search_strings ||= [primary_code, secondary_code, symbol, names, slugs].flatten.uniq
+    end
+
+    def attribute_string
+      [:atom, :prefix, :primary_code, :secondary_code, :symbol, :names, :slugs].map do |attr|
+        "#{attr}='#{send attr}'"
+      end.join(', ')
+    end
+  end
+end

data/lib/unitwise/expression/transformer.rb

@@ -5,8 +5,8 @@ module Unitwise
       rule(integer: simple(:i)) { i.to_i }
       rule(fixnum: simple(:f)) { f.to_f }
 
-      rule(prefix_code: simple(:c)) { |ctx| Prefix.find_by(ctx[:key], ctx[:c]) }
-      rule(atom_code: simple(:c))   { |ctx| Atom.find_by(ctx[:key], ctx[:c]) }
+      rule(prefix_code: simple(:c)) { |ctx| Prefix.find(ctx[:c], ctx[:key]) }
+      rule(atom_code: simple(:c))   { |ctx| Atom.find(ctx[:c], ctx[:key]) }
       rule(term: subtree(:h))       { Term.new(h) }
 
       rule(operator: simple(:o), right: simple(:r)) do

data/lib/unitwise/ext/numeric.rb

@@ -1,11 +1,29 @@
 class Numeric
-  def convert(unit)
+  # Converts numeric to a measurement
+  # @param unit [Unitwise::Unit, String] The unit to use in the measurement
+  # @return [Unitwise::Measurement]
+  # @example
+  #   26.2.convert_to('mile') # => #<Unitwise::Measurement 1 mile>
+  # @api public
+  def convert_to(unit)
     Unitwise::Measurement.new(self, unit)
   end
 
+  # Converts numeric to a measurement by the method name
+  # @exmple
+  #   26.2.mile # => #<Unitwise::Measurement 26.2 mile>
+  #   100.to_foot # => #<Unitwise::Measurement 100 foot>
+  # @api semipublic
   def method_missing(meth, *args, &block)
-    convert(meth)
-  rescue Unitwise::ExpressionError
-    super(meth, *args)
+    if args.empty? && !block_given?
+      unit = (match = /\Ato_(\w+)\Z/.match(meth)) ? match[1] : meth
+      begin
+        convert_to(unit)
+      rescue Unitwise::ExpressionError
+        super(meth, *args, &block)
+      end
+    else
+      super(meth, *args, &block)
+    end
   end
 end

data/lib/unitwise/measurement.rb

@@ -23,10 +23,10 @@ module Unitwise
     # @param other_unit [String, Measurement::Unit] Either a string expression
     # or a Measurement::Unit
     # @example
-    #   measurement1.convert('foot')
-    #   measurement2.convert('kilogram')
+    #   measurement1.convert_to('foot')
+    #   measurement2.convert_to('kilogram')
     # @api public
-    def convert(other_unit)
+    def convert_to(other_unit)
       other_unit = Unit.new(other_unit)
       if similar_to?(other_unit)
         new(converted_value(other_unit), other_unit)
@@ -126,13 +126,17 @@ module Unitwise
       Rational(value)
     end
 
-    # Will attempt to convert to a unit by the method name.
+    # Will attempt to convert to a unit by method name.
     # @example
-    #   measurement.foot # => <Unitwise::Measurement 4 foot>
+    #   measurement.to_foot # => <Unitwise::Measurement 4 foot>
     # @api semipublic
     def method_missing(meth, *args, &block)
-      if Unitwise::Expression.decompose(meth)
-        self.convert(meth)
+      if args.empty? && !block_given? && (match = /\Ato_(\w+)\Z/.match(meth))
+        begin
+          convert_to(match[1])
+        rescue ExpressionError
+          super(meth, *args, &block)
+        end
       else
         super(meth, *args, &block)
       end
@@ -168,7 +172,7 @@ module Unitwise
     # @api private
     def combine(operator, other)
       if similar_to?(other)
-        new(value.send(operator, other.convert(unit).value), unit)
+        new(value.send(operator, other.convert_to(unit).value), unit)
       end
     end
 
@@ -179,7 +183,7 @@ module Unitwise
         new(value.send(operator, other), unit)
       elsif other.respond_to?(:composition)
         if similar_to?(other)
-          converted = other.convert(unit)
+          converted = other.convert_to(unit)
           new(value.send(operator, converted.value), unit.send(operator, converted.unit))
         else
           new(value.send(operator, other.value), unit.send(operator, other.unit))

data/lib/unitwise/scale.rb

@@ -14,13 +14,6 @@ module Unitwise
       @unit.is_a?(Unit) ? @unit : Unit.new(@unit)
     end
 
-    # Duplicate this instance
-    # @return [Unitwise::Unit]
-    # @api public
-    def dup
-      self.class.new(value, unit)
-    end
-
     # List the atoms associated with this scale's unit.
     # @return [Array]
     # @api public
@@ -28,7 +21,7 @@ module Unitwise
       unit.atoms
     end
 
-    # List the atoms associated with this scale's unit.
+    # List the terms associated with this scale's unit.
     # @return [Array]
     # @api public
     def terms
@@ -74,18 +67,14 @@ module Unitwise
       unit.depth + 1
     end
 
-    # Is this the deepest level scale in the scale chain?
-    # @return [true, false]
-    # @api public
-    def terminal?
-      depth <= 3
-    end
-
     # Convert to a simple string representing the scale.
     # @api public
     def to_s
       "#{value} #{unit}"
     end
 
+    def inspect
+      "#<#{self.class} value=#{value} unit=#{unit}>"
+    end
   end
 end

data/lib/unitwise/unit.rb

@@ -34,28 +34,16 @@ module Unitwise
       terms.first.functional(x, forward)
     end
 
-    def dup
-      self.class.new(expression)
-    end
-
     def depth
       terms.map(&:depth).max + 1
     end
 
-    def terminal?
-      depth <= 3
-    end
-
     def root_terms
       terms.flat_map(&:root_terms)
     end
 
     def scalar
-      if terms.empty?
-        1
-      else
-        terms.map(&:scalar).inject(&:*)
-      end
+      terms.map(&:scalar).inject(&:*)
     end
 
     def *(other)

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/unitwise.rb

@@ -11,11 +11,22 @@ require 'unitwise/atom'
 require 'unitwise/prefix'
 require 'unitwise/term'
 require 'unitwise/unit'
+require 'unitwise/compound'
 require 'unitwise/errors'
 
-# Unitwise is a library for performing mathematical operations and conversions 
+# Unitwise is a library for performing mathematical operations and conversions
 # on all units defined by the [Unified Code for Units of Measure(UCUM).
 module Unitwise
+
+  # Search for available compounds. This is just a helper method for
+  # convenience
+  # @param term [String, Regexp]
+  # @return [Array]
+  # @api public
+  def self.search(term)
+    Compound.search(term)
+  end
+  
   # The system path for the installed gem
   # @api private
   def self.path
@@ -44,4 +55,3 @@ def Unitwise(first, last=nil)
     Unitwise::Measurement.new(1, first)
   end
 end
-

data/test/support/scale_tests.rb

@@ -36,16 +36,6 @@ module ScaleTests
         end
       end
 
-      describe "#dup" do
-        it "must return a new instance" do
-          subject.must_respond_to(:dup)
-          subject.dup.must_be_instance_of(described_class)
-          subject.dup.value.must_equal subject.value
-          subject.dup.unit.to_s.must_equal subject.unit.to_s
-          subject.dup.object_id.wont_equal subject.dup.object_id
-        end
-      end
-
       describe "#terms" do
         it "must return an array of terms" do
           subject.terms.must_be_kind_of(Enumerable)
@@ -90,12 +80,6 @@ module ScaleTests
         end
       end
 
-      describe "#terminal?" do
-        it "must return true for the last of kind in the chain" do
-          subject.terminal?.must_equal false
-          k.terminal?.must_equal true
-        end
-      end
     end
   end
 end

data/test/unitwise/atom_test.rb

@@ -23,14 +23,6 @@ describe Unitwise::Atom do
     end
   end
 
-  describe "::search" do
-    it "must search for atoms" do
-      result = subject.search("inch")
-      result.count.must_equal 10
-      result.must_include subject.find("inch")
-    end
-  end
-
   let(:second)  { Unitwise::Atom.find("s") }
   let(:yard)    { Unitwise::Atom.find("[yd_i]")}
   let(:pi)      { Unitwise::Atom.find("[pi]")}

data/test/unitwise/compound_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+describe Unitwise::Compound do
+  describe :class_methods do
+    describe :all do
+      subject { Unitwise::Compound.all }
+      it { subject.must_be_kind_of Enumerable }
+      it { subject.first.must_be_instance_of Unitwise::Compound }
+    end
+    describe :search do
+      it "should return a list of units" do
+        search = Unitwise::Compound.search('foo')
+        search.must_be_kind_of Enumerable
+        search.first.must_be_instance_of Unitwise::Compound
+      end
+    end
+  end
+
+  describe :instance_methods do
+    let(:prefixed)   { Unitwise::Compound.new('m','k') }
+    let(:unprefixed) { Unitwise::Compound.new("[in_i]") }
+    it "should have an atom" do
+      [prefixed, unprefixed].each { |ex| ex.atom.must_be_instance_of Unitwise::Atom }
+    end
+    it "should have a prefix when appropriate" do
+      prefixed.prefix.must_be_instance_of Unitwise::Prefix
+      unprefixed.prefix.must_equal nil
+    end
+    it "should concatenate common methods" do
+      prefixed.primary_code.must_equal 'km'
+      unprefixed.secondary_code.must_equal '[IN_I]'
+      prefixed.names.must_equal ['kilometer']
+      unprefixed.slugs.must_equal ['inch']
+    end
+    it "should have an array of strings for searching" do
+      prefixed.search_strings.must_be_kind_of(Array)
+    end
+    it "should look ok for inspection" do
+      prefixed.inspect.must_include 'km'
+      unprefixed.inspect.must_include '[IN_I]'
+    end
+  end
+end

data/test/unitwise/ext/numeric_test.rb

@@ -4,42 +4,47 @@ describe Numeric do
 
   describe "#convert" do
     it "must work for Integer" do
-      measurement = 22.convert("kg")
+      measurement = 22.convert_to("kg")
       measurement.must_be_instance_of(Unitwise::Measurement)
       measurement.value.must_equal 22
     end
     it "must work for Fixnum" do
-      measurement = 24.25.convert("[ft_i]")
+      measurement = 24.25.convert_to("[ft_i]")
       measurement.must_be_instance_of(Unitwise::Measurement)
       measurement.value.must_equal 24.25
     end
     it "must work for Float" do
-      measurement = (22.0/7).convert("[mi_i]")
+      measurement = (22.0/7).convert_to("[mi_i]")
       measurement.must_be_instance_of(Unitwise::Measurement)
       measurement.value.must_equal 3.142857142857143
     end
     it "must work for Rational" do
-      measurement = Rational(22/7).convert("N/m2")
+      measurement = Rational(22/7).convert_to("N/m2")
       measurement.must_be_instance_of(Unitwise::Measurement)
       measurement.value.must_equal Rational(22/7)
     end
   end
 
   describe "#method_missing" do
-    it "must match mm" do
+    it "must match 'mm'" do
       mm = 2.5.mm
       mm.must_be_instance_of(Unitwise::Measurement)
       mm.value.must_equal 2.5
     end
-    it "must match foot" do
-      ft = 4.foot
-      ft.must_be_instance_of(Unitwise::Measurement)
-      ft.value.must_equal 4
+    it "must match 'to_mm'" do
+      mm = 2.5.to_mm
+      mm.must_be_instance_of(Unitwise::Measurement)
+      mm.value.must_equal 2.5
     end
+
     it "must not match 'foo'" do
       ->{ 1.foo }.must_raise NoMethodError
     end
 
+    it "must not match 'to_foo'" do
+      ->{ 1.to_foo }.must_raise NoMethodError
+    end
+
   end
 
 

data/test/unitwise/measurement_test.rb

@@ -11,27 +11,27 @@ describe Unitwise::Measurement do
     end
   end
 
-  describe "#convert" do
+  describe "#convert_to" do
     it "must convert to a similar unit code" do
-      mph.convert('km/h').value.must_equal 96.56063999999999
+      mph.convert_to('km/h').value.must_equal 96.56063999999999
     end
     it "must raise an error if the units aren't similar" do
-      ->{ mph.convert('N') }.must_raise Unitwise::ConversionError
+      ->{ mph.convert_to('N') }.must_raise Unitwise::ConversionError
     end
     it "must convert special units to their base units" do
-      cel.convert('K').value.must_equal 295.15
+      cel.convert_to('K').value.must_equal 295.15
     end
     it "must convert base units to special units" do
-      k.convert('Cel').value.must_equal 100
+      k.convert_to('Cel').value.must_equal 100
     end
     it "must convert special units to special units" do
-      f.convert('Cel').value.must_equal 37
+      f.convert_to('Cel').value.must_equal 37
     end
     it "must convert special units to non-special units" do
-      cel.convert("[degR]").value.must_equal 531.27
+      cel.convert_to("[degR]").value.must_equal 531.27
     end
     it "must convert derived units to special units" do
-      r.convert("Cel").value.round.must_equal 0
+      r.convert_to("Cel").value.round.must_equal 0
     end
   end
 
@@ -127,14 +127,14 @@ describe Unitwise::Measurement do
 
   describe "#method_missing" do
     let(:meter) { Unitwise::Measurement.new(1, 'm')}
-    it "must convert 'mm'" do
-      convert = meter.mm
+    it "must convert 'to_mm'" do
+      convert = meter.to_mm
       convert.must_be_instance_of Unitwise::Measurement
       convert.value.must_equal 1000
     end
 
-    it "must convert 'foot'" do
-      convert = meter.foot
+    it "must convert 'to_foot'" do
+      convert = meter.to_foot
       convert.must_be_instance_of Unitwise::Measurement
       convert.value.must_equal 3.280839895013123
     end
@@ -143,6 +143,10 @@ describe Unitwise::Measurement do
       ->{ meter.foo }.must_raise NoMethodError
     end
 
+    it "must not convert 'to_foo'" do
+      ->{ meter.to_foo }.must_raise NoMethodError
+    end
+
   end
 
   describe "#to_f" do

data/test/unitwise/prefix_test.rb

@@ -22,12 +22,4 @@ describe Unitwise::Prefix do
     end
   end
 
-  describe "#search" do
-    it "should search for a prefix" do
-      result = subject.search("mi")
-      result.count.must_equal 3
-      result.must_include subject.find("milli")
-    end
-  end
-
 end

data/test/unitwise_test.rb

@@ -9,7 +9,15 @@ describe Unitwise do
       Unitwise('kg').must_be_instance_of Unitwise::Measurement
     end
   end
+
+  describe 'search' do
+    it "must return results" do
+      Unitwise.search('foo').must_be_instance_of(Array)
+    end
+  end
+
   it "should have a path" do
     Unitwise.path.must_match(/unitwise$/)
   end
-end
+
+end

data/unitwise.gemspec

@@ -17,13 +17,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^test/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "liner", "~> 0.2.1"
-  gem.add_dependency "signed_multiset", "~> 0.2.0"
-  gem.add_dependency "parslet", "~> 1.5.0"
+  gem.add_dependency "liner", "~> 0.2"
+  gem.add_dependency "signed_multiset", "~> 0.2"
+  gem.add_dependency "parslet", "~> 1.5"
 
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "nori"
-  gem.add_development_dependency "nokogiri"
-  gem.add_development_dependency "coveralls"
+  gem.add_development_dependency "minitest",  ">= 5.0"
+  gem.add_development_dependency "rake",      ">= 10.0"
+  gem.add_development_dependency "nori",      "~> 2.3"
+  gem.add_development_dependency "nokogiri",  "~> 1.6"
+  gem.add_development_dependency "coveralls", "~> 0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-01 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
@@ -16,112 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: signed_multiset
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 description: Ruby implementation of the Unified Code for Units of Measure (UCUM)
 email:
 - josh.w.lewis@gmail.com
@@ -143,6 +143,7 @@ files:
 - lib/unitwise/atom.rb
 - lib/unitwise/base.rb
 - lib/unitwise/composable.rb
+- lib/unitwise/compound.rb
 - lib/unitwise/errors.rb
 - lib/unitwise/expression.rb
 - lib/unitwise/expression/composer.rb
@@ -172,6 +173,7 @@ files:
 - test/test_helper.rb
 - test/unitwise/atom_test.rb
 - test/unitwise/base_test.rb
+- test/unitwise/compound_test.rb
 - test/unitwise/expression/decomposer_test.rb
 - test/unitwise/expression/matcher_test.rb
 - test/unitwise/expression/parser_test.rb
@@ -214,6 +216,7 @@ test_files:
 - test/test_helper.rb
 - test/unitwise/atom_test.rb
 - test/unitwise/base_test.rb
+- test/unitwise/compound_test.rb
 - test/unitwise/expression/decomposer_test.rb
 - test/unitwise/expression/matcher_test.rb
 - test/unitwise/expression/parser_test.rb
@@ -225,3 +228,4 @@ test_files:
 - test/unitwise/term_test.rb
 - test/unitwise/unit_test.rb
 - test/unitwise_test.rb
+has_rdoc: