brainfuck_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aab2eca7a1517f1379a14eab6f7a6c82b6bb0c35e32aaac0c7fa375014a83fdd
+  data.tar.gz: 890127ded5ceb4153732b40d1c67d0c0a4e667c51424bffbe431b1449126bb5f
+SHA512:
+  metadata.gz: 11dfa2271fede9934b4ea66d8bf6262f4bfe6bbd9bd0a5c8b4b290f55776dda2744102ed4938a7961cef552d85875f5c658f17b02ee44b493d2213aed156d052
+  data.tar.gz: 290c20f7c32ce17745baa5456bd77db5698873b4d9fff250f36ddc811a56670e4890bb03116c9ddfccfb84caed686094098320c7cdaf930f27150a8b6fb2f4c7

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.7.3
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in brainfuck_ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    brainfuck_ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  brainfuck_ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Keegan Leitz
+
+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,70 @@
+# BrainfuckRuby
+
+A brainfuck interpreter written in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brainfuck_ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install brainfuck_ruby
+
+## Usage
+
+```rb
+hello_world_in_brainfuck = <<~BRAINFUCK
++++++ +++
+[
+    > ++++
+    [
+        > ++
+        > +++
+        > +++
+        > +
+        <<<< -
+    ]
+    > +
+    > +
+    > -
+    >> +
+    [
+        <
+    ]
+    < -
+]
+>> .
+> --- . +++++ ++ . . +++ .
+>> .
+< - .
+< . +++ . ----- - . ----- --- .
+>> + .
+> ++ .
+BRAINFUCK
+
+BrainfuckRuby::Interpreter.new(hello_world_in_brainfuck).execute!
+# Hello World!
+# => nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kjleitz/brainfuck_ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "brainfuck_ruby"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brainfuck_ruby.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/brainfuck_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "brainfuck_ruby"
+  spec.version       = BrainfuckRuby::VERSION
+  spec.authors       = ["Keegan Leitz"]
+  spec.email         = ["kjleitz@gmail.com"]
+
+  spec.summary       = "brainfuck interpreter written in ruby"
+  spec.description   = "brainfuck interpreter written in ruby"
+  spec.homepage      = "https://github.com/kjleitz/brainfuck_ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.3"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kjleitz/brainfuck_ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/brainfuck_ruby/interpreter.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module BrainfuckRuby
+  # Interprets brainfuck code. Initialize with a string containing some
+  # brainfuck, and then call `#execute!` on the instance to execute that code.
+  class Interpreter
+    attr_reader :options, :cell_values, :code, :cursor
+    attr_accessor :current_cell, :nesting
+
+    def initialize(brainfuck_code)
+      @code = brainfuck_code
+      reset!
+    end
+
+    def reset!
+      @cell_values = Hash.new(0)
+      @current_cell = 0
+      @cursor = 0
+      @nesting = 0
+    end
+
+    def execute!
+      loop do
+        instruction = current_instruction
+        break if instruction.nil?
+
+        handle_instruction!(instruction)
+        next_instruction!
+      end
+
+      reset!
+      nil
+    end
+
+    def handle_instruction!(instruction)
+      case instruction
+      when ">" then right!
+      when "<" then left!
+      when "+" then increment!
+      when "-" then decrement!
+      when "[" then goto_closing_brace! if current_cell_value.zero?
+      when "]" then goto_opening_brace! if current_cell_value.positive?
+      when "." then print!
+      when "," then read!
+      end
+    end
+
+    def cursor=(value)
+      raise "Cursor position cannot go below zero" if value.negative?
+
+      @cursor = value
+    end
+
+    def current_instruction
+      code[cursor]
+    end
+
+    def current_cell_value
+      cell_values[current_cell]
+    end
+
+    def current_cell_value=(value)
+      cell_values[current_cell] = value % 256
+    end
+
+    def current_cell_character
+      current_cell_value.chr
+    end
+
+    def next_instruction!
+      self.cursor += 1
+    end
+
+    def right!
+      self.current_cell += 1
+    end
+
+    def left!
+      self.current_cell -= 1
+    end
+
+    def increment!
+      self.current_cell_value += 1
+    end
+
+    def decrement!
+      self.current_cell_value -= 1
+    end
+
+    def goto_closing_brace!
+      goto_matching_brace_to_the :right
+    end
+
+    def goto_opening_brace!
+      goto_matching_brace_to_the :left
+    end
+
+    def print!
+      print(current_cell_character)
+    end
+
+    def read!
+      input = gets.chomp
+      self.current_cell_value = numeric?(input) ? input.to_i : input.ord
+    end
+
+    def numeric?(value)
+      !!Float(value) rescue false
+    end
+
+    private
+
+    # `direction` should be `:right` or `:left`
+    def goto_matching_brace_to_the(direction)
+      cursor_modifier = { right: 1, left: -1 }[direction]
+      nesting = 0
+
+      loop do
+        case current_instruction
+        when "[" then nesting += 1
+        when "]" then nesting -= 1
+        end
+
+        break if nesting.zero?
+
+        self.cursor += cursor_modifier
+      end
+    end
+  end
+end

data/lib/brainfuck_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BrainfuckRuby
+  VERSION = "0.1.0"
+end

data/lib/brainfuck_ruby.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "brainfuck_ruby/version"
+require_relative "brainfuck_ruby/interpreter"
+
+module BrainfuckRuby
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: brainfuck_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keegan Leitz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-02 00:00:00.000000000 Z
+dependencies: []
+description: brainfuck interpreter written in ruby
+email:
+- kjleitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brainfuck_ruby.gemspec
+- lib/brainfuck_ruby.rb
+- lib/brainfuck_ruby/interpreter.rb
+- lib/brainfuck_ruby/version.rb
+homepage: https://github.com/kjleitz/brainfuck_ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kjleitz/brainfuck_ruby
+  source_code_uri: https://github.com/kjleitz/brainfuck_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: brainfuck interpreter written in ruby
+test_files: []