dentaku 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 813c0e0ea4c6a021ca324515d26386d2f2f28962
-  data.tar.gz: 943958582e98916af345553a343b261b978c97c5
+  metadata.gz: c299535113d559ed61d819be474ced8128bf7e0f
+  data.tar.gz: 80aa950604c573fcbee95cfa6bb820a1fa6af94b
 SHA512:
-  metadata.gz: d281ac5672cb9badc8ba74033d5624bd2e23d12f37785a6fc47595be0de51c8da9a2419eb0701de273e6ed710212988f47a16a72fef9fcbc119a8c39b38ebad4
-  data.tar.gz: 8f3ca27e26d5a603c99d2473a3115fb87c00407127b7d1613f0c0634057f37318583de7a7f8192d47db0ea8236648e916ea6dbc6084add0b591b4939e95c48f1
+  metadata.gz: 616133f23a73885b22d1e53722d8482f9522e249ca03a76fe7a8685d1d365eebbde7b1677248ea6758cbf29e60f54504f9c4a4a9ee43735ab54cffc8cb9d11ac
+  data.tar.gz: aea6a8919d66c838c704ba09b19787ddeb301f72ead03883ffc481ffe4ff7a54afa92108ed73794feaec4d83ea93cc17476dc108d0273401dba9c6077a603ec0

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [v2.0.7] 2016-02-25
+- fail with gem-specific error for parsing issues
+- support NULL literals and nil variables
+- keep reference to variable that caused failure when bulk-solving
+
 ## [v2.0.6] 2016-01-26
 - support array parameters for external functions
 - support case statements
@@ -98,7 +103,8 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
-[Unreleased]:  https://github.com/rubysolo/dentaku/compare/v2.0.6...HEAD
+[Unreleased]:  https://github.com/rubysolo/dentaku/compare/v2.0.7...HEAD
+[v2.0.7]:  https://github.com/rubysolo/dentaku/compare/v2.0.6...v2.0.7
 [v2.0.6]:  https://github.com/rubysolo/dentaku/compare/v2.0.5...v2.0.6
 [v2.0.5]:  https://github.com/rubysolo/dentaku/compare/v2.0.4...v2.0.5
 [v2.0.4]:  https://github.com/rubysolo/dentaku/compare/v2.0.3...v2.0.4

data/lib/dentaku/ast/arithmetic.rb

@@ -7,7 +7,9 @@ module Dentaku
     class Arithmetic < Operation
       def initialize(*)
         super
-        fail "#{ self.class } requires numeric operands" unless valid_node?(left) && valid_node?(right)
+        unless valid_node?(left) && valid_node?(right)
+          fail ParseError, "#{ self.class } requires numeric operands"
+        end
       end
 
       def type
@@ -29,7 +31,7 @@ module Dentaku
       end
 
       def valid_node?(node)
-        node.dependencies.any? || node.type == :numeric
+        node && (node.dependencies.any? || node.type == :numeric)
       end
     end
 
@@ -66,7 +68,7 @@ module Dentaku
     class Division < Arithmetic
       def value(context={})
         r = cast(right.value(context), false)
-        raise ZeroDivisionError if r.zero?
+        raise Dentaku::ZeroDivisionError if r.zero?
 
         cast(cast(left.value(context)) / r)
       end

data/lib/dentaku/ast/combinators.rb

@@ -5,7 +5,9 @@ module Dentaku
     class Combinator < Operation
       def initialize(*)
         super
-        fail "#{ self.class } requires logical operands" unless valid_node?(left) && valid_node?(right)
+        unless valid_node?(left) && valid_node?(right)
+          fail ParseError, "#{ self.class } requires logical operands"
+        end
       end
 
       def type

data/lib/dentaku/ast/function.rb

@@ -12,7 +12,9 @@ module Dentaku
       end
 
       def self.get(name)
-        registry.fetch(function_name(name)) { fail "Undefined function #{ name } "}
+        registry.fetch(function_name(name)) {
+          fail ParseError, "Undefined function #{ name }"
+        }
       end
 
       def self.register(name, type, implementation)

data/lib/dentaku/ast/identifier.rb

@@ -10,12 +10,13 @@ module Dentaku
       end
 
       def value(context={})
-        v = context[identifier]
+        v = context.fetch(identifier) do
+          raise UnboundVariableError.new([identifier])
+        end
+
         case v
         when Node
           v.value(context)
-        when NilClass
-          raise UnboundVariableError.new([identifier])
         else
           v
         end

data/lib/dentaku/ast/negation.rb

@@ -3,7 +3,7 @@ module Dentaku
     class Negation < Operation
       def initialize(node)
         @node = node
-        fail "Negation requires numeric operand" unless valid_node?(node)
+        fail ParseError, "Negation requires numeric operand" unless valid_node?(node)
       end
 
       def value(context={})
@@ -33,7 +33,7 @@ module Dentaku
       private
 
       def valid_node?(node)
-        node.dependencies.any? || node.type == :numeric
+        node && (node.dependencies.any? || node.type == :numeric)
       end
     end
   end

data/lib/dentaku/bulk_expression_solver.rb

@@ -43,9 +43,20 @@ 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], expressions.merge(r))
+          value_from_memory = calculator.memory[var_name]
+
+          if value_from_memory.nil? &&
+              expressions[var_name].nil? &&
+              !calculator.memory.has_key?(var_name)
+            next
+          end
+
+          value = value_from_memory ||
+            evaluate!(expressions[var_name], expressions.merge(r))
+
+          r[var_name] = value
         rescue Dentaku::UnboundVariableError, ZeroDivisionError => ex
+          ex.recipient_variable = var_name
           r[var_name] = block.call(ex)
         end
       end

data/lib/dentaku/exceptions.rb

@@ -1,5 +1,7 @@
 module Dentaku
   class UnboundVariableError < StandardError
+    attr_accessor :recipient_variable
+
     attr_reader :unbound_variables
 
     def initialize(unbound_variables)
@@ -7,4 +9,11 @@ module Dentaku
       super("no value provided for variables: #{ unbound_variables.join(', ') }")
     end
   end
+
+  class ParseError < StandardError
+  end
+
+  class ZeroDivisionError < ::ZeroDivisionError
+    attr_accessor :recipient_variable
+  end
 end

data/lib/dentaku/parser.rb

@@ -54,6 +54,9 @@ module Dentaku
             operations.push op_class
           end
 
+        when :null
+          output.push AST::Nil.new
+
         when :function
           arities.push 0
           operations.push function(token)
@@ -102,7 +105,7 @@ module Dentaku
             end
 
             unless operations.count == 1 && operations.last == AST::Case
-              fail "Unprocessed token #{ token.value }"
+              fail ParseError, "Unprocessed token #{ token.value }"
             end
             consume(arities.pop.succ)
           when :when
@@ -139,7 +142,7 @@ module Dentaku
 
             operations.push(AST::CaseElse)
           else
-            fail "Unknown case token #{ token.value }"
+            fail ParseError, "Unknown case token #{ token.value }"
           end
 
         when :grouping
@@ -158,7 +161,7 @@ module Dentaku
             end
 
             lparen = operations.pop
-            fail "Unbalanced parenthesis" unless lparen == AST::Grouping
+            fail ParseError, "Unbalanced parenthesis" unless lparen == AST::Grouping
 
             if operations.last && operations.last < AST::Function
               consume(arities.pop.succ)
@@ -171,11 +174,11 @@ module Dentaku
             end
 
           else
-            fail "Unknown grouping token #{ token.value }"
+            fail ParseError, "Unknown grouping token #{ token.value }"
           end
 
         else
-          fail "Not implemented for tokens of category #{ token.category }"
+          fail ParseError, "Not implemented for tokens of category #{ token.category }"
         end
       end
 
@@ -184,7 +187,7 @@ module Dentaku
       end
 
       unless output.count == 1
-        fail "Parse error"
+        fail ParseError, "Invalid statement"
       end
 
       output.first

data/lib/dentaku/token_scanner.rb

@@ -26,6 +26,7 @@ module Dentaku
     class << self
       def available_scanners
         [
+          :null,
           :whitespace,
           :numeric,
           :double_quoted_string,
@@ -68,6 +69,10 @@ module Dentaku
         new(:whitespace, '\s+')
       end
 
+      def null
+        new(:null, 'null\b')
+      end
+
       def numeric
         new(:numeric, '(\d+(\.\d+)?|\.\d+)\b', lambda { |raw| raw =~ /\./ ? BigDecimal.new(raw) : raw.to_i })
       end

data/lib/dentaku/version.rb

@@ -1,3 +1,3 @@
 module Dentaku
-  VERSION = "2.0.6"
+  VERSION = "2.0.7"
 end

data/spec/ast/addition_spec.rb

@@ -17,7 +17,7 @@ describe Dentaku::AST::Addition do
   it 'requires numeric operands' do
     expect {
       described_class.new(five, t)
-    }.to raise_error(RuntimeError, /requires numeric operands/)
+    }.to raise_error(Dentaku::ParseError, /requires numeric operands/)
 
     expression = Dentaku::AST::Multiplication.new(five, five)
     group = Dentaku::AST::Grouping.new(expression)

data/spec/ast/and_spec.rb

