dentaku 3.5.3 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a51418767c413ccded1f235a56d34866005edf21cbc0d4cf5848d4cff4bc801f
-  data.tar.gz: 2009c09a76a5cc0b85cf04769c93f0d372cc8613f410a18401de53ca268b134d
+  metadata.gz: 42f22227c2d7aef33e71f5c177f65ca3e7855115466d4d04851e6286bcbe1955
+  data.tar.gz: e779f142e5f458aed8437539bfe98ee73b4bf86a0ddb280cceec586ebcd62190
 SHA512:
-  metadata.gz: 6cfeabc676fa63016096d2f3c291d60a68ce247fe7c75ba195cdc2968c28af85de9ab9eeaaa9e88749cbf7920a120b1e6fe4d78464b98f9c825180d42aafc4f1
-  data.tar.gz: 42863ad11afff2dc72dfe906d1fdc1c07821f4391dcb7fc67921d862c736350be15a6671beac9c16de9e1345f17869e0de40bb131bc1fcfea70190538274bd53
+  metadata.gz: 8c4305e2d7f5c8289edcc5f530dbb0d98cbc95f6db59a8ba98561506f2ec7e41ef89c6ab7271d8754f0a0dfc5ade6325833269f38595593c39eca44c8dcce7c5
+  data.tar.gz: 9a186d4164b031bbe27fb1490184d9c23387849267d4b1067c6bec6a39afdee4e6bf97d8bbbb364f36474fdad0e37e59f4ef63dae1454055244bc06f6791905b

data/.github/workflows/rspec.yml

@@ -0,0 +1,26 @@
+name: rspec
+on:
+  push:
+  pull_request:
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+        - '3.2'
+        - '3.3'
+        - '3.4'
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+        bundler-cache: true
+    - run: bundle exec rspec --format documentation

data/.github/workflows/rubocop.yml

@@ -0,0 +1,14 @@
+name: rubocop
+on:
+  push:
+  pull_request:
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3'
+        bundler-cache: true
+    - run: bundle exec rubocop

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log
 
-## [Unreleased]
+## [v3.5.5] 2025-08-20
+- fix percentages in print visitor
+- repo cleanup
+- fix modulo zero
+- fix array arithmetic
+- refactor parser
+
+## [v3.5.4] 2024-08-13
+- add support for default value for PLUCK function
+- improve error handling for MAP/ANY/ALL functions
+- fix modulo / percentage operator determination
+- fix string casing bug with bulk expressions
+- add explicit gem dependency for BigDecimal
+
+## [v3.5.3] 2024-07-04
 - add support for empty array literals
 - add support for quoted identifiers
 - add REDUCE function
@@ -9,7 +23,7 @@
 - improve custom class arithmetic
 - fix IF dependency
 
-## [v3.5.2]
+## [v3.5.2] 2023-12-06
 - add ABS function
 - add array support for AST visitors
 - add support for function callbacks
@@ -22,14 +36,14 @@
 - fix handling of Math::DomainError
 - fix invalid cast
 
-## [v3.5.1]
+## [v3.5.1] 2022-10-24
 - 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]
+## [v3.5.0] 2022-03-17
 - fix bug with function argument count
 - add XOR operator
 - make function args publicly accessible
@@ -41,7 +55,7 @@
 - respect case sensitivity in nested case statments
 - add visitor pattern
 
-## [v3.4.2]
+## [v3.4.2] 2021-07-14
 - add FILTER function
 - add concurrent-ruby dependency to make global calculator object thread safe
 - add Ruby 3 support
@@ -253,7 +267,9 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
-[Unreleased]: https://github.com/rubysolo/dentaku/compare/v3.5.2...HEAD
+[v3.5.5]: https://github.com/rubysolo/dentaku/compare/v3.5.4...v3.5.5
+[v3.5.4]: https://github.com/rubysolo/dentaku/compare/v3.5.3...v3.5.4
+[v3.5.3]: https://github.com/rubysolo/dentaku/compare/v3.5.2...v3.5.3
 [v3.5.2]: https://github.com/rubysolo/dentaku/compare/v3.5.1...v3.5.2
 [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

data/README.md

@@ -3,9 +3,6 @@ Dentaku
 
 [![Join the chat at https://gitter.im/rubysolo/dentaku](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rubysolo/dentaku?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![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)
-[![Coverage](https://codecov.io/gh/rubysolo/dentaku/branch/master/graph/badge.svg)](https://codecov.io/gh/rubysolo/dentaku)
 
 
 DESCRIPTION
@@ -147,7 +144,7 @@ Logic: `IF`, `AND`, `OR`, `XOR`, `NOT`, `SWITCH`
 
 Numeric: `MIN`, `MAX`, `SUM`, `AVG`, `COUNT`, `ROUND`, `ROUNDDOWN`, `ROUNDUP`, `ABS`, `INTERCEPT`
 
-Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/master/spec/calculator_spec.rb#L593))
+Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/main/lib/dentaku/ast/case.rb))
 
 String: `LEFT`, `RIGHT`, `MID`, `LEN`, `FIND`, `SUBSTITUTE`, `CONCAT`, `CONTAINS`
 

data/dentaku.gemspec

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

data/lib/dentaku/ast/access.rb

@@ -17,9 +17,6 @@ module Dentaku
         arity
       end
 
-      def self.peek(*)
-      end
-
       def initialize(data_structure, index)
         @structure = data_structure
         @index = index

data/lib/dentaku/ast/arithmetic.rb

@@ -9,20 +9,6 @@ module Dentaku
       DECIMAL = /\A-?\d*\.\d+\z/.freeze
       INTEGER = /\A-?\d+\z/.freeze
 
-      def initialize(*)
-        super
-
-        unless valid_left?
-          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"
-        end
-      end
-
       def type
         :numeric
       end
@@ -69,8 +55,9 @@ module Dentaku
       def datetime?(val)
         # val is a Date, Time, or DateTime
         return true if val.respond_to?(:strftime)
+        return false unless val.is_a?(::String)
 
-        val.to_s =~ Dentaku::TokenScanner::DATE_TIME_REGEXP
+        val =~ Dentaku::TokenScanner::DATE_TIME_REGEXP
       end
 
       def valid_node?(node)
@@ -179,62 +166,61 @@ module Dentaku
 
     class Modulo < Arithmetic
       def self.arity
-        @arity
+        2
       end
 
-      def self.peek(input)
-        @arity = 1
-        @arity = 2 if input.length > 1
+      def self.precedence
+        20
       end
 
-      def initialize(left, right = nil)
-        if right
-          @left  = left
-          @right = right
-        else
-          @right = left
-        end
+      def self.resolve_class(next_token)
+        next_token.nil? || next_token.operator? || next_token.close? ? Percentage : self
+      end
 
-        unless valid_left?
-          raise NodeError.new(%i[numeric nil], left.type, :left),
-                "#{self.class} requires numeric operands or nil"
-        end
-        unless valid_right?
-          raise NodeError.new(:numeric, right.type, :right),
-                "#{self.class} requires numeric operands"
-        end
+      def operator
+        :%
       end
 
-      def dependencies(context = {})
-        if percent?
-          @right.dependencies(context)
-        else
-          super
+      def value(context = {})
+        r = decimal(cast(right.value(context)))
+        raise Dentaku::ZeroDivisionError if r.zero?
+
+        cast(cast(left.value(context)) % r)
+      end
+    end
+
+    class Percentage < Arithmetic
+      def self.arity
+        1
+      end
+
+      def initialize(child)
+        @left = child
+
+        unless valid_left?
+          raise NodeError.new(:numeric, left.type, :left),
+                "#{self.class} requires a numeric operand"
         end
       end
 
-      def percent?
-        left.nil?
+      def dependencies(context = {})
+        @left.dependencies(context)
       end
 
       def value(context = {})
-        if percent?
-          cast(right.value(context)) * 0.01
-        else
-          super
-        end
+        cast(left.value(context)) * 0.01
       end
 
       def operator
         :%
       end
 
-      def self.precedence
-        20
+      def operator_spacing
+        ""
       end
 
-      def valid_left?
-        valid_node?(left) || left.nil?
+      def self.precedence
+        30
       end
     end
 

data/lib/dentaku/ast/array.rb

@@ -14,9 +14,6 @@ module Dentaku
         Float::INFINITY
       end
 
-      def self.peek(*)
-      end
-
       def initialize(*elements)
         @elements = *elements
       end
@@ -32,7 +29,7 @@ module Dentaku
       def type
         nil
       end
-      
+
       def accept(visitor)
         visitor.visit_array(self)
       end

data/lib/dentaku/ast/case.rb

@@ -7,6 +7,18 @@ require 'dentaku/exceptions'
 
 module Dentaku
   module AST
+    # Examples of using in a formula:
+    #
+    #     CASE x WHEN 1 THEN 2 WHEN 3 THEN 4 ELSE END
+    #
+    #     CASE fruit
+    #     WHEN 'apple'
+    #       THEN 1 * quantity
+    #     WHEN 'banana'
+    #       THEN 2 * quantity
+    #     ELSE
+    #       3 * quantity
+    #     END
     class Case < Node
       attr_reader :switch, :conditions, :else
 

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

@@ -9,11 +9,7 @@ module Dentaku
         expression      = @args[2]
 
         collection.all? do |item_value|
-          expression.value(
-            context.merge(
-              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
-            )
-          )
+          mapped_value(expression, context, item_identifier => item_value)
         end
       end
     end

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

@@ -9,11 +9,7 @@ module Dentaku
         expression      = @args[2]
 
         collection.any? do |item_value|
-          expression.value(
-            context.merge(
-              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
-            )
-          )
+          mapped_value(expression, context, item_identifier => item_value)
         end
       end
     end

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

@@ -33,6 +33,19 @@ module Dentaku
       def validate_identifier(arg, message = "#{name}() requires second argument to be an identifier")
         raise ParseError.for(:node_invalid), message unless arg.is_a?(Identifier)
       end
+
+      private
+
+      def mapped_value(expression, context, item_context)
+        expression.value(
+          context.merge(
+            FlatHash.from_hash_with_intermediates(item_context)
+          )
+        )
+      rescue => e
+        raise e if context["__evaluation_mode"] == :strict
+        nil
+      end
     end
   end
 end

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

@@ -9,11 +9,7 @@ module Dentaku
         expression      = @args[2]
 
         collection.map do |item_value|
-          expression.value(
-            context.merge(
-              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
-            )
-          )
+          mapped_value(expression, context, item_identifier => item_value)
         end
       end
     end

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

@@ -9,19 +9,23 @@ module Dentaku
       end
 
       def self.max_param_count
-        2
+        3
       end
 
       def value(context = {})
         collection = Array(@args[0].value(context))
+
         unless collection.all? { |elem| elem.is_a?(Hash) }
           raise ArgumentError.for(:incompatible_type, value: collection),
                 'PLUCK() requires first argument to be an array of hashes'
         end
 
         pluck_path = @args[1].identifier
+        default    = @args[2]
 
-        collection.map { |h| h.transform_keys(&:to_s)[pluck_path] }
+        collection.map { |h|
+          h.transform_keys(&:to_s).fetch(pluck_path, default&.value(context))
+        }
       end
     end
   end

data/lib/dentaku/ast/node.rb

@@ -9,7 +9,8 @@ module Dentaku
         nil
       end
 
-      def self.peek(*)
+      def self.resolve_class(*)
+        self
       end
 
       def dependencies(context = {})

data/lib/dentaku/ast/operation.rb

@@ -33,7 +33,12 @@ module Dentaku
       def display_operator
         operator.to_s
       end
+
       alias_method :to_s, :display_operator
+
+      def operator_spacing
+        " "
+      end
     end
   end
 end

data/lib/dentaku/ast.rb

@@ -39,4 +39,4 @@ require_relative './ast/functions/ruby_math'
 require_relative './ast/functions/string_functions'
 require_relative './ast/functions/sum'
 require_relative './ast/functions/switch'
-require_relative './ast/functions/xor'
+require_relative './ast/functions/xor'

data/lib/dentaku/bulk_expression_solver.rb

@@ -6,16 +6,41 @@ require 'dentaku/tokenizer'
 
 module Dentaku
   class BulkExpressionSolver
+    class StrictEvaluator
+      def initialize(calculator)
+        @calculator = calculator
+      end
+
+      def evaluate(*args)
+        @calculator.evaluate!(*args)
+      end
+    end
+
+    class PermissiveEvaluator
+      def initialize(calculator, block)
+        @calculator = calculator
+        @block = block || ->(*) { :undefined }
+      end
+
+      def evaluate(*args)
+        @calculator.evaluate(*args) { |expr, ex|
+          @block.call(ex)
+        }
+      end
+    end
+
     def initialize(expressions, calculator)
       @expression_hash = FlatHash.from_hash(expressions)
       @calculator = calculator
     end
 
     def solve!
+      @evaluator = StrictEvaluator.new(calculator)
       solve(&raise_exception_handler)
     end
 
     def solve(&block)
+      @evaluator ||= PermissiveEvaluator.new(calculator, block)
       error_handler = block || return_undefined_handler
       results = load_results(&error_handler)
 
@@ -42,7 +67,7 @@ module Dentaku
       @dep_cache ||= {}
     end
 
-    attr_reader :expression_hash, :calculator
+    attr_reader :expression_hash, :calculator, :evaluator
 
     def return_undefined_handler
       ->(*) { :undefined }
@@ -52,8 +77,11 @@ module Dentaku
       ->(ex) { raise ex }
     end
 
-    def expression_with_exception_handler(&block)
-      ->(_expr, ex) { block.call(ex) }
+    def expression_with_exception_handler(var_name, &block)
+      ->(_expr, ex) {
+        ex.recipient_variable = var_name
+        block.call(ex)
+      }
     end
 
     def load_results(&block)
@@ -73,11 +101,14 @@ module Dentaku
         next if expressions[var_name].nil?
 
         with_rescues(var_name, results, block) do
-          results[var_name] = evaluated_facts[var_name] || calculator.evaluate!(
+          results[var_name] = evaluated_facts[var_name] || evaluator.evaluate(
             expressions[var_name],
             context.merge(results),
-            &expression_with_exception_handler(&block)
-          )
+            &expression_with_exception_handler(var_name, &block)
+          ).tap { |res|
+            res.recipient_variable = var_name if res.respond_to?(:recipient_variable=)
+            res
+          }
         end
       end
 
@@ -88,7 +119,6 @@ module Dentaku
 
     def with_rescues(var_name, results, block)
       yield
-
     rescue Dentaku::UnboundVariableError, Dentaku::ZeroDivisionError, Dentaku::ArgumentError => ex
       ex.recipient_variable = var_name
       results[var_name] = block.call(ex)

data/lib/dentaku/calculator.rb

@@ -52,27 +52,39 @@ module Dentaku
     end
 
     def evaluate(expression, data = {}, &block)
-      evaluate!(expression, data)
+      context = evaluation_context(data, :permissive)
+      return evaluate_array(expression, context, &block) if expression.is_a?(Array)
+
+      evaluate!(expression, context)
     rescue Dentaku::Error, Dentaku::ArgumentError, Dentaku::ZeroDivisionError => ex
       block.call(expression, ex) if block_given?
     end
 
+    private def evaluate_array(expression, data = {}, &block)
+      expression.map { |e| evaluate(e, data, &block) }
+    end
+
     def evaluate!(expression, data = {}, &block)
-      return expression.map { |e|
-        evaluate(e, data, &block)
-      } if expression.is_a? Array
+      context = evaluation_context(data, :strict)
+      return evaluate_array!(expression, context, &block) if expression.is_a? Array
 
-      store(data) do
+      store(context) do
         node = ast(expression)
         unbound = node.dependencies(memory)
+
         unless unbound.empty?
           raise UnboundVariableError.new(unbound),
                 "no value provided for variables: #{unbound.uniq.join(', ')}"
         end
+
         node.value(memory)
       end
     end
 
+    private def evaluate_array!(expression, data = {}, &block)
+      expression.map { |e| evaluate!(e, data, &block) }
+    end
+
     def solve!(expression_hash)
       BulkExpressionSolver.new(expression_hash, self).solve!
     end
@@ -130,6 +142,10 @@ module Dentaku
       end
     end
 
+    def evaluation_context(data, evaluation_mode)
+      data.key?(:__evaluation_mode) ? data : data.merge(__evaluation_mode: evaluation_mode)
+    end
+
     def store(key_or_hash, value = nil)
       restore = Hash[memory]
 

data/lib/dentaku/date_arithmetic.rb

@@ -13,13 +13,11 @@ module Dentaku
       when Numeric
         @base + duration
       when Dentaku::AST::Duration::Value
-        case duration.unit
-        when :year
-          Time.local(@base.year + duration.value, @base.month, @base.day).to_datetime
-        when :month
-          @base >> duration.value
-        when :day
-          @base + duration.value
+        case @base
+        when Time
+          change_datetime(@base.to_datetime, duration.unit, duration.value).to_time
+        else
+          change_datetime(@base, duration.unit, duration.value)
         end
       else
         raise Dentaku::ArgumentError.for(:incompatible_type, value: duration, for: Numeric),
@@ -29,16 +27,14 @@ module Dentaku
 
     def sub(duration)
       case duration
-      when Date, DateTime, Numeric
+      when Date, DateTime, Numeric, Time
         @base - duration
       when Dentaku::AST::Duration::Value
-        case duration.unit
-        when :year
-          Time.local(@base.year - duration.value, @base.month, @base.day).to_datetime
-        when :month
-          @base << duration.value
-        when :day
-          @base - duration.value
+        case @base
+        when Time
+          change_datetime(@base.to_datetime, duration.unit, -duration.value).to_time
+        else
+          change_datetime(@base, duration.unit, -duration.value)
         end
       when Dentaku::TokenScanner::DATE_TIME_REGEXP
         @base - Time.parse(duration).to_datetime
@@ -47,5 +43,18 @@ module Dentaku
           "'#{duration || duration.class}' is not coercible for date arithmetic"
       end
     end
+
+    private
+
+    def change_datetime(base, unit, value)
+      case unit
+      when :year
+        base >> (value * 12)
+      when :month
+        base >> value
+      when :day
+        base + value
+      end
+    end
   end
 end