eqn 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44b0ee30b3b10912678e3772296e6fd4799029f9
-  data.tar.gz: 4f97acd53b3271bd62c5a3783612fbe28c02fc89
+  metadata.gz: 39b0293f4a288d1ef8c13ad3627ce4aa23b62ebd
+  data.tar.gz: d4e32c1a62b84f9821c4782e3bc7751134a7c56f
 SHA512:
-  metadata.gz: e61ff1468e7677bc817d4af8d814fa260d16587740ddb7d632f604a37d0dcc9ef34a2f68b9fa242f9a5919b1adb0056db40fa36f8dcfdb276ca888889432047e
-  data.tar.gz: 2b07aaae187d2b51326309fa4df838d3cddf64cf0078861dab020d904c428110a9183fd2f621cff4a4a1a44fcfed2154eef84be3b15b87a8cab45e1baaa831f0
+  metadata.gz: 91490640f171957c8b7fe85967d74f04f6620898d0bf4a7c67fa7d05f915952bf7b818735054a9c97d1369d72de8821cae8acc9e01a287954cb11dd2a778d00a
+  data.tar.gz: c2f498b84bda0b3cb31ca054c6012d94ba79f8ebcbe80e8025ce6ca966c185f38a6e2992bb5a274ba3a9c574b3101578aae4ee175b61138dedfac6e545ff5377

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/.rubocop.yml

@@ -3,6 +3,8 @@ AllCops:
     - db/**/*
     - vendor/**/*
 
+AbcSize:
+  Enabled: false
 BlockNesting: 
   Max: 4
 ClassLength:

data/README.md

@@ -45,6 +45,19 @@ If you want to peek at how Eqn is parsing an equation, run the following to get
 
 Eqn follows the standard mathematical order of operations: parentheses, exponentiation, multiplication/division, addition/subtraction. It ignores  whitespace, so `1 + 1` === `1+1`. (However, it does not ignore whitespace between two numbers, so `1 1` is invalid.)
 
+### Variables
+
+Eqn supports dynamically inserting values into an equation. Variables are passed to the calculator method via a hash; variable names may contain any lowercase or uppercase letters. Some examples:
+
+    $ Eqn::Calculator.calc('a + 1', a: 1)
+    # => 2
+
+    $ Eqn::Calculator.calc('5 * value', value: 2.5)
+    # => 12.5
+
+    $ Eqn::Calculator.calc('if(a > 10, b, c)', a: 15, b: 1, c: 0) # see below for function documentation
+    # => 1
+
 ### Functions
 
 Eqn presently supports four functions:

data/lib/eqn.treetop

@@ -64,7 +64,7 @@ grammar Eqn
   end
 
   rule signed_float
-    sign? space? (float / digits) <Eqn::Number::SignedNumber>
+    sign? space? (float / digits / variable) <Eqn::Number::SignedNumber>
   end
 
   rule float
@@ -115,6 +115,10 @@ grammar Eqn
     [0-9]+ <Eqn::Terminal::Digits>
   end
 
+  rule variable
+    [a-zA-Z]+ <Eqn::Terminal::Variable>
+  end
+
   rule space
     ("\s" / "\t")*
   end

data/lib/eqn/calculator.rb

@@ -1,16 +1,21 @@
 module Eqn
   class Calculator
     class << self
-      def calc(data)
-        result = Parser.parse(data).value
-        fail ZeroDivisionError if result.is_a?(Float) && (result.abs == Float::INFINITY || result.nan?)
-        result
+      def calc(data, vars = {})
+        @@vars = vars
+        begin
+          result = Parser.parse(data).value
+          fail ZeroDivisionError if result.is_a?(Float) && (result.abs == Float::INFINITY || result.nan?)
+          result
+        ensure
+          @@vars = nil
+        end
       end
 
-      def valid?(data)
-        calc(data)
+      def valid?(data, vars = {})
+        calc(data, vars)
         true
-      rescue ParseError, ZeroDivisionError
+      rescue NonNumericVariableError, NoVariableValueError, ParseError, ZeroDivisionError
         false
       end
     end

data/lib/eqn/errors.rb

@@ -0,0 +1,6 @@
+module Eqn
+  class NonNumericVariableError < StandardError; end
+  class NoVariableValueError < StandardError; end
+  class ParseError < StandardError; end
+  class ZeroDivisionError < StandardError; end
+end

data/lib/eqn/parser.rb

@@ -1,8 +1,8 @@
-require 'eqn/function'
 require 'eqn/comparation'
+require 'eqn/errors'
 require 'eqn/expression'
+require 'eqn/function'
 require 'eqn/number'
-require 'eqn/parse_error'
 require 'eqn/terminal'
 
 module Eqn

data/lib/eqn/terminal.rb

@@ -2,6 +2,18 @@ module Eqn
   module Terminal
     class Node < Treetop::Runtime::SyntaxNode; end
 
+    class Variable < Node
+      def value
+        unless Eqn::Calculator.class_variable_get(:@@vars).key? text_value.intern
+          fail NoVariableValueError, "No value given for: #{text_value}"
+        end
+        unless Eqn::Calculator.class_variable_get(:@@vars)[text_value.intern].is_a? Numeric
+          fail NonNumericVariableError, "Variable #{text_value} value is nonnumeric: #{Eqn::Calculator.class_variable_get(:@@vars)[text_value.intern]}"
+        end
+        Eqn::Calculator.class_variable_get(:@@vars)[text_value.intern]
+      end
+    end
+
     class Digits < Node
       def dec_value
         ".#{text_value}".to_f

data/lib/eqn/version.rb

@@ -1,3 +1,3 @@
 module Eqn
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eqn
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Zach Schneider
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -131,10 +131,10 @@ files:
 - lib/eqn/calculator.rb
 - lib/eqn/comparation.rb
 - lib/eqn/engine.rb
+- lib/eqn/errors.rb
 - lib/eqn/expression.rb
 - lib/eqn/function.rb
 - lib/eqn/number.rb
-- lib/eqn/parse_error.rb
 - lib/eqn/parser.rb
 - lib/eqn/terminal.rb
 - lib/eqn/version.rb

data/lib/eqn/parse_error.rb

@@ -1,4 +0,0 @@
-module Eqn
-  class ParseError < StandardError; end
-  class ZeroDivisionError < StandardError; end
-end