@@ -17,7 +17,7 @@ describe Dentaku::AST::And do
   it 'requires logical operands' do
     expect {
       described_class.new(t, five)
-    }.to raise_error(RuntimeError, /requires logical operands/)
+    }.to raise_error(Dentaku::ParseError, /requires logical operands/)
 
     expression = Dentaku::AST::LessThanOrEqual.new(five, five)
     expect {

data/spec/ast/division_spec.rb

@@ -17,7 +17,7 @@ describe Dentaku::AST::Division do
   it 'requires numeric operands' do
     expect {
       described_class.new(five, t)
-    }.to raise_error(RuntimeError, /requires numeric operands/)
+    }.to raise_error(Dentaku::ParseError, /requires numeric operands/)
 
     expression = Dentaku::AST::Multiplication.new(five, five)
     group = Dentaku::AST::Grouping.new(expression)

data/spec/ast/function_spec.rb

@@ -7,7 +7,9 @@ describe Dentaku::AST::Function do
   end
 
   it 'raises an exception when trying to access an undefined function' do
-    expect { described_class.get("flarble") }.to raise_error(RuntimeError, /undefined function/i)
+    expect {
+      described_class.get("flarble")
+    }.to raise_error(Dentaku::ParseError, /undefined function/i)
   end
 
   it 'registers a custom function' do

data/spec/bulk_expression_solver_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe Dentaku::BulkExpressionSolver do
       expressions = {more_apples: "1/0"}
       expect {
         described_class.new(expressions, calculator).solve!
-      }.to raise_error(ZeroDivisionError)
+      }.to raise_error(Dentaku::ZeroDivisionError)
     end
 
     it "does not require keys to be parseable" do
@@ -55,5 +55,23 @@ RSpec.describe Dentaku::BulkExpressionSolver do
       expect(described_class.new(expressions, calculator).solve { :foo })
         .to eq(more_apples: :foo)
     end
+
+    it 'stores the recipient variable on the exception when there is a div/0 error' do
+      expressions = {more_apples: "1/0"}
+      exception = nil
+      described_class.new(expressions, calculator).solve do |ex|
+        exception = ex
+      end
+      expect(exception.recipient_variable).to eq('more_apples')
+    end
+
+    it 'stores the recipient variable on the exception when there is an unbound variable' do
+      expressions = {more_apples: "apples + 1"}
+      exception = nil
+      described_class.new(expressions, calculator).solve do |ex|
+        exception = ex
+      end
+      expect(exception.recipient_variable).to eq('more_apples')
+    end
   end
 end

data/spec/calculator_spec.rb

@@ -260,6 +260,28 @@ describe Dentaku::Calculator do
     end
   end
 
+  describe 'explicit NULL' do
+    it 'can be used in IF statements' do
+      expect(calculator.evaluate('IF(null, 1, 2)')).to eq(2)
+    end
+
+    it 'can be used in IF statements when passed in' do
+      expect(calculator.evaluate('IF(foo, 1, 2)', foo: nil)).to eq(2)
+    end
+
+    it 'nil values are carried across middle terms' do
+      results = calculator.solve!(
+        choice: 'IF(bar, 1, 2)',
+        bar: 'foo',
+        foo: nil)
+      expect(results).to eq(
+        choice: 2,
+        bar: nil,
+        foo: nil
+      )
+    end
+  end
+
   describe 'case statements' do
     it 'handles complex then statements' do
       formula = <<-FORMULA

data/spec/parser_spec.rb

@@ -123,4 +123,20 @@ describe Dentaku::Parser do
        case_close]).parse
     expect(node.value(x: 3)).to eq(4)
   end
+
+  it 'raises an error on parse failure' do
+    five  = Dentaku::Token.new(:numeric, 5)
+    times = Dentaku::Token.new(:operator, :multiply)
+    minus = Dentaku::Token.new(:operator, :subtract)
+
+    expect {
+      described_class.new([five, times, minus]).parse
+    }.to raise_error(Dentaku::ParseError)
+  end
+
+  it "evaluates explicit 'NULL' as a Nil" do
+    null  = Dentaku::Token.new(:null, nil)
+    node = described_class.new([null]).parse
+    expect(node.value).to eq(nil)
+  end
 end

data/spec/token_scanner_spec.rb

@@ -28,7 +28,7 @@ describe Dentaku::TokenScanner do
   end
 
   it 'returns a list of all configured scanners' do
-    expect(described_class.scanners.length).to eq 13
+    expect(described_class.scanners.length).to eq 14
   end
 
   it 'allows customizing available scanners' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Solomon White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,8 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      Dentaku is a parser and evaluator for mathematical formulas
+description: "    Dentaku is a parser and evaluator for mathematical formulas\n"
 email:
 - rubysolo@gmail.com
 executables: []
@@ -148,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: dentaku
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A formula language parser and evaluator
@@ -172,3 +171,4 @@ test_files:
 - spec/token_scanner_spec.rb
 - spec/token_spec.rb
 - spec/tokenizer_spec.rb
+has_rdoc: