dentaku 3.4.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0275b981a44fdb17f4eb1ec144c57baf3f5ab46f0bf65c6f98dda51b3bc80658
-  data.tar.gz: b5120974bd987a35e5388a5932e0a01d9a0d05692df9d0281d65ad729484754c
+  metadata.gz: 3dadbc209e58b2d2206dfaf48b83be3224db37f71d60cf590aadb63be9f4bebd
+  data.tar.gz: 86530c9c3333139994775a6bde16202005d89161a0b98670db58bcdda47f8e55
 SHA512:
-  metadata.gz: 76f427ebaed43836b95201f5939c90d3391b9887a7bfbbc3fc51973a7fdf7c25453be641fba639480e095284af26391437b5711731625e211ccf55cd616967c2
-  data.tar.gz: 6934989420f0c0d86914bcd10c2f562c138e883b3bb4b0d33013553f2403d45064b472932d069d79cb69c82c24a672668b50cc46fbca7740e2bf71982913635c
+  metadata.gz: f132401168218a3c021124ddabb56bbf485550bdff60a03a291ad811d8628e25caab2ba36e4bed4f8148bde048e56bed1fa31480774f2c19617a79282da81280
+  data.tar.gz: 3b6a8fc5e40988a9442be9dbdf890dc813e13b95fc2d0cb2f60252b2492d07fdf4ba47cdfedd0a85c002aaaa23a83bffb141b8f8f31fbf518678439d55c1e795

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [v3.4.2]
+- add FILTER function
+- add concurrent-ruby dependency to make global calculator object thread safe
+- add Ruby 3 support
+- allow formulas to access intermediate context values
+- fix incorrect Ruby Math function return type
+- fix context mutation bug
+- fix dependency resolution bug
+
 ## [v3.4.1] 2020-12-12
 - prevent extra evaluations in bulk expression solver
 
@@ -203,7 +212,8 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
-[HEAD]:  https://github.com/rubysolo/dentaku/compare/v3.4.0...v3.4.1
+[v3.4.2]:  https://github.com/rubysolo/dentaku/compare/v3.4.1...v3.4.2
+[v3.4.1]:  https://github.com/rubysolo/dentaku/compare/v3.4.0...v3.4.1
 [v3.4.0]:  https://github.com/rubysolo/dentaku/compare/v3.3.4...v3.4.0
 [v3.3.4]:  https://github.com/rubysolo/dentaku/compare/v3.3.3...v3.3.4
 [v3.3.3]:  https://github.com/rubysolo/dentaku/compare/v3.3.2...v3.3.3

data/README.md

@@ -152,6 +152,8 @@ Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/m
 
 String: `LEFT`, `RIGHT`, `MID`, `LEN`, `FIND`, `SUBSTITUTE`, `CONCAT`, `CONTAINS`
 
+Collection: `MAP`, `FILTER`, `ALL`, `ANY`, `PLUCK`
+
 RESOLVING DEPENDENCIES
 ----------------------
 

data/dentaku.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |s|
     Dentaku is a parser and evaluator for mathematical formulas
   DESC
 
+  s.add_dependency('concurrent-ruby')
+
   s.add_development_dependency('codecov')
   s.add_development_dependency('pry')
   s.add_development_dependency('pry-byebug')

data/lib/dentaku.rb

@@ -1,4 +1,5 @@
 require "bigdecimal"
+require "concurrent"
 require "dentaku/calculator"
 require "dentaku/version"
 
@@ -9,11 +10,11 @@ module Dentaku
   @aliases = {}
 
   def self.evaluate(expression, data = {}, &block)
-    calculator.evaluate(expression, data, &block)
+    calculator.value.evaluate(expression, data, &block)
   end
 
   def self.evaluate!(expression, data = {}, &block)
-    calculator.evaluate!(expression, data, &block)
+    calculator.value.evaluate!(expression, data, &block)
   end
 
   def self.enable_caching!
@@ -55,7 +56,7 @@ module Dentaku
   end
 
   def self.calculator
-    @calculator ||= Dentaku::Calculator.new
+    @calculator ||= Concurrent::ThreadLocalVar.new { Dentaku::Calculator.new }
   end
 end
 

data/lib/dentaku/ast/functions/all.rb

@@ -23,8 +23,8 @@ module Dentaku
 
         Array(collection).all? do |item_value|
           expression.value(
-            context.update(
-              FlatHash.from_hash(item_identifier => item_value)
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
             )
           )
         end

data/lib/dentaku/ast/functions/any.rb

@@ -23,8 +23,8 @@ module Dentaku
 
         Array(collection).any? do |item_value|
           expression.value(
-            context.update(
-              FlatHash.from_hash(item_identifier => item_value)
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
             )
           )
         end

data/lib/dentaku/ast/functions/filter.rb

@@ -0,0 +1,36 @@
+require_relative '../function'
+require_relative '../../exceptions'
+
+module Dentaku
+  module AST
+    class Filter < Function
+      def self.min_param_count
+        3
+      end
+
+      def self.max_param_count
+        3
+      end
+
+      def deferred_args
+        [1, 2]
+      end
+
+      def value(context = {})
+        collection      = @args[0].value(context)
+        item_identifier = @args[1].identifier
+        expression      = @args[2]
+
+        Array(collection).select do |item_value|
+          expression.value(
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
+            )
+          )
+        end
+      end
+    end
+  end
+end
+
+Dentaku::AST::Function.register_class(:filter, Dentaku::AST::Filter)

data/lib/dentaku/ast/functions/map.rb

@@ -23,8 +23,8 @@ module Dentaku
 
         collection.map do |item_value|
           expression.value(
-            context.update(
-              FlatHash.from_hash(item_identifier => item_value)
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
             )
           )
         end

data/lib/dentaku/ast/functions/mul.rb

@@ -1,13 +1,12 @@
 require_relative '../function'
 
 Dentaku::AST::Function.register(:mul, :numeric, ->(*args) {
-  flatten_args = args.flatten
-  if flatten_args.empty?
+  if args.empty?
     raise Dentaku::ArgumentError.for(
         :too_few_arguments,
         function_name: 'MUL()', at_least: 1, given: 0
     ), 'MUL() requires at least one argument'
   end
 
-  flatten_args.map { |arg| Dentaku::AST::Function.numeric(arg) }.reduce(1, :*)
+  args.flatten.map { |arg| Dentaku::AST::Function.numeric(arg) }.reduce(1, :*)
 })

data/lib/dentaku/ast/functions/ruby_math.rb

@@ -40,8 +40,10 @@ module Dentaku
         self.class.call(*args)
       end
 
+      ARRAY_RETURN_TYPES = [:frexp, :lgamma].freeze
+
       def type
-        nil
+        ARRAY_RETURN_TYPES.include?(@name) ? :array : :numeric
       end
     end
   end

data/lib/dentaku/ast/functions/sum.rb

@@ -1,13 +1,12 @@
 require_relative '../function'
 
 Dentaku::AST::Function.register(:sum, :numeric, ->(*args) {
-  flatten_args = args.flatten
-  if flatten_args.empty?
+  if args.empty?
     raise Dentaku::ArgumentError.for(
         :too_few_arguments,
         function_name: 'SUM()', at_least: 1, given: 0
     ), 'SUM() requires at least one argument'
   end
 
-  flatten_args.map { |arg| Dentaku::AST::Function.numeric(arg) }.reduce(0, :+)
+  args.flatten.map { |arg| Dentaku::AST::Function.numeric(arg) }.reduce(0, :+)
 })

data/lib/dentaku/ast/identifier.rb

@@ -31,13 +31,13 @@ module Dentaku
       end
 
       def dependencies(context = {})
-        context.key?(identifier) ? dependencies_of(context[identifier]) : [identifier]
+        context.key?(identifier) ? dependencies_of(context[identifier], context) : [identifier]
       end
 
       private
 
-      def dependencies_of(node)
-        node.respond_to?(:dependencies) ? node.dependencies : []
+      def dependencies_of(node, context)
+        node.respond_to?(:dependencies) ? node.dependencies(context) : []
       end
     end
   end

data/lib/dentaku/calculator.rb

@@ -59,7 +59,7 @@ module Dentaku
       store(data) do
         node = expression
         node = ast(node) unless node.is_a?(AST::Node)
-        unbound = node.dependencies - memory.keys
+        unbound = node.dependencies(memory)
         unless unbound.empty?
           raise UnboundVariableError.new(unbound),
                 "no value provided for variables: #{unbound.uniq.join(', ')}"

data/lib/dentaku/version.rb

@@ -1,3 +1,3 @@
 module Dentaku
-  VERSION = "3.4.1"
+  VERSION = "3.4.2"
 end

data/spec/ast/filter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'dentaku/ast/functions/filter'
+require 'dentaku'
+
+describe Dentaku::AST::Filter do
+  it 'excludes unmatched values' do
+    result = Dentaku('SUM(FILTER(vals, val, val > 1))', vals: [1, 2, 3])
+    expect(result).to eq(5)
+  end
+
+  it 'works with a single value if needed for some reason' do
+    result = Dentaku('FILTER(vals, val, val > 1)', vals: 1)
+    expect(result).to eq([])
+
+    result = Dentaku('FILTER(vals, val, val > 1)', vals: 2)
+    expect(result).to eq([2])
+  end
+end

data/spec/ast/map_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'dentaku/ast/functions/map'
+require 'dentaku'
+
+describe Dentaku::AST::Map do
+  it 'operates on each value in an array' do
+    result = Dentaku('SUM(MAP(vals, val, val + 1))', vals: [1, 2, 3])
+    expect(result).to eq(9)
+  end
+
+  it 'works with an empty array' do
+    result = Dentaku('MAP(vals, val, val + 1)', vals: [])
+    expect(result).to eq([])
+  end
+end

data/spec/ast/max_spec.rb

@@ -17,4 +17,17 @@ describe 'Dentaku::AST::Function::Max' do
     result = Dentaku('MAX(1, x, 1.8)', x: [1.5, 2.3, 1.7])
     expect(result).to eq(2.3)
   end
+
+  it 'returns the largest value if only an Array is passed' do
+    result = Dentaku('MAX(x)', x: [1.5, 2.3, 1.7])
+    expect(result).to eq(2.3)
+  end
+
+  context 'checking errors' do
+    let(:calculator) { Dentaku::Calculator.new }
+
+    it 'does not raise an error if an empty array is passed' do
+      expect(calculator.evaluate!('MAX(x)', x: [])).to eq(nil)
+    end
+  end
 end

data/spec/ast/min_spec.rb

@@ -17,4 +17,17 @@ describe 'Dentaku::AST::Function::Min' do
     result = Dentaku('MIN(1, x, 1.8)', x: [1.5, 0.3, 1.7])
     expect(result).to eq(0.3)
   end
+
+  it 'returns the smallest value if only an Array is passed' do
+    result = Dentaku('MIN(x)', x: [1.5, 2.3, 1.7])
+    expect(result).to eq(1.5)
+  end
+
+  context 'checking errors' do
+    let(:calculator) { Dentaku::Calculator.new }
+
+    it 'does not raise an error if an empty array is passed' do
+      expect(calculator.evaluate!('MIN(x)', x: [])).to eq(nil)
+    end
+  end
 end

data/spec/ast/mul_spec.rb

@@ -35,8 +35,9 @@ describe 'Dentaku::AST::Function::Mul' do
       expect { calculator.evaluate!('MUL()') }.to raise_error(Dentaku::ArgumentError)
     end
 
-    it 'raises an error if an empty array is passed' do
-      expect { calculator.evaluate!('MUL(x)', x: []) }.to raise_error(Dentaku::ArgumentError)
+    it 'does not raise an error if an empty array is passed' do
+      result = calculator.evaluate!('MUL(x)', x: [])
+      expect(result).to eq(1)
     end
   end
 end

data/spec/ast/sum_spec.rb

@@ -35,8 +35,9 @@ describe 'Dentaku::AST::Function::Sum' do
       expect { calculator.evaluate!('SUM()') }.to raise_error(Dentaku::ArgumentError)
     end
 
-    it 'raises an error if an empty array is passed' do
-      expect { calculator.evaluate!('SUM(x)', x: []) }.to raise_error(Dentaku::ArgumentError)
+    it 'does not raise an error if an empty array is passed' do
+      result = calculator.evaluate!('SUM(x)', x: [])
+      expect(result).to eq(0)
     end
   end
 end

data/spec/calculator_spec.rb

@@ -502,6 +502,10 @@ describe Dentaku::Calculator do
           {"name" => "Bob",  "age" => 44},
           {"name" => "Jane", "age" => 27}
         ])).to eq(["Bob", "Jane"])
+        expect(calculator.evaluate!('map(users, u, IF(u.age < 30, u, null))', users: [
+          {"name" => "Bob",  "age" => 44},
+          {"name" => "Jane", "age" => 27}
+        ])).to eq([nil, { "name" => "Jane", "age" => 27 }])
       end
     end
 
@@ -696,9 +700,13 @@ describe Dentaku::Calculator do
       it method do
         if Math.method(method).arity == 2
           expect(calculator.evaluate("#{method}(x,y)", x: 1, y: '2')).to eq(Math.send(method, 1, 2))
+          expect(calculator.evaluate("#{method}(x,y) + 1", x: 1, y: '2')).to be_within(0.00001).of(Math.send(method, 1, 2) + 1)
           expect { calculator.evaluate!("#{method}(x)", x: 1) }.to raise_error(Dentaku::ParseError)
         else
           expect(calculator.evaluate("#{method}(1)")).to eq(Math.send(method, 1))
+          unless [:atanh, :frexp, :lgamma].include?(method)
+            expect(calculator.evaluate("#{method}(1) + 1")).to be_within(0.00001).of(Math.send(method, 1) + 1)
+          end
         end
       end
     end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.4.2
 platform: ruby
 authors:
 - Solomon White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +176,7 @@ files:
 - lib/dentaku/ast/functions/avg.rb
 - lib/dentaku/ast/functions/count.rb
 - lib/dentaku/ast/functions/duration.rb
+- lib/dentaku/ast/functions/filter.rb
 - lib/dentaku/ast/functions/if.rb
 - lib/dentaku/ast/functions/map.rb
 - lib/dentaku/ast/functions/max.rb
@@ -210,7 +225,9 @@ files:
 - 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/map_spec.rb
 - spec/ast/max_spec.rb
 - spec/ast/min_spec.rb
 - spec/ast/mul_spec.rb
@@ -269,7 +286,9 @@ test_files:
 - 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/map_spec.rb
 - spec/ast/max_spec.rb
 - spec/ast/min_spec.rb
 - spec/ast/mul_spec.rb