dentaku 3.3.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59795943c781e4fff4c3ea5a33a0035e6c9ac2cf3a4671ac9105201301601b3e
-  data.tar.gz: cfc61c4b4e522b54754dd6c960a82bc0cddcedebe160ed111d8d68e4334b5752
+  metadata.gz: 1eb86933b899627333d93e993cd2d093a11f4ca54b2e0f6668c3580a8f133975
+  data.tar.gz: 004bd53fa5c3c6815bafdbf98788de96757b688a6ba217b7f8e96be31a4f7d5d
 SHA512:
-  metadata.gz: c3d96b80d7a90ecbf946311743f92ce84e04d77bbb7e0c6ac44724e0f0b479b3ce27d19d6b191381c46c27b12bd352dd8881d786500c5c666eef923126c7e577
-  data.tar.gz: 93a8ab932fda06e5121c98c39a8561b728da48fef9501127a218776c18d18cfd4086b5d3db938e6f8bc1bbdad59e8c3ba258b84e4d22c0ffcdd39d0d8aa20d54
+  metadata.gz: 32f0e44638fc3738a3df5ba6a04abdb4ee66177049242260e26fea1ad6844a66a35e65ca5a27448f118838e6ccecd133f46650e9fbff5d878bbc14b1e7d952e8
+  data.tar.gz: 8081bcf51e30daa33dbaba3f8796951151c1bfd2e3975f63e5291aac7e04e09f2fc2f00aa956cfdad99caf1b8a8fb4f04b2c0789d8909b0982372e75dc7f7fc0

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,9 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.3.8
-  - 2.4.4
-  - 2.5.3
-  - 2.6.0
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 before_install:
   - gem update bundler
   - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [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
 
@@ -187,6 +199,7 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
+[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

data/dentaku.gemspec

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

data/lib/dentaku.rb

@@ -5,19 +5,21 @@ 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.evaluate(expression, data, &block)
   end
 
-  def self.evaluate!(expression, data = {})
-    calculator.evaluate!(expression, data)
+  def self.evaluate!(expression, data = {}, &block)
+    calculator.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 +38,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

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/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.update(
+              FlatHash.from_hash(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.update(
+              FlatHash.from_hash(item_identifier => item_value)
+            )
+          )
+        end
+      end
+    end
+  end
+end
+
+Dentaku::AST::Function.register_class(:any, Dentaku::AST::Any)

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

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

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

@@ -0,0 +1,36 @@
+require_relative '../function'
+require_relative '../../exceptions'
+
+module Dentaku
+  module AST
+    class Map < 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]
+
+        collection.map do |item_value|
+          expression.value(
+            context.update(
+              FlatHash.from_hash(item_identifier => item_value)
+            )
+          )
+        end
+      end
+    end
+  end
+end
+
+Dentaku::AST::Function.register_class(:map, Dentaku::AST::Map)

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

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

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

@@ -0,0 +1,29 @@
+require_relative '../function'
+require_relative '../../exceptions'
+
+module Dentaku
+  module AST
+    class Pluck < Function
+      def self.min_param_count
+        2
+      end
+
+      def self.max_param_count
+        2
+      end
+
+      def deferred_args
+        [1]
+      end
+
+      def value(context = {})
+        collection = @args[0].value(context)
+        pluck_path = @args[1].identifier
+
+        collection.map { |h| h.transform_keys(&:to_s)[pluck_path] }
+      end
+    end
+  end
+end
+
+Dentaku::AST::Function.register_class(:pluck, Dentaku::AST::Pluck)

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

@@ -1,5 +1,5 @@
 require_relative '../function'
 
 Dentaku::AST::Function.register(:round, :numeric, lambda { |numeric, places = 0|
-  Dentaku::AST::Function.numeric(numeric).round(places.to_i)
+  Dentaku::AST::Function.numeric(numeric).round(Dentaku::AST::Function.numeric(places || 0).to_i)
 })

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

@@ -1,7 +1,7 @@
 require_relative '../function'
 
 Dentaku::AST::Function.register(:rounddown, :numeric, lambda { |numeric, precision = 0|
-  precision = precision.to_i
+  precision = Dentaku::AST::Function.numeric(precision || 0).to_i
   tens = 10.0**precision
   result = (Dentaku::AST::Function.numeric(numeric) * tens).floor / tens
   precision <= 0 ? result.to_i : result

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

@@ -1,7 +1,7 @@
 require_relative '../function'
 
 Dentaku::AST::Function.register(:roundup, :numeric, lambda { |numeric, precision = 0|
-  precision = precision.to_i
+  precision = Dentaku::AST::Function.numeric(precision || 0).to_i
   tens = 10.0**precision
   result = (Dentaku::AST::Function.numeric(numeric) * tens).ceil / tens
   precision <= 0 ? result.to_i : result

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

@@ -1,8 +1,52 @@
 # import all functions from Ruby's Math module
 require_relative '../function'
 
+module Dentaku
+  module AST
+    class RubyMath < Function
+      def self.[](method)
+        klass = Class.new(self)
+        klass.implement(method)
+        klass
+      end
+
+      def self.implement(method)
+        @name = method
+        @implementation = Math.method(method)
+      end
+
+      def self.name
+        @name
+      end
+
+      def self.arity
+        @implementation.arity < 0 ? nil : @implementation.arity
+      end
+
+      def self.min_param_count
+        @implementation.parameters.select { |type, _name| type == :req }.count
+      end
+
+      def self.max_param_count
+        @implementation.parameters.select { |type, _name| type == :rest }.any? ? Float::INFINITY : @implementation.parameters.count
+      end
+
+      def self.call(*args)
+        @implementation.call(*args)
+      end
+
+      def value(context = {})
+        args = @args.flatten.map { |a| Dentaku::AST::Function.numeric(a.value(context)) }
+        self.class.call(*args)
+      end
+
+      def type
+        nil
+      end
+    end
+  end
+end
+
 Math.methods(false).each do |method|
-  Dentaku::AST::Function.register(method, :numeric, lambda { |*args|
-    Math.send(method, *args.flatten.map { |arg| Dentaku::AST::Function.numeric(arg) })
-  })
+  Dentaku::AST::Function.register_class(method, Dentaku::AST::RubyMath[method])
 end