robodog 0.0.1

data/spec/orientation_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../lib/robo_dog/pose/orientation'
+
+RSpec.describe RoboDog::Pose::Orientation do
+  describe 'the public interface' do
+    it { expect(described_class).to respond_to :constantize, :stringify }
+  end
+
+  describe '.constantize' do
+    shared_examples 'a constantizer' do |string, expect_constant|
+      subject { described_class.constantize(string) }
+
+      it 'returns the correct constant' do
+        is_expected.to eql expect_constant
+      end
+    end
+
+    it_behaves_like 'a constantizer', 'N', described_class::NORTH
+    it_behaves_like 'a constantizer', 'E', described_class::EAST
+    it_behaves_like 'a constantizer', 'S', described_class::SOUTH
+    it_behaves_like 'a constantizer', 'W', described_class::WEST
+  end
+
+  describe '.stringify' do
+    shared_examples 'a stringifier' do |constant, expected_string|
+      subject { described_class.stringify(constant) }
+
+      it 'returns the correct constant' do
+        is_expected.to eql expected_string
+      end
+    end
+
+    it_behaves_like 'a stringifier', described_class::NORTH, 'N'
+    it_behaves_like 'a stringifier', described_class::EAST, 'E'
+    it_behaves_like 'a stringifier', described_class::SOUTH, 'S'
+    it_behaves_like 'a stringifier', described_class::WEST, 'W'
+  end
+end

data/spec/paddock_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../lib/robo_dog/paddock'
+
+RSpec.describe RoboDog::Paddock do
+  describe 'the public interface' do
+    it { expect(described_class).to respond_to :build }
+
+    subject{ described_class.new }
+    it { is_expected.to respond_to :valid_coordinates? }
+  end
+
+  describe '.build' do
+    context 'with invalid data' do
+      let(:data) { '1' }
+      it 'screams at you' do
+        expect { described_class.build(data) }.to raise_exception described_class::DataError
+      end
+    end
+    context 'with valid data' do
+      let(:data) { '4 3'}
+      it 'returns a paddock instance' do
+        expect(described_class.build(data)).to be_instance_of described_class
+      end
+      it 'builds with correct x size' do
+        expect(described_class.build(data).instance_variable_get(:@x_size)).to eql 4
+      end
+      it 'builds with correct y size' do
+        expect(described_class.build(data).instance_variable_get(:@y_size)).to eql 3
+      end
+    end
+  end
+
+  let(:paddock) { described_class.new(5, 5) }
+
+  describe '#valid_coordinates?' do
+    context 'with coordinates within paddock' do
+      it 'returns truthy' do
+        [[0,0],[5,5],[2,4]].each do |coordinates|
+          expect(paddock.valid_coordinates?(x: coordinates[0], y: coordinates[1])).to be_truthy
+        end
+      end
+    end
+    context 'with coordinates outside of paddock' do
+      it 'returns falsy' do
+        [[-1,0],[6,5],[7,7]].each do |coordinates|
+          expect(paddock.valid_coordinates?(x: coordinates[0], y: coordinates[1])).to be_falsy
+        end
+      end
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,74 @@
+require_relative '../lib/robo_dog/parser'
+require 'stringio'
+
+RSpec.describe RoboDog::Parser do
+  describe 'the public interface' do
+    it { expect(described_class).to respond_to :parse }
+  end
+
+  describe '.parse' do
+    shared_examples 'a complaining parser' do |input_string|
+      it 'screams at you' do
+        str_io = StringIO.new(input_string)
+        expect { described_class.parse(str_io) }.to raise_exception described_class::DataError
+      end
+    end
+
+    context 'with invalid input data' do
+      context 'with no data' do
+        it_behaves_like 'a complaining parser',
+                        ''
+      end
+
+      context 'with missing robot data' do
+        it_behaves_like 'a complaining parser',
+                        <<-END.gsub(/^\s+\|/, '')
+                          |1 1
+                          |only robot_1 coordinates
+                        END
+      end
+    end
+
+    context 'with valid input data' do
+      let(:valid_input) do
+        s = <<-END.gsub(/^\s+\|/, '')
+          |a paddock description
+          |robot_1 coordinate
+          |robot_1 commands
+          |robot_2 coordinates
+          |robot_2 commands
+        END
+        StringIO.new(s)
+      end
+
+      subject do
+        described_class.instance_variable_set(:@paddock_factory, paddock_factory)
+        described_class.instance_variable_set(:@robot_factory, robot_factory)
+        described_class.parse(valid_input)
+      end
+
+      let(:paddock_factory) do
+        dbl = double
+        allow(dbl).to receive(:build).and_return('a paddock')
+        dbl
+      end
+      let(:robot_factory) do
+        dbl = double
+        allow(dbl).to receive(:build).and_return('robot_1','robot_2')
+        dbl
+      end
+
+      it 'returns a hash' do
+        is_expected.to be_instance_of Hash
+      end
+
+      it 'includes paddock data' do
+        is_expected.to include paddock: 'a paddock'
+      end
+
+      it 'includes robots data' do
+        is_expected.to include robots: ['robot_1', 'robot_2']
+      end
+    end
+  end
+end

data/spec/pose_spec.rb

@@ -0,0 +1,164 @@
+require_relative '../lib/robo_dog/pose'
+
+RSpec.describe RoboDog::Pose do
+  describe 'the public interface' do
+    it { expect(described_class).to respond_to :build }
+    subject{ described_class.new }
+    it { is_expected.to respond_to :report, :coordinates, :adjacent, :rotate! }
+  end
+
+  describe '.build' do
+    context 'with invalid data' do
+      let(:data) { '1' }
+      it 'screams at you' do
+        expect { described_class.build(data) }.to raise_exception described_class::DataError
+      end
+    end
+    context 'with valid data' do
+      let(:data) { '4 3 N'}
+      it 'returns a instance of self' do
+        expect(described_class.build(data)).to be_instance_of described_class
+      end
+      it 'builds with correct x coordinate' do
+        expect(described_class.build(data).instance_variable_get(:@x)).to eql 4
+      end
+      it 'builds with correct y coordinate' do
+        expect(described_class.build(data).instance_variable_get(:@y)).to eql 3
+      end
+      it 'builds with correct orientation' do
+        expect(described_class.build(data).instance_variable_get(:@orientation)).to eql described_class::Orientation::NORTH
+      end
+    end
+  end
+
+  let(:pose) do
+    described_class.new(x: 0, y: 0, orientation: :north)
+  end
+
+  describe '#report' do
+    subject { pose.report }
+    it 'returns a hash' do
+      is_expected.to be_instance_of Hash
+    end
+
+    it 'includes x, y and orientation' do
+      is_expected.to include x: 0, y: 0, orientation: 'N'
+    end
+  end
+
+  describe '#coordinates' do
+    subject { pose.coordinates }
+
+    it 'returns a hash' do
+      is_expected.to be_instance_of Hash
+    end
+
+    it 'includes x and y coordinates' do
+      is_expected.to include x: 0, y: 0
+    end
+  end
+
+  describe '#adjacent' do
+    let(:pose) { described_class.new(x: 2, y: 2, orientation: orientation) }
+
+    subject do
+      adj = pose.adjacent
+      {
+        x: adj.instance_variable_get(:@x),
+        y: adj.instance_variable_get(:@y),
+        orientation: adj.instance_variable_get(:@orientation)
+      }
+    end
+
+    context 'when facing north' do
+      let(:orientation) { described_class::Orientation::NORTH }
+      it 'returns the correct coordinates' do
+        is_expected.to include x: 2, y: 3, orientation: orientation
+      end
+    end
+
+    context 'when facing east' do
+      let(:orientation) { described_class::Orientation::EAST }
+      it 'returns the correct coordinates' do
+        is_expected.to include x: 3, y: 2, orientation: orientation
+      end
+    end
+
+    context 'when facing south' do
+      let(:orientation) { described_class::Orientation::SOUTH }
+      it 'returns the correct coordinates' do
+        is_expected.to include x: 2, y: 1, orientation: orientation
+      end
+    end
+
+    context 'when facing west' do
+      let(:orientation) { described_class::Orientation::WEST }
+      it 'returns the correct coordinates' do
+        is_expected.to include x: 1, y: 2, orientation: orientation
+      end
+    end
+  end
+
+  describe '#rotate!' do
+    let(:pose) { described_class.new(x: 2, y: 2, orientation: init_orientation) }
+
+    shared_examples 'a rotatable pose' do |direction, correct_orientation|
+      subject do
+        rotated = pose.rotate!(direction)
+        {
+          x: rotated.instance_variable_get(:@x),
+          y: rotated.instance_variable_get(:@y),
+          orientation: rotated.instance_variable_get(:@orientation)
+        }
+      end
+
+      it 'returns the correct orientation' do
+        is_expected.to include x: 2, y: 2, orientation: correct_orientation
+      end
+    end
+
+    context 'when facing north' do
+      let(:init_orientation) { described_class::Orientation::NORTH }
+      it_behaves_like 'a rotatable pose',
+                      :clockwise,
+                      described_class::Orientation::EAST
+
+      it_behaves_like 'a rotatable pose',
+                      :counter,
+                      described_class::Orientation::WEST
+    end
+
+    context 'when facing east' do
+      let(:init_orientation) { described_class::Orientation::EAST }
+      it_behaves_like 'a rotatable pose',
+                      :clockwise,
+                      described_class::Orientation::SOUTH
+
+      it_behaves_like 'a rotatable pose',
+                      :counter,
+                      described_class::Orientation::NORTH
+    end
+
+    context 'when facing south' do
+      let(:init_orientation) { described_class::Orientation::SOUTH }
+      it_behaves_like 'a rotatable pose',
+                      :clockwise,
+                      described_class::Orientation::WEST
+
+      it_behaves_like 'a rotatable pose',
+                      :counter,
+                      described_class::Orientation::EAST
+    end
+
+    context 'when facing west' do
+      let(:init_orientation) { described_class::Orientation::WEST }
+      it_behaves_like 'a rotatable pose',
+                      :clockwise,
+                      described_class::Orientation::NORTH
+
+      it_behaves_like 'a rotatable pose',
+                      :counter,
+                      described_class::Orientation::SOUTH
+    end
+  end
+end

data/spec/robot_spec.rb

@@ -0,0 +1,166 @@
+require_relative '../lib/robo_dog/robot'
+
+RSpec.describe RoboDog::Robot do
+  describe 'the public interface' do
+    it { expect(described_class).to respond_to :build }
+    subject{ described_class.new }
+    it { is_expected.to respond_to :execute, :report, :coordinates, :move, :right, :left, :add_coordinator }
+  end
+
+  describe '.build' do
+    context 'with invalid data' do
+      let(:data) { {commands: 'wrong'} }
+      it 'screams at you' do
+        expect { described_class.build(data) }.to raise_exception described_class::DataError
+      end
+    end
+    context 'with valid data' do
+      let(:data) do
+        {
+          commands: 'LRMR',
+          pose: '0 0 N'
+        }
+      end
+      it 'returns a instance of self' do
+        expect(described_class.build(data)).to be_instance_of described_class
+      end
+      it 'builds with correct commands' do
+        expect(described_class.build(data).instance_variable_get(:@commands)).to be == [:left, :right, :move, :right]
+      end
+      it 'delegates pose building' do
+        expect(RoboDog::Pose).to receive(:build).with(data[:pose])
+        described_class.build(data)
+      end
+    end
+  end
+
+  let(:robot) do
+    described_class.new(
+      pose: pose,
+      commands: commands,
+      coordinators: [coordinator]
+    )
+  end
+
+  let(:pose) { double }
+  let(:commands) { [] }
+  let(:coordinator) { double }
+
+  describe '#add_coordinator' do
+    it 'adds a coordinator to the coordinators array' do
+      robot.add_coordinator('a added coordinator')
+      expect(robot.instance_variable_get(:@coordinators)).to include 'a added coordinator'
+    end
+  end
+
+  describe '#execute' do
+    let(:commands) { [:left, :move, :left, :right] }
+
+    context 'with :all' do
+      it 'executes all commands' do
+        expect(robot).to receive(:left).ordered
+        expect(robot).to receive(:move).ordered
+        expect(robot).to receive(:left).ordered
+        expect(robot).to receive(:right).ordered
+
+        robot.execute(:all)
+      end
+
+      it 'empties the commands' do
+        allow(robot).to receive_messages(left: nil, move: nil, right: nil)
+        robot.execute(:all)
+        expect(robot.instance_variable_get(:@commands)).to be_empty
+      end
+    end
+
+    context 'with :next' do
+      it 'executes the next command' do
+        expect(robot).to receive(:left)
+
+        robot.execute(:next)
+      end
+
+      it 'removes the first command' do
+        allow(robot).to receive(:left)
+        robot.execute(:next)
+        expect(robot.instance_variable_get(:@commands)).to match_array [:move, :left, :right]
+      end
+    end
+  end
+
+  describe '#report' do
+    let(:pose) do
+      dbl = double
+      allow(dbl).to receive(:report).and_return('some report')
+      dbl
+    end
+
+    it "returns pose's report" do
+      expect(robot.report).to match('some report')
+    end
+  end
+
+  describe '#coordinates' do
+    let(:pose) do
+      dbl = double
+      allow(dbl).to receive(:coordinates).and_return('some coordinates')
+      dbl
+    end
+
+    it "returns pose's coordinates" do
+      expect(robot.coordinates).to match('some coordinates')
+    end
+  end
+
+  describe '#move' do
+    let(:pose) do
+      dbl = double
+      adj_pose = 'adjacent pose'
+      allow(adj_pose).to receive(:coordinates).and_return('some coordinates')
+      allow(dbl).to receive(:adjacent).and_return(adj_pose)
+      dbl
+    end
+
+    let(:coordinator) do
+      dbl = double
+      allow(dbl).to receive(:valid_coordinates?).and_return(coordinator_return)
+      dbl
+    end
+
+    let(:coordinator_return) { [true, false].sample }
+
+    it 'returns nil' do
+      expect(robot.move).to be_nil
+    end
+
+    context 'with valid adjacent pose' do
+      let(:coordinator_return) { true }
+      it 'updates its pose' do
+        robot.move
+        expect(robot.instance_variable_get(:@pose)).to eql('adjacent pose')
+      end
+    end
+
+    context 'with invalid adjacent pose' do
+      let(:coordinator_return) { false }
+      it 'does not update its pose' do
+        robot.move
+        expect(robot.instance_variable_get(:@pose)).to eql(pose)
+      end
+    end
+  end
+
+  describe '#right' do
+    it 'rotates its pose' do
+      expect(pose).to receive(:rotate!).with(:clockwise)
+      robot.right
+    end
+  end
+
+  describe '#left' do
+    it 'rotates its pose' do
+      expect(pose).to receive(:rotate!).with(:counter)
+      robot.left
+    end
+  end
+end