quantify 1.1.0 → 1.2.0

data/lib/quantify/unit/unit.rb

@@ -20,17 +20,132 @@ module Quantify
     # prefixes) at any time and either used in place or loaded into the known
     # system.
 
-    # Make the @units instance array readable
     class << self
       attr_reader :units
+      #attr_reader :symbol_denominator_delimiter, :symbol_unit_delimiter
+      #attr_reader :use_symbol_parentheses, :use_symbol_denominator_syntax
     end
 
+    # Instance variable containing system of known units
+    @units = []
+
+    # Default configuration for unit symbols
+    #@use_symbol_denominator_syntax = true
+    #@use_symbol_parentheses = false
+    #@symbol_denominator_delimiter = "/"
+    #@symbol_unit_delimiter = " "
+
     def self.configure(&block)
       self.class_eval(&block) if block
     end
 
-    # Instance variable containing system of known units
-    @units = []
+    # Set the default string which is used to delimit numerator and denominator
+    # strings in compound unit symbol representations. Defaults to "/".
+    #
+    def self.symbol_denominator_delimiter=(string)
+      @symbol_denominator_delimiter = string
+      refresh_all_unit_attributes!
+    end
+
+    def self.symbol_denominator_delimiter
+      @symbol_denominator_delimiter ||= "/"
+    end
+
+    # Set the default string which is used to delimit unit symbol strings in
+    # compound unit symbol representations. Defaults to " ".
+    #
+    def self.symbol_unit_delimiter=(string)
+      @symbol_unit_delimiter = string
+      refresh_all_unit_attributes!
+    end
+
+    def self.symbol_unit_delimiter
+      @symbol_unit_delimiter ||= " "
+    end
+
+    # Specify whether parentheses should be used to group multiple units in
+    # compound unit symbol representations. Set either <tt>true</tt> (e.g.
+    # "kg/(t km)") or <tt>false</tt> (e.g. "kg/t km"). Defaults to <tt>false</tt>
+    #
+    def self.use_symbol_parentheses=(true_or_false)
+      @use_symbol_parentheses = true_or_false
+      refresh_all_unit_attributes!
+    end
+
+    # Shorthand bang! method for configuring parentheses in compound unit symbol
+    # representations
+    #
+    def self.use_symbol_parentheses!
+      @use_symbol_parentheses = true
+    end
+
+    # Returns <tt>true</tt> if parentheses are configured for use within compound
+    # unit symbol representations. Otherwise returns <tt>false</tt>.
+    #
+    def self.use_symbol_parentheses?
+      @use_symbol_parentheses.nil? ? false : @use_symbol_parentheses
+    end
+
+    # Shorthand bang! method for configuring denominator structures in compound
+    # unit symbol representations (e.g. "kg/t km")
+    #
+    def self.use_symbol_denominator_syntax!
+      self.use_symbol_denominator_syntax = true
+    end
+
+    # Shorthand bang! method for configuring index-only structures in compound
+    # unit symbol representations (e.g. "kg t^-1 km^-1")
+    #
+    def self.use_symbol_indices_only!
+      self.use_symbol_denominator_syntax = false
+    end
+
+    # Specify whether denominator structures should be used in compound unit
+    # symbol representations. Set either <tt>true</tt> (e.g. "kg/t km") or
+    # <tt>false</tt> (e.g. "kg t^-1 km^-1"). Defaults to <tt>true</tt>
+    #
+    def self.use_symbol_denominator_syntax=(true_or_false)
+      @use_symbol_denominator_syntax = true_or_false
+      refresh_all_unit_attributes!
+    end
+
+    # Returns <tt>true</tt> if denominator structures are configured for use
+    # within compound unit symbol representations. Otherwise returns
+    # <tt>false</tt>.
+    #
+    def self.use_symbol_denominator_syntax?
+      @use_symbol_denominator_syntax.nil? ? true : @use_symbol_denominator_syntax
+    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 ::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_attributes!
+    end
+
+    # Switch all unit identifiers (name, symbol, label) to use the currently
+    # configured system for superscripts.
+    #
+    def self.refresh_all_unit_attributes!
+      Unit.units.replace(
+        Unit.units.map { |unit| unit.refresh_attributes; unit }
+      )
+    end
 
     # Load a new unit into they system of known units
     def self.load(unit)
@@ -168,7 +283,7 @@ module Quantify
         when :name then string_or_symbol.remove_underscores.singularize.downcase
         else string_or_symbol.to_s
       end
-      Quantify.use_superscript_characters? ?
+      Unit.use_superscript_characters? ?
         string_or_symbol.with_superscript_characters : string_or_symbol.without_superscript_characters
     end
     

data/lib/quantify.rb

@@ -22,6 +22,7 @@ require 'quantify/unit/unit'
 require 'quantify/unit/base_unit'
 require 'quantify/unit/si_unit'
 require 'quantify/unit/non_si_unit'
+require 'quantify/unit/compound_base_unit_list'
 require 'quantify/unit/compound_base_unit'
 require 'quantify/unit/compound_unit'
 require 'quantify/quantity'

data/quantify.gemspec

@@ -0,0 +1,90 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{quantify}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Berkeley"]
+  s.date = %q{2011-08-04}
+  s.description = %q{A gem to support physical quantities and unit conversions}
+  s.email = %q{andrew.berkeley.is@googlemail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".rvmrc",
+    "COPYING",
+    "Gemfile",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "lib/quantify.rb",
+    "lib/quantify/config.rb",
+    "lib/quantify/core_extensions/numeric.rb",
+    "lib/quantify/core_extensions/string.rb",
+    "lib/quantify/core_extensions/symbol.rb",
+    "lib/quantify/dimensions.rb",
+    "lib/quantify/exception.rb",
+    "lib/quantify/inflections.rb",
+    "lib/quantify/quantify.rb",
+    "lib/quantify/quantity.rb",
+    "lib/quantify/unit/base_unit.rb",
+    "lib/quantify/unit/compound_base_unit.rb",
+    "lib/quantify/unit/compound_base_unit_list.rb",
+    "lib/quantify/unit/compound_unit.rb",
+    "lib/quantify/unit/non_si_unit.rb",
+    "lib/quantify/unit/prefix/base_prefix.rb",
+    "lib/quantify/unit/prefix/non_si_prefix.rb",
+    "lib/quantify/unit/prefix/prefix.rb",
+    "lib/quantify/unit/prefix/si_prefix.rb",
+    "lib/quantify/unit/si_unit.rb",
+    "lib/quantify/unit/unit.rb",
+    "quantify.gemspec",
+    "spec/compound_unit_spec.rb",
+    "spec/dimension_spec.rb",
+    "spec/quantify_spec.rb",
+    "spec/quantity_spec.rb",
+    "spec/string_spec.rb",
+    "spec/unit_spec.rb"
+  ]
+  s.homepage = %q{https://github.com/spatchcock/quantify}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.0}
+  s.summary = %q{Support for handling physical quantities, unit conversions, etc}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rspec>, ["= 1.3.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rspec>, ["= 1.3.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+  end
+end
+

data/spec/compound_unit_spec.rb

@@ -3,6 +3,79 @@ include Quantify
 
 describe Unit do
 
+  describe "compound unit symbols" do
+
+    after :all do
+      Unit.use_symbol_denominator_syntax!
+      Unit.use_symbol_parentheses = false
+    end
+
+    it "should use denominator syntax by default" do
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m² s kg/m³ s"
+      Unit.metre_per_second.symbol.should eql "m/s"
+    end
+    
+    it "should use indices only with bang! method" do
+      Unit.use_symbol_indices_only!
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m² s kg s^-1 m^-3"
+      Unit.metre_per_second.symbol.should eql "m s^-1"
+    end
+
+    it "should use denominator syntax with bang! method" do
+      Unit.use_symbol_denominator_syntax!
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m² s kg/m³ s"
+      Unit.metre_per_second.symbol.should eql "m/s"
+    end
+
+    it "should use indices only with setter method" do
+      Unit.use_symbol_denominator_syntax = false
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m² s kg s^-1 m^-3"
+      Unit.metre_per_second.symbol.should eql "m s^-1"
+    end
+
+    it "should use denominator syntax with setter method" do
+      Unit.use_symbol_denominator_syntax = true
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m² s kg/m³ s"
+      Unit.metre_per_second.symbol.should eql "m/s"
+    end
+
+    it "should use parentheses with setter method" do
+      Unit.use_symbol_parentheses = true
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "(m² s kg)/(m³ s)"
+      unit = Unit.m*Unit.m/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m²/(m³ s)"
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m)
+      unit.symbol.should == "(m² s kg)/m³"
+    end
+
+    it "should not use parentheses with setter method" do
+      Unit.use_symbol_parentheses = false
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m² s kg/m³ s"
+      unit = Unit.m*Unit.m/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m²/m³ s"
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m)
+      unit.symbol.should == "m² s kg/m³"
+    end
+
+    it "should use parentheses with bang! method" do
+      Unit.use_symbol_parentheses!
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "(m² s kg)/(m³ s)"
+      unit = Unit.m*Unit.m/(Unit.m*Unit.m*Unit.m*Unit.s)
+      unit.symbol.should == "m²/(m³ s)"
+      unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m)
+      unit.symbol.should == "(m² s kg)/m³"
+    end
+
+  end
+
   describe "compound unit naming algorithms" do
 
     it "should return pluralised unit name" do
