robot_rea 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73095d64460267f93eb6b7068f2d4b728acd558013dc83ccc3465e168aa10955
-  data.tar.gz: 9442ab1a0a426cbe65fee5500882f5230d15f55791bd5fa1d41733b3fc78a8c8
+  metadata.gz: 4c28f77b0f5fb3c609046a3439f11841d86d5e5f6ac54896647db26d77278f00
+  data.tar.gz: 76b2de4755bc647d06a5ee8f3b5fd6ebe4d13465a1b290fcf9c406b7d1c33f42
 SHA512:
-  metadata.gz: 2944ec74a6eefc86a7807f32909940f63d0a62f4cb3b6452aad2903f947fa52755fbc01b407549eb92cac06c0b155d36f32997d69c2fd49730254ab0f6dec7bd
-  data.tar.gz: afb15ea2ec832b0ae10dac2e43f538cb59c9cf1658d9491c45b8640dee0e115bc7b8320de5a0b5098a697ec041a8db6164f46b5b121291dc2d8b9f9c2824f8a5
+  metadata.gz: e174a31378b1d2eb8732212fbf888f9b5820cc131ffd562dcd34787ab7f090e7fc5799e1cd9a79f2aeebd8ed9c8d4872b309e6c795d0413de2cfe2f68c10161e
+  data.tar.gz: a06bb5ee747927d4aa82435e312348a7f10a1f16c959d85b843a7bed70a81a25210190c962f7e95f9c4f250af6939bdb72198f5ab4bca8d120f4b156cf4dc81d

data/README.md

@@ -25,5 +25,6 @@ LEFT
 REPORT
 ```
 
-To configure the table size, update the file `config.yaml`
+
+To run the specs, clone the repo then run `bundle exec rspec`
 

data/lib/robot.rb

@@ -1,4 +1,6 @@
-require "robot/version"
+# frozen_string_literal: true
+
+require 'robot/version'
 require 'robot/point'
 require 'robot/position'
 require 'robot/directions'
@@ -10,5 +12,21 @@ require 'robot/game'
 module Robot
   def self.run
     Game.()
+    instructions
+  end
+
+  def instructions
+    puts <<~HEREDOC
+      Welcome to the Robot game
+      Please enter one of the following commands:
+      PLACE 0,0,NORTH (PLACE X,Y,DIRECTION)
+      MOVE
+      LEFT
+      RIGHT
+      REPORT
+
+      invalid commands are ignored.
+      You must start with a place command.
+    HEREDOC
   end
 end

data/lib/robot/command_proxy.rb

@@ -1,9 +1,10 @@
-# This class implements the proxy design pattern. It sits between the client and the commands,
-# and only invokes the command if it passes validation.
+# frozen_string_literal: true
+
 module Robot
+  # This class implements the proxy design pattern. It sits between the client and the commands,
+  # and only invokes the command if it passes validation.
   class CommandProxy
-
-    attr_reader :command_string, :position, :min_point, :max_point
+    attr_reader :command_string, :position
 
     def initialize(command_string:, position: nil)
       @command_string = command_string
@@ -33,6 +34,7 @@ module Robot
 
     def would_fall?
       return unless [Robot::Commands::Move, Robot::Commands::Place].include?(command_class)
+
       new_position = execute
       new_position.point > table.max_point || new_position.point < table.min_point
     end

data/lib/robot/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'robot/commands/place_command_parser'
 require 'robot/commands/base'
 require 'robot/commands/no_op'
@@ -7,4 +9,3 @@ require 'robot/commands/right'
 require 'robot/commands/place'
 require 'robot/commands/report'
 require 'robot/commands/factory'
-

data/lib/robot/commands/base.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
+    # Command Base/Interface
     class Base
-      def self.matches(command)
+      def self.matches(_command)
         raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
       end
 

data/lib/robot/commands/factory.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # Factory class that takes a command input and returns the command object that can handle it,
 # this is used instead of if/else or case/when for each command.
 # If the command entered does not match any known command, the NoOp Command will be returned.
 
 module Robot
   module Commands
-    COMMANDS = [Left, Right, Move, Place, Report, NoOp]
+    COMMANDS = [Left, Right, Move, Place, Report, NoOp].freeze
 
     class Factory
       def self.build(command)

data/lib/robot/commands/left.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
     class Left < Base

data/lib/robot/commands/move.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
     class Move < Base
-      MOVE = 'MOVE'.freeze
+      MOVE = 'MOVE'
 
       def self.matches?(command)
         command == MOVE
@@ -11,8 +13,8 @@ module Robot
         {
           Robot::Directions::NORTH => position.north,
           Robot::Directions::SOUTH => position.south,
-          Robot::Directions::EAST  => position.east,
-          Robot::Directions::WEST  => position.west,
+          Robot::Directions::EAST => position.east,
+          Robot::Directions::WEST => position.west
         }.fetch(position.direction)
       end
     end

data/lib/robot/commands/no_op.rb

@@ -1,11 +1,12 @@
-# A no operation command that's returned to avoid nil exceptions when the command the user
-# enters is invalid. The idea is based on the null pointer design pattern
+# frozen_string_literal: true
 
 module Robot
   module Commands
-    class NoOp < Base
+    # A no operation command that gets returned to avoid nil exceptions when the command the user
+    # enters is invalid. The idea is based on the null pointer design pattern
 
-      def self.matches?(command)
+    class NoOp < Base
+      def self.matches?(_command)
         true
       end
 

data/lib/robot/commands/place.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
+    # Place Command
+
     class Place < Base
       extend PlaceCommandParser
 
-      REGEX = /^\A(PLACE) \d,\d,(NORTH|EAST|WEST|SOUTH)\z/
-
+      REGEX = /^\A(PLACE) \d,\d,(NORTH|EAST|WEST|SOUTH)\z/.freeze
 
       def self.matches?(command)
         command =~ REGEX

data/lib/robot/commands/place_command_parser.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
     module PlaceCommandParser
       def parse(command)
-        command.gsub('PLACE ', '').split(",")
+        command.gsub('PLACE ', '').split(',')
       end
     end
   end

data/lib/robot/commands/report.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
     class Report < Base
-      REPORT = 'REPORT'.freeze
+      REPORT = 'REPORT'
 
       def self.matches?(command)
         command == REPORT

data/lib/robot/commands/right.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Robot
   module Commands
     class Right < Base
-      RIGHT = 'RIGHT'.freeze
+      RIGHT = 'RIGHT'
 
       def self.matches?(command)
         command == RIGHT

data/lib/robot/directions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Robot
   module Directions
     EAST  = :EAST

data/lib/robot/game.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Robot
   class Game
     attr_reader :input
@@ -7,7 +9,7 @@ module Robot
     end
 
     def simulate
-      while command = input.gets
+      while (command = input.gets)
         command = command.chomp
         @position = Robot::CommandProxy.new(command_string: command, position: @position).call
       end
@@ -15,26 +17,7 @@ module Robot
 
     def self.call(input: $stdin)
       game = new(input: input)
-      instruction
       game.simulate
     end
-
-    def self.instruction
-      puts  <<~HEREDOC
-        Welcome to the Robot game
-        Please enter one of the following commands:
-        PLACE 0,0,NORTH (PLACE X,Y,DIRECTION)
-        MOVE
-        LEFT
-        RIGHT
-        REPORT
-
-        invalid commands are ignored.
-        You must start with a place command.
-      HEREDOC
-    end
   end
 end
-
-
-

data/lib/robot/point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Point value object
 
 module Robot
@@ -25,16 +27,16 @@ module Robot
       Point.new(x: x - 1, y: y)
     end
 
-    def ==(point)
-      x == point.x && y == point.y
+    def ==(other)
+      x == other.x && y == other.y
     end
 
-    def >(point)
-      x > point.x || y > point.y
+    def >(other)
+      x > other.x || y > other.y
     end
 
-    def <(point)
-      x < point.x || y < point.y
+    def <(other)
+      x < other.x || y < other.y
     end
 
     def to_s

data/lib/robot/position.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Position value object
 
 module Robot
@@ -26,15 +28,15 @@ module Robot
     end
 
     def left
-      Position.new(point: point, direction: lefts[direction] )
+      Position.new(point: point, direction: lefts[direction])
     end
 
     def right
-      Position.new(point: point, direction: rights[direction] )
+      Position.new(point: point, direction: rights[direction])
     end
 
-    def ==(position)
-      point == position.point && direction == position.direction
+    def ==(other)
+      point == other.point && direction == other.direction
     end
 
     def to_s
@@ -45,22 +47,20 @@ module Robot
 
     def lefts
       {
-        Robot::Directions::EAST  => Robot::Directions::NORTH,
+        Robot::Directions::EAST => Robot::Directions::NORTH,
         Robot::Directions::NORTH => Robot::Directions::WEST,
-        Robot::Directions::WEST  => Robot::Directions::SOUTH,
-        Robot::Directions::SOUTH => Robot::Directions::EAST,
+        Robot::Directions::WEST => Robot::Directions::SOUTH,
+        Robot::Directions::SOUTH => Robot::Directions::EAST
       }.freeze
     end
 
     def rights
       {
-        Robot::Directions::EAST  => Robot::Directions::SOUTH,
+        Robot::Directions::EAST => Robot::Directions::SOUTH,
         Robot::Directions::SOUTH => Robot::Directions::WEST,
-        Robot::Directions::WEST  => Robot::Directions::NORTH,
-        Robot::Directions::NORTH => Robot::Directions::EAST,
+        Robot::Directions::WEST => Robot::Directions::NORTH,
+        Robot::Directions::NORTH => Robot::Directions::EAST
       }.freeze
     end
   end
 end
-
-

data/lib/robot/table.rb

@@ -1,46 +1,14 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Robot
   class Table
     attr_reader :min_point, :max_point
 
-    def initialize
-      @min_point = set_min_point
-      @max_point = set_max_point
-    end
-
-    private
-
-    def set_min_point
-      Point.new(x: minimum_x, y: minimum_y)
-    end
-
-    def set_max_point
-      Point.new(x: maximum_x, y: maximum_y)
-    end
-
-    def config_file
-      YAML.load_file(File.join(root, 'config.yaml'))
-    end
-
-    def root
-      File.expand_path('../../../', __FILE__)
-    end
-
-    def minimum_x
-      config_file["min_x"]
-    end
-
-    def minimum_y
-      config_file["min_y"]
-    end
-
-    def maximum_x
-      config_file["max_x"]
-    end
-
-    def maximum_y
-      config_file["max_y"]
+    def initialize(min_point: Point.new(x: 0, y: 0), max_point: Point.new(x: 4, y: 4))
+      @min_point = min_point
+      @max_point = max_point
     end
   end
 end

data/lib/robot/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Robot
-  VERSION = "0.1.5"
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robot_rea
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Anonymous
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-09 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,6 @@ files:
 - bin/robot
 - bin/robot.exe
 - bin/setup
-- config.yaml
 - lib/robot.rb
 - lib/robot/command_proxy.rb
 - lib/robot/commands.rb

data/config.yaml

@@ -1,4 +0,0 @@
-min_x: 0
-min_y: 0
-max_x: 4
-max_y: 4