dentaku 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eb86933b899627333d93e993cd2d093a11f4ca54b2e0f6668c3580a8f133975
-  data.tar.gz: 004bd53fa5c3c6815bafdbf98788de96757b688a6ba217b7f8e96be31a4f7d5d
+  metadata.gz: 9a0b093e29b178197c0f92c1f63ec56342716c1fa84a4d12a73a7d355d42bc76
+  data.tar.gz: 480ccf9248568006227518363a0ef6350843007389f2e94ac5610ae62028e87e
 SHA512:
-  metadata.gz: 32f0e44638fc3738a3df5ba6a04abdb4ee66177049242260e26fea1ad6844a66a35e65ca5a27448f118838e6ccecd133f46650e9fbff5d878bbc14b1e7d952e8
-  data.tar.gz: 8081bcf51e30daa33dbaba3f8796951151c1bfd2e3975f63e5291aac7e04e09f2fc2f00aa956cfdad99caf1b8a8fb4f04b2c0789d8909b0982372e75dc7f7fc0
+  metadata.gz: 904292b2d2fd834701fd18900d689b9125579d58421fc58aaad03cd75c0fb556eeaeb5635dcd034a3f29e9f70f5c8fe0370e605acefd599c3dd75eae64436fdd
+  data.tar.gz: 3b6ed8763b9241e55e85f1a1e5a09d2652ec91eee21c080ca825029e04867b8fe65b128ddfc557cab3ef4fae76abb30b936f5971326355ea763081f90ba66638

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.5.7
-  - 2.6.5
-  - 2.7.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,5 +1,29 @@
 # Change Log
 
+## [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
@@ -12,6 +36,7 @@
 - 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
 
@@ -199,6 +224,9 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
+[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

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)
 
 
@@ -144,14 +143,16 @@ 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
 ----------------------
 
@@ -321,7 +322,7 @@ LICENSE
 
 (The MIT License)
 
-Copyright © 2012-2019 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,6 +14,8 @@ Gem::Specification.new do |s|
     Dentaku is a parser and evaluator for mathematical formulas
   DESC
 
+  s.add_dependency('concurrent-ruby')
+
   s.add_development_dependency('codecov')
   s.add_development_dependency('pry')
   s.add_development_dependency('pry-byebug')

data/lib/dentaku/ast/access.rb

@@ -3,6 +3,8 @@ require_relative "./node"
 module Dentaku
   module AST
     class Access < Node
+      attr_reader :structure, :index
+
       def self.arity
         2
       end
@@ -36,6 +38,10 @@ module Dentaku
       def type
         nil
       end
+
+      def accept(visitor)
+        visitor.visit_access(self)
+      end
     end
   end
 end

data/lib/dentaku/ast/arithmetic.rb

@@ -57,7 +57,7 @@ module Dentaku
       end
 
       def valid_node?(node)
-        node && (node.type == :numeric || node.dependencies.any?)
+        node && (node.type == :numeric || node.type == :integer || node.dependencies.any?)
       end
 
       def valid_left?
@@ -220,6 +220,10 @@ module Dentaku
         :**
       end
 
+      def display_operator
+        "^"
+      end
+
       def self.precedence
         30
       end

data/lib/dentaku/ast/array.rb

@@ -32,6 +32,10 @@ module Dentaku
       def type
         nil
       end
+      
+      def accept(visitor)
+        visitor.visit_array(self)
+      end
     end
   end
 end

data/lib/dentaku/ast/bitwise.rb

@@ -6,12 +6,20 @@ module Dentaku
       def value(context = {})
         left.value(context) | right.value(context)
       end
+
+      def operator
+        :|
+      end
     end
 
     class BitwiseAnd < Operation
       def value(context = {})
         left.value(context) & right.value(context)
       end
+
+      def operator
+        :&
+      end
     end
   end
 end

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

@@ -29,6 +29,10 @@ module Dentaku
       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,6 +1,8 @@
 module Dentaku
   module AST
     class CaseElse < Node
+      attr_reader :node
+
       def initialize(node)
         @node = node
       end
@@ -24,6 +26,10 @@ module Dentaku
       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
@@ -24,6 +26,10 @@ module Dentaku
       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,6 +1,8 @@
 module Dentaku
   module AST
     class CaseThen < Node
+      attr_reader :node
+
       def initialize(node)
         @node = node
       end
@@ -24,6 +26,10 @@ module Dentaku
       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,6 +1,8 @@
 module Dentaku
   module AST
     class CaseWhen < Operation
+      attr_reader :node
+
       def initialize(node)
         @node = node
       end
@@ -24,6 +26,14 @@ module Dentaku
       def self.max_param_count
         1
       end
+
+      def accept(visitor)
+        visitor.visit_when(self)
+      end
+
+      def to_s
+        'WHEN'
+      end
     end
   end
 end

data/lib/dentaku/ast/case.rb

@@ -8,6 +8,8 @@ require 'dentaku/exceptions'
 module Dentaku
   module AST
     class Case < Node
+      attr_reader :switch, :conditions, :else
+
       def self.min_param_count
         2
       end
@@ -57,6 +59,10 @@ module Dentaku
         else_dependencies(context)
       end
 
+      def accept(visitor)
+        visitor.visit_case(self)
+      end
+
       private
 
       def switch_dependencies(context = {})

data/lib/dentaku/ast/comparators.rb

@@ -15,74 +15,64 @@ module Dentaku
         raise NotImplementedError
       end
 
+      def value(context = {})
+        l = validate_value(left.value(context))
+        r = validate_value(right.value(context))
+
+        l.public_send(operator, r)
+      rescue ::ArgumentError => e
+        raise Dentaku::ArgumentError.for(:incompatible_type, value: r, for: l.class), e.message
+      end
+
       private
 
-      def value
-        yield
-      rescue ::ArgumentError => argument_error
-        raise Dentaku::ArgumentError, argument_error.message
-      rescue NoMethodError => no_method_error
-        raise Dentaku::Error, no_method_error.message
+      def validate_value(value)
+        unless value.respond_to?(operator)
+          raise Dentaku::ArgumentError.for(:invalid_operator, operation: self.class, operator: operator),
+                "#{ self.class } requires operands that respond to #{operator}"
+        end
+
+        value
       end
     end
 
     class LessThan < Comparator
-      def value(context = {})
-        super() { left.value(context) < right.value(context) }
-      end
-
       def operator
-        return :<
+        :<
       end
     end
 
     class LessThanOrEqual < Comparator
-      def value(context = {})
-        super() { left.value(context) <= right.value(context) }
-      end
-
       def operator
-        return :<=
+        :<=
       end
     end
 
     class GreaterThan < Comparator
-      def value(context = {})
-        super() { left.value(context) > right.value(context) }
-      end
-
       def operator
-        return :>
+        :>
       end
     end
 
     class GreaterThanOrEqual < Comparator
-      def value(context = {})
-        super() { left.value(context) >= right.value(context) }
-      end
-
       def operator
-        return :>=
+        :>=
       end
     end
 
     class NotEqual < Comparator
-      def value(context = {})
-        super() { left.value(context) != right.value(context) }
-      end
-
       def operator
-        return :!=
+        :!=
       end
     end
 
     class Equal < Comparator
-      def value(context = {})
-        super() { left.value(context) == right.value(context) }
+      def operator
+        :==
       end
 
-      def operator
-        return :==
+      def display_operator
+        "="
       end
     end
   end

data/lib/dentaku/ast/function.rb

@@ -4,6 +4,8 @@ require_relative 'function_registry'
 module Dentaku
   module AST
     class Function < Node
+      attr_reader :args
+
       # @return [Integer] with the number of significant decimal digits to use.
       DIG = Float::DIG + 1
 
@@ -11,19 +13,15 @@ module Dentaku
         @args = args
       end
 
+      def accept(visitor)
+        visitor.visit_function(self)
+      end
+
       def 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)
         registry.get(name)
       end

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

@@ -1,30 +1,17 @@
-require_relative '../function'
-require_relative '../../exceptions'
+require_relative './enum'
 
 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
-
+    class All < Enum
       def value(context = {})
-        collection      = @args[0].value(context)
+        collection      = Array(@args[0].value(context))
         item_identifier = @args[1].identifier
         expression      = @args[2]
 
-        Array(collection).all? do |item_value|
+        collection.all? do |item_value|
           expression.value(
-            context.update(
-              FlatHash.from_hash(item_identifier => item_value)
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
             )
           )
         end

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

@@ -1,30 +1,17 @@
-require_relative '../function'
-require_relative '../../exceptions'
+require_relative './enum'
 
 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
-
+    class Any < Enum
       def value(context = {})
-        collection      = @args[0].value(context)
+        collection      = Array(@args[0].value(context))
         item_identifier = @args[1].identifier
         expression      = @args[2]
 
-        Array(collection).any? do |item_value|
+        collection.any? do |item_value|
           expression.value(
-            context.update(
-              FlatHash.from_hash(item_identifier => item_value)
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
             )
           )
         end

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

@@ -4,11 +4,11 @@ module Dentaku
   module AST
     class Duration < Function
       def self.min_param_count
-        1
+        2
       end
 
       def self.max_param_count
-        1
+        2
       end
 
       class Value

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

@@ -0,0 +1,37 @@
+require_relative '../function'
+require_relative '../../exceptions'
+
+module Dentaku
+  module AST
+    class Enum < Function
+      def self.min_param_count
+        3
+      end
+
+      def self.max_param_count
+        3
+      end
+
+      def dependencies(context = {})
+        validate_identifier(@args[1])
+
+        collection      = @args[0]
+        item_identifier = @args[1].identifier
+        expression      = @args[2]
+
+        collection_deps = collection.dependencies(context)
+        expression_deps = (expression&.dependencies(context) || []).reject do |i|
+          i == item_identifier || i.start_with?("#{item_identifier}.")
+        end
+
+        collection_deps + expression_deps
+      end
+
+      def validate_identifier(arg, message = "#{name}() requires second argument to be an identifier")
+        unless arg.is_a?(Identifier)
+          raise ArgumentError.for(:incompatible_type, value: arg, for: Identifier), message
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative './enum'
+
+module Dentaku
+  module AST
+    class Filter < Enum
+      def value(context = {})
+        collection      = Array(@args[0].value(context))
+        item_identifier = @args[1].identifier
+        expression      = @args[2]
+
+        collection.select 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(:filter, Dentaku::AST::Filter)

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

@@ -19,6 +19,10 @@ module Dentaku
         @right     = right
       end
 
+      def args
+        [predicate, left, right]
+      end
+
       def value(context = {})
         predicate.value(context) ? left.value(context) : right.value(context)
       end

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

@@ -1,30 +1,17 @@
-require_relative '../function'
-require_relative '../../exceptions'
+require_relative './enum'
 
 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
-
+    class Map < Enum
       def value(context = {})
-        collection      = @args[0].value(context)
+        collection      = Array(@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)
+            context.merge(
+              FlatHash.from_hash_with_intermediates(item_identifier => item_value)
             )
           )
         end

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

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