robot_rea 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cce95d6985de86d54196c23696060da2a089fdd251c3d48368be695c7f22c494
+  data.tar.gz: 19e0d3f20d223884e0ec59860ee1a735a7f57181de20afee9759af0318638683
+SHA512:
+  metadata.gz: 70faa108dac6ed5ff1d7ac2146af47f2da3f17326c5b10c5b4b8cf9db96038241719b0af53b0663775293d9d937ca42196573001c4fe1da9711959cd3d65b501
+  data.tar.gz: c7d23f3794b00b7e7a422fd114b3568cc7e28b353256ce328658748d5d536490f1566739f1b6c4fa7324b76f1287948ffff14fe36c44d508d650d5644178bff1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ahmad@himama.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in robot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    robot (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  rake (~> 10.0)
+  robot!
+  rspec
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ahmad Al-kheat
+
+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,43 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'robot'
+```
+
+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
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/robot

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'robot'
+
+Robot.run

data/bin/robot.exe

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "robot"
+
+Robot.run

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.yaml

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

data/lib/robot.rb

@@ -0,0 +1,14 @@
+require "robot/version"
+require 'robot/point'
+require 'robot/position'
+require 'robot/directions'
+require 'robot/commands'
+require 'robot/command_proxy'
+require 'robot/table'
+require 'robot/game'
+
+module Robot
+  def self.run
+    Game.()
+  end
+end

data/lib/robot/command_proxy.rb

@@ -0,0 +1,52 @@
+# This class implements the proxy design pattern. It sits between the client and the commands,
+# and only invokes the command if it passes validation.
+module Robot
+  class CommandProxy
+
+    attr_reader :command_string, :position, :min_point, :max_point
+
+    def initialize(command_string:, position: nil)
+      @command_string = command_string
+      @position = position
+    end
+
+    def call
+      return if not_placed_yet? && !place_command?
+      return position if would_fall?
+
+      execute
+    end
+
+    private
+
+    def execute
+      if place_command?
+        command_class.build_from_string_command(command_string)
+      else
+        command_class.(position)
+      end
+    end
+
+    def command_class
+      Robot::Commands::Factory.build(command_string)
+    end
+
+    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
+
+    def table
+      @table ||= Robot::Table.new
+    end
+
+    def not_placed_yet?
+      position.nil?
+    end
+
+    def place_command?
+      command_class == Robot::Commands::Place
+    end
+  end
+end

data/lib/robot/commands.rb

@@ -0,0 +1,10 @@
+require 'robot/commands/place_command_parser'
+require 'robot/commands/base'
+require 'robot/commands/no_op'
+require 'robot/commands/move'
+require 'robot/commands/left'
+require 'robot/commands/right'
+require 'robot/commands/place'
+require 'robot/commands/report'
+require 'robot/commands/factory'
+

data/lib/robot/commands/base.rb

@@ -0,0 +1,13 @@
+module Robot
+  module Commands
+    class Base
+      def self.matches(command)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def self.call
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/robot/commands/factory.rb

@@ -0,0 +1,16 @@
+# 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]
+
+    class Factory
+      def self.build(command)
+        command_klass = COMMANDS.detect { |klass| klass.matches?(command) }
+        command_klass
+      end
+    end
+  end
+end

data/lib/robot/commands/left.rb

@@ -0,0 +1,13 @@
+module Robot
+  module Commands
+    class Left < Base
+      def self.matches?(command)
+        command.to_sym == Robot::Directions::LEFT
+      end
+
+      def self.call(position)
+        position.left
+      end
+    end
+  end
+end

data/lib/robot/commands/move.rb

@@ -0,0 +1,20 @@
+module Robot
+  module Commands
+    class Move < Base
+      MOVE = 'MOVE'.freeze
+
+      def self.matches?(command)
+        command == MOVE
+      end
+
+      def self.call(position)
+        {
+          Robot::Directions::NORTH => position.north,
+          Robot::Directions::SOUTH => position.south,
+          Robot::Directions::EAST  => position.east,
+          Robot::Directions::WEST  => position.west,
+        }.fetch(position.direction)
+      end
+    end
+  end
+end

data/lib/robot/commands/no_op.rb

@@ -0,0 +1,17 @@
+# 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
+
+module Robot
+  module Commands
+    class NoOp < Base
+
+      def self.matches?(command)
+        true
+      end
+
+      def self.call(position)
+        position
+      end
+    end
+  end
+end

data/lib/robot/commands/place.rb

@@ -0,0 +1,26 @@
+module Robot
+  module Commands
+    class Place < Base
+      extend PlaceCommandParser
+
+      REGEX = /^\A(PLACE) \d,\d,(NORTH|EAST|WEST|SOUTH)\z/
+
+
+      def self.matches?(command)
+        command =~ REGEX
+      end
+
+      def self.call(x:, y:, f:)
+        Robot::Position.new(point: Point.new(x: x, y: y), direction: f)
+      end
+
+      def self.build_from_string_command(command)
+        x, y, f = parse(command)
+        x = x.to_i
+        y = y.to_i
+        f = f.to_sym
+        call(x: x, y: y, f: f)
+      end
+    end
+  end
+end

data/lib/robot/commands/place_command_parser.rb

@@ -0,0 +1,9 @@
+module Robot
+  module Commands
+    module PlaceCommandParser
+      def parse(command)
+        command.gsub('PLACE ', '').split(",")
+      end
+    end
+  end
+end

data/lib/robot/commands/report.rb

@@ -0,0 +1,16 @@
+module Robot
+  module Commands
+    class Report < Base
+      REPORT = 'REPORT'.freeze
+
+      def self.matches?(command)
+        command == REPORT
+      end
+
+      def self.call(position)
+        puts position
+        position
+      end
+    end
+  end
+end

data/lib/robot/commands/right.rb

@@ -0,0 +1,15 @@
+module Robot
+  module Commands
+    class Right < Base
+      RIGHT = 'RIGHT'.freeze
+
+      def self.matches?(command)
+        command == RIGHT
+      end
+
+      def self.call(position)
+        position.right
+      end
+    end
+  end
+end

data/lib/robot/directions.rb

@@ -0,0 +1,10 @@
+module Robot
+  module Directions
+    EAST  = :EAST
+    WEST  = :WEST
+    SOUTH = :SOUTH
+    NORTH = :NORTH
+    LEFT  = :LEFT
+    RIGHT = :RIGHT
+  end
+end

data/lib/robot/game.rb

@@ -0,0 +1,24 @@
+module Robot
+  class Game
+    attr_reader :input
+    def initialize(input: $stdin)
+      @input = input
+    end
+
+    def simulate
+      while command = input.gets
+        command = command.chomp
+
+        @position = Robot::CommandProxy.new(command_string: command, position: @position).call
+      end
+    end
+
+    def self.call(input: $stdin)
+      game = new(input: input)
+      game.simulate
+    end
+  end
+end
+
+
+

data/lib/robot/point.rb

@@ -0,0 +1,44 @@
+# Point value object
+
+module Robot
+  class Point
+    attr_reader :x, :y
+
+    def initialize(x:, y:)
+      @x = x
+      @y = y
+    end
+
+    def north
+      Point.new(x: x, y: y + 1)
+    end
+
+    def south
+      Point.new(x: x, y: y - 1)
+    end
+
+    def east
+      Point.new(x: x + 1, y: y)
+    end
+
+    def west
+      Point.new(x: x - 1, y: y)
+    end
+
+    def ==(point)
+      x == point.x && y == point.y
+    end
+
+    def >(point)
+      x > point.x || y > point.y
+    end
+
+    def <(point)
+      x < point.x || y < point.y
+    end
+
+    def to_s
+      "#{x}, #{y}"
+    end
+  end
+end

data/lib/robot/position.rb

@@ -0,0 +1,66 @@
+# Position value object
+
+module Robot
+  class Position
+    attr_reader :point, :direction
+
+    def initialize(point: Point.new(x: 0, y: 0), direction: Robot::Directions::NORTH)
+      @point = point
+      @direction = direction
+    end
+
+    def north
+      Position.new(point: point.north, direction: direction)
+    end
+
+    def south
+      Position.new(point: point.south, direction: direction)
+    end
+
+    def east
+      Position.new(point: point.east, direction: direction)
+    end
+
+    def west
+      Position.new(point: point.west, direction: direction)
+    end
+
+    def left
+      Position.new(point: point, direction: lefts[direction] )
+    end
+
+    def right
+      Position.new(point: point, direction: rights[direction] )
+    end
+
+    def ==(position)
+      point == position.point && direction == position.direction
+    end
+
+    def to_s
+      "#{point}, #{direction}"
+    end
+
+    private
+
+    def lefts
+      {
+        Robot::Directions::EAST  => Robot::Directions::NORTH,
+        Robot::Directions::NORTH => Robot::Directions::WEST,
+        Robot::Directions::WEST  => Robot::Directions::SOUTH,
+        Robot::Directions::SOUTH => Robot::Directions::EAST,
+      }.freeze
+    end
+
+    def rights
+      {
+        Robot::Directions::EAST  => Robot::Directions::SOUTH,
+        Robot::Directions::SOUTH => Robot::Directions::WEST,
+        Robot::Directions::WEST  => Robot::Directions::NORTH,
+        Robot::Directions::NORTH => Robot::Directions::EAST,
+      }.freeze
+    end
+  end
+end
+
+

data/lib/robot/table.rb

@@ -0,0 +1,46 @@
+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"]
+    end
+  end
+end

data/lib/robot/version.rb

@@ -0,0 +1,3 @@
+module Robot
+  VERSION = "0.1.4"
+end

data/robot.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "robot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "robot_rea"
+  spec.version       = Robot::VERSION
+  spec.authors       = ["Anonymous"]
+  spec.email         = ["a@a.com"]
+
+  spec.summary       = %q{robot simulation}
+  spec.description   = %q{robot simulation}
+  spec.homepage      = "http://rubygems.org/gems/robot_rea"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://test.com"
+  spec.metadata["changelog_uri"] = "http://test.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.executables   = ['robot']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: robot_rea
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Anonymous
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: robot simulation
+email:
+- a@a.com
+executables:
+- robot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/robot
+- bin/robot.exe
+- bin/setup
+- config.yaml
+- lib/robot.rb
+- lib/robot/command_proxy.rb
+- lib/robot/commands.rb
+- lib/robot/commands/base.rb
+- lib/robot/commands/factory.rb
+- lib/robot/commands/left.rb
+- lib/robot/commands/move.rb
+- lib/robot/commands/no_op.rb
+- lib/robot/commands/place.rb
+- lib/robot/commands/place_command_parser.rb
+- lib/robot/commands/report.rb
+- lib/robot/commands/right.rb
+- lib/robot/directions.rb
+- lib/robot/game.rb
+- lib/robot/point.rb
+- 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:
+- MIT
+metadata:
+  homepage_uri: http://rubygems.org/gems/robot_rea
+  source_code_uri: http://test.com
+  changelog_uri: http://test.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: robot simulation
+test_files: []