maux_robot 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcae61d13656d506d2d2b851f744ad89ab52019b
-  data.tar.gz: 55ccb6a55a0ecac20ed9a32ed4b4894e6396d928
+  metadata.gz: 961e2b5489e001d3676b9a8f4360b212b62e677b
+  data.tar.gz: '028a03a16e37befedecb9336b8d1a5f6c3cd78e1'
 SHA512:
-  metadata.gz: c4bcf5f0d29bc5e2e06534f26d3ad31275829bb9f310c98a70fba8c6b2ee6081999c884c2a91fb5dee7bf8dbf8b2a33a1b04436319a64a21b9bb952bf8ff3b9e
-  data.tar.gz: c0e40e5920f39688a15e5018d7545fd6a81e6639791bd0394e182b2390b35198d68bd53089f180bd7aa990f390910d292f7f4554a33a64a3b10d2e7b71e3c9f4
+  metadata.gz: 1676475a44d162ae4038dc3862e380f81527caf621e3ea74e942ce3d431553476635373cffe05e9f4e468afea18ce5035e2c7d297bbfd3d57d645bf6fb1def11
+  data.tar.gz: ff3e5c81d4c9d4d348b90d7e99e76e683fb14064c2bf4431203498b479de0e60a4d1c2da186a4e4b59f63590e2868c4c1d25e0a63d6bff37dd6abb5ebb591819

data/README.md

@@ -24,7 +24,8 @@ PLACE X,Y,F
 MOVE
 LEFT
 RIGHT
