rpn 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use ruby-1.9.2@rpn

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    rpn (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    configuration (1.2.0)
+    diff-lcs (1.1.2)
+    guard (0.2.2)
+      open_gem (~> 1.4.2)
+      thor (~> 0.14.3)
+    guard-rspec (0.1.9)
+      guard (>= 0.2.2)
+    launchy (0.3.7)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    open_gem (1.4.2)
+      launchy (~> 0.3.5)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.7)
+  guard
+  guard-rspec
+  rpn!
+  rspec (~> 2.4.0)

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at http://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch('^spec/(.*)_spec.rb')
+  watch('^lib/(.*)\.rb')                              { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('^spec/spec_helper.rb')                       { "spec" }
+  
+  # Rails example
+  watch('^app/(.*)\.rb')                              { |m| "spec/#{m[1]}_spec.rb" }
+  # watch('^lib/(.*)\.rb')                              { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('^config/routes.rb')                          { "spec/routing" }
+  watch('^app/controllers/application_controller.rb') { "spec/controllers" }
+  watch('^spec/factories.rb')                         { "spec/models" }
+end

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,57 @@
+#Reverse Polish Notation calculator
+
+A simple implementation of a RPN (also known as _postfix_ notation) calculator.
+
+In a nutshell, this notation consists of operands followed by their operators.
+As opposed to express an operation like this...
+
+    (3 + 4) * 7 - 1
+
+...in reverse Polish notation it would look like this:
+
+    7 3 4 + * 1 -
+
+It basically works like a stack in which you push operands until you find an
+operator; given an arity _n_, you evaluate this operator with _n_ numbers from
+the stack, and substitute them for their result. Check out the [Wikipedia
+article](http://en.wikipedia.org/wiki/Reverse_Polish_notation) to learn more about this notation.
+
+##Install
+
+    gem install rpn
+
+##Usage
+
+Just require it in your Gemfile:
+
+    gem 'rpn'
+
+Note: If you are not using Bundler, you should `require 'rpn'` manually.
+
+Now you have to initialize a calculator. You can provide a custom _n_ arity 
+(the number of operands that will get evaluated by each operator). Default
+arity is 2. You can also provide the delimiter the parser will use (will be ' '
+by default).
+
+    my_rpn = RPN::Calculator.new # => will use the defaults
+    my_rpn.solve "7 3 4 + * 1 -"
+    # => 48
+
+For now, it supports the following operators:
+
+    + - * / ^
+
+##Contribute!
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs for it. This is important so I don't break it in a future
+  version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  If you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull.
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Josep M. Bach. See LICENSE for details.

data/lib/rpn/calculator.rb

@@ -0,0 +1,14 @@
+module RPN
+  class Calculator
+    attr_reader :parser, :stack
+    def initialize options = {}
+      arity, delimiter = options[:arity] || 2,
+                         options[:delimiter] || ' '
+      @stack = Stack.new(arity)
+      @parser = Parser.new(delimiter)
+    end
+    def solve string
+      stack.solve parser.parse(string)
+    end
+  end
+end

data/lib/rpn/parser.rb

@@ -0,0 +1,41 @@
+module RPN
+  class Parser
+    class MalformedStringError < StandardError; end;
+    class InvalidDelimiterError < StandardError; end;
+    
+    TOKENS = %w{. + - * / ^}
+    ALIASES = {'^' => '**'}
+
+    attr_reader :delimiter
+
+    def initialize delimiter
+      @delimiter = validate(delimiter)
+    end
+
+    def parse string
+      string.gsub(/#{delimiter}+/, delimiter)\
+            .split(delimiter).map(&:strip).map do |element|
+        if element.to_i.zero? && element != '0'
+          if TOKENS.include?(element)
+            (ALIASES[element] || element).to_sym
+          else
+            raise MalformedStringError.new("Offending token: #{element}")
+          end
+        else
+          element =~ /\./ ? element.to_f\
+                          : element.to_i
+        end
+      end
+    end
+
+    private
+
+    def validate delimiter
+      if TOKENS.include?(delimiter.strip) ||
+          delimiter =~ /[0-9]+/
+        raise InvalidDelimiterError.new
+      end
+      delimiter
+    end
+  end
+end

data/lib/rpn/stack.rb

@@ -0,0 +1,49 @@
+module RPN
+  class Stack
+    class InsufficientValuesAvailable < StandardError; end;
+    class UnsolvableExpressionError < StandardError; end;
+
+    attr_reader :arity, :elements
+
+    def initialize arity
+      @arity = arity
+      @elements = []
+    end
+
+    def solve tokens
+      clear
+      tokens.each do |token|
+        if Numeric === token
+          push token
+          next
+        end
+        raise InsufficientValuesAvailable\
+              .new("Cannot apply #{token} to less than #{arity} values!") if size < arity
+        result = pop(arity).inject do |acc, e|
+          acc.send(token, e)
+        end
+        push result
+      end
+      raise UnsolvableExpressionError\
+            .new("The final stack contained more than one value: #{elements.inspect}") if size > 1
+      elements.first
+    end
+
+    def push token
+      elements.push token
+    end
+
+    def pop amount
+      elements.pop amount
+    end
+
+    def size
+      elements.size
+    end
+
+    def clear
+      elements.clear
+    end
+
+  end
+end

data/lib/rpn/version.rb

@@ -0,0 +1,3 @@
+module RPN
+  VERSION = "0.0.1"
+end

data/lib/rpn.rb

@@ -0,0 +1,6 @@
+require 'rpn/stack.rb'
+require 'rpn/parser.rb'
+require 'rpn/calculator.rb'
+
+module RPN
+end

data/rpn.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rpn/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rpn"
+  s.version     = RPN::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josep M. Bach"]
+  s.email       = ["josep.m.bach@gmail.com"]
+  s.homepage    = "http://github.com/txus/rpn"
+  s.summary     = %q{A simple Reverse Polish Notation calculator in Ruby}
+  s.description     = %q{A simple Reverse Polish Notation calculator in Ruby}
+
+  s.rubyforge_project = "rpn"
+
+  s.add_development_dependency 'bundler', '~> 1.0.7'
+  s.add_development_dependency 'rspec',   '~> 2.4.0'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+
+  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.require_paths = ["lib"]
+end

data/spec/acceptance/acceptance_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module RPN
+  describe Calculator do
+
+    it 'works like a charm' do
+      subject.solve("2 3 +").should == 5
+      subject.solve("90 3 -").should == 87
+      subject.solve("10 4 3 + 2 * -").should == -4
+      subject.solve("10 4 3 + 2 * - 2 /").should == -2
+      subject.solve("90 34 12 33 55 66 + * - + -").should == 4037
+      subject.solve("2 3 ^").should == 8
+    end
+
+  end
+
+end

data/spec/rpn/calculator_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module RPN
+  describe Calculator do
+    describe "#initialize" do
+      context "with no arguments" do
+        it 'sets default arity' do
+          Stack.should_receive(:new).with(2)
+          Calculator.new
+        end
+        it 'sets default delimiter' do
+          Parser.should_receive(:new).with(' ')
+          Calculator.new
+        end
+      end
+      it 'accepts a custom arity' do
+        Stack.should_receive(:new).with(3)
+        Calculator.new :arity => 3
+      end
+      it 'accepts a custom delimiter' do
+        Parser.should_receive(:new).with(',')
+        Calculator.new :delimiter => ','
+      end
+      it 'creates an accessible stack' do
+        calculator = Calculator.new
+        calculator.stack.should be_kind_of(Stack)
+      end
+      it 'creates an accessible parser' do
+        calculator = Calculator.new
+        calculator.parser.should be_kind_of(Parser)
+      end
+    end
+
+    describe "#solve" do
+      it 'passes the string to the parser' do
+        subject.stack.stub(:solve)
+        subject.parser.should_receive(:parse).with "3 4 +"
+        subject.solve "3 4 +"
+      end
+      it 'delegates solving to the stack' do
+        subject.parser.stub(:parse).and_return ["3", "4", "+"]
+        subject.stack.should_receive(:solve).with ["3", "4", "+"]
+        subject.solve "3 4 +"
+      end
+    end
+  end
+end

data/spec/rpn/parser_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module RPN
+  describe Parser do
+    describe "#initialize" do
+      it 'sets the delimiter' do
+        parser = Parser.new ' '
+        parser.delimiter.should == ' '
+      end
+      describe "makes the parser raise an InvalidDelimiterError" do
+        %w{. + - * / ^ 19 425 0}.each do |invalid_delimiter|
+          it "when using #{invalid_delimiter} as a delimiter" do
+            expect {
+              Parser.new invalid_delimiter
+            }.to raise_error(Parser::InvalidDelimiterError)
+          end
+        end
+      end
+    end
+
+    describe "#parse" do
+      context "with a space delimiter" do
+        subject { Parser.new ' ' }
+
+        it 'returns a tokenized array' do
+          subject.parse("1 4 5 + -").should == [1, 4, 5, :+, :-]
+          subject.parse("1 2 3 4 5 6 7 8 + - * / ^").should == [1, 2, 3, 4, 5, 6, 7, 8, :+, :-, :*, :/, :**]
+        end
+        describe "edge cases" do
+          it 'strips any extra spaces' do
+            subject.parse("1    4  5 +  -").should == [1, 4, 5, :+, :-]
+          end
+        end
+      end
+      context "with a comma delimiter" do
+        subject { Parser.new ',' }
+
+        it 'returns a tokenized array' do
+          subject.parse("1,4,5.3,+,-").should == [1, 4, 5.3, :+, :-]
+          subject.parse("1,2,3,4,5,6,7,8,+,-,*,/,^").should == [1,2,3,4,5,6,7,8,:+,:-,:*,:/,:**]
+        end
+        describe "edge cases" do
+          it 'strips any extra spaces and delimiter' do
+            subject.parse("1,, 4 , 5.3 ,,,+, -").should == [1, 4, 5.3, :+, :-]
+          end
+        end
+      end
+      context "with inconsistent or malformed strings" do
+        subject { Parser.new ',' }
+
+        it 'raises a MalformedStringError' do
+          expect {
+            subject.parse "1,4.5,&+,-"
+          }.to raise_error(Parser::MalformedStringError, "Offending token: &+")
+        end
+      end
+    end
+    
+  end
+end

data/spec/rpn/stack_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+module RPN
+  describe Stack do
+    subject { Stack.new 2 }
+
+    describe "#initialize" do
+      it 'sets the delimiter' do
+        stack = Stack.new 3
+        stack.arity.should == 3
+      end
+    end
+
+    describe "#solve", "iterates the tokens" do
+      context 'when the token is a value' do
+        it 'pushes it to the stack' do
+          subject.should_receive(:push).with 3
+          subject.solve [3]
+        end
+      end
+      context 'when the token is an operator' do
+        context 'if the size of the stack is below the arity' do
+          it 'raises an error' do
+            subject.stub(:size).and_return 1
+            expect {
+              subject.solve [:+]
+            }.to raise_error(Stack::InsufficientValuesAvailable)
+          end
+        end
+        context 'otherwise' do
+          it 'pops n elements from the stack and pushes the result' do
+            subject.stub(:size).and_return 3, 1
+            elements = [1,2]
+            subject.should_receive(:pop).with(subject.arity).and_return elements
+            subject.should_receive(:push).with(3)
+
+            subject.solve [:+]
+          end
+        end
+      end
+      context 'when at the end there is more than one result' do
+        it 'raises an error' do
+          subject.stub(:size).and_return 2
+          expect {
+            subject.solve [:+]
+          }.to raise_error(Stack::UnsolvableExpressionError)
+        end
+      end
+      context 'when everything is fine' do
+        it 'returns the result' do
+          subject.stub(:size).and_return 3, 1
+          elements = [1,2]
+          subject.stub(:pop).with(subject.arity).and_return elements
+
+          subject.solve([:+]).should == 3
+        end
+      end
+
+      it 'clears the stack before each call' do
+        subject.solve [3]
+        subject.solve [4]
+        subject.elements.should == [4]
+      end
+    end
+
+    describe "#push" do
+      it 'pushes a token to the elements collection' do
+        subject.elements.should_receive(:push).with 3
+        subject.push 3
+      end
+    end
+    describe "#pop" do
+      it 'pushes a token to the elements collection' do
+        subject.elements.should_receive(:pop).with 2
+        subject.pop 2
+      end
+    end
+    describe "#size" do
+      it 'pushes a token to the elements collection' do
+        subject.elements.should_receive(:size)
+        subject.size
+      end
+    end
+    describe "#clear" do
+      it 'clears the stack' do
+        subject.elements.should_receive(:clear)
+        subject.clear
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rpn'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: rpn
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josep M. Bach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A simple Reverse Polish Notation calculator in Ruby
+email: 
+- josep.m.bach@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- Rakefile
+- Readme.md
+- lib/rpn.rb
+- lib/rpn/calculator.rb
+- lib/rpn/parser.rb
+- lib/rpn/stack.rb
+- lib/rpn/version.rb
+- rpn.gemspec
+- spec/acceptance/acceptance_spec.rb
+- spec/rpn/calculator_spec.rb
+- spec/rpn/parser_spec.rb
+- spec/rpn/stack_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/txus/rpn
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rpn
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple Reverse Polish Notation calculator in Ruby
+test_files: 
+- spec/acceptance/acceptance_spec.rb
+- spec/rpn/calculator_spec.rb
+- spec/rpn/parser_spec.rb
+- spec/rpn/stack_spec.rb
+- spec/spec_helper.rb