loco_bot 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bcc03fc9e471fbe3836c3d97c8f4b2c1781c3b4
-  data.tar.gz: 3422b70bf9684df8760c86aee333509d3c3ea18f
+  metadata.gz: 6e0a1c8db7a70dcd7daec9e1493e617a4ef3d912
+  data.tar.gz: 1f9d8d45a358faf58a8dba65af42f9fd9b553581
 SHA512:
-  metadata.gz: f6e1f94945da2600e5d87060c1d86a38609e38b762c2b270a2f603306b7bd762aa93883a1b6627d82a9a545d6f5a07471337a266bb1af7b4b11c1141f5a8a4d5
-  data.tar.gz: 1a543d54eb4229da4fe29d915b1f4f9251d31e9d9b56f76d34807d611193cfcec09c9cc3e2b1f60338d934224669109cf8ab08bea020c7c78acda7ef30f5b053
+  metadata.gz: c6b6cbecc758ad45feda6b9c9bcfda1261afe32bc449c380e07d9db4c5582acff2240ea65454750a4eec31559a48bc6f73c7b6fef6225cf403b70001c853ebaa
+  data.tar.gz: 1753fbf0dc832a2d1d3418eae6bf5450c39b36a79f2162691d8223c56e7dac7ee37bea6c52e16dfdc3f6a42f9e2ac3648f02108e511da86e85404ee51773fb39

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/Rakefile

@@ -3,7 +3,16 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
 
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new do |task|
+    task.options = ['-D']
+  end
+rescue LoadError
+  warn 'Rubocop not found'
+end
+
 task default: :test
 
 desc 'Run the test suite'
-task test: :spec
+task test: [:spec, :rubocop]

data/bin/loco_bot_cli

@@ -5,6 +5,6 @@ require 'loco_bot'
 
 cli = LocoBot::CLI.new
 
-while input = STDIN.gets
+while (input = STDIN.gets)
   cli.input!(input)
 end

data/lib/loco_bot/cli/command/base.rb

@@ -3,7 +3,6 @@ module LocoBot
     module Command
       # Parent class for Command classes.
       class Base
-
         # @!attribute [r] table
         # @return [Robot] the Robot
         attr_reader :robot
@@ -20,7 +19,7 @@ module LocoBot
         # Returns the Command's label.
         # @return [String] the Command's label
         def self.label
-          self.name.split("::").last.upcase
+          name.split('::').last.upcase
         end
       end
     end

data/lib/loco_bot/cli/command/report.rb

@@ -6,11 +6,19 @@ module LocoBot
         # Executes the command.
         # @return [void]
         def execute
-          report = robot.report
+          report_hash = robot.report
 
-          unless report.empty?
-            puts "#{report[:x]},#{report[:y]},#{report[:direction].label}"
-          end
+          puts report_string(report_hash) unless report_hash.empty?
+        end
+
+        private
+
+        def report_string(report_hash)
+          [
+            report_hash[:x],
+            report_hash[:y],
+            report_hash[:direction].label
+          ].join(',')
         end
       end
     end

data/lib/loco_bot/cli/command.rb

@@ -10,11 +10,10 @@ module LocoBot
   class CLI
     # Top-level namespace for available commands.
     module Command
-
       # Returns the list of available commands.
       # @return [Array<String>] the list of available commands
       def self.list
-        list = constants.map {|const| const.to_s.upcase}
+        list = constants.map { |const| const.to_s.upcase }
         list.delete('BASE')
         list
       end
@@ -23,11 +22,9 @@ module LocoBot
       # @param name [String] the Command name
       # @return [Command] the Command
       def self.class_from_name(name)
-        return nil if name.nil? or name.capitalize.to_s == 'Base'
+        return nil if name.nil? || name.capitalize.to_s == 'Base'
 
-        if const_defined?(name.capitalize, false)
-          const_get(name.capitalize)
-        end
+        const_get(name.capitalize) if const_defined?(name.capitalize, false)
       end
     end
   end

data/lib/loco_bot/cli.rb

@@ -46,11 +46,9 @@ module LocoBot
     private
 
     def execute_command(command_class, arguments)
-      begin
-        command_class.new(robot, table).execute(*arguments)
-      rescue ArgumentError => exception
-        puts "#{command_class.label}: #{exception.message}"
-      end
+      command_class.new(robot, table).execute(*arguments)
+    rescue ArgumentError => exception
+      puts "#{command_class.label}: #{exception.message}"
     end
 
     def parse_input(input)

data/lib/loco_bot/robot/direction/east.rb

@@ -3,7 +3,6 @@ module LocoBot
     module Direction
       # East direction.
       module East
-
         # Returns the Direction at the left of this one.
         # @return [Direction::North]
         def self.left

data/lib/loco_bot/robot/direction/north.rb

@@ -3,7 +3,6 @@ module LocoBot
     module Direction
       # North direction.
       module North
-
         # Returns the Direction at the left of this one.
         # @return [Direction::West]
         def self.left

data/lib/loco_bot/robot/direction/south.rb

@@ -3,7 +3,6 @@ module LocoBot
     module Direction
       # South direction.
       module South
-
         # Returns the Direction at the left of this one.
         # @return [Direction::East]
         def self.left

data/lib/loco_bot/robot/direction/west.rb

@@ -3,7 +3,6 @@ module LocoBot
     module Direction
       # West direction.
       module West
-
         # Returns the Direction at the left of this one.
         # @return [Direction::South]
         def self.left

data/lib/loco_bot/robot/direction.rb

@@ -7,7 +7,6 @@ module LocoBot
   class Robot
     # Top-level namespace for the possible facing directions.
     module Direction
-
       # Returns the list of available Direction as Strings.
       # @return [Array<String>]
       def self.list
@@ -18,9 +17,7 @@ module LocoBot
       # @param name [String] the Direction name
       # @return [Command] the Direction
       def self.from_name(name)
-        if const_defined?(name.capitalize, false)
-          const_get(name.capitalize)
-        end
+        const_get(name.capitalize) if const_defined?(name.capitalize, false)
       end
     end
   end

data/lib/loco_bot/robot.rb

@@ -3,7 +3,6 @@ require 'loco_bot/robot/direction'
 module LocoBot
   # Representation of a robot, placeable on tables.
   class Robot
-
     # @!attribute [r] table
     # @return [Table] the Table the Robot is currently placed on
     attr_reader :table
@@ -78,7 +77,7 @@ module LocoBot
     def report
       return {} if table.nil?
 
-      {x: x, y: y, direction: direction}
+      { x: x, y: y, direction: direction }
     end
 
     # Outputs a friendly greating.

data/lib/loco_bot/table.rb

@@ -1,7 +1,6 @@
 module LocoBot
   # Representation of a table on which robots can be placed.
   class Table
-
     # @!attribute [r] width
     # @return [Fixnum] width of the Table
     # Determines the farthest accessible point on the Table's x-axis.
@@ -65,7 +64,7 @@ module LocoBot
     # @param y [Integer] the y-axis coordinate
     # @return [Boolean] true if a Robot can be placed at the given coordinates, false otherwise.
     def position_valid?(x, y)
-      position_within_bounds?(x, y) and position_free?(x, y)
+      position_within_bounds?(x, y) && position_free?(x, y)
     end
 
     # The collection of Robots currently placed on the Table.
@@ -81,7 +80,7 @@ module LocoBot
     end
 
     def position_free?(x, y)
-      robots.none? {|robot| robot.x == x && robot.y == y }
+      robots.none? { |robot| robot.x == x && robot.y == y }
     end
 
     def validate_dimensions
@@ -89,7 +88,7 @@ module LocoBot
       errors << "#{width} is not a valid width: it must be > 0" unless width > 0
       errors << "#{height} is not a valid height: it must be > 0" unless height > 0
 
-      raise ArgumentError.new(errors.join(', ')) unless errors.empty?
+      fail(ArgumentError, errors.join(', ')) unless errors.empty?
     end
   end
 end

data/lib/loco_bot/version.rb

