toy_robot 1.0.4

data/lib/toy_robot/roboto/speech.rb

@@ -0,0 +1,11 @@
+module ToyRobot
+  class Roboto
+    class Speech
+
+      def speak(something)
+        puts something
+      end
+
+    end
+  end
+end

data/lib/toy_robot/simulator.rb

@@ -0,0 +1,26 @@
+module ToyRobot
+  class Simulator
+
+    attr_reader :roboto, :table
+
+    def initialize(table_size: {x: 5, y: 5})
+      @roboto = Roboto.new
+      @table  = Table.new(table_size)
+      inform_roboto_about_table
+    end
+
+    def run(orders)
+      orders.each do |order|
+        understood = @roboto.understand_order(order)
+        @roboto.execute_order(understood)
+      end
+    end
+
+    private
+
+    def inform_roboto_about_table
+      @roboto.table_edges = @table.edges
+    end
+
+  end
+end

data/lib/toy_robot/table.rb

@@ -0,0 +1,27 @@
+module ToyRobot
+  class Table
+
+    attr_reader :roboto, :x, :y
+
+    def initialize(x:, y:)
+      @x = x
+      @y = y
+    end
+
+    # Returns a Hash with the limits for X and Y axis
+    def edges
+      { x: x_limits, y: y_limits }
+    end
+
+    # Returns a hash with min and max values for X based on initial value
+    def x_limits
+      { min: 0, max: @x-1 }
+    end
+
+    # Returns a hash with min and max values for Y based on initial value
+    def y_limits
+      { min: 0, max: @y-1 }
+    end
+
+  end
+end

data/lib/toy_robot/version.rb

@@ -0,0 +1,3 @@
+module ToyRobot
+  VERSION = '1.0.4'
+end

data/spec/bin/io_utils_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe ToyRobot::Bin::IOUtils do
+
+  let(:dummy_class) { Class.new { extend ToyRobot::Bin::IOUtils } }
+
+  before do
+    allow_any_instance_of(Object).to receive(:sleep)
+  end
+
+  describe '#print_with_delay' do
+
+    it 'prints a message' do
+      expect { dummy_class.print_with_delay('a message') }.to match_stdout('a message')
+    end
+
+    it 'has a default delay of 2 seconds' do
+      expect(dummy_class).to receive(:delay).with(2)
+      dummy_class.print_with_delay('a message')
+    end
+
+    it 'can have custom delay time' do
+      expect(dummy_class).to receive(:delay).with(5)
+      dummy_class.print_with_delay('a message', 5)
+    end
+
+  end
+
+  describe '#_print' do
+
+    it 'prints a message' do
+      expect { dummy_class._print('a message') }.to match_stdout('a message')
+    end
+
+  end
+
+  describe '#delay' do
+
+    it 'sleeps for desired time' do
+      expect(dummy_class).to receive(:sleep).with(3)
+      dummy_class.delay 3
+    end
+
+  end
+
+  describe '#yellow' do
+
+    it 'returns a yellowish string' do
+      expect(dummy_class.yellow('yellowish string')).to eq "\e[33myellowish string\e[0m"
+    end
+
+  end
+
+  describe '#green' do
+
+    it 'returns a greenish string' do
+      expect(dummy_class.green('greenish string')).to eq "\e[32mgreenish string\e[0m"
+    end
+
+  end
+
+  describe '#reddish' do
+
+    it 'returns a reddish string' do
+      expect(dummy_class.red('reddish string')).to eq "\e[31mreddish string\e[0m"
+    end
+
+  end
+
+end

data/spec/bin/runner_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe ToyRobot::Bin::Runner do
+
+  before do
+    allow_any_instance_of(Object).to receive(:puts)
+    allow(subject).to receive(:capture_input) { '1' }
+  end
+
+  it 'has a simulator' do
+    expect(subject.simulator).to be_an_instance_of(ToyRobot::Simulator)
+  end
+
+  it 'has a roboto' do
+    expect(subject.roboto).to be_an_instance_of(ToyRobot::Roboto)
+  end
+
+  it 'assigns roboto a random name' do
+    allow_any_instance_of(ToyRobot::Bin::Runner).to receive(:robots).and_return(['random name'])
+    subject = ToyRobot::Bin::Runner.new
+    expect(subject.roboto.name).to eq 'random name'
+  end
+
+  describe '#start' do
+
+    context 'checking prints' do
+
+      before do
+        allow(subject).to receive(:handle_selected_option)
+      end
+
+      it 'shows art' do
+        expect(subject).to receive(:show_art)
+        subject.start
+      end
+
+      it 'shows help' do
+        expect(subject).to receive(:show_help)
+        subject.start
+      end
+
+      it 'shows options' do
+        expect(subject).to receive(:show_options)
+        subject.start
+      end
+
+    end
+
+    it 'captures user option' do
+      allow(subject).to receive(:handle_selected_option)
+      subject.start
+      expect(subject.selected_option).to eq '1'
+    end
+
+    context 'handling selected option' do
+
+      context 'when 1' do
+
+        it 'inputs by hand' do
+          expect(subject).to receive(:input_by_hand)
+          subject.start
+        end
+        
+      end
+
+      context 'when 2' do
+
+        before do
+          allow(subject).to receive(:capture_input) { '2' }
+        end
+
+        it 'inputs from file' do
+          expect(subject).to receive(:input_from_file)
+          subject.start
+        end
+
+      end
+
+      context 'when else' do
+
+        before do
+          allow(subject).to receive(:capture_input) { '3' }
+          allow(subject).to receive(:show_art)
+          allow(subject).to receive(:show_help)
+          allow(subject).to receive(:show_options)
+        end
+
+        it 'prints termination message' do
+          expect(subject).to receive(:_print).with('Invalid option, terminating simulator.')
+          subject.start
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/fixtures/manifest_example.txt

@@ -0,0 +1,5 @@
+MOVE
+PLACE 1,2,NORTH
+LEFT
+RIGHT
+REPORT

data/spec/manifest_reader_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ToyRobot::ManifestReader do
+
+  describe '#read' do
+
+    it 'reads from a default file' do
+      subject = ToyRobot::ManifestReader.new
+      expect(subject.file).to be_a File
+    end
+
+    it 'reads from custom file' do
+      file_path = File.join(File.dirname(__FILE__), 'fixtures', 'manifest_example.txt')
+      subject = ToyRobot::ManifestReader.new(file_path: file_path)
+      expect(subject.file.path).to eq file_path
+    end
+
+    it 'returns an array with orders' do
+      subject = ToyRobot::ManifestReader.new(file_path: File.join(File.dirname(__FILE__), 'fixtures', 'manifest_example.txt'))
+      orders_array = [
+        'MOVE',
+        'PLACE 1,2,NORTH',
+        'LEFT',
+        'RIGHT',
+        'REPORT'
+      ]
+      expect(subject.read).to match_array(orders_array)
+    end
+
+  end
+
+end

data/spec/roboto/brain_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe ToyRobot::Roboto::Brain do
+
+  it 'has a motor cortex' do
+    expect(subject.motor_cortex).to be_an_instance_of(ToyRobot::Roboto::MotorCortex)
+  end
+
+  it 'has speech' do
+    expect(subject.speech).to be_an_instance_of(ToyRobot::Roboto::Speech)
+  end
+
+  it 'delegates speak to Speech' do
+    expect(subject.speech).to receive(:speak).with('something')
+    subject.speak('something')
+  end
+
+  describe '#understand_order' do
+
+    it 'understand order with bad input' do
+      expect(subject.understand_order(' PLACE   1,2,nORTH')).to eq({ command: :place, args: { x: 1, y: 2, f: :north} })
+    end
+
+    context 'when ordering placement' do
+
+      it 'sanitizes args' do
+        expect(subject.understand_order('PLACE 1,2,NORTH')[:args]).to eq({ x: 1, y: 2, f: :north})
+      end
+
+    end
+
+    
+
+  end
+
+end

data/spec/roboto/motor_cortex_spec.rb

@@ -0,0 +1,322 @@
+require 'spec_helper'
+
+describe ToyRobot::Roboto::MotorCortex do
+
+  it 'has a list of cardinal directions' do
+    expect(ToyRobot::Roboto::MotorCortex).to have_constant(:CARDINAL_DIRECTIONS)
+  end
+
+  it 'has a list of move directions' do
+    expect(ToyRobot::Roboto::MotorCortex).to have_constant(:MOVE)
+  end
+
+  describe '#reset' do
+
+    subject { ToyRobot::Roboto::MotorCortex.new(x: 2, y: 3, f: :north) }
+
+    it 'sets X, Y and forwarding direction' do
+      subject.reset(x: 1, y: 2, f: :south)
+      expect(subject.x).to eq 1
+      expect(subject.y).to eq 2
+      expect(subject.f).to eq :south
+    end
+
+    it 'raises an exception if cardinal direction is not recognized' do
+      expect { subject.reset(x: 1, y: 2, f: :southwest) }.to raise_error('southwest is not a recognized direction')
+    end
+
+  end
+
+  describe '#rotate_ccw' do
+
+    context 'when facing north' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :north) }
+
+      it 'rotates to west' do
+        subject.rotate_ccw
+        expect(subject.f).to eq :west
+      end
+
+    end
+
+    context 'when facing east' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :east) }
+
+      it 'rotates to north' do
+        subject.rotate_ccw
+        expect(subject.f).to eq :north
+      end
+
+    end
+
+    context 'when facing south' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :south) }
+
+      it 'rotates to east' do
+        subject.rotate_ccw
+        expect(subject.f).to eq :east
+      end
+
+    end
+
+    context 'when facing west' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :west) }
+
+      it 'rotates to south' do
+        subject.rotate_ccw
+        expect(subject.f).to eq :south
+      end
+
+    end
+
+  end
+
+  describe '#rotate_cw' do
+
+    context 'when facing north' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :north) }
+
+      it 'rotates to east' do
+        subject.rotate_cw
+        expect(subject.f).to eq :east
+      end
+
+    end
+
+    context 'when facing east' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :east) }
+
+      it 'rotates to south' do
+        subject.rotate_cw
+        expect(subject.f).to eq :south
+      end
+
+    end
+
+    context 'when facing south' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :south) }
+
+      it 'rotates to west' do
+        subject.rotate_cw
+        expect(subject.f).to eq :west
+      end
+
+    end
+
+    context 'when facing west' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(f: :west) }
+
+      it 'rotates to north' do
+        subject.rotate_cw
+        expect(subject.f).to eq :north
+      end
+
+    end
+
+  end
+
+  describe '#forward' do
+
+    context 'when facing north' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :north) }
+
+      it 'increases Y axis by one' do
+        subject.forward
+        expect(subject.y).to eq 2
+      end
+
+      it 'keeps X axis the same' do
+        subject.forward
+        expect(subject.x).to eq 1
+      end
+
+      it 'keeps forwarding direction the same' do
+        subject.forward
+        expect(subject.f).to eq :north
+      end
+
+    end
+
+    context 'when facing east' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :east) }
+
+      it 'increases X axis by one' do
+        subject.forward
+        expect(subject.x).to eq 2
+      end
+
+      it 'keeps Y axis the same' do
+        subject.forward
+        expect(subject.y).to eq 1
+      end
+
+      it 'keeps forwarding direction the same' do
+        subject.forward
+        expect(subject.f).to eq :east
+      end
+
+    end
+
+    context 'when facing south' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :south) }
+
+      it 'decreases Y axis by one' do
+        subject.forward
+        expect(subject.y).to eq 0
+      end
+
+      it 'keeps X axis the same' do
+        subject.forward
+        expect(subject.x).to eq 1
+      end
+
+      it 'keeps forwarding direction the same' do
+        subject.forward
+        expect(subject.f).to eq :south
+      end
+
+    end
+
+    context 'when facing west' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :west) }
+
+      it 'decreases X axis by one' do
+        subject.forward
+        expect(subject.x).to eq 0
+      end
+
+      it 'keeps Y axis the same' do
+        subject.forward
+        expect(subject.y).to eq 1
+      end
+
+      it 'keeps forwarding direction the same' do
+        subject.forward
+        expect(subject.f).to eq :west
+      end
+
+    end
+
+  end
+
+  describe '#forward_prediction' do
+
+    context 'when facing north' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :north) }
+
+      it 'increases Y axis by one' do
+        expect(subject.forward_prediction).to eq [1, 2]
+      end
+
+    end
+
+    context 'when facing east' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :east) }
+
+      it 'increases X axis by one' do
+        expect(subject.forward_prediction).to eq [2, 1]
+      end
+
+    end
+
+    context 'when facing south' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :south) }
+
+      it 'decreases Y axis by one' do
+        expect(subject.forward_prediction).to eq [1, 0]
+      end
+
+    end
+
+    context 'when facing west' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 1, y: 1, f: :west) }
+
+      it 'decreases X axis by one' do
+        expect(subject.forward_prediction).to eq [0, 1]
+      end
+
+    end
+
+  end
+
+  describe '#to_s' do
+
+    subject { ToyRobot::Roboto::MotorCortex.new(x: 3, y: 6, f: :north) }
+
+    it 'returns a formated string with axis and forwarding direction' do
+      expect(subject.to_s).to eq 'X: 3, Y: 6, F: north'
+    end
+
+    context 'when X is nil' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: nil, y: 6, f: :north) }
+
+      it 'says N/A' do
+        expect(subject.to_s).to eq 'X: N/A, Y: 6, F: north'
+      end
+
+    end
+
+    context 'when Y is nil' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 2, y: nil, f: :north) }
+
+      it 'says N/A' do
+        expect(subject.to_s).to eq 'X: 2, Y: N/A, F: north'
+      end
+
+    end
+
+    context 'when F is nil' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 2, y: 3, f: nil) }
+
+      it 'says N/A' do
+        expect(subject.to_s).to eq 'X: 2, Y: 3, F: N/A'
+      end
+
+    end
+
+  end
+
+  describe '#nil?' do
+
+    context 'when X, Y and F are present' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 3, y: 6, f: :north) }
+
+      it 'returns false' do
+        expect(subject.nil?).to be_falsy
+      end
+
+    end
+
+    context 'when X or Y or F are nil' do
+
+      subject { ToyRobot::Roboto::MotorCortex.new(x: 3, y: nil, f: :north) }
+
+      it 'returns true' do
+        expect(subject.nil?).to be_truthy
+      end
+
+    end
+
+  end
+
+end