dentaku 3.5.8 → 4.0.0

data/spec/volatile_functions_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'dentaku'
+require 'dentaku/calculator'
+
+describe Dentaku::Calculator do
+  describe 'volatile functions' do
+    let(:calculator) { described_class.new }
+    let(:call_count) { { count: 0 } }
+
+    def register_counter(volatile:)
+      counter = call_count
+      calculator.add_function(:vol, :numeric, ->(x) { counter[:count] += 1; x }, volatile: volatile)
+    end
+
+    describe 'registration' do
+      it 'marks generated function classes volatile' do
+        registry = Dentaku::AST::FunctionRegistry.new
+        registry.register(:vol, :numeric, ->(x) { x }, volatile: true)
+        expect(registry.get(:vol).volatile?).to be true
+      end
+
+      it 'defaults to non-volatile' do
+        registry = Dentaku::AST::FunctionRegistry.new
+        registry.register(:plain, :numeric, ->(x) { x })
+        expect(registry.get(:plain).volatile?).to be_falsy
+      end
+
+      it 'reports built-in function classes as non-volatile' do
+        expect(Dentaku::AST::If.volatile?).to be false
+      end
+
+      it 'accepts a fifth tuple element in add_functions' do
+        calculator.add_functions([
+          [:vol5, :numeric, ->(x) { x }, nil, true],
+          [:plain5, :numeric, ->(x) { x }],
+        ])
+        expect(calculator.dependencies('IF(vol5(1) > 0, a, b)')).to eq(%w(a b))
+        expect(calculator.dependencies('IF(plain5(1) > 0, a, b)')).to eq(['a'])
+      end
+    end
+
+    describe 'dependency resolution' do
+      it 'does not evaluate a volatile IF predicate and returns both branches' do
+        register_counter(volatile: true)
+        expect(calculator.dependencies('IF(vol(1) > 0, a, b)')).to eq(%w(a b))
+        expect(call_count[:count]).to eq(0)
+      end
+
+      it 'still prunes when the predicate uses a pure custom function' do
+        register_counter(volatile: false)
+        expect(calculator.dependencies('IF(vol(1) > 0, a, b)')).to eq(['a'])
+        expect(call_count[:count]).to eq(1)
+      end
+
+      it 'treats volatility as recursive through the guard subtree' do
+        register_counter(volatile: true)
+        expect(calculator.dependencies('IF(1 + vol(1) > 2, a, b)')).to eq(%w(a b))
+        expect(call_count[:count]).to eq(0)
+      end
+
+      it 'does not prune CASE with a volatile switch' do
+        register_counter(volatile: true)
+        deps = calculator.dependencies('CASE vol(1) WHEN 1 THEN a ELSE b END')
+        expect(deps).to eq(%w(a b))
+        expect(call_count[:count]).to eq(0)
+      end
+
+      it 'does not prune CASE with a volatile when-clause' do
+        register_counter(volatile: true)
+        deps = calculator.dependencies('CASE 1 WHEN vol(1) THEN a ELSE b END')
+        expect(deps).to eq(%w(a b))
+        expect(call_count[:count]).to eq(0)
+      end
+
+      it 'does not treat a volatile AND operand as decisive' do
+        register_counter(volatile: true)
+        expect(calculator.dependencies('vol(0) > 1 AND x')).to eq(['x'])
+        expect(call_count[:count]).to eq(0)
+      end
+
+      it 'still prunes AND on a pure decisive operand without running the volatile side' do
+        register_counter(volatile: true)
+        expect(calculator.dependencies('1 > 2 AND vol(1) > 0')).to eq([])
+        expect(call_count[:count]).to eq(0)
+      end
+    end
+
+    describe 'evaluation' do
+      it 'evaluates a volatile predicate exactly once per evaluate!' do
+        register_counter(volatile: true)
+        expect(calculator.evaluate!('IF(vol(2) > 1, a, b)', a: 1, b: 2)).to eq(1)
+        expect(call_count[:count]).to eq(1)
+      end
+
+      it 'requires variables from both branches when the predicate is volatile' do
+        register_counter(volatile: true)
+        expect {
+          calculator.evaluate!('IF(vol(2) > 1, a, b)', a: 1)
+        }.to raise_error(Dentaku::UnboundVariableError) { |error|
+          expect(error.unbound_variables).to eq(['b'])
+        }
+      end
+
+      it 'does not change runtime short-circuit behavior for direct AST evaluation' do
+        register_counter(volatile: true)
+        node = calculator.ast('IF(vol(2) > 1, a, b)')
+        expect(node.value('a' => 1)).to eq(1)
+        expect(call_count[:count]).to eq(1)
+      end
+    end
+
+    describe 'solve' do
+      it 'resolves expressions with volatile guards when all branch inputs are provided' do
+        register_counter(volatile: true)
+        calculator.store(a: 1, b: 2)
+        result = calculator.solve!(c: 'IF(vol(2) > 1, a, b)', d: 'c + 1')
+        expect(result[:d]).to eq(2)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 3.5.8
+  version: 4.0.0
 platform: ruby
 authors:
 - Solomon White
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: tsort
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 description: "    Dentaku is a parser and evaluator for mathematical formulas\n"
 email:
 - rubysolo@gmail.com
@@ -63,7 +63,6 @@ files:
 - ".gitignore"
 - ".pryrc"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -180,6 +179,8 @@ files:
 - spec/dependency_resolver_spec.rb
 - spec/exceptions_spec.rb
 - spec/external_function_spec.rb
+- spec/gemspec_spec.rb
+- spec/identifiers_spec.rb
 - spec/numeric_parser_spec.rb
 - spec/parser_spec.rb
 - spec/print_visitor_spec.rb
@@ -190,10 +191,16 @@ files:
 - spec/tokenizer_spec.rb
 - spec/visitor/infix_spec.rb
 - spec/visitor_spec.rb
-homepage: http://github.com/rubysolo/dentaku
+- spec/volatile_functions_spec.rb
+homepage: https://github.com/rubysolo/dentaku
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/rubysolo/dentaku
+  source_code_uri: https://github.com/rubysolo/dentaku
+  changelog_uri: https://github.com/rubysolo/dentaku/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rubysolo/dentaku/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -201,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -211,53 +218,4 @@ requirements: []
 rubygems_version: 3.6.9
 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
-- spec/ast/and_spec.rb
-- spec/ast/any_spec.rb
-- spec/ast/arithmetic_spec.rb
-- spec/ast/avg_spec.rb
-- spec/ast/case_spec.rb
-- spec/ast/comparator_spec.rb
-- spec/ast/count_spec.rb
-- 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
-- spec/ast/mul_spec.rb
-- spec/ast/negation_spec.rb
-- spec/ast/node_spec.rb
-- 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
-- spec/ast/string_functions_spec.rb
-- spec/ast/sum_spec.rb
-- spec/ast/switch_spec.rb
-- spec/ast/xor_spec.rb
-- spec/benchmark.rb
-- spec/bulk_expression_solver_spec.rb
-- spec/calculator_spec.rb
-- spec/dentaku_spec.rb
-- spec/dependency_resolver_spec.rb
-- spec/exceptions_spec.rb
-- spec/external_function_spec.rb
-- spec/numeric_parser_spec.rb
-- spec/parser_spec.rb
-- spec/print_visitor_spec.rb
-- spec/spec_helper.rb
-- spec/token_matcher_spec.rb
-- spec/token_scanner_spec.rb
-- spec/token_spec.rb
-- spec/tokenizer_spec.rb
-- spec/visitor/infix_spec.rb
-- spec/visitor_spec.rb
+test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.5.9
-  - 2.6.7
-  - 2.7.3
-  - 3.0.1
-before_install:
-  - gem update bundler
-  - gem update --system