another_toy_robot 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c172c05d49f128057d23173ff7b4dd448378db9
-  data.tar.gz: e2c7f21029d0cdca40e142ed3cce0a8afd185d3c
+  metadata.gz: a8d1128303c93b1075d61df54fa152297c37f8d3
+  data.tar.gz: f7eb58a07a7333905b4655d9032c3fdd83d7aae8
 SHA512:
-  metadata.gz: a6544b8a114e7ae2266077ff6491ef35aaa9b629e945fb268a56862c0f28b68ef9edaf817f543d07b2e0b15aa2be97e1d689d7a479f9f3fcf0643e968a0c0cbd
-  data.tar.gz: 638af44750a27e6ffdb62fffcc3717a1eb06240ded47d21cb5c07e0e4363997849a221ccb5fe1085e1f32bbbb477412293e802682c3aa7e2e2a9a855ac354912
+  metadata.gz: 7360190bc39b05b0ba27907ba6174cc0c683dfd9d4fd85436297568643f9634eddacdb5759d84450bbd2a96db3fc482d6bfb3a303cfc5361731ce862e56ed5d4
+  data.tar.gz: bf0b75a09de010a969ce596a2f839fb0802e4828f91c048554aa501c6bc13f18721149bc2f78099566b376656dfe02bd8ae381ab56dbba06e6446c66a65fd0a4

data/README.md

@@ -7,6 +7,9 @@ The application is a simulation of a toy robot moving on a 5 x 5 unit tabletop.
 is an example of a well tested, object oriented design, employing the command design
 pattern.
 
+### Dependencies
+Requires Ruby 2.3 or later.
+
 ### Installation
 ```
 gem install another_toy_robot
@@ -26,13 +29,14 @@ Valid commands are:
 
 | Command       | Description
 | ------------- | ---
-| `place x,y,d` | Places robot at position `x`, `y`, facing cardinal direction `d`. E.g. `place 1,2,n`.
+| `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.
 | `move`        | Advances the robot one position in the direction it is currently facing.
 | `report`      | Prints the current location.
+| `exit`        | Closes the application.
 
-Commands resulting in the robot moving to an out-of-bounds position (`x` or `y` being `< 0` or `> 4`) will be ignored.
+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.
 
 ## Specification
 

data/lib/toy_robot/client.rb

@@ -4,7 +4,7 @@ class Client
     @robot = Robot.new arena: @table
   end
 
-  def instruction(input)
+  def parse(input)
     command = case input
               when /place\s+(\d+,\s*){2}([nesw]|(north)|(east)|(south)|(west))$/
                 PlaceCommand.new robot: @robot, command: input

data/lib/toy_robot/command.rb

@@ -5,13 +5,21 @@ class PlaceCommand
   end
 
   def execute
-    @robot.place RealPosition.new(x_coord:   @params[0].to_i,
-                                  y_coord:   @params[1].to_i,
-                                  direction: direction)
+    @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.new
@@ -63,8 +71,6 @@ class ReportCommand
 end
 
 class InvalidCommand
-  def intialize; end
-
   def execute
     puts "Invalid command"
   end

data/lib/toy_robot/direction.rb

@@ -1,10 +1,15 @@
-class North
-  attr_reader :x_displacement, :y_displacement, :to_s
+class Direction
+  attr_reader :x_displacement, :y_displacement
 
+  def to_s
+    self.class.to_s.downcase
+  end
+end
+
+class North < Direction
   def initialize
     @x_displacement = 0
     @y_displacement = 1
-    @to_s           = "north"
   end
 
   def left
@@ -16,13 +21,10 @@ class North
   end
 end
 
-class East
-  attr_reader :x_displacement, :y_displacement, :to_s
-
+class East < Direction
   def initialize
     @x_displacement = 1
     @y_displacement = 0
-    @to_s           = "east"
   end
 
   def left
@@ -34,13 +36,10 @@ class East
   end
 end
 
-class South
-  attr_reader :x_displacement, :y_displacement, :to_s
-
+class South < Direction
   def initialize
     @x_displacement = 0
     @y_displacement = -1
-    @to_s           = "south"
   end
 
   def left
@@ -52,13 +51,10 @@ class South
   end
 end
 
-class West
-  attr_reader :x_displacement, :y_displacement, :to_s
-
+class West < Direction
   def initialize
     @x_displacement = -1
     @y_displacement = 0
-    @to_s           = "west"
   end
 
   def left

data/lib/toy_robot/null_position.rb

@@ -0,0 +1,18 @@
+class NullPosition
+  attr_reader :x_coord, :y_coord, :direction, :to_s
+
+  def initialize
+    @x_coord   = nil
+    @y_coord   = nil
+    @direction = nil
+    @to_s      = "No position"
+  end
+
+  def advance
+    self
+  end
+
+  def turn(*)
+    self
+  end
+end

data/lib/toy_robot/position.rb

@@ -1,4 +1,4 @@
-class RealPosition
+class Position
   attr_reader :x_coord, :y_coord, :direction
 
   def initialize(x_coord: 0, y_coord: 0, direction: North.new)
@@ -10,11 +10,11 @@ class RealPosition
   def advance
     x = @x_coord + @direction.x_displacement
     y = @y_coord + @direction.y_displacement
-    RealPosition.new x_coord: x, y_coord: y, direction: @direction
+    Position.new x_coord: x, y_coord: y, direction: @direction
   end
 
   def turn(hand_side)
-    RealPosition.new(x_coord:   @x_coord,
+    Position.new(x_coord:   @x_coord,
                      y_coord:   @y_coord,
                      direction: @direction.send(hand_side))
   end
@@ -23,25 +23,3 @@ class RealPosition
     "#{@x_coord}, #{@y_coord}, #{@direction}"
   end
 end
-
-class NullPosition
-  attr_reader :x_coord, :y_coord, :direction
-
-  def initialize
-    @x_coord   = nil
-    @y_coord   = nil
-    @direction = nil
-  end
-
-  def advance
-    self
-  end
-
-  def turn(*)
-    self
-  end
-
-  def to_s
-    "No position"
-  end
-end

data/lib/toy_robot/version.rb

@@ -1,3 +1,3 @@
 module ToyRobot
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/toy_robot.rb

@@ -3,24 +3,25 @@ require "toy_robot/client"
 require "toy_robot/robot"
 require "toy_robot/arena"
 require "toy_robot/command"
-require "toy_robot/position"
 require "toy_robot/direction"
+require "toy_robot/position"
+require "toy_robot/null_position"
 
 module ToyRobot
   def self.main
     client = Client.new
 
     loop do
-      command = get_input
-      break if command == "exit"
-      client.instruction command
+      print "Input command: "
+      input = get_input
+      break if input == "exit"
+      client.parse input
     end
   end
 
   private
 
   def self.get_input
-    print "Input command: "
     gets.downcase.strip
   end
 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-11-29"
+  spec.date                  = "2016-11-30"
   spec.authors               = "Sheldon J. Johnson"
   spec.email                 = "sheldon.j.johnson@outlook.com"
   spec.homepage              = "https://github.com/drzel/toy_robot"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: another_toy_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sheldon J. Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies: []
 description: "The application is a simulation of a toy robot moving on a square tabletop.\nIt
   is an example of a well tested, object oriented design, employing the \ncommand
@@ -34,6 +34,7 @@ files:
 - lib/toy_robot/client.rb
 - lib/toy_robot/command.rb
 - lib/toy_robot/direction.rb
+- lib/toy_robot/null_position.rb
 - lib/toy_robot/position.rb
 - lib/toy_robot/robot.rb
 - lib/toy_robot/version.rb