toy_robo_simulator 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9697c5a9c1cd08ba5afadb9b1079a0f2f59f292
-  data.tar.gz: f9645af6fd80dce7a433784a4779c08ee72c014b
+  metadata.gz: 36a233f2485ba520549d1f92e495ec5ca18ef050
+  data.tar.gz: 8742f7dad1462f904c0d423b477609152fdce748
 SHA512:
-  metadata.gz: 460f8d9a3e697694c47589e52755480b1996ee64fc240a8d593f88de99499c84a055c0fe45e8ed9212af9576911013c33a7417cdc9ed3d3a347c7d44faaf87da
-  data.tar.gz: c7d44efdea2331bfba1189a0e01272a4bf36a44eec99083183c73ae324ff4a3204978e74f0df86897e4950ade59f1ba9a55faf6183c321a8abc2e13c083d8704
+  metadata.gz: edc2a79ad6e63d0cd297c47fdd6da200f644a9e1ce6d027addea658669069af9720c14b8c6e84dfa4ef93888a40b6e320a5cf61fa8602660e21bb2a83a3ec5e9
+  data.tar.gz: 40ddf777aab1f1cb04b08ba474c8b54f8658200ece6d2d0cbe5c9588b17257261695672d01a01d8b66b734eb844e918de2f724e450b185d23a9817007a9f850f

data/.rubocop.yml

@@ -2,3 +2,13 @@ AllCops:
   Exclude:
     - 'bin/**/*'
     - '*.gemspec'
+  DisplayCopNames: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.1

data/.travis.yml

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

data/Gemfile

@@ -3,4 +3,3 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in toy_robo_simulator.gemspec
 gemspec
 gem 'codeclimate-test-reporter', group: :test, require: nil
-gem 'colorize', '0.7.7'

data/bin/robo-dev

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

data/lib/toy_robo_simulator/console.rb

@@ -1,3 +1,5 @@
+require 'readline'
+
 module ToyRoboSimulator
   # The console is responsible for initaing an interactive command line interface for
   # users to access the program.
@@ -9,18 +11,15 @@ module ToyRoboSimulator
     # Initializes a CLI that includes a Robo instance.
     def initialize
       puts MESSAGE
-      @n = 0
       @robo = Robo.new
-      print "#{format('%02d', @n)} > "
     end
 
     # Starts watching for user input.
     def watch
-      command = STDIN.gets.chomp
-      while command
-        run(command)
-        print "#{format('%02d', @n += 1)} > "
-        command = STDIN.gets.chomp
+      n = 0
+      while cmd = Readline.readline("#{format('%02d', n)}> ", true)
+        run(cmd)
+        n += 1
       end
     end
 
@@ -48,30 +47,24 @@ module ToyRoboSimulator
     # Directly sends the command with arguments to the Robo instance.
     def process(action, args)
       case action
-      when 'exit' then exit_program
-      when 'help' then help
+      when 'exit'
+        exit_program
+      when 'help'
+        puts HELP
       else
-        @robo.send(action.to_sym, *args)
+        robo.send(action.to_sym, *args)
       end
     rescue ArgumentError => e
-      tip if e.message.include? 'wrong number of arguments'
+      puts TIP if e.message.include? 'wrong number of arguments'
     end
 
     def to_args(command)
       command.split(' ').map { |n| n.split(',') }.flatten.map(&:chomp).map(&:downcase)
     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/robo.rb

@@ -1,6 +1,7 @@
 module ToyRoboSimulator
-  # Rubo is the character of this program. It serves to simulates the movement of a robot on a table.
-  # The available actions are place, move, left, right, and report. Each action is validated before execution
+  # Robo is the character of this program. It serves to simulate the movement of a robot on a table.
+  # The available actions are place, move, left, right, and report.
+  # Each action is validated before execution
   # and will respond with the result.
   class Robo
     include Validator
@@ -31,11 +32,9 @@ module ToyRoboSimulator
     # robo.y # => nil
     # ```
     def place(x, y, orientation)
-      validate_placement(x, y, orientation)
-      warning && return if @errors.any?
-      @x = x.to_i
-      @y = y.to_i
+      @x, @y = x, y
       @orientation = orientation.downcase.to_sym
