loco_bot 1.0.0

data/spec/loco_bot/robot/direction/east_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe LocoBot::Robot::Direction::East do
+  describe '.left' do
+    subject { described_class.left }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::North }
+  end
+
+  describe '.right' do
+    subject { described_class.right }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::South }
+  end
+
+  describe '.label' do
+    subject { described_class.label }
+
+    it { is_expected.to eql 'EAST' }
+  end
+
+  describe '.coordinates' do
+    subject { described_class.coordinates(21, 17) }
+
+    it { is_expected.to eql({ x: 22, y: 17 }) }
+  end
+end

data/spec/loco_bot/robot/direction/north_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe LocoBot::Robot::Direction::North do
+  describe '.left' do
+    subject { described_class.left }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::West }
+  end
+
+  describe '.right' do
+    subject { described_class.right }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::East }
+  end
+
+  describe '.label' do
+    subject { described_class.label }
+
+    it { is_expected.to eql 'NORTH' }
+  end
+
+  describe '.coordinates' do
+    subject { described_class.coordinates(21, 17) }
+
+    it { is_expected.to eql({ x: 21, y: 18 }) }
+  end
+end

data/spec/loco_bot/robot/direction/south_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe LocoBot::Robot::Direction::South do
+  describe '.left' do
+    subject { described_class.left }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::East }
+  end
+
+  describe '.right' do
+    subject { described_class.right }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::West }
+  end
+
+  describe '.label' do
+    subject { described_class.label }
+
+    it { is_expected.to eql 'SOUTH' }
+  end
+
+  describe '.coordinates' do
+    subject { described_class.coordinates(21, 17) }
+
+    it { is_expected.to eql({ x: 21, y: 16 }) }
+  end
+end

data/spec/loco_bot/robot/direction/west_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe LocoBot::Robot::Direction::West do
+  describe '.left' do
+    subject { described_class.left }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::South }
+  end
+
+  describe '.right' do
+    subject { described_class.right }
+
+    it { is_expected.to eql LocoBot::Robot::Direction::North }
+  end
+
+  describe '.label' do
+    subject { described_class.label }
+
+    it { is_expected.to eql 'WEST' }
+  end
+
+  describe '.coordinates' do
+    subject { described_class.coordinates(21, 17) }
+
+    it { is_expected.to eql({ x: 20, y: 17 }) }
+  end
+end

data/spec/loco_bot/robot/direction_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe LocoBot::Robot::Direction do
+  describe '.list' do
+    subject { described_class.list }
+
+    it { is_expected.to eql ['East', 'North', 'South', 'West'] }
+  end
+
+  describe '.from_name' do
+    subject { described_class.from_name(direction) }
+
+    context 'passing :north' do
+      let(:direction) { :north }
+
+      it { is_expected.to eql LocoBot::Robot::Direction::North }
+    end
+
+    context 'passing :east' do
+      let(:direction) { :east }
+
+      it { is_expected.to eql LocoBot::Robot::Direction::East }
+    end
+
+    context 'passing :south' do
+      let(:direction) { :south }
+
+      it { is_expected.to eql LocoBot::Robot::Direction::South }
+    end
+
+    context 'passing :west' do
+      let(:direction) { :west }
+
+      it { is_expected.to eql LocoBot::Robot::Direction::West }
+    end
+  end
+end

data/spec/loco_bot/robot_spec.rb

@@ -0,0 +1,247 @@
+RSpec.describe LocoBot::Robot do
+  let(:robot) { described_class.new }
+  let(:table) { LocoBot::Table.new(20, 20) }
+
+  describe '#place' do
+    subject { robot }
+
+    it 'calls Table#place_robot' do
+      expect(table).to receive(:place_robot).with(subject, 9, 3, LocoBot::Robot::Direction::East).once
+
+      subject.place(table, 9, 3, LocoBot::Robot::Direction::East)
+    end
+  end
+
+  describe '#remove' do
+    subject { robot.remove }
+
+    context 'when placed on a table' do
+      before { robot.place(table, 6, 17, LocoBot::Robot::Direction::East)  }
+
+      it 'calls Table#remove_robot' do
+        expect(table).to receive(:remove_robot).with(robot).once
+
+        subject
+      end
+    end
+
+    context 'when not placed on a table' do
+      it { expect(subject).to be false }
+    end
+  end
+
+  describe '#move' do
+    subject { robot }
+
+    before { robot.place(table, x, y, direction) }
+
+    context 'facing north' do
+      let(:direction) { LocoBot::Robot::Direction::North }
+      let(:x) { 10 }
+
+      context 'when movement is possible' do
+        let(:y) { 0 }
+
+        it 'moves north' do
+          expect { subject.move }.to change { subject.y }.to(1)
+          expect { subject.move }.not_to change { subject.x }
+        end
+      end
+
+      context 'when movement is not possible' do
+        let(:y) { 19 }
+
+        it 'does not move' do
+          expect { subject.move }.not_to change { subject.x }
+          expect { subject.move }.not_to change { subject.y }
+        end
+      end
+    end
+
+    context 'facing south' do
+      let(:direction) { LocoBot::Robot::Direction::South }
+      let(:x) { 10 }
+
+      context 'when movement is possible' do
+        let(:y) { 19 }
+
+        it 'moves south' do
+          expect { subject.move }.to change { subject.y }.to(18)
+          expect { subject.move }.not_to change { subject.x }
+        end
+      end
+
+      context 'when movement is not possible' do
+        let(:y) { 0 }
+
+        it 'does not move' do
+          expect { subject.move }.not_to change { subject.x }
+          expect { subject.move }.not_to change { subject.y }
+        end
+      end
+    end
+
+    context 'facing east' do
+      let(:direction) { LocoBot::Robot::Direction::East }
+      let(:y) { 10 }
+
+      context 'when movement is possible' do
+        let(:x) { 0 }
+
+        it 'moves east' do
+          expect { subject.move }.to change { subject.x }.to(1)
+          expect { subject.move }.not_to change { subject.y }
+        end
+      end
+
+      context 'when movement is not possible' do
+        let(:x) { 19 }
+
+        it 'does not move' do
+          expect { subject.move }.not_to change { subject.x }
+          expect { subject.move }.not_to change { subject.y }
+        end
+      end
+    end
+
+    context 'facing west' do
+      let(:direction) { LocoBot::Robot::Direction::West }
+      let(:y) { 10 }
+
+      context 'when movement is possible' do
+        let(:x) { 19 }
+
+        it 'moves west' do
+          expect { subject.move }.to change { subject.x }.to(18)
+          expect { subject.move }.not_to change { subject.y }
+        end
+      end
+
+      context 'when movement is not possible' do
+        let(:x) { 0 }
+
+        it 'does not move' do
+          expect { subject.move }.not_to change { subject.x }
+          expect { subject.move }.not_to change { subject.y }
+        end
+      end
+    end
+  end
+
+  describe '#turn_left' do
+    subject { robot }
+
+    before { subject.place(table, 10, 10, direction) }
+
+    context 'facing north' do
+      let(:direction) { LocoBot::Robot::Direction::North }
+
+      it { expect { subject.turn_left }.to change { subject.direction }.to LocoBot::Robot::Direction::West }
+    end
+
+    context 'facing south' do
+      let(:direction) { LocoBot::Robot::Direction::South }
+
+      it { expect { subject.turn_left }.to change { subject.direction }.to LocoBot::Robot::Direction::East }
+    end
+
+    context 'facing east' do
+      let(:direction) { LocoBot::Robot::Direction::East }
+
+      it { expect { subject.turn_left }.to change { subject.direction }.to LocoBot::Robot::Direction::North }
+    end
+
+    context 'facing west' do
+      let(:direction) { LocoBot::Robot::Direction::West }
+
+      it { expect { subject.turn_left }.to change { subject.direction }.to LocoBot::Robot::Direction::South }
+    end
+  end
+
+  describe '#turn_right' do
+    subject { robot }
+
+    before { subject.place(table, 10, 10, direction) }
+
+    context 'facing north' do
+      let(:direction) { LocoBot::Robot::Direction::North }
+
+      it { expect { subject.turn_right }.to change { subject.direction }.to LocoBot::Robot::Direction::East }
+    end
+
+    context 'facing south' do
+      let(:direction) { LocoBot::Robot::Direction::South }
+
+      it { expect { subject.turn_right }.to change { subject.direction }.to LocoBot::Robot::Direction::West }
+    end
+
+    context 'facing east' do
+      let(:direction) { LocoBot::Robot::Direction::East }
+
+      it { expect { subject.turn_right }.to change { subject.direction }.to LocoBot::Robot::Direction::South }
+    end
+
+    context 'facing west' do
+      let(:direction) { LocoBot::Robot::Direction::West }
+
+      it { expect { subject.turn_right }.to change { subject.direction }.to LocoBot::Robot::Direction::North }
+    end
+  end
+
+  describe '#report' do
+    subject { robot.report }
+
+    context 'when placed on a table' do
+      before { robot.place(table, 6, 17, LocoBot::Robot::Direction::East)  }
+
+      it { is_expected.to eql({x: 6, y: 17, direction: LocoBot::Robot::Direction::East}) }
+    end
+
+    context 'when not placed on a table' do
+      it 'returns an empty Hash' do
+        expect(subject).to be_a Hash
+        expect(subject).to be_empty
+      end
+    end
+  end
+
+  describe '#hodor!' do
+    it { expect { robot.hodor! }.to output("HODOR HODOR !\n").to_stdout }
+  end
+
+  describe '#next_position' do
+    subject { robot.next_position }
+
+    context 'when not placed on a table' do
+      it { is_expected.to eql({}) }
+    end
+
+    context 'when placed on a table' do
+      before { robot.place(table, 10, 10, direction) }
+
+      context 'facing north' do
+        let(:direction) { LocoBot::Robot::Direction::North }
+
+        it { is_expected.to eql({x: 10, y: 11}) }
+      end
+
+      context 'facing south' do
+        let(:direction) { LocoBot::Robot::Direction::South }
+
+        it { is_expected.to eql({x: 10, y: 9}) }
+      end
+
+      context 'facing east' do
+        let(:direction) { LocoBot::Robot::Direction::East }
+
+        it { is_expected.to eql({x: 11, y: 10}) }
+      end
+
+      context 'facing west' do
+        let(:direction) { LocoBot::Robot::Direction::West }
+
+        it { is_expected.to eql({x: 9, y: 10}) }
+      end
+    end
+  end
+end

data/spec/loco_bot/table_spec.rb

@@ -0,0 +1,197 @@
+RSpec.describe LocoBot::Table do
+  describe '#initialize' do
+    subject { described_class.new(width, height) }
+    let(:width) { 8 }
+    let(:height) { 3 }
+
+    it { expect(subject.width).to eql 8 }
+    it { expect(subject.height).to eql 3 }
+    it { expect(subject.robots).to be_empty }
+
+    context 'with an invalid width' do
+      let(:width) { 0 }
+
+      it { expect{ subject }.to(raise_error(ArgumentError)) }
+    end
+
+    context 'with an invalid height' do
+      let(:height) { -5 }
+
+      it { expect{ subject }.to(raise_error(ArgumentError)) }
+    end
+
+    context 'with an invalid width and height' do
+      let(:width) { -16 }
+      let(:height) { 0 }
+
+      it { expect{ subject }.to(raise_error(ArgumentError)) }
+    end
+  end
+
+  describe '#place_robot' do
+    let(:table) { described_class.new(15, 15) }
+    let(:other_table) { described_class.new(10, 10) }
+    let(:robot) { LocoBot::Robot.new }
+
+    before { other_table.place_robot(robot, 5, 7, LocoBot::Robot::Direction::West) }
+
+    context 'with a valid position' do
+      it 'modifies the robot lists' do
+        expect(other_table.robots).to include(robot)
+        expect(table.robots).not_to include(robot)
+
+        table.place_robot(robot, 12, 14, LocoBot::Robot::Direction::South)
+
+        expect(other_table.robots).not_to include(robot)
+        expect(table.robots).to include(robot)
+      end
+
+      it 'changes the robot table, x, y and position' do
+        expect(robot.table).to eql other_table
+        expect(robot.x).to eql 5
+        expect(robot.y).to eql 7
+        expect(robot.direction).to eql LocoBot::Robot::Direction::West
+
+        table.place_robot(robot, 12, 14, LocoBot::Robot::Direction::South)
+
+        expect(robot.table).to eql table
+        expect(robot.x).to eql 12
+        expect(robot.y).to eql 14
+        expect(robot.direction).to eql LocoBot::Robot::Direction::South
+      end
+
+      it { expect(table.place_robot(robot, 12, 14, LocoBot::Robot::Direction::South)).to be true }
+    end
+
+    context 'with an invalid position' do
+      it 'does not modify the robot lists' do
+        expect(other_table.robots).to include(robot)
+        expect(table.robots).not_to include(robot)
+
+        table.place_robot(robot, 617, 9001, LocoBot::Robot::Direction::South)
+
+        expect(other_table.robots).to include(robot)
+        expect(table.robots).not_to include(robot)
+      end
+
+      it 'does not change the robot table, x, y and position' do
+        expect(robot.table).to eql other_table
+        expect(robot.x).to eql 5
+        expect(robot.y).to eql 7
+        expect(robot.direction).to eql LocoBot::Robot::Direction::West
+
+        table.place_robot(robot, 617, 9001, LocoBot::Robot::Direction::South)
+
+        expect(robot.table).to eql other_table
+        expect(robot.x).to eql 5
+        expect(robot.y).to eql 7
+        expect(robot.direction).to eql LocoBot::Robot::Direction::West
+      end
+
+      it { expect(table.place_robot(robot, 617, 9001, LocoBot::Robot::Direction::South)).to be false }
+    end
+  end
+
+  describe '#remove_robot' do
+    let(:table) { described_class.new(10, 10) }
+    let(:robot) { LocoBot::Robot.new }
+
+    before do
+      table.place_robot(LocoBot::Robot.new, 3, 4, LocoBot::Robot::Direction::North)
+      table.place_robot(LocoBot::Robot.new, 1, 8, LocoBot::Robot::Direction::West)
+      LocoBot::Table.new.place_robot(robot, 1, 3, LocoBot::Robot::Direction::South)
+    end
+
+    context 'with a robot on another table' do
+      let(:other_table) { described_class.new(20, 20) }
+
+      before do
+        other_table.place_robot(robot, 1, 3, LocoBot::Robot::Direction::South)
+      end
+
+      it 'does not modify the robot list' do
+        expect(table.robots.count).to eql 2
+        expect(table.robots).not_to include(robot)
+
+        table.remove_robot(robot)
+
+        expect(table.robots.count).to eql 2
+        expect(table.robots).not_to include(robot)
+      end
+
+      it 'does not set to nil robot table, x, y and direction' do
+        expect(robot.table).to eql other_table
+        expect(robot.x).to eql 1
+        expect(robot.y).to eql 3
+        expect(robot.direction).to eql LocoBot::Robot::Direction::South
+
+        table.remove_robot(robot)
+
+        expect(robot.table).to eql other_table
+        expect(robot.x).to eql 1
+        expect(robot.y).to eql 3
+        expect(robot.direction).to eql LocoBot::Robot::Direction::South
+      end
+
+      it { expect(table.remove_robot(robot)).to be false }
+    end
+
+    context 'with the robot on the table' do
+      before { table.place_robot(robot, 5, 3, LocoBot::Robot::Direction::East) }
+
+      it 'removes the robot from the list' do
+        expect(table.robots.count).to eql 3
+        expect(table.robots).to include(robot)
+
+        table.remove_robot(robot)
+
+        expect(table.robots.count).to eql 2
+        expect(table.robots).not_to include(robot)
+      end
+
+      it 'sets to nil robot table, x, y and direction' do
+        expect(robot.table).to eql table
+        expect(robot.x).to eql 5
+        expect(robot.y).to eql 3
+        expect(robot.direction).to eql LocoBot::Robot::Direction::East
+
+        table.remove_robot(robot)
+
+        expect(robot.table).to be_nil
+        expect(robot.x).to be_nil
+        expect(robot.y).to be_nil
+        expect(robot.direction).to be_nil
+      end
+
+      it { expect(table.remove_robot(robot)).to be true }
+    end
+  end
+
+  describe '#position_valid?' do
+    subject { table.position_valid?(x, y) }
+    let(:table) { described_class.new(10, 5) }
+
+    context 'with an out of bounds position' do
+      let(:x) { 5 }
+      let(:y) { 6 }
+
+      it { is_expected.to be false }
+    end
+
+    context 'with an occupied position' do
+      let(:x) { 2 }
+      let(:y) { 3 }
+
+      before { table.place_robot(LocoBot::Robot.new, 2, 3, LocoBot::Robot::Direction::North) }
+
+      it { is_expected.to be false }
+    end
+
+    context 'with a free position within bounds' do
+      let(:x) { 3 }
+      let(:y) { 1 }
+
+      it { is_expected.to be true }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require 'loco_bot'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+end

data/spec/support/test_1.txt

@@ -0,0 +1,3 @@
+PLACE 0,0,NORTH
+MOVE
+REPORT

data/spec/support/test_2.txt

@@ -0,0 +1,3 @@
+PLACE 0,0,NORTH
+LEFT
+REPORT

data/spec/support/test_3.txt

@@ -0,0 +1,6 @@
+PLACE 1,2,EAST
+MOVE
+MOVE
+LEFT
+MOVE
+REPORT

data/spec/support/test_4.txt

@@ -0,0 +1,28 @@
+PLACE 4,4,NORTH
+MOVE
+MOVE
+RIGHT
+MOVE
+REPORT
+
+RIGHT
+MOVE
+MOVE
+RIGHT
+MOVE
+MOVE
+LEFT
+MOVE
+REPORT
+
+PLACE 1,6,WEST
+REPORT
+
+PLACE 1,4,WEST
+MOVE
+MOVE
+LEFT
+MOVE
+LEFT
+MOVE
+REPORT