brainfuck 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    brainfuck (0.0.1)
+      highline
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    highline (1.6.1)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    simplecov (0.3.7)
+      simplecov-html (>= 0.3.7)
+    simplecov-html (0.3.9)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  brainfuck!
+  bundler
+  highline
+  rspec
+  simplecov

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'simplecov'
+SimpleCov.start do
+  add_group "Lib", 'lib'
+end
+
+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,49 @@
+# brainfuck
+
+Just another Brainfuck interpreter in Ruby!
+(If you don't know what Brainfuck is, you definitely
+[should][http://en.wikipedia.org/wiki/Brainfuck]).
+
+This interpreter works with MRI 1.8.7, 1.9.2 and JRuby 1.5.5.
+
+## Known caveats (yes, before anything)
+
+Ok, I admit it. Nested loops don't work in an extremely reliable manner, so to
+speak. I suggest you NOT TO USE THIS IN PRODUCTION APPS. Yes, forget about
+using this interpreter for that high-security online payment system you wrote in Brainfuck.
+
+Oh and why are nested loops tricky with this interpreter? I was tired and Civilization 5
+was installed in my laptop and... You know, forks and pull requests are always welcome! :)
+
+## Installation and usage
+
+You just `gem install brainfuck`!
+
+And then: `brainfuck my_file.bf`
+
+You can also require the gem and use inline brainfuck in your ruby scripts like this:
+
+    require 'brainfuck'
+
+    interpreter = Brainfuck.new
+    interpreter.compile "+++>+++<---"
+
+    interpreter.cells
+    # => [0, 3]
+
+It's very basic, and needs *a lot* of refactoring, but for now... there you go! ;)
+
+## Note on Patches/Pull Requests
+ 
+* 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) 2010 Josep M. Bach. See LICENSE for details.

data/bin/brainfuck

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'brainfuck'
+Brainfuck::Interpreter.new.compile File.read(ARGV.first)

data/brainfuck.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "brainfuck/version"
+
+Gem::Specification.new do |s|
+  s.name        = "brainfuck"
+  s.version     = Brainfuck::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josep M. Bach"]
+  s.email       = ["josep.m.bach@gmail.com"]
+  s.homepage    = "http://github.com/txus/brainfuck"
+  s.summary     = %q{Another Brainfuck interpreter in Ruby}
+  s.description     = %q{Another Brainfuck interpreter in Ruby}
+
+  s.rubyforge_project = "brainfuck"
+
+  s.add_runtime_dependency "highline"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
+  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.require_paths = ["lib"]
+end

data/examples/hello_world.bf

@@ -0,0 +1,21 @@
++++++ +++++             initialize counter (cell #0) to 10
+[                       use loop to set the next four cells to 70/100/30/10
+    > +++++ ++              add  7 to cell #1
+    > +++++ +++++           add 10 to cell #2 
+    > +++                   add  3 to cell #3
+    > +                     add  1 to cell #4
+    <<<< -                  decrement counter (cell #0)
+]                   
+> ++ .                  print 'H'
+> + .                   print 'e'
++++++ ++ .              print 'l'
+.                       print 'l'
++++ .                   print 'o'
+> ++ .                  print ' '
+<< +++++ +++++ +++++ .  print 'W'
+> .                     print 'o'
++++ .                   print 'r'
+----- - .               print 'l'
+----- --- .             print 'd'
+> + .                   print '!'
+> .                     print '\n'

data/lib/brainfuck.rb

@@ -0,0 +1,102 @@
+require 'highline/system_extensions'
+
+module Brainfuck
+  class Interpreter
+    include HighLine::SystemExtensions
+
+    INSTRUCTIONS = %w{> < + - [ ] . ,}
+
+    attr_accessor :cells
+    attr_reader :pointer
+    attr_reader :code
+
+    def initialize
+      @cells = [0]
+      @pointer = 0
+      @code = nil
+    end
+
+    def current
+      @cells[pointer] ||= 0
+    end
+    def current=(value)
+      @cells[pointer] = (value % 255) rescue 0
+    end
+
+    def forward
+      @pointer += 1
+      initialize_cell_if_nil
+    end
+    def backward
+      @pointer -= 1
+      ensure_pointer_is_above_zero
+      initialize_cell_if_nil
+    end
+    def increase
+      @cells[pointer] = (@cells[pointer] + 1) % 255
+    end
+    def decrease
+      @cells[pointer] = (@cells[pointer] - 1) % 255
+    end
+
+    def compile(code)
+      @code = clean(code)
+      run
+    end
+
+    def run(from = nil, to = nil)
+      index = 0
+      context = 0
+
+      c = code.dup
+
+      if from && to
+        context = from 
+        c = c.slice(from...to)
+      end
+
+      c.each_char do |char|
+        index += 1
+        case char
+          when '>'
+            forward 
+          when '<'
+            backward 
+          when '+'
+            increase
+          when '-'
+            decrease
+          when '.'
+            stdout.print current.chr
+          when ','
+            self.current = get_character
+          when '['
+            @start = index
+          when ']'
+            @end = index unless @end && @start < @end
+            run(@start, @end) unless current == 0
+            @start = context || nil
+        end
+      end
+    end
+
+    private
+
+    def clean(code)
+      code.chars.select {|c| INSTRUCTIONS.include? c }.join
+    end
+
+    def stdout
+      $stdout
+    end
+
+    def initialize_cell_if_nil
+      @cells[pointer] ||= 0
+    end
+
+    def ensure_pointer_is_above_zero
+      raise "Tried to access cell #{@pointer}." if @pointer < 0
+    end
+
+  end
+end

data/lib/brainfuck/version.rb

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

data/spec/acceptance_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+module Brainfuck
+  describe Interpreter, "acceptance specs" do
+
+    describe "without loops nor user input" do
+      let(:code) do
+        <<-EOS
+          ++++>++++---.<--.
+        EOS
+      end
+      it "sets two cells to 2 and 1" do
+        subject.should_receive(:code).and_return code
+        subject.compile(code)
+        subject.cells.should == [2,1]
+      end
+      it "prints 2 and 1" do
+        output = double('output')
+        subject.should_receive(:stdout).twice.and_return(output)
+        output.should_receive(:print).with(1.chr).ordered
+        output.should_receive(:print).with(2.chr).ordered
+
+        subject.compile(code)
+      end
+    end
+
+    describe "with user input" do
+      let(:code) do
+        <<-EOS
+          ,++++
+        EOS
+      end
+      it "sets the first cell to a + 4" do
+        input = double('input')
+        subject.should_receive(:get_character).once.and_return 97
+
+        subject.compile(code)
+        subject.current.should == 101
+      end
+    end
+
+    describe "with loops" do
+      let(:code) do
+        <<-EOS
+          ++++[-]+-+
+        EOS
+      end
+      it "runs the loop 4 times" do
+        subject.compile(code)
+        subject.current.should == 1
+      end
+    end
+    
+    describe "cell hopping examples" do
+
+      it "transfers the content from one cell to another" do
+        subject.cells = [10]
+        subject.compile("[>+<-]")
+        subject.cells.should == [0,10]
+      end
+
+      it "transfers the content from one cell to the third" do
+        subject.cells = [10]
+        subject.compile("[>+<-]>[>+<-]")
+        subject.cells.should == [0,0,10]
+      end
+
+      it "transfers the content from one cell to the third and back to the second" do
+        subject.cells = [10]
+        subject.compile("[>+<-]>[>+<-]>[<+>-]")
+        subject.cells.should == [0,10,0]
+      end
+
+    end
+
+    describe "hello world" do
+
+      it "displays hello world" do
+        subject.compile <<-EOS
+          +++++ +++++            
+          [                      
+              > +++++ ++         
+              > +++++ +++++      
+              > +++              
+              > +                
+              <<<< -              
+          ]                   
+          > ++ .                  
+          > + .                   
+          +++++ ++ .              
+          .                       
+          +++ .                   
+          > ++ .                  
+          << +++++ +++++ +++++ .  
+          > .                     
+          +++ .                   
+          ----- - .               
+          ----- --- .             
+          > + .                   
+          > .                     
+  EOS
+
+      end
+    end
+
+  end
+end

data/spec/interpreter_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module Brainfuck
+  describe Interpreter do
+    subject { Interpreter.new }
+
+    it "initializes with an array of cells with a single 0 element" do
+      subject.cells.should == [0]
+    end
+
+    describe "#clean" do
+      it "cleans the code from comments and whitespace" do
+        subject.send(:clean, " < > h -  + ..,hb [lk]f").should == '<>-+..,[]'
+      end
+    end
+
+    describe "#compile" do
+      it "cleans the code first and runs it second" do
+        code = double('code')
+        subject.should_receive(:clean).once.with(code).ordered.and_return("")
+        subject.should_receive(:run).once
+
+        subject.compile(code)
+      end
+    end
+
+    describe "#run" do
+      it "converts > into forward" do
+        subject.stub(:code).and_return ">"
+        subject.should_receive(:forward).once
+        subject.run
+      end
+      it "converts < into backward" do
+        subject.stub(:code).and_return "<"
+        subject.should_receive(:backward).once
+        subject.run
+      end
+      it "converts + into increase" do
+        subject.stub(:code).and_return "+"
+        subject.should_receive(:increase).once
+        subject.run
+      end
+      it "converts - into decrease" do
+        subject.stub(:code).and_return "-"
+        subject.should_receive(:decrease).once
+        subject.run
+      end
+      it "converts , into get_character" do
+        subject.stub(:code).and_return ","
+        subject.should_receive(:get_character).once
+        subject.run
+      end
+      it "converts . into stdout.print" do
+        subject.stub(:code).and_return "."
+        output = double('output')
+        subject.should_receive(:stdout).once.and_return(output)
+        subject.should_receive(:current).once.and_return(117)
+        output.should_receive(:print).once
+
+        subject.run
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+require 'simplecov'
+SimpleCov.start do
+  add_group "Lib", "lib"
+end
+
+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 'brainfuck'
+require 'rspec'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: brainfuck
+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: 2010-12-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  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: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  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: simplecov
+  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: Another Brainfuck interpreter in Ruby
+email: 
+- josep.m.bach@gmail.com
+executables: 
+- brainfuck
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- bin/brainfuck
+- brainfuck.gemspec
+- examples/hello_world.bf
+- lib/brainfuck.rb
+- lib/brainfuck/version.rb
+- spec/acceptance_spec.rb
+- spec/interpreter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/txus/brainfuck
+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: brainfuck
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Another Brainfuck interpreter in Ruby
+test_files: 
+- spec/acceptance_spec.rb
+- spec/interpreter_spec.rb
+- spec/spec_helper.rb