dentaku 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32158c76337de5c5f07140c71cb70fa6ea1d2963
-  data.tar.gz: 42bc70de0b8208fda14f82850c5362d34410bd16
+  metadata.gz: 402c5a79a4d28d7323c53de8852007fa1c49c087
+  data.tar.gz: e5bd251b569708d740a7aeedde619e3bbfa34037
 SHA512:
-  metadata.gz: 7362ea2c8a48f4e218807c6a5d979c64460e19bd4cd26a356433b77200fec7871b8d13343c99404979179d2362ec8028f4205990a38c48cb70ed101c06a3b57f
-  data.tar.gz: b399f646e1cf8671041d11a07db4f65d7b21f3c4bd31cd91ad643aa8ad6266272b75713de501c5307395bcf67867209554e085a8e0a5aafd088a9dca8364cc3f
+  metadata.gz: a7dda0285c345400228dd7ec606958a95b9f57bd54f87a4333b4533d8f671b9ac66485ec8d29f66360b0dc026b00bb57ca842f4cf07e763c5840a2d84fa5a89e
+  data.tar.gz: d58d8f1451b0092feb6a8038f0d1efe8b6957c5de0a67badf53538395963098912853ea848c5fab03581ffeeddf89e4bb8812a735ec8ba6be48a76db35760e97

data/.travis.yml

@@ -3,9 +3,10 @@ sudo: false
 rvm:
   - 2.0.0-p648
   - 2.1.10
-  - 2.2.8
-  - 2.3.5
-  - 2.4.2
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 before_install:
   - gem update bundler
   - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v3.2.0] Unreleased
+- add `COUNT` and `AVG` functions
+- add unicode support 😎
+- fix CASE parsing bug
+- allow dependency filtering based on context
+- add variadic MUL function
+- performance optimization
+
 ## [v3.1.0] 2017-01-10
 - allow decimals with no leading zero
 - nested hash and array support in bulk expression solver
@@ -151,6 +159,7 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
+[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
 [v2.0.11]:  https://github.com/rubysolo/dentaku/compare/v2.0.10...v2.0.11

data/README.md

@@ -146,7 +146,7 @@ Comparison: `<`, `>`, `<=`, `>=`, `<>`, `!=`, `=`,
 
 Logic: `IF`, `AND`, `OR`, `NOT`, `SWITCH`
 
-Numeric: `MIN`, `MAX`, `SUM`, `ROUND`, `ROUNDDOWN`, `ROUNDUP`
+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))
 
@@ -321,7 +321,7 @@ LICENSE
 
 (The MIT License)
 
-Copyright © 2012-2017 Solomon White
+Copyright © 2012-2018 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/lib/dentaku/ast.rb

@@ -15,14 +15,16 @@ require_relative './ast/grouping'
 require_relative './ast/case'
 require_relative './ast/function_registry'
 require_relative './ast/functions/and'
+require_relative './ast/functions/avg'
+require_relative './ast/functions/count'
 require_relative './ast/functions/if'
 require_relative './ast/functions/max'
 require_relative './ast/functions/min'
 require_relative './ast/functions/not'
 require_relative './ast/functions/or'
 require_relative './ast/functions/round'
-require_relative './ast/functions/roundup'
 require_relative './ast/functions/rounddown'
+require_relative './ast/functions/roundup'
 require_relative './ast/functions/ruby_math'
 require_relative './ast/functions/string_functions'
 require_relative './ast/functions/sum'

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