@@ -1,4 +1,5 @@
+# Top-level namespace of the gem.
 module LocoBot
   # The gem's current version
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/loco_bot.gemspec

@@ -8,8 +8,10 @@ Gem::Specification.new do |spec|
   spec.version       = LocoBot::VERSION
   spec.authors       = ['Rafaël Gonzalez']
   spec.email         = ['github@rafaelgonzalez.me']
-  spec.summary       = %q{Ruby gem of crazy robots and benevolent tables that keep watching over them.}
-  spec.description   = %q{Issue commands to control the robots and the tables will keep you from making them fall, you monster!}
+  spec.summary       = 'Ruby gem of crazy robots and benevolent tables that ' \
+                       'keep watching over them.'
+  spec.description   = 'Issue commands to control the robots and the tables ' \
+                       'will keep you from making them fall, you monster!'
   spec.homepage      = 'https://github.com/rafaelgonzalez/loco_bot'
   spec.license       = 'MIT'
 
@@ -23,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.0'
+  spec.add_development_dependency 'rubocop', '~> 0.32.1'
 end

data/spec/loco_bot/cli/command/report_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe LocoBot::CLI::Command::Report do
     end
 
     context 'after placing robot' do
-      before { subject.robot.place(table, 4 ,2 , LocoBot::Robot::Direction::East) }
+      before { subject.robot.place(table, 4, 2, LocoBot::Robot::Direction::East) }
 
       it 'outputs a string' do
         expect { subject.execute }.to output("4,2,EAST\n").to_stdout

data/spec/loco_bot/cli/command_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe LocoBot::CLI::Command do
   describe '.list' do
     subject { described_class.list }
 
-    it { is_expected.to eql ['HODOR', 'LEFT', 'MOVE', 'PLACE', 'REPORT', 'RIGHT'] }
+    it { is_expected.to eql %w(HODOR LEFT MOVE PLACE REPORT RIGHT) }
   end
 
   describe '.class_from_name' do

data/spec/loco_bot/cli_spec.rb

@@ -17,9 +17,9 @@ RSpec.describe LocoBot::CLI do
         let(:command_class_double) { double }
 
         it 'calls the correct command' do
-          expect(LocoBot::CLI::Command::Place).to receive(:new).
-                                                  with(subject.robot, subject.table).
-                                                  once.and_return(command_class_double)
+          expect(LocoBot::CLI::Command::Place).to receive(:new)
+            .with(subject.robot, subject.table)
+            .once.and_return(command_class_double)
 
           expect(command_class_double).to receive(:execute).with('1', '3', 'SOUTH').once
 
@@ -41,7 +41,9 @@ RSpec.describe LocoBot::CLI do
       let(:arguments) { '' }
 
       it 'does not raise an error' do
-        expect { subject.input!(input) }.to output("YADAYADA: not a known command. Valid commands are HODOR, LEFT, MOVE, PLACE, REPORT, RIGHT.\n").to_stdout
+        expect { subject.input!(input) }.to output(
+          "YADAYADA: not a known command. Valid commands are HODOR, LEFT, MOVE, PLACE, REPORT, RIGHT.\n"
+        ).to_stdout
       end
     end
   end

data/spec/loco_bot/robot/direction/east_spec.rb

@@ -20,6 +20,6 @@ RSpec.describe LocoBot::Robot::Direction::East do
   describe '.vector' do
     subject { described_class.vector(21, 17) }
 
-    it { is_expected.to eql({ x: 22, y: 17 }) }
+    it { is_expected.to eql(x: 22, y: 17) }
   end
 end

data/spec/loco_bot/robot/direction/north_spec.rb

@@ -20,6 +20,6 @@ RSpec.describe LocoBot::Robot::Direction::North do
   describe '.vector' do
     subject { described_class.vector(21, 17) }
 
-    it { is_expected.to eql({ x: 21, y: 18 }) }
+    it { is_expected.to eql(x: 21, y: 18) }
   end
 end

data/spec/loco_bot/robot/direction/south_spec.rb

@@ -20,6 +20,6 @@ RSpec.describe LocoBot::Robot::Direction::South do
   describe '.vector' do
     subject { described_class.vector(21, 17) }
 
-    it { is_expected.to eql({ x: 21, y: 16 }) }
+    it { is_expected.to eql(x: 21, y: 16) }
   end
 end

data/spec/loco_bot/robot/direction/west_spec.rb

@@ -20,6 +20,6 @@ RSpec.describe LocoBot::Robot::Direction::West do
   describe '.vector' do
     subject { described_class.vector(21, 17) }
 
-    it { is_expected.to eql({ x: 20, y: 17 }) }
+    it { is_expected.to eql(x: 20, y: 17) }
   end
 end

data/spec/loco_bot/robot/direction_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe LocoBot::Robot::Direction do
   describe '.list' do
     subject { described_class.list }
 
-    it { is_expected.to eql ['East', 'North', 'South', 'West'] }
+    it { is_expected.to eql %w(East North South West) }
   end
 
   describe '.from_name' do

data/spec/loco_bot/robot_spec.rb

@@ -272,7 +272,7 @@ RSpec.describe LocoBot::Robot do
     context 'when placed on a table' do
       before { robot.place(table, 6, 17, LocoBot::Robot::Direction::East)  }
 
-      it { is_expected.to eql({x: 6, y: 17, direction: LocoBot::Robot::Direction::East}) }
+      it { is_expected.to eql(x: 6, y: 17, direction: LocoBot::Robot::Direction::East) }
     end
 
     context 'when not placed on a table' do
@@ -300,25 +300,25 @@ RSpec.describe LocoBot::Robot do
       context 'facing north' do
         let(:direction) { LocoBot::Robot::Direction::North }
 
-        it { is_expected.to eql({x: 10, y: 11}) }
+        it { is_expected.to eql(x: 10, y: 11) }
       end
 
       context 'facing south' do
         let(:direction) { LocoBot::Robot::Direction::South }
 
-        it { is_expected.to eql({x: 10, y: 9}) }
+        it { is_expected.to eql(x: 10, y: 9) }
       end
 
       context 'facing east' do
         let(:direction) { LocoBot::Robot::Direction::East }
 
-        it { is_expected.to eql({x: 11, y: 10}) }
+        it { is_expected.to eql(x: 11, y: 10) }
       end
 
       context 'facing west' do
         let(:direction) { LocoBot::Robot::Direction::West }
 
-        it { is_expected.to eql({x: 9, y: 10}) }
+        it { is_expected.to eql(x: 9, y: 10) }
       end
     end
   end
@@ -330,7 +330,6 @@ RSpec.describe LocoBot::Robot do
       it { is_expected.to be false }
     end
 
-
     context 'when placed on a table' do
       before { robot.place(table, 0, 0, direction) }
 

data/spec/loco_bot/table_spec.rb

@@ -11,20 +11,20 @@ RSpec.describe LocoBot::Table do
     context 'with an invalid width' do
       let(:width) { 0 }
 
-      it { expect{ subject }.to(raise_error(ArgumentError)) }
+      it { expect { subject }.to(raise_error(ArgumentError)) }
     end
 
     context 'with an invalid height' do
       let(:height) { -5 }
 
-      it { expect{ subject }.to(raise_error(ArgumentError)) }
+      it { expect { subject }.to(raise_error(ArgumentError)) }
     end
 
     context 'with an invalid width and height' do
       let(:width) { -16 }
       let(:height) { 0 }
 
-      it { expect{ subject }.to(raise_error(ArgumentError)) }
+      it { expect { subject }.to(raise_error(ArgumentError)) }
     end
   end
 

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ CodeClimate::TestReporter.start
 
 require 'simplecov'
 SimpleCov.start do
-  add_filter "/spec/"
+  add_filter '/spec/'
 end
 
 require 'loco_bot'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loco_bot
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Rafaël Gonzalez
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
 description: Issue commands to control the robots and the tables will keep you from
   making them fall, you monster!
 email:
@@ -91,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt