lemmibot 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d125d14ad12b0139f69af46b5051534ab07d8395
-  data.tar.gz: cd9242fa6928f0db371708a91aa157b8e2ba3ea9
+  metadata.gz: d9b547cbeee34311afbfa2a4d807fab0917075e9
+  data.tar.gz: 2e6f30d57bfbcb0652a438338ea0ce5db36d3813
 SHA512:
-  metadata.gz: 88f65fc237a1b5bc6daf3ba49a6b482b8da998beca9af597467d7db745521646498cbc049ecf0a1ebd7f9e33c146eb77ed2c5ad1b01d5bab2634aff4239db464
-  data.tar.gz: 5abc057800f629faa4870d9b88ab96a078a70247bf64f7528b41893f90957a3a9a7d757fbe6babd25324d87433a7e38d40e4a00b54682badfa5b694852cdd3da
+  metadata.gz: 34bf061fa9bee2db80a1892d6aecf14cb05de6c408a68e242dbda10e1e729ba6ad7a6ff350f38e2dffb20f805abbc3b03bea278f683be3fd1dfddb1e9d042f3c
+  data.tar.gz: 3ef074417f45aa1f561d6826d6ddd1d24ce2e10ac9b5038585c66433d0c2593f0cf7b31c7b3372f05f274bf653581f982a4b16b27136ab7b5b142a6547971dd6

data/.rubocop.yml

@@ -1,3 +1,4 @@
+# Exclude spec files from some Rubocop metric
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
@@ -5,9 +6,9 @@ Metrics/LineLength:
   Exclude:
     - 'spec/**/*.rb'
     - 'lemmibot.gemspec'
-# Do not prefix writer method names with set_
+# Allow prefixing writer method names with set_
 Style/AccessorMethodName:
   Enabled: false
-# Do not suppress exceptions
+# Allow silently suppressing exceptions
 Lint/HandleExceptions:
   Enabled: false

data/README.md

@@ -2,7 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/lemmibot.svg)](https://badge.fury.io/rb/lemmibot) 
 [![Build Status](https://travis-ci.org/ineffyble/lemmibot.svg)](https://travis-ci.org/ineffyble/lemmibot)
 
-A toy robot with better self-preservation instincts than a real lemming.
+A toy robot with better self-preservation instincts than a lemming.
 
 ## Installation
 
@@ -17,6 +17,8 @@ and should run on any system running `ruby >= 2.0.0`.
 
 ## Usage
 
+### Interactive
+
 Once installed, start an interactive bot interface:
 
     $ lemmibot
@@ -25,19 +27,21 @@ Congratulations! You've now created your very own Lemmibot.
 
 The bot will accept the following commands:
 
-* `PLACE X,Y,F` (e.g. `PLACE 2,1,NORTH`) - Places the bot at the specified coordinates on the table top, facing the specified position.
-* `MOVE` - Moves the bot one unit in the currently facing direction.
-* `LEFT` - Rotates the bot 90 degrees left, changing the faced direction but not moving the bot.
-* `RIGHT` - Rotates the bot 90 degrees right, changing the faced direction but not moving the bot.
-* `REPORT` - Outputs a report of the bot's current position and direction, in the format `0,1,NORTH`.
-
-The bot must be placed before it will accept any other commands.
+* `PLACE X,Y,F` (e.g. `PLACE 2,1,NORTH`) - Place the bot at the specified coordinates on the tabletop, facing the specified position.
+    * The tabletop is a size of 5 units by 5 units. Coordinates are zero-indexed. Valid X and Y coordinates are 0-4.
+    * Lemmibot can face the following directions: *north, south, east, west*.
+    * **The bot must be placed before it will accept any other commands.**
+* `MOVE` - Move the bot one unit in the currently facing direction.
+* `LEFT` - Rotate the bot 90 degrees left, changing the direction the bot is facing in.
+* `RIGHT` - Rotate the bot 90 degrees right, changing the direction the bot is facing in.
+* `REPORT` - Print a report of the bot's current position and direction, in the format `0,1,NORTH`.
 
-Any erroneous commands (including unrecognised commands and malformed commands) will be silently ignored.
+Any unrecognised or malformed commands will be silently ignored.
 
+**Lemmibot is programmed with self-preservation routines.**  
 Any commands that would result in this bot's untimely demise
-(e.g. placing it off the edge of the table, or attempting to move the bot off the edge of the table)
-will be silently ignored.
+(i.e. attempting to place the bot at coordinates that are not on the tabletop,
+or commanding the bot to move off the table) will be silently ignored.
 
 ### Using a command script
 
@@ -45,25 +49,53 @@ Lemmibot can fed a list of commands from a file:
 
     $ lemmibot < examples/basic_move
 
-The following scripts may be found in the `examples` directory:
+The following scripts may be found in the `examples` directory. All examples end with a single `REPORT` command.
 
-* `basic_move` - Demonstrates moving Lemmibot one unit and reporting. The output should be `0,1,NORTH`.
-* `basic_rotate` - Demonstrates rotating Lemmibot 90 degrees left and reporting. The output should be `0,0,WEST`.
-* `move_and_rotate` - Demonstrates moving and rotating Lemmibot, then reporting. The output should be `3,3,NORTH`.
-* `self_preservation` - Demonstrates that Lemmibot will not jump off the table. The output should be `2,4,EAST`.
+|      File name      |                     Description                         |    Output   |
+| ------------------- | ------------------------------------------------------- | ----------- |
+| `basic_move`        | Demonstrates moving Lemmibot one unit.                  | `0,1,NORTH` |
+| `basic_rotate`      | Demonstrates rotating Lemmibot 90 degrees left.         | `0,0,WEST`  |
+| `move_and_rotate`   | Demonstrates moving and rotating Lemmibot.              | `3,3,NORTH` |
+| `self_preservation` | Demonstrates that Lemmibot will not jump off the table. | `2,4,EAST`  |
 
 ## Development
 
+### Tools
+
 Lemmibot uses `rake`, `rspec`, `aruba`, and `rubocop` for development and testing.
 
-After cloning the repository, you may use the setup script at `./bin/setup` to install development dependencies.
+### Set up
+
+Clone the repository from GitHub:
+
+    $ git clone https://github.com/ineffyble/lemmibot.git
+
+Then use the setup script at to install development dependencies.
+
+    $ cd lemmibot && ./bin/setup
+
 
-To run the RSpec test suite and Rubocop style checker against Lemmibot, run `bundle exec rake`.
+### Running Lemmibot locally
+
+To run the interactive Lemmibot interface from local source: 
+
+    $ bundle exec ./exe/lemmibot
+
+You may pipe in example scripts from the `examples/` directory, as per the Usage section of this README.
+
+### Testing
+
+Once you have some working code changes, run the RSpec test suite and Rubocop style checker:
+
+    $ bundle exec rake
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ineffyble/lemmibot.
 
+> "Don't *git push* me 'cause I'm close to the edge (of the tabletop)"
+> ~ Lemmibot, 2017
+
 ## License
 
 Lemmibot is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/lemmibot.rb

@@ -2,6 +2,6 @@ require 'lemmibot/version'
 require 'lemmibot/bot'
 require 'lemmibot/command_interface'
 
-# A toy robot simulator
+# A toy robot with better self-preservation instincts than a lemming
 module Lemmibot
 end

data/lib/lemmibot/bot.rb

@@ -1,5 +1,5 @@
 module Lemmibot
-  # A simulated toy robot on a tabletop
+  # A simulated toy robot, which can be placed on a tabletop and given commands
   class Bot
     def initialize
       @pos_x = 0
@@ -10,22 +10,18 @@ module Lemmibot
 
     def turn(relative_direction)
       # Rotate the bot 90 degrees to face another direction
-      # TODO: Find a nicer way to find the new direction
       return false unless @placed
-      change = if relative_direction == :left
-                 -1
-               else
-                 1
-               end
-      next_direction_index = DIRECTIONS.index(@direction) + change
-      next_direction_index = 0 if next_direction_index > DIRECTIONS.count - 1
-      new_direction = DIRECTIONS[next_direction_index]
+      case relative_direction
+      when :left then change = -1
+      when :right then change = 1
+      end
+      current_direction_index = DIRECTIONS.index(@direction)
+      new_direction = DIRECTIONS.rotate(current_direction_index + change).first
       set_direction(new_direction)
     end
 
     def move
       # Move the bot one unit in the direction it is facing
-      # TODO: Find a more elegant solution for this
       return false unless @placed
       case @direction
       when :north then return change_position(:y, 1)

data/lib/lemmibot/command_interface.rb

@@ -1,11 +1,13 @@
 module Lemmibot
-  # An interface for issuing commands to a Lemmibot via CLI/STDIN
+  # An interface for issuing commands to a Lemmibot
+  # via interactive command-line or piped in scripts
   class CommandInterface
     def initialize
       @bot = Lemmibot::Bot.new
     end
 
     def start
+      # Start a session, receiving and processing commands from standard input
       puts 'Lemmibot is awaiting your commands'
       loop do
         command = gets
@@ -13,7 +15,7 @@ module Lemmibot
         begin
           process_command(command.chomp)
         rescue
-          # Malformed and failed commands should be ignored
+          # Malformed and failed commands should be ignored, so take no action
         end
       end
     end
@@ -23,12 +25,13 @@ module Lemmibot
     def process_command(command)
       # Process a command string
       case command.upcase
-      when /PLACE/ then place(command)
-      when /MOVE/ then @bot.move
-      when /LEFT/ then @bot.turn(:left)
-      when /RIGHT/ then @bot.turn(:right)
-      when /REPORT/ then report
+      when /^PLACE / then place(command)
+      when 'MOVE' then @bot.move
+      when 'LEFT' then @bot.turn(:left)
+      when 'RIGHT' then @bot.turn(:right)
+      when 'REPORT' then report
       end
+      # All other commands will be silently ignored
     end
 
     def place_arguments(command)

data/lib/lemmibot/version.rb

@@ -1,3 +1,3 @@
 module Lemmibot
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lemmibot
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Effy Elden