maux_robot 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 776efb576b9d292a6d18f2ab3428c45b223399a3
-  data.tar.gz: 8f65894e13ff0bb52a95a61b0654d58200a53cb8
+  metadata.gz: 9bf2d0fed313bcc6043144745aa33467fa7c8ab0
+  data.tar.gz: a63febfee434feda427515e282367fb974b223c7
 SHA512:
-  metadata.gz: 20aef8da93c3cb1f28378607a95020a8201fef566adc14522432d3a1ab0723b7c597dab066bc57c2359a51d83ea9785cd1bb28602d32b95418b5b16b122bd130
-  data.tar.gz: d09ae6bb62e2bdbc5d9b2f5f110ae78d0ebc0d86b66c8371d42984dea9823e138cc0eff556cd0b94fd04cb6f030e9079fbd0d3a3afded3ca5b6d5e8ad70582c7
+  metadata.gz: f04f82e9a2914420a34898662e02231d4f744bfc6035e51302b091af5058eba85c74beaf32bcb69d0954643494cf9624571ee6ae68cbec58bcb437e75a514213
+  data.tar.gz: 0304f7d1f1110a3ca0b048bce64dc59bbd87087903345c3e97696fe0b42052dcc72d93349084ca66413b319f32514f1b89b10cec330f1bfd40dd59acc3cc7b76

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/mauriciovieira/maux_robot.svg?branch=master)](https://travis-ci.org/mauriciovieira/maux_robot)
+
 # maux_robot
 
 Maux version of a Toy Robot Simulator in Ruby

data/lib/maux_robot/cli.rb

@@ -4,8 +4,6 @@ module MauxRobot
 
   # The CLI is a class responsible of handling command line interface
   class CLI
-    ALLOWED_ORDERS = %i[left right move place report].freeze
-
     attr_reader :robot
     def initialize
       @robot = Robot.new
@@ -24,38 +22,15 @@ module MauxRobot
     end
 
     def parse(line_input)
-      clean_input = line_input.strip.squeeze(' ').split(' ')
-      order = sanitize_order(clean_input.shift)
-      return unless order
-
-      command = { order: order }
-
-      if clean_input.any?
-        arguments = sanitize_arguments(clean_input.join(''))
-        command[:arguments] = arguments
-      end
-
-      command
+      Parser.new.parse(line_input)
     end
 
     def execute(command)
-      if command[:arguments].nil?
-        @robot.send(command[:order])
-      else
+      if command.has_key?(:arguments)
         @robot.send(command[:order], command[:arguments])
+      else
+        @robot.send(command[:order])
       end
     end
-
-    private
-
-    def sanitize_order(input_string)
-      order = input_string.downcase.to_sym
-      order if ALLOWED_ORDERS.include?(order)
-    end
-
-    def sanitize_arguments(arguments)
-      arguments = arguments.delete(' ').split(',')
-      { x: arguments[0], y: arguments[1], face: arguments[2] }
-    end
   end
 end

data/lib/maux_robot/parser.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module MauxRobot
+
+  class Parser
+    ALLOWED_ORDERS = %i[left right move place report verbose].freeze
+
+    def parse(line_input)
+      clean_input = line_input.strip.squeeze(' ').split(' ')
+      order = sanitize_order(clean_input.shift)
+      return unless order
+
+      command = { order: order }
+
+      if clean_input.any?
+        arguments = sanitize_arguments(order, clean_input.join(''))
+        command[:arguments] = arguments
+      end
+
+      command
+    end
+
+
+    private
+
+    def sanitize_order(input_string)
+      order = input_string.downcase.to_sym
+      order if ALLOWED_ORDERS.include?(order)
+    end
+
+    def sanitize_arguments(order, arguments)
+      case order
+      when :place
+        arguments = arguments.delete(' ').split(',')
+        { x: arguments[0], y: arguments[1], face: arguments[2] }
+      when :report
+        { format: arguments.downcase.to_sym }
+      end
+    end
+  end
+end
+
+
+

data/lib/maux_robot/position.rb

@@ -26,17 +26,21 @@ module MauxRobot
       POSSIBLE_DIRECTIONS.include?(@face)
     end
 
-    def turn_left
+    def left
+      return self unless valid_direction?
       next_direction_index = ( POSSIBLE_DIRECTIONS.index(@face) + 1 ) % 4
       @face = POSSIBLE_DIRECTIONS[next_direction_index]
     end
 
-    def turn_right
+    def right
+      return self unless valid_direction?
       next_direction_index = ( POSSIBLE_DIRECTIONS.index(@face) - 1 )
       @face = POSSIBLE_DIRECTIONS[next_direction_index]
     end
 
     def forward_position
+      return self unless valid_direction?
+
       x = @x + POSSIBLE_MOVEMENTS[@face][:x]
       y = @y + POSSIBLE_MOVEMENTS[@face][:y]
       Position.new(x, y, @face)
@@ -45,5 +49,15 @@ module MauxRobot
     def to_s
       "#{@x},#{@y},#{@face.upcase.to_s}"
     end
+
+    def ==(other)
+      other.x == x && other.y == y && other.face == face
+    end
+  end
+
+  class NullPosition < Position
+    def initialize
+      super(nil, nil, nil)
+    end
   end
 end

data/lib/maux_robot/robot.rb

@@ -1,31 +1,29 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 module MauxRobot
 
   # The main class. It executes the actions using its table and position
   class Robot
     attr_reader :position
 
+    extend Forwardable
+    def_delegators :@position, :left, :right
+
     def initialize(table=MauxRobot::Table.new)
       @table = table
+      @position = MauxRobot::NullPosition.new
     end
 
     def place(x:, y:, face:)
       position = MauxRobot::Position.new(x, y, face)
 
-      if position.valid_direction? and @table.contains?(position)
+      if position.valid_direction? && @table.contains?(position)
         @position = position
       end
     end
 
-    def left
-      @position&.turn_left
-    end
-
-    def right
-      @position&.turn_right
-    end
-
     def move
       next_position = @position.forward_position
 

data/lib/maux_robot/version.rb

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

data/lib/maux_robot.rb

@@ -1,5 +1,9 @@
 require 'maux_robot/version'
 require 'maux_robot/cli'
+require 'maux_robot/parser'
 require 'maux_robot/position'
 require 'maux_robot/table'
-require 'maux_robot/robot'
+require 'maux_robot/robot'
+
+module MauxRobot
+end

data/spec/maux_robot/cli_spec.rb

@@ -3,66 +3,17 @@
 require 'maux_robot'
 
 describe MauxRobot::CLI do
-  describe '#parse' do
-    context 'valid orders' do
-      it '#report' do
-        expect(subject.parse('REPORT')).to eq(order: :report)
-      end
-
-      it '#move' do
-        expect(subject.parse('MOVE')).to eq(order: :move)
-      end
-
-      it '#left' do
-        expect(subject.parse('LEFT')).to eq(order: :left)
-      end
-
-      it '#right' do
-        expect(subject.parse('RIGHT')).to eq(order: :right)
-      end
-
-      it '#place' do
-        expect(subject.parse('PLACE 0,3,WEST')).to eq(order: :place, arguments: { x: '0', y: '3', face: 'WEST' })
-      end
-    end
-
-    context 'orders with spaces and downcase' do
-      it '#report' do
-        expect(subject.parse('    repoRT')).to eq(order: :report)
-      end
-
-      it '#move' do
-        expect(subject.parse('move      ')).to eq(order: :move)
-      end
-
-      it '#left' do
-        expect(subject.parse('   LefT ')).to eq(order: :left)
-      end
-
-      it '#right' do
-        expect(subject.parse('   rigHt')).to eq(order: :right)
-      end
-
-      it '#place' do
-        expect(subject.parse('PLACE 2 ,  1 ,  NOrth')).to eq(order: :place, arguments: { x: '2', y: '1', face: 'NOrth' })
-      end
-    end
-
-    it 'ignores anything else' do
-      expect(subject.parse('blablabla balbla')).to be_nil
-    end
-  end
 
   describe '#execute' do
-    context 'commands without arguments' do
-      it 'sends proper message to robot' do
+    context 'parsed input without arguments' do
+      it 'should send proper message to robot' do
         expect(subject.robot).to receive(:move)
         subject.execute(order: :move)
       end
     end
 
-    context 'place' do
-      it 'send place command along with arguments' do
+    context 'parsed place command with arguments' do
+      it 'should send proper message to robot' do
         expect(subject.robot).to receive(:place).with(x: '0', y: '2', face: 'EAST')
         subject.execute(order: :place, arguments: { x: '0', y: '2', face: 'EAST' })
       end

data/spec/maux_robot/parser_spec.rb

@@ -0,0 +1,69 @@
+ # frozen_string_literal: true
+
+require 'maux_robot'
+
+describe MauxRobot::Parser do
+  describe '#parse' do
+    context 'valid orders' do
+      it '#report' do
+        expect(subject.parse('REPORT')).to eq(order: :report)
+      end
+
+      it '#report csv' do
+        expect(subject.parse('REPORT CSV')).to eq(order: :report, arguments: { format: :csv })
+      end
+
+      it '#report json' do
+        expect(subject.parse('REPORT JSON')).to eq(order: :report, arguments: { format: :json })
+      end
+
+      it '#move' do
+        expect(subject.parse('MOVE')).to eq(order: :move)
+      end
+
+      it '#left' do
+        expect(subject.parse('LEFT')).to eq(order: :left)
+      end
+
+      it '#right' do
+        expect(subject.parse('RIGHT')).to eq(order: :right)
+      end
+
+      it '#verbose' do
+        expect(subject.parse('VERBOSE')).to eq(order: :verbose)
+      end
+
+      it '#place' do
+        expect(subject.parse('PLACE 0,3,WEST')).to eq(order: :place, arguments: { x: '0', y: '3', face: 'WEST' })
+      end
+    end
+
+    context 'orders with spaces and downcase' do
+      it '#report' do
+        expect(subject.parse('    repoRT')).to eq(order: :report)
+      end
+
+      it '#move' do
+        expect(subject.parse('move      ')).to eq(order: :move)
+      end
+
+      it '#left' do
+        expect(subject.parse('   LefT ')).to eq(order: :left)
+      end
+
+      it '#right' do
+        expect(subject.parse('   rigHt')).to eq(order: :right)
+      end
+
+      it '#place' do
+        expect(subject.parse('PLACE 2 ,  1 ,  NOrth')).to eq(order: :place, arguments: { x: '2', y: '1', face: 'NOrth' })
+      end
+    end
+
+    context 'invalid orders' do
+      it 'ignores anything else' do
+        expect(subject.parse('blablabla balbla')).to be_nil
+      end
+    end
+  end
+end

data/spec/maux_robot/position_spec.rb

@@ -36,34 +36,34 @@ describe MauxRobot::Position do
   describe 'rotation' do
     let(:position) { MauxRobot::Position.new(2, 2, :north) }
 
-    context '#turn_left' do
+    context '#left' do
       it 'should rotate counter-clockwise' do
-        position.turn_left
+        position.left
         expect(position.face).to eq(:west)
 
-        position.turn_left
+        position.left
         expect(position.face).to eq(:south)
 
-        position.turn_left
+        position.left
         expect(position.face).to eq(:east)
 
-        position.turn_left
+        position.left
         expect(position.face).to eq(:north)
       end
     end
 
-    context '#turn_right' do
+    context '#right' do
       it 'should rotate clockwise' do
-        position.turn_right
+        position.right
         expect(position.face).to eq(:east)
 
-        position.turn_right
+        position.right
         expect(position.face).to eq(:south)
 
-        position.turn_right
+        position.right
         expect(position.face).to eq(:west)
 
-        position.turn_right
+        position.right
         expect(position.face).to eq(:north)
       end
     end

data/spec/maux_robot/robot_spec.rb

@@ -4,13 +4,14 @@ require 'maux_robot'
 
 describe MauxRobot::Robot do
   subject(:robot) { described_class.new }
+  let(:null_position) { MauxRobot::NullPosition.new }
 
   describe '#place' do
     context 'given a valid place' do
       it 'should have a position' do
         robot.place(x: 0, y: 0, face: :north)
 
-        expect(robot.position).not_to be_nil
+        expect(robot.position).not_to eq null_position
       end
     end
 
@@ -18,7 +19,7 @@ describe MauxRobot::Robot do
       it 'should not have a position' do
         robot.place(x: 5, y: 0, face: :south)
 
-        expect(robot.position).to be_nil
+        expect(robot.position).to eq null_position
       end
     end
 
@@ -26,7 +27,7 @@ describe MauxRobot::Robot do
       it 'should not have a position' do
         robot.place(x: 0, y: 2, face: :south_east)
 
-        expect(robot.position).to be_nil
+        expect(robot.position).to eq null_position
       end
     end
   end
@@ -37,7 +38,7 @@ describe MauxRobot::Robot do
         robot.place(x: 0, y: 2, face: :south_east)
         robot.left
 
-        expect(robot.position).to be_nil
+        expect(robot.position).to eq null_position
       end
     end
 
@@ -57,7 +58,7 @@ describe MauxRobot::Robot do
         robot.place(x: 0, y: 2, face: :north_west)
         robot.right
 
-        expect(robot.position).to be_nil
+        expect(robot.position).to eq null_position
       end
     end
 
@@ -72,6 +73,14 @@ describe MauxRobot::Robot do
   end
 
   describe '#move' do
+    context 'robot not placed' do
+      it 'should silently ignore' do
+        robot.move
+
+        expect(robot.position).to eq null_position
+      end
+    end
+
     context 'to a place on the table' do
       it 'should update its position' do
         robot.place(x: 3, y: 2, face: :north)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maux_robot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mauricio Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,11 +44,13 @@ files:
 - bin/maux_robot
 - lib/maux_robot.rb
 - lib/maux_robot/cli.rb
+- lib/maux_robot/parser.rb
 - lib/maux_robot/position.rb
 - lib/maux_robot/robot.rb
 - lib/maux_robot/table.rb
 - lib/maux_robot/version.rb
 - spec/maux_robot/cli_spec.rb
+- spec/maux_robot/parser_spec.rb
 - spec/maux_robot/position_spec.rb
 - spec/maux_robot/robot_spec.rb
 - spec/maux_robot/table_spec.rb