dentaku 3.3.3 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3028783062dbbe592ef71ed7bc388e57fb3af383e8cb897893dc858c4b772f63
-  data.tar.gz: c940b16dcfdc9e0d1658a6b38b7521e7a17882c9519a1771d4117600a614100a
+  metadata.gz: 3dadbc209e58b2d2206dfaf48b83be3224db37f71d60cf590aadb63be9f4bebd
+  data.tar.gz: 86530c9c3333139994775a6bde16202005d89161a0b98670db58bcdda47f8e55
 SHA512:
-  metadata.gz: 7e9633152d5e43e11b52db3a91e8c012816c2cf956e5e3906ce2c058c44d5733fc2668d57049dbc3c44d07155c12bd3bcd8f416e4012986ddcd937bd46cae49c
-  data.tar.gz: bf89bf9096af4720832a7c904ce981a98beb69388996a1d29b190ce279fb8248eddc56175c5cc77646a36c65a0acc78dcd6c98fffb04ad0773cae22630eb3fdd
+  metadata.gz: f132401168218a3c021124ddabb56bbf485550bdff60a03a291ad811d8628e25caab2ba36e4bed4f8148bde048e56bed1fa31480774f2c19617a79282da81280
+  data.tar.gz: 3b6a8fc5e40988a9442be9dbdf890dc813e13b95fc2d0cb2f60252b2492d07fdf4ba47cdfedd0a85c002aaaa23a83bffb141b8f8f31fbf518678439d55c1e795

data/.rubocop.yml

@@ -8,11 +8,6 @@ AllCops:
 Style/AndOr:
   Enabled: true
 
-# Do not use braces for hash literals when they are the last argument of a
-# method call.
-Style/BracesAroundHashParameters:
-  Enabled: true
-
 # Align `when` with `case`.
 Layout/CaseIndentation:
   Enabled: true
@@ -93,11 +88,11 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 # Detect hard tabs, no hard tabs.
-Layout/Tab:
+Layout/IndentationStyle:
   Enabled: true
 
 # Blank lines should not have any spaces.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # No trailing whitespace.

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.3.8
-  - 2.4.4
-  - 2.5.3
-  - 2.6.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,6 +1,34 @@
 # Change Log
 
-## [Unreleased]
+## [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
+
+## [v3.4.0] 2020-12-07
+- allow access to intermediate values of flattened hashes
+- catch invalid array syntax in the parse phase
+- drop support for Ruby < 2.5, add support for Ruby 2.7
+- add support for subtracting date literals
+- improve error handling
+- improve math function implementation
+- add caching for calculated variable values
+- allow custom unbound variable handling block at Dentaku module level
+- add enum functions `ANY`, `ALL`, `MAP` and `PLUCK`
+- allow self-referential formulas in bulk expression solver
+- misc internal fixes and enhancements
+
+## [v3.3.4] 2019-11-21
+- bugfix release
+
+## [v3.3.3] 2019-11-20
 - date / duration addition and subtraction
 - validate arity for custom functions with variable arity
 - make AST serializable with Marshal.dump
@@ -184,7 +212,11 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
-[Unreleased]:  https://github.com/rubysolo/dentaku/compare/v3.3.2...HEAD
+[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
 [v3.3.2]:  https://github.com/rubysolo/dentaku/compare/v3.3.1...v3.3.2
 [v3.3.1]:  https://github.com/rubysolo/dentaku/compare/v3.3.0...v3.3.1
 [v3.3.0]:  https://github.com/rubysolo/dentaku/compare/v3.2.1...v3.3.0

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
 ----------------------
 
@@ -284,7 +286,7 @@ using Calculator#add_functions.
 FUNCTION ALIASES
 ----------------
 
-Every function can be aliased by synonyms. For example, it can be useful if 
+Every function can be aliased by synonyms. For example, it can be useful if
 your application is multilingual.
 
 ```ruby
@@ -321,7 +323,7 @@ LICENSE
 
 (The MIT License)
 
-Copyright © 2012-2018 Solomon White
+Copyright © 2012-2019 Solomon White
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the ‘Software’), to deal in

data/dentaku.gemspec

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

data/lib/dentaku.rb

@@ -1,23 +1,26 @@
 require "bigdecimal"
+require "concurrent"
 require "dentaku/calculator"
 require "dentaku/version"
 
 module Dentaku
   @enable_ast_caching = false
   @enable_dependency_order_caching = false
+  @enable_identifier_caching = false
   @aliases = {}
 
-  def self.evaluate(expression, data = {})
-    calculator.evaluate(expression, data)
+  def self.evaluate(expression, data = {}, &block)
+    calculator.value.evaluate(expression, data, &block)
   end
 
-  def self.evaluate!(expression, data = {})
-    calculator.evaluate!(expression, data)
+  def self.evaluate!(expression, data = {}, &block)
+    calculator.value.evaluate!(expression, data, &block)
   end
 
   def self.enable_caching!
     enable_ast_cache!
     enable_dependency_order_cache!
+    enable_identifier_cache!
   end
 
   def self.enable_ast_cache!
@@ -36,6 +39,14 @@ module Dentaku
     @enable_dependency_order_caching
   end
 
+  def self.enable_identifier_cache!
+    @enable_identifier_caching = true
+  end
+
+  def self.cache_identifier?
+    @enable_identifier_caching
+  end
+
   def self.aliases
     @aliases
   end
@@ -45,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.rb

@@ -15,15 +15,19 @@ require_relative './ast/array'
 require_relative './ast/grouping'
 require_relative './ast/case'
 require_relative './ast/function_registry'
+require_relative './ast/functions/all'
 require_relative './ast/functions/and'
+require_relative './ast/functions/any'
 require_relative './ast/functions/avg'
 require_relative './ast/functions/count'
 require_relative './ast/functions/duration'
 require_relative './ast/functions/if'
+require_relative './ast/functions/map'
 require_relative './ast/functions/max'
 require_relative './ast/functions/min'
 require_relative './ast/functions/not'
 require_relative './ast/functions/or'
+require_relative './ast/functions/pluck'
 require_relative './ast/functions/round'
 require_relative './ast/functions/rounddown'
 require_relative './ast/functions/roundup'

data/lib/dentaku/ast/access.rb

@@ -1,6 +1,8 @@
+require_relative "./node"
+
 module Dentaku
   module AST
-    class Access
+    class Access < Node
       def self.arity
         2
       end

data/lib/dentaku/ast/arithmetic.rb

@@ -31,7 +31,12 @@ module Dentaku
       def value(context = {})
         l = cast(left.value(context))
         r = cast(right.value(context))
-        l.public_send(operator, r)
+        begin
+          l.public_send(operator, r)
+        rescue ::TypeError => e
+          # Right cannot be converted to a suitable type for left. e.g. [] + 1
+          raise Dentaku::ArgumentError.for(:incompatible_type, value: r, for: l.class), e.message
+        end
       end
 
       private
@@ -60,7 +65,7 @@ module Dentaku
       end
 
       def valid_right?
-        valid_node?(right) || right.type == :duration
+        valid_node?(right) || right.type == :duration || right.type == :datetime
       end
 
       def validate_value(val)

data/lib/dentaku/ast/array.rb

@@ -1,6 +1,8 @@
+require_relative "./node"
+
 module Dentaku
   module AST
-    class Array
+    class Array < Node
       def self.arity
       end
 

data/lib/dentaku/ast/case/case_else.rb

@@ -1,10 +1,6 @@
 module Dentaku
   module AST
     class CaseElse < Node
-      def self.arity
-        1
-      end
-
       def initialize(node)
         @node = node
       end
@@ -16,6 +12,18 @@ module Dentaku
       def dependencies(context = {})
         @node.dependencies(context)
       end
+
+      def self.arity
+        1
+      end
+
+      def self.min_param_count
+        1
+      end
+
+      def self.max_param_count
+        1
+      end
     end
   end
 end

data/lib/dentaku/ast/case/case_switch_variable.rb

@@ -16,6 +16,14 @@ module Dentaku
       def self.arity
         1
       end
+
+      def self.min_param_count
+        1
+      end
+
+      def self.max_param_count
+        1
+      end
     end
   end
 end

data/lib/dentaku/ast/case/case_then.rb

@@ -1,10 +1,6 @@
 module Dentaku
   module AST
     class CaseThen < Node
-      def self.arity
-        1
-      end
-
       def initialize(node)
         @node = node
       end
@@ -16,6 +12,18 @@ module Dentaku
       def dependencies(context = {})
         @node.dependencies(context)
       end
+
+      def self.arity
+        1
+      end
+
+      def self.min_param_count
+        1
+      end
+
+      def self.max_param_count
+        1
+      end
     end
   end
 end

data/lib/dentaku/ast/case/case_when.rb

@@ -1,10 +1,6 @@
 module Dentaku
   module AST
     class CaseWhen < Operation
-      def self.arity
-        1
-      end
-
       def initialize(node)
         @node = node
       end
@@ -16,6 +12,18 @@ module Dentaku
       def dependencies(context = {})
         @node.dependencies(context)
       end
+
+      def self.arity
+        1
+      end
+
+      def self.min_param_count
+        1
+      end
+
+      def self.max_param_count
+        1
+      end
     end
   end
 end

data/lib/dentaku/ast/function.rb

@@ -12,7 +12,16 @@ module Dentaku
       end
 
       def dependencies(context = {})
-        @args.flat_map { |a| a.dependencies(context) }
+        deferred = deferred_args
+        @args.each_with_index
+             .reject { |_, i| deferred.include? i }
+             .flat_map { |a, _| a.dependencies(context) }
+      end
+
+      # override if your function implementation needs to defer evaluation of
+      # any arguments
+      def deferred_args
+        []
       end
 
       def self.get(name)

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

@@ -0,0 +1,36 @@
+require_relative '../function'
+require_relative '../../exceptions'
+
+module Dentaku
+  module AST
+    class All < 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).all? 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(:all, Dentaku::AST::All)

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

@@ -0,0 +1,36 @@
+require_relative '../function'
+require_relative '../../exceptions'
+
+module Dentaku
+  module AST
+    class Any < 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).any? 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(:any, Dentaku::AST::Any)