eqn 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5169b7bc9b7ffba3e28eae977ec4ec934a56ae22
+  data.tar.gz: 320adbd2103e2303abafa6a04bc3ac3956904e92
+SHA512:
+  metadata.gz: 43290301b723b40ef8f834038b612c0c382a20bbc835210fa3be6d510afbf20039e78eaf9de2405c9a80ec9326ce15782b7530602b2b4d702f5a3e5043946a87
+  data.tar.gz: 6b9a586c947a93085d89d0f21d0a040d996a9b2611ef06a07e2751755452220aebab7a4915a4fcd3cf8e258e05af6a82ac083bf35cec00f62c7f3ceca28c9418

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - db/**/*
+
+BlockNesting: 
+  Max: 4
+ClassLength:
+  Enabled: False
+ClassVars:
+  Enabled: False
+CyclomaticComplexity:
+  Enabled: False
+Documentation:
+  Enabled: false
+LineLength:
+  Max: 175
+MethodLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eqn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Aha! Labs Inc
+
+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

@@ -0,0 +1,82 @@
+# Eqn
+
+Eqn uses the Treetop parser generator to safely evaluate mathematical expressions in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eqn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eqn
+
+## Usage
+
+To evaluate an equation string, run the following:
+
+    $ Eqn::Calculator.calc('1 + 1')
+    # => 2
+
+You can also check if an equation is valid:
+
+    $ Eqn::Calculator.valid?('1 + 1')
+    # => true
+    $ Eqn::Calculator.valid?('1 + + 1')
+    # => false
+
+If you want to peek at how Eqn is parsing an equation, run the following to get the syntax tree:
+
+    $ Eqn::Parser.parse('1 + 1')
+    # => <syntax tree is printed>
+
+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.)
+
+### Functions
+
+Eqn presently supports four functions:
+
+**if**
+
+Syntax: `if(comparison, value_if_true, value_if_false)`
+
+For example, `if(5 > 3, 1, 2)` would evaluate to `1`.
+
+**round**
+
+Syntax: `round(number)`
+
+Rounds the number up if the decimal is greater than 0.5 and down otherwise (i.e. "normal" rounding).
+
+**roundup**
+
+Syntax: `roundup(number)`
+
+Rounds the number up to the next whole integer (i.e. ceiling function)
+
+**rounddown**
+
+Syntax: `rounddown(number)`
+
+Rounds the number down to the next whole integer (i.e. floor function)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+The gem uses rspec for testing; run `rspec` from the application root to execute the tests.
+
+## Contributing
+
+1. Fork it ( https://github.com/schneidmaster/eqn/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'eqn'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/eqn.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eqn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eqn'
+  spec.version       = Eqn::VERSION
+  spec.authors       = ['Zach Schneider']
+  spec.email         = ['zach@aha.io']
+
+  spec.summary       = 'A gem to evaluate numerical equations.'
+  spec.description   = 'A gem to evaluate numerical equations. Includes support for functions.'
+  spec.homepage      = 'https://github.com/schneidmaster/eqn'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'treetop', '~> 1.4.14'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.31'
+  spec.add_development_dependency 'byebug'
+end

data/lib/eqn.rb

@@ -0,0 +1,5 @@
+require 'treetop'
+require 'eqn/version'
+require 'eqn/parser'
+require 'eqn/calculator'
+require 'eqn/engine' if defined? Rails

data/lib/eqn.treetop

@@ -0,0 +1,113 @@
+grammar Eqn
+  rule comparation
+    expression comp_group? <Eqn::Comparation>
+  end
+
+  rule comp_group
+    comp_op expression <Eqn::Comparation::CompGroup>
+  end
+
+  rule expression
+    multitive addsub_group? <Eqn::Expression>
+  end
+
+  rule addsub_group
+    addsub_op expression <Eqn::Expression::ExprGroup>
+  end
+
+  rule multitive
+    exponentiative muldiv_group? <Eqn::Expression>
+  end
+
+  rule muldiv_group
+    muldiv_op multitive <Eqn::Expression::ExprGroup>
+  end
+
+  rule exponentiative
+    operand pow_group? <Eqn::Expression>
+  end
+
+  rule pow_group
+    pow_op exponentiative <Eqn::Expression::ExprGroup>
+  end
+
+  rule operand
+    function / group / number
+  end
+
+  rule function
+    if_func / round_func / roundup_func / rounddown_func
+  end
+
+  rule if_func
+    'if' '(' comparation ',' expression ',' expression ')' <Eqn::Function::If>
+  end
+
+  rule round_func
+    'round' group <Eqn::Function::Round>
+  end
+
+  rule roundup_func
+    'roundup' group <Eqn::Function::RoundUp>
+  end
+
+  rule rounddown_func
+    'rounddown' group <Eqn::Function::RoundDown>
+  end
+
+  rule group
+    '(' expression ')' <Eqn::Expression>
+  end
+
+  rule number
+    signed_float exponent? <Eqn::Number>
+  end
+
+  rule signed_float
+    sign? digits decimal? <Eqn::Number::SignedNumber>
+  end
+
+  rule decimal
+    '.' digits <Eqn::Number::Decimal>
+  end
+
+  rule exponent
+    exp signed_float <Eqn::Number::Exponent>
+  end
+
+  rule pow_op
+    '^' <Eqn::Terminal::Op::Pow>
+  end
+
+  rule muldiv_op
+      '*' <Eqn::Terminal::Op::Mul>
+    / '/' <Eqn::Terminal::Op::Div>
+  end
+
+  rule addsub_op
+      '+' <Eqn::Terminal::Op::Add>
+    / '-' <Eqn::Terminal::Op::Sub>
+  end
+
+  rule comp_op
+      '<=' <Eqn::Terminal::CompOp::Lte>
+    / '>=' <Eqn::Terminal::CompOp::Gte>
+    / '<'  <Eqn::Terminal::CompOp::Lt>
+    / '>'  <Eqn::Terminal::CompOp::Gt>
+    / '==' <Eqn::Terminal::CompOp::Eq>
+    / '='  <Eqn::Terminal::CompOp::Eq>
+    / '!=' <Eqn::Terminal::CompOp::Neq>
+  end
+
+  rule exp
+    'e' / 'E'
+  end
+
+  rule sign
+    '+' / '-' <Eqn::Terminal::Sign>
+  end
+
+  rule digits
+    [0-9]+ <Eqn::Terminal::Digits>
+  end
+end

data/lib/eqn/calculator.rb

@@ -0,0 +1,16 @@
+module Eqn
+  class Calculator
+    class << self
+      def calc(data)
+        Parser.parse(data).value
+      end
+
+      def valid?(data)
+        calc(data)
+        true
+      rescue Exception
+        false
+      end
+    end
+  end
+end

data/lib/eqn/comparation.rb

@@ -0,0 +1,21 @@
+module Eqn
+  class Node < Treetop::Runtime::SyntaxNode; end
+
+  class Comparation < Node
+    def value
+      val_one = elements.shift.value
+      if elements.empty?
+        val_one
+      else
+        op, val_two = elements.shift.value
+        val_one.send(op, val_two)
+      end
+    end
+
+    class CompGroup < Node
+      def value
+        [elements.shift.value, elements.shift.value]
+      end
+    end
+  end
+end

data/lib/eqn/engine.rb

@@ -0,0 +1,7 @@
+module Eqn
+  class Engine < ::Rails::Engine
+    initializer 'eqn' do
+      config.autoload_paths += Dir["#{config.root}/lib/**/"]
+    end
+  end
+end

data/lib/eqn/expression.rb

@@ -0,0 +1,21 @@
+module Eqn
+  class Node < Treetop::Runtime::SyntaxNode; end
+
+  class Expression < Node
+    def value
+      if elements.count == 1
+        elements.shift.value
+      else
+        base = elements.shift.value
+        op, num = elements.shift.value
+        base.send(op, num)
+      end
+    end
+
+    class ExprGroup < Node
+      def value
+        [elements.shift.value, elements.shift.value]
+      end
+    end
+  end
+end

data/lib/eqn/function.rb

@@ -0,0 +1,37 @@
+module Eqn
+  class Node < Treetop::Runtime::SyntaxNode; end
+
+  module Function
+    class If < Node
+      def value
+        comp_val = elements.shift.value
+        ls = elements.shift.value
+        rs = elements.shift.value
+
+        if comp_val
+          ls
+        else
+          rs
+        end
+      end
+    end
+
+    class Round < Node
+      def value
+        elements.shift.value.round
+      end
+    end
+
+    class RoundUp < Node
+      def value
+        elements.shift.value.ceil
+      end
+    end
+
+    class RoundDown < Node
+      def value
+        elements.shift.value.floor
+      end
+    end
+  end
+end

data/lib/eqn/number.rb

@@ -0,0 +1,44 @@
+module Eqn
+  class Node < Treetop::Runtime::SyntaxNode; end
+
+  class Number < Node
+    def value
+      base = elements.shift.value
+      # Apply any exponent.
+      base *= elements.shift.value unless elements.empty?
+      base
+    end
+
+    class SignedNumber < Node
+      def value
+        # Store sign if any.
+        sign_negative = elements.shift.negative? if elements.first.is_a? Terminal::Sign
+
+        # Store base number.
+        base = elements.shift.value
+
+        # Handle decimal.
+        base += elements.shift.value unless elements.empty?
+
+        # Apply sign if any.
+        if sign_negative
+          -base
+        else
+          base
+        end
+      end
+    end
+
+    class Decimal < Node
+      def value
+        elements.shift.dec_value
+      end
+    end
+
+    class Exponent < Node
+      def value
+        10**elements.shift.value
+      end
+    end
+  end
+end

data/lib/eqn/parser.rb

@@ -0,0 +1,42 @@
+require 'eqn/function'
+require 'eqn/comparation'
+require 'eqn/expression'
+require 'eqn/number'
+require 'eqn/terminal'
+
+module Eqn
+  WHITESPACE_REGEX = /([^0-9]( )+[^0-9])|([^0-9]( )+[0-9])|([0-9]( )+[^0-9])/
+
+  class Parser
+    # Load the Treetop grammar from the grammar.
+    Treetop.load(File.join(File.dirname(__dir__), 'eqn.treetop'))
+    @@parser = EqnParser.new
+
+    def self.parse(data)
+      # Remove any whitespace and pass the data over to the parser instance.
+      data.downcase!
+      while data =~ Eqn::WHITESPACE_REGEX do
+        data = data.downcase.gsub(Eqn::WHITESPACE_REGEX) do
+          Regexp.last_match.to_s.delete(' ')
+        end
+      end
+      tree = @@parser.parse(data)
+
+      # Raise any errors.
+      if tree.nil?
+        fail Exception, "Parse error at offset: #{@@parser.index}" + @@parser.failure_reason
+      end
+
+      # Remove extraneous nodes and return the tree.
+      clean_tree(tree)
+    end
+
+    def self.clean_tree(root_node)
+      return if root_node.elements.nil?
+      root_node.elements.delete_if { |node| node.class.name == 'Treetop::Runtime::SyntaxNode' }
+      root_node.elements.each { |node| clean_tree(node) }
+      root_node
+    end
+    private_class_method :clean_tree
+  end
+end

data/lib/eqn/terminal.rb

@@ -0,0 +1,91 @@
+module Eqn
+  module Terminal
+    class Node < Treetop::Runtime::SyntaxNode; end
+
+    class Digits < Node
+      def dec_value
+        ".#{text_value}".to_f
+      end
+
+      def value
+        text_value.to_f
+      end
+    end
+
+    class Sign < Node
+      def negative?
+        text_value == '-'
+      end
+    end
+
+    class Op < Node
+      class Add < Node
+        def value
+          '+'
+        end
+      end
+
+      class Sub < Node
+        def value
+          '-'
+        end
+      end
+
+      class Mul < Node
+        def value
+          '*'
+        end
+      end
+
+      class Div < Node
+        def value
+          '/'
+        end
+      end
+
+      class Pow < Node
+        def value
+          '**'
+        end
+      end
+    end
+
+    class CompOp < Node
+      class Lt < Node
+        def value
+          '<'
+        end
+      end
+
+      class Gt < Node
+        def value
+          '>'
+        end
+      end
+
+      class Lte < Node
+        def value
+          '<='
+        end
+      end
+
+      class Gte < Node
+        def value
+          '>='
+        end
+      end
+
+      class Eq < Node
+        def value
+          '=='
+        end
+      end
+
+      class Neq < Node
+        def value
+          '!='
+        end
+      end
+    end
+  end
+end

data/lib/eqn/version.rb

@@ -0,0 +1,3 @@
+module Eqn
+  VERSION = '1.0.3'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: eqn
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Zach Schneider
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.14
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to evaluate numerical equations. Includes support for functions.
+email:
+- zach@aha.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eqn.gemspec
+- lib/eqn.rb
+- lib/eqn.treetop
+- lib/eqn/calculator.rb
+- lib/eqn/comparation.rb
+- lib/eqn/engine.rb
+- lib/eqn/expression.rb
+- lib/eqn/function.rb
+- lib/eqn/number.rb
+- lib/eqn/parser.rb
+- lib/eqn/terminal.rb
+- lib/eqn/version.rb
+homepage: https://github.com/schneidmaster/eqn
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A gem to evaluate numerical equations.
+test_files: []