@@ -56,7 +129,7 @@ describe Unit do
   describe "specific compound unit operations" do
 
     it "should find equivalent unit for compound unit" do
-      (Unit.m*Unit.m).equivalent_known_unit.name.should == 'square metre'
+      (Unit.kg*Unit.m*Unit.m/Unit.s/Unit.s).equivalent_known_unit.name.should == 'joule'
       (Unit.km*Unit.lb).equivalent_known_unit.should == nil
     end
 
@@ -68,28 +141,28 @@ describe Unit do
 
     it "should consolidate across all base units" do
       unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
-      unit.symbol.should == "m² s kg s^-1 m^-3"
+      unit.symbol.should == "m² s kg/m³ s"
       unit.base_units.size.should == 5
       unit.consolidate_base_units!
-      unit.symbol.should == "kg m^-1"
+      unit.symbol.should == "kg/m"
       unit.base_units.size.should == 2
     end
 
     it "should cancel base units with one argument which is a symbol" do
       unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
-      unit.symbol.should == "m² s kg s^-1 m^-3"
+      unit.symbol.should == "m² s kg/m³ s"
       unit.base_units.size.should == 5
       unit.cancel_base_units! :m
-      unit.symbol.should == "s kg m^-1 s^-1"
+      unit.symbol.should == "s kg/m s"
       unit.base_units.size.should == 4
     end
 
     it "should cancel base units with multiple arguments including unit objects and strings" do
       unit = Unit.m*Unit.m*Unit.s*Unit.kg/(Unit.m*Unit.m*Unit.m*Unit.s)
-      unit.symbol.should == "m² s kg s^-1 m^-3"
+      unit.symbol.should == "m² s kg/m³ s"
       unit.base_units.size.should == 5
       unit.cancel_base_units! Unit.m, 's'
-      unit.symbol.should == "kg m^-1"
+      unit.symbol.should == "kg/m"
       unit.base_units.size.should == 2
     end
 
@@ -108,7 +181,7 @@ describe Unit do
       base1 = Unit::CompoundBaseUnit.new Unit.h, -1
       base2 = Unit::CompoundBaseUnit.new Unit.mi
       compound_unit = Unit::Compound.new base1, base2
-      compound_unit.symbol.should == "mi h^-1"
+      compound_unit.symbol.should == "mi/h"
     end
 
     it "should initialize compound unit with multiple individual units" do
@@ -136,7 +209,7 @@ describe Unit do
       base1 = [Unit.h, -1]
       base2 = [Unit.m, 2]
       compound_unit = Unit::Compound.new base1, base2
-      compound_unit.symbol.should == "m² h^-1"
+      compound_unit.symbol.should == "m²/h"
     end
 
     it "should initialize compound unit with variable arguments" do
@@ -189,17 +262,55 @@ describe Unit do
       unit = Unit.yard*Unit.foot
       unit.rationalize_base_units!.label.should eql 'yd²'
       unit = Unit.metre*Unit.centimetre/Unit.inch
-      unit.rationalize_base_units!(:full).label.should eql 'm²/m'
+      unit.rationalize_base_units!.label.should eql 'm²/m'
       unit.consolidate_base_units!.label.should eql 'm'
     end
 
     it "should rationalize base units with specified unit" do
       unit = Unit.yard*Unit.foot
-      unit.rationalize_base_units!(:partial,:yd).label.should eql 'yd²'
+      unit.rationalize_numerator_and_denominator_units!(:yd).label.should eql 'yd²'
       unit = Unit.metre*Unit.centimetre/Unit.inch
-      unit.rationalize_base_units!(:full,:m).label.should eql 'm²/m'
-      unit.consolidate_base_units!.label.should eql 'm'
+      unit.rationalize_base_units!(:cm).label.should eql 'cm²/cm'
+      unit.consolidate_base_units!.label.should eql 'cm'
+    end
+
+    it "should rationalize only numerator and denominator base units" do
+      unit = Unit.yard*Unit.foot
+      unit.rationalize_numerator_and_denominator_units!.label.should eql 'yd²'
+      unit = Unit.metre*Unit.centimetre/Unit.inch
+      unit.rationalize_numerator_and_denominator_units!.label.should eql 'm²/in'
+      unit.consolidate_base_units!.label.should eql 'm²/in'
     end
     
   end
+
+  describe "adding prefixes" do
+
+    it "should have no valid prefixes with multiple base units" do
+      (Unit.kg*Unit.m*Unit.m/Unit.s/Unit.s).valid_prefixes.should be_empty
+    end
+
+    it "should return SI prefixes with single SI unit" do
+      prefixes = (Unit.kg**3).valid_prefixes
+      prefixes.should_not be_empty
+      prefixes.first.should be_a Unit::Prefix::SI
+    end
+
+    it "should return SI prefixes with single SI unit" do
+      prefixes = (Unit.lb**3).valid_prefixes
+      prefixes.should be_empty # no NonSI prefixes defined
+    end
+
+    it "should refuse to add prefix to multi-unit compound unit" do
+      lambda{(Unit.kg*Unit.m*Unit.m/Unit.s/Unit.s).with_prefix(:giga)}.should raise_error
+    end
+
+    it "should prefix a single unit compound unit" do
+      unit = (Unit.m**2).with_prefix(:kilo)
+      unit.name.should eql "square kilometre"
+      unit.factor.should == 1000000
+    end
+
+
+  end
 end

data/spec/quantify_spec.rb

@@ -3,18 +3,4 @@ include Quantify
 
 describe Quantify do
 
-  it "should initialize superscript format" do
-    Quantify.use_superscript_characters?.should be_true
-  end
-
-  it "should set superscript usage to true" do
-    Quantify.use_superscript_characters=true
-    Quantify.use_superscript_characters?.should be_true
-  end
-
-  it "should set superscript usage to false" do
-    Quantify.use_superscript_characters=false
-    Quantify.use_superscript_characters?.should be_false
-  end
-
 end

data/spec/quantity_spec.rb

@@ -154,7 +154,7 @@ describe Quantity do
     speed.class.should == Quantity
     speed.value.should be_close 27.1143792976291, 0.00000001
     speed.to_s(:name).should == "27.1143792976291 miles per hour"
-    speed.to_s.should == "27.1143792976291 mi h^-1"
+    speed.to_s.should == "27.1143792976291 mi/h"
   end
 
   it "coerce method should handle inverted syntax" do
@@ -185,7 +185,7 @@ describe Quantity do
 
   it "should convert compound units correctly" do
     speed = Quantity.new 100, (Unit.km/Unit.h)
-    speed.to_mi.round(2).to_s.should == "62.14 mi h^-1"
+    speed.to_mi.round(2).to_s.should == "62.14 mi/h"
   end
 
   it "should convert to SI unit correctly" do
@@ -224,9 +224,9 @@ describe Quantity do
     unit = 50.ft ** -1
     unit.to_s.should == "0.02 ft^-1"
     unit = (10.m/1.s)**2
-    unit.to_s.should == "100.0 m² s^-2"
+    unit.to_s.should == "100.0 m²/s²"
     unit = (10.m/1.s)**-1
-    unit.to_s.should == "0.1 s m^-1"
+    unit.to_s.should == "0.1 s/m"
     lambda{ ((10.m/1.s)** 0.5) }.should raise_error
   end
 
@@ -234,8 +234,8 @@ describe Quantity do
     (50.ft.pow! 2).to_s.should == "2500.0 ft²"
     (50.ft.pow! 3).to_s.should == "125000.0 ft³"
     (50.ft.pow! -1).to_s.should == "0.02 ft^-1"
-    ((10.m/1.s).pow! 2).to_s.should == "100.0 m² s^-2"
-    ((10.m/1.s).pow! -1).to_s.should == "0.1 s m^-1"
+    ((10.m/1.s).pow! 2).to_s.should == "100.0 m²/s²"
+    ((10.m/1.s).pow! -1).to_s.should == "0.1 s/m"
     lambda{ ((10.m/1.s).pow! 0.5) }.should raise_error
   end