quantify 1.1.0 → 1.2.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@quantify

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "activesupport"
+gem "i18n"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem 'rspec', '1.3.0'
+  gem 'rcov'
+  gem 'rspec_spinner', '1.1.3'
+end

data/README

@@ -9,7 +9,7 @@ Quick introduction
 
   12.feet + 12.feet                   => "24.0 feet"
 
-  6.m ** 2                            => "36.0 m^2"
+  6.m ** 2                            => "36.0 m²"
 
   100.km / 2.h                        => "50 kilometers per hour"
 
@@ -124,11 +124,11 @@ Convert a quantity to a different unit
 
 Convert the units of a quantity with a compound unit
 
-  speed = 70.mi/1.h                     => "70.0 mi h^-1"
+  speed = 70.mi/1.h                     => "70.0 mi/h"
 
-  speed_in_kms = speed.to_km            => "112.65408 km h^-1"
+  speed_in_kms = speed.to_km            => "112.65408 km/h"
 
-  speed_in_mins = speed_in_kms.to_min   => "1.877568 km min^-1"
+  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.
@@ -180,18 +180,18 @@ and the user may not necessarily prefer a conversion into consistent mass units
   area = 12.yd * 36.ft                  => <Quantify::Quantity:0xb7332bbc ... >
   area.to_s                             => "432.0 yd ft"
   area.to_yd
-  area.to_s                             => "144.0 yd^2"
+  area.to_s                             => "144.0 yd²"
 
   # 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^-1 min^-1
+  quantity.to_s                         => 12.0 ft mi/s min
   quantity.rationalize_units!
-  quantity.to_s                         => 1056.0 ft^2 s^-2
+  quantity.to_s                         => 1056.0 ft²/s²
 
   # 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^-2"
+  quantity.to_s                         => "746496.0 m^6/m²"
   quantity.cancel_base_units! :m
   quantity.to_s                         => "746496.0 m^4"
 
@@ -228,14 +228,14 @@ Initialize a unit object
 
   another_unit = unit / other_unit       => <Quantify::Unit::Compound:0xb74af323 ... >
   another_unit.name                      => 'kilometer per hour'
-  another_unit.symbol                    => 'km h^-1'
+  another_unit.symbol                    => 'km/h'
   another_unit.measures                  => 'velocity'
   another_unit.base_units.map(&:name)    => ['kilogram','hour']
 
   last_unit = Unit.m
   last.unit.measures                     => 'length'
   square = last_unit ** 2                => <Quantify::Unit::Compound:0xb446f12f ... >
-  square.symbol                          => 'm^2'
+  square.symbol                          => 'm²'
   square.measures                        => 'area'
 
 

data/Rakefile

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'spec'
+require 'spec/rake/spectask'
+
+task :default => [:spec]
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/*ruby*,']
+end
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "quantify"
+  gem.homepage = "https://github.com/spatchcock/quantify"
+  gem.license = "MIT"
+  gem.summary = %Q{Support for handling physical quantities, unit conversions, etc}
+  gem.description = %Q{A gem to support physical quantities and unit conversions}
+  gem.email = "andrew.berkeley.is@googlemail.com"
+  gem.authors = ["Andrew Berkeley"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "quantify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/lib/quantify/config.rb

@@ -177,24 +177,24 @@ Unit::SI.configure do
   load :name => 'kilogram', :physical_quantity => :mass, :symbol => 'kg', :label => 'kg'
   load :name => 'gram',     :physical_quantity => :mass, :symbol => 'g',  :label => 'g',  :factor => 1e-3
 
-  # Define units on the basis of unit operations
+  # Define compound units on the basis of SI units
 
-  construct_and_load metre**2
-  construct_and_load metre**3
-  construct_and_load(metre/second)
-  construct_and_load(metre/second**2)
+  (metre**2).load
+  (metre**3).load
+  (metre/second).load
+  (metre/second**2).load
 
-  construct_and_load(1/centimetre) do |unit|
+  (1/centimetre).configure do |unit|
     unit.name = 'inverse centimetre'
-  end
+  end.load
 
-  construct_and_load(centimetre/second**2) do |unit|
+  (centimetre/second**2).configure do |unit|
     unit.name = 'galileo'
     unit.symbol = 'Gal'
     unit.label = 'galileo'
-  end
+  end.load
 
-  # add required prefixed unit individually
+  # add required prefixed units individually
 
   kilometre.load
 
@@ -215,8 +215,6 @@ Unit::SI.configure do
   
   si_base_units.each { |unit| unit.acts_as_equivalent_unit = true }
 
-  cubic_metre.acts_as_equivalent_unit = true
-
   joule.acts_as_equivalent_unit = true
 
   newton.acts_as_equivalent_unit = true
@@ -225,8 +223,6 @@ Unit::SI.configure do
 
   pascal.acts_as_equivalent_unit = true
 
-  square_metre.acts_as_equivalent_unit = true
-
 end
 
 Unit::NonSI.configure do

data/lib/quantify/dimensions.rb

@@ -51,7 +51,7 @@ module Quantify
     #
     def self.base_dimensions
       @@dimensions.select do |dimensions|
-        BASE_QUANTITIES.map {|q| q.remove_underscores}.include?(dimensions.describe)
+        BASE_QUANTITIES.map {|quantity| quantity.remove_underscores}.include?(dimensions.describe)
       end
     end
 

data/lib/quantify/quantify.rb

@@ -1,40 +1,7 @@
 module Quantify
 
-  def self.configure &block
-    self.module_eval &block if block
-  end
-
-  # Check whether superscript characters are turned on.
-  def self.use_superscript_characters?
-    @use_superscript_characters.nil? ? true : @use_superscript_characters
-  end
-
-  # Shorthand method for Quantify.use_superscript_characters=true
-  def self.use_superscript_characters!
-    self.use_superscript_characters=true
-  end
-
-  # Declare whether superscript characters should be used for unit names, symbols
-  # and labels - i.e. "²" and "³" rather than "^2" and "^3". Set to either true or
-  # false. If not set, superscript characters are used by default.
-  #
-  def self.use_superscript_characters=(true_or_false)
-    raise Exceptions::InvalidArgumentError,
-      "Argument must be true or false" unless true_or_false == true || true_or_false == false
-    @use_superscript_characters = true_or_false
-    refresh_all_unit_identifiers!
-  end
-
-  # Switch all unit identifiers (name, symbol, label) to use the currently
-  # configured system for superscripts.
-  #
-  def refresh_all_unit_identifiers!
-    Unit.units.replace(
-      Unit.units.map do |unit|
-        unit.refresh_identifiers!
-        unit
-      end
-    )
+  def self.configure(&block)
+    self.module_eval(&block) if block
   end
 
   module ExtendedMethods

data/lib/quantify/unit/base_unit.rb

@@ -52,13 +52,13 @@ module Quantify
       # Syntactic sugar for defining the units known to the system, enabling the
       # required associated units to be loaded at runtime, e.g.
       #
-      #  Unit::[Base|SI|NonSI].configure do |config|
+      #   Unit::[Base|SI|NonSI].configure do |config|
       #
-      #    load :name => :metre, :physical_quantity => :length
-      #    load :name => 'hectare', :physical_quantity => :area, :factor => 10000
-      #    load :name => :watt, :physical_quantity => :power, :symbol => 'W'
+      #     load :name => :metre, :physical_quantity => :length
+      #     load :name => 'hectare', :physical_quantity => :area, :factor => 10000
+      #     load :name => :watt, :physical_quantity => :power, :symbol => 'W'
       #
-      #  end
+      #   end
       #
       def self.configure &block
         class_eval &block if block
@@ -138,7 +138,7 @@ module Quantify
       #
       def name=(name)
         name = name.to_s.remove_underscores.singularize
-        @name = Quantify.use_superscript_characters? ? name.with_superscript_characters : name.without_superscript_characters
+        @name = Unit.use_superscript_characters? ? name.with_superscript_characters : name.without_superscript_characters
       end
 
       # Set the symbol attribute of self. Symbols are stringified and stripped of
@@ -151,7 +151,7 @@ module Quantify
       #
       def symbol=(symbol)
         symbol = symbol.to_s.remove_underscores
-        @symbol = Quantify.use_superscript_characters? ? symbol.with_superscript_characters : symbol.without_superscript_characters
+        @symbol = Unit.use_superscript_characters? ? symbol.with_superscript_characters : symbol.without_superscript_characters
       end
 
       # Set the label attribute of self. This represents the unique identifier for
@@ -165,13 +165,13 @@ module Quantify
       #
       def label=(label)
         label = label.to_s.gsub(" ","_")
-        @label = Quantify.use_superscript_characters? ? label.with_superscript_characters : label.without_superscript_characters
+        @label = Unit.use_superscript_characters? ? label.with_superscript_characters : label.without_superscript_characters
       end
 
       # Refresh the name, symbol and label attributes of self with respect to the
       # configuration found in Quantify.use_superscript_characters?
       #
-      def refresh_identifiers!
+      def refresh_attributes
         self.name = name
         self.symbol = symbol
         self.label = label
@@ -448,7 +448,7 @@ module Quantify
       #                                               "T", "P" ... ]
       #
       def valid_prefixes(by=nil)
-        return [] if self.is_compound_unit?
+        return [] if is_compound_unit? && has_multiple_base_units?
         return Unit::Prefix.si_prefixes.map(&by) if is_si_unit?
         return Unit::Prefix.non_si_prefixes.map(&by) if is_non_si_unit?
       end
@@ -513,25 +513,20 @@ module Quantify
       # of self, complete with modified name, symbol, factor, etc..
       #
       def with_prefix(name_or_symbol)
-        if @name =~ /\A(#{valid_prefixes(:name).join("|")})/
-          raise Exceptions::InvalidArgumentError, "Cannot add prefix where one already exists: #{self.name}"
-        end
+        raise Exceptions::InvalidArgumentError, "No valid prefixes exist for unit: #{self.name}" if valid_prefixes.empty?
+        raise Exceptions::InvalidArgumentError, "Cannot add prefix where one already exists: #{self.name}" if @name =~ /\A(#{valid_prefixes(:name).join("|")})/
         
         prefix = Unit::Prefix.for(name_or_symbol,valid_prefixes)
-
-        unless prefix.nil?
-          new_unit_options = {}
-          new_unit_options[:name] = "#{prefix.name}#{@name}"
-          new_unit_options[:symbol] = "#{prefix.symbol}#{@symbol}"
-          new_unit_options[:label] = "#{prefix.symbol}#{@label}"
-          new_unit_options[:factor] = prefix.factor * @factor
-          new_unit_options[:physical_quantity] = @dimensions
-          self.class.new(new_unit_options)
+        if !prefix.nil?
+          self.class.new(options_for_prefixed_version(prefix))
         else
           raise Exceptions::InvalidArgumentError, "Prefix unit is not known: #{prefix}"
         end
       end
 
+      # Return an array of new unit instances based upon self, together with the
+      # prefixes specified by <tt>prefixes</tt>
+      #
       def with_prefixes(*prefixes)
         [prefixes].map { |prefix| self.with_prefix(prefix) }
       end
@@ -561,6 +556,18 @@ module Quantify
           raise Exceptions::InvalidArgumentError, "Cannot coerce #{self.class} into #{object.class}"
         end
       end
+
+      private
+
+      def options_for_prefixed_version(prefix)
+        options = {}
+        options[:name] = "#{prefix.name}#{@name}"
+        options[:symbol] = "#{prefix.symbol}#{@symbol}"
+        options[:label] = "#{prefix.symbol}#{@label}"
+        options[:factor] = prefix.factor * @factor
+        options[:physical_quantity] = @dimensions
+        return options
+      end
       
       # Clone self and explicitly clone the associated Dimensions object located
       # at @dimensions.
@@ -573,9 +580,6 @@ module Quantify
       def initialize_copy(source)
         super
         instance_variable_set("@dimensions", @dimensions.clone)
-        if self.is_compound_unit?
-          instance_variable_set("@base_units", @base_units.map {|base| base.clone })
-        end
       end
 
       # Provides syntactic sugar for several methods. E.g.

data/lib/quantify/unit/compound_base_unit.rb

@@ -31,7 +31,7 @@ module Quantify
       end
 
       # Absolute index as names always contain 'per' before denominator units
-      def name
+      def name(reciprocal=false)
         name_to_power(@unit.name, @index.abs)
       end
 
@@ -39,20 +39,12 @@ module Quantify
         name_to_power(@unit.pluralized_name, @index.abs)
       end
 
-      def symbol
-        @unit.symbol.to_s + ( @index.nil? || @index == 1 ? "" : formatted_index )
+      def symbol(reciprocal=false)
+        @unit.symbol + index_as_string(reciprocal)
       end
 
-      def label
-        @unit.label + (@index == 1 ? "" : formatted_index)
-      end
-
-      # Reciprocalized version of label, i.e. sign changed. This is used to make
-      # a denominator unit renderable in cases where there are no numerator units,
-      # i.e. where no '/' appears in the label
-      #
-      def reciprocalized_label
-        @unit.label + (@index == -1 ? "" : formatted_index(@index * -1))
+      def label(reciprocal=false)
+        @unit.label + index_as_string(reciprocal)
       end
 
       def factor
@@ -67,8 +59,9 @@ module Quantify
         @index < 0
       end
 
-      # The following methods refer only to the unit of the CompoundBaseUnit
-      # object, rather than the unit *together with its index*
+      def measures
+        dimensions.describe
+      end
 
       def is_base_quantity_si_unit?
         @unit.is_base_quantity_si_unit?
@@ -97,10 +90,6 @@ module Quantify
       def is_derived_unit?
         @unit.is_derived_unit?
       end
-  
-      def measures
-        @unit.measures
-      end
 
       def initialize_copy(source)
         instance_variable_set("@unit", @unit.clone)
@@ -109,11 +98,21 @@ module Quantify
       private
 
       # Returns a string representation of the unit index, formatted according to
-      # the global superscript configuration
+      # the global superscript configuration.
+      #
+      # The index value can be overridden by specifying as an argument.
       #
       def formatted_index(index=nil)
         index = "^#{index.nil? ? @index : index}"
-        Quantify.use_superscript_characters? ? index.with_superscript_characters : index
+        Unit.use_superscript_characters? ? index.with_superscript_characters : index
+      end
+
+      def index_as_string(reciprocal=false)
+        if reciprocal == true
+          @index == -1 ? "" : formatted_index(@index * -1)
+        else
+          @index.nil? || @index == 1 ? "" : formatted_index
+        end
       end
 
       def name_to_power(string,index)
@@ -123,7 +122,7 @@ module Quantify
         when 2 then "square #{name}"
         when 3 then "cubic #{name}"
         else
-          ordinal = ActiveSupport::Inflector.ordinalize index
+          ordinal = ActiveSupport::Inflector.ordinalize(index)
           name << " to the #{ordinal} power"
         end
       end