toy_robot 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 470b7ee06374f2b4e17346a8a842fb990766dd19
+  data.tar.gz: 5e6c4ba76194f3c01f500c54738518818b2317fb
+SHA512:
+  metadata.gz: c23a350702a5d232edfc69c501c5c7bcc3f5e12fa61b7f570089886761d1e5df1983b0b2e78321056f17ff0f88e7825bab67239a36c8a6f932e9a31cd81d1f98
+  data.tar.gz: 0ee1187e09d65ae884102910bafa0d73bdb9bc68778f509ced990b03454a19b6ead3433dcca85a941ee0e96d4fa908fde82449dd12767984f26638ed82a91cd7

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/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 louman
+
+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,18 @@
+# Toy_Robot
+
+Welcome to the toy robot simulator.
+
+## Usage
+
+```ruby
+gem install toy_robot
+
+toy_robot
+```
+and follow instructions :)
+
+## Specs
+
+```ruby
+rspec
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/toy_robot

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/toy_robot'
+
+ToyRobot::Bin::Runner.new.start

data/lib/toy_robot.rb

@@ -0,0 +1,19 @@
+require 'asciiart'
+require 'forwardable'
+require 'rainbow'
+require 'terminal-table'
+
+require 'toy_robot/roboto'
+require 'toy_robot/roboto/brain'
+require 'toy_robot/roboto/motor_cortex'
+require 'toy_robot/roboto/speech'
+require 'toy_robot/table'
+require 'toy_robot/manifest_reader'
+require 'toy_robot/simulator'
+
+require 'toy_robot/bin/io_utils'
+require 'toy_robot/bin/runner'
+
+module ToyRobot
+
+end

data/lib/toy_robot/bin/io_utils.rb

@@ -0,0 +1,38 @@
+module ToyRobot
+  module Bin
+    module IOUtils
+
+      # puts a message and sleep
+      def print_with_delay(msg, delay_time=2)
+        _print msg
+        delay delay_time
+      end
+
+      # just a wrapper for puts
+      def _print(msg)
+        puts msg
+      end
+
+      # just a wrapper for sleep
+      def delay(delay_time)
+        sleep delay_time
+      end
+
+      # returns a yellowish string
+      def yellow(text)
+        Rainbow(text).yellow
+      end
+
+      # returns a greenish string
+      def green(text)
+        Rainbow(text).green
+      end
+
+      # returns a reddish string
+      def red(text)
+        Rainbow(text).red
+      end
+
+    end
+  end
+end

data/lib/toy_robot/bin/runner.rb

@@ -0,0 +1,108 @@
+module ToyRobot
+  module Bin
+    class Runner
+
+      include IOUtils
+
+      attr_reader :simulator, :roboto, :selected_option
+
+      def initialize
+        @simulator   = ToyRobot::Simulator.new
+        @roboto      = @simulator.roboto
+        @roboto.name = robots.sample
+      end
+
+      def start
+        show_art
+        show_help
+        show_options
+        @selected_option = capture_input
+        handle_selected_option
+      end
+
+      private
+
+      def capture_input
+        gets.chomp.strip
+      end
+
+      def handle_selected_option
+        case selected_option
+        when '1'
+          input_by_hand
+        when '2'
+          input_from_file
+        else
+          _print 'Invalid option, terminating simulator.'
+        end
+      end
+
+      def input_by_hand
+        boot_roboto('Ok, preparing roboto for manual orders')
+        _print green("-- #{@roboto.name} reporting for duty. What is you first order sir?")
+        command = capture_input
+        while command
+          begin
+            @simulator.run([command])
+          rescue StandardError
+            _print red('Order not recognized, sir!')
+          end  
+          _print green("#{@roboto.name} waiting for new orders, sir!")
+          command = capture_input
+        end
+      end
+
+      def input_from_file
+        boot_roboto('Ok, preparing roboto for orders manifest')
+        @simulator.run(read_manifest)
+      end
+
+      def read_manifest
+        ToyRobot::ManifestReader.new.read
+      end
+
+      def show_art
+        _print art
+      end
+
+      def show_help
+        _print help
+      end
+
+      def show_options
+        _print '1) Input orders by hand'
+        _print '2) Input orders from file'
+      end
+
+      def boot_roboto(acknowledge_message)
+        print_with_delay yellow(acknowledge_message)
+        print_with_delay yellow("Booting #{@roboto.name}")
+        print_with_delay yellow('Calibrating controls')
+        print_with_delay yellow('Activating AI')
+        print_with_delay yellow('1, 2, 3 testing')
+      end
+
+      def help
+        rows = []
+        rows << ['Type "exit" anytime to exit simulator']
+        rows << ['Valid commands are: PLACE, MOVE, LEFT, RIGHT, REPORT']
+        rows << ['PLACE: puts the toy robot on the table in position X,Y and facing NORTH, SOUTH, EAST or WEST.']
+        rows << ['MOVE: moves the toy robot one unit forward in the direction it is currently facing.']
+        rows << ['LEFT: rotates the robot 90 degrees counter-clockwise without changing the position of the robot.']
+        rows << ['RIGHT: rotates the robot 90 degrees clockwise without changing the position of the robot.']
+        rows << ['REPORT: announces the X,Y and F of the robot.']
+        table = Terminal::Table.new :rows => rows, title: 'Welcome to the Toy Robot Simulator!'
+      end
+
+      def robots
+        ['T-800', 'Optimus Prime', 'R2-D2', 'C-3PO', 'Data', 'Sonny', 'Wall-E', 'Rosey', 'Robocop', 'T-1000']
+      end
+
+      def art
+        art = AsciiArt.new(File.join(File.dirname(__FILE__), '..', 'files', 'roboto.jpg'))
+        art.to_ascii_art(width: 70)
+      end
+
+    end
+  end
+end

data/lib/toy_robot/files/manifest.txt

@@ -0,0 +1,9 @@
+MOVE
+PLACE 1,2,NORTH
+LEFT
+REPORT
+LEFT
+LEFT
+REPORT
+MOVE
+REPORT

data/lib/toy_robot/manifest_reader.rb

@@ -0,0 +1,16 @@
+module ToyRobot
+  class ManifestReader
+
+    attr_reader :file
+
+    def initialize(file_path:nil)
+      @file_path = file_path || File.join(File.dirname(__FILE__), 'files', 'manifest.txt')
+      @file = File.open(@file_path)
+    end
+
+    def read
+      @file.each_line.map(&:strip)
+    end
+
+  end
+end

data/lib/toy_robot/roboto.rb

@@ -0,0 +1,90 @@
+module ToyRobot
+  class Roboto
+
+    extend Forwardable
+
+    def_delegator :@brain, :speak
+    def_delegator :@brain, :motor_cortex, :location
+    def_delegator :@brain, :understand_order
+
+    attr_accessor :table_edges, :brain, :name
+
+    def initialize
+      @brain = Brain.new
+      @name  = 'Roboto'
+    end
+
+    # Sends order's method
+    def execute_order(order)
+      if order[:args].nil?
+        send(order[:command])
+      else
+        send(order[:command], order[:args])
+      end
+    end
+
+    # Changes roboto location if is safe
+    # otherwise says advise message
+    def place(x:, y:, f:)
+      safe(x, y) do
+        location.reset(x: x.to_i, y: y.to_i, f: f.downcase.to_sym)
+      end
+    end
+
+    # Moves roboto one unit forward to facing direction if roboto is placed
+    # and it's safe
+    # otherwise says advise message
+    def move
+      if_placed do
+        x, y = location.forward_prediction
+        safe(x, y) do
+          location.forward
+        end
+      end
+    end
+
+    # Says current location if roboto is placed
+    # otherwise says advise message
+    def report
+      if_placed do
+        puts speak(location.to_s)
+      end
+    end
+
+    # Rotates roboto 90 degrees to the left if roboto is placed
+    # otherwise says advise message
+    def left
+      if_placed do
+        location.rotate_ccw
+      end
+    end
+
+    # Rotates roboto 90 degrees to the right if roboto is placed
+    # otherwise says advise message
+    def right
+      if_placed do
+        location.rotate_cw
+      end
+    end
+
+    # Returns true if location is nil
+    def placed?
+      !location.nil?
+    end
+
+    private
+
+    def safe(x, y)
+      to_safe_location?(x, y) ? yield : speak("No can do, sir! If #{name} move #{name} fall.")
+    end
+
+    def to_safe_location?(new_x, new_y)
+      new_x.between?(table_edges[:x][:min], table_edges[:x][:max]) && new_y.between?(table_edges[:y][:min], table_edges[:y][:max])
+    end
+
+    def if_placed
+      placed? ? yield : speak("#{name} not placed yet, sir!")
+    end
+
+  end
+end

data/lib/toy_robot/roboto/brain.rb

@@ -0,0 +1,38 @@
+module ToyRobot
+  class Roboto
+    class Brain
+
+      extend Forwardable
+
+      def_delegator :@speech, :speak
+
+      attr_accessor :motor_cortex, :speech
+
+      def initialize
+        @motor_cortex = MotorCortex.new
+        @speech       = Speech.new
+      end
+
+      def understand_order(order)
+        order  = sanitized_order(order).split(' ')
+        method = order.shift.downcase.to_sym
+        if order.any?
+          arguments = sanitized_args(order.shift)
+        end
+        { command: method, args: arguments }
+      end
+
+      private
+
+      def sanitized_order(order)
+        order.strip.squeeze(' ')
+      end
+
+      def sanitized_args(args)
+        args = args.gsub(/ /, '').split(',')
+        { x: args[0].to_i, y: args[1].to_i, f: args[2].downcase.to_sym }
+      end
+
+    end
+  end
+end

data/lib/toy_robot/roboto/motor_cortex.rb

@@ -0,0 +1,67 @@
+module ToyRobot
+  class Roboto
+    class MotorCortex
+
+      attr_accessor :x, :y, :f
+
+      CARDINAL_DIRECTIONS = [:north, :east, :south, :west]
+      MOVE = { north: { x: 0,  y: 1  },
+               east:  { x: 1,  y: 0  },
+               south: { x: 0,  y: -1 },
+               west:  { x: -1, y: 0  } }
+
+      def initialize(x: nil, y: nil, f: nil)
+        reset(x: x, y: y, f: f)
+      end
+
+      # Sets X, Y and forwarding direction
+      def reset(x:, y:, f:)
+        raise "#{f} is not a recognized direction" unless f.nil? || CARDINAL_DIRECTIONS.include?(f)
+        @x = x
+        @y = y
+        @f = f
+      end
+
+      # Rotates -90 degrees
+      def rotate_ccw
+        @f = rotation(-1)
+      end
+
+      # Rotates 90 degrees
+      def rotate_cw
+        @f = rotation(1) || CARDINAL_DIRECTIONS[0]
+      end
+
+      # Increaseas one unit to forwarding direction
+      def forward
+        new_x, new_y = forward_prediction
+        reset(x: new_x, y: new_y, f: @f)
+      end
+
+      # Calculates new position to move forward
+      def forward_prediction
+        return @x + MOVE[@f][:x], @y + MOVE[@f][:y]
+      end
+
+      # Returns a formated string with axis and forwarding direction
+      def to_s
+        "X: #{value_or_not_available(@x)}, Y: #{value_or_not_available(@y)}, F: #{value_or_not_available(@f)}"
+      end
+
+      # Returns true X or Y or F is nil
+      def nil?
+        @x.nil? || @y.nil? || @f.nil?
+      end
+
+      private
+
+      def value_or_not_available(value)
+        value.nil? ? 'N/A' : value
+      end
+
+      def rotation(step)
+        CARDINAL_DIRECTIONS[CARDINAL_DIRECTIONS.index(@f) + step]
+      end
+    end
+  end
+end