dentaku 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c299535113d559ed61d819be474ced8128bf7e0f
-  data.tar.gz: 80aa950604c573fcbee95cfa6bb820a1fa6af94b
+  metadata.gz: e5dd3288b6e13441c5e71ac914a527a9c4d97daa
+  data.tar.gz: 88c305d4010f094f2f59615fd830ea583274d9ca
 SHA512:
-  metadata.gz: 616133f23a73885b22d1e53722d8482f9522e249ca03a76fe7a8685d1d365eebbde7b1677248ea6758cbf29e60f54504f9c4a4a9ee43735ab54cffc8cb9d11ac
-  data.tar.gz: aea6a8919d66c838c704ba09b19787ddeb301f72ead03883ffc481ffe4ff7a54afa92108ed73794feaec4d83ea93cc17476dc108d0273401dba9c6077a603ec0
+  metadata.gz: 588690a66352277de04db87a048047c54d47bf8bd5ce92f3b1d841345a5cf721c903631a283d8912346ccead66242c13ae2f86e3ad186a1ab9b943e05988d095
+  data.tar.gz: 38b5f255f8e5bac861729589a71b7d7b6deec651bfc0fde17bfb07e96c2c710c758f58835dd9071bf695bb6dda45c532e6a25fc895e908ea10066a7450ac8123

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
-before_install:
-  - gem update --system
-  - gem update bundler
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0
@@ -11,4 +9,5 @@ rvm:
   - 2.2.1
   - 2.2.2
   - 2.2.3
+  - 2.3.0
   - rbx-2

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Change Log
 
-## [Unreleased]
+## [v2.0.8] 2016-05-10
+- numeric input validations
+- fail with gem-specific error for invalid arithmetic operands
+- add `LEFT`, `RIGHT`, `MID`, `LEN`, `FIND`, `SUBSTITUTE`, and `CONCAT` string functions
 
 ## [v2.0.7] 2016-02-25
 - fail with gem-specific error for parsing issues
@@ -103,7 +106,7 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
-[Unreleased]:  https://github.com/rubysolo/dentaku/compare/v2.0.7...HEAD
+[v2.0.8]:  https://github.com/rubysolo/dentaku/compare/v2.0.7...v2.0.8
 [v2.0.7]:  https://github.com/rubysolo/dentaku/compare/v2.0.6...v2.0.7
 [v2.0.6]:  https://github.com/rubysolo/dentaku/compare/v2.0.5...v2.0.6
 [v2.0.5]:  https://github.com/rubysolo/dentaku/compare/v2.0.4...v2.0.5

data/README.md

@@ -57,7 +57,7 @@ calculator.evaluate('(5 + 3) * 2')
 #=> 16
 ```
 
-The `evalutate` method will return `nil` if there is an error in the formula.
+The `evaluate` method will return `nil` if there is an error in the formula.
 If this is not the desired behavior, use `evaluate!`, which will raise an
 exception.
 
@@ -123,13 +123,17 @@ application, AST caching will consume more memory with each new formula.
 BUILT-IN OPERATORS AND FUNCTIONS
 ---------------------------------
 
-Math: `+ - * / %`
+Math: `+`, `-`, `*`, `/`, `%`
 
-Logic: `< > <= >= <> != = AND OR`
+Logic: `<`, `>`, `<=`, `>=`, `<>`, `!=`, `=`, `AND`, `OR`
 
-Functions: `IF NOT MIN MAX ROUND ROUNDDOWN ROUNDUP`
+Functions: `IF`, `NOT`, `MIN`, `MAX`, `ROUND`, `ROUNDDOWN`, `ROUNDUP`
 
-Math: all functions from Ruby's Math module, including `SIN, COS, TAN, ...`
+Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/master/spec/calculator_spec.rb#L292))
+
+Math: all functions from Ruby's Math module, including `SIN`, `COS`, `TAN`, etc.
+
+String: `LEFT`, `RIGHT`, `MID`, `LEN`, `FIND`, `SUBSTITUTE`, `CONCAT`
 
 RESOLVING DEPENDENCIES
 ----------------------

data/lib/dentaku/ast.rb

@@ -18,3 +18,4 @@ require_relative './ast/functions/round'
 require_relative './ast/functions/roundup'
 require_relative './ast/functions/rounddown'
 require_relative './ast/functions/ruby_math'
+require_relative './ast/functions/string_functions'

data/lib/dentaku/ast/arithmetic.rb

@@ -25,6 +25,7 @@ module Dentaku
       private
 
       def cast(value, prefer_integer=true)
+        validate_numeric(value)
         v = BigDecimal.new(value, Float::DIG+1)
         v = v.to_i if prefer_integer && v.frac.zero?
         v
@@ -33,6 +34,12 @@ module Dentaku
       def valid_node?(node)
         node && (node.dependencies.any? || node.type == :numeric)
       end
+
+      def validate_numeric(value)
+        Float(value)
+      rescue ::ArgumentError, ::TypeError
+        fail Dentaku::ArgumentError, "#{ self.class } requires numeric operands"
+      end
     end
 
     class Addition < Arithmetic

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

@@ -0,0 +1,104 @@
+require_relative '../function'
+
+module Dentaku
+  module AST
+    module StringFunctions
+      class Left < Function
+        def initialize(string, length)
+          @string = string
+          @length = length
+        end
+
+        def value(context={})
+          @string.value(context)[0, @length.value(context)]
+        end
+      end
+
+      class Right < Function
+        def initialize(string, length)
+          @string = string
+          @length = length
+        end
+
+        def value(context={})
+          string = @string.value(context)
+          length = @length.value(context)
+          string[length * -1, length] || string
+        end
+      end
+
+      class Mid < Function
+        def initialize(string, offset, length)
+          @string = string
+          @offset = offset
+          @length = length
+        end
+
+        def value(context={})
+          string = @string.value(context)
+          offset = @offset.value(context)
+          length = @length.value(context)
+          string[offset - 1, length].to_s
+        end
+      end
+
+      class Len < Function
+        def initialize(string)
+          @string = string
+        end
+
+        def value(context={})
+          @string.value(context).length
+        end
+      end
+
+      class Find < Function
+        def initialize(needle, haystack)
+          @needle = needle
+          @haystack = haystack
+        end
+
+        def value(context={})
+          needle = @needle.value(context)
+          haystack = @haystack.value(context)
+          pos = haystack.index(needle)
+          pos && pos + 1
+        end
+      end
+
+      class Substitute < Function
+        def initialize(original, search, replacement)
+          @original = original
+          @search = search
+          @replacement = replacement
+        end
+
+        def value(context={})
+          original = @original.value(context)
+          search = @search.value(context)
+          replacement = @replacement.value(context)
+          original.sub(search, replacement)
+        end
+      end
+
+      class Concat < Function
+        def initialize(left, right)
+          @left  = left
+          @right = right
+        end
+
+        def value(context={})
+          @left.value(context) + @right.value(context)
+        end
+      end
+    end
+  end
+end
+
+Dentaku::AST::Function.register_class(:left,       Dentaku::AST::StringFunctions::Left)
+Dentaku::AST::Function.register_class(:right,      Dentaku::AST::StringFunctions::Right)
+Dentaku::AST::Function.register_class(:mid,        Dentaku::AST::StringFunctions::Mid)
+Dentaku::AST::Function.register_class(:len,        Dentaku::AST::StringFunctions::Len)
+Dentaku::AST::Function.register_class(:find,       Dentaku::AST::StringFunctions::Find)
+Dentaku::AST::Function.register_class(:substitute, Dentaku::AST::StringFunctions::Substitute)
+Dentaku::AST::Function.register_class(:concat,     Dentaku::AST::StringFunctions::Concat)

data/lib/dentaku/calculator.rb

@@ -27,7 +27,7 @@ module Dentaku
 
     def evaluate(expression, data={})
       evaluate!(expression, data)
-    rescue UnboundVariableError
+    rescue UnboundVariableError, ArgumentError
       yield expression if block_given?
     end
 

data/lib/dentaku/exceptions.rb

@@ -13,6 +13,9 @@ module Dentaku
   class ParseError < StandardError
   end
 
+  class ArgumentError < ::ArgumentError
+  end
+
   class ZeroDivisionError < ::ZeroDivisionError
     attr_accessor :recipient_variable
   end

data/lib/dentaku/version.rb

@@ -1,3 +1,3 @@
 module Dentaku
-  VERSION = "2.0.7"
+  VERSION = "2.0.8"
 end

data/spec/ast/string_functions_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'dentaku/ast/functions/string_functions'
+
+describe Dentaku::AST::StringFunctions::Left do
+  let(:string) { identifier('string') }
+  let(:length) { identifier('length') }
+
+  subject { described_class.new(string, length) }
+
+  it 'returns the left N characters of the string' do
+    expect(subject.value('string' => 'ABCDEFG', 'length' => 4)).to eq 'ABCD'
+  end
+
+  it 'works correctly with literals' do
+    left = literal('ABCD')
+    len  = literal(2)
+    fn   = described_class.new(left, len)
+    expect(fn.value).to eq 'AB'
+  end
+
+  it 'handles an empty string correctly' do
+    expect(subject.value('string' => '', 'length' => 4)).to eq ''
+  end
+
+  it 'handles size greater than input string length correctly' do
+    expect(subject.value('string' => 'abcdefg', 'length' => 40)).to eq 'abcdefg'
+  end
+end
+
+describe Dentaku::AST::StringFunctions::Right do
+  it 'returns the right N characters of the string' do
+    subject = described_class.new(literal('ABCDEFG'), literal(4))
+    expect(subject.value).to eq 'DEFG'
+  end
+
+  it 'handles an empty string correctly' do
+    subject = described_class.new(literal(''), literal(4))
+    expect(subject.value).to eq ''
+  end
+
+  it 'handles size greater than input string length correctly' do
+    subject = described_class.new(literal('abcdefg'), literal(40))
+    expect(subject.value).to eq 'abcdefg'
+  end
+end
+
+describe Dentaku::AST::StringFunctions::Mid do
+  it 'returns a substring from the middle of the string' do
+    subject = described_class.new(literal('ABCDEFG'), literal(4), literal(2))
+    expect(subject.value).to eq 'DE'
+  end
+
+  it 'handles an empty string correctly' do
+    subject = described_class.new(literal(''), literal(4), literal(2))
+    expect(subject.value).to eq ''
+  end
+
+  it 'handles offset greater than input string length correctly' do
+    subject = described_class.new(literal('abcdefg'), literal(40), literal(4))
+    expect(subject.value).to eq ''
+  end
+
+  it 'handles size greater than input string length correctly' do
+    subject = described_class.new(literal('abcdefg'), literal(4), literal(40))
+    expect(subject.value).to eq 'defg'
+  end
+end
+
+describe Dentaku::AST::StringFunctions::Len do
+  it 'returns the length of a string' do
+    subject = described_class.new(literal('ABCDEFG'))
+    expect(subject.value).to eq 7
+  end
+
+  it 'handles an empty string correctly' do
+    subject = described_class.new(literal(''))
+    expect(subject.value).to eq 0
+  end
+end
+
+describe Dentaku::AST::StringFunctions::Find do
+  it 'returns the position of a substring within a string' do
+    subject = described_class.new(literal('DE'), literal('ABCDEFG'))
+    expect(subject.value).to eq 4
+  end
+
+  it 'handles an empty substring correctly' do
+    subject = described_class.new(literal(''), literal('ABCDEFG'))
+    expect(subject.value).to eq 1
+  end
+
+  it 'handles an empty string correctly' do
+    subject = described_class.new(literal('DE'), literal(''))
+    expect(subject.value).to be_nil
+  end
+end
+
+describe Dentaku::AST::StringFunctions::Substitute do
+  it 'replaces a substring within a string' do
+    subject = described_class.new(literal('ABCDEFG'), literal('DE'), literal('xy'))
+    expect(subject.value).to eq 'ABCxyFG'
+  end
+
+  it 'handles an empty search string correctly' do
+    subject = described_class.new(literal('ABCDEFG'), literal(''), literal('xy'))
+    expect(subject.value).to eq 'xyABCDEFG'
+  end
+
+  it 'handles an empty replacement string correctly' do
+    subject = described_class.new(literal('ABCDEFG'), literal('DE'), literal(''))
+    expect(subject.value).to eq 'ABCFG'
+  end
+end
+
+describe Dentaku::AST::StringFunctions::Concat do
+  it 'concatenates two strings' do
+    subject = described_class.new(literal('ABC'), literal('DEF'))
+    expect(subject.value).to eq 'ABCDEF'
+  end
+
+  it 'concatenates a string onto an empty string' do
+    subject = described_class.new(literal(''), literal('ABC'))
+    expect(subject.value).to eq 'ABC'
+  end
+
+  it 'concatenates an empty string onto a string' do
+    subject = described_class.new(literal('ABC'), literal(''))
+    expect(subject.value).to eq 'ABC'
+  end
+
+  it 'concatenates two empty strings' do
+    subject = described_class.new(literal(''), literal(''))
+    expect(subject.value).to eq ''
+  end
+end

data/spec/calculator_spec.rb

@@ -31,6 +31,7 @@ describe Dentaku::Calculator do
     expect(calculator.evaluate('(((695759/735000)^(1/(1981-1991)))-1)*1000').round(4)).to eq(5.5018)
     expect(calculator.evaluate('0.253/0.253')).to eq(1)
     expect(calculator.evaluate('0.253/d', d: 0.253)).to eq(1)
+    expect(calculator.evaluate('10 + x', x: 'abc')).to be_nil
   end
 
   describe 'memory' do
@@ -280,6 +281,12 @@ describe Dentaku::Calculator do
         foo: nil
       )
     end
+
+    it 'raises errors when used in arithmetic operation' do
+      expect {
+        calculator.solve!(more_apples: "apples + 1", apples: nil)
+      }.to raise_error(Dentaku::ArgumentError)
+    end
   end
 
   describe 'case statements' do
@@ -371,4 +378,12 @@ describe Dentaku::Calculator do
       end
     end
   end
+
+  describe 'string functions' do
+    it 'concatenates two strings' do
+      expect(
+        calculator.evaluate('CONCAT(s1, s2)', 's1' => 'abc', 's2' => 'def')
+      ).to eq 'abcdef'
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -31,3 +31,11 @@ def type_for(value)
     :identifier
   end
 end
+
+def identifier(name)
+  Dentaku::AST::Identifier.new(Dentaku::Token.new(:identifier, name))
+end
+
+def literal(value)
+  Dentaku::AST::Literal.new(Dentaku::Token.new(type_for(value), value))
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dentaku
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Solomon White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,6 +87,7 @@ files:
 - lib/dentaku/ast/functions/rounddown.rb
 - lib/dentaku/ast/functions/roundup.rb
 - lib/dentaku/ast/functions/ruby_math.rb
+- lib/dentaku/ast/functions/string_functions.rb
 - lib/dentaku/ast/grouping.rb
 - lib/dentaku/ast/identifier.rb
 - lib/dentaku/ast/literal.rb
@@ -115,6 +116,7 @@ files:
 - spec/ast/function_spec.rb
 - spec/ast/node_spec.rb
 - spec/ast/numeric_spec.rb
+- spec/ast/string_functions_spec.rb
 - spec/benchmark.rb
 - spec/bulk_expression_solver_spec.rb
 - spec/calculator_spec.rb
@@ -159,6 +161,7 @@ test_files:
 - spec/ast/function_spec.rb
 - spec/ast/node_spec.rb
 - spec/ast/numeric_spec.rb
+- spec/ast/string_functions_spec.rb
 - spec/benchmark.rb
 - spec/bulk_expression_solver_spec.rb
 - spec/calculator_spec.rb
@@ -171,4 +174,3 @@ test_files:
 - spec/token_scanner_spec.rb
 - spec/token_spec.rb
 - spec/tokenizer_spec.rb
-has_rdoc: