dentaku 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a7a3fa41f933a1f88a76e736c32e71dcf87f391a7a4ba09d37b2abad8269b2
-  data.tar.gz: 3045bd6715d486669c2fe015165a2bef31928fccdf4e6a07f59a67257b9f4867
+  metadata.gz: 1eb86933b899627333d93e993cd2d093a11f4ca54b2e0f6668c3580a8f133975
+  data.tar.gz: 004bd53fa5c3c6815bafdbf98788de96757b688a6ba217b7f8e96be31a4f7d5d
 SHA512:
-  metadata.gz: 2f8b4a5d727ec64a0308a57570fc51ff09864174fd0669956acb6b26b0d6b5694d6a0ec563eb107b577db79dd37ddd383fc36ec47bd17ebb11008981e2d5c729
-  data.tar.gz: 1cb16ed5d1bbad1c896d3907761206178093531ef02fe27eabaa19e1b5187f66f1d9d6586d410107133c08c520596dd7b9a6d5b47f23decb47e80ed2cbdd0e28
+  metadata.gz: 32f0e44638fc3738a3df5ba6a04abdb4ee66177049242260e26fea1ad6844a66a35e65ca5a27448f118838e6ccecd133f46650e9fbff5d878bbc14b1e7d952e8
+  data.tar.gz: 8081bcf51e30daa33dbaba3f8796951151c1bfd2e3975f63e5291aac7e04e09f2fc2f00aa956cfdad99caf1b8a8fb4f04b2c0789d8909b0982372e75dc7f7fc0

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true
@@ -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.
@@ -105,12 +100,12 @@ Layout/TrailingWhitespace:
   Enabled: true
 
 # Use quotes for string literals when they are enough.
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: true
 
 # Align `end` with the matching keyword or starting expression except for
 # assignments, where it should be aligned with the LHS.
-Lint/EndAlignment:
+Layout/EndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: variable
 

data/.travis.yml

@@ -1,12 +1,9 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.0.0-p648
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 before_install:
   - gem update bundler
   - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # 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
+
+## [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
+- performance optimization for arithmetic node validation
+- support lazy evaluation for expensive values
+- short-circuit IF function
+- better error when empty string is used in arithmetic operation
+
+## [v3.3.2] 2019-06-10
+- add ability to pre-load AST cache
+- fix negation node bug
+
+## [v3.3.1] 2019-03-26
+- better errors for parse failures and exceptions in internal functions
+- fix Ruby 2.6.0 deprecation warnings
+- fix issue with functions in nested case statements
+
 ## [v3.3.0] 2018-12-04
 - add array literal syntax
 - return correct type from string function AST nodes
@@ -166,7 +199,11 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
-[HEAD]:  https://github.com/rubysolo/dentaku/compare/v3.3.0...HEAD
+[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
 [v3.2.1]:  https://github.com/rubysolo/dentaku/compare/v3.2.0...v3.2.1
 [v3.2.0]:  https://github.com/rubysolo/dentaku/compare/v3.1.0...v3.2.0

data/README.md

@@ -284,7 +284,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 +321,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,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
@@ -44,8 +54,6 @@ module Dentaku
     @aliases = hash
   end
 
-  private
-
   def self.calculator
     @calculator ||= Dentaku::Calculator.new
   end

data/lib/dentaku/ast.rb

@@ -15,14 +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,10 +1,20 @@
+require_relative "./node"
+
 module Dentaku
   module AST
-    class Access
+    class Access < Node
       def self.arity
         2
       end
 
+      def self.min_param_count
+        arity
+      end
+
+      def self.max_param_count
+        arity
+      end
+
       def self.peek(*)
       end
 
@@ -22,6 +32,10 @@ module Dentaku
       def dependencies(context = {})
         @structure.dependencies(context) + @index.dependencies(context)
       end
+
+      def type
+        nil
+      end
     end
   end
 end

data/lib/dentaku/ast/arithmetic.rb

@@ -1,4 +1,5 @@
 require_relative './operation'
+require_relative '../date_arithmetic'
 require 'bigdecimal'
 require 'bigdecimal/util'
 
@@ -12,6 +13,7 @@ module Dentaku
           raise NodeError.new(:numeric, left.type, :left),
                 "#{self.class} requires numeric operands"
         end
+
         unless valid_right?
           raise NodeError.new(:numeric, right.type, :right),
                 "#{self.class} requires numeric operands"
@@ -29,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
@@ -40,7 +47,7 @@ module Dentaku
       end
 
       def numeric(val, prefer_integer)
-        v = BigDecimal.new(val, Float::DIG + 1)
+        v = BigDecimal(val, Float::DIG + 1)
         v = v.to_i if prefer_integer && v.frac.zero?
         v
       rescue ::TypeError
@@ -50,15 +57,15 @@ module Dentaku
       end
 
       def valid_node?(node)
-        node && (node.dependencies.any? || node.type == :numeric)
+        node && (node.type == :numeric || node.dependencies.any?)
       end
 
       def valid_left?
-        valid_node?(left)
+        valid_node?(left) || left.type == :datetime
       end
 
       def valid_right?
-        valid_node?(right)
+        valid_node?(right) || right.type == :duration || right.type == :datetime
       end
 
       def validate_value(val)
@@ -77,7 +84,7 @@ module Dentaku
       end
 
       def validate_format(string)
-        unless string =~ /\A-?\d*(\.\d+)?\z/
+        unless string =~ /\A-?\d*(\.\d+)?\z/ && !string.empty?
           raise Dentaku::ArgumentError.for(:invalid_value, value: string, for: BigDecimal),
                 "String input '#{string}' is not coercible to numeric"
         end
@@ -92,6 +99,14 @@ module Dentaku
       def self.precedence
         10
       end
+
+      def value(context = {})
+        if left.type == :datetime
+          Dentaku::DateArithmetic.new(left.value(context)).add(right.value(context))
+        else
+          super
+        end
+      end
     end
 
     class Subtraction < Arithmetic
@@ -102,6 +117,14 @@ module Dentaku
       def self.precedence
         10
       end
+
+      def value(context = {})
+        if left.type == :datetime
+          Dentaku::DateArithmetic.new(left.value(context)).sub(right.value(context))
+        else
+          super
+        end
+      end
     end
 
     class Multiplication < Arithmetic

data/lib/dentaku/ast/array.rb

@@ -1,9 +1,19 @@
+require_relative "./node"
+
 module Dentaku
   module AST
-    class Array
+    class Array < Node
       def self.arity
       end
 
+      def self.min_param_count
+        0
+      end
+
+      def self.max_param_count
+        Float::INFINITY
+      end
+
       def self.peek(*)
       end
 
@@ -18,6 +28,10 @@ module Dentaku
       def dependencies(context = {})
         @elements.flat_map { |el| el.dependencies(context) }
       end
+
+      def type
+        nil
+      end
     end
   end
 end

data/lib/dentaku/ast/case.rb

@@ -3,24 +3,34 @@ require_relative './case/case_when'
 require_relative './case/case_then'
 require_relative './case/case_switch_variable'
 require_relative './case/case_else'
+require 'dentaku/exceptions'
 
 module Dentaku
   module AST
     class Case < Node
+      def self.min_param_count
+        2
+      end
+
+      def self.max_param_count
+        Float::INFINITY
+      end
+
       def initialize(*nodes)
         @switch = nodes.shift
 
         unless @switch.is_a?(AST::CaseSwitchVariable)
-          raise 'Case missing switch variable'
+          raise ParseError.for(:node_invalid), 'Case missing switch variable'
         end
 
         @conditions = nodes
 
+        @else = nil
         @else = @conditions.pop if @conditions.last.is_a?(AST::CaseElse)
 
         @conditions.each do |condition|
           unless condition.is_a?(AST::CaseConditional)
-            raise "#{condition} is not a CaseConditional"
+            raise ParseError.for(:node_invalid), "#{condition} is not a CaseConditional"
           end
         end
       end
@@ -36,7 +46,7 @@ module Dentaku
         if @else
           return @else.value(context)
         else
-          raise "No block matched the switch value '#{switch_value}'"
+          raise ArgumentError.for(:invalid_value), "No block matched the switch value '#{switch_value}'"
         end
       end
 

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

@@ -1,17 +1,28 @@
+require 'dentaku/exceptions'
+
 module Dentaku
   module AST
     class CaseConditional < Node
       attr_reader :when,
                   :then
 
+      def self.min_param_count
+        2
+      end
+
+      def self.max_param_count
+        2
+      end
+
       def initialize(when_statement, then_statement)
         @when = when_statement
         unless @when.is_a?(AST::CaseWhen)
-          raise 'Expected first argument to be a CaseWhen'
+          raise ParseError.for(:node_invalid), 'Expected first argument to be a CaseWhen'
         end
+
         @then = then_statement
         unless @then.is_a?(AST::CaseThen)
-          raise 'Expected second argument to be a CaseThen'
+          raise ParseError.for(:node_invalid), 'Expected second argument to be a CaseThen'
         end
       end