toy-robot-simulator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b4b3c0db1ec9db67b04a8c7956260295a9184f566d58226882d889034c27760
-  data.tar.gz: 5ed46e5643fec38a6114029cf43ce63d862c9a94b3c2f221ce3c7c41f8b67916
+  metadata.gz: c3ed853290dbb977c1c2b342805da404cc67a2a6100f87595b575619aa31f647
+  data.tar.gz: ab21ed69da38c44c7bd494a88ba07c00be6fc2146782e77a4ab1d94c45450096
 SHA512:
-  metadata.gz: 70e4ed4c2e4972bb367fa02e6b4469f1b15393c5250fee6999c1975b18e5f9984ce9c9e63840a581f1738a517e0992a803d612ac5f9101d42041197aab35900d
-  data.tar.gz: 48d8a2823e3c988416442f09f87b3adb14726c7cef432be4ab11e6edd07fa44c6e36916d5d9012829c9f6103f0333f7cafe97426c47b282f876430149fffdf4a
+  metadata.gz: 8f7080dcaf8309609f5dd61ae4e75428abdbba355d0d0a6a1bb228c7d653eb8c0fa0fdc90cb094ac59494b149e0276c02ff8c6ab1b929800a2e154639b3c4356
+  data.tar.gz: 19b7d35b3cc6c0c02297e2964d78e201d981dbc877a97b7d6923288b56eee02e98139eb720ef59cb58fbeb8544870b736a403c13426c3c92aa7d54037241ac51

data/README.md

@@ -0,0 +1,79 @@
+
+# Toy Robot Simulator
+_version: 0.0.1_
+
+The Ruby gem let the toy robot move a table painlessly, easily, and most importantly, **it does not fall from the table** 
+
+- [Full gem documentation (version 0.0.1)](https://www.rubydoc.info/gems/toy-robot-simulator/0.0.1/)
+# Installation
+```
+gem install toy-robot-simulator
+```
+```ruby
+gem "toy-robot-simulator", "~> 0.0.1"
+```
+```
+bundle install
+```
+# Usage
+## ToyRobotController
+The main component of this gem is which instantiate Robot, Table and process commands. In order to use this controller you need to do the following:
+
+**1. Include the ToyRobotController**
+```ruby
+require  'toy_robot_controller'
+```
+**2. Initialize the controller**
+```ruby
+ToyRobotController.init(commands: Array, table_size : int)
+```
+`There is also a CommandLoader module available which can read the test data from file and return commands array which can be passed into init of our controller`
+
+examples:
+```ruby
+ToyRobotController.init(['PLACE 0,0,NORTH', 'MOVE'])
+```
+**3. Execute the commands**
+```ruby
+ToyRobotController.execute_commands
+```
+**4. Report**
+```ruby
+ToyRobotController.report
+```
+
+
+## CommandSetLoader
+
+```ruby
+require  'helpers/command_set_loader'
+include CommandSetLoader
+```
+```ruby
+commands = CommandSetLoader.read_commands('./test_data/test1.txt')
+```
+`We can use this helper method to generate the array of commands which can be used as commands with ToyRobotController`
+```ruby
+ToyRobotController.init(commands)
+```
+
+## Things to considered
+
+ **init** method of ToyRobotController expects array of commands where all the commands should be type of **string**
+ 
+  If you are using the **CommandSetLoader**, make sure that your file has each command on a new line such as:
+ ```plain
+PLACE 0,0,NORTH
+MOVE
+REPORT
+```
+
+## TODO
+
+- Add configuration option 
+ - Ability to change PLACE command sequence such as
+	 -  X,Y, NORTH PLACE
+	 - NORTH X Y PLACE
+- **CommandSetLoader** is reading file locally, would be a good idea to add the option to read the file remotely
+- Add obstructions on the table
+- Non square table 

data/lib/toy_robot_controller.rb

@@ -4,12 +4,16 @@ require_relative 'toy_robot/robot'
 require_relative 'surface/table'
 require_relative 'helpers/command_parser_helper'
 require_relative 'errors/command'
-# ToyRobotController module and main entry of the program
+
+# ToyRobotController module which sets up the Robot, Table and execute commands provided
 module ToyRobotController
   class << self
     attr_accessor :robot, :commands
     include CommandParserHelper
 
+    # This method is expecting [Array<String>] of commands such as ['PLACE 0,0,NORTH', 'MOVE', 'REPORT']
+    # @param commands_stream [Array<String>]
+    # @param table_size [Integer]
     def init(commands_stream, table_size = 5)
       validate_command_stream(commands_stream)
 
@@ -20,10 +24,18 @@ module ToyRobotController
       populate_commands
     end
 
+    # This method return the coordinates of Robot on the table and the direction it is facing
     def report(format = 'console')
       @robot.report(format)
     end
 
+    # Simply executes the commands array.
+    #
+    # considerations:
+    #
+    # @raise [Command::NoValidCommandsFound] if the commands array length is 0
+    #
+    # @raise [Command::PlaceCommandNotFound] if the commands array does not contain a valid PLACE command
     def execute_commands
       raise Command::NoValidCommandsFound if @commands.size.zero?
       raise Command::PlaceCommandNotFound if @commands.select { |c| c.type == 'PLACE' }.size.zero?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toy-robot-simulator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Salman Sohail