toyrobot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38160974bafdf9946e5e665c58b1bf00dccaf40e
+  data.tar.gz: b9a29c8e8df15252a2453517cccda9057818502c
+SHA512:
+  metadata.gz: 05978ae19f8a401719dc7f825127c36575efe3c116bcd8ae5613aad01e74687869e8ca0f889ce79c2976bf122bd2196993f730d1479054299a734f2c86b582c7
+  data.tar.gz: d24163a31a50ad221ebf1c00ca844d9a3bf08fcbb7cdb3a9f68b27f9070f0d6378c5bc3b5aa6eac3b43dad7119eae2a8dbef28c279199e25f6c3d785af13918a

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+## How to contribute
+
+Fork, then clone the repo:
+
+    git clone git@github.com:your-username/toy-robot-simulator.git
+
+Check you ruby and development dependancies versions:
+
+    $ ruby -v
+
+    $ gem list
+
+Make sure the tests pass:
+
+    rake test:all
+
+Make your change. Add tests for your change. Make the tests pass:
+
+    rake test:all
+
+Push to your fork and submit a pull request. Some things that are equal parts necesary/epic:
+
+ * Write tests.
+
+ * Follow a sensible style guide. My pick is [this one](https://github.com/bbatsov/ruby-style-guide).
+
+ * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+ 

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/README.md

@@ -0,0 +1,148 @@
+toy-robot
+===================
+
+A simulation of a toy robot moving on a square tabletop.
+
+
+## Installation
+
+via RubyGems:
+
+    $ gem install toy_robot
+
+
+## Usage
+
+Start the simulator in interactive mode:
+
+    $ toy_robot
+
+Or pipe it a file with commands:
+
+    $ toy_robot < path/to/file
+
+An example file with commands:
+
+    PLACE 1,2,EAST
+    MOVE
+    MOVE
+    LEFT
+    MOVE
+    REPORT
+
+To which the simulator will respond:
+
+    3,3,NORTH
+
+### Simulation Commands
+
+Simulation commands are case-sensitive.
+
+#### PLACE
+
+Puts the robot on the table in position X,Y and facing `NORTH`, `SOUTH`, `EAST` or `WEST`. The origin (0,0) is considered to be the SOUTH WEST most corner. Usage: 
+
+    PLACE 2,1,WEST
+
+#### MOVE
+
+Move the robot one unit forward in the direction it is currently facing. Usage:
+
+    MOVE
+
+#### LEFT
+
+Rotate the robot 90 degrees counter-clockwise. It does not affect its position. Usage:
+
+    LEFT
+
+#### RIGHT
+
+Rotates the robot 90 degrees clockwise. It does not affect its position. Usage:
+
+    RIGHT
+
+#### REPORT
+
+Announce the X,Y and F of the robot. Usage:
+
+    REPORT
+
+Response:
+
+    X,Y,FACING
+
+### Simulation Constraints
+
+* The toy robot is 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 is prevented from falling to destruction.
+
+* Any movement that would result in the robot falling from the table is prevented, however further valid movement commands are still allowed.
+
+* 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 discards all commands in the sequence until a valid PLACE command has been executed.
+
+* A robot that is not on the table ignores the MOVE, LEFT, RIGHT and REPORT commands.
+
+* The application does not provide any graphical output showing the movement of the toy robot.
+
+
+## Dependancies
+
+    ruby version ~> 2.1.0p0
+
+To check your version run:
+
+    $ ruby -v
+
+To learn how to install ruby visit [ruby-lang.org/en/installation/](https://www.ruby-lang.org/en/installation/)
+
+
+## Troubleshooting
+
+### Development environment
+
+ * OSX 10.8.5, ruby 2.1.2p95
+
+Development dependancies:
+
+    rake ~> 10.3
+    minitest ~> 4.7.5
+
+To install them along the gem:
+
+    $ gem install --dev toy_robot
+
+### Compatible environments
+
+* Ubuntu 14.04 x64, ruby 2.1.0p0
+
+* Ubuntu 12.04 x32, ruby 2.1.0p0
+
+### Incompatible enviroments
+
+* ruby < 2.1.0
+
+### Tests
+
+To run unit tests:
+
+    $ rake test
+
+To run integration tests:
+
+    $ rake test:integration
+
+To run all tests:
+
+    $ rake test:all
+
+## Discussion
+
+This piece of software is over-engineered. Over engineering does not feel good.
+
+## Contributing
+
+View [CONTRIBUTING.md](https://github.com/matiasanaya/toy-robot-simulator/blob/master/CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.name = "test:integration"
+  t.test_files = FileList['test/integration/test*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.name = "test:all"
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/bin/toyrobot

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'toy_robot'
+
+ToyRobot::Application.new(ARGV).run

data/data/example_input_a.txt

@@ -0,0 +1,3 @@
+PLACE 0,0,NORTH
+MOVE
+REPORT

data/data/example_input_b.txt

@@ -0,0 +1,3 @@
+PLACE 0,0,NORTH
+LEFT
+REPORT

data/data/example_input_c.txt

@@ -0,0 +1,6 @@
+PLACE 1,2,EAST
+MOVE
+MOVE
+LEFT
+MOVE
+REPORT

data/lib/toy_robot/application.rb

@@ -0,0 +1,38 @@
+require_relative 'factory'
+require_relative 'command/parser'
+
+module ToyRobot
+  class Application
+    def initialize(argv = [], args = {})
+      @input = args[:input] || $stdin
+      @parser = Command::Parser
+      @controller = Factory.create(:controller)
+    end
+
+    def run(options = nil)
+      loop do
+        raw_input = input.gets
+        break unless raw_input
+        raw_input.chomp!
+        debug(raw_input)
+        command = parser.parse(raw_input)
+        controller.input(command) if command
+      end
+    end
+
+    private
+
+    attr_reader :input, :parser, :controller
+
+    def debug(raw_input)
+      case raw_input
+      when /\AR(EPORT_DEBUG)*\z/
+        puts controller.instance_variable_get(:@robot).inspect
+      when /\AE(XIT)*\z/
+        puts 'Have a nice day, bye :)'
+        puts '...'
+        exit(false)
+      end
+    end
+  end
+end

data/lib/toy_robot/board.rb

@@ -0,0 +1,16 @@
+module ToyRobot
+  class Board
+    def initialize(x_size, y_size)
+      @x_size = x_size
+      @y_size = y_size
+    end
+
+    def valid_pose?(pose)
+      pose && (0..x_size).include?(pose.x) && (0..y_size).include?(pose.y)
+    end
+
+    private
+
+    attr_reader :x_size, :y_size
+  end
+end

data/lib/toy_robot/command/base.rb

@@ -0,0 +1,5 @@
+module ToyRobot
+  module Command
+    Base = Struct.new(:token, :args)
+  end
+end

data/lib/toy_robot/command/parser/base.rb

@@ -0,0 +1,58 @@
+require_relative '../token'
+require_relative '../base'
+
+module ToyRobot
+  module Command
+    module Parser
+      class Base
+        def initialize(args)
+          @regex = args[:regex]
+          @token = args[:token]
+          @args_extractor = args[:args_extractor]
+        end
+
+        def build_with_match(string)
+          build_command(string) if match?(string)
+        end
+
+        private
+
+        attr_reader :regex, :token, :args_extractor
+
+        def match?(string)
+          string =~ regex
+        end
+
+        def extract_args(string)
+          if args_extractor
+            args_extractor.call(string)
+          end
+        end
+
+        def build_command(string)
+          Command::Base.new(token, extract_args(string)) if match?(string)
+        end
+      end
+
+      Move = Base.new(
+        token: Command::Token::MOVE,
+        regex: /\AMOVE\z/
+      )
+
+      Right = Base.new(
+        token: Command::Token::RIGHT,
+        regex: /\ARIGHT\z/
+      )
+
+      Left = Base.new(
+        token: Command::Token::LEFT,
+        regex: /\ALEFT\z/
+      )
+
+      Report = Base.new(
+        token: Command::Token::REPORT,
+        regex: /\AREPORT\z/
+      )
+    end
+  end
+end

data/lib/toy_robot/command/parser/place.rb

@@ -0,0 +1,37 @@
+require_relative 'base'
+require_relative '../../pose'
+
+module ToyRobot
+  module Command
+    module Parser
+      constantize_orientation = lambda do |string|
+        case string
+        when 'EAST'
+          Pose::Orientation::EAST
+        when 'NORTH'
+          Pose::Orientation::NORTH
+        when 'WEST'
+          Pose::Orientation::WEST
+        when 'SOUTH'
+          Pose::Orientation::SOUTH
+        end
+      end
+
+      place_args_extractor = lambda do |raw_command|
+        x, y, f = raw_command.split.pop.split(',')
+
+        Pose.new(
+          x: x.to_i,
+          y: y.to_i,
+          orientation: constantize_orientation.call(f)
+        )
+      end
+
+      Place = Base.new(
+        token: Command::Token::PLACE,
+        regex: /\APLACE \d+,\d+,(NORTH|SOUTH|EAST|WEST)\z/,
+        args_extractor: place_args_extractor
+      )
+    end
+  end
+end

data/lib/toy_robot/command/parser.rb

@@ -0,0 +1,20 @@
+require_relative 'parser/base'
+require_relative 'parser/place'
+
+module ToyRobot
+  module Command
+    module Parser
+      def self.parse(string)
+        all.each do |matcher|
+          command = matcher.build_with_match(string)
+          return command if command
+        end
+        nil
+      end
+
+      def self.all
+        constants(false).reject! { |const| const == :Base }.map { |const| const_get(const) }
+      end
+    end
+  end
+end

data/lib/toy_robot/command/token.rb

@@ -0,0 +1,11 @@
+module ToyRobot
+  module Command
+    module Token
+      PLACE = :PLACE
+      MOVE = :MOVE
+      RIGHT = :RIGHT
+      LEFT = :LEFT
+      REPORT = :REPORT
+    end
+  end
+end

data/lib/toy_robot/factory.rb

@@ -0,0 +1,83 @@
+require_relative 'robot_controller'
+require_relative 'robot'
+require_relative 'placement'
+require_relative 'board'
+require_relative 'pose'
+require_relative 'view'
+
+module ToyRobot
+  module Factory
+    module_function
+
+    def create(identifier, opts = {})
+      case identifier
+      when :controller
+        RobotControllerFactory.create(opts)
+      end
+    end
+
+    module RobotControllerFactory
+      module_function
+
+      def create(opts = {})
+        robot = opts[:robot] || RobotFactory.create
+        view = opts[:view] || ViewFactory.create(robot: robot)
+
+        ToyRobot::RobotController.new(
+          robot: robot,
+          view: view
+        )
+      end
+    end
+
+    module ViewFactory
+      module_function
+
+      def create(opts = {})
+        robot = opts[:robot] || RobotFactory.create
+        output = opts[:output] || $stdout
+
+        ToyRobot::View.new(
+          robot: robot,
+          output: output
+        )
+      end
+    end
+
+    module RobotFactory
+      module_function
+
+      def create(opts = {})
+        placement = opts[:placement] || PlacementFactory.create
+
+        ToyRobot::Robot.new(
+          placement: placement
+        )
+      end
+    end
+
+    module PlacementFactory
+      module_function
+
+      def create(opts = {})
+        board = opts[:board] || BoardFactory.create
+        pose = opts[:pose] || ToyRobot::Pose.new
+        ToyRobot::Placement.new(
+          board: board,
+          pose: pose
+        )
+      end
+    end
+
+    module BoardFactory
+      module_function
+
+      def create(opts = {})
+        x = opts[:x] || 5
+        y = opts[:y] || 5
+
+        ToyRobot::Board.new(x, y)
+      end
+    end
+  end
+end

data/lib/toy_robot/placement.rb

@@ -0,0 +1,34 @@
+require 'forwardable'
+
+module ToyRobot
+  class Placement
+    extend Forwardable
+
+    def_delegator :pose, :report
+    def_delegator :pose, :rotate!, :rotate
+
+    def initialize(args)
+      @board = args[:board]
+      @pose = args[:pose]
+    end
+
+    def on_board?
+      board && board.valid_pose?(pose)
+    end
+
+    def update(a_new_pose)
+      if board.valid_pose?(a_new_pose)
+        self.pose = a_new_pose
+      end
+    end
+
+    def advance
+      update(pose.adjacent)
+    end
+
+    private
+
+    attr_reader :board
+    attr_accessor :pose
+  end
+end

data/lib/toy_robot/pose.rb

@@ -0,0 +1,79 @@
+module ToyRobot
+  class Pose
+    module Orientation
+      EAST = :east
+      NORTH = :north
+      WEST = :west
+      SOUTH = :south
+    end
+
+    attr_accessor :x, :y, :orientation
+
+    def initialize(args = {})
+      @x = args[:x]
+      @y = args[:y]
+      @orientation = args[:orientation]
+    end
+
+    def adjacent
+      dup.send(:adjacent!)
+    end
+
+    def rotate!(degrees)
+      step = (degrees % 90) + (degrees/degrees.abs)
+      self.orientation = step_orientation(step)
+    end
+
+    def report
+      {
+        x: x,
+        y: y,
+        orientation: orientation
+      }
+    end
+
+    private
+
+    def step_orientation(by = 1)
+      orientations = [
+        Pose::Orientation::NORTH,
+        Pose::Orientation::EAST,
+        Pose::Orientation::SOUTH,
+        Pose::Orientation::WEST
+      ]
+
+      orientations[(orientations.index(orientation) + by) % 4]
+    end
+
+    def adjacent!
+      case orientation
+      when Pose::Orientation::EAST
+        increment!(:x)
+      when Pose::Orientation::NORTH
+        increment!(:y)
+      when Pose::Orientation::WEST
+        decrement!(:x)
+      when Pose::Orientation::SOUTH
+        decrement!(:y)
+      end
+      self
+    end
+
+    def increment!(coordinate, by = 1)
+      update!(coordinate, by)
+    end
+
+    def decrement!(coordinate, by = -1)
+      update!(coordinate, by)
+    end
+
+    def update!(coordinate, by)
+      case coordinate
+      when :x
+        self.x = x + by
+      when :y
+        self.y = y + by
+      end
+    end
+  end
+end