unite 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aebeae667614cd23ebc795fa7930b6d55a95cce1
+  data.tar.gz: 62f3c66b9baec8a9ab0970322489ac43fa1dbd50
+SHA512:
+  metadata.gz: 0a5f0ee539de7142b8b26a510dd4f2aa6bb1d16fdc1a403f8c7434ca610562d319a2060284dedeefa67e835145e9e78f53c83f0ffa911cd8115e9a9e3e37190d
+  data.tar.gz: c88e6b42a7d06a16037a3a3c931df650a9852abffa00d39e4ffda5d4cc6971a59e4d6890de230c32a5f72b7b6344efdc304f2a2d860723fcc97fd6686d97613b

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_BIN: bin

data/.rspec

@@ -1,4 +1,4 @@
 --colour
 --format d
 --profile
---backtrace
+--backtrace

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -6,13 +6,13 @@ gemspec
 group :test do
   gem 'SystemTimer',  :platform => :mri_18
   gem 'ruby-debug',   :platform => :mri_18
-  gem 'linecache19',       '>= 0.5.13', :platform => :mri_19
-  gem 'ruby-debug-base19', '>= 0.11.26', :platform => :mri_19
-  gem 'ruby-debug19', :platform => :mri_19, :require => 'ruby-debug'
+  gem 'debugger', :platform => :mri_19
+  gem 'byebug', :platform => :mri_20
   gem 'mocha'
   gem 'rspec'
   gem 'shoulda-matchers', :git => 'git://github.com/thoughtbot/shoulda-matchers.git', :require => 'false'
   gem 'fabrication'
   gem 'guard-rspec'
   gem 'guard-bundler'
+  gem 'guard'
 end

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    unite (1.1.1)
+    unite (1.3.0)
       activemodel (>= 3.0.0)
       activesupport (>= 3.0.0)
 
@@ -22,9 +22,17 @@ GEM
       i18n (~> 0.6)
     activesupport (3.1.3)
       multi_json (~> 1.0)
-    archive-tar-minitar (0.5.2)
-    builder (3.0.0)
+    builder (3.0.4)
+    byebug (2.3.1)
+      columnize (~> 0.3.6)
+      debugger-linecache (~> 1.2.0)
     columnize (0.3.6)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
     diff-lcs (1.1.3)
     fabrication (1.2.0)
     ffi (1.0.11)
@@ -36,11 +44,9 @@ GEM
       guard (>= 0.2.2)
     guard-rspec (0.6.0)
       guard (>= 0.10.0)
-    i18n (0.6.0)
+    i18n (0.6.5)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
-    linecache19 (0.5.13)
-      ruby_core_source (>= 0.1.4)
     metaclass (0.0.1)
     mocha (0.10.1)
       metaclass (~> 0.0.1)
@@ -59,16 +65,6 @@ GEM
       ruby-debug-base (~> 0.10.4.0)
     ruby-debug-base (0.10.4)
       linecache (>= 0.3)
-    ruby-debug-base19 (0.11.26)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.5)
-      archive-tar-minitar (>= 0.5.2)
     thor (0.14.6)
 
 PLATFORMS
@@ -76,14 +72,14 @@ PLATFORMS
 
 DEPENDENCIES
   SystemTimer
+  byebug
+  debugger
   fabrication
+  guard
   guard-bundler
   guard-rspec
-  linecache19 (>= 0.5.13)
   mocha
   rspec
   ruby-debug
-  ruby-debug-base19 (>= 0.11.26)
-  ruby-debug19
   shoulda-matchers!
   unite!

data/README

@@ -1,3 +1,35 @@
 gem install unite
 
-gem 'unite'
+gem 'unite'
+
+
+Based on 
+
+http://www.cs.utexas.edu/users/novak/units95.html
+
+
+Handles the following dimensions 
+
+ [:length, :time, :temperature, :mass, :current, :substance, :luminosity, :money]
+ 
+ 
+ Note: Conversion of Money is not currently supported
+ 
+ 
+ Can use Unite::Quantity to represent values or include the functionality into your own objects.
+ 
+ Look at https://github.com/stellard/unite/blob/master/lib/unite/quantity.rb for a minum implementation
+ 
+ Examples: (needs more info here)
+ 
+ Unite::Quantity.init("1000*km")
+ Unite::Quantity.init("1000","km")
+
+ Unit definitions are found here
+ 
+ https://github.com/stellard/unite/blob/master/lib/unite/lookup/definitions.rb
+ 
+ Specs show good examples of use. 
+ 
+ I will add more to readme
+

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'autospec')

data/bin/byebug

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'byebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'byebug')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'guard')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'ldiff')

data/bin/rake2thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake2thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'rake2thor')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'rspec')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('unite', 'thor')

data/lib/unite/conversion.rb

@@ -7,7 +7,7 @@ module Unite
 
     extend ::ActiveSupport::Concern
     include Comparison
-    include Fraction
+    include SiFactor
 
     included do
 
@@ -18,27 +18,37 @@ module Unite
     end
 
     def convert_to other
-      other = other.clone.tap{|o| o.value = BigDecimal.new(1) }  #this is so that only the unit is used for the conversion 
-      new_value = self.converted_value(other)
+      other = cast_to_unit other
+      new_value, new_numerator, new_denominator = converted(other)
       return nil if new_value.nil?
-      self.class.new :value => new_value, :numerator => other.numerator, :denominator => other.denominator
+      self.class.new :value => new_value, :numerator => new_numerator, :denominator => new_denominator
+    end
+
+    def convert_to! other
+      other = cast_to_unit other
+      compatible! other
+      new_value, new_numerator, new_denominator = converted(other)
+      self.value = new_value
+      self.numerator = new_numerator
+      self.denominator = new_denominator
+      self
     end
 
     protected
 
-    def converted_value other
-      return nil unless self.compatible?(other)
-      self.si_factor / other.si_factor
+    def cast_to_unit other
+      other = Unit.init(other.is_a?(String) ? other : other.unit)
     end
 
-    def si_factor
-      value * (get_si_factor(numerator) / get_si_factor(denominator))
+    def converted other
+      new_value = self.converted_value(other)
+      return [nil, nil, nil] if new_value.nil?
+      return [new_value, other.numerator, other.denominator]
     end
 
-    def get_si_factor unit_array
-      expand_unit_array(unit_array).map do |element|
-        Lookup.find!(element).si_factor
-      end.inject(BigDecimal.new(1)) {|product, factor| product*factor}
+    def converted_value other
+      return nil unless self.compatible?(other)
+      self.si_factor / other.si_factor
     end
 
   end

data/lib/unite/dimension.rb

@@ -23,12 +23,16 @@ module Unite
 
     # also include the dimensionless dimension "none"
     LIST = VECTOR_LIST + [:none]
-    UNITS = ['meter', 'second', 'kelvin', 'kilogram', 'ampere', 'mole', 'candela', 'GBP', '']
+    UNITS = ['km', 's', 'K', 'kg', 'A', 'mol', 'cd', 'GBP', '']
     INDICIES = Hash[*LIST.each_with_index.map{|d,i| [d,i]}.flatten]
 
 
-    def si_unit dimension
-      UNITS[INDICIES[dimension.to_sym]]
+    def si_unit dimension_name_or_index
+      if dimension_name_or_index.kind_of? Fixnum
+        UNITS[dimension_name_or_index]
+      else
+        UNITS[INDICIES[dimension_name_or_index.to_sym]]
+      end
     end
 
     def blank_dimension_vector

data/lib/unite/fraction.rb

@@ -1,8 +1,8 @@
 # -*- encoding : utf-8 -*-
 module Unite
-  class InvalidFormat < RuntimeError 
+  class InvalidFormat < RuntimeError
   end
-  
+
   module Fraction
     extend ::ActiveSupport::Concern
 
@@ -20,30 +20,18 @@ module Unite
       self.denominator ||= []
     end
 
-
-    def expression=string
-      unless string.blank? || string.strip == '/'
-        num_denom = string.split('/')
-        raise(InvalidFormat, string) if num_denom.length > 2 || num_denom.empty?
-        self.numerator = num_denom[0].split('*').map(&:strip)
-        self.denominator = (num_denom[1].nil? ? [] : num_denom[1].split('*')).map(&:strip)
-        self.value = extract_value!(:numerator) / extract_value!(:denominator)
-        reduce
-      else
-        self.value = BigDecimal.new(0)
-        self.numerator = []
-        self.denominator = []
-      end
+    def expression= string
+      self.value, self.numerator, self.denominator = parse_expression string
+      reduce
+      expression
     end
 
-    def expression
-      numertor_string = ([value] + (numerator || [])).join('*')
-      denominator.empty? ? numertor_string : "#{numertor_string}/#{denominator.join('*')}"
+    def expression precision = 2
+      denominator_expression.blank? ? numerator_expression(precision) : "#{numerator_expression(precision)}/#{denominator_expression}"
     end
 
     def unit
-      numertor_string = (numerator.blank? && !denominator.blank?) ? '1.0' : (numerator || []).join('*')
-      denominator.blank? ? numertor_string : "#{numertor_string}/#{denominator.join('*')}"
+      unit_array_to_string self.numerator, self.denominator
     end
 
     def expanded_numerator
@@ -60,20 +48,27 @@ module Unite
     end
 
     def reduce
-      expand
+      new_unit = normalized_unit
+      convert_to!(normalized_unit) unless new_unit == unit || !self.respond_to?(:convert_to!)
+    end
 
-      self.denominator.delete_if do |unit|  
-        if nindex = self.numerator.index(unit)
-          self.numerator.delete_at(nindex)
-        end
-      end
+    private
 
+    def with_expanded_units
+      expand
+      result = yield
       self.numerator = reduce_unit_array(self.numerator)
       self.denominator = reduce_unit_array(self.denominator)
+      result
+    end
 
+    def numerator_expression precision
+      ([value.round(precision)] + (numerator || [])).join('*')
     end
 
-    private
+    def denominator_expression
+      denominator.join('*')
+    end
 
     def expand
       self.numerator = expanded_numerator
@@ -84,9 +79,13 @@ module Unite
       [].tap{|rejected| array.delete_if { |v| yield(v) && rejected << v }}
     end
 
-    def extract_value! method
+    def split_string string
+      (string.nil? ? [] : string.split('*')).map(&:strip)
+    end
+
+    def extract_value! array
       number_regex = /\A[-+]?\d*\.?\d+([eE][-+]?\d+)?\Z/
-      seperate!(self.send(method)){|x| number_regex =~ x }.map{|n| BigDecimal.new(n)}.
+      seperate!(array){|x| number_regex =~ x }.map{|n| BigDecimal.new(n)}.
         inject(BigDecimal.new(1)){|product, number| product*number }
     end
 
@@ -103,6 +102,25 @@ module Unite
       end
     end
 
+    def parse_expression string
+      unless string.blank? || string.strip == '/'
+        num_denom = string.split('/')
+        raise(InvalidFormat, string) if num_denom.length > 2 || num_denom.empty?
+        top = split_string(num_denom[0])
+        bottom = split_string(num_denom[1])
+        value = extract_value!(top) / extract_value!(bottom)
+        numerator = []
+        denominator = []
+        sift_units top, numerator, denominator
+        sift_units bottom, denominator, numerator
+      else
+        value = BigDecimal.new(0)
+        numerator = []
+        denominator = []
+      end
+      return [value, numerator, denominator]
+    end
+
     def expand_unit_array array
       array.collect  do |unit|
         if /\A([^\^\s]+)(\^(\d+))?\Z/ =~ unit
