befunger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13f8c6222f3f991b2316f1af4dfd93fbab419da6
+  data.tar.gz: 7445278203eb52b1bed7bad1b4802261f70ff2a2
+SHA512:
+  metadata.gz: e3859a68f657555bae5791d901d19c1f064a254048cc814920ef906725a4a9c8fc5b8a930d8fe0c336cfa45cdb73231b83103cbde889883bce162e3823e68614
+  data.tar.gz: 7d0115f877f145a2bede98c73f2a4e449beaf960099cd001e712d315035dce0bfe69784fdb60b5a408b8a001f706fc42cdb1bc7de42d66fedfd6a0af7ae7cea5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.14.3

data/.yardopts

@@ -0,0 +1,2 @@
+--markup=markdown
+--private

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rohitpaulk@live.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Paul Kuruvilla
+
+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,85 @@
+# Befunger
+
+Befunger is an interpreter for [Befunge](https://esolangs.org/wiki/Befunge) written in Ruby. I wrote this as an answer to [this Kata on codewars](https://www.codewars.com/kata/befunge-interpreter).
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'befunger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install befunger
+
+## Usage
+
+```
+require 'befunger'
+
+Befunge.run(code)
+```
+
+## Specification
+
+This is the [original problem statement](https://www.codewars.com/kata/befunge-interpreter) I wrote this for:
+
+Your task is to write a method which will interpret Befunge-93 code! Befunge-93 is a language in which the code is presented not as a series of instructions, but as instructions scattered on a 2D plane; your pointer starts at the top-left corner and defaults to moving right through the code. Note that the instruction pointer wraps around the screen! There is a singular stack which we will assume is unbounded and only contain integers. While Befunge-93 code is supposed to be restricted to 80x25, you need not be concerned with code size. Befunge-93 supports the following instructions
+
+- `0-9` Push this number onto the stack.
+- `+` Addition: Pop a and b, then push a+b.
+- `-` Subtraction: Pop a and b, then push b-a.
+- `*` Multiplication: Pop a and b, then push a*b.
+- `/` Integer division: Pop a and b, then push b/a, rounded down. If a is zero, push zero.
+- `%` Modulo: Pop a and b, then push the b%a. If a is zero, push zero.
+- `!` Logical NOT: Pop a value. If the value is zero, push 1; otherwise, push zero.
+- `` ` `` Greater than: Pop a and b, then push 1 if b>a, otherwise push zero.
+- `>` Start moving right.
+- `<` Start moving left.
+- `^` Start moving up.
+- `v` Start moving down.
+- `?` Start moving in a random cardinal direction.
+- `_` Pop a value; move right if value = 0, left otherwise.
+- `|` Pop a value; move down if value = 0, up otherwise.
+- `"` Start string mode: push each character's ASCII value all the way up to the next ".
+- `:` Duplicate value on top of the stack. If there is nothing on top of the stack, push a 0.
+- `\` Swap two values on top of the stack. If there is only one value, pretend there is an extra 0 on bottom of the stack.
+- `$` Pop value from the stack and discard it.
+- `.` Pop value and output as an integer.
+- `,` Pop value and output the ASCII character represented by the integer code that is stored in the value.
+- `#` Trampoline: Skip next cell.
+- `p` A "put" call (a way to store a value for later use). Pop y, x and v, then change the character at the position (x,y) in the program to the character with ASCII value v.
+- `g` A "get" call (a way to retrieve data in storage). Pop y and x, then push ASCII value of the character at that position in the program.
+- `@` End program.
+- ` ` (i.e. a space) No-op. Does nothing.
+
+Here's an example:
+
+```
+>987v>.v
+v456<  :
+>321 ^ _@
+```
+
+will create the output `123456789`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/rohitpaulk/befunge-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/befunger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'befunger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "befunger"
+  spec.version       = Befunger::VERSION
+  spec.authors       = ["Paul Kuruvilla"]
+  spec.email         = ["rohitpaulk@live.com"]
+
+  spec.summary       = "A befunge interpreter"
+  spec.homepage      = "https://github.com/rohitpaulk/befunge-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "befunger"
+
+# 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/lib/befunger.rb

@@ -0,0 +1,18 @@
+require "befunger/interpreter"
+require "befunger/version"
+
+# Example usage:
+#
+# ```
+# code = ">987v>.v\nv456<  :\n>321 ^ _@\n"
+# output = Befunger.run(code)
+# ```
+module Befunger
+  # Runs befunge code and returns the output
+  #
+  # @param code [String] the code to be run, lines separated with newline characters.
+  # @return [String] output of the program
+  def self.run(code)
+    Befunger::Interpreter.new(code).run
+  end
+end

data/lib/befunger/interpreter.rb

@@ -0,0 +1,250 @@
+module Befunger
+  # {Befunger::Interpreter} is responsible for running Befunge code.
+  #
+  # The only input to the Interpreter is the code to be executed,
+  # passed in as a string. Lines are to be separated with the `\n`
+  # character.
+  #
+  # Example usage:
+  #
+  # ```
+  # output = Befunger::Interpreter.new(code_string).run
+  # ```
+  class Interpreter
+    # The Befunge code to be run, stored as a 2D array of characters.
+    #
+    # For a program like this:
+    #
+    # ```
+    # >987v>.v
+    # v456<  :
+    # >321 ^ _@
+    # ```
+    #
+    # `code_array` will look like:
+    #
+    # ```
+    # [
+    #   [">", "9", "8", "7", "v", ">", ".", "v"],
+    #   ["v", "4", "5", "6", "<", " ", " ", ":"],
+    #   [">", "3", "2", "1", " ", "^", " ", "_", "@"]
+    # ]
+    # ```
+    #
+    attr_reader :code_array
+
+    # Human friendly constants for the direction to move a code_pointer in.
+    DIRECTIONS = {
+      right: { x: 1, y: 0 },
+      down:  { x: 0, y: 1 },
+      left:  { x: -1, y: 0 },
+      up:    { x: 0, y: -1 }
+    }
+
+    # Default interpreter state.
+    #
+    # This gets copied and then modified and passed from instruction to instruction
+    # in the interpreter loop.
+    #
+    # - ## `code_pointer`
+    #
+    # Denotes what the position of the current instruction is.
+    #
+    # `x` and `y` are positive values starting at 0, calculated like this:
+    #
+    # ```
+    # .----------------------------------------------> x
+    # |
+    # |
+    # |
+    # |  (code_array)                  --------> {x: 5, y: 0}
+    # |                               |
+    # |  [                            |
+    # |
+    # |    [">", "9", "8", "7", "v", ">", ".", "v"],
+    # |
+    # |    ["v", "4", "5", "6", "<", " ", " ", ":"],
+    # |
+    # |    [">", "3", "2", "1", " ", "^", " ", "_", "@"]
+    # |
+    # |  ]                                           |
+    # |                                              |
+    # |                                               ------> {x: 8, y: 2}
+    # v
+    #
+    # y
+    #
+    # ```
+    #
+    # ## `code_direction`
+    #
+    # The next direction to move `code_pointer` in.
+    #
+    # `x` and `y` are either 0, 1, or -1.
+    #
+    # - (x: 1, y: 0) means the next move is towards the right
+    # - (x: 0, y: 1) means the next move is downwards
+    # - ... so on and so forth.
+    #
+    # Human-friendly constants available in {Interpreter::DIRECTIONS}.
+    #
+    # ## `stack`
+    #
+    # A stack to store values, manipulated by the befunge code being run.
+    #
+    # ## `output`
+    #
+    # Output returned from program, represented as an array of characters.
+    INITIAL_STATE = {
+      code_pointer: {x: 0, y: 0}, # Instructions are evaluated from the top-left
+      code_direction: Interpreter::DIRECTIONS[:right],
+      stack: [],
+      output: []
+    }
+
+    # @param code [String] the befunge code to be run. Lines must be separated with newline characters
+    def initialize(code)
+      @code_array = code.split("\n").map { |line| line.chars }
+    end
+
+    # @return [String] output of program execution
+    def run
+      state = Interpreter::INITIAL_STATE # TODO: `deep_dup`?
+
+      loop do
+        instruction = get_instruction(state[:code_pointer])
+
+        break if instruction == '@'
+
+        state = handle_instruction(instruction, state)
+      end
+
+      state[:output].join('')
+    end
+
+    private
+
+    # Returns the next instruction to be processed
+    #
+    # @param code_pointer [Hash] the current +code_pointer+, in the form: `{x: 0, y: 3}`
+    # @return [String] the next instruction to be processed
+    def get_instruction(code_pointer)
+      @code_array[code_pointer[:y]][code_pointer[:x]]
+    end
+
+    # Moves the `code_pointer` in the specified `code_direction`, and returns the modified
+    # `code_pointer`
+    #
+    # @param code_pointer [Hash] the current +code_pointer+, in the form: `{x: 0, y: 3}`
+    # @param code_direction [Hash] the current +code_direction+, in the form: `{x: 0, y: 1}`
+    # @return [Hash] the modified `code_pointer`
+    def move_pointer(code_pointer, code_direction)
+      code_pointer[:x] += code_direction[:x]
+      code_pointer[:y] += code_direction[:y]
+
+      code_pointer
+    end
+
+    # Given an `instruction` and `state` - processes the instruction and returns
+    # the modified `state`.
+    #
+    # @param instruction [String] the instruction to be executed
+    # @param state [Hash] the current interpreter state
+    # @return [Hash] the modified `state`
+    def handle_instruction(instruction, state)
+      output         = state[:output].dup
+      stack          = state[:stack].dup
+      code_pointer   = state[:code_pointer].dup
+      code_direction = state[:code_direction].dup
+
+      # Numbers
+      if ('0'..'9').include? instruction
+        stack.push(instruction.to_i)
+
+      # Binary Stack Operations
+      elsif ['+', '-', '*', '/', '%', '`'].include? instruction
+        a = stack.pop
+        b = stack.pop
+
+        value = case instruction
+          when '+' then b + a
+          when '*' then b * a
+          when '-' then b - a
+          when '/' then b / a
+          when '%' then b % a
+          when '`' then b > a ? 1 : 0
+        end
+
+        stack.push(value)
+
+      # Setter, Getter
+      elsif ['p', 'g'].include? instruction
+        y = stack.pop
+        x = stack.pop
+        case instruction
+        when 'p' then @code_array[y][x] = stack.pop.chr
+        when 'g' then stack.push @code_array[y][x].ord
+        end
+
+      # Operations with one stack value
+      elsif ['!', '$', '.', ','].include? instruction
+        a = stack.pop
+
+        case instruction
+        when '!' then stack.push(a == 0 ? 1 : 0)
+        when '.' then output.push(a)
+        when ',' then output.push(a.chr)
+        end
+
+      # Direction changes
+      elsif ['>', '<', 'v', '^', '?', '_', '|'].include? instruction
+        code_direction = case instruction
+        when '>' then DIRECTIONS[:right]
+        when '<' then DIRECTIONS[:left]
+        when 'v' then DIRECTIONS[:down]
+        when '^' then DIRECTIONS[:up]
+        when '?' then DIRECTIONS.values.sample
+        when '_' then DIRECTIONS[stack.pop == 0 ? :right : :left]
+        when '|' then DIRECTIONS[stack.pop == 0 ? :down : :up]
+        end
+
+      # String Mode
+      elsif instruction == '"'
+        code_pointer = move_pointer(code_pointer, code_direction) # Skip the first quote
+
+        loop do
+          instruction = get_instruction(code_pointer)
+          break if instruction == '"'
+          stack.push(instruction.ord)
+          code_pointer = move_pointer(code_pointer, code_direction)
+        end
+
+      # Swap
+      elsif instruction == '\\'
+        if stack.size == 1
+          stack.push(0)
+        else
+          stack[-1], stack[-2] = stack[-2], stack[-1]
+        end
+
+      # Duplicate
+      elsif instruction == ":"
+        stack.push(stack.empty? ? 0 : stack.last)
+
+      # Skip
+      elsif instruction == '#'
+        code_pointer = move_pointer(code_pointer, code_direction)
+
+      elsif instruction != ' '
+        raise "Invalid Instruction '#{instruction}'"
+      end
+
+      {
+        code_pointer: move_pointer(code_pointer, code_direction),
+        code_direction: code_direction,
+        stack: stack,
+        output: output
+      }
+    end
+  end
+end

data/lib/befunger/version.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: befunger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Kuruvilla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- rohitpaulk@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- befunger.gemspec
+- bin/console
+- bin/setup
+- lib/befunger.rb
+- lib/befunger/interpreter.rb
+- lib/befunger/version.rb
+homepage: https://github.com/rohitpaulk/befunge-ruby
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A befunge interpreter
+test_files: []