another_toy_robot 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43ea9ed6146a026f2e64bf8fb0c9190950f8ae76
-  data.tar.gz: ea3faa443089ea8a429f6f8305b5c3fcb7a99873
+  metadata.gz: fbbb001b13b2aece8fbc3472fde61dbd182f15a2
+  data.tar.gz: f082074f51a05499991610fa313020112bd53cf8
 SHA512:
-  metadata.gz: 556f6c6f940b2079d8be8c87d7ac853541d1ed2aadc097f3a5ef665f2950289e4b64891ffe0f477110571edafa1998dfd4e8dbba53db875766a042566c6e6b1b
-  data.tar.gz: f1a887cfa16bdd63a2bd36429f43904db8bb0829e255b11a2296fbb357d231d06c6a9c0f4824b828d0c652670af2ff49334830597088a22a5b881074a3200279
+  metadata.gz: a3aca4553c6b12365fc69f971d998570d020a314df936462cfac410db436498b84d0817426bead5838029731b6799a5057597353856d7d03ae6e2f603764ed87
+  data.tar.gz: 2be5502641219c8bd3a7d102a154ca06043cded28d02aebae3cf0fc3ec699dc35572f55fdbf39abde4fa3a25b0d86bbd75def000f3769cf2645c84dc8f82c5b0

