dentaku 3.5.1 → 3.5.3

data/spec/external_function_spec.rb

@@ -5,8 +5,7 @@ require 'dentaku/calculator'
 describe Dentaku::Calculator do
   describe 'functions' do
     describe 'external functions' do
-
-      let(:with_external_funcs) do
+      let(:custom_calculator) do
         c = described_class.new
 
         c.add_function(:now, :string, -> { Time.now.to_s })
@@ -22,30 +21,30 @@ describe Dentaku::Calculator do
       end
 
       it 'includes NOW' do
-        now = with_external_funcs.evaluate('NOW()')
+        now = custom_calculator.evaluate('NOW()')
         expect(now).not_to be_nil
         expect(now).not_to be_empty
       end
 
       it 'includes POW' do
-        expect(with_external_funcs.evaluate('POW(2,3)')).to eq(8)
-        expect(with_external_funcs.evaluate('POW(3,2)')).to eq(9)
-        expect(with_external_funcs.evaluate('POW(mantissa,exponent)', mantissa: 2, exponent: 4)).to eq(16)
+        expect(custom_calculator.evaluate('POW(2,3)')).to eq(8)
+        expect(custom_calculator.evaluate('POW(3,2)')).to eq(9)
+        expect(custom_calculator.evaluate('POW(mantissa,exponent)', mantissa: 2, exponent: 4)).to eq(16)
       end
 
       it 'includes BIGGEST' do
-        expect(with_external_funcs.evaluate('BIGGEST(8,6,7,5,3,0,9)')).to eq(9)
+        expect(custom_calculator.evaluate('BIGGEST(8,6,7,5,3,0,9)')).to eq(9)
       end
 
       it 'includes SMALLEST' do
-        expect(with_external_funcs.evaluate('SMALLEST(8,6,7,5,3,0,9)')).to eq(0)
+        expect(custom_calculator.evaluate('SMALLEST(8,6,7,5,3,0,9)')).to eq(0)
       end
 
       it 'includes OPTIONAL' do
-        expect(with_external_funcs.evaluate('OPTIONAL(1,2)')).to eq(3)
-        expect(with_external_funcs.evaluate('OPTIONAL(1,2,3)')).to eq(6)
-        expect { with_external_funcs.dependencies('OPTIONAL()') }.to raise_error(Dentaku::ParseError)
-        expect { with_external_funcs.dependencies('OPTIONAL(1,2,3,4)') }.to raise_error(Dentaku::ParseError)
+        expect(custom_calculator.evaluate('OPTIONAL(1,2)')).to eq(3)
+        expect(custom_calculator.evaluate('OPTIONAL(1,2,3)')).to eq(6)
+        expect { custom_calculator.dependencies('OPTIONAL()') }.to raise_error(Dentaku::ParseError)
+        expect { custom_calculator.dependencies('OPTIONAL(1,2,3,4)') }.to raise_error(Dentaku::ParseError)
       end
 
       it 'supports array parameters' do
@@ -62,6 +61,66 @@ describe Dentaku::Calculator do
       end
     end
 
+    describe 'with callbacks' do
+      let(:custom_calculator) do
+        c = described_class.new
+
+        @counts = Hash.new(0)
+
+        @initial_time = "2023-02-03"
+        @last_time = @initial_time
+
+        c.add_function(
+            :reverse,
+            :stringl,
+            ->(a) { a.reverse },
+            lambda do |args|
+              args.each do |arg|
+                @counts[arg.value] += 1 if arg.type == :string
+              end
+            end
+        )
+
+        fns = [
+          [:biggest_callback,  :numeric, ->(*args) { args.max }, ->(args) { args.each { |arg| raise Dentaku::ArgumentError unless arg.type == :numeric } }],
+          [:pythagoras, :numeric, ->(l1, l2) { Math.sqrt(l1**2 + l2**2) }, ->(e) { @last_time = Time.now.to_s }],
+          [:callback_lambda, :string, ->() { " " }, ->() { "lambda executed" }],
+          [:no_lambda_function, :numeric, ->(a) { a**a }],
+        ]
+
+        c.add_functions(fns)
+      end
+
+      it 'includes BIGGEST_CALLBACK' do
+        expect(custom_calculator.evaluate('BIGGEST_CALLBACK(1, 2, 5, 4)')).to eq(5)
+        expect { custom_calculator.dependencies('BIGGEST_CALLBACK(1, 3, 6, "hi", 10)') }.to raise_error(Dentaku::ArgumentError)
+      end
+
+      it 'includes REVERSE' do
+        expect(custom_calculator.evaluate('REVERSE(\'Dentaku\')')).to eq('ukatneD')
+        expect { custom_calculator.evaluate('REVERSE(22)') }.to raise_error(NoMethodError)
+        expect(@counts["Dentaku"]).to eq(1)
+      end
+
+      it 'includes PYTHAGORAS' do
+        expect(custom_calculator.evaluate('PYTHAGORAS(8, 7)')).to eq(10.63014581273465)
+        expect(custom_calculator.evaluate('PYTHAGORAS(3, 4)')).to eq(5)
+        expect(@last_time).not_to eq(@initial_time)
+      end
+
+      it 'exposes the `callback` method of a function' do
+        expect(Dentaku::AST::Function::Callback_lambda.callback.call()).to eq("lambda executed")
+      end
+
+      it 'does not add a `callback` method to built-in functions' do
+        expect { Dentaku::AST::If.callback.call }.to raise_error(NoMethodError)
+      end
+
+      it 'defaults `callback` method to nil if not specified' do
+        expect(Dentaku::AST::Function::No_lambda_function.callback).to eq(nil)
+      end
+    end
+
     it 'allows registering "bang" functions' do
       calculator = described_class.new
       calculator.add_function(:hey!, :string, -> { "hey!" })
@@ -82,24 +141,36 @@ describe Dentaku::Calculator do
     end
 
     it 'does not store functions across all calculators' do
-      calculator1 = Dentaku::Calculator.new
+      calculator1 = described_class.new
       calculator1.add_function(:my_function, :numeric, ->(x) { 2 * x + 1 })
 
-      calculator2 = Dentaku::Calculator.new
+      calculator2 = described_class.new
       calculator2.add_function(:my_function, :numeric, ->(x) { 4 * x + 3 })
 
       expect(calculator1.evaluate!("1 + my_function(2)")). to eq(1 + 2 * 2 + 1)
       expect(calculator2.evaluate!("1 + my_function(2)")). to eq(1 + 4 * 2 + 3)
 
       expect {
-        Dentaku::Calculator.new.evaluate!("1 + my_function(2)")
+        described_class.new.evaluate!("1 + my_function(2)")
       }.to raise_error(Dentaku::ParseError)
     end
 
     describe 'Dentaku::Calculator.add_function' do
-      it 'adds to default/global function registry' do
-        Dentaku::Calculator.add_function(:global_function, :numeric, ->(x) { 10 + x**2 })
-        expect(Dentaku::Calculator.new.evaluate("global_function(3) + 5")).to eq(10 + 3**2 + 5)
+      it 'adds a function to default/global function registry' do
+        described_class.add_function(:global_function, :numeric, ->(x) { 10 + x**2 })
+        expect(described_class.new.evaluate("global_function(3) + 5")).to eq(10 + 3**2 + 5)
+      end
+    end
+
+    describe 'Dentaku::Calculator.add_functions' do
+      it 'adds multiple functions to default/global function registry' do
+        described_class.add_functions([
+          [:cube, :numeric, ->(x) { x**3 }],
+          [:spongebob, :string, ->(x) { x.split("").each_with_index().map { |c,i| i.even? ? c.upcase : c.downcase }.join() }],
+        ])
+
+        expect(described_class.new.evaluate("1 + cube(3)")).to eq(28)
+        expect(described_class.new.evaluate("spongebob('How are you today?')")).to eq("HoW ArE YoU ToDaY?")
       end
     end
   end

data/spec/parser_spec.rb

@@ -79,6 +79,9 @@ describe Dentaku::Parser do
   it 'evaluates arrays' do
     node = parse('{1, 2, 3}')
     expect(node.value).to eq([1, 2, 3])
+
+    node = parse('{}')
+    expect(node.value).to eq([])
   end
 
   context 'invalid expression' do

data/spec/print_visitor_spec.rb

@@ -8,6 +8,12 @@ describe Dentaku::PrintVisitor do
     expect(repr).to eq('5 + 4')
   end
 
+  it 'handles grouping correctly' do
+    formula = '10 - (0 - 10)'
+    repr = roundtrip(formula)
+    expect(repr).to eq(formula)
+  end
+
   it 'quotes string literals' do
     repr = roundtrip('Concat(\'a\',   "B")')
     expect(repr).to eq('CONCAT("a", "B")')

data/spec/tokenizer_spec.rb

@@ -1,3 +1,4 @@
+require 'dentaku/exceptions'
 require 'dentaku/tokenizer'
 
 describe Dentaku::Tokenizer do
@@ -234,9 +235,9 @@ describe Dentaku::Tokenizer do
   end
 
   it 'tokenizes Time literals' do
-    tokens = tokenizer.tokenize('2017-01-01 2017-01-2 2017-1-03 2017-01-04 12:23:42 2017-1-5 1:2:3 2017-1-06 1:02:30 2017-01-07 12:34:56 Z 2017-01-08 1:2:3 +0800')
-    expect(tokens.length).to eq(8)
-    expect(tokens.map(&:category)).to eq([:datetime, :datetime, :datetime, :datetime, :datetime, :datetime, :datetime, :datetime])
+    tokens = tokenizer.tokenize('2017-01-01 2017-01-2 2017-1-03 2017-01-04 12:23:42 2017-1-5 1:2:3 2017-1-06 1:02:30 2017-01-07 12:34:56 Z 2017-01-08 1:2:3 +0800 2017-01-08T01:02:03.456Z')
+    expect(tokens.length).to eq(9)
+    expect(tokens.map(&:category)).to eq([:datetime, :datetime, :datetime, :datetime, :datetime, :datetime, :datetime, :datetime, :datetime])
     expect(tokens.map(&:value)).to eq([
       Time.local(2017, 1, 1).to_datetime,
       Time.local(2017, 1, 2).to_datetime,
@@ -245,7 +246,8 @@ describe Dentaku::Tokenizer do
       Time.local(2017, 1, 5, 1, 2, 3).to_datetime,
       Time.local(2017, 1, 6, 1, 2, 30).to_datetime,
       Time.utc(2017, 1, 7, 12, 34, 56).to_datetime,
-      Time.new(2017, 1, 8, 1, 2, 3, "+08:00").to_datetime
+      Time.new(2017, 1, 8, 1, 2, 3, "+08:00").to_datetime,
+      Time.utc(2017, 1, 8, 1, 2, 3, 456000).to_datetime
     ])
   end
 

data/spec/visitor/infix_spec.rb

@@ -10,6 +10,21 @@ class ArrayProcessor
     @expression = []
   end
 
+  def visit_array(node)
+    @expression << "{"
+
+    head, *tail = node.value
+
+    process(head) if head
+
+    tail.each do |v|
+      @expression << ","
+      process(v)
+    end
+
+    @expression << "}"
+  end
+
   def process(node)
     @expression << node.to_s
   end
@@ -22,10 +37,16 @@ RSpec.describe Dentaku::Visitor::Infix do
     expect(processor.expression).to eq ['5', '+', '3']
   end
 
+  it 'supports array nodes' do
+    processor = ArrayProcessor.new
+    processor.visit(ast('{1, 2, 3}'))
+    expect(processor.expression).to eq ['{', '1', ',', '2', ',', '3', '}']
+  end
+
   private
 
   def ast(expression)
     tokens = Dentaku::Tokenizer.new.tokenize(expression)
     Dentaku::Parser.new(tokens).parse
   end
-end
+end

data/spec/visitor_spec.rb

@@ -114,7 +114,7 @@ describe TestVisitor do
     visit_nodes('case (a % 5) when 0 then a else b end')
     visit_nodes('0xCAFE & (0xDECAF << 3) | (0xBEEF >> 5)')
     visit_nodes('2017-12-24 23:59:59')
-    visit_nodes('ALL({1, 2, 3}, "val", val % 2 == 0)')
+    visit_nodes('ALL({1, 2, 3}, val, val % 2 == 0)')
     visit_nodes('ANY(vals, val, val > 1)')
     visit_nodes('COUNT({1, 2, 3})')
     visit_nodes('PLUCK(users, age)')
@@ -122,6 +122,7 @@ describe TestVisitor do
     visit_nodes('duration(1, day)')
     visit_nodes('MAP(vals, val, val + 1)')
     visit_nodes('FILTER(vals, val, val > 1)')
+    visit_nodes('REDUCE(vals, memo, val, memo + val)')
 
     @expected = Set.new(Dentaku::AST::constants - generic_subclasses)
     expect(@visited.sort).to eq(@expected.sort)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.3
 platform: ruby
 authors:
 - Solomon White
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -170,6 +170,7 @@ files:
 - lib/dentaku/ast/datetime.rb
 - lib/dentaku/ast/function.rb
 - lib/dentaku/ast/function_registry.rb
+- lib/dentaku/ast/functions/abs.rb
 - lib/dentaku/ast/functions/all.rb
 - lib/dentaku/ast/functions/and.rb
 - lib/dentaku/ast/functions/any.rb
@@ -179,6 +180,7 @@ files:
 - lib/dentaku/ast/functions/enum.rb
 - lib/dentaku/ast/functions/filter.rb
 - lib/dentaku/ast/functions/if.rb
+- lib/dentaku/ast/functions/intercept.rb
 - lib/dentaku/ast/functions/map.rb
 - lib/dentaku/ast/functions/max.rb
 - lib/dentaku/ast/functions/min.rb
@@ -186,6 +188,7 @@ files:
 - lib/dentaku/ast/functions/not.rb
 - lib/dentaku/ast/functions/or.rb
 - lib/dentaku/ast/functions/pluck.rb
+- lib/dentaku/ast/functions/reduce.rb
 - lib/dentaku/ast/functions/round.rb
 - lib/dentaku/ast/functions/rounddown.rb
 - lib/dentaku/ast/functions/roundup.rb
@@ -220,6 +223,7 @@ files:
 - lib/dentaku/tokenizer.rb
 - lib/dentaku/version.rb
 - lib/dentaku/visitor/infix.rb
+- spec/ast/abs_spec.rb
 - spec/ast/addition_spec.rb
 - spec/ast/all_spec.rb
 - spec/ast/and_function_spec.rb
@@ -233,6 +237,7 @@ files:
 - spec/ast/division_spec.rb
 - spec/ast/filter_spec.rb
 - spec/ast/function_spec.rb
+- spec/ast/intercept_spec.rb
 - spec/ast/map_spec.rb
 - spec/ast/max_spec.rb
 - spec/ast/min_spec.rb
@@ -242,6 +247,7 @@ files:
 - spec/ast/numeric_spec.rb
 - spec/ast/or_spec.rb
 - spec/ast/pluck_spec.rb
+- spec/ast/reduce_spec.rb
 - spec/ast/round_spec.rb
 - spec/ast/rounddown_spec.rb
 - spec/ast/roundup_spec.rb
@@ -283,11 +289,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: A formula language parser and evaluator
 test_files:
+- spec/ast/abs_spec.rb
 - spec/ast/addition_spec.rb
 - spec/ast/all_spec.rb
 - spec/ast/and_function_spec.rb
@@ -301,6 +308,7 @@ test_files:
 - spec/ast/division_spec.rb
 - spec/ast/filter_spec.rb
 - spec/ast/function_spec.rb
+- spec/ast/intercept_spec.rb
 - spec/ast/map_spec.rb
 - spec/ast/max_spec.rb
 - spec/ast/min_spec.rb
@@ -310,6 +318,7 @@ test_files:
 - spec/ast/numeric_spec.rb
 - spec/ast/or_spec.rb
 - spec/ast/pluck_spec.rb
+- spec/ast/reduce_spec.rb
 - spec/ast/round_spec.rb
 - spec/ast/rounddown_spec.rb
 - spec/ast/roundup_spec.rb