robot_rea 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cce95d6985de86d54196c23696060da2a089fdd251c3d48368be695c7f22c494
-  data.tar.gz: 19e0d3f20d223884e0ec59860ee1a735a7f57181de20afee9759af0318638683
+  metadata.gz: f4016e42d5e11c2d3a2d304d1b499c3823cc905ee9a9ae4990ddb17edaf168c8
+  data.tar.gz: f9cfd2a9c681525eb2b27b62137985d8524616d4092e9f7e17cc8e249941f32e
 SHA512:
-  metadata.gz: 70faa108dac6ed5ff1d7ac2146af47f2da3f17326c5b10c5b4b8cf9db96038241719b0af53b0663775293d9d937ca42196573001c4fe1da9711959cd3d65b501
-  data.tar.gz: c7d23f3794b00b7e7a422fd114b3568cc7e28b353256ce328658748d5d536490f1566739f1b6c4fa7324b76f1287948ffff14fe36c44d508d650d5644178bff1
+  metadata.gz: 1d5d0d0c6ff0a229711c1f97b484dfb805fee3fad42720ff9379e85c419f9377aa5ddae623aa1d86b7be36c65b46541ebb47c1f33061b72179ab71756d2667c0
+  data.tar.gz: 18ee25e68835d739182a028c3269f1d88822460ecc9fb40c38f6c443842dccd1debb550bcb2de75749904d562e920d8ab1aac7e2edf9ddd9223aaccb0b74be2b

data/README.md

@@ -1,43 +1,30 @@
 # Robot
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/robot`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Robot game simulation gem.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
-gem 'robot'
+gem install 'robot_rea'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install robot
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
+Run the executable:
+```
+robot
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/robot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Try some commands: 
 
-## License
+```
+PLACE 0,0,NORTH
+MOVE
+REPORT
+LEFT
+REPORT
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+To run the specs, clone the repo then run `bundle exec rspec`
 
-Everyone interacting in the Robot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/robot/blob/master/CODE_OF_CONDUCT.md).

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'
@@ -9,6 +11,22 @@ require 'robot/game'
 
 module Robot
   def self.run
+    instructions
     Game.()
   end
+
+  def self.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,14 +1,16 @@
+# frozen_string_literal: true
+
 module Robot
   class Game
     attr_reader :input
+
     def initialize(input: $stdin)
       @input = input
     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
     end
@@ -19,6 +21,3 @@ module Robot
     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.4"
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robot_rea
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Anonymous
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-09 00:00:00.000000000 Z
+date: 2020-08-20 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
@@ -105,8 +104,6 @@ files:
 - lib/robot/position.rb
 - lib/robot/table.rb
 - lib/robot/version.rb
-- robot-0.1.0.gem
-- robot-0.1.1.gem
 - robot.gemspec
 homepage: http://rubygems.org/gems/robot_rea
 licenses:

data/config.yaml

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