robulator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5782980ac4a94cae445c3205039b189ca5237c2f
+  data.tar.gz: 6981570a6608d4d8b3c86baf198eacea74f68705
+SHA512:
+  metadata.gz: 7f6382c4d8836bcd63040bfd1617f6fcd75a7fec992c7e0564ab95f8f96a49615fdbc7de19e546db55d494105cdd66ddba13c165c596a54c1b94c1c9d9805abd
+  data.tar.gz: 4301a37010aab6aeca7847ed7022e29f4d5687aae62e8fc29dbeb308f606f6ea5220e86fce48dd4b408ede2463f3035da3a1e3a543d85d87478b70a0f0ac4c7d

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ikhsan Maulana
+
+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,112 @@
+# Robulator
+Robulator is a simulation of a toy robot moving on a square tabletop,
+of dimensions 5 units x 5 units.
+
+             y
+             ^
+             |     NORTH
+             |
+           4 |---+---+---+---+
+             |   |   |   |   |
+           3 |---+---+---+---+
+             |   |   |   |   |
+    WEST   2 |---+---+---+---+   EAST
+             |   |   |   |   |
+           1 |---+---+---+---+
+             |   |   |   |   |
+             |---|---|---|---|----> x
+           0     1   2   3   4
+
+                   SOUTH
+
+
+## Installation
+Install it with:
+
+    $ gem install robulator
+
+
+## Usage
+Start the toy robot simulator with:
+
+    $ robulator
+
+Robulator accept commands in the following form:
+
+    PLACE X,Y,F
+    MOVE
+    LEFT
+    RIGHT
+    REPORT
+
+### PLACE
+Put the toy robot on the table in position `X`,`Y` and facing `NORTH`, `SOUTH`,
+`EAST` or `WEST`.
+
+  * The origin (0,0) is 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. Robulator discard all commands in the sequence until a
+    valid `PLACE` command has been executed.
+
+### MOVE
+Move the toy robot one unit forward in the direction it is currently facing.
+
+### LEFT and RIGHT
+Rotate the robot 90 degrees in the specified direction without changing the
+position of the robot.
+
+### REPORT
+Announce the `X`,`Y` and the direction of the robot to standard output (e.g.
+`2,4,SOUTH`).
+
+
+## Example Input and Output
+
+    >> PLACE 0,0,NORTH
+    >> MOVE
+    >> REPORT
+    0,1,NORTH
+
+    >> PLACE 0,0,NORTH
+    >> LEFT
+    >> REPORT
+    0,0,WEST
+
+    >> PLACE 1,2,EAST
+    >> MOVE
+    >> MOVE
+    >> LEFT
+    >> MOVE
+    >> REPORT
+    3,3,NORTH
+
+
+## Conditions and Characteristics
+
+  * There are no other obstructions on the table surface.
+
+  * The robot is free to roam around the surface of the table but it ignore
+    commands that would cause the robot to fall, this also includes the initial
+    placement of the toy robot, however further valid commands will be accepted.
+
+  * A robot that is not on the table will ignore the `MOVE`, `LEFT`, `RIGHT` and
+    `REPORT` commands.
+
+  * Robulator does not provide any graphical output showing the movement of the
+    toy robot.
+
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec robulator` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/ixandidu/robulator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "robulator"
+
+# 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/exe/robulator

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "robulator"
+require 'readline'
+
+Readline.completion_append_character = ' '
+Readline.completion_proc             = proc do |s|
+  Robulator::Simulator::PERFORMABLE_COMMANDS.grep(/\A#{Regexp.escape(s)}/)
+end
+
+stty_save = `stty -g`.chomp
+trap('INT') do
+  system('stty', stty_save)
+  exit
+end
+
+puts  '-- Welcome to Robulator, a Toy Robot Simulator.'
+print '-- Available commands are: '
+print Robulator::Simulator::PERFORMABLE_COMMANDS[0..-2].join(', ')
+print ' and '
+print Robulator::Simulator::PERFORMABLE_COMMANDS[-1]
+puts  '.'
+
+simulator = Robulator::Simulator.new
+while line = Readline.readline('>> ', true)
+   simulator.perform line.chomp
+end

data/lib/robulator.rb

@@ -0,0 +1,8 @@
+require "robulator/version"
+require "robulator/robot"
+require "robulator/simulator"
+require "robulator/tabletop"
+
+module Robulator
+  # Your code goes here...
+end

data/lib/robulator/robot.rb

@@ -0,0 +1,41 @@
+module Robulator
+  class Robot
+    ORIENTATIONS = {
+      north: {move: [:y, 1],  turns: {right: :east,  left: :west}},
+      south: {move: [:y, -1], turns: {right: :west,  left: :east}},
+      east:  {move: [:x, 1],  turns: {right: :south, left: :north}},
+      west:  {move: [:x, -1], turns: {right: :north, left: :south}}
+    }.freeze
+    VALID_TURN = %i[right left].freeze
+
+    attr_reader :position, :direction
+
+    def place(x, y, direction)
+      direction = direction.to_sym.downcase unless direction.is_a?(Symbol)
+      return unless ORIENTATIONS.keys.include?(direction)
+
+      @position  = {x: Integer(x), y: Integer(y)}
+      @direction = direction
+    rescue ArgumentError
+    end
+
+    def placed?
+      !!(direction && position)
+    end
+
+    def next_position
+      return unless placed?
+      axis, value = *ORIENTATIONS[direction][:move]
+      position.merge({axis => position[axis] + value})
+    end
+
+    def move
+      @position = next_position if next_position
+    end
+
+    def turn(relative_direction)
+      return if !placed? || !VALID_TURN.include?(relative_direction)
+      @direction = ORIENTATIONS[direction][:turns][relative_direction]
+    end
+  end
+end

data/lib/robulator/simulator.rb

@@ -0,0 +1,51 @@
+require 'forwardable'
+
+module Robulator
+  class Simulator
+    extend ::Forwardable
+
+    def_delegators :@robot,
+                   :place,
+                   :placed?,
+                   :move,
+                   :turn,
+                   :position,
+                   :direction,
+                   :next_position
+
+    def_delegators :@tabletop,
+                   :placeable_spot?
+
+    PERFORMABLE_COMMANDS = %w[PLACE MOVE RIGHT LEFT REPORT]
+
+    def initialize(robot=Robot.new, tabletop=Tabletop.new(5))
+      @robot    = robot
+      @tabletop = tabletop
+    end
+
+    def perform(command)
+      command, *args = command.split(/\s|,/).reject(&:empty?)
+
+      case command
+      when 'PLACE';         place(*args) if args.size == 3 && safe_place?(*args)
+      when 'MOVE';          move         if safe_to_move?
+      when 'RIGHT', 'LEFT'; turn(command.downcase.to_sym)
+      when 'REPORT';        send(command.downcase)
+      end
+    end
+
+    private
+      def report
+        return unless placed?
+        puts "#{position.values.join(',')},#{direction.upcase}"
+      end
+
+      def safe_place?(x, y, _direction)
+        placeable_spot?(x, y)
+      end
+
+      def safe_to_move?
+        placeable_spot?(next_position[:x], next_position[:y])
+      end
+  end
+end

data/lib/robulator/tabletop.rb

@@ -0,0 +1,15 @@
+module Robulator
+  class Tabletop
+    def initialize(size)
+      size             = Integer(size)
+      @placeable_spots = {x: 0...size, y: 0...size}
+    end
+
+    def placeable_spot?(x, y)
+      @placeable_spots[:x].include?(Integer(x)) &&
+      @placeable_spots[:y].include?(Integer(y))
+    rescue ArgumentError
+      false
+    end
+  end
+end

data/lib/robulator/version.rb

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

data/robulator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robulator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "robulator"
+  spec.version       = Robulator::VERSION
+  spec.authors       = ["Ikhsan Maulana"]
+  spec.email         = ["ixandidu@gmail.com"]
+
+  spec.summary       = %q{Toy Robot Simulation.}
+  spec.description   = %q{Robulator is a simulation of a toy robot moving on a square tabletop.}
+  spec.homepage      = "https://bitbucket.org/ixandidu/robulator"
+  spec.license       = "MIT"
+
+  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", "~> 5.8"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: robulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ikhsan Maulana
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-01 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: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: Robulator is a simulation of a toy robot moving on a square tabletop.
+email:
+- ixandidu@gmail.com
+executables:
+- robulator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/robulator
+- lib/robulator.rb
+- lib/robulator/robot.rb
+- lib/robulator/simulator.rb
+- lib/robulator/tabletop.rb
+- lib/robulator/version.rb
+- robulator.gemspec
+homepage: https://bitbucket.org/ixandidu/robulator
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Toy Robot Simulation.
+test_files: []