dentaku 3.2.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 402c5a79a4d28d7323c53de8852007fa1c49c087
-  data.tar.gz: e5bd251b569708d740a7aeedde619e3bbfa34037
+SHA256:
+  metadata.gz: d5592654ee45adeb24167b584374fb2d69bc67d1db4d5f4ac99050130f187f8f
+  data.tar.gz: 31d3952b08887ae934661f4c0ecc5c298b2f36f0f8365cc1503495eb044eb558
 SHA512:
-  metadata.gz: a7dda0285c345400228dd7ec606958a95b9f57bd54f87a4333b4533d8f671b9ac66485ec8d29f66360b0dc026b00bb57ca842f4cf07e763c5840a2d84fa5a89e
-  data.tar.gz: d58d8f1451b0092feb6a8038f0d1efe8b6957c5de0a67badf53538395963098912853ea848c5fab03581ffeeddf89e4bb8812a735ec8ba6be48a76db35760e97
+  metadata.gz: d8e0d003f897e06173c91b200e62d9fed12ec3bacfe0f2ecc3f3705a1cbf914d1705948b79962f5ac6a5397138ff89c2123aa5c3753963f0046a88280b29825b
+  data.tar.gz: 5f48d3b8fef4e56ed308e717da88937bef508e47dfca4c3e16610aff7523f11405e53e2b55d00c53b5eca8efbe7be64df0d0d12e7ddafbc61099cde08bf92a53

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,10 @@
 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.9
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
 before_install:
   - gem update bundler
   - gem update --system

data/CHANGELOG.md

@@ -1,6 +1,78 @@
 # Change Log
 
-## [v3.2.0] Unreleased
+## [v3.5.1]
+- add bitwise shift left and shift right operators
+- improve numeric conversions
+- improve parse exceptions
+- improve bitwise exceptions
+- include variable name in bulk expression exceptions
+
+## [v3.5.0]
+- fix bug with function argument count
+- add XOR operator
+- make function args publicly accessible
+- better argument handling for collection functions
+- better dependency reporting for collection functions
+- allow ruby math-backed functions to be serialized
+- improve scientific notation handling
+- improve comparator argument errors
+- respect case sensitivity in nested case statments
+- add visitor pattern
+
+## [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
+- 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
+
+## [v3.2.1] 2018-10-24
+- make `evaluate` rescue more exceptions
+
+## [v3.2.0] 2018-03-14
 - add `COUNT` and `AVG` functions
 - add unicode support 😎
 - fix CASE parsing bug
@@ -8,7 +80,7 @@
 - add variadic MUL function
 - performance optimization
 
-## [v3.1.0] 2017-01-10
+## [v3.1.0] 2018-01-10
 - allow decimals with no leading zero
 - nested hash and array support in bulk expression solver
 - add a variadic SUM function
@@ -159,6 +231,18 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
+[Unreleased]: https://github.com/rubysolo/dentaku/compare/v3.5.1...HEAD
+[v3.5.1]: https://github.com/rubysolo/dentaku/compare/v3.5.0...v3.5.1
+[v3.5.0]:  https://github.com/rubysolo/dentaku/compare/v3.4.2...v3.5.0
+[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
+[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
 [v3.1.0]:  https://github.com/rubysolo/dentaku/compare/v3.0.0...v3.1.0
 [v3.0.0]:  https://github.com/rubysolo/dentaku/compare/v2.0.11...v3.0.0

data/README.md

@@ -5,7 +5,6 @@ Dentaku
 [![Gem Version](https://badge.fury.io/rb/dentaku.png)](http://badge.fury.io/rb/dentaku)
 [![Build Status](https://travis-ci.org/rubysolo/dentaku.png?branch=master)](https://travis-ci.org/rubysolo/dentaku)
 [![Code Climate](https://codeclimate.com/github/rubysolo/dentaku.png)](https://codeclimate.com/github/rubysolo/dentaku)
-[![Hakiri](https://hakiri.io/github/rubysolo/dentaku/master.svg)](https://hakiri.io/github/rubysolo/dentaku)
 [![Coverage](https://codecov.io/gh/rubysolo/dentaku/branch/master/graph/badge.svg)](https://codecov.io/gh/rubysolo/dentaku)
 
 
@@ -138,20 +137,22 @@ application, AST caching will consume more memory with each new formula.
 BUILT-IN OPERATORS AND FUNCTIONS
 ---------------------------------
 
-Math: `+`, `-`, `*`, `/`, `%`, `^`, `|`, `&`
+Math: `+`, `-`, `*`, `/`, `%`, `^`, `|`, `&`, `<<`, `>>`
 
 Also, all functions from Ruby's Math module, including `SIN`, `COS`, `TAN`, etc.
 
 Comparison: `<`, `>`, `<=`, `>=`, `<>`, `!=`, `=`,
 
-Logic: `IF`, `AND`, `OR`, `NOT`, `SWITCH`
+Logic: `IF`, `AND`, `OR`, `XOR`, `NOT`, `SWITCH`
 
 Numeric: `MIN`, `MAX`, `SUM`, `AVG`, `COUNT`, `ROUND`, `ROUNDDOWN`, `ROUNDUP`
 
-Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/master/spec/calculator_spec.rb#L292))
+Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/master/spec/calculator_spec.rb#L593))
 
 String: `LEFT`, `RIGHT`, `MID`, `LEN`, `FIND`, `SUBSTITUTE`, `CONCAT`, `CONTAINS`
 
+Collection: `MAP`, `FILTER`, `ALL`, `ANY`, `PLUCK`
+
 RESOLVING DEPENDENCIES
 ----------------------
 
@@ -284,7 +285,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 +322,7 @@ LICENSE
 
 (The MIT License)
 
-Copyright © 2012-2018 Solomon White
+Copyright © 2012-2022 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/ast/access.rb

@@ -1,10 +1,22 @@
+require_relative "./node"
+
 module Dentaku
   module AST
-    class Access
+    class Access < Node
+      attr_reader :structure, :index
+
       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 +34,14 @@ module Dentaku
       def dependencies(context = {})
         @structure.dependencies(context) + @index.dependencies(context)
       end
+
+      def type
+        nil
+      end
+
+      def accept(visitor)
+        visitor.visit_access(self)
+      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,36 +31,42 @@ module Dentaku
       def value(context = {})
         l = cast(left.value(context))
         r = cast(right.value(context))
+
         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
 
       private
 
-      def cast(val, prefer_integer = true)
+      def cast(val)
         validate_value(val)
-        numeric(val, prefer_integer)
+        numeric(val)
       end
 
-      def numeric(val, prefer_integer)
-        v = BigDecimal.new(val, Float::DIG + 1)
-        v = v.to_i if prefer_integer && v.frac.zero?
-        v
-      rescue ::TypeError
-        # If we got a TypeError BigDecimal or to_i failed;
-        # let value through so ruby things like Time - integer work
-        val
+      def numeric(val)
+        case val.to_s
+        when /\A\d*\.\d+\z/ then decimal(val)
+        when /\A-?\d+\z/ then val.to_i
+        else val
+        end
+      end
+
+      def decimal(val)
+        BigDecimal(val.to_s, Float::DIG + 1)
       end
 
       def valid_node?(node)
-        node && (node.dependencies.any? || node.type == :numeric)
+        node && (node.type == :numeric || node.type == :integer || 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 +85,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 +100,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 +118,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
@@ -120,7 +144,7 @@ module Dentaku
       end
 
       def value(context = {})
-        r = cast(right.value(context), false)
+        r = decimal(cast(right.value(context)))
         raise Dentaku::ZeroDivisionError if r.zero?
 
         cast(cast(left.value(context)) / r)
@@ -159,6 +183,14 @@ module Dentaku
         end
       end
 
+      def dependencies(context = {})
+        if percent?
+          @right.dependencies(context)
+        else
+          super
+        end
+      end
+
       def percent?
         left.nil?
       end
@@ -189,6 +221,10 @@ module Dentaku
         :**
       end
 
+      def display_operator
+        "^"
+      end
+
       def self.precedence
         30
       end

data/lib/dentaku/ast/array.rb

@@ -0,0 +1,41 @@
+require_relative "./node"
+
+module Dentaku
+  module AST
+    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
+
+      def initialize(*elements)
+        @elements = *elements
+      end
+
+      def value(context = {})
+        @elements.map { |el| el.value(context) }
+      end
+
+      def dependencies(context = {})
+        @elements.flat_map { |el| el.dependencies(context) }
+      end
+
+      def type
+        nil
+      end
+      
+      def accept(visitor)
+        visitor.visit_array(self)
+      end
+    end
+  end
+end

data/lib/dentaku/ast/bitwise.rb

@@ -2,15 +2,40 @@ require_relative './operation'
 
 module Dentaku
   module AST
-    class BitwiseOr < Operation
+    class Bitwise < Operation
       def value(context = {})
-        left.value(context) | right.value(context)
+        left_value = left.value(context)
+        right_value = right.value(context)
+
+        left_value.public_send(operator, right_value)
+      rescue NoMethodError => e
+        raise Dentaku::ArgumentError.for(:invalid_operator, value: left_value, for: left_value.class)
+      rescue TypeError => e
+        raise Dentaku::ArgumentError.for(:invalid_operator, value: right_value, for: right_value.class)
       end
     end
 
-    class BitwiseAnd < Operation
-      def value(context = {})
-        left.value(context) & right.value(context)
+    class BitwiseOr < Bitwise
+      def operator
+        :|
+      end
+    end
+
+    class BitwiseAnd < Bitwise
+      def operator
+        :&
+      end
+    end
+
+    class BitwiseShiftLeft < Bitwise
+      def operator
+        :<<
+      end
+    end
+
+    class BitwiseShiftRight < Bitwise
+      def operator
+        :>>
       end
     end
   end

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

@@ -1,23 +1,38 @@
+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
 
       def dependencies(context = {})
         @when.dependencies(context) + @then.dependencies(context)
       end
+
+      def accept(visitor)
+        visitor.visit_case_conditional(self)
+      end
     end
   end
 end

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

@@ -1,9 +1,7 @@
 module Dentaku
   module AST
     class CaseElse < Node
-      def self.arity
-        1
-      end
+      attr_reader :node
 
       def initialize(node)
         @node = node
@@ -16,6 +14,22 @@ 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
+
+      def accept(visitor)
+        visitor.visit_else(self)
+      end
     end
   end
 end

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

@@ -1,6 +1,8 @@
 module Dentaku
   module AST
     class CaseSwitchVariable < Node
+      attr_reader :node
+
       def initialize(node)
         @node = node
       end
@@ -16,6 +18,18 @@ module Dentaku
       def self.arity
         1
       end
+
+      def self.min_param_count
+        1
+      end
+
+      def self.max_param_count
+        1
+      end
+
+      def accept(visitor)
+        visitor.visit_switch(self)
+      end
     end
   end
 end

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

@@ -1,9 +1,7 @@
 module Dentaku
   module AST
     class CaseThen < Node
-      def self.arity
-        1
-      end
+      attr_reader :node
 
       def initialize(node)
         @node = node
@@ -16,6 +14,22 @@ 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
+
+      def accept(visitor)
+        visitor.visit_then(self)
+      end
     end
   end
 end

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

@@ -1,9 +1,7 @@
 module Dentaku
   module AST
     class CaseWhen < Operation
-      def self.arity
-        1
-      end
+      attr_reader :node
 
       def initialize(node)
         @node = node
@@ -16,6 +14,26 @@ 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
+
+      def accept(visitor)
+        visitor.visit_when(self)
+      end
+
+      def to_s
+        'WHEN'
+      end
     end
   end
 end