/toy-robot

A simulation of a toy robot moving on a square tabletop, of dimensions 5 units x 5 units.

Primary LanguageHTMLMIT LicenseMIT

Ruby Toy Robot Simulator

Build Status Code Climate Test Coverage

Description

A simulation of a toy robot moving on a square tabletop, of dimensions 5 units x 5 units. See Specification below for details.

Installation

$ brew update
$ brew install rbenv ruby-build
$ rbenv install 2.1.6
$ gem install bundler
$ bundle install

Changelog

$ stepup changelog

Usage

$ bin/toy_robot interpret ./test_data/commands_1.txt

Testing

Code quality is attempted by using RSpec for testing, SimpleCov for code test coverage, Rubocop for static code analyzer, Reek to fix code smells, as well as Code Climate for quality metrics.

Run tests:

$ rspec

Check test coverage (after running rspec):

$ open coverage/index.html

Check code smells:

$ reek

Rubocop report:

$ open rubocop.html

Specification

Description

  • The application is a simulation of a toy robot moving on a square tabletop, of dimensions 5 units x 5 units.
  • There are no other obstructions on the table surface.
  • The robot is free to roam around the surface of the table, but must be prevented from falling to destruction. Any movement that would result in the robot falling from the table must be prevented, however further valid movement commands must still be allowed.

Create an application that can read in commands of the following form PLACE X,Y,F MOVE LEFT RIGHT REPORT

  • PLACE will put the toy robot on the table in position X,Y and facing NORTH, SOUTH, EAST or WEST.
  • The origin (0,0) can be considered to be the SOUTH WEST most corner.
  • The first valid command to the robot is a PLACE command, after that, any sequence of commands may be issued, in any order, including another PLACE command. The application should discard all commands in the sequence until a valid PLACE command has been executed
  • MOVE will move the toy robot one unit forward 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. This can be in any form, but standard output is sufficient.
  • A robot that is not on the table can choose to ignore the MOVE, LEFT, RIGHT and REPORT commands.
  • Input can be from a file, or from standard input, as the developer chooses.
  • Provide test data to exercise the application.

Constraints

The toy robot must not fall off the table during movement. This also includes the initial placement of the toy robot. Any move that would cause the robot to fall must be ignored.

Example Input and Output:

a) PLACE 0,0,NORTH MOVE REPORT Output: 0,1,NORTH

b) PLACE 0,0,NORTH LEFT REPORT Output: 0,0,WEST

c) PLACE 1,2,EAST MOVE MOVE LEFT MOVE REPORT Output: 3,3,NORTH

Deliverables

The Ruby source files, the test data and any test code. It is not required to provide any graphical output showing the movement of the toy robot.

Copyright

Copyright (c) 2015 Igor Escobar

See MIT LICENSE for details.