toy_robot_cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9ea2b0b48996a8fcb4f68df38f7773060e92ac1221d36e09eb05268a6cb6db6
+  data.tar.gz: '0145910220ff22a216dfe8b4ffe4786d337a993d0a8b743c52b9092fa716b7b9'
+SHA512:
+  metadata.gz: be4037d0629acfd481136ea6ab35a7875a3b3ec2670a55d9e93e86f866b0b1c555b98366a5e0518c288431803f4ac64d5183479ff6cb7d19da149cf9eb7c1133
+  data.tar.gz: aa39acda6ad7fb7b128970fc40420888a314c784c83bb81f2a951a3a48a7d7bcbe439d439a3769e9a49ee83508848111b8029fce45cfaf24ecf8016d42cdec12

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Paulo H Sacramento
+
+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,61 @@
+# ToyRobotCli
+
+ToyRobotCli is a RubyGem that provides a command-line interface (CLI) for interacting with a toy robot on a table.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toy_robot_cli'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+gem install toy_robot_cli
+```
+
+## Usage
+
+To use the ToyRobotCli gem, you can run the toy_robot command in your terminal.
+
+The available commands are:
+
+- place X Y FACING: Place the robot on the table at position X,Y facing the specified direction (NORTH, EAST, SOUTH, WEST).
+- move: Move the robot one unit forward in the current direction.
+- left: Rotate the robot 90 degrees to the left.
+- right: Rotate the robot 90 degrees to the right.
+- report: Report the current position and direction of the robot.
+
+Here's an example usage:
+
+```shell
+$ toy_robot
+> place 1 2 EAST
+> move
+> move
+> right
+> move
+> report
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` or `bundle exec cucumber features` to run the tests. 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 the created tag, 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/phsacramento/toy_robot_cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/toy_robot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "toy_robot_cli"
+
+ToyRobotCli::CLI.start

data/lib/toy_robot_cli/cli.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ToyRobotCli
+  class CLI < Thor
+    VALID_DIRECTIONS = %w[NORTH EAST SOUTH WEST].freeze
+
+    def initialize(*args)
+      super
+      @robot = Robot.new
+    end
+
+    desc "place X Y FACING", "Place the robot on the table"
+    def place(x, y, facing)
+      @robot.place(x.to_i, y.to_i, facing.upcase)
+    end
+
+    desc "move", "Move the robot one unit forward in the current direction"
+    def move
+      @robot.move
+    end
+
+    desc "left", "Rotate the robot 90 degrees to the left"
+    def left
+      @robot.left
+    end
+
+    desc "right", "Rotate the robot 90 degrees to the right"
+    def right
+      @robot.right
+    end
+
+    desc "report", "Report the current position and direction of the robot"
+    def report
+      puts @robot.report
+    end
+
+    desc "interactive", "Interactive mode to input commands"
+    def interactive
+      loop do
+        print "> "
+        input = $stdin.gets.chomp.downcase
+
+        command, *args = input.split(" ")
+
+        case command
+        when "place"
+          place(*args)
+        when "move"
+          move
+        when "left"
+          left
+        when "right"
+          right
+        when "report"
+          report
+        when "exit"
+          break
+        else
+          puts "Invalid command. Please try again."
+        end
+      end
+    end
+
+    default_task :interactive
+  end
+end

data/lib/toy_robot_cli/robot.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Ruby module to wrap robot moves features
+module ToyRobotCli
+  # Ruby class to handle Robot moves on square table top
+  class Robot
+    # Valid directions what robot can be faced
+    VALID_DIRECTIONS = %w[NORTH EAST SOUTH WEST].freeze
+
+    # Initialize a new Robot instance.
+    def initialize
+      @position = nil
+      @direction = nil
+    end
+
+    # Place the robot on the table at the specified coordinates and facing direction.
+    # Example:
+    #   >> robot = ToyRobotCli::Robot.new
+    #   => #<ToyRobotCli::Robot:0x000000... @direction=nil, @position=nil>
+    #   >> robot.place(0, 0, "SOUTH")
+    #   => 2
+    #
+    # Arguments:
+    #   coordinate_x: (Integer) - The X-coordinate of the robot's position.
+    #   coordinate_y: (Integer) - The Y-coordinate of the robot's position.
+    #   facing: (String) - The direction the robot is facing (NORTH, EAST, SOUTH, WEST).
+
+    def place(coordinate_x, coordinate_y, facing)
+      return unless valid_position?(coordinate_x, coordinate_y) && VALID_DIRECTIONS.include?(facing)
+
+      @position = Matrix[[coordinate_x], [coordinate_y]]
+      @direction = VALID_DIRECTIONS.index(facing)
+    end
+
+    # Move the robot one unit forward in the current direction.
+    def move
+      return unless placed?
+
+      new_position = @position + direction_vector
+      @position = new_position if valid_position?(new_position[0, 0], new_position[1, 0])
+    end
+
+    # Rotate the robot 90 degrees to the left.
+    def left
+      return unless placed?
+
+      @direction = (@direction - 1) % VALID_DIRECTIONS.length
+    end
+
+    # Rotate the robot 90 degrees to the right.
+    def right
+      return unless placed?
+
+      @direction = (@direction + 1) % VALID_DIRECTIONS.length
+    end
+
+    # Report the current position and direction of the robot.
+    # Example:
+    #   >> robot = ToyRobotCli::Robot.new
+    #   => #<ToyRobotCli::Robot:0x000000... @direction=nil, @position=nil>
+    #   >> robot.place(0, 0, "SOUTH")
+    #   => 2
+    #   >> robot.report
+    #   => "0,0,SOUTH"
+    #
+    # Returns:
+    #   (String) - The current position and direction of the robot in the format "X,Y,FACING".
+    def report
+      return unless placed?
+
+      coordinate_x, coordinate_y = @position.to_a.flatten
+      "#{coordinate_x},#{coordinate_y},#{VALID_DIRECTIONS[@direction]}"
+    end
+
+    private
+
+    # Check if the specified position is valid within the table boundaries.
+    def valid_position?(coordinate_x, coordinate_y)
+      (0..4).cover?(coordinate_x) && (0..4).cover?(coordinate_y)
+    end
+
+    # Check if the robot is placed on the table.
+    def placed?
+      !@position.nil? && !@direction.nil?
+    end
+
+    # Calculate the direction vector based on the current direction.
+    def direction_vector
+      direction = Matrix[[0], [0]]
+      update_direction(direction)
+      direction
+    end
+
+    # Update the direction vector based on the current direction.
+    def update_direction(direction)
+      case @direction
+      when 0
+        direction[1, 0] = -1
+      when 1
+        direction[0, 0] = 1
+      when 2
+        direction[1, 0] = 1
+      when 3
+        direction[0, 0] = -1
+      end
+    end
+  end
+end

data/lib/toy_robot_cli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ToyRobotCli
+  VERSION = "0.1.0"
+end

data/lib/toy_robot_cli.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "matrix"
+
+require File.expand_path("toy_robot_cli/cli", __dir__)
+require File.expand_path("toy_robot_cli/version", __dir__)
+require File.expand_path("toy_robot_cli/robot", __dir__)
+
+module ToyRobotCli
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/toy_robot_cli.rbs

@@ -0,0 +1,4 @@
+module ToyRobotCli
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/toy_robot_cli.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/toy_robot_cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "toy_robot_cli"
+  spec.version = ToyRobotCli::VERSION
+
+  spec.authors = ["Paulo H Sacramento"]
+  spec.email = ["contato@henriquesacramento.net"]
+
+  spec.summary     = "A CLI interface for the Toy Robot gem."
+  spec.description = "A CLI interface using the thor gem for the Toy Robot gem."
+  spec.homepage = "https://github.com/phsacramento/toy-robot-cli"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/phsacramento/toy-robot-cli"
+  spec.metadata["changelog_uri"] = "https://github.com/phsacramento/toy-robot-cli"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile {lib,bin}/**/* lib/**/*])
+    end
+  end
+  spec.executables = ["toy_robot"]
+  spec.bindir = "bin"
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency "aruba", "~> 2.1"
+  spec.add_development_dependency "cucumber", "~> 8.0"
+
+  spec.add_dependency "matrix", "~> 0.4.2"
+  spec.add_dependency "rdoc", "~> 4.2", ">= 4.2.2"
+  spec.add_dependency "thor", "~> 1.2", ">= 1.2.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: toy_robot_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paulo H Sacramento
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: A CLI interface using the thor gem for the Toy Robot gem.
+email:
+- contato@henriquesacramento.net
+executables:
+- toy_robot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/toy_robot
+- lib/toy_robot_cli.rb
+- lib/toy_robot_cli/cli.rb
+- lib/toy_robot_cli/robot.rb
+- lib/toy_robot_cli/version.rb
+- sig/toy_robot_cli.rbs
+- toy_robot_cli.gemspec
+homepage: https://github.com/phsacramento/toy-robot-cli
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/phsacramento/toy-robot-cli
+  source_code_uri: https://github.com/phsacramento/toy-robot-cli
+  changelog_uri: https://github.com/phsacramento/toy-robot-cli
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: A CLI interface for the Toy Robot gem.
+test_files: []