ToyRobotCli
ToyRobotCli is a RubyGem that provides a command-line interface (CLI) for interacting with a toy robot on a table.
Installation
Add this line to your application's Gemfile:
gem 'toy_robot_cli'
And then execute:
bundle install
Or install it yourself as:
gem install toy_robot_cli
Usage
To use the ToyRobotCli gem, you can run the toy_robot command in your terminal.
The available commands are:
- place X Y FACING: Place the robot on the table at position X,Y facing the specified direction (NORTH, EAST, SOUTH, WEST).
- move: Move the robot one unit forward in the current direction.
- left: Rotate the robot 90 degrees to the left.
- right: Rotate the robot 90 degrees to the right.
- report: Report the current position and direction of the robot.
- current_position: Report the current position of the robot.
- current_direction: Report the current direction of the robot is facing.
Here's an example usage:
$ toy_robot
> place 1 2 EAST
> move
> move
> right
> move
> report
> current_position
> current_direction
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
or bundle exec cucumber features
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and the created tag, and push the .gem
file to rubygems.org.
Docs
rdoc lib/toy_robot_cli/robot.rb
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/phsacramento/toy_robot_cli.
License
The gem is available as open source under the terms of the MIT License.