@@ -114,5 +132,63 @@ module Unite
         end
       end.flatten.compact
     end
+
+    def sift_units array, top, bottom
+      #move negative exponents to the bottom and keep positive on the top
+      array.each do |u|
+        u.match(/\A^([^\^\s]+)(\^(-?)(\d+))?\z/)
+        unit = Regexp.last_match(1)
+        power = Regexp.last_match(4)
+        expression = "#{unit}#{power.blank? ? "": "^#{power}"}"
+        if Regexp.last_match(3) == "-"
+          bottom << expression
+        else
+          top << expression
+        end
+      end
+      return [top, bottom]
+    end
+
+    def normalized_unit
+      with_expanded_units do
+        numerator_lookup_array = lookup_units numerator
+        denominator_lookup_array = lookup_units denominator
+
+        units_in_use = {}
+        (numerator_lookup_array + denominator_lookup_array).each do |unit|
+          dimension_int = unit.dimension_int
+          units_in_use[dimension_int] ||= unit
+        end
+
+        new_numerator = normalize_units numerator_lookup_array, units_in_use
+        new_denominator = normalize_units denominator_lookup_array, units_in_use
+
+
+        new_denominator.delete_if do |unit|
+          if nindex = new_numerator.index(unit)
+            new_numerator.delete_at(nindex)
+          end
+        end
+
+        new_denominator = reduce_unit_array(new_denominator)
+        new_numerator = reduce_unit_array(new_numerator)
+
+        unit_array_to_string new_numerator, new_denominator
+      end
+    end
+
+    def normalize_units array, in_use_hash
+      array.map { |unit| in_use_hash[unit.dimension_int] || unit }.map(&:name)
+    end
+
+    def lookup_units array
+      array.map{ |unit| Lookup.find!(unit) }
+    end
+
+    def unit_array_to_string num, denom
+      numertor_string = (num.blank? && !denominator.blank?) ? '1.0' : (num || []).join('*')
+      denom.blank? ? numertor_string : "#{numertor_string}/#{denom.join('*')}"
+    end
+
   end
 end

data/lib/unite/lookup/definitions.rb

@@ -12,15 +12,15 @@ module Unite
   Lookup.add_property Property.new(:name => :none, :expression => '')
 
   #TIME
-  Lookup.add SimpleUnit.new(:name => "s", :si_factor => 1, :dimension => :time)
-  Lookup.add SimpleUnit.new(:name => "hr", :si_factor => 3600, :dimension => :time)
+  Lookup.add SimpleUnit.new(:name => "s", :si_factor => 1, :dimension => :time, :aliases => ['second', 'seconds'])
+  Lookup.add SimpleUnit.new(:name => "h", :si_factor => 3600, :dimension => :time, :aliases => ['hour', 'hours', 'hr'])
 
-  Lookup.add DerivedUnit.new(:name => "day", :expression => '24*hr')
+  Lookup.add DerivedUnit.new(:name => "day", :expression => '24*hr', :aliases => ['days'])
 
   Lookup.add_property Property.new(:name => :time, :expression => 'hr')
 
   #LENGTH
-  Lookup.add SimpleUnit.new(:name => "m", :si_factor => 1, :dimension => :length)
+  Lookup.add SimpleUnit.new(:name => "m", :si_factor => 1, :dimension => :length, :aliases => ['meter', 'meters'])
   Lookup.add SimpleUnit.new(:name => "cm", :si_factor => 0.01, :dimension => :length)
   Lookup.add SimpleUnit.new(:name => "dm", :si_factor => 0.1, :dimension => :length)
   Lookup.add SimpleUnit.new(:name => "km", :si_factor => 1000, :dimension => :length)
@@ -36,19 +36,18 @@ module Unite
 
 
   #MASS
-  Lookup.add SimpleUnit.new(:name => "g", :si_factor => 1, :dimension => :mass)
-  Lookup.add SimpleUnit.new(:name => "kg", :si_factor => 1000, :dimension => :mass)
-  Lookup.add SimpleUnit.new(:name => "tonne", :si_factor => 1000000, :dimension => :mass)
-  Lookup.add SimpleUnit.new(:name => "metric_tonne", :si_factor => 1000000, :dimension => :mass)
+  Lookup.add SimpleUnit.new(:name => "g", :si_factor => 1, :dimension => :mass, :aliases => ['gram'])
+  Lookup.add SimpleUnit.new(:name => "kg", :si_factor => 1000, :dimension => :mass, :aliases => ['kilogram'])
+  Lookup.add SimpleUnit.new(:name => "t", :si_factor => 1000000, :dimension => :mass, :aliases => ['tonne', 'metric_tonne'])
 
   Lookup.add SimpleUnit.new(:name => "long_ton", :si_factor => 1.01605e6, :dimension => :mass)
   Lookup.add SimpleUnit.new(:name => "short_ton", :si_factor => 907185, :dimension => :mass)
   Lookup.add SimpleUnit.new(:name => "lb", :si_factor => 453.592, :dimension => :mass)
 
-  Lookup.add_property Property.new(:name => :mass, :expression => 'tonne')
+  Lookup.add_property Property.new(:name => :mass, :expression => 'g')
 
 
-  #DIMENSIONLESS
+  #MONEY
   Lookup.add SimpleUnit.new(:name => "GBP", :si_factor => 1, :dimension => :money)
 
   #Right now only one currency is supported. It is too difficult to be able to convert them.
@@ -60,6 +59,23 @@ module Unite
   Lookup.add_property Property.new(:name => :money, :expression => 'GBP')
 
 
+  #TEMPERATURE
+  Lookup.add SimpleUnit.new(:name => "K", :si_factor => 1, :dimension => :temperature, :aliases => ['kelvin'])
+  Lookup.add_property Property.new(:name => :temperature, :expression => 'K')
+
+  #LUMINOSITY
+  Lookup.add SimpleUnit.new(:name => "cd", :si_factor => 1, :dimension => :luminosity, :aliases => ['candela'])
+  Lookup.add_property Property.new(:name => :luminosity, :expression => 'cd')
+
+  #CURRENT
+  Lookup.add SimpleUnit.new(:name => "A", :si_factor => 1, :dimension => :current, :aliases => ['amp', 'ampere'])
+  Lookup.add_property Property.new(:name => :current, :expression => 'A')
+
+  #MOLE
+  Lookup.add SimpleUnit.new(:name => "mol", :si_factor => 1, :dimension => :substance, :aliases => ['mole'])
+  Lookup.add_property Property.new(:name => :substance, :expression => 'mol')
+
+
   #DERIVED UNITS
 
   #ENERGY

data/lib/unite/lookup/derived_unit.rb

@@ -6,7 +6,7 @@ module Unite
     include Dimension::Vector
     include Conversion
 
-    attr_accessor :name, :numerator, :denominator, :value
+    attr_accessor :name, :numerator, :denominator, :value, :aliases
 
     alias :to_s :name
     validates_presence_of :name
@@ -19,6 +19,9 @@ module Unite
       super
     end
 
+    def aliases
+      @aliases ||= []
+    end
 
   end
 end

data/lib/unite/lookup/simple_unit.rb

@@ -5,7 +5,7 @@ module Unite
     include ActiveModel::Validations
     include Dimension::Integer
 
-    attr_accessor :dimension, :name, :si_factor
+    attr_accessor :dimension, :name, :si_factor, :aliases
     alias :to_s :name
 
     validates_inclusion_of :dimension, :in => Dimension::LIST
@@ -22,5 +22,9 @@ module Unite
       end
     end
 
+    def aliases
+      @aliases ||= []
+    end
+
   end
 end