data/Gemfile

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in toy_robot.gemspec
+# Specify your gem's dependencies in another_toy_robot.gemspec
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/another_toy_robot.svg)](https://badge.fury.io/rb/another_toy_robot)
-[![Code Climate](https://codeclimate.com/github/drzel/toy_robot/badges/gpa.svg)](https://codeclimate.com/github/drzel/toy_robot)
-[![Test Coverage](https://codeclimate.com/github/drzel/toy_robot/badges/coverage.svg)](https://codeclimate.com/github/drzel/toy_robot/coverage)
-[![Build Status](https://travis-ci.org/drzel/toy_robot.svg?branch=master)](https://travis-ci.org/drzel/toy_robot)
+[![Code Climate](https://codeclimate.com/github/drzel/another_toy_robot/badges/gpa.svg)](https://codeclimate.com/github/drzel/another_toy_robot)
+[![Test Coverage](https://codeclimate.com/github/drzel/another_toy_robot/badges/coverage.svg)](https://codeclimate.com/github/drzel/another_toy_robot/coverage)
+[![Build Status](https://travis-ci.org/drzel/another_toy_robot.svg?branch=master)](https://travis-ci.org/drzel/another_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. It is commonly used as an code-test. See specifications below for the full text of the test.
@@ -24,8 +24,8 @@ $ gem install another_toy_robot
 
 Alternatively it can be built from source:
 ```
-$ git clone https://github.com/drzel/toy_robot.git
-$ cd toy_robot
+$ git clone https://github.com/drzel/another_toy_robot.git
+$ cd another_toy_robot
 $ bundle install
 ```
 
@@ -39,7 +39,7 @@ Unit tests are written to [Sandi Metz' Unit Testing Minimalist](https://youtu.be
 
 ### Usage
 ```
-$ toy_robot
+$ another_toy_robot
 ```
 
 This will present a prompt:
@@ -66,32 +66,29 @@ The app implements:
 - 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:
+`another_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
+require "another_toy_robot"
+AnotherToyRobot.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`.
+`AnotherToyRobot#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:
 
-- The main loop does the following:
 - Requests user input
 - Instantiates a new `Input` object
-- Passes the new `Input` object to the client
+- Passes the new `Input` object to the client's `#command_for` method
 
 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 `Client#command_for` method 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 `#left`, `#right` or `#move`, the robot will pass the request to its `@position` which will respond with the new position. The `#place` method obtains it's position from the commands parameters. Then `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.
 
@@ -102,7 +99,7 @@ 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.
+The `Input` wrapper allows new commands to be easily added. E.g. Creating a new file `lib/another_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/another_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.
 

data/{toy_robot.gemspec → another_toy_robot.gemspec}

@@ -1,15 +1,15 @@
 # coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "toy_robot/version"
+require "another_toy_robot/version"
 
 Gem::Specification.new do |spec|
   spec.name                  = "another_toy_robot"
-  spec.version               = ToyRobot::VERSION
+  spec.version               = AnotherToyRobot::VERSION
   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"
+  spec.homepage              = "https://github.com/drzel/another_toy_robot"
   spec.summary               = "Another toy robot demonstration app"
   spec.required_ruby_version = ">= 2.3"
   spec.license               = "MIT"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.bindir = "bin"
-  spec.executables << "toy_robot"
+  spec.executables << "another_toy_robot"
 
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "rake", "~> 11.3"

data/bin/another_toy_robot

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "another_toy_robot"
+AnotherToyRobot.main

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "toy_robot"
+require "another_toy_robot"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/{toy_robot.rb → another_toy_robot.rb}

@@ -1,7 +1,7 @@
-require "toy_robot/client"
-require "toy_robot/input"
+require "another_toy_robot/client"
+require "another_toy_robot/input"
 
-module ToyRobot
+module AnotherToyRobot
   def self.main
     client = Client.new
 

data/lib/{toy_robot → another_toy_robot}/client.rb

@@ -1,5 +1,5 @@
-require "toy_robot/arena"
-require "toy_robot/robot"
+require "another_toy_robot/arena"
+require "another_toy_robot/robot"
 
 class Client
   def initialize

data/lib/{toy_robot → another_toy_robot}/input.rb

@@ -1,9 +1,9 @@
-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"
+require "another_toy_robot/move_command"
+require "another_toy_robot/left_command"
+require "another_toy_robot/right_command"
+require "another_toy_robot/place_command"
+require "another_toy_robot/report_command"
+require "another_toy_robot/invalid_command"
 
 class Input
   def initialize(input)

data/lib/{toy_robot → another_toy_robot}/invalid_command.rb

@@ -1,4 +1,4 @@
-require "toy_robot/command"
+require "another_toy_robot/command"
 
 class InvalidCommand < Command
   def execute

data/lib/{toy_robot → another_toy_robot}/left_command.rb

@@ -1,4 +1,4 @@
-require "toy_robot/command"
+require "another_toy_robot/command"
 
 class LeftCommand < Command
   def issue_command

data/lib/{toy_robot → another_toy_robot}/move_command.rb

@@ -1,4 +1,4 @@
-require "toy_robot/command"
+require "another_toy_robot/command"
 
 class MoveCommand < Command
   def issue_command

data/lib/{toy_robot → another_toy_robot}/place_command.rb

@@ -1,4 +1,4 @@
-require "toy_robot/command"
+require "another_toy_robot/command"
 
 class PlaceCommand < Command
   def post_initialize

data/lib/{toy_robot → another_toy_robot}/position.rb

@@ -1,4 +1,4 @@
-require "toy_robot/direction"
+require "another_toy_robot/direction"
 
 class Position
   attr_reader :x_coord, :y_coord, :direction

data/lib/{toy_robot → another_toy_robot}/report_command.rb

@@ -1,4 +1,4 @@
-require "toy_robot/command"
+require "another_toy_robot/command"
 
 class ReportCommand < Command
   def issue_command

data/lib/{toy_robot → another_toy_robot}/right_command.rb

@@ -1,4 +1,4 @@
-require "toy_robot/command"
+require "another_toy_robot/command"
 
 class RightCommand < Command
   def issue_command

data/lib/{toy_robot → another_toy_robot}/robot.rb

@@ -1,6 +1,6 @@
-require "toy_robot/position"
-require "toy_robot/null_position"
-require "toy_robot/arena"
+require "another_toy_robot/position"
+require "another_toy_robot/null_position"
+require "another_toy_robot/arena"
 
 class Robot
   attr_reader :position, :arena

data/lib/another_toy_robot/version.rb

@@ -0,0 +1,3 @@
+module AnotherToyRobot
+  VERSION = "0.1.10".freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: another_toy_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Sheldon J. Johnson
@@ -85,7 +85,7 @@ description: The application is a simulation of a toy robot moving on a square t
   pattern.
 email: sheldon.j.johnson@outlook.com
 executables:
-- toy_robot
+- another_toy_robot
 extensions: []
 extra_rdoc_files: []
 files:
@@ -97,27 +97,27 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- another_toy_robot.gemspec
+- bin/another_toy_robot
 - bin/console
 - bin/setup
-- bin/toy_robot
-- lib/toy_robot.rb
-- lib/toy_robot/arena.rb
-- 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
-homepage: https://github.com/drzel/toy_robot
+- lib/another_toy_robot.rb
+- lib/another_toy_robot/arena.rb
+- lib/another_toy_robot/client.rb
+- lib/another_toy_robot/command.rb
+- lib/another_toy_robot/direction.rb
+- lib/another_toy_robot/input.rb
+- lib/another_toy_robot/invalid_command.rb
+- lib/another_toy_robot/left_command.rb
+- lib/another_toy_robot/move_command.rb
+- lib/another_toy_robot/null_position.rb
+- lib/another_toy_robot/place_command.rb
+- lib/another_toy_robot/position.rb
+- lib/another_toy_robot/report_command.rb
+- lib/another_toy_robot/right_command.rb
+- lib/another_toy_robot/robot.rb
+- lib/another_toy_robot/version.rb
+homepage: https://github.com/drzel/another_toy_robot
 licenses:
 - MIT
 metadata: {}

data/bin/toy_robot

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-require "toy_robot"
-ToyRobot.main

data/lib/toy_robot/version.rb

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