unitwise 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de40334f99c4238cd5e8c492b52a2e6556f80fd
-  data.tar.gz: 52c7bce118481d12d1955d7395b06068dc400c23
+  metadata.gz: 410fb733b657a34122237793d03bf634fa0676b2
+  data.tar.gz: 57ab5cfe90d3bfb9dea058ea3b85904b3bb451dd
 SHA512:
-  metadata.gz: 9e3e7a34913889ff32d9d7f7af7e4f3dc3ef563295f0469653f5f46f84c1977cd022a888a2a31efbe6b33f2397dfa5eac1810781b061716f6c233acd3e9a91e3
-  data.tar.gz: 4635700db7000da9b2a2958e1f0bdd2696bc8bdf698396cf90ce66da6750d173402c9ddb04162e2375766ddc287e5f1c7cda19e9bdf650e260b2ff35826e63c3
+  metadata.gz: 0171c1aef8b9daf3e07a89959bbde2ee947854c51b6f7be0c1d569e140b0e9f24e95ec9a455babcb489d105c1656928cb207180b935fc02b329c330c9e3a41b8
+  data.tar.gz: 389f2c83e8505e1e7e6df4b8a9aeb6ae79869e2693dd3bb9d9476667ed440823f32faa63403c78a234a7fbdb83fd46d7e48072bed52c1946615bd408ef13bf6d

data/CHANGELOG.md

@@ -5,6 +5,13 @@ version 1.0.0.
 
 Unitwise uses semantic versioning.
 
+## 1.0.2 - 2014-09-14
+
+## Fixed
+
+- Decomposer caching is now a little smarter. This resulted in a mild
+  performance increase.
+
 ## 1.0.1 - 2014-08-30
 
 ### Fixed

data/lib/unitwise/expression.rb

@@ -19,8 +19,7 @@ module Unitwise
         Composer.new(terms, method).expression
       end
 
-      # Convert a string representation of a unit, and turn it into a
-      # an array of terms
+      # Convert a string representation of a unit into an array of terms
       # @param expression [String] The string you wish to convert
       # @return [Array]
       # @example
@@ -28,26 +27,9 @@ module Unitwise
       #   # => [<Unitwise::Term m2>, <Unitwise::Term s-2>]
       # @api public
       def decompose(expression)
-        expression = expression.to_s
-        if decomposed.key?(expression)
-          decomposed[expression]
-        else
-          decomposed[expression] = begin
-            Decomposer.new(expression).terms
-          rescue ExpressionError
-            nil
-          end
-        end
+        Decomposer.parse(expression)
       end
 
-      private
-
-      # A cache of decomposed strings.
-      # @return [Hash]
-      # @api private
-      def decomposed
-        @decomposed ||= {}
-      end
     end
   end
 end

data/lib/unitwise/expression/decomposer.rb

@@ -13,17 +13,38 @@ module Unitwise
 
       TRANSFORMER = Transformer.new
 
+      class << self
+
+        # Parse an expression to an array of terms and cache the results
+        def parse(expression)
+          expression = expression.to_s
+          if cache.key?(expression)
+            cache[expression]
+          elsif decomposer = new(expression)
+            cache[expression] = decomposer
+          end
+        end
+
+        private
+
+        # A simple cache to prevent re-decomposing the same units
+        # api private
+        def cache
+          @cache ||= {}
+        end
+      end
+
       attr_reader :expression, :mode
 
       def initialize(expression)
         @expression = expression.to_s
         if terms.nil? || terms.empty?
-          fail ExpressionError, "Could not evaluate '#{@expression}'."
+          fail(ExpressionError, "Could not evaluate '#{ expression }'.")
         end
       end
 
       def parse
-        @parse ||= PARSERS.reduce(nil) do |_, (mode, parser)|
+        PARSERS.reduce(nil) do |_, (mode, parser)|
           parsed = parser.parse(expression) rescue next
           @mode = mode
           break parsed
@@ -41,7 +62,7 @@ module Unitwise
           Array(transform)
         end
       end
-      
+
     end
   end
 end

data/lib/unitwise/expression/matcher.rb

@@ -5,15 +5,19 @@ module Unitwise
     class Matcher
       class << self
         def atom(mode)
-          new(Atom.all, mode).alternative
+          @atom ||= {}
+          @atom[mode] ||= new(Atom.all, mode).alternative
         end
 
         def metric_atom(mode)
-          new(Atom.all.select(&:metric?), mode).alternative
+          @metric_atom ||= {}
+          @metric_atom[mode] ||=
+            new(Atom.all.select(&:metric?), mode).alternative
         end
 
         def prefix(mode)
-          new(Prefix.all, mode).alternative
+          @prefix ||= {}
+          @prefix[mode] ||= new(Prefix.all, mode).alternative
         end
       end
 
@@ -25,17 +29,17 @@ module Unitwise
       end
 
       def strings
-        @stings ||= collection.map(&mode).flatten.compact.sort do |x, y|
+        collection.map(&mode).flatten.compact.sort do |x, y|
           y.length <=> x.length
         end
       end
 
       def matchers
-        @matchers ||= strings.map { |s| Parslet::Atoms::Str.new(s) }
+        strings.map { |s| Parslet::Atoms::Str.new(s) }
       end
 
       def alternative
-        @alternative ||= Parslet::Atoms::Alternative.new(*matchers)
+        Parslet::Atoms::Alternative.new(*matchers)
       end
 
     end

data/lib/unitwise/ext/numeric.rb

@@ -20,13 +20,15 @@ class Numeric
   def method_missing(meth, *args, &block)
     if args.empty? && !block_given?
       unit = (match = /\Ato_(\w+)\Z/.match(meth.to_s)) ? match[1] : meth
-      begin
-        res = convert_to(unit)
-        Numeric.define_unit_conversion_methods_for(unit)
-        res
+      converted = begin
+        convert_to(unit)
       rescue Unitwise::ExpressionError
-        super(meth, *args, &block)
+        nil
       end
+    end
+    if converted
+      Numeric.define_unit_conversion_methods_for(unit)
+      converted
     else
       super(meth, *args, &block)
     end

data/lib/unitwise/scale.rb

@@ -81,7 +81,7 @@ module Unitwise
     end
     memoize :root_terms
 
-    # How far away is this instances unit from the deepest leve atom.
+    # How far away is this instances unit from the deepest level atom.
     # @return [Integer]
     # @api public
     def depth

data/lib/unitwise/term.rb

@@ -89,28 +89,19 @@ module Unitwise
     # params other [Unit, Term, Numeric]
     # @return [Term]
     def *(other)
-      if other.respond_to?(:terms)
-        Unit.new(other.terms << self)
-      elsif other.respond_to?(:atom)
-        Unit.new([self, other])
-      elsif other.is_a?(Numeric)
-        self.class.new(to_hash.merge(:factor => factor * other))
-      end
+      operate('*', other) ||
+        fail(TypeError, "Can't multiply #{ self } by #{ other }.")
     end
 
     # Term division. Divide by a Unit, another Term, or a Numeric.
     # params other [Unit, Term, Numeric]
     # @return [Term]
     def /(other)
-      if other.respond_to?(:terms)
-        Unit.new(other.terms.map { |t| t ** -1 } << self)
-      elsif other.respond_to?(:atom)
-        Unit.new([self, other ** -1])
-      elsif other.is_a?(Numeric)
-        self.class.new(to_hash.merge(:factor => factor / other))
-      end
+      operate('/', other) ||
+        fail(TypeError, "Can't divide #{ self } by #{ other }.")
     end
 
+
     # Term exponentiation. Raise a term to a numeric power.
     # params other [Numeric]
     # @return [Term]
@@ -133,5 +124,19 @@ module Unitwise
     def calculate(value)
       (factor * (prefix ? prefix.scalar : 1) * value) ** exponent
     end
+
+    # Multiply or divide a term
+    # @api private
+    def operate(operator, other)
+      exp = operator == '/' ? -1 : 1
+      if other.respond_to?(:terms)
+        Unit.new(other.terms.map { |t| t ** exp } << self)
+      elsif other.respond_to?(:atom)
+        Unit.new([self, other ** exp])
+      elsif other.is_a?(Numeric)
+        self.class.new(to_hash.merge(:factor => factor.send(operator, other)))
+      end
+    end
+
   end
 end

data/lib/unitwise/unit.rb

@@ -27,7 +27,7 @@ module Unitwise
     def terms
       unless frozen?
         unless @terms
-          decomposer = Expression::Decomposer.new(@expression)
+          decomposer = Expression.decompose(@expression)
           @mode  = decomposer.mode
           @terms = decomposer.terms
         end
