toy_robot_cli 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9465bbbfd49f2de70e762e66b8ebb85a42e058e047dc190d459c4cfa9e0674
-  data.tar.gz: c1d8c7b25605ba93871bae39756c0f0f9f86c263dd784f789b4156cc7a645283
+  metadata.gz: c145bb96e64a3e559084b341f50a38efec5f235b12bf946babe0c2bc2376ab64
+  data.tar.gz: 39c2783f9367048e8346dd8b45db6d4ae9c340b1062e8694b949493f566b4a8a
 SHA512:
-  metadata.gz: 2f9bd0a617f9fc83256dfeae4ef9ef879f761f49b9a4c00642b322792beacaf50223cb02fdf48954bc46dbc7a8da2e729e6d107cfa23dc282a311a34e58a7cc3
-  data.tar.gz: 06367b0746873f1af22aa0b9e0a0bc9e103683d501f9183274307201e1c170ad0b4c97e6fb9f7f07007ad7e2d65d83e7c2fa9745a01fb90010f496cd61fda3a8
+  metadata.gz: d92addaad468bfdd6375b3b3771c9657eec02ab4297e7c969340273f9ae3c79f44dcef3076bc0f3d4089371e1745bbe5335a134ca51c28daacb79fb2f450e9da
+  data.tar.gz: c935935c5e16189f8105ba8477ee9d41a2a823dd6a1be4704cc85a56601ba10071ebf7e9285646c846eb24dee8b6b1dd78b2fb85c166fe598b7a4bc2a5bae24f

data/README.md

@@ -34,6 +34,7 @@ The available commands are:
 - right: Rotate the robot 90 degrees to the right.
 - report: Report the current position and direction of the robot.
 - current_position: Report the current position of the robot.
+- current_direction: Report the current direction of the robot is facing.
 
 Here's an example usage:
 
@@ -46,6 +47,7 @@ $ toy_robot
 > move
 > report
 > current_position
+> current_direction
 ```
 
 ## Development
@@ -54,6 +56,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+### Docs
+
+`rdoc lib/toy_robot_cli/robot.rb`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/phsacramento/toy_robot_cli.

data/lib/toy_robot_cli/robot.rb

@@ -38,6 +38,8 @@ module ToyRobotCli
     #   => #<ToyRobotCli::Robot:0x000000... @direction=nil, @position=nil>
     #   >> robot.place(0, 0, "SOUTH")
     #   => 2
+    #   >> robot.current_position
+    #   => [0, 0]
     #
     # Returns:
     #   (Array) - An array containing the X and Y coordinates of the robot's current position.
@@ -47,6 +49,23 @@ module ToyRobotCli
       @position.to_a.flatten
     end
 
+    # Get the current direction of the robot.
+    # Example:
+    #   >> robot = ToyRobotCli::Robot.new
+    #   => #<ToyRobotCli::Robot:0x000000... @direction=nil, @position=nil>
+    #   >> robot.place(0, 0, "SOUTH")
+    #   => 2
+    #   >> robot.current_direction
+    #   => "SOUTH"
+    #
+    # Returns:
+    #   (String) - An array containing the X and Y coordinates of the robot's current position.
+    def current_direction
+      return nil unless placed?
+
+      VALID_DIRECTIONS[@direction]
+    end
+
     # Move the robot one unit forward in the current direction.
     def move
       return unless placed?

data/lib/toy_robot_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toy_robot_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Paulo H Sacramento
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba