ruby-measurement 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## ruby-measurement 1.2.0 (Mar 16, 2013)
+
+* Implement `String#to_measurement`, `String#to_unit`,
+  `Symbol#to_unit`, and `Numeric#to_measurement`. *Matt Huggins*
+
 ## ruby-measurement 1.1.0 (Feb 6, 2013)
 
 * Move unit definition logic into `Unit` class. *Matt Huggins*

data/README.md

@@ -1,6 +1,7 @@
 # Measurement
 
 [![Build Status](https://secure.travis-ci.org/mhuggins/ruby-measurement.png)](http://travis-ci.org/mhuggins/ruby-measurement)
+[![Code Climate](https://codeclimate.com/github/mhuggins/ruby-measurement.png)](https://codeclimate.com/github/mhuggins/ruby-measurement)
 
 [ruby-measurement](https://github.com/mhuggins/ruby-measurement) is a simple
 Ruby gem for calculating and converting units of measure.
@@ -23,60 +24,79 @@ Or install it yourself as:
 
 The `Measurement` class is responsible for parsing strings to determine the
 quantity entered as well as the unit of measure.  This can be done through the
-`parse` method.
+`parse` method, which returns a `Measurement` object.
 
-    Measurement.parse('3 feet')      # => 3.0 ft.
-    Measurement.parse('25 fl oz')    # => 25.0 fl. oz.
-    Measurement.parse('12 tonnes')   # => 12.0 t
-    Measurement.parse('25 "')        # => 25.0 in.
+    Measurement.parse('3 feet')                # => 3.0 ft.
+    Measurement.parse('25 fl oz')              # => 25.0 fl. oz.
+    Measurement.parse('12 tonnes')             # => 12.0 t
+    Measurement.parse('25 "')                  # => 25.0 in.
 
-The object returned by `Measurement.parse` is of type `Measurement`.
+A measurement includes both a quantity and a unit.  Refer to the "Units"
+section below for more details on how to interact with a unit.
 
-    m = Measurement.parse('12 yd')   # => 12.0 yd.
-    Measurement.quantity             # => 12.0
-    Measurement.unit                 # => yd.
+    measurement = Measurement.parse('12 yd')   # => 12.0 yd.
+    measurement.quantity                       # => 12.0
+    measurement.unit                           # => yd.
 
-The object returned by `Measurement#unit` is of type `Measurement::Unit`.
+The `String` and `Numeric` classes have also been extended to simplify the
+parsing of measurement values.
 
-    u = Measurement.unit             # => yd.
-    u.name                           # => "yd."
-    u.aliases                        # => ["yd.", "yd", "yard", "yards"]
+    '12 yd'.to_measurement                     # => 12.0 yd.
+    20.to_measurement                          # => 20.0 count
 
-## Converting units
+### Units
+
+The `Measurement::Unit` class is used to represent the units for a measurement.
+Predefined units can be looked up via `Measurement::Unit[]`.
+
+    unit = Measurement::Unit[:dozen]           # => doz
+
+Similarly, the `String#to_unit` and `Symbol#to_unit` method can be used to
+accomplish the same thing.
+
+    unit = 'dozen'.to_unit                     # => doz
+    unit = :dozen.to_unit                      # => doz
+
+Units provide access to their names and aliases.
+
+    unit.name                                  # => "yd."
+    unit.aliases                               # => ["yd.", "yd", "yard", "yards"]
+
+### Converting units
 
 This gem allows you to convert among compatible units as long as a conversion
 has been supplied when defining a unit.  The default supplied units include
 conversions among the same unit types (e.g.: converting feet to yards or meters
 to kilometers).
 
-    m = Measurement.parse('3 feet')  # => 3.0 ft.
-    m.convert_to(:yards)             # => 1.0 yd.
-    m.convert_to(:in)                # => 36.0 in.
-    m.convert_to(:inches)            # => 36.0 in.
+    measurement = Measurement.parse('3 feet')  # => 3.0 ft.
+    measurement.convert_to(:yards)             # => 1.0 yd.
+    measurement.convert_to(:in)                # => 36.0 in.
+    measurement.convert_to(:inches)            # => 36.0 in.
 
 NOTE: Converting between metric and U.S. customary systems is currently not
 included by default.  It is intended to be shipped in a future release.
 
-## Calculations
+### Calculations
 
 This gem allows you to add, subtract, multiply, or divide measurements that can
 be converted into one-another.
 
-    m1 = Measurement.parse('3 feet') # => 3.0 ft.
-    m2 = Measurement.parse('6 inch') # => 6.0 in.
-    m1 + m2                          # => 3.5 ft.
+    measurement1 = Measurement.parse('3 feet') # => 3.0 ft.
+    measurement2 = Measurement.parse('6 inch') # => 6.0 in.
+    measurement1 + measurement2                # => 3.5 ft.
 
 Additionally, measurements can have basic math operations performed using basic
 numeric values.
 
-    m = Measurement.parse('2 yards') # => 2.0 yd.
-    m * 6                            # => 12.0 yd.
-    m / 5                            # => 0.4 yd.
-    m + 3                            # => 5.0 yd.
-    m - 1                            # => 1.0 yd.
-    m ** 2                           # => 4.0 yd.
+    measurement = Measurement.parse('2 yards') # => 2.0 yd.
+    measurement * 6                            # => 12.0 yd.
+    measurement / 5                            # => 0.4 yd.
+    measurement + 3                            # => 5.0 yd.
+    measurement - 1                            # => 1.0 yd.
+    measurement ** 2                           # => 4.0 yd.
 
-## Specifying units
+### Specifying units
 
 By default, ruby-measurement ships with common areas, lengths, volumes, and
 weights/masses for the metric and U.S. customary systems.  This happens
@@ -112,7 +132,7 @@ system.
     require 'ruby-measurement/definitions/us_customary/volume'
     require 'ruby-measurement/definitions/us_customary/weight'
 
-## Defining custom units & conversions
+### Defining custom units & conversions
 
 This gem also enabled you to define units of measure that aren't included by
 default.
@@ -138,9 +158,9 @@ default.
 Note that the first value passed to `Measurement.define` is the unit format
 that will be used when displaying a measurement.
 
-    Measurement.parse('3 yr')        # => 3.0 yr
-    Measurement.parse('3 year')      # => 3.0 yr
-    Measurement.parse('3 years')     # => 3.0 yr
+    Measurement.parse('3 yr')                  # => 3.0 yr
+    Measurement.parse('3 year')                # => 3.0 yr
+    Measurement.parse('3 years')               # => 3.0 yr
 
 ## Contributing
 

data/lib/ruby-measurement.rb

@@ -1,3 +1,4 @@
 require 'ruby-measurement/version'
+require 'ruby-measurement/core_ext'
 require 'ruby-measurement/measurement'
 require 'ruby-measurement/definitions'

data/lib/ruby-measurement/core_ext.rb

@@ -0,0 +1,3 @@
+require 'ruby-measurement/core_ext/numeric'
+require 'ruby-measurement/core_ext/string'
+require 'ruby-measurement/core_ext/symbol'

data/lib/ruby-measurement/core_ext/numeric.rb

@@ -0,0 +1,7 @@
+require 'ruby-measurement/measurement'
+
+class Numeric
+  def to_measurement
+    Measurement.new(self)
+  end
+end

data/lib/ruby-measurement/core_ext/string.rb

@@ -0,0 +1,11 @@
+require 'ruby-measurement/measurement'
+
+class String
+  def to_measurement
+    Measurement.parse(self)
+  end
+  
+  def to_unit
+    Measurement::Unit[self] or raise ArgumentError, "Invalid unit: #{self}"
+  end
+end

data/lib/ruby-measurement/core_ext/symbol.rb

@@ -0,0 +1,7 @@
+require 'ruby-measurement/unit'
+
+class Symbol
+  def to_unit
+    Measurement::Unit[self] or raise ArgumentError, "Invalid unit: #{self}"
+  end
+end

data/lib/ruby-measurement/measurement.rb

@@ -29,64 +29,23 @@ class Measurement
     "#{quantity} #{unit}"
   end
   
-  def +(obj)
-    case obj
-    when Numeric
-      self.class.new(quantity + obj.to_f, unit)
-    when self.class
-      if obj.unit == unit
-        self.class.new(quantity + obj.quantity, unit)
-      else
-        self + obj.convert_to(unit)
-      end
-    else
-      raise ArgumentError, "Invalid arithmetic: #{self} + #{obj}"
-    end
-  end
-  
-  def -(obj)
-    case obj
-    when Numeric
-      self.class.new(quantity - obj.to_f, unit)
-    when self.class
-      if obj.unit == unit
-        self.class.new(quantity - obj.quantity, unit)
-      else
-        self - obj.convert_to(unit)
+  %w(+ - * /).each do |operator|
+    class_eval <<-END, __FILE__, __LINE__ + 1
+      def #{operator}(obj)
+        case obj
+        when Numeric
+          self.class.new(quantity #{operator} obj.to_f, unit)
+        when self.class
+          if obj.unit == unit
+            self.class.new(quantity #{operator} obj.quantity, unit)
+          else
+            self #{operator} obj.convert_to(unit)
+          end
+        else
+          raise ArgumentError, "Invalid arithmetic: \#{self} #{operator} \#{obj}"
+        end
       end
-    else
-      raise ArgumentError, "Invalid arithmetic: #{self} - #{obj}"
-    end
-  end
-  
-  def *(obj)
-    case obj
-    when Numeric
-      self.class.new(quantity * obj.to_f, unit)
-    when self.class
-      if obj.unit == unit
-        self.class.new(quantity * obj.quantity, unit)
-      else
-        self * obj.convert_to(unit)
-      end
-    else
-      raise ArgumentError, "Invalid arithmetic: #{self} * #{obj}"
-    end
-  end
-  
-  def /(obj)
-    case obj
-    when Numeric
-      self.class.new(quantity / obj.to_f, unit)
-    when self.class
-      if obj.unit == unit
-        self.class.new(quantity / obj.quantity, unit)
-      else
-        self / obj.convert_to(unit)
-      end
-    else
-      raise ArgumentError, "Invalid arithmetic: #{self} / #{obj}"
-    end
+    END
   end
   
   def **(obj)
@@ -131,7 +90,7 @@ class Measurement
       quantity = whole.to_f
     elsif str =~ RATIONAL_REGEX
       whole, _, numerator, denominator, unit_name = str.scan(RATIONAL_REGEX).first
-
+      
       if numerator && denominator
         numerator = numerator.to_f + (denominator.to_f * whole.to_f)
         denominator = denominator.to_f
@@ -154,6 +113,8 @@ class Measurement
     Unit.define(unit_name, &block)
   end
   
+  private
+  
   define(:count) do |unit|
     unit.convert_to(:dozen) { |value| value / 12.0 }
   end

data/lib/ruby-measurement/version.rb

@@ -1,3 +1,3 @@
 class Measurement
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/ruby-measurement/core_ext/numeric_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Numeric do
+  describe '#to_measurement' do
+    subject { 20 }
+    specify { subject.to_measurement.should eq Measurement.new(20) }
+  end
+end

data/spec/ruby-measurement/core_ext/string_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe String do
+  describe '#to_measurement' do
+    describe 'with valid quantity' do
+      subject { '3' }
+      specify { subject.to_measurement.should eq Measurement.new(3) }
+    end
+    
+    describe 'with valid quantity and unit' do
+      subject { '3 dozen' }
+      specify { subject.to_measurement.should eq Measurement.new(3, :dozen) }
+    end
+    
+    describe 'with valid quantity and invalid unit' do
+      subject { '3 people' }
+      specify { expect { subject.to_measurement }.to raise_error }
+    end
+    
+    describe 'with invalid input' do
+      subject { 'foobar' }
+      specify { expect { subject.to_measurement }.to raise_error }
+    end
+  end
+  
+  describe '#to_unit' do
+    describe 'with valid unit' do
+      subject { 'dozen' }
+      specify { subject.to_unit.should eq Measurement::Unit[:dozen] }
+    end
+    
+    describe 'with invalid unit' do
+      subject { 'person' }
+      specify { expect { subject.to_unit }.to raise_error }
+    end
+  end
+end

data/spec/ruby-measurement/core_ext/symbol_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Symbol do
+  describe '#to_unit' do
+    describe 'with valid unit' do
+      subject { :dozen }
+      specify { subject.to_unit.should eq Measurement::Unit[:dozen] }
+    end
+
+    describe 'with invalid unit' do
+      subject { :person }
+      specify { expect { subject.to_unit }.to raise_error }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-measurement
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152673660 !ruby/object:Gem::Requirement
+  requirement: &2160834380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152673660
+  version_requirements: *2160834380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152672480 !ruby/object:Gem::Requirement
+  requirement: &2160833960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152672480
+  version_requirements: *2160833960
 description: Simple gem for calculating and converting measurements
 email: matt.huggins@gmail.com
 executables: []
@@ -47,6 +47,10 @@ files:
 - README.md
 - Rakefile
 - lib/ruby-measurement.rb
+- lib/ruby-measurement/core_ext.rb
+- lib/ruby-measurement/core_ext/numeric.rb
+- lib/ruby-measurement/core_ext/string.rb
+- lib/ruby-measurement/core_ext/symbol.rb
 - lib/ruby-measurement/definitions.rb
 - lib/ruby-measurement/definitions/metric.rb
 - lib/ruby-measurement/definitions/metric/area.rb
@@ -64,6 +68,9 @@ files:
 - lib/ruby-measurement/unit.rb
 - lib/ruby-measurement/version.rb
 - ruby-measurement.gemspec
+- spec/ruby-measurement/core_ext/numeric_spec.rb
+- spec/ruby-measurement/core_ext/string_spec.rb
+- spec/ruby-measurement/core_ext/symbol_spec.rb
 - spec/ruby-measurement/definitions/metric/area_spec.rb
 - spec/ruby-measurement/definitions/metric/capacity_spec.rb
 - spec/ruby-measurement/definitions/metric/length_spec.rb
@@ -105,6 +112,9 @@ signing_key:
 specification_version: 3
 summary: Simple gem for calculating and converting measurements
 test_files:
+- spec/ruby-measurement/core_ext/numeric_spec.rb
+- spec/ruby-measurement/core_ext/string_spec.rb
+- spec/ruby-measurement/core_ext/symbol_spec.rb
 - spec/ruby-measurement/definitions/metric/area_spec.rb
 - spec/ruby-measurement/definitions/metric/capacity_spec.rb
 - spec/ruby-measurement/definitions/metric/length_spec.rb