+      return unless valid_placement?
       puts 'It is placed.'
     end
 
@@ -57,9 +56,7 @@ module ToyRoboSimulator
     # robo.x # => 5
     # ```
     def move
-      validate_if_placed
-      validate_movement
-      warning && return if @errors.any?
+      return unless placed? && moveable?
       move_forward(1)
       puts 'It moves forward.'
     end
@@ -77,16 +74,14 @@ module ToyRoboSimulator
     # robo.orientation # => :north
     # ```
     def left
-      validate_if_placed
-      warning && return if @errors.any?
+      return unless placed?
       turn(:left)
       puts 'It turns left.'
     end
 
     # Turns right. See `#left`.
     def right
-      validate_if_placed
-      warning && return if @errors.any?
+      return unless placed?
       turn(:right)
       puts 'It turns right'
     end
@@ -102,8 +97,7 @@ module ToyRoboSimulator
     # robo.report # => 'Robo is now at (3,3) facing EAST'
     # ```
     def report
-      validate_if_placed
-      warning && return if @errors.any?
+      return unless placed?
       puts "Robo is now at (#{@x},#{@y}) facing #{@orientation.to_s.upcase}"
     end
 
@@ -115,8 +109,8 @@ module ToyRoboSimulator
     end
 
     def turn(direction)
-      i = direction == :left ? 1 : -1
-      index = ORIENTATIONS.index(@orientation) + i
+      i            = direction == :left ? 1 : -1
+      index        = ORIENTATIONS.index(@orientation) + i
       @orientation = ORIENTATIONS[index] || :north
     end
 

data/lib/toy_robo_simulator/validator.rb

@@ -3,29 +3,51 @@ module ToyRoboSimulator
   # takes arguments and attributes from a Robo.
   module Validator
     # Ensures input values of Robo#place action is valid in type and range.
-    # Returns false if it is not valid.
-    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)
+    # Returns false if it is not valid, otherwise returns true.
+    def valid_placement?
+      validate_placement
+      if @errors.any?
+        @errors.each { |message| puts message }
+        @x, @y, @orientation = nil, nil, nil
+        false
+      else
+        @x, @y = @x.to_i, @y.to_i
+        true
+      end
     end
 
     # Prevents Robo#move from moving out of the table.
-    # Returns false if the Robo is at the edge of the table.
-    def validate_movement
-      @errors << 'The Robo is at edge. No further move is allowed.' if edge?
+    # Returns false if the Robo is at the edge of the table, otherwise returns true.
+    def moveable?
+      if edge?
+        puts 'The Robo is at edge. No further move is allowed.'
+      else
+        true
+      end
     end
 
     # Ensures the Robo is placed before any other actions are performed.
-    # Returns false if no attributes are set for the Robo.
-    def validate_if_placed
-      @errors << 'The Robo is not placed yet. Use PLACE command first.' unless @x && @y && @orientation
+    # Returns false if no attributes are set for the Robo, otherwise returns true.
+    def placed?
+      if @x && @y && @orientation
+        true
+      else
+        puts 'The Robo is not placed yet. Use PLACE command first.'
+        false
+      end
     end
 
     private
 
+    def validate_placement
+      @errors = []
+      @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 << 'It can only face NORTH, SOUTH, EAST, or WEST' unless orientation_valid?(@orientation)
+    end
+
     def int?(value)
       value.to_s == value.to_i.to_s
     end
@@ -45,9 +67,9 @@ module ToyRoboSimulator
       when :east
         @x == @table.x
       when :south
-        @y == 0
+        @y.zero?
       when :west
-        @x == 0
+        @x.zero?
       end
     end
   end

data/lib/toy_robo_simulator/version.rb

@@ -1,3 +1,3 @@
 module ToyRoboSimulator
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toy_robo_simulator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Adler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - Rakefile
 - bin/console
 - bin/robo
+- bin/robo-dev
 - bin/setup
 - lib/toy_robo_simulator.rb
 - lib/toy_robo_simulator/console.rb
@@ -116,9 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A toy robot simulator
 test_files: []
-has_rdoc: