dentaku 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99f7f7efeefb4c1096618e028100c52bb15ca134
-  data.tar.gz: 1afd93ef547f630fb0ea121a6e8c813ea8abeeac
+  metadata.gz: 32158c76337de5c5f07140c71cb70fa6ea1d2963
+  data.tar.gz: 42bc70de0b8208fda14f82850c5362d34410bd16
 SHA512:
-  metadata.gz: 31227f42fb7f0a262e82b2ccdc334adc4458ba7339c87f0fbf81eb49ffb51bac72654e05de9495d8dad73c9669b8d82bf9bdf8c4f7ee1a5b5830aba123dc6f17
-  data.tar.gz: 2f78631eb082dc6c2d52ccac04d057c11c05b212ab05ffaa197e4f5ebf80aafc23113691d1dc0653c6af5df2827d6a4b45af58d4bfac73aa0156e3e91fbdb063
+  metadata.gz: 7362ea2c8a48f4e218807c6a5d979c64460e19bd4cd26a356433b77200fec7871b8d13343c99404979179d2362ec8028f4205990a38c48cb70ed101c06a3b57f
+  data.tar.gz: b399f646e1cf8671041d11a07db4f65d7b21f3c4bd31cd91ad643aa8ad6266272b75713de501c5307395bcf67867209554e085a8e0a5aafd088a9dca8364cc3f

data/.rubocop.yml

@@ -0,0 +1,119 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  # 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
+
+# Prefer &&/|| over and/or.
+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
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: false
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{a: 1}` not `{ a:1 }`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.travis.yml

@@ -1,12 +1,11 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.2.0
-  - 2.2.1
-  - 2.2.2
-  - 2.2.3
-  - 2.3.0
-  - 2.4.0
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+before_install:
+  - gem update bundler
+  - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v3.1.0] 2017-01-10
+- allow decimals with no leading zero
+- nested hash and array support in bulk expression solver
+- add a variadic SUM function
+- support array arguments to min, max, sum, and Math functions
+- add case-sensitive variable support
+- allow opt-out of nested data for performance boost
+
 ## [v3.0.0] 2017-10-11
 - add && and || as aliases for AND and OR
 - add hexadecimal literal support
@@ -143,6 +151,7 @@
 ## [v0.1.0] 2012-01-20
 - initial release
 
+[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
 [v2.0.10]:  https://github.com/rubysolo/dentaku/compare/v2.0.9...v2.0.10

data/Gemfile

@@ -2,8 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in dentaku.gemspec
 gemspec
-
-if RUBY_VERSION.to_f >= 2.0 && RUBY_ENGINE == 'ruby'
-  gem 'pry-byebug'
-  gem 'pry-stack_explorer'
-end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012 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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -6,7 +6,8 @@ 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 Status](https://coveralls.io/repos/github/rubysolo/dentaku/badge.svg)](https://coveralls.io/github/rubysolo/dentaku)
+[![Coverage](https://codecov.io/gh/rubysolo/dentaku/branch/master/graph/badge.svg)](https://codecov.io/gh/rubysolo/dentaku)
+
 
 DESCRIPTION
 -----------
@@ -35,6 +36,16 @@ calculator.evaluate('kiwi + 5', kiwi: 2)
 #=> 7
 ```
 
+To enter a case sensitive mode, just pass an option to the calculator instance:
+
+```ruby
+calculator.evaluate('Kiwi + 5', Kiwi: -2, kiwi: 2)
+#=> 7
+calculator = Dentaku::Calculator.new(case_sensitive: true)
+calculator.evaluate('Kiwi + 5', Kiwi: -2, kiwi: 2)
+#=> 3
+```
+
 You can also store the variable values in the calculator's memory and then
 evaluate expressions against those stored values:
 
@@ -69,11 +80,14 @@ calculator.evaluate!('10 * x')
 Dentaku::UnboundVariableError: Dentaku::UnboundVariableError
 ```
 
-Dentaku has built-in functions (including `if`, `not`, `min`, `max`, and
+Dentaku has built-in functions (including `if`, `not`, `min`, `max`, `sum`, and
 `round`) and the ability to define custom functions (see below). Functions
 generally work like their counterparts in Excel:
 
 ```ruby
+calculator.evaluate('SUM(1, 1, 2, 3, 5, 8)')
+#=> 20
+
 calculator.evaluate('if (pears < 10, 10, 20)', pears: 5)
 #=> 10
 calculator.evaluate('if (pears < 10, 10, 20)', pears: 15)
@@ -132,7 +146,7 @@ Comparison: `<`, `>`, `<=`, `>=`, `<>`, `!=`, `=`,
 
 Logic: `IF`, `AND`, `OR`, `NOT`, `SWITCH`
 
