whitespace-ruby 1.0.0

data/lib/whitespace/version.rb

@@ -0,0 +1,3 @@
+module Whitespace
+  VERSION = "1.0.0"
+end

data/lib/whitespace/vm.rb

@@ -0,0 +1,44 @@
+require_relative "data_structures/console"
+require_relative "data_structures/counter"
+require_relative "data_structures/memory"
+require_relative "data_structures/stack"
+
+module Whitespace
+  class VM
+    attr_reader :instructions, :vstack, :cstack, :memory, :pc
+
+    def initialize
+      @instructions = []
+      reset
+    end
+
+    def load(instructions)
+      @instructions = Array(instructions)
+    end
+
+    def run
+      reset
+
+      loop do
+        instruction = instructions.fetch pc
+        pc.increment
+        execute instruction
+      end
+    end
+
+    private
+
+    def reset
+      @vstack = Stack.new   # a value stack
+      @cstack = Stack.new   # a call stack
+      @memory = Memory.new  # heap memory
+      @pc     = Counter.new # program counter
+    end
+
+    def execute(instruction)
+      instruction.execute
+    rescue Halt
+      raise StopIteration
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "pry-byebug"
+require "whitespace"
+
+require "minitest/autorun"

data/test/whitespace/data_structures/console_test.rb

@@ -0,0 +1,113 @@
+require "test_helper"
+
+module Whitespace
+  describe Console do
+    before do
+      @stdin = Object.new
+    end
+
+    describe "#printc" do
+      describe "when given an ASCII character" do
+        it "prints it" do
+          expect { Console.new.printc 65 }.must_output("A")
+        end
+      end
+
+      describe "when not given an ASCII character" do
+        it "raises ArgumentError" do
+          e = expect { Console.new.printc 0 }.must_raise ArgumentError
+          expect(e.message).must_match /must be an ASCII character: 0/
+        end
+      end
+    end
+
+    describe "#printn" do
+      describe "when given an integer" do
+        it "prints it" do
+          expect { Console.new.printn 65 }.must_output("65")
+        end
+      end
+
+      describe "when not given an integer" do
+        it "raises ArgumentError" do
+          e = expect { Console.new.printn :x }.must_raise ArgumentError
+          expect(e.message).must_match /must be an integer/
+        end
+      end
+    end
+
+    describe "#getc" do
+      describe "when given an ASCII character" do
+        it "gets it" do
+          def @stdin.getc
+            "A"
+          end
+
+          expect(Console.new(stdin: @stdin).getc).must_equal "A"
+        end
+      end
+
+      describe "when not given an ASCII character" do
+        describe "when there is a character" do
+          it "raises ArgumentError" do
+            def @stdin.getc
+              "\a"
+            end
+
+            e = expect { Console.new(stdin: @stdin).getc }.must_raise ArgumentError
+            expect(e.message).must_match /must be an ASCII character/
+          end
+        end
+
+        describe "when EOF" do
+          it "raises ArgumentError" do
+            def @stdin.getc
+            end
+
+            e = expect { Console.new(stdin: @stdin).getc }.must_raise ArgumentError
+            expect(e.message).must_match /must be an ASCII character: EOF/
+          end
+        end
+      end
+    end
+
+    describe "#getn" do
+      describe "when given an integer" do
+        it "gets it" do
+          def @stdin.getc
+            @chars = ["1", "2", "3"]
+            @i ||= 0
+
+            @i += 1
+            @chars[@i - 1]
+          end
+
+          expect(Console.new(stdin: @stdin).getn).must_equal 123
+        end
+      end
+
+      describe "when not given an integer" do
+        describe "when there is at least one character" do
+          it "raises ArgumentError" do
+            def @stdin.getc
+              "\n"
+            end
+
+            e = expect { Console.new(stdin: @stdin).getn }.must_raise ArgumentError
+            expect(e.message).must_match /must be an integer: /
+          end
+        end
+
+        describe "when EOF" do
+          it "raises ArgumentError" do
+            def @stdin.getc
+            end
+
+            e = expect { Console.new(stdin: @stdin).getn }.must_raise ArgumentError
+            expect(e.message).must_match /must be an integer: EOF/
+          end
+        end
+      end
+    end
+  end
+end

data/test/whitespace/data_structures/counter_test.rb

@@ -0,0 +1,37 @@
+require "test_helper"
+
+module Whitespace
+  describe Counter do
+    before do
+      @counter = Counter.new
+    end
+
+    it "is initially 0" do
+      expect(@counter.to_int).must_equal 0
+    end
+
+    describe "#increment" do
+      it "increases its value by 1" do
+        @counter.increment
+
+        expect(@counter.to_int).must_equal 1
+      end
+    end
+
+    describe "#change_to" do
+      describe "when the value is non-negative" do
+        it "changes the counter's value to the given value" do
+          @counter.change_to 5
+
+          expect(@counter.to_int).must_equal 5
+        end
+      end
+
+      describe "when the value is negative" do
+        it "raises ArgumentError" do
+          expect { @counter.change_to -1 }.must_raise ArgumentError
+        end
+      end
+    end
+  end
+end

data/test/whitespace/data_structures/memory_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+module Whitespace
+  describe Memory do
+    before do
+      @memory = Memory.new
+    end
+
+    describe "how values are accessed" do
+      describe "when the given address exists" do
+        it "returns the value" do
+          @memory[:address] = :value
+
+          expect(@memory[:address]).must_equal :value
+        end
+      end
+
+      describe "when the given address does not exist" do
+        it "raises Whitespace::AddressError" do
+          expect { @memory[:address] }.must_raise AddressError
+        end
+      end
+    end
+  end
+end

data/test/whitespace/data_structures/stack_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+module Whitespace
+  describe Stack do
+    before do
+      @stack = Stack.new
+    end
+
+    describe "#push" do
+      it "places an element on top the stack" do
+        @stack.push :a
+        @stack.push :b
+
+        expect(@stack.top).must_equal :b
+      end
+    end
+
+    describe "#pop" do
+      describe "when the stack is empty" do
+        it "raises Whitespace::EmptyError" do
+          expect { @stack.pop }.must_raise EmptyError
+        end
+      end
+
+      describe "when the stack is not empty" do
+        it "removes and returns the top element" do
+          @stack.push :a
+          @stack.push :b
+
+          expect(@stack.pop).must_equal :b
+          expect(@stack.top).must_equal :a
+        end
+      end
+    end
+
+    describe "#top" do
+      describe "when the stack is empty" do
+        it "raises Whitespace::EmptyError" do
+          expect { @stack.top }.must_raise EmptyError
+        end
+      end
+
+      describe "when the stack is not empty" do
+        it "returns the top element" do
+          @stack.push :a
+          expect(@stack.top).must_equal :a
+        end
+      end
+    end
+
+    describe "#size" do
+      it "returns the number of elements on the stack" do
+        expect(@stack.size).must_equal 0
+
+        @stack.push :a
+        @stack.push :b
+        @stack.push :c
+
+        expect(@stack.size).must_equal 3
+      end
+    end
+  end
+end

data/test/whitespace/instructions/arithmetic/add_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+
+module Whitespace::ISA
+  describe Add do
+    before do
+      @vm = Whitespace::VM.new
+    end
+
+    describe "#execute" do
+      describe "when the value stack is empty" do
+        it "raises Whitespace::EmptyError" do
+          expect(@vm.vstack.size).must_equal 0
+
+          expect { Add.new(@vm).execute }.must_raise Whitespace::EmptyError
+        end
+      end
+
+      describe "when the value stack has one element" do
+        it "raises Whitespace::EmptyError" do
+          @vm.vstack.push 1
+          expect(@vm.vstack.size).must_equal 1
+
+          expect { Add.new(@vm).execute }.must_raise Whitespace::EmptyError
+        end
+      end
+
+      describe "when the value stack has at least 2 elements" do
+        it "replaces the top 2 elements with their sum" do
+          @vm.vstack.push 1
+          @vm.vstack.push 2
+          @vm.vstack.push 3
+          expect(@vm.vstack.size).must_equal 3
+
+          Add.new(@vm).execute
+
+          expect(@vm.vstack.pop).must_equal 5
+          expect(@vm.vstack.pop).must_equal 1
+          expect(@vm.vstack.size).must_equal 0
+        end
+      end
+    end
+  end
+end

data/test/whitespace/instructions/arithmetic/div_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+
+module Whitespace::ISA
+  describe Div do
+    before do
+      @vm = Whitespace::VM.new
+    end
+
+    describe "#execute" do
+      describe "when the value stack is empty" do
+        it "raises Whitespace::EmptyError" do
+          expect(@vm.vstack.size).must_equal 0
+
+          expect { Div.new(@vm).execute }.must_raise Whitespace::EmptyError
+        end
+      end
+
+      describe "when the value stack has one element" do
+        it "raises Whitespace::EmptyError" do
+          @vm.vstack.push 1
+          expect(@vm.vstack.size).must_equal 1
+
+          expect { Div.new(@vm).execute }.must_raise Whitespace::EmptyError
+        end
+      end
+
+      describe "when the value stack has at least 2 elements" do
+        it "replaces the top 2 elements with their quotient" do
+          @vm.vstack.push 1
+          @vm.vstack.push 6
+          @vm.vstack.push 2
+          expect(@vm.vstack.size).must_equal 3
+
+          Div.new(@vm).execute
+
+          expect(@vm.vstack.pop).must_equal 3
+          expect(@vm.vstack.pop).must_equal 1
+          expect(@vm.vstack.size).must_equal 0
+        end
+      end
+
+      describe "division by 0" do
+        it "raises ZeroDivisionError" do
+          @vm.vstack.push 1
+          @vm.vstack.push 0
+
+          expect { Div.new(@vm).execute }.must_raise ZeroDivisionError
+        end
+      end
+    end
+  end
+end

data/test/whitespace/instructions/arithmetic/mod_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+
+module Whitespace::ISA
+  describe Mod do
+    before do
+      @vm = Whitespace::VM.new
+    end
+
+    describe "#execute" do
+      describe "when the value stack is empty" do
+        it "raises Whitespace::EmptyError" do
+          expect(@vm.vstack.size).must_equal 0
+
+          expect { Mod.new(@vm).execute }.must_raise Whitespace::EmptyError
+        end
+      end
+
+      describe "when the value stack has one element" do
+        it "raises Whitespace::EmptyError" do
+          @vm.vstack.push 1
+          expect(@vm.vstack.size).must_equal 1
+
+          expect { Mod.new(@vm).execute }.must_raise Whitespace::EmptyError
+        end
+      end
+
+      describe "when the value stack has at least 2 elements" do
+        it "replaces the top 2 elements with their remainder" do
+          @vm.vstack.push 1
+          @vm.vstack.push 5
+          @vm.vstack.push 3
+          expect(@vm.vstack.size).must_equal 3
+
+          Mod.new(@vm).execute
+
+          expect(@vm.vstack.pop).must_equal 2
+          expect(@vm.vstack.pop).must_equal 1
+          expect(@vm.vstack.size).must_equal 0
+        end
+      end
+
+      describe "modulo 0" do
+        it "raises ZeroDivisionError" do
+          @vm.vstack.push 1
+          @vm.vstack.push 0
+
+          expect { Mod.new(@vm).execute }.must_raise ZeroDivisionError
+        end
+      end
+    end
+  end
+end