@@ -0,0 +1,13 @@
+require_relative '../function'
+
+Dentaku::AST::Function.register(:avg, :numeric, ->(*args) {
+  if 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/count.rb

@@ -0,0 +1,18 @@
+require_relative '../function'
+
+module Dentaku
+  module AST
+    class Count < Function
+      def value(context = {})
+        if @args.length == 1
+          first_arg = @args[0].value(context)
+          return first_arg.length if first_arg.respond_to?(:length)
+        end
+
+        @args.length
+      end
+    end
+  end
+end
+
+Dentaku::AST::Function.register_class(:count, Dentaku::AST::Count)

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

@@ -0,0 +1,12 @@
+require_relative '../function'
+
+Dentaku::AST::Function.register(:mul, :numeric, ->(*args) {
+  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
+
+  args.flatten.map { |arg| Dentaku::AST::Function.numeric(arg) }.reduce(1, :*)
+})

data/lib/dentaku/calculator.rb

@@ -75,11 +75,11 @@ module Dentaku
       BulkExpressionSolver.new(expression_hash, self).solve(&block)
     end
 
-    def dependencies(expression)
+    def dependencies(expression, context = {})
       if expression.is_a? Array
-        return expression.flat_map { |e| dependencies(e) }
+        return expression.flat_map { |e| dependencies(e, context) }
       end
-      ast(expression).dependencies(memory)
+      store(context) { ast(expression).dependencies(memory) }
     end
 
     def ast(expression)

data/lib/dentaku/parser.rb

@@ -2,6 +2,28 @@ require_relative './ast'
 
 module Dentaku
   class Parser
+    AST_OPERATIONS = {
+      add:      AST::Addition,
+      subtract: AST::Subtraction,
+      multiply: AST::Multiplication,
+      divide:   AST::Division,
+      pow:      AST::Exponentiation,
+      negate:   AST::Negation,
+      mod:      AST::Modulo,
+      bitor:    AST::BitwiseOr,
+      bitand:   AST::BitwiseAnd,
+
+      lt:       AST::LessThan,
+      gt:       AST::GreaterThan,
+      le:       AST::LessThanOrEqual,
+      ge:       AST::GreaterThanOrEqual,
+      ne:       AST::NotEqual,
+      eq:       AST::Equal,
+
+      and:      AST::And,
+      or:       AST::Or,
+    }.freeze
+
     attr_reader :input, :output, :operations, :arities, :case_sensitive
 
     def initialize(tokens, options = {})
@@ -78,6 +100,9 @@ module Dentaku
           operations.push func
 
         when :case
+          case_index = operations.index { |o| o == AST::Case } || -1
+          token_index = case_index + 1
+
           case token.value
           when :open
             # special handling for case nesting: strip out inner case
@@ -113,7 +138,7 @@ module Dentaku
               arities.push(0)
             end
           when :close
-            if operations[1] == AST::CaseThen
+            if operations[token_index] == AST::CaseThen
               while operations.last != AST::Case
                 consume
               end
@@ -121,7 +146,7 @@ module Dentaku
               operations.push(AST::CaseConditional)
               consume(2)
               arities[-1] += 1
-            elsif operations[1] == AST::CaseElse
+            elsif operations[token_index] == AST::CaseElse
               while operations.last != AST::Case
                 consume
               end
@@ -129,12 +154,12 @@ module Dentaku
               arities[-1] += 1
             end
 
-            unless operations.count == 1 && operations.last == AST::Case
+            unless operations.count >= 1 && operations.last == AST::Case
               fail! :unprocessed_token, token_name: token.value
             end
             consume(arities.pop.succ)
           when :when
-            if operations[1] == AST::CaseThen
+            if operations[token_index] == AST::CaseThen
               while ![AST::CaseWhen, AST::Case].include?(operations.last)
                 consume
               end
@@ -148,14 +173,14 @@ module Dentaku
 
             operations.push(AST::CaseWhen)
           when :then
-            if operations[1] == AST::CaseWhen
+            if operations[token_index] == AST::CaseWhen
               while ![AST::CaseThen, AST::Case].include?(operations.last)
                 consume
               end
             end
             operations.push(AST::CaseThen)
           when :else
-            if operations[1] == AST::CaseThen
+            if operations[token_index] == AST::CaseThen
               while operations.last != AST::Case
                 consume
               end
@@ -237,27 +262,7 @@ module Dentaku
     end
 
     def operation(token)
-      {
-        add:      AST::Addition,
-        subtract: AST::Subtraction,
-        multiply: AST::Multiplication,
-        divide:   AST::Division,
-        pow:      AST::Exponentiation,
-        negate:   AST::Negation,
-        mod:      AST::Modulo,
-        bitor:    AST::BitwiseOr,
-        bitand:   AST::BitwiseAnd,
-
-        lt:       AST::LessThan,
-        gt:       AST::GreaterThan,
-        le:       AST::LessThanOrEqual,
-        ge:       AST::GreaterThanOrEqual,
-        ne:       AST::NotEqual,
-        eq:       AST::Equal,
-
-        and:      AST::And,
-        or:       AST::Or,
-      }.fetch(token.value)
+      AST_OPERATIONS.fetch(token.value)
     end
 
     def function(token)

data/lib/dentaku/token_scanner.rb

@@ -168,7 +168,7 @@ module Dentaku
       end
 
       def identifier
-        new(:identifier, '[\w\.]+\b', lambda { |raw| standardize_case(raw.strip) })
+        new(:identifier, '[[[:word:]]\.]+\b', lambda { |raw| standardize_case(raw.strip) })
       end
     end
 

data/lib/dentaku/version.rb

@@ -1,3 +1,3 @@
 module Dentaku
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/spec/ast/avg_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'dentaku/ast/functions/avg'
+require 'dentaku'
+
+describe 'Dentaku::AST::Function::Avg' do
+  it 'returns the average of an array of Numeric values' do
+    result = Dentaku('AVG(1, x, 1.8)', x: 2.3)
+    expect(result).to eq 1.7
+  end
+
+  it 'returns the average of a single entry array of a Numeric value' do
+    result = Dentaku('AVG(x)', x: 2.3)
+    expect(result).to eq 2.3
+  end
+
+  it 'returns the average even if a String is passed' do
+    result = Dentaku('AVG(1, x, 1.8)', x: '2.3')
+    expect(result).to eq 1.7
+  end
+
+  it 'returns the average even if an array is passed' do
+    result = Dentaku('AVG(1, x, 2.3)', x: [4, 5])
+    expect(result).to eq 3.075
+  end
+
+  context 'checking errors' do
+    let(:calculator) { Dentaku::Calculator.new }
+
+    it 'raises an error if no arguments are passed' do
+      expect { calculator.evaluate!('AVG()') }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/ast/count_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'dentaku/ast/functions/count'
+require 'dentaku'
+
+describe 'Dentaku::AST::Count' do
+  it 'returns the length of an array' do
+    result = Dentaku('COUNT(1, x, 1.8)', x: 2.3)
+    expect(result).to eq 3
+  end
+
+  it 'returns the length of a single number object' do
+    result = Dentaku('COUNT(x)', x: 2.3)
+    expect(result).to eq 1
+  end
+
+  it 'returns the length if a single String is passed' do
+    result = Dentaku('COUNT(x)', x: 'dentaku')
+    expect(result).to eq 7
+  end
+
+  it 'returns the length if an array is passed' do
+    result = Dentaku('COUNT(x)', x: [4, 5])
+    expect(result).to eq 2
+  end
+
+  it 'returns the length if an array with one element is passed' do
+    result = Dentaku('COUNT(x)', x: [4])
+    expect(result).to eq 1
+  end
+
+  it 'returns the length if an array even if it has nested array' do
+    result = Dentaku('COUNT(1, x, 3)', x: [4, 5])
+    expect(result).to eq 3
+  end
+
+  it 'returns the length if an array is passed' do
+    result = Dentaku('COUNT()')
+    expect(result).to eq 0
+  end
+end

data/spec/ast/mul_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'dentaku/ast/functions/mul'
+require 'dentaku'
+
+describe 'Dentaku::AST::Function::Mul' do
+  it 'returns the product of an array of Numeric values' do
+    result = Dentaku('MUL(1, x, 1.8)', x: 2.3)
+    expect(result).to eq 4.14
+  end
+
+  it 'returns the product of a single entry array of a Numeric value' do
+    result = Dentaku('MUL(x)', x: 2.3)
+    expect(result).to eq 2.3
+  end
+
+  it 'coerces string inputs to numeric' do
+    result = Dentaku('mul(1, x, 1.8)', x: '2.3')
+    expect(result).to eq 4.14
+  end
+
+  it 'returns the product even if an array is passed' do
+    result = Dentaku('mul(1, x, 2.3)', x: [4, 5])
+    expect(result).to eq 46
+  end
+
+  it 'handles nested calls' do
+    result = Dentaku('mul(1, x, mul(4, 5))', x: '2.3')
+    expect(result).to eq 46
+  end
+
+  context 'checking errors' do
+    let(:calculator) { Dentaku::Calculator.new }
+
+    it 'raises an error if no arguments are passed' do
+      expect { calculator.evaluate!('MUL()') }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/calculator_spec.rb

@@ -41,6 +41,10 @@ describe Dentaku::Calculator do
     expect(calculator.evaluate("2 & 3 * 9")).to eq (2)
   end
 
+  it 'supports unicode characters in identifiers' do
+    expect(calculator.evaluate("ρ * 2", ρ: 2)).to eq (4)
+  end
+
   describe 'memory' do
     it { expect(calculator).to be_empty }
     it { expect(with_memory).not_to be_empty   }
@@ -90,6 +94,10 @@ describe Dentaku::Calculator do
       expect(calculator.dependencies("bob + dole / 3")).to eq(['bob', 'dole'])
     end
 
+    it "ignores dependencies passed in context" do
+      expect(calculator.dependencies("a + b", a: 1)).to eq(['b'])
+    end
+
     it "finds dependencies in formula arguments" do
       allow(Dentaku).to receive(:cache_ast?) { true }
 
@@ -371,19 +379,33 @@ describe Dentaku::Calculator do
   end
 
   describe 'case statements' do
-    it 'handles complex then statements' do
-      formula = <<-FORMULA
+    let(:formula) {
+      <<-FORMULA
       CASE fruit
       WHEN 'apple'
-        THEN (1 * quantity)
+        THEN 1 * quantity
       WHEN 'banana'
-        THEN (2 * quantity)
+        THEN 2 * quantity
+      ELSE
+        3 * quantity
       END
       FORMULA
+    }
+
+    it 'handles complex then statements' do
       expect(calculator.evaluate(formula, quantity: 3, fruit: 'apple')).to eq(3)
       expect(calculator.evaluate(formula, quantity: 3, fruit: 'banana')).to eq(6)
     end
 
+    it 'evaluates case statement as part of a larger expression' do
+      expect(calculator.evaluate("2 + #{formula}", quantity: 3, fruit: 'apple')).to eq(5)
+      expect(calculator.evaluate("2 + #{formula}", quantity: 3, fruit: 'banana')).to eq(8)
+      expect(calculator.evaluate("2 + #{formula}", quantity: 3, fruit: 'kiwi')).to eq(11)
+      expect(calculator.evaluate("#{formula} + 2", quantity: 3, fruit: 'apple')).to eq(5)
+      expect(calculator.evaluate("#{formula} + 2", quantity: 3, fruit: 'banana')).to eq(8)
+      expect(calculator.evaluate("#{formula} + 2", quantity: 3, fruit: 'kiwi')).to eq(11)
+    end
+
     it 'handles complex when statements' do
       formula = <<-FORMULA
       CASE number
@@ -409,16 +431,6 @@ describe Dentaku::Calculator do
     end
 
     it 'handles a default else statement' do
-      formula = <<-FORMULA
-      CASE fruit
-      WHEN 'apple'
-        THEN 1 * quantity
-      WHEN 'banana'
-        THEN 2 * quantity
-      ELSE
-        3 * quantity
-      END
-      FORMULA
       expect(calculator.evaluate(formula, quantity: 1, fruit: 'banana')).to eq(2)
       expect(calculator.evaluate(formula, quantity: 1, fruit: 'orange')).to eq(3)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Solomon White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -156,9 +156,12 @@ files:
 - lib/dentaku/ast/function.rb
 - lib/dentaku/ast/function_registry.rb
 - lib/dentaku/ast/functions/and.rb
+- lib/dentaku/ast/functions/avg.rb
+- lib/dentaku/ast/functions/count.rb
 - lib/dentaku/ast/functions/if.rb
 - lib/dentaku/ast/functions/max.rb
 - lib/dentaku/ast/functions/min.rb
+- lib/dentaku/ast/functions/mul.rb
 - lib/dentaku/ast/functions/not.rb
 - lib/dentaku/ast/functions/or.rb
 - lib/dentaku/ast/functions/round.rb
@@ -195,12 +198,15 @@ files:
 - spec/ast/and_function_spec.rb
 - spec/ast/and_spec.rb
 - spec/ast/arithmetic_spec.rb
+- spec/ast/avg_spec.rb
 - spec/ast/case_spec.rb
 - spec/ast/comparator_spec.rb
+- spec/ast/count_spec.rb
 - spec/ast/division_spec.rb
 - spec/ast/function_spec.rb
 - spec/ast/max_spec.rb
 - spec/ast/min_spec.rb
+- spec/ast/mul_spec.rb
 - spec/ast/node_spec.rb
 - spec/ast/numeric_spec.rb
 - spec/ast/or_spec.rb
@@ -242,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: dentaku
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A formula language parser and evaluator
@@ -251,12 +257,15 @@ test_files:
 - spec/ast/and_function_spec.rb
 - spec/ast/and_spec.rb
 - spec/ast/arithmetic_spec.rb
+- spec/ast/avg_spec.rb
 - spec/ast/case_spec.rb
 - spec/ast/comparator_spec.rb
+- spec/ast/count_spec.rb
 - spec/ast/division_spec.rb
 - spec/ast/function_spec.rb
 - spec/ast/max_spec.rb
 - spec/ast/min_spec.rb
+- spec/ast/mul_spec.rb
 - spec/ast/node_spec.rb
 - spec/ast/numeric_spec.rb
 - spec/ast/or_spec.rb