-REPORT
+REPORT [csv|json]
+VERBOSE
 ```
 
 * `PLACE` will put the toy robot on the table in position X,Y
@@ -40,7 +41,8 @@ in the direction it is currently facing.
 * `LEFT` and `RIGHT` will rotate the robot 90 degrees
 in the specified direction
 without changing the position of the robot.
-* `REPORT` will announce the X,Y and F of the robot.
+* `REPORT` will announce the X,Y and F of the robot. If `csv` or `json` is passed, it formats the whereabouts accordingly. The default format is `csv`.
+* `VERBOSE` will turn the error messages (talkative mode) on or off. The robot starts with talkative mode set to off.
 
 * A robot that is not on the table ignores the `MOVE`, `LEFT`, `RIGHT` and `REPORT` commands.
 

data/lib/maux_robot/cli.rb

@@ -17,7 +17,11 @@ module MauxRobot
     def run_script(all_input)
       all_input.split("\n").each do |line_input|
         command = parse(line_input)
-        execute(command) if command
+        begin
+          execute(command) if command
+        rescue MauxRobot::RobotError => e
+          puts e if @robot.talkative
+        end
       end
     end
 

data/lib/maux_robot/position.rb

@@ -46,7 +46,7 @@ module MauxRobot
       Position.new(x, y, @face)
     end
 
-    def report(format_type: :csv)
+    def report(format_type=:csv)
       formatter = MauxRobot::Formatter.from(format_type)
       puts formatter.generate(self)
     end

data/lib/maux_robot/robot.rb

@@ -4,31 +4,89 @@ require 'forwardable'
 
 module MauxRobot
 
+  class RobotError < StandardError; end
+
+  # Error to notify that the robot was not placed yet
+  class RobotNotPlacedYet < RobotError
+    def initialize
+      super('The robot was not placed yet!')
+    end
+  end
+
+  # Error to notify that the position is/would be outside the table
+  class NotOkToGo < RobotError
+    def initialize(position)
+      super("It's not ok to go to #{position.x},#{position.y}")
+    end
+  end
+
   # The main class. It executes the actions using its table and position
   class Robot
-    attr_reader :position
-
-    extend Forwardable
-    def_delegators :@position, :left, :right, :report
+    attr_reader :position, :talkative
 
     def initialize(table=MauxRobot::Table.new)
       @table = table
       @position = MauxRobot::NullPosition.new
+      @talkative = false
     end
 
     def place(x:, y:, face:)
       position = MauxRobot::Position.new(x, y, face)
 
-      if position.valid_direction? && @table.contains?(position)
+      ok_to_go?(position) do
         @position = position
       end
     end
 
     def move
-      next_position = @position.forward_position
+      robot_placed? do
+        next_position = @position.forward_position
+
+        ok_to_go?(next_position) do
+          @position = next_position
+        end
+      end
+    end
+
+    def left
+      robot_placed? do
+        @position.left
+      end
+    end
+
+    def right
+      robot_placed? do
+        @position.right
+      end
+    end
+
+    def report(format_type: :csv)
+      robot_placed? do
+        @position.report(format_type)
+      end
+    end
+
+    def verbose
+      @talkative = !@talkative
+      is_not = @talkative ? 'is' : 'is not'
+      puts "Robot #{is_not} talkative now."
+    end
+
+    private
+
+    def ok_to_go?(position)
+      if @table.contains?(position)
+        yield
+      else
+        raise NotOkToGo.new(position)
+      end
+    end
 
-      if @table.contains?(next_position)
-        @position = next_position
+    def robot_placed?
+      unless @position.class == MauxRobot::NullPosition
+         yield
+      else
+        raise RobotNotPlacedYet
       end
     end
   end

data/lib/maux_robot/table.rb

@@ -10,7 +10,8 @@ module MauxRobot
     end
 
     def contains?(position)
-      position.x.between?(@x[0], @x[1]) &&
+      position.valid_direction? &&
+        position.x.between?(@x[0], @x[1]) &&
         position.y.between?(@y[0], @y[1])
     end
   end

data/lib/maux_robot/version.rb

@@ -3,7 +3,7 @@
 module MauxRobot
   # This module holds the MauxRobot version information.
   module Version
-    STRING = '0.0.5'.freeze
+    STRING = '0.1.0'.freeze
 
     MSG = '%s (using Parser %s, running on %s %s %s)'.freeze
 

data/spec/maux_robot/robot_spec.rb

@@ -14,28 +14,22 @@ describe MauxRobot::Robot do
     end
 
     context 'given an invalid place' do
-      it 'should not have a position' do
-        robot.place(x: 5, y: 0, face: :south)
-
-        expect(robot.position).to eq null_position
+      it 'should raise NotOkToGo error' do
+        expect { robot.place(x: 5, y: 0, face: :south) }.to raise_error MauxRobot::NotOkToGo
       end
     end
 
     context 'given an invalid direction' do
-      it 'should not have a position' do
-        robot.place(x: 0, y: 2, face: :south_east)
-
-        expect(robot.position).to eq null_position
+      it 'should raise NotOkToGo error' do
+        expect { robot.place(x: 0, y: 2, face: :south_east) }.to raise_error MauxRobot::NotOkToGo
       end
     end
   end
 
   describe '#left' do
     context 'robot not placed' do
-      it 'should silently ignore' do
-        robot.place(x: 0, y: 2, face: :south_east)
-        robot.left
-
+      it 'should raise RobotNotPlacedYet error' do
+        expect { robot.left }.to raise_error MauxRobot::RobotNotPlacedYet
         expect(robot.position).to eq null_position
       end
     end
@@ -52,9 +46,8 @@ describe MauxRobot::Robot do
 
   describe '#right' do
     context 'robot not placed' do
-      it 'should silently ignore' do
-        robot.place(x: 0, y: 2, face: :north_west)
-        robot.right
+      it 'should raise RobotNotPlacedYet error' do
+        expect { robot.right }.to raise_error MauxRobot::RobotNotPlacedYet
 
         expect(robot.position).to eq null_position
       end
@@ -72,9 +65,8 @@ describe MauxRobot::Robot do
 
   describe '#move' do
     context 'robot not placed' do
-      it 'should silently ignore' do
-        robot.move
-
+      it 'should raise RobotNotPlacedYet error' do
+        expect { robot.right }.to raise_error MauxRobot::RobotNotPlacedYet
         expect(robot.position).to eq null_position
       end
     end
@@ -93,7 +85,8 @@ describe MauxRobot::Robot do
     context 'to outside the table' do
       it 'should stay where it is' do
         robot.place(x: 0, y: 0, face: :south)
-        robot.move
+
+        expect { robot.move }.to raise_error MauxRobot::NotOkToGo
 
         expect(robot.position.x).to eq(0)
         expect(robot.position.y).to eq(0)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maux_robot
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Mauricio Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec