another_toy_robot 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef892b383c68270bf0742d262d9a40ea5047f597
-  data.tar.gz: b97bbf3224f6acbf2077e42cf6c229f5519f1292
+  metadata.gz: 43ea9ed6146a026f2e64bf8fb0c9190950f8ae76
+  data.tar.gz: ea3faa443089ea8a429f6f8305b5c3fcb7a99873
 SHA512:
-  metadata.gz: f9a12c53ddb64381fff8f995bb2e99373e7ad3a7a7c17349f04a9301e2190019aa64640db423fd662be24b009bab55010920f46505e2b2daa10a7c06e87c5a6e
-  data.tar.gz: 7d7b71e62de2720cfd32229e6d6110b0a46704be84628f713449ffd07c95bb4b0cd697dc5d91234726bd663440af411a6f13313b38d4dbbe6339ef93205f9b07
+  metadata.gz: 556f6c6f940b2079d8be8c87d7ac853541d1ed2aadc097f3a5ef665f2950289e4b64891ffe0f477110571edafa1998dfd4e8dbba53db875766a042566c6e6b1b
+  data.tar.gz: f1a887cfa16bdd63a2bd36429f43904db8bb0829e255b11a2296fbb357d231d06c6a9c0f4824b828d0c652670af2ff49334830597088a22a5b881074a3200279

data/Gemfile

@@ -1,14 +1,4 @@
 source "https://rubygems.org"
 
-gem "pry"
-gem "rspec"
-gem "rake"
-gem "factory_girl", "~> 4.0"
-
-group :test do
-  gem "simplecov", require: false
-  gem "codeclimate-test-reporter", "~> 1.0.0"
-end
-
 # Specify your gem's dependencies in toy_robot.gemspec
 gemspec

data/README.md

@@ -4,21 +4,42 @@
 [![Build Status](https://travis-ci.org/drzel/toy_robot.svg?branch=master)](https://travis-ci.org/drzel/toy_robot)
 
 # Another Toy Robot Simulator
-The application is a simulation of a toy robot moving on a 5 x 5 unit tabletop. It
-is an example of a well tested, object oriented design, employing the command design
-pattern.
+The application is a simulation of a toy robot moving on a 5 x 5 unit tabletop. It is an example of a well tested, object oriented design, employing the command design pattern. It is commonly used as an code-test. See specifications below for the full text of the test.
 
-### Dependencies
-Requires Ruby 2.3 or later.
+### Environment
+This application was developed on Ubuntu 16.10 x86_64. It requires Ruby 2.3 or later.
+
+To check your version run:
+```
+$ ruby -v
+```
+
+Information on installing Ruby can be found at [Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/).
 
 ### Installation
+The latest release can be installed via RubyGems:
+```
+$ gem install another_toy_robot
+```
+
+Alternatively it can be built from source:
+```
+$ git clone https://github.com/drzel/toy_robot.git
+$ cd toy_robot
+$ bundle install
+```
+
+### Testing
+The test suite is invoked with:
 ```
-gem install another_toy_robot
+$ bundle exec rspec
 ```
 
+Unit tests are written to [Sandi Metz' Unit Testing Minimalist](https://youtu.be/URSWYvyc42M) guidelines.
+
 ### Usage
 ```
-toy_robot
+$ toy_robot
 ```
 
 This will present a prompt:
@@ -29,7 +50,7 @@ Input command:
 Valid commands are:
 
 | Command       | Description
-| ------------- | ---
+| ---           | ---
 | `place x,y,d` | Places robot at position `x`, `y`, facing cardinal direction `d`. E.g. `place 1,2,north`.
 | `left`        | Rotates robot 90° counter-clockwise.
 | `right`       | Rotates robot 90° clockwise.
@@ -39,16 +60,80 @@ Valid commands are:
 
 Commands resulting in the robot moving to an out-of-bounds position (`x` or `y` being less than 0 or greater than 4) will be ignored.
 
+### Design
+The app implements:
+- The [command pattern](https://en.wikipedia.org/wiki/Command_pattern)
+- The [null-object pattern](https://en.wikipedia.org/wiki/Null_Object_pattern) (for positions)
+- The [singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern) (for directions)
+
+`toy_robot` is an executable in your load path. It is a Ruby script that calls the main function:
+```
+#!/usr/bin/env ruby
+
+require "toy_robot"
+ToyRobot.main
+```
+
+`ToyRobot#main` instantiates a new `Client`. The `Client` instantiates an `Arena` and `Robot` objects. The new `Robot` is initialised with `NullPosition` in the `Arena`.
+
+- The main loop does the following:
+- Requests user input
+- Instantiates a new `Input` object
+- Passes the new `Input` object to the client
+
+The `Input` class contains methods to parse the user input and determine the correct `Command` class for the given command. E.g. `"move"` will resolve a the `MoveCommand` while `"derp"` will resolve `InvalidCommand`.
+
+The client calls the `Input#new_command` method, passing the `@robot` as the target.
+
+The `xCommand` object will parse any arguments provided and call the appropriate action on the `@robot`.
+
+When receiving a `place` method the robot will check with its `@arena` to see if the position is `#inbounds` before assigning the new `Position` to itself.
+
+When receiving `#left`, `#right` or `#move`, the robot will pass the request to its `@position` which will respond with the new position.
+
+The `Robot` will then check with its `@arena` to see if the position is `#inbounds` before assigning the new position to itself.
+
+When receiving a `#left`, `#right` or `#move` message the `NullPosition` will return itself.
+
+When the `Robot` receives `#report` it prints its `@position` as a string.
+
+This process continues until an `"exit"` command is received, breaking the loop.
+
+### Considerations
+Given the requirement for a command line interface to interact with the robot, I settled on the well established and widely used command pattern.
+
+The `Input` wrapper allows new commands to be easily added. E.g. Creating a new file `lib/toy_robot/random_command.rb` and requiring it, would be all that is required for the application to accept the `"random"` command, and it would have access to an array of parameters. Validations can also be added by defining a `valid?` method on the command object. See the `lib/toy_robot/place_command.rb` for an example.
+
+I'm particularly happy with the `Position` class and the `Direction` modules. Together as a unit they have absolutely no dependencies and could be easily reused with new features, new objects, or with changing specifications. It would be reasonably straight forward to add a second robot, or a third dimension.
+
+Currently the `Robot` must be instantiated with an `Arena`. Originally, I had also employed the null object pattern for the `Arena` as well as the position, but as it turned out, with the current specification, there is no situation where a robot is not in an arena, so it was unneeded and removed, reducing overall complexity of the application.
+
+As GINnFIN helpfully pointed out in the [Reddit discussion](https://www.reddit.com/r/ruby/comments/5fptz9/i_did_the_toy_robot_challenge_ive_tried_to_be/), the `Position` `#left` and `#right` methods do necessarily need to return a new instance of `Position`, and could instead mutate the current position in place. While this is true, there is a pleasing symmetry in each of the current `Position` methods returning a new instance of position that would would be lost if these were to be changed. I'm not entirely sure which is better, but have decided to keep the current implementation, as different behaviour for the `place` and `move` methods to the `left` and `right` methods may be unnecessarily increasing the conceptual complexity of the app.
+
+### Licence
+[MIT](https://tldrlegal.com/license/mit-license)
+
+### Contributing
+My goal is to continue to develop this application to use as an example for other developers who are learning Ruby and object oriented design and have attempted to ensure it is SOLID, DRY, OO and TDD.
+
+If you have something to contribute, whether it be to report an bug, suggest a potential improvement or even ask a question, don't hesitate to log an issue.
+
+Pull requests are also warmly welcomed.
+
+### Links
+- [another_toy_robot on RubyGems](https://rubygems.org/gems/another_toy_robot)
+- [Discussion on Reddit](https://www.reddit.com/r/ruby/comments/5fptz9/i_did_the_toy_robot_challenge_ive_tried_to_be/?ref=share&ref_source=link)
+
 ## Specification
 
 ### Description
 - The application is a simulation of a toy robot moving on a square tabletop, 
-of dimensions 5 units x 5 units.
+  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.
+  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:
 
 ```
@@ -60,20 +145,20 @@ REPORT
 ```
 
 - PLACE will put the toy robot on the table in position X,Y and facing NORTH,
-SOUTH, EAST or WEST.
+  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.
+  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.
+  facing.
 - LEFT and RIGHT will rotate the robot 90 degrees in the specified direction
-without changing the position of the robot.
+  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.
+  standard output is sufficient.
 - A robot that is not on the table can choose the ignore the MOVE, LEFT, RIGHT
-and REPORT commands.
+  and REPORT commands.
 - Input can be from a file, or from standard input, as the developer chooses.
 - Provide test data to exercise the application.
 
@@ -118,5 +203,6 @@ toy robot.
 
 ## Acknowledgements
 - [RafaelChefe's Toy Robot Simulator](https://github.com/RafaelChefe/toy_robot)
-- [Wikipedia Command pattern article](https://en.wikipedia.org/wiki/Command_pattern)
-- [Sandi Metz](https://www.sandimetz.com/) :heart:
+- [Sandi Metz' Unit Testing Minimalist](https://youtu.be/URSWYvyc42M)
+- [Daniel Steele](https://uk.linkedin.com/in/developerdansteele) and [Omnidev](https://omnidev.co.uk/)
+

data/lib/toy_robot.rb

@@ -1,11 +1,5 @@
-require "pry"
 require "toy_robot/client"
-require "toy_robot/robot"
-require "toy_robot/arena"
-require "toy_robot/command"
-require "toy_robot/direction"
-require "toy_robot/position"
-require "toy_robot/null_position"
+require "toy_robot/input"
 
 module ToyRobot
   def self.main
@@ -13,13 +7,9 @@ module ToyRobot
 
     loop do
       print "Input command: "
-      input = get_input
-      break if input == "exit"
-      client.parse input
+      input = gets
+      break if input =~ /^\s*exit\s+/
+      client.command_for Input.new(input)
     end
   end
-
-  def self.get_input
-    gets.downcase.strip
-  end
 end

data/lib/toy_robot/arena.rb

@@ -1,20 +1,10 @@
 class Arena
-  def initialize(width:, height:)
-    @width  = width
-    @height = height
+  def initialize(width: 5, height: 5)
+    @columns = 0...width
+    @rows    = 0...height
   end
 
   def inbounds?(x_coord, y_coord)
-    x_coord&.between?(0, max_x) && y_coord&.between?(0, max_y)
-  end
-
-  private
-
-  def max_x
-    @width - 1
-  end
-
-  def max_y
-    @height - 1
+    @columns.cover?(x_coord) && @rows.cover?(y_coord)
   end
 end

data/lib/toy_robot/client.rb

@@ -1,24 +1,13 @@
+require "toy_robot/arena"
+require "toy_robot/robot"
+
 class Client
   def initialize
     @table = Arena.new width: 5, height: 5
     @robot = Robot.new arena: @table
   end
 
-  def parse(input)
-    command = case input
-              when /place\s+(\d+,\s*){2}([nesw]|(north)|(east)|(south)|(west))$/
-                PlaceCommand.new robot: @robot, command: input
-              when "move"
-                MoveCommand.new robot: @robot
-              when "left"
-                LeftCommand.new robot: @robot
-              when "right"
-                RightCommand.new robot: @robot
-              when "report"
-                ReportCommand.new robot: @robot
-              else
-                InvalidCommand.new
-              end
-    command.execute
+  def command_for(input)
+    input.new_command(@robot).execute
   end
 end

data/lib/toy_robot/command.rb

@@ -1,77 +1,21 @@
-class PlaceCommand
-  def initialize(robot:, command:)
-    @robot  = robot
-    @params = command[/\s.*/].delete(" ").split(",")
-  end
-
-  def execute
-    @robot.place Position.new(x_coord:   x_coord,
-                              y_coord:   y_coord,
-                              direction: direction)
-  end
-
-  private
-
-  def x_coord
-    @params[0].to_i
-  end
-
-  def y_coord
-    @params[1].to_i
-  end
-
-  def direction
-    case @params[2]
-    when "n", "north" then North
-    when "e", "east"  then East
-    when "s", "south" then South
-    when "w", "west"  then West
-    end
-  end
-end
-
-class MoveCommand
-  def initialize(robot:)
-    @robot = robot
-  end
-
-  def execute
-    @robot.move
-  end
-end
+class Command
+  attr_accessor :target, :params
 
-class LeftCommand
-  def initialize(robot:)
-    @robot = robot
-  end
+  def initialize(target: nil, params: nil)
+    @target = target
+    @params = params
 
-  def execute
-    @robot.left
+    post_initialize
   end
-end
 
-class RightCommand
-  def initialize(robot:)
-    @robot = robot
-  end
+  def post_initialize; end
 
   def execute
-    @robot.right
+    return InvalidCommand.new.execute unless valid?
+    issue_command
   end
-end
 
-class ReportCommand
-  def initialize(robot:)
-    @robot = robot
-  end
-
-  def execute
-    @robot.report
-  end
-end
-
-class InvalidCommand
-  def execute
-    puts "Invalid command"
+  def valid?
+    true
   end
 end

data/lib/toy_robot/input.rb

@@ -0,0 +1,38 @@
+require "toy_robot/move_command"
+require "toy_robot/left_command"
+require "toy_robot/right_command"
+require "toy_robot/place_command"
+require "toy_robot/report_command"
+require "toy_robot/invalid_command"
+
+class Input
+  def initialize(input)
+    @input = input.strip.downcase
+  end
+
+  def new_command(target)
+    to_class.new target: target, params: params
+  end
+
+  private
+
+  def basename
+    @basename ||= @input.split(" ").first
+  end
+
+  def params
+    @params ||= @input.split(" ").drop 1
+  end
+
+  def classname
+    @classname ||= "#{basename.capitalize}Command"
+  end
+
+  def to_class
+    if Object.const_defined? classname
+      Object.const_get classname
+    else
+      InvalidCommand
+    end
+  end
+end

data/lib/toy_robot/invalid_command.rb

@@ -0,0 +1,7 @@
+require "toy_robot/command"
+
+class InvalidCommand < Command
+  def execute
+    puts "Invalid command"
+  end
+end

data/lib/toy_robot/left_command.rb

@@ -0,0 +1,7 @@
+require "toy_robot/command"
+
+class LeftCommand < Command
+  def issue_command
+    @target.left
+  end
+end

data/lib/toy_robot/move_command.rb

@@ -0,0 +1,7 @@
+require "toy_robot/command"
+
+class MoveCommand < Command
+  def issue_command
+    @target.move
+  end
+end

data/lib/toy_robot/null_position.rb

@@ -1,11 +1,14 @@
 class NullPosition
-  attr_reader :x_coord, :y_coord, :direction, :to_s
+  attr_reader :x_coord, :y_coord, :direction
 
   def initialize
     @x_coord   = nil
     @y_coord   = nil
     @direction = nil
-    @to_s      = "No position"
+  end
+
+  def to_s
+    "No position"
   end
 
   def advance

data/lib/toy_robot/place_command.rb

@@ -0,0 +1,40 @@
+require "toy_robot/command"
+
+class PlaceCommand < Command
+  def post_initialize
+    @params &&= @params.join.delete(" ").split ","
+  end
+
+  def issue_command
+    @target.place Position.new(x_coord:   x_coord,
+                               y_coord:   y_coord,
+                               direction: direction)
+  end
+
+  private
+
+  def valid?
+    @params                 &&
+      @params.length == 3   &&
+      @params[0] =~ /^\d+$/ &&
+      @params[1] =~ /^\d+$/ &&
+      @params[2] =~ /^([nesw]|(north)|(east)|(south)|(west))$/
+  end
+
+  def x_coord
+    @params[0].to_i
+  end
+
+  def y_coord
+    @params[1].to_i
+  end
+
+  def direction
+    case @params[2]
+    when "n", "north" then North
+    when "e", "east"  then East
+    when "s", "south" then South
+    when "w", "west"  then West
+    end
+  end
+end

data/lib/toy_robot/position.rb

@@ -1,3 +1,5 @@
+require "toy_robot/direction"
+
 class Position
   attr_reader :x_coord, :y_coord, :direction
 
@@ -8,24 +10,25 @@ class Position
   end
 
   def advance
-    Position.new(x_coord:   @x_coord + @direction::X_DISPLACEMENT,
-                 y_coord:   @y_coord + @direction::Y_DISPLACEMENT,
-                 direction: @direction)
+    new_position(x_coord: @x_coord + @direction::X_DISPLACEMENT,
+                 y_coord: @y_coord + @direction::Y_DISPLACEMENT)
   end
 
   def left
-    Position.new(x_coord:   @x_coord,
-                 y_coord:   @y_coord,
-                 direction: @direction.left)
+    new_position direction: @direction.left
   end
 
   def right
-    Position.new(x_coord:   @x_coord,
-                 y_coord:   @y_coord,
-                 direction: @direction.right)
+    new_position direction: @direction.right
   end
 
   def to_s
     "#{@x_coord}, #{@y_coord}, #{@direction}"
   end
+
+  private
+
+  def new_position(x_coord: @x_coord, y_coord: @y_coord, direction: @direction)
+    Position.new x_coord: x_coord, y_coord: y_coord, direction: direction
+  end
 end

data/lib/toy_robot/report_command.rb

@@ -0,0 +1,7 @@
+require "toy_robot/command"
+
+class ReportCommand < Command
+  def issue_command
+    @target.report
+  end
+end

data/lib/toy_robot/right_command.rb

@@ -0,0 +1,7 @@
+require "toy_robot/command"
+
+class RightCommand < Command
+  def issue_command
+    @target.right
+  end
+end

data/lib/toy_robot/robot.rb

@@ -1,25 +1,29 @@
+require "toy_robot/position"
+require "toy_robot/null_position"
+require "toy_robot/arena"
+
 class Robot
-  attr_accessor :position, :arena
+  attr_reader :position, :arena
 
-  def initialize(position: NullPosition.new, arena:)
+  def initialize(position: NullPosition.new, arena: Arena.new)
     @position = position
     @arena    = arena
   end
 
-  def place(new_position)
-    @position = safely_go_to new_position
+  def place(position)
+    safely_go_to position
   end
 
   def move
-    @position = safely_go_to @position.advance
+    safely_go_to @position.advance
   end
 
   def left
-    @position = @position.left
+    safely_go_to @position.left
   end
 
   def right
-    @position = @position.right
+    safely_go_to @position.right
   end
 
   def report
@@ -28,11 +32,9 @@ class Robot
 
   private
 
-  def safely_go_to(new_position)
-    if @arena.inbounds? new_position.x_coord, new_position.y_coord
-      new_position
-    else
-      @position
-    end
+  def safely_go_to(position)
+    return unless position.x_coord && position.y_coord
+    return unless @arena.inbounds? position.x_coord, position.y_coord
+    @position = position
   end
 end

data/lib/toy_robot/version.rb

@@ -1,3 +1,3 @@
 module ToyRobot
-  VERSION = "0.1.8".freeze
+  VERSION = "0.1.9".freeze
 end

data/toy_robot.gemspec

@@ -6,7 +6,7 @@ require "toy_robot/version"
 Gem::Specification.new do |spec|
   spec.name                  = "another_toy_robot"
   spec.version               = ToyRobot::VERSION
-  spec.date                  = "2016-12-01"
+  spec.date                  = "2016-12-05"
   spec.authors               = "Sheldon J. Johnson"
   spec.email                 = "sheldon.j.johnson@outlook.com"
   spec.homepage              = "https://github.com/drzel/toy_robot"
@@ -24,4 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.bindir = "bin"
   spec.executables << "toy_robot"
+
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rake", "~> 11.3"
+  spec.add_development_dependency "factory_girl", "~> 4.0"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
 end

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: another_toy_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Sheldon J. Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
-dependencies: []
+date: 2016-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: The application is a simulation of a toy robot moving on a square tabletop.  It
   is an example of a well tested, object oriented design, employing the command design
   pattern.
@@ -35,8 +105,15 @@ files:
 - lib/toy_robot/client.rb
 - lib/toy_robot/command.rb
 - lib/toy_robot/direction.rb
+- lib/toy_robot/input.rb
+- lib/toy_robot/invalid_command.rb
+- lib/toy_robot/left_command.rb
+- lib/toy_robot/move_command.rb
 - lib/toy_robot/null_position.rb
+- lib/toy_robot/place_command.rb
 - lib/toy_robot/position.rb
+- lib/toy_robot/report_command.rb
+- lib/toy_robot/right_command.rb
 - lib/toy_robot/robot.rb
 - lib/toy_robot/version.rb
 - toy_robot.gemspec