another_toy_robot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13301a7680a25a2891de7baf8406ca3e258109c1
+  data.tar.gz: 4df6c3e6ff61ea1acf1a6fcb691dcce15f74fcbc
+SHA512:
+  metadata.gz: 4273e039a8a3d1c91d6c3f8990fdcf935247637f504fd70482ff1896c0d1e9209dcab2a8c78e0120765ca3ffca7055f09dcedd84a9bb6c1b8c65e6550d81667c
+  data.tar.gz: 409cc9a8252052dfad782e6a659268a75f72327a9cbecc47e3ff56f3550324d84e8739efd72e748739376a9e6811be9db5fbfc22d2ff34b5ed6944fbc2061aee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem "pry"
+gem "rspec"
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 drzel
+
+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,79 @@
+[![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)
+
+#Toy Robot Simulator
+
+##Description
+- The application is a simulation of a toy robot moving on a square tabletop, 
+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.
+- Create an application that can read in commands of the following form:
+
+````
+PLACE X,Y,F
+MOVE
+LEFT
+RIGHT
+REPORT
+````
+
+- PLACE will put the toy robot on the table in position X,Y and facing NORTH,
+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.
+- MOVE will move the toy robot one unit forward in the direction it is currently
+facing.
+- LEFT and RIGHT will rotate the robot 90 degrees in the specified direction
+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.
+- A robot that is not on the table can choose the ignore the MOVE, LEFT, RIGHT
+and REPORT commands.
+- Input can be from a file, or from standard input, as the developer chooses.
+- Provide test data to exercise the application.
+
+##Constraints
+The toy robot must not fall off the table during movement. This also includes 
+the initial placement of the toy robot. Any move that would cause the robot 
+to fall must be ignored.
+
+##Example Input and Output
+a)
+````
+PLACE 0,0,NORTH
+MOVE
+REPORT
+````
+Output: ````0,1,NORTH````
+
+b)
+````
+PLACE 0,0,NORTH
+LEFT
+REPORT
+````
+Output: ````0,0,WEST````
+
+c)
+````
+PLACE 1,2,EAST
+MOVE
+MOVE
+LEFT
+MOVE
+REPORT
+````
+Output: ````3,3,NORTH````
+
+##Deliverables
+The source files, the test data and any test code.
+
+It is not required to provide any graphical output showing the movement of the
+toy robot. 

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/toy_robot

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

data/lib/toy_robot/arena.rb

@@ -0,0 +1,28 @@
+class Arena
+  attr_accessor :width, :height
+
+  def initialize(width:, height:)
+    @width  = width
+    @height = height
+  end
+
+  def inbounds?(x, y)
+    x.between?(0, max_x) && y.between?(0, max_y)
+  end
+
+  private
+
+  def max_x
+    width - 1
+  end
+
+  def max_y
+    height - 1
+  end
+end
+
+class NullArena
+  def inbounds?(*)
+    true
+  end
+end

data/lib/toy_robot/client.rb

@@ -0,0 +1,24 @@
+class Client
+  def initialize
+    @robot = Robot.new
+    @table = Arena.new width: 5, height: 5
+  end
+
+  def instruction(input)
+    command = case input
+              when /place\s+(\d+,\s*){2}[nesw]/
+                PlaceCommand.new robot: @robot, arena: @table, 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
+  end
+end

data/lib/toy_robot/command.rb

@@ -0,0 +1,63 @@
+class PlaceCommand
+  def initialize(robot:, arena: NullArena.new, command:)
+    @robot  = robot
+    @arena  = arena
+    @params = command[/\s.*/].delete(" ").split(",")
+  end
+
+  def execute
+    position = NullPosition.new arena: @arena
+    position = position.go_to(x:         @params[0].to_i,
+                              y:         @params[1].to_i,
+                              direction: @params[2].to_sym)
+    @robot.position = position
+  end
+end
+
+class MoveCommand
+  def initialize(robot:)
+    @robot = robot
+  end
+
+  def execute
+    @robot.move
+  end
+end
+
+class LeftCommand
+  def initialize(robot:)
+    @robot = robot
+  end
+
+  def execute
+    @robot.left
+  end
+end
+
+class RightCommand
+  def initialize(robot:)
+    @robot = robot
+  end
+
+  def execute
+    @robot.right
+  end
+end
+
+class ReportCommand
+  def initialize(robot:)
+    @robot = robot
+  end
+
+  def execute
+    @robot.report
+  end
+end
+
+class InvalidCommand
+  def intialize; end
+
+  def execute
+    puts "Invalid command"
+  end
+end

data/lib/toy_robot/position.rb

@@ -0,0 +1,64 @@
+class Position
+  attr_accessor :arena
+
+  def initialize(arena: NullArena.new, **args)
+    @arena = arena
+    post_initialize args
+  end
+
+  def go_to(x: @x_coord, y: @y_coord, direction: @direction)
+    if @arena.inbounds? x, y
+      RealPosition.new x: x, y: y, direction: direction, arena: @arena
+    else
+      self
+    end
+  end
+end
+
+class RealPosition < Position
+  attr_accessor :x_coord, :y_coord, :direction
+
+  ROTATION     = { left: -1, right: 1 }.freeze
+  DISPLACEMENT = { n: { x:  0, y:  1 },
+                   e: { x:  1, y:  0 },
+                   s: { x:  0, y: -1 },
+                   w: { x: -1, y:  0 } }.freeze
+
+  def post_initialize(x: 0, y: 0, direction: :n)
+    @x_coord   = x
+    @y_coord   = y
+    @direction = direction
+  end
+
+  def advance
+    new_x = @x_coord + DISPLACEMENT[@direction][:x]
+    new_y = @y_coord + DISPLACEMENT[@direction][:y]
+    go_to x: new_x, y: new_y
+  end
+
+  def turn(hand_side)
+    compass = DISPLACEMENT.keys
+    index = (compass.find_index(@direction) + ROTATION[hand_side]) % 4
+    go_to direction: compass[index]
+  end
+
+  def to_s
+    "#{@x_coord}, #{@y_coord}, #{@direction}"
+  end
+end
+
+class NullPosition < Position
+  def post_initialize(*); end
+
+  def advance
+    self
+  end
+
+  def turn(*)
+    self
+  end
+
+  def to_s
+    "No position"
+  end
+end

data/lib/toy_robot/robot.rb

@@ -0,0 +1,23 @@
+class Robot
+  attr_accessor :position
+
+  def initialize(position: NullPosition.new)
+    @position = position
+  end
+
+  def move
+    @position = @position.advance
+  end
+
+  def left
+    @position = @position.turn :left
+  end
+
+  def right
+    @position = @position.turn :right
+  end
+
+  def report
+    puts @position.to_s
+  end
+end

data/lib/toy_robot/version.rb

@@ -0,0 +1,3 @@
+module ToyRobot
+  VERSION = "0.1.0"
+end

data/lib/toy_robot.rb

@@ -0,0 +1,19 @@
+require "pry"
+require "toy_robot/client"
+require "toy_robot/robot"
+require "toy_robot/arena"
+require "toy_robot/command"
+require "toy_robot/position"
+
+module ToyRobot
+  def self.main
+    client = Client.new
+
+    loop do
+      print "Input command: "
+      input = gets.strip
+      break if input == "exit"
+      client.instruction input
+    end
+  end
+end

data/toy_robot.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'toy_robot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "another_toy_robot"
+  spec.version       = ToyRobot::VERSION
+  spec.date          = "2016-11-27"
+  spec.authors       = "Sheldon J. Johnson"
+  spec.email         = "sheldon.j.johnson@outlook.com"
+  spec.homepage      = "https://github.com/drzel/toy_robot"
+  spec.summary       = "Another toy robot demonstration app"
+  spec.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."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "bin"
+  spec.executables  << "toy_robot"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: another_toy_robot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon J. Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies: []
+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.
+email: sheldon.j.johnson@outlook.com
+executables:
+- toy_robot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/position.rb
+- lib/toy_robot/robot.rb
+- lib/toy_robot/version.rb
+- toy_robot.gemspec
+homepage: https://github.com/drzel/toy_robot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Another toy robot demonstration app
+test_files: []