toybot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49c78135d65da889f15226744edb5f9112e35f21
+  data.tar.gz: 219588e93302a02dabfb75e147e7481f6d26a1dc
+SHA512:
+  metadata.gz: 4871e41bcbf4d5399648144d05c5ae4fe90227aac8baef2f0554bd0a9284548c1ca39cf746d5457b87dfa53e0c5168255b10278c1c3124afab37f83c70a5ce8a
+  data.tar.gz: 38f92f0f1f4e05e7fd3a71d74c395ccd07efb815066cce60c376addcfbe7acc441e111843831e2bed0f363018c9e193e55e1cecb508002d3c49fcfe2d039aabf

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,117 @@
+# toy-robot
+
+### Description
+
+toy-robot is a simulator of a toy robot that moves on a tabletop.
+
+### Requirements
+
+- You need [RubyGems](https://rubygems.org/pages/download).
+- You need [Bundler](http://bundler.io/)
+
+To install Bundler from rubygems:
+
+```bash
+$ gem install bundler
+```
+
+### Install
+
+```bash
+$ bundle install
+```
+
+This will install the few required dependencies specified in `toybot.gemspec`
+
+**Run tests**
+
+You can check that everything works correctly by running the tests:
+
+```bash
+$ bundle exec rake
+```
+
+### Usage
+
+**Start bot**
+
+```bash
+$ bundle exec bin/toy-robot
+```
+
+It is also possible to give a size to the tabletop like so:
+
+```bash
+$ bundle exec bin/toy-robot WIDTH HEIGHT
+```
+
+### Error handling
+
+- Toybot is quite permissive with the input as long as it respects the number of arguments, and uses the comma separator.
+- Toybot is not very smart, but he is trying. Any invalid input will freak him out and he will display a little notice.
+
+### Implementation details
+
+Toybot is made of several components:
+
+1. Tabletop
+
+The `Tabletop` class is a simple abstraction of a tabletop with a `width` and a `height`.
+
+- By default, the size of the tabletop is infinite.
+- The tabletop only has positive coordinates starting at x(0) and y(0).
+- The tabletop cannot be smaller than 1 by 1.
+
+**where**: `lib/toybot/tabletop.rb`
+
+2. Direction
+
+The `Direction` class abstract the notion of cardinal directions.
+
+- It can be rotated clockwise or counter clockwise of 90deg.
+
+**where**: `lib/toybot/direction.rb`
+
+3. Bot
+
+Finally, our little robot.
+
+- The bot needs to be initialized with a tabletop object.
+- It can be initialized and run in one time with:
+
+```ruby
+Toybot::Bot.start(tabletop)
+```
+
+- It implements internally all the possible actions.
+- Actions are called by passing a message to the bot object, deducted from the input.
+
+**where**: `lib/toybot/bot.rb`
+
+### Specifications
+
+toy-robot is a simulator of a toy robot that moves on a tabletop.
+
+toy-robot reads instructions from STDIN, executing them one at a time until EOF is reached. (On a Linux or OSX system, type C-d to generate an EOF character).
+
+valid commands
+
+PLACE X,Y,FACING
+
+Put the toy robot on the table in position X,Y and facing NORTH, SOUTH, EAST or WEST. If the robot is already placed, issuing another valid PLACE command will place the robot in the newly specified location.
+
+MOVE
+
+Moves the toy robot one unit forward in the direction it is currently facing.
+
+LEFT
+
+Rotates the robot 90 degrees to the left (i.e. counter-clockwise) without changing the position of the robot.
+
+RIGHT
+
+Rotates the robot 90 degrees to the right (i.e. clockwise) without changing the position of the robot.
+
+REPORT
+
+Announces the X,Y and F of the robot.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "toybot"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/toy-robot

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'toybot'
+
+if ARGV.size == 2
+  tabletop = Toybot::Tabletop.new width: ARGV[0].to_i, height: ARGV[1].to_i
+else
+  tabletop = Toybot::Tabletop.new
+end
+
+Toybot::Bot.start tabletop

data/lib/toybot.rb

@@ -0,0 +1,7 @@
+require "toybot/version"
+require 'toybot/tabletop'
+require 'toybot/bot'
+require 'toybot/direction'
+
+module Toybot
+end

data/lib/toybot/bot.rb

@@ -0,0 +1,173 @@
+class Toybot::Bot
+  # The format of the output of the `#report` method
+  REPORT_FORMAT = "[^_^] *bip bop* -( My position is X:%d Y:%d facing %s! )"
+  ERROR_REPORTS = [
+    "[x_x] *tuuuuut* -( What do you mean? )",
+    "[T_T] *tuuuuut* -( I can't help you, but Siri might... )",
+    "[o_0] *tuuuuut* -( Bonjour, parlez vous francais? )",
+  ]
+  USAGE = <<-EOS
+
+    Here's what you can do:
+    -----------------------
+
+    PLACE X, Y, F - Put the toy robot on the table in position X,Y
+    and facing NORTH, SOUTH, EAST or WEST. If the robot is already
+    placed, issuing another valid PLACE command will place the robot
+    in the newly specified location
+
+    example: PLACE 24, 42, SOUTH
+
+    MOVE
+    Moves the toy robot one unit forward in the direction it is currently
+    facing.
+
+    LEFT
+    Rotates the robot 90 degrees to the left (i.e. counter-clockwise) without
+    changing the position of the robot.
+
+    RIGHT
+    Rotates the robot 90 degrees to the right (i.e. clockwise) without changing
+    the position of the robot.
+
+    REPORT
+    Announces the X,Y and F of the robot.
+
+  EOS
+
+  # Whitelist of actions that the bot knows how to execute
+  ACTIONS = [:place, :move, :left, :right, :report]
+
+  # The bot entry point.
+  # It takes a `Toybot::Tabletop` as the first argument.
+  def self.start tabletop
+    self.new(tabletop).run
+  end
+
+  # Initialize a new `Bot` on a given `Tabletop`
+  # The bot has a default position of `{x: 0, y: 0, facing: :north}`
+  def initialize tabletop = Toybot::Tabletop.new
+    @tabletop = tabletop
+    @x, @y, @facing = 0, 0, Toybot::Direction.new(:north)
+  end
+
+  # Run loop of the bot
+  # Wait for input from STDIN, parse, execute, repeat until EOF
+  def run
+    while (input = $stdin.gets) do
+      action, args = self.parse_input(input)
+      self.execute action, args unless action == :no_action
+    end
+  end
+
+  # Returns the action and an array of arguments.
+  # It does not perform any validation on the input.
+  def parse_input input
+    input = input.chomp
+    arr = input.split
+    action = arr.shift || :no_action
+    return action.downcase.to_sym, arr.join.split(',')
+  end
+
+  # It takes the action and the arguments as first and second arguments.
+  # 1. Validate that the action is whitelisted
+  # 2. Fire the corresponding method, with the arguments if needed.
+  def execute action, args
+    if ACTIONS.include? action
+      if args.any?
+        self.send action, *args
+      else
+        self.send action
+      end
+    else
+      self.report_error
+    end
+  rescue ArgumentError
+    self.report_error
+  end
+
+  ############################################################
+  # Bot actions
+  #
+  # All bot actions return the bot position to facilitate
+  # testing.
+  ############################################################
+
+  def place x, y, facing
+    @x = x.to_i
+    @y = y.to_i
+    @facing.value = facing.downcase.to_sym
+    self.position
+  end
+
+  def right
+    @facing.rotate_clockwise!
+    self.position
+  end
+
+  def left
+    @facing.rotate_counter_clockwise!
+    self.position
+  end
+
+  def move
+    case @facing.value
+    when :north
+      self.move_up
+    when :east
+      self.move_right
+    when :south
+      self.move_down
+    when :west
+      self.move_left
+    end
+    self.position
+  end
+
+  def report
+    puts self.to_s
+    self.position
+  end
+
+  ############################################################
+  # Bot movement rules
+  ############################################################
+
+  def move_down
+    @y -= @y > 0 ? 1 : 0
+  end
+
+  def move_up
+    @y += @y < @tabletop.height ? 1 : 0
+  end
+
+  def move_left
+    @x -= @x > 0 ? 1 : 0
+  end
+
+  def move_right
+    @x += @x < @tabletop.width ? 1 : 0
+  end
+
+
+  ############################################################
+  # Bot reporting
+  ############################################################
+
+  def position
+    {x: @x, y: @y, facing: @facing.value}
+  end
+
+  def to_s
+    REPORT_FORMAT % [@x, @y, @facing.to_s]
+  end
+
+  def report_error
+    puts
+    puts "ERROR REPORT ======================================================================"
+    puts ERROR_REPORTS.sample
+    puts USAGE
+    puts "==================================================================================="
+    puts
+  end
+end

data/lib/toybot/direction.rb

@@ -0,0 +1,25 @@
+class Toybot::Direction
+  attr_reader :value
+
+  DIRECTIONS = [:north, :east, :south, :west]
+
+  def initialize facing = :north
+    self.value = facing
+  end
+
+  def value= facing
+    @value = facing if DIRECTIONS.include? facing
+  end
+
+  def rotate_clockwise!
+    self.value = DIRECTIONS[DIRECTIONS.index(@value) + 1] || DIRECTIONS[0]
+  end
+
+  def rotate_counter_clockwise!
+    self.value = DIRECTIONS[DIRECTIONS.index(@value) - 1]
+  end
+
+  def to_s
+    @value.to_s
+  end
+end

data/lib/toybot/tabletop.rb

@@ -0,0 +1,19 @@
+class Toybot::Tabletop
+  attr_accessor :width, :height
+
+  # Default values for tabletop x & y
+  # +1.0/0.0 => Infinity
+  DEFAULT_TABLETOP_WIDTH = +1.0/0.0
+  DEFAULT_TABLETOP_HEIGHT = +1.0/0.0
+
+  # A Tabletop has a width and height (Infinity by default).
+  # A Tabletop has a minimum size of 1 by 1.
+  def initialize width: DEFAULT_TABLETOP_WIDTH, height: DEFAULT_TABLETOP_HEIGHT
+    @width = width > 0 ? width : 1
+    @height = height > 0 ? height : 1
+  end
+
+  def size
+    {width: self.width, height: self.height}
+  end
+end

data/lib/toybot/version.rb

@@ -0,0 +1,3 @@
+module Toybot
+  VERSION = "1.0.0"
+end

data/toybot.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'toybot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "toybot"
+  spec.version       = Toybot::VERSION
+  spec.authors       = ["Arnaud MESUREUR"]
+  spec.email         = ["arnaud.mesureur@gmail.com"]
+
+  spec.summary       = %q{BIP BOP}
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: toybot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arnaud MESUREUR
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- arnaud.mesureur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/toy-robot
+- lib/toybot.rb
+- lib/toybot/bot.rb
+- lib/toybot/direction.rb
+- lib/toybot/tabletop.rb
+- lib/toybot/version.rb
+- toybot.gemspec
+homepage: 
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: BIP BOP
+test_files: []