dentaku 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34a03b8d224b161ba7b6cdbfd0d5f1fd344f932c
-  data.tar.gz: 20e97d8a754981e1597748723afd4f54285a0e19
+  metadata.gz: 568297af6c05c99fdd87b6a2d70cd78b4d1f5828
+  data.tar.gz: 9e7668dd3998237a5fe6aaf50370dadfb6941bee
 SHA512:
-  metadata.gz: 510851224ae2e3e6b6a19b229cfe6095a28eaf9c6ac978edd6ea40295f4dc9a37b2fdb03d6f0072ef79b9fcfe1bf34f715f3f910d21b79491ce72643e66cddaf
-  data.tar.gz: b27e2dfc0c821f04475310eb47e6d30d908c02a77ba7da7512ed703a21b99c62e6a85a21be25d34db8540d9e10d131971ca45dfd54be554aed0a29e71e9b1b50
+  metadata.gz: 51685ec73f241afaed1bf66961b55837792100a0ecf06c2d5b283eca227fdb3129c76045fe676b8416fa40d54e11d1ef0da8ef298c504faeace2f77caf168955
+  data.tar.gz: a9a6914b90950b7616e3c82c704ab58921d0107045a3f440f5de2848acbf056ee95fefd8f2f63b663cb33f71f72f3733d94f13b7dd1f0895c1285f5bcab9181c

data/.travis.yml

@@ -8,5 +8,4 @@ rvm:
   - 2.2.1
   - 2.2.2
   - 2.2.3
-  - jruby-19mode
   - rbx-2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [v2.0.4] 2015-09-03
+- fix BigDecimal conversion bug
+- add caching for bulk expression solving dependency order
+- allow for custom configuration for token scanners
+
 ## [v2.0.3] 2015-08-25
 - bug fixes
 - performance enhancements
@@ -80,6 +85,7 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
+[v2.0.4]:  https://github.com/rubysolo/dentaku/compare/v2.0.3...v2.0.4
 [v2.0.3]:  https://github.com/rubysolo/dentaku/compare/v2.0.1...v2.0.3
 [v2.0.1]:  https://github.com/rubysolo/dentaku/compare/v2.0.0...v2.0.1
 [v2.0.0]:  https://github.com/rubysolo/dentaku/compare/v1.2.6...v2.0.0

data/lib/dentaku.rb

@@ -7,6 +7,11 @@ module Dentaku
     calculator.evaluate(expression, data)
   end
 
+  def self.enable_caching!
+    enable_ast_cache!
+    enable_dependency_order_cache!
+  end
+
   def self.enable_ast_cache!
     @enable_ast_caching = true
   end
@@ -15,6 +20,14 @@ module Dentaku
     @enable_ast_caching
   end
 
+  def self.enable_dependency_order_cache!
+    @enable_dependency_order_caching = true
+  end
+
+  def self.cache_dependency_order?
+    @enable_dependency_order_caching
+  end
+
   private
 
   def self.calculator

data/lib/dentaku/ast/arithmetic.rb

@@ -1,5 +1,6 @@
 require_relative './operation'
 require 'bigdecimal'
+require 'bigdecimal/util'
 
 module Dentaku
   module AST
@@ -13,16 +14,28 @@ module Dentaku
         :numeric
       end
 
+      def value(context={})
+        l = cast(left.value(context))
+        r = cast(right.value(context))
+        l.public_send(operator, r)
+      end
+
       private
 
+      def cast(value, prefer_integer=true)
+        v = BigDecimal.new(value, Float::DIG+1)
+        v = v.to_i if prefer_integer && v.frac.zero?
+        v
+      end
+
       def valid_node?(node)
         node.is_a?(Identifier) || node.type == :numeric
       end
     end
 
     class Addition < Arithmetic
-      def value(context={})
-        left.value(context) + right.value(context)
+      def operator
+        :+
       end
 
       def self.precedence
@@ -31,8 +44,8 @@ module Dentaku
     end
 
     class Subtraction < Arithmetic
-      def value(context={})
-        left.value(context) - right.value(context)
+      def operator
+        :-
       end
 
       def self.precedence
@@ -41,8 +54,8 @@ module Dentaku
     end
 
     class Multiplication < Arithmetic
-      def value(context={})
-        left.value(context) * right.value(context)
+      def operator
+        :*
       end
 
       def self.precedence
@@ -52,12 +65,10 @@ module Dentaku
 
     class Division < Arithmetic
       def value(context={})
-        r = BigDecimal.new(right.value(context))
+        r = cast(right.value(context), false)
         raise ZeroDivisionError if r.zero?
 
-        v = BigDecimal.new(left.value(context)) / r
-        v = v.to_i if v.frac.zero?
-        v
+        cast(cast(left.value(context)) / r)
       end
 
       def self.precedence
@@ -66,8 +77,8 @@ module Dentaku
     end
 
     class Modulo < Arithmetic
-      def value(context={})
-        left.value(context) % right.value(context)
+      def operator
+        :%
       end
 
       def self.precedence
@@ -76,8 +87,8 @@ module Dentaku
     end
 
     class Exponentiation < Arithmetic
-      def value(context={})
-        left.value(context) ** right.value(context)
+      def operator
+        :**
       end
 
       def self.precedence

data/lib/dentaku/ast/identifier.rb

@@ -13,7 +13,7 @@ module Dentaku
         v = context[identifier]
         case v
         when Node
-          v.value
+          v.value(context)
         when NilClass
           raise UnboundVariableError.new([identifier])
         else
@@ -22,7 +22,13 @@ module Dentaku
       end
 
       def dependencies(context={})
-        context.has_key?(identifier) ? [] : [identifier]
+        context.has_key?(identifier) ? dependencies_of(context[identifier]) : [identifier]
+      end
+
+      private
+
+      def dependencies_of(node)
+        node.respond_to?(:dependencies) ? node.dependencies : []
       end
     end
   end

data/lib/dentaku/bulk_expression_solver.rb

@@ -6,9 +6,9 @@ require 'dentaku/tokenizer'
 
 module Dentaku
   class BulkExpressionSolver
-    def initialize(expression_hash, memory)
+    def initialize(expression_hash, calculator)
       self.expression_hash = expression_hash
-      self.calculator = Calculator.new.store(memory)
+      self.calculator = calculator
     end
 
     def solve!
@@ -26,6 +26,10 @@ module Dentaku
 
     private
 
+    def self.dependency_cache
+      @dep_cache ||= {}
+    end
+
     attr_accessor :expression_hash, :calculator
 
     def return_undefined_handler
@@ -39,28 +43,42 @@ module Dentaku
     def load_results(&block)
       variables_in_resolve_order.each_with_object({}) do |var_name, r|
         begin
-          r[var_name] = calculator.memory[var_name] || evaluate!(expressions[var_name], r)
+          r[var_name] = calculator.memory[var_name] ||
+                        evaluate!(expressions[var_name], expressions.merge(r))
         rescue Dentaku::UnboundVariableError, ZeroDivisionError => ex
           r[var_name] = block.call(ex)
         end
       end
     end
 
-    def dependencies(expression)
-      Parser.new(Tokenizer.new.tokenize(expression)).parse.dependencies
-    end
-
     def expressions
       @expressions ||= Hash[expression_hash.map { |k,v| [k.to_s, v] }]
     end
 
     def expression_dependencies
-      Hash[expressions.map { |var, expr| [var, dependencies(expr)] }]
+      Hash[expressions.map { |var, expr| [var, calculator.dependencies(expr)] }].tap do |d|
+        d.values.each do |deps|
+          unresolved = deps.reject { |ud| d.has_key?(ud) }
+          unresolved.each { |u| add_dependencies(d, u) }
+        end
+      end
+    end
+
+    def add_dependencies(current_dependencies, variable)
+      node = calculator.memory[variable]
+      if node.respond_to?(:dependencies)
+        current_dependencies[variable] = node.dependencies
+        node.dependencies.each { |d| add_dependencies(current_dependencies, d) }
+      end
     end
 
     def variables_in_resolve_order
-      @variables_in_resolve_order ||=
-        DependencyResolver::find_resolve_order(expression_dependencies)
+      cache_key = expressions.keys.map(&:to_s).sort.join("|")
+      @ordered_deps ||= self.class.dependency_cache.fetch(cache_key) {
+        DependencyResolver.find_resolve_order(expression_dependencies).tap do |d|
+          self.class.dependency_cache[cache_key] = d if Dentaku.cache_dependency_order?
+        end
+      }
     end
 
     def evaluate!(expression, results)

data/lib/dentaku/calculator.rb

@@ -1,3 +1,4 @@
+require 'dentaku'
 require 'dentaku/bulk_expression_solver'
 require 'dentaku/exceptions'
 require 'dentaku/token'
@@ -31,7 +32,7 @@ module Dentaku
     end
 
     def evaluate!(expression, data={})
-      memory[expression] || store(data) do
+      store(data) do
         node = expression
         node = ast(node) unless node.is_a?(AST::Node)
         node.value(memory)
@@ -39,11 +40,11 @@ module Dentaku
     end
 
     def solve!(expression_hash)
-      BulkExpressionSolver.new(expression_hash, memory).solve!
+      BulkExpressionSolver.new(expression_hash, self).solve!
     end
 
     def solve(expression_hash, &block)
-      BulkExpressionSolver.new(expression_hash, memory).solve(&block)
+      BulkExpressionSolver.new(expression_hash, self).solve(&block)
     end
 
     def dependencies(expression)
@@ -79,6 +80,10 @@ module Dentaku
     end
     alias_method :bind, :store
 
+    def store_formula(key, formula)
+      store(key, ast(formula))
+    end
+
     def clear
       @memory = {}
     end

data/lib/dentaku/exceptions.rb

@@ -4,6 +4,7 @@ module Dentaku
 
     def initialize(unbound_variables)
       @unbound_variables = unbound_variables
+      super("no value provided for variables: #{ unbound_variables.join(', ') }")
     end
   end
 end

data/lib/dentaku/token_scanner.rb

@@ -24,23 +24,35 @@ module Dentaku
     end
 
     class << self
-      def scanners
-        @scanners ||= [
-          whitespace,
-          numeric,
-          double_quoted_string,
-          single_quoted_string,
-          negate,
-          operator,
-          grouping,
-          comparator,
-          combinator,
-          boolean,
-          function,
-          identifier
+      def available_scanners
+        [
+          :whitespace,
+          :numeric,
+          :double_quoted_string,
+          :single_quoted_string,
+          :negate,
+          :operator,
+          :grouping,
+          :comparator,
+          :combinator,
+          :boolean,
+          :function,
+          :identifier
         ]
       end
 
+      def scanners=(token_scanners)
+        @scanners = (token_scanners & available_scanners).map { |scanner|
+          self.send(scanner)
+        }
+      end
+
+      def scanners
+        @scanners ||= available_scanners.map { |scanner|
+          self.send(scanner)
+        }
+      end
+
       def whitespace
         new(:whitespace, '\s+')
       end

data/lib/dentaku/version.rb

@@ -1,3 +1,3 @@
 module Dentaku
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/spec/bulk_expression_solver_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 require 'dentaku/bulk_expression_solver'
 
 RSpec.describe Dentaku::BulkExpressionSolver do
+  let(:calculator) { Dentaku::Calculator.new }
+
   describe "#solve!" do
     it "evaluates properly with variables, even if some in memory" do
       expressions = {
@@ -9,8 +11,7 @@ RSpec.describe Dentaku::BulkExpressionSolver do
         weekly_apple_budget: "apples * 7",
         pear: "1"
       }
-      memory = {apples: 3}
-      solver = described_class.new(expressions, memory)
+      solver = described_class.new(expressions, calculator.store(apples: 3))
       expect(solver.solve!)
         .to eq(pear: 1, weekly_apple_budget: 21, weekly_fruit_budget: 25)
     end
@@ -18,20 +19,20 @@ RSpec.describe Dentaku::BulkExpressionSolver do
     it "lets you know if a variable is unbound" do
       expressions = {more_apples: "apples + 1"}
       expect {
-        described_class.new(expressions, {}).solve!
+        described_class.new(expressions, calculator).solve!
       }.to raise_error(Dentaku::UnboundVariableError)
     end
 
     it "lets you know if the result is a div/0 error" do
       expressions = {more_apples: "1/0"}
       expect {
-        described_class.new(expressions, {}).solve!
+        described_class.new(expressions, calculator).solve!
       }.to raise_error(ZeroDivisionError)
     end
 
     it "does not require keys to be parseable" do
       expressions = { "the value of x, incremented" => "x + 1" }
-      solver = described_class.new(expressions, "x" => 3)
+      solver = described_class.new(expressions, calculator.store("x" => 3))
       expect(solver.solve!).to eq({ "the value of x, incremented" => 4 })
     end
   end
@@ -39,19 +40,19 @@ RSpec.describe Dentaku::BulkExpressionSolver do
   describe "#solve" do
     it "returns :undefined when variables are unbound" do
       expressions = {more_apples: "apples + 1"}
-      expect(described_class.new(expressions, {}).solve)
+      expect(described_class.new(expressions, calculator).solve)
         .to eq(more_apples: :undefined)
     end
 
     it "allows passing in a custom value to an error handler when a variable is unbound" do
       expressions = {more_apples: "apples + 1"}
-      expect(described_class.new(expressions, {}).solve { :foo })
+      expect(described_class.new(expressions, calculator).solve { :foo })
         .to eq(more_apples: :foo)
     end
 
     it "allows passing in a custom value to an error handler when there is a div/0 error" do
       expressions = {more_apples: "1/0"}
-      expect(described_class.new(expressions, {}).solve { :foo })
+      expect(described_class.new(expressions, calculator).solve { :foo })
         .to eq(more_apples: :foo)
     end
   end

data/spec/calculator_spec.rb

@@ -29,6 +29,8 @@ describe Dentaku::Calculator do
     expect(calculator.evaluate('3 + 0 / -3')).to eq(3)
     expect(calculator.evaluate('15 % 8')).to eq(7)
     expect(calculator.evaluate('(((695759/735000)^(1/(1981-1991)))-1)*1000').round(4)).to eq(5.5018)
+    expect(calculator.evaluate('0.253/0.253')).to eq(1)
+    expect(calculator.evaluate('0.253/d', d: 0.253)).to eq(1)
   end
 
   describe 'memory' do
@@ -51,6 +53,11 @@ describe Dentaku::Calculator do
       expect(calculator.evaluate!('first')).to eq 1
       expect(calculator.evaluate!('second')).to eq 2
     end
+
+    it 'stores formulas' do
+      calculator.store_formula('area', 'length * width')
+      expect(calculator.evaluate!('area', length: 5, width: 5)).to eq 25
+    end
   end
 
   describe 'dependencies' do
@@ -68,15 +75,15 @@ describe Dentaku::Calculator do
       expect(with_memory.solve!(
         weekly_fruit_budget: "weekly_apple_budget + pear * 4",
         weekly_apple_budget: "apples * 7",
-        pear: "1"
+        pear:                "1"
       )).to eq(pear: 1, weekly_apple_budget: 21, weekly_fruit_budget: 25)
     end
 
     it "preserves hash keys" do
       expect(calculator.solve!(
         'meaning_of_life' => 'age + kids',
-        'age'  => 40,
-        'kids' =>  2
+        'age'             => 40,
+        'kids'            =>  2
       )).to eq('age' => 40, 'kids' => 2, 'meaning_of_life' => 42)
     end
 
@@ -96,6 +103,20 @@ describe Dentaku::Calculator do
         calculator.solve!(more_apples: "apples + 1")
       }.to raise_error(Dentaku::UnboundVariableError)
     end
+
+    it 'can reference stored formulas' do
+      calculator.store_formula("base_area", "length * width")
+      calculator.store_formula("volume", "base_area * height")
+
+      result = calculator.solve!(
+        weight: "volume * 5.432",
+        height: "3",
+        length: "2",
+        width:  "length * 2",
+      )
+
+      expect(result[:weight]).to eq 130.368
+    end
   end
 
   describe 'solve' do

data/spec/exceptions_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'dentaku/exceptions'
+
+describe Dentaku::UnboundVariableError do
+  it 'includes variable name(s) in message' do
+    exception = described_class.new(['length'])
+    expect(exception.message).to match /length/
+  end
+end

data/spec/token_scanner_spec.rb

@@ -25,4 +25,16 @@ describe Dentaku::TokenScanner do
   it 'returns a list of all configured scanners' do
     expect(described_class.scanners.length).to eq 12
   end
+
+  it 'allows customizing available scanners' do
+    described_class.scanners = [:whitespace, :numeric]
+    expect(described_class.scanners.length).to eq 2
+    described_class.scanners = described_class.available_scanners
+  end
+
+  it 'ignores invalid scanners' do
+    described_class.scanners = [:whitespace, :numeric, :fake]
+    expect(described_class.scanners.length).to eq 2
+    described_class.scanners = described_class.available_scanners
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Solomon White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -113,6 +113,7 @@ files:
 - spec/bulk_expression_solver_spec.rb
 - spec/calculator_spec.rb
 - spec/dentaku_spec.rb
+- spec/exceptions_spec.rb
 - spec/external_function_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
@@ -155,6 +156,7 @@ test_files:
 - spec/bulk_expression_solver_spec.rb
 - spec/calculator_spec.rb
 - spec/dentaku_spec.rb
+- spec/exceptions_spec.rb
 - spec/external_function_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb