quantify 3.1.1 → 3.1.2

data/{README → README.md}

@@ -1,11 +1,19 @@
-A gem to support physical quantities and unit conversions
+Quantify
+========
+
+A gem to support physical quantities and unit conversions in Ruby
+
 Licensed under the MIT license (See COPYING file for details)
+
 Author: Andrew Berkeley (andrew.berkeley.is@googlemail.com)
+
 Homepage: https://github.com/spatchcock/quantify
 
+
 Quick introduction
+------------------
 
-  # Quantity operations
+Operating on quantities
 
   12.feet + 12.feet                   => "24.0 feet"
 
@@ -19,11 +27,11 @@ Quick introduction
 
   Unit.ratio :kg, :ton                => "1.016047 kilograms per long ton"
 
-  # Note: these results are string representations of the actual objects
-  # which result from these operations, using the Quantity#to_s method which
-  # renders quantities using either the unit name or symbol.
+Note: these results are string representations of the actual objects
+which result from these operations, using the Quantity#to_s method which
+renders quantities using either the unit name or symbol.
 
-  # Handling units
+Handling units
 
   Unit.ton.name                       => "long ton"
 
@@ -58,27 +66,17 @@ Quick introduction
 
   
 General introduction
+--------------------
 
 Quantify represents physical quantities using the Quantify::Quantity class.
 
 A Quantity object holds both a value (Numeric) and a unit (of the class
-Quantify::Unit::Base), for example a Quantity object might represent 12 kgs
-(value, 12; unit, kilogram).
-
-Quantities can be manipulated and operated on, in all of the ways that might be
-required for real physical quantities. Operations include, addition, subtraction,
-multiplying and dividing by scalar values or other quantities, raising to powers,
-converting into alternative unit representations (e.g. kgs to lbs, miles per hour
-to metres per second), and rounding of values. Quantify handles the converting of
-both values and units so that the result is a an accurate representation of the
-operation. For example, multiplying 10 metres by 10 metres will result in a quanity
-of square metres, whereas dividing, say, 10 metres by 2 seconds will result in a
-quantity in metres per second.
-
-In all cases the results of operations are a changes to the Quantity instance or
-a new instance of a Quantity object. The new value or unit can be accessed using
-the #value and #unit attributes, or the #to_s method which renders the quantity
-in string form.
+Quantify::Unit::Base), for example a Quantity object might represent 12 kgs (value, 12; unit, kilogram).
+
+Quantities can be manipulated and operated on, in all of the ways that might be required for real physical quantities. Operations include, addition, subtraction, multiplying and dividing by scalar values or other quantities, raising to powers, converting into alternative unit representations (e.g. kgs to lbs, miles per hour to metres per second), and rounding of values. Quantify handles the converting of both values and units so that the result is a an accurate representation of the
+operation. For example, multiplying 10 metres by 10 metres will result in a quanity of square metres, whereas dividing, say, 10 metres by 2 seconds will result in a quantity in metres per second.
+
+In all cases the results of operations are a changes to the Quantity instance or a new instance of a Quantity object. The new value or unit can be accessed using the #value and #unit attributes, or the #to_s method which renders the quantity in string form.
 
 There are several ways to initialize a quantity object
 
@@ -119,8 +117,7 @@ Convert a quantity to a different unit
   unit = Unit.MJ                        => <Quantify::Unit::SI:0xb75c9718 ... >
   new_energy = energy.to(unit)          => "360.0 MJ"
 
-  # Note: all of the above results are string representations of the actual 
-  # objects which result from these operations.
+Note: all of the above results are string representations of the actual objects which result from these operations.
 
 Convert the units of a quantity with a compound unit
 
@@ -130,16 +127,15 @@ Convert the units of a quantity with a compound unit
 
   speed_in_mins = speed_in_kms.to_min   => "1.877568 km/min"
 
-  # Note: all of the above results are string representations of the actual
-  # objects which result from these operations.
+Note: all of the above results are string representations of the actual objects which result from these operations.
 
 Convert a quantity to the corresponding SI unit
 
   energy = 100.kWh                      => "100 kWh"
   si = quantity.to_si                   => "360000000.0 J"
 
-  # Note: all of the above results are string representations of the actual
-  # objects which result from these operations.
+Note: all of the above results are string representations of the actual
+objects which result from these operations.
 
 Operate on a quantity
 
@@ -156,52 +152,41 @@ Operate on a quantity
   distance = speed * time               => <Quantify::Quantity:7d7f8g9d5g ... >
   distance.to_s                         => "35.0 mi"
 
-  # Note: all of the above results are string representations of the actual
-  # objects which result from these operations.
+Note: all of the above results are string representations of the actual
+objects which result from these operations.
 
 Additional operations
-The result of quantity operations is commonly a new quantity with a compound unit.
-Unless the result is equivalent to one of the base SI units (m, kg, s, K, etc.) or
-one of the following, square metre, cubic metre, joule, watt, newton or pascal, then
-the compound unit represents appropriate combination of the units involved, albeit
-with any like-units within the numerator and denominator grouped under a single
+The result of quantity operations is commonly a new quantity with a compound unit. Unless the result is equivalent to one of the base SI units (m, kg, s, K, etc.) or one of the following, square metre, cubic metre, joule, watt, newton or pascal, then the compound unit represents appropriate combination of the units involved, albeit with any like-units within the numerator and denominator grouped under a single
 power/index.
 
-Units are not automatically cancelled or rationalized (made consistent). This is
-because it cannot be assumed that that is the desire of the user. For example, a
-quantity with units <mass> per <mass> is technically dimensionless, but the user
-might prefer to explicitly represent the units rather than reduce to a dimensionless
-quantity. In addition, this quantity might be expressed in terms of grams per tonne,
-and the user may not necessarily prefer a conversion into consistent mass units
-(e.g. g/g or t/t). Therefore, the following methods are available...
+Units are not automatically cancelled or rationalized (made consistent). This is because it cannot be assumed that that is the desire of the user. For example, a quantity with units <mass> per <mass> is technically dimensionless, but the user might prefer to explicitly represent the units rather than reduce to a dimensionless quantity. In addition, this quantity might be expressed in terms of grams per tonne,
+and the user may not necessarily prefer a conversion into consistent mass units (e.g. g/g or t/t). Therefore, the following methods are available...
+
+Where units representing the same physical quantity appear together, they can be made consistent by simply converting to the unit which is desired:
 
-  # Where units representing the same physical quantity appear together, they can
-  # made consistent by simply converting to the unit which is desired
   area = 12.yd * 36.ft                  => <Quantify::Quantity:0xb7332bbc ... >
   area.to_s                             => "432.0 yd ft"
   area.to_yd
   area.to_s                             => "144.0 yd²"
 
-  # Alternatively, all units within the numerator and denominator respectively
-  # can be standardized.
+Alternatively, all units within the numerator and denominator respectively can be standardized:
+
   quantity = (12.ft*8.mi)/(1.s*8.min)
   quantity.to_s                         => 12.0 ft mi/s min
   quantity.rationalize_units!
   quantity.to_s                         => 1056.0 ft²/s²
 
-  # A quantity with arbitrary cancelable units can be cancelled manually
+A quantity with arbitrary cancelable units can be cancelled manually:
+
   quantity = (12.m**6) / 2.m**2
   quantity.to_s                         => "746496.0 m^6/m²"
   quantity.cancel_base_units! :m
   quantity.to_s                         => "746496.0 m^4"
 
-Note: there are more comprehensive and flexible methods for manupulating compound
-units available as part of of the class Unit::Compound. These can be used to
-convert a conpound unit into the precise form required. If such an approach is
-used, any quantity object can be converted to the new form by simply passing the
-new unit object into the Quantity#to method.
+Note: there are more comprehensive and flexible methods for manupulating compound units available as part of of the class Unit::Compound. These can be used to convert a conpound unit into the precise form required. If such an approach is used, any quantity object can be converted to the new form by simply passing the new unit object into the Quantity#to method.
 
-Initialize a unit object
+Initializing unit objects
+-------------------------
 
   unit = Unit.for :km                    => <Quantify::Unit::SI:0xb75c9718 ... >
   unit = Unit.km                         => <Quantify::Unit::SI:0xb75c9718 ... >

data/VERSION

@@ -1 +1 @@
-3.1.1
+3.1.2

data/lib/quantify/core_extensions/range.rb

@@ -0,0 +1,5 @@
+if RUBY_VERSION < "1.9"
+  class Range
+	alias :cover? include?
+  end
+end

data/lib/quantify/dimensions.rb

@@ -352,14 +352,14 @@ module Quantify
     # quantities which represent a quantity of something *per unit mass*
     #
     def is_specific_quantity?
-      denominator_quantities == ["@mass"]
+      denominator_quantities == [:@mass]
     end
 
     # Method for identifying quantities which are 'molar' quantities, i.e
     # quantities which represent a quantity of something *per mole*
     #
     def is_molar_quantity?
-      denominator_quantities == ["@amount_of_substance"]
+      denominator_quantities == [:@amount_of_substance]
     end
 
 
@@ -456,10 +456,11 @@ module Quantify
       quantities = self.instance_variables
       if RUBY_VERSION < "1.9"
         quantities.delete("@physical_quantity")
+        return quantities.map(&:to_sym)
       else
         quantities.delete(:@physical_quantity)
+        return quantities
       end
-      return quantities
     end
 
     # Just the base quantities which have positive indices

data/lib/quantify/quantity.rb

@@ -251,7 +251,7 @@ module Quantify
 
     def ===(range)
       raise Exceptions::InvalidArgumentError unless range.is_a? Range
-      range.include? self
+      range.cover? self
     end
 
     protected
@@ -297,7 +297,7 @@ module Quantify
       old_unit = @unit
       self.multiply!(Unit.ratio new_unit, old_unit)
       old_base_units = old_unit.base_units.map { |base| base.unit } if old_unit.is_compound_unit?
-      self.cancel_base_units!(*old_base_units || old_unit)
+      self.cancel_base_units!(*old_base_units || [old_unit])
     end
 
     def conversion_with_scalings!(new_unit)

data/lib/quantify.rb

@@ -11,6 +11,7 @@ require 'quantify/quantify'
 require 'quantify/core_extensions/string'
 require 'quantify/core_extensions/symbol'
 require 'quantify/core_extensions/numeric'
+require 'quantify/core_extensions/range'
 require 'quantify/inflections'
 require 'quantify/exception'
 require 'quantify/dimensions'

data/quantify.gemspec

@@ -5,26 +5,27 @@
 
 Gem::Specification.new do |s|
   s.name = "quantify"
-  s.version = "3.1.1"
+  s.version = "3.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Berkeley"]
-  s.date = "2011-12-22"
+  s.date = "2012-01-18"
   s.description = "A gem to support physical quantities and unit conversions"
   s.email = "andrew.berkeley.is@googlemail.com"
   s.extra_rdoc_files = [
-    "README"
+    "README.md"
   ]
   s.files = [
     ".rvmrc",
     "COPYING",
     "Gemfile",
-    "README",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/quantify.rb",
     "lib/quantify/config.rb",
     "lib/quantify/core_extensions/numeric.rb",
+    "lib/quantify/core_extensions/range.rb",
     "lib/quantify/core_extensions/string.rb",
     "lib/quantify/core_extensions/symbol.rb",
     "lib/quantify/dimensions.rb",
@@ -53,7 +54,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/spatchcock/quantify"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.15"
   s.summary = "Support for handling physical quantities, unit conversions, etc"
 
   if s.respond_to? :specification_version then

data/spec/quantity_spec.rb

@@ -364,9 +364,9 @@ describe Quantity do
     time_in_hours = time_in_min.to_hours
     speed = distance_in_miles / time_in_hours
     speed.class.should == Quantity
+    # use #be_within to tolerate Ruby 1.8.7 - 1.9.2 differences
     speed.value.should be_within(1.0e-08).of(27.1143792976291)
-    speed.to_s(:name).should == "27.1143792976291 miles per hour"
-    speed.to_s.should == "27.1143792976291 mi/h"
+    speed.unit.pluralized_name.should eql "miles per hour"
   end
 
   it "coerce method should handle inverted syntax" do
@@ -388,11 +388,17 @@ describe Quantity do
   end
 
   it "should convert standard units correctly" do
-    6000.BTU.to_megajoules.to_s(:name).should == "6.328824 megajoules"
+    quantity = 6000.BTU.to_megajoules
+    # use #be_within to tolerate Ruby 1.8.7 - 1.9.2 differences
+    quantity.value.should be_within(1.0e-08).of(6.328824)
+    quantity.unit.pluralized_name.should eql "megajoules"
   end
 
   it "should convert standard units correctly" do
-    13.1.stones.to_kg.to_s(:name).should == "83.1888383 kilograms"
+    quantity = 13.1.stones.to_kg
+    # use #be_within to tolerate Ruby 1.8.7 - 1.9.2 differences
+    quantity.value.should be_within(1.0e-08).of(83.1888383)
+    quantity.unit.pluralized_name.should eql "kilograms"
   end
 
   it "should convert compound units correctly" do
@@ -402,7 +408,12 @@ describe Quantity do
 
   it "should convert to SI unit correctly" do
     100.cm.to_si.to_s.should == "1.0 m"
-    2.kWh.to_si.to_s.should == "7200000.0 J"
+
+    quantity = 2.kWh.to_si
+    # use #be_within to tolerate Ruby 1.8.7 - 1.9.2 differences
+    quantity.value.should be_within(1.0e-08).of(7200000.0)
+    quantity.unit.symbol.should eql "J"
+
     400.ha.to_si.to_s.should == "4000000.0 m²"
     35.degree_celsius.to_si.to_s.should == "308.15 K"
   end
@@ -455,7 +466,9 @@ describe Quantity do
   it "should cancel by base units of original compound unit if necessary" do
     quantity = Quantity.new(20, Unit.psi).to(Unit.inches_of_mercury)
     quantity.unit.base_units.size.should == 1
-    quantity.to_s.should == "40.720412743579 inHg"
+    # use #be_within to tolerate Ruby 1.8.7 - 1.9.2 differences
+    quantity.value.should be_within(1.0e-08).of(40.720412743579)
+    quantity.unit.symbol.should eql "inHg"
   end
 
   it "should rationalize units and return new quantity" do
@@ -512,13 +525,13 @@ describe Quantity do
   end
 
   it "should return between value from range" do
-    (2.ft..20.ft).include?(3.ft).should be_true
+    (2.ft..20.ft).send(RUBY_VERSION < "1.9" ? :include? : :cover?, 3.ft).should be_true
   end
 
   it "should return between value from range with different units" do
-    (2.ft..4.m).include?(200.cm).should be_true
-    (1.ly..1.parsec).include?(2.ly).should be_true
-    (1.ly..1.parsec).include?(2.in).should be_false
+    (2.ft..4.m).send(RUBY_VERSION < "1.9" ? :include? : :cover?, 200.cm).should be_true
+    (1.ly..1.parsec).send(RUBY_VERSION < "1.9" ? :include? : :cover?, 2.ly).should be_true
+    (1.ly..1.parsec).send(RUBY_VERSION < "1.9" ? :include? : :cover?, 2.in).should be_false
   end
 
   it "should return between value from range using === operator" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: quantify
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 3
   - 1
-  - 1
-  version: 3.1.1
+  - 2
+  version: 3.1.2
 platform: ruby
 authors: 
 - Andrew Berkeley
@@ -15,9 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-22 00:00:00 Z
+date: 2012-01-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: activesupport
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -28,11 +29,11 @@ dependencies:
         - 3
         - 0
         version: "3.0"
-  version_requirements: *id001
-  name: activesupport
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: i18n
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,11 +43,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id002
-  name: i18n
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: bundler
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -58,11 +59,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id003
-  name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: jeweler
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -74,11 +75,11 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  version_requirements: *id004
-  name: jeweler
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: rspec
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -90,11 +91,11 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
-  version_requirements: *id005
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: rcov
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -104,11 +105,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id006
-  name: rcov
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
+  name: rdoc
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -118,10 +119,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
-  name: rdoc
-  prerelease: false
   type: :development
+  prerelease: false
+  version_requirements: *id007
 description: A gem to support physical quantities and unit conversions
 email: andrew.berkeley.is@googlemail.com
 executables: []
@@ -129,17 +129,18 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
 - .rvmrc
 - COPYING
 - Gemfile
-- README
+- README.md
 - Rakefile
 - VERSION
 - lib/quantify.rb
 - lib/quantify/config.rb
 - lib/quantify/core_extensions/numeric.rb
+- lib/quantify/core_extensions/range.rb
 - lib/quantify/core_extensions/string.rb
 - lib/quantify/core_extensions/symbol.rb
 - lib/quantify/dimensions.rb
@@ -193,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Support for handling physical quantities, unit conversions, etc