-Numeric: `MIN`, `MAX`, `ROUND`, `ROUNDDOWN`, `ROUNDUP`
+Numeric: `MIN`, `MAX`, `SUM`, `ROUND`, `ROUNDDOWN`, `ROUNDUP`
 
 Selections: `CASE` (syntax see [spec](https://github.com/rubysolo/dentaku/blob/master/spec/calculator_spec.rb#L292))
 
@@ -267,6 +281,33 @@ function)
 Functions can be added individually using Calculator#add_function, or en masse
 using Calculator#add_functions.
 
+FUNCTION ALIASES
+----------------
+
+Every function can be aliased by synonyms. For example, it can be useful if 
+your application is multilingual.
+
+```ruby
+Dentaku.aliases = {
+  round: ['rrrrround!', 'округлить']
+}
+
+Dentaku('rrrrround!(8.2) + округлить(8.4)') # the same as round(8.2) + round(8.4)
+# 16
+```
+
+Also, if you need thread-safe aliases you can pass them to `Dentaku::Calculator`
+initializer:
+
+```ruby
+aliases = {
+  round: ['rrrrround!', 'округлить']
+}
+c = Dentaku::Calculator.new(aliases: aliases)
+c.evaluate('rrrrround!(8.2) + округлить(8.4)')
+# 16
+```
+
 THANKS
 ------
 

data/Rakefile

@@ -1,5 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
 desc "Run specs"
 task :spec do
@@ -10,7 +13,7 @@ task :spec do
 end
 
 desc "Default: run specs."
-task default: :spec
+task(:default).clear.enhance [:spec, :rubocop]
 
 task :console do
   begin

data/dentaku.gemspec

@@ -9,20 +9,24 @@ Gem::Specification.new do |s|
   s.email       = ["rubysolo@gmail.com"]
   s.homepage    = "http://github.com/rubysolo/dentaku"
   s.licenses    = %w(MIT)
-  s.summary     = %q{A formula language parser and evaluator}
+  s.summary     = 'A formula language parser and evaluator'
   s.description = <<-DESC
     Dentaku is a parser and evaluator for mathematical formulas
   DESC
 
   s.rubyforge_project = "dentaku"
 
+  s.add_development_dependency('codecov')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug')
+  s.add_development_dependency('pry-stack_explorer')
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('pry')
-  s.add_development_dependency('coveralls')
+  s.add_development_dependency('rubocop')
+  s.add_development_dependency('simplecov')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/lib/dentaku.rb

@@ -5,11 +5,16 @@ require "dentaku/version"
 module Dentaku
   @enable_ast_caching = false
   @enable_dependency_order_caching = false
+  @aliases = {}
 
-  def self.evaluate(expression, data={})
+  def self.evaluate(expression, data = {})
     calculator.evaluate(expression, data)
   end
 
+  def self.evaluate!(expression, data = {})
+    calculator.evaluate!(expression, data)
+  end
+
   def self.enable_caching!
     enable_ast_cache!
     enable_dependency_order_cache!
@@ -31,6 +36,14 @@ module Dentaku
     @enable_dependency_order_caching
   end
 
+  def self.aliases
+    @aliases
+  end
+
+  def self.aliases=(hash)
+    @aliases = hash
+  end
+
   private
 
   def self.calculator
@@ -38,6 +51,6 @@ module Dentaku
   end
 end
 
-def Dentaku(expression, data={})
+def Dentaku(expression, data = {})
   Dentaku.evaluate(expression, data)
 end

data/lib/dentaku/ast.rb

@@ -25,4 +25,5 @@ require_relative './ast/functions/roundup'
 require_relative './ast/functions/rounddown'
 require_relative './ast/functions/ruby_math'
 require_relative './ast/functions/string_functions'
+require_relative './ast/functions/sum'
 require_relative './ast/functions/switch'

data/lib/dentaku/ast/access.rb

@@ -13,13 +13,13 @@ module Dentaku
         @index = index
       end
 
-      def value(context={})
+      def value(context = {})
         structure = @structure.value(context)
         index = @index.value(context)
         structure[index]
       end
 
-      def dependencies(context={})
+      def dependencies(context = {})
         @structure.dependencies(context) + @index.dependencies(context)
       end
     end

data/lib/dentaku/ast/arithmetic.rb

@@ -26,7 +26,7 @@ module Dentaku
         raise NotImplementedError
       end
 
-      def value(context={})
+      def value(context = {})
         l = cast(left.value(context))
         r = cast(right.value(context))
         l.public_send(operator, r)
@@ -34,13 +34,13 @@ module Dentaku
 
       private
 
-      def cast(val, prefer_integer=true)
+      def cast(val, prefer_integer = true)
         validate_value(val)
         numeric(val, prefer_integer)
       end
 
       def numeric(val, prefer_integer)
-        v = BigDecimal.new(val, Float::DIG+1)
+        v = BigDecimal.new(val, Float::DIG + 1)
         v = v.to_i if prefer_integer && v.frac.zero?
         v
       rescue ::TypeError
@@ -77,7 +77,7 @@ module Dentaku
       end
 
       def validate_format(string)
-        unless string =~ /\A-?\d+(\.\d+)?\z/
+        unless string =~ /\A-?\d*(\.\d+)?\z/
           raise Dentaku::ArgumentError.for(:invalid_value, value: string, for: BigDecimal),
                 "String input '#{string}' is not coercible to numeric"
         end
@@ -119,7 +119,7 @@ module Dentaku
         :/
       end
 
-      def value(context={})
+      def value(context = {})
         r = cast(right.value(context), false)
         raise Dentaku::ZeroDivisionError if r.zero?
 
@@ -141,7 +141,7 @@ module Dentaku
         @arity = 2 if input.length > 1
       end
 
-      def initialize(left, right=nil)
+      def initialize(left, right = nil)
         if right
           @left  = left
           @right = right
@@ -163,7 +163,7 @@ module Dentaku
         left.nil?
       end
 
-      def value(context={})
+      def value(context = {})
         if percent?
           cast(right.value(context)) * 0.01
         else