loco_bot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef33dd6ab2797541d85647722519e50e1fcf5c56
+  data.tar.gz: 2695c38bbc217dd317ba7ab67cfc6681e4034be7
+SHA512:
+  metadata.gz: 713365f6dd107ae2ac6410e192d5f77d4da7fd60590f289b409967e29dad9a83987103a6be79800092d0d02eba6b27a15b1f28dec10ac205736b1b4b0db69526
+  data.tar.gz: 511a8c28a3cfcd05ceb5b925f15c4cebfa250ca6a7b219657403c80d829add94e1c070248112b6260641a6805a94f505aa4a49828696ba914941d776663de2ac

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+
+script: 'bundle exec rake test'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafaël Gonzalez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,393 @@
+[![Build Status](https://travis-ci.org/rafaelgonzalez/loco_bot.svg?branch=master)](https://travis-ci.org/rafaelgonzalez/loco_bot)
+[![Dependency Status](https://gemnasium.com/rafaelgonzalez/loco_bot.svg)](https://gemnasium.com/rafaelgonzalez/loco_bot)
+[![Test Coverage](https://codeclimate.com/github/rafaelgonzalez/loco_bot/badges/coverage.svg)](https://codeclimate.com/github/rafaelgonzalez/loco_bot)
+[![Code Climate](https://codeclimate.com/github/rafaelgonzalez/loco_bot/badges/gpa.svg)](https://codeclimate.com/github/rafaelgonzalez/loco_bot)
+
+# LocoBot
+
+Ruby gem of crazy robots and benevolent tables that keep watching over them.
+
+Issue commands to control the robots and the tables will keep you from making them fall.
+
+> You monster!
+
+> *- GLadOS*
+
+## Rules
+
+- Robots can not move until placed on a table.
+- Robots are free to roam around the surface of the table, but will be prevented from
+  - falling from the table
+  - crashing into other robots on the same table
+
+## Installation
+
+Via RubyGems:
+
+    $ gem install loco_bot
+
+Or in a Gemfile:
+
+    gem 'loco_bot'
+
+## Usage
+
+### Command line interface
+
+From the CLI, you can place a robot on a table of 5x5 and play around with it.
+
+This means you only have a unique instance of `Robot` and `Table` available through this interface.
+
+To use multiple robots and tables, see the API usage further below.
+
+#### Manual input
+
+Just run the binary and start typing commands:
+
+    $ loco_bot_cli
+
+Available commands are:
+
+- **PLACE X,Y,F**
+
+  Puts the robot on the table in position X,Y and facing NORTH, SOUTH, EAST or WEST.
+
+- **MOVE**
+
+  Moves the robot one unit forward in the direction it is currently facing.
+
+- **LEFT** and **RIGHT**
+
+  Rotates the robot 90 degrees in the specified direction without changing its position.
+
+- **REPORT**
+
+  Announces the X,Y and F of the robot.
+
+- **HODOR**
+
+  Outputs a friendly greating.
+
+Example:
+
+    $ loco_bot_cli
+    PLACE 1,2,SOUTH
+    MOVE
+    LEFT
+    MOVE
+    MOVE
+    REPORT
+    0,4,EAST
+
+#### Input from files
+
+You can also use files to issue commands, like so:
+
+    $ loco_bot_cli < ./spec/support/test_1.txt
+
+### API
+
+Full documentation is available [here](http://rubydoc.info/github/rafaelgonzalez/locobot/master/frames).
+
+#### LocoBot::Table
+
+##### #new
+
+You can specify the dimensions of the `Table`. Default dimensions are 5x5.
+
+```ruby
+table = LocoBot::Table.new
+table.width # => 5
+table.height # => 5
+
+table = LocoBot::Table.new(20, 25)
+table.width # => 20
+table.height # => 25
+```
+
+##### #place_robot
+
+Place the given `Robot` on the `Table`.
+
+This method works the same way as `Robot#place`, only a `Robot` is passed as first argument instead of a `Table`.
+
+Placing a `Robot` on a `Table` will:
+
+- update the `Table`'s list of `Robot`s
+
+  ```ruby
+  robot = LocoBot::Robot.new
+  table = LocoBot::Table.new(10, 20)
+
+  table.robots # => []
+
+  table.place_robot(robot, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+  table.robots # => [#<LocoBot::Robot:0x007f9212e7ad5>]
+  ```
+
+- update the `Robot`'s positions
+
+  ```ruby
+  robot = LocoBot::Robot.new
+  table = LocoBot::Table.new(10, 20)
+
+  robot.x # => nil
+  robot.y # => nil
+  robot.direction # => nil
+  robot.table # => nil
+
+  table.place_robot(robot, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+  robot.x # => 2
+  robot.y # => 3
+  robot.direction # => LocoBot::Robot::Direction::North
+  robot.table # => #<LocoBot::Table:0x007f9212e62480 @width=10, @height=20>
+  ```
+
+A `Robot` can not be placed on a spot outside the `Table`.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new(10, 20)
+
+table.place_robot(robot, 100, 12, LocoBot::Robot::Direction::North) # => false
+
+robot.table # => nil
+table.robots # => []
+```
+
+A `Robot` can not be placed on a spot of the `Table` where there is another `Robot`.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new(10, 20)
+
+table.place_robot(LocoBot::Robot.new, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+table.place_robot(robot, 2, 3, LocoBot::Robot::Direction::East) # => false
+
+robot.table # => nil
+table.robots.count # => 1
+```
+
+##### #remove_robot
+
+Removes the given `Robot` from the `Table`.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new(10, 20)
+table.place_robot(robot, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+table.robots # => [#<LocoBot::Robot:0x007f9212e7ad5>]
+robot.table # => #<LocoBot::Table:0x007f9212e62480 @width=10, @height=20>
+
+table.remove_remove(robot)
+
+table.robots # => []
+robot.table # => nil
+```
+
+#### LocoBot::Robot
+
+All the following methods, except for `#report` and `#hodor`, return a `Boolean`.
+
+If they return `true`, the operation as succeded and the state of the Robot has changed. They will return `false` otherwise.
+
+##### #place
+
+Place the `Robot` on the given `Table`.
+
+This method works the same way as `Table#place_robot`, only a `Table` is passed as first argument instead of a `Robot`.
+
+Placing a `Robot` on a `Table` will:
+
+- update the `Table`'s list of `Robot`s
+
+  ```ruby
+  robot = LocoBot::Robot.new
+  table = LocoBot::Table.new(10, 20)
+
+  table.robots # => []
+
+  robot.place(table, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+  table.robots # => [#<LocoBot::Robot:0x007f9212e7ad5>]
+  ```
+
+- update the `Robot`'s positions
+
+  ```ruby
+  robot = LocoBot::Robot.new
+  table = LocoBot::Table.new(10, 20)
+
+  robot.x # => nil
+  robot.y # => nil
+  robot.direction # => nil
+  robot.table # => nil
+
+  robot.place(table, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+  robot.x # => 2
+  robot.y # => 3
+  robot.direction # => LocoBot::Robot::Direction::North
+  robot.table # => #<LocoBot::Table:0x007f9212e62480 @width=10, @height=20>
+  ```
+
+A `Robot` can not be placed on a spot outside the `Table`.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new(10, 20)
+
+robot.place(table, 100, 12, LocoBot::Robot::Direction::North) # => false
+
+robot.table # => nil
+table.robots # => []
+```
+
+A `Robot` can not be placed on a spot of the `Table` where there is another `Robot`.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new(10, 20)
+
+LocoBot::Robot.new.place(table, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+robot.place(table, 2, 3, LocoBot::Robot::Direction::East) # => false
+
+robot.table # => nil
+table.robots.count # => 1
+```
+
+##### #remove
+
+Removes the `Robot` from its current `Table`.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new(10, 20)
+robot.place(table, 2, 3, LocoBot::Robot::Direction::North) # => true
+
+table.robots # => [#<LocoBot::Robot:0x007f9212e7ad5>]
+robot.table # => #<LocoBot::Table:0x007f9212e62480 @width=10, @height=20>
+
+robot.remove
+
+table.robots # => []
+robot.table # => nil
+```
+
+##### #turn_left, #turn_right
+
+Changes the `Robot`'s facing direction without changing its position.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new
+
+robot.place(table, 2, 3, LocoBot::Robot::Direction::West)
+robot.direction # => LocoBot::Robot::Direction::West
+
+robot.turn_right # => true
+robot.direction # => LocoBot::Robot::Direction::North
+
+robot.turn_left # => true
+robot.direction # => LocoBot::Robot::Direction::West
+```
+
+##### #move
+
+Moves the robot one unit forward in the direction it is currently facing.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new
+
+robot.place(table, 2, 3, LocoBot::Robot::Direction::West)
+
+robot.move # => true
+
+robot.x # => 1
+robot.y # => 3
+```
+
+The robot will not move if it makes it fall out of the table.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new
+
+robot.place(table, 0, 0, LocoBot::Robot::Direction::South)
+
+robot.move # => false
+
+robot.x # => 0
+robot.y # => 0
+```
+
+It will not move either if there is another robot on the destination spot.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new
+
+LocoBot::Robot.new.place(table, 0, 0, LocoBot::Robot::Direction::South)
+
+robot.move # => false
+
+robot.x # => 0
+robot.y # => 0
+```
+
+##### #report
+
+Returns a Hash describing the `Robot`'s position and facing direction.
+
+```ruby
+robot = LocoBot::Robot.new
+table = LocoBot::Table.new
+
+robot.place(table, 2, 3, LocoBot::Robot::Direction::West)
+
+robot.report
+# => {x: 2, y: 3, direction: LocoBot::Robot::Direction::West}
+```
+
+##### #hodor!
+
+Outputs a friendly message.
+
+```ruby
+LocoBot::Robot.new.hodor!
+# stdout => "HODOR HODOR !\n"
+```
+
+#### LocoBot::CLI
+
+You can still access the command line interface through code.
+
+```ruby
+cli = LocoBot::CLI.new
+
+cli.input!('PLACE 1,2,WEST')
+
+cli.robot.x # => 1
+cli.robot.y # => 2
+cli.robot.direction # => LocoBot::Robot::Direction::West
+```
+
+## License
+
+Copyright 2014 Rafaël Gonzalez
+
+Released under the terms of the MIT licence. See the LICENSE file for more details.
+
+## Contributing
+
+1. Fork it ( https://github.com/rafaelgonzalez/loco_bot/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :test
+
+desc 'Run the test suite'
+task test: :spec

data/bin/loco_bot_cli

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'loco_bot'
+
+cli = LocoBot::CLI.new
+
+while input = STDIN.gets
+  cli.input!(input)
+end

data/lib/loco_bot/cli/command/base.rb

@@ -0,0 +1,28 @@
+module LocoBot
+  class CLI
+    module Command
+      # Parent class for Command classes.
+      class Base
+
+        # @!attribute [r] table
+        # @return [Robot] the Robot
+        attr_reader :robot
+
+        # @!attribute [r] table
+        # @return [Table] the Table
+        attr_reader :table
+
+        def initialize(robot, table)
+          @robot = robot
+          @table = table
+        end
+
+        # Returns the Command's label.
+        # @return [String] the Command's label
+        def self.label
+          self.name.split("::").last.upcase
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command/hodor.rb

@@ -0,0 +1,14 @@
+module LocoBot
+  class CLI
+    module Command
+      # Upon execution, outputs a string to STDOUT.
+      class Hodor < Base
+        # Executes the command.
+        # @return [void]
+        def execute
+          robot.hodor!
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command/left.rb

@@ -0,0 +1,14 @@
+module LocoBot
+  class CLI
+    module Command
+      # Upon execution, calls #turn_left on the robot attribute.
+      class Left < Base
+        # Executes the command.
+        # @return [Boolean] true if the operation succeeded, false otherwise.
+        def execute
+          robot.turn_left
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command/move.rb

@@ -0,0 +1,14 @@
+module LocoBot
+  class CLI
+    module Command
+      # Upon execution, calls #move on the robot attribute.
+      class Move < Base
+        # Executes the command.
+        # @return [Boolean] true if the operation succeeded, false otherwise.
+        def execute
+          robot.move
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command/place.rb

@@ -0,0 +1,17 @@
+module LocoBot
+  class CLI
+    module Command
+      # Upon execution, calls #place on the robot attribute.
+      class Place < Base
+        # Executes the command.
+        # Calls #place on the robot attribute, passing the table attribute and the given arguments.
+        # @return [Boolean] true if the operation succeeded, false otherwise.
+        def execute(x, y, direction_name)
+          direction = Robot::Direction.from_name(direction_name)
+
+          robot.place(table, x.to_i, y.to_i, direction)
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command/report.rb

@@ -0,0 +1,18 @@
+module LocoBot
+  class CLI
+    module Command
+      # Upon execution, outputs the robot position to STDOUT.
+      class Report < Base
+        # Executes the command.
+        # @return [void]
+        def execute
+          report = robot.report
+
+          unless report.empty?
+            puts "#{report[:x]},#{report[:y]},#{report[:direction].label}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command/right.rb

@@ -0,0 +1,14 @@
+module LocoBot
+  class CLI
+    module Command
+      # Upon execution, calls #turn_right on the robot attribute.
+      class Right < Base
+        # Executes the command.
+        # @return [Boolean] true if the operation succeeded, false otherwise.
+        def execute
+          robot.turn_right
+        end
+      end
+    end
+  end
+end

data/lib/loco_bot/cli/command.rb

@@ -0,0 +1,34 @@
+require 'loco_bot/cli/command/base'
+require 'loco_bot/cli/command/hodor'
+require 'loco_bot/cli/command/left'
+require 'loco_bot/cli/command/move'
+require 'loco_bot/cli/command/place'
+require 'loco_bot/cli/command/report'
+require 'loco_bot/cli/command/right'
+
+module LocoBot
+  class CLI
+    # Top-level namespace for available commands.
+    module Command
+
+      # Returns the list of available commands.
+      # @return [Array<String>] the list of available commands
+      def self.list
+        list = constants.map {|const| const.to_s.upcase}
+        list.delete('BASE')
+        list
+      end
+
+      # Returns a Command class that as the same name as the given name.
+      # @param name [String] the Command name
+      # @return [Command] the Command
+      def self.class_from_name(name)
+        return nil if name.nil? or name.capitalize.to_s == 'Base'
+
+        if const_defined?(name.capitalize, false)
+          const_get(name.capitalize)
+        end
+      end
+    end
+  end
+end