toy_robo_simulator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d36581000b8d9c29ed537e9dd0f387fb9916e76
+  data.tar.gz: dd370f74e8875bdd316da77319ca0272a3f1b2d9
+SHA512:
+  metadata.gz: e9220146ac4c361c80413c1eecf03dbafb5b52f39101491fd2b4c660fb5957a6141d8ac77ad2dd0482bb9995219cfd5021f4f81b23ebb91bb0c9c461b836ec98
+  data.tar.gz: b5fce97d98b20109882deb14a82ea1f2d397c7e100422c038f475f669195c669b2a4a5dfff2cdad30160135b3b0fec7fbe537b5eecce3da628080dd0e4e3eb7f

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - '*.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

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 toy_robo_simulator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adler
+
+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,34 @@
+# Toy Robot Simulator
+
+## Installation
+
+Run:
+
+```
+gem install toy_robo_simulator
+```
+
+## Usage
+
+## Development Specs
+
+- [ ] Create a 5x5 tabletop when initated
+- [ ] The (0,0) is the south west corner
+- [ ] The robot cannot move out of range
+- [ ] Available Commands
+  - [ ] PLACE X, Y, F: Place the robot on a specific position with direction
+  - [ ] MOVE: move forward one space
+  - [ ] LEFT: turn left
+  - [ ] RIGHT: turn right
+  - [ ] REPORT: report current position and direction
+- [ ] PLACE should be the first command, otherwise ignored
+- [ ] Allow both CLI input and file input
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/toy_robo_simulator. 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,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_robo_simulator"
+
+# 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/robo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'toy_robo_simulator'
+
+ToyRoboSimulator::Console.new.watch

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/lib/toy_robo_simulator/console.rb

@@ -0,0 +1,59 @@
+module ToyRoboSimulator
+  # The console is responsible for initaing a command line interface for 
+  # users to access the program.
+  class Console
+    def initialize
+      puts ::MESSAGE
+      @n = 0
+      @robo = Robo.new
+      print "#{format('%02d', @n)} > "
+    end
+
+    def watch
+      command = STDIN.gets
+      while command
+        run(command)
+        print "#{format('%02d', @n += 1)} > "
+        command = STDIN.gets
+      end
+    end
+
+    def run(command)
+      args   = command.split(' ')
+      action = args[0].gsub("\n", '').downcase
+      case
+      when ::AVAILABLE_COMMANDS.include?(action)
+        process(action, args)
+      when action == 'exit'
+        exit_program
+      when action == 'help'
+        help
+      else
+        puts ::WARNING
+      end
+    end
+
+    private
+
+    def process(action, args)
+      begin
+        @robo.send(action.to_sym, *args[1..-1])
+      rescue ArgumentError => e
+        tip if e.message.include? 'wrong number of arguments'
+      end
+    end
+
+    def tip
+      puts TIP
+    end
+
+    def exit_program
+      puts "\nThank You!\n\n"
+      exit
+    end
+
+    def help
+      puts HELP
+    end
+  end
+end

data/lib/toy_robo_simulator/env.rb

@@ -0,0 +1,23 @@
+require 'colorize'
+
+AVAILABLE_COMMANDS = %w(place move left right report)
+
+HELP = "Available Commands:
+- PLACE:  Place a robo. Requires x, y, and orientation arguments.
+          e.g. PLACE 2 5 NORTH
+- MOVE:   Move forward
+- LEFT:   Turn left
+- RIGHT:  Turn right
+- REPORT: Report current position and orientation
+- HELP:   Display all available commands"
+
+MESSAGE = "\n#{'Welcome to Toy Robo Simulator!'.colorize(:green)}
+\n#{HELP}\nUse PLACE first to start the simulation :)\n\n"
+
+WARNING = "Command Not Found. See 'HELP'."
+
+TIP = "#{'WARNING'.colorize(:red)}
+- PLACE should take 3 arguments: x, y, and orientation. e.g. PLACE 1 2 NORTH
+- Other commands take no argument."
+
+ORIENTATIONS = %i(north west south east)

data/lib/toy_robo_simulator/robo.rb

@@ -0,0 +1,62 @@
+module ToyRoboSimulator
+  class Robo
+    include Validator
+    attr_accessor :x, :y, :orientation
+
+    def initialize
+      @table  = Table.new(5, 5)
+      @errors = []
+    end
+
+    def place(x, y, orientation)
+      validate_placement(x, y, orientation)
+      warning && return if @errors.any?
+      @x, @y = x.to_i, y.to_i
+      @orientation = orientation.downcase.to_sym
+      puts 'It is placed.'
+    end
+
+    def move
+      validate_if_placed
+      validate_movement
+      warning && return if @errors.any?
+      case orientation
+      when :north then @y += 1
+      when :east  then @x += 1
+      when :south then @y -= 1
+      when :west  then @x -= 1
+      end
+      puts 'It moves forward.'
+    end
+
+    def left
+      validate_if_placed
+      warning && return if @errors.any?
+      index = ::ORIENTATIONS.index(@orientation) + 1
+      @orientation = ::ORIENTATIONS[index] || :north
+      puts 'It turns left.'
+    end
+
+    def right
+      validate_if_placed
+      warning && return if @errors.any?
+      index = ::ORIENTATIONS.index(@orientation) - 1
+      @orientation = ::ORIENTATIONS[index]
+      puts 'It turns right'
+    end
+
+    def report
+      validate_if_placed
+      warning && return if @errors.any?
+      puts "Robo is now at (#{@x},#{@y}) facing #{@orientation.to_s.upcase}"
+    end
+
+    private
+
+    def warning
+      @errors.each { |message| puts message }
+      @errors = []
+    end
+
+  end
+end

data/lib/toy_robo_simulator/table.rb

@@ -0,0 +1,9 @@
+module ToyRoboSimulator
+  class Table
+    attr_accessor :x, :y
+    def initialize(x, y)
+      @x = x
+      @y = y
+    end
+  end
+end

data/lib/toy_robo_simulator/validator.rb

@@ -0,0 +1,40 @@
+module ToyRoboSimulator
+  module Validator
+    def validate_placement(x, y, orientation)
+      @errors << 'X must be a number' unless int?(x)
+      @errors << 'Y must be a number' unless int?(y)
+      @errors << "X must be between 0 and #{@table.x}" unless in_range?(x, @table.x)
+      @errors << "Y must be between 0 and #{@table.y}" unless in_range?(y, @table.y)
+      @errors << 'Orientation should be either NORTH, SOUTH, EAST, or WEST' unless orientation_valid?(orientation)
+    end
+
+    def validate_movement
+      @errors << 'The Robo is at edge. No further move is allowed.' if at_table_edge?
+    end
+
+    def validate_if_placed
+      @errors << 'The Robo is not placed yet. Use PLACE command first.' unless @x && @y && @orientation
+    end
+
+    def at_table_edge?
+      (@orientation == :north && @y == @table.y) ||
+      (@orientation == :east  && @x == @table.x) ||
+      (@orientation == :south && @y == 0)        ||
+      (@orientation == :west  && @x == 0)
+    end
+
+    private
+
+    def int?(value)
+      value.to_s == value.to_i.to_s
+    end
+
+    def in_range?(value, max)
+      value.to_i >= 0 && value.to_i <= max
+    end
+
+    def orientation_valid?(orientation)
+      ::ORIENTATIONS.include? orientation.downcase.to_sym
+    end
+  end
+end

data/lib/toy_robo_simulator/version.rb

@@ -0,0 +1,3 @@
+module ToyRoboSimulator
+  VERSION = '0.1.0'
+end

data/lib/toy_robo_simulator.rb

@@ -0,0 +1,17 @@
+require_relative 'toy_robo_simulator/version'
+require_relative 'toy_robo_simulator/env'
+require_relative 'toy_robo_simulator/table'
+require_relative 'toy_robo_simulator/validator'
+require_relative 'toy_robo_simulator/robo'
+require_relative 'toy_robo_simulator/console'
+
+# This module includes all other modules and classes in this program.
+# Basically it can be divided into:
+# 
+# - Console: Offering a command line interface for input & output.
+# - Robo: A robot simulating the movement on a table.
+# - Validator: Validating the robo's actions and their prerequisities.
+# - Others
+#
+module ToyRoboSimulator
+end

data/toy_robo_simulator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'toy_robo_simulator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "toy_robo_simulator"
+  spec.version       = ToyRoboSimulator::VERSION
+  spec.authors       = ["Adler"]
+  spec.email         = ["nkj20932@hotmail.com"]
+
+  spec.summary       = %q{A toy robot simulator}
+  spec.description   = %q{A CLI that simulates the movement of a robot on a 5x5 table}
+  spec.homepage      = "http://github.com/adlerhsieh/toy_rubo_simulator"
+  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 "rspec"
+  spec.add_development_dependency "colorize"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: toy_robo_simulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-10 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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: A CLI that simulates the movement of a robot on a 5x5 table
+email:
+- nkj20932@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/robo
+- bin/setup
+- lib/toy_robo_simulator.rb
+- lib/toy_robo_simulator/console.rb
+- lib/toy_robo_simulator/env.rb
+- lib/toy_robo_simulator/robo.rb
+- lib/toy_robo_simulator/table.rb
+- lib/toy_robo_simulator/validator.rb
+- lib/toy_robo_simulator/version.rb
+- toy_robo_simulator.gemspec
+homepage: http://github.com/adlerhsieh/toy_rubo_simulator
+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: A toy robot simulator
+test_files: []