@@ -41,11 +41,14 @@ module Unitwise
     # (:primary_code, :names, :secondary_code).
     # @return [String]
     # @api public
-    def expression(mode = mode)
-      Expression.compose(terms, mode)
+    def expression(mode=nil)
+      if @expression && (mode.nil? || mode == self.mode)
+        @expression
+      else
+        Expression.compose(terms, mode || self.mode)
+      end
     end
 
-
     # The collection of atoms that compose this unit. Essentially delegated to
     # terms.
     # @return [Array]
@@ -105,15 +108,8 @@ module Unitwise
     # @return [Unitwise::Unit]
     # @api public
     def *(other)
-      if other.respond_to?(:terms)
-        self.class.new(terms + other.terms)
-      elsif other.respond_to?(:atom)
-        self.class.new(terms << other)
-      elsif other.is_a?(Numeric)
-        self.class.new(terms.map { |t| t * other })
-      else
-        fail TypeError, "Can't multiply #{self} by #{other}."
-      end
+      operate('*', other) ||
+        fail(TypeError, "Can't multiply #{ self } by #{ other }.")
     end
 
     # Divide this unit by another unit,term, or number.
@@ -121,17 +117,11 @@ module Unitwise
     # @return [Unitwise::Unit]
     # @api public
     def /(other)
-      if other.respond_to?(:terms)
-        self.class.new(terms + other.terms.map { |t| t ** -1 })
-      elsif other.respond_to?(:atom)
-        self.class.new(terms << other ** -1)
-      elsif other.is_a?(Numeric)
-        self.class.new(terms.map { |t| t / other })
-      else
-        fail TypeError, "Can't divide #{self} by #{other}."
-      end
+      operate('/', other) ||
+        fail(TypeError, "Can't divide #{ self } by #{ other }.")
     end
 
+
     # Raise this unit to a numeric power.
     # @param other [Numeric]
     # @return [Unitwise::Unit]
@@ -149,8 +139,8 @@ module Unitwise
     # (:primary_code, :names, :secondary_code)
     # @return [String]
     # @api public
-    def to_s(mode = mode)
-      expression(mode || self.mode)
+    def to_s(mode = nil)
+      expression(mode)
     end
 
     # A collection of the possible string representations of this unit.
@@ -172,5 +162,20 @@ module Unitwise
       @mode || :primary_code
     end
 
+    private
+
+    # Multiply or divide units
+    # @api private
+    def operate(operator, other)
+      exp = operator == '/' ? -1 : 1
+      if other.respond_to?(:terms)
+        self.class.new(terms + other.terms.map { |t| t ** exp })
+      elsif other.respond_to?(:atom)
+        self.class.new(terms << other ** exp)
+      elsif other.is_a?(Numeric)
+        self.class.new(terms.map { |t| t.send(operator, other) })
+      end
+    end
+
   end
 end

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/test/unitwise/term_test.rb

@@ -45,5 +45,11 @@ describe Unitwise::Term do
         subject.frozen?.must_equal true
       end
     end
+
+    describe "#to_s" do
+      it "should return the UCUM code" do
+        subject.to_s.must_equal "kJ"
+      end
+    end
   end
 end

data/test/unitwise/unit_test.rb

@@ -66,7 +66,7 @@ describe Unitwise::Unit do
 
   describe "#frozen?" do
     it "should be frozen" do
-      kg.to_s
+      kg.scalar
       kg.frozen?.must_equal true
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-30 00:00:00.000000000 Z
+date: 2014-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
@@ -183,7 +183,6 @@ files:
 - lib/unitwise/term.rb
 - lib/unitwise/unit.rb
 - lib/unitwise/version.rb
-- simple_bench.rb
 - test/support/scale_tests.rb
 - test/test_helper.rb
 - test/unitwise/atom_test.rb

data/simple_bench.rb

@@ -1,21 +0,0 @@
-require 'unitwise'
-require 'ruby-units'
-require 'benchmark'
-
-Benchmark.bm(10) do |x|
-
-  x.report('unitwise') do
-    100000.times do |x|
-      expression = "mm#{x % 20}"
-      Unitwise::Measurement.new(x, expression)
-    end
-  end
-
-  x.report('ruby-units') do
-    100000.times do |x|
-      expression = "mm^#{x % 20}"
-      Unit(x, expression)
-    end
-  end
-
-end