arithmetic 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    arithmetic (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arithmetic!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sean Kirby
+
+MIT License
+
+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,31 @@
+arithmetic
+==========
+
+Simple arithmetic evaluator for Ruby
+
+Based on http://rosettacode.org/wiki/Arithmetic_evaluation#Ruby but adds:
+
+* tests
+* support for nicer errors on invalid expressions
+* optional spaces between operators and operands
+* uses BigDecimal instead of floats
+
+Shortcomings:
+
+* only supports `+ - * /` operators
+* no localization
+
+Usage
+=====
+
+    expression = Arithmetic.parse("-2 * (1+3.5)")
+    expression.eval # => -18
+    expression.to_s # => "-2 * (1 + 3.5)"
+
+    Arithmetic.parse("2 + wtf?") # => raises Arithmetic::InvalidExpression with the 
+                                 # original expression as the message
+
+I18N support
+============
+
+Please ensure that decimal separators are decimals ('`.`'). Use a gem like Delocalize to perform this conversion.

data/Rakefile

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

data/arithmetic.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arithmetic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "arithmetic"
+  gem.version       = Arithmetic::VERSION
+  gem.authors       = ["Sean Kirby", "Justin Fitzsimmons"]
+  gem.email         = ["seank@nulogy.com", "justin@fitzsimmons.ca"]
+  gem.description   = %q{Simple arithmetic calculator for Ruby}
+  gem.summary       = %q{Simple arithmetic calculator for Ruby}
+  gem.homepage      = "https://github.com/nulogy/arithmetic"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency('rspec')
+end

data/lib/arithmetic.rb

@@ -0,0 +1,12 @@
+require 'bigdecimal'
+require 'arithmetic/expression'
+require 'arithmetic/parser'
+require 'arithmetic/nodes'
+require 'arithmetic/operators'
+
+module Arithmetic
+  # make lazy?
+  def self.parse(expression)
+    Expression.new(Parser.new(expression).parse)
+  end
+end

data/lib/arithmetic/expression.rb

@@ -0,0 +1,15 @@
+module Arithmetic
+  class Expression
+    def initialize(expression)
+      @parsed_expression = expression
+    end
+
+    def eval
+      @result ||= @parsed_expression.eval
+    end
+
+    def to_s
+      @string ||= @parsed_expression.to_s
+    end
+  end
+end

data/lib/arithmetic/nodes.rb

@@ -0,0 +1,42 @@
+module Arithmetic 
+  class OperandNode
+    attr_accessor :operand
+   
+    def initialize(operand)
+      @operand = operand
+    end
+
+    def to_s(na=nil)
+      @operand
+    end
+   
+    def eval
+      BigDecimal.new(@operand)
+    end
+  end
+
+  class OperatorNode
+    attr_accessor :operator, :operands
+   
+    def initialize(operator, operands)
+      @operator = operator
+      @operands = operands
+    end
+   
+    def to_s(top=true)
+      strs = @operands.map {|o| o.to_s(false) }
+
+      if @operator.arity == 1
+        "#{@operator}#{strs.first}"
+      else
+        result = [strs.first, @operator, *strs[1..-1]].join(" ")
+        result = "(" + result + ")" unless top
+        result
+      end
+    end
+   
+    def eval
+      @operator.eval(*@operands.map(&:eval))
+    end
+  end
+end

data/lib/arithmetic/operators.rb

@@ -0,0 +1,41 @@
+module Arithmetic
+  class Operator
+    attr_reader :string, :priority
+
+    def initialize(string, priority, function)
+      @string = string
+      @priority = priority
+      @function = function
+    end
+
+    def eval(*args)
+      @function.call(*args)
+    end
+
+    def to_s
+      @string
+    end
+
+    def arity
+      @function.arity
+    end
+  end
+
+  module Operators
+    extend self
+
+    UNARY_MINUS = Operator.new("-", 2, lambda {|x| -x})
+    MINUS = Operator.new("-", 0, lambda {|x, y| x - y})
+
+    @operators = {
+      "+" => Operator.new("+", 0, lambda {|x, y| x + y}),
+      "-" => MINUS,
+      "*" => Operator.new("*", 1, lambda {|x, y| x * y}),
+      "/" => Operator.new("/", 1, lambda {|x, y| x / y})
+    }
+
+    def get(token)
+      @operators[token]
+    end
+  end
+end

data/lib/arithmetic/parser.rb

@@ -0,0 +1,107 @@
+module Arithmetic
+  class Parser
+    def initialize(exp)
+      @expression = exp.to_s
+      @node_stack = []
+    end
+
+    def parse
+      tokens = Tokenizer.new.tokenize(@expression)
+      op_stack = []
+     
+      tokens.each do |token|
+        if token.is_a? Operator
+          # clear stack of higher priority operators
+          while (!op_stack.empty? &&
+                 op_stack.last != "(" &&
+                 op_stack.last.priority >= token.priority)
+            push_operator(op_stack.pop)
+          end
+     
+          op_stack.push(token)
+        elsif token == "("
+          op_stack.push(token)
+        elsif token == ")"
+          while op_stack.last != "("
+            push_operator(op_stack.pop)
+          end
+     
+          # throw away the '('
+          op_stack.pop
+        else
+          push_operand(token)
+        end
+      end
+     
+      until op_stack.empty?
+        push_operator(op_stack.pop)
+      end
+     
+      parsed_expression = @node_stack.pop
+      raise InvalidExpression.new(@expression) unless @node_stack.empty?
+      parsed_expression
+    end
+
+    private
+
+    def push_operand(operand)
+      raise InvalidExpression.new(@expression) unless is_a_number?(operand)
+      @node_stack.push(OperandNode.new(operand))
+    end
+
+    def push_operator(operator)
+      raise InvalidExpression.new(@expression) unless operator.is_a?(Operator)
+
+      operands = []
+      operator.arity.times do
+        operands.unshift(@node_stack.pop)
+      end
+      raise InvalidExpression.new(@expression) if operands.any?(&:nil?)
+
+      @node_stack.push(OperatorNode.new(operator, operands))
+    end
+
+    def is_a_number?(str)
+      !!str.match(/^[\d\.]+$/)
+    end
+  end
+
+  class Tokenizer
+    def tokenize(exp)
+      tokens = exp
+        .gsub('*', ' * ')
+        .gsub('/', ' / ')
+        .gsub('+', ' + ')
+        .gsub('-', ' - ')
+        .gsub('(', ' ( ')
+        .gsub(')', ' ) ')
+        .split(' ')
+      tokens = parse_operators(tokens)
+      replace_unary_minus(tokens)
+    end
+
+    private
+
+    def parse_operators(tokens)
+      tokens.map do |token|
+        Operators.get(token) || token
+      end
+    end
+
+    def replace_unary_minus(tokens)
+      new_tokens = []
+      tokens.each_with_index do |current_token, i|
+        previous_token = tokens[i-1]
+        if current_token == Operators::MINUS && (i == 0 || previous_token.is_a?(Operator))
+          new_tokens << Operators::UNARY_MINUS
+        else
+          new_tokens << current_token
+        end
+      end
+      new_tokens
+    end
+  end
+
+  class InvalidExpression < Exception
+  end
+end

data/lib/arithmetic/version.rb

@@ -0,0 +1,3 @@
+module Arithmetic
+  VERSION = "0.1.0"
+end

data/spec/arithmetic_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Arithmetic do
+  it "evaluates simple expressions" do
+    test_eval("2").should == 2.0
+  end
+
+  it "evaluates addition" do
+    test_eval("2 + 2").should == 4.0
+  end
+
+  it "evaluates subtraction" do
+    test_eval("2.1 - 2").should == 0.1
+  end
+
+  it "handles negative numbers" do
+    test_eval("3--2").should == 5
+  end
+
+  it "handles negative numbers with parens" do
+    test_eval("-(3+2)").should == -5
+  end
+
+  it "handles leading minus signs" do
+    test_eval("-3+2").should == -1
+  end
+
+  it "has unary minus take precedence over multiplication" do
+    test_eval("-3 * -2").should == 6
+  end
+
+  it "evaluates division" do
+    test_eval("10.5 / 5").should == 2.1
+  end
+
+  it "evaluates multiplication" do
+    test_eval("2 * 3.1").should == 6.2
+  end
+
+  it "evaluates parens" do
+    test_eval("2 * (2.1 + 1)").should == 6.2
+  end
+
+  it "evaluates regardless of whitespace" do
+    test_eval("2*(1+\t1)").should == 4
+  end
+
+  it "evaluates order of operations" do
+    expect( test_eval("2 * 2.1 + 1 / 2") ).to eq 4.7
+  end
+
+  it "evaluates multiple levels of parens" do
+    test_eval("2*(1/(1+3))").should == 0.5
+  end
+
+  it "formats the expression" do
+    test_to_s("   -1+\n    2*     \t3").should == '-1 + (2 * 3)'
+  end
+
+  it "handles ridiculous precision" do
+    test_eval("1.111111111111111111111111111111111111111111 + 2").should == BigDecimal.new('3.111111111111111111111111111111111111111111')
+  end
+
+  it "handles simple numbers" do
+    test_eval(2).should == 2
+  end
+
+  context "invalid expressions" do
+    it "handles missing operand" do
+      exp_should_error "1 *"
+      exp_should_error "1 * + 1"
+    end
+
+    it "handles missing operator" do
+      exp_should_error "1 2 * 3"
+    end
+
+    it "handles invalid characters" do
+      exp_should_error "1 * hi_there!"
+    end
+
+    it "handles invalid operators" do
+      exp_should_error "1 & 2"
+    end
+
+    it "handles unmatched leading paren" do
+      exp_should_error "(1 + 2"
+    end
+
+    it "handles unmatched trailing paren" do
+      exp_should_error "1 + 2)"
+    end
+  end
+
+  def exp_should_error(exp)
+    expect {test_init exp}.to raise_error Arithmetic::InvalidExpression
+  end
+
+  def test_eval(exp)
+    test_init(exp).eval
+  end
+
+  def test_to_s(exp)
+    test_init(exp).to_s
+  end
+
+  def test_init(exp)
+    Arithmetic::parse(exp)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'arithmetic'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: arithmetic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Kirby
+- Justin Fitzsimmons
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple arithmetic calculator for Ruby
+email:
+- seank@nulogy.com
+- justin@fitzsimmons.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- arithmetic.gemspec
+- lib/arithmetic.rb
+- lib/arithmetic/expression.rb
+- lib/arithmetic/nodes.rb
+- lib/arithmetic/operators.rb
+- lib/arithmetic/parser.rb
+- lib/arithmetic/version.rb
+- spec/arithmetic_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nulogy/arithmetic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple arithmetic calculator for Ruby
+test_files:
+- spec/arithmetic_spec.rb
+- spec/spec_helper.rb