robojora 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49bb8a26a341996273ea81d944a2de3f60c61c4958bb61cc4b8a66524021afcf
-  data.tar.gz: 8bb791fc706555bae991368918f7ebb85e9750a7da2da9836afd9b8c97e2c9d4
+  metadata.gz: b72ba8db6436c7677b7600cb6fc1fc24d81e75599bbf44524fdcf325e72ee2d5
+  data.tar.gz: 833d8299767fbbab25b5fbe62ca0f345ded2da13de99b1fca65692b3b1b6ecfe
 SHA512:
-  metadata.gz: 1defbf0a9b6f16d7b104bcf4b5a72c14a8eb1c4effd1eefe0f3407380dfef5f1ca1a752a6f071d93416ef47ccab2608bbdaaf15c8c9fc63d4eafca7fae62f9aa
-  data.tar.gz: 571930d287b3d186adc0474671ef5f68fe6e4bd04eccacf1aeadcdcba1cafec71100f9efe650f4cfd717a240a97d73a44acf78b827729b448498dc6bf3dbd1c1
+  metadata.gz: aa8faecc15c1ae3d63fd2c457ec14d261187681b042b253eb3a4fd7cc10eaa72f9e73853c863a947d574cd15515624f48d125ef304a7126e28c8826377ce92fc
+  data.tar.gz: 89760a6fe8ec19fe75ac08ea29eb6669ce3538882556e58d35f0aabb054f8108fa948e283d806990cbae4227922c897fdf87d67213fe10b6c91ed476f8fc1c16

data/Gemfile.lock

@@ -6,12 +6,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
     diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -32,7 +27,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  pry (~> 0.12.2)
   rake (~> 10.0)
   robojora!
   rspec (~> 3.0)

data/README.md

@@ -1,12 +1,24 @@
+![robojora-robot](https://github.com/enriquesalceda/robojora/blob/master/smaller_robot.png)
+
 # Robojora
+[![Build Status](https://travis-ci.com/enriquesalceda/robojora.svg?branch=master)](https://travis-ci.com/enriquesalceda/robojora)
 
-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/robojora`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is Enrique's Jora robot challenge. I have created a gem called `Robojora`
+that contains:
 
-TODO: Delete this and the text above, and describe your gem
+- The logic required by the challenge.
+- Automated testing.
+- CI integration with Travis.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If you are going to test locally, I recommend you to:
+
+```shell
+$ gem install robojora
+```
+
+Or, if you want to add this to an app:
 
 ```ruby
 gem 'robojora'
@@ -14,25 +26,57 @@ gem 'robojora'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install robojora
+Let's say you ran `gem install robojora`, now you can:
 
-## Usage
+* Go to pry
 
-TODO: Write usage instructions here
+```shell
+$ pry
+```
 
-## Development
+* Require `robojora`
+```shell
+> require 'robojora'
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+From here you can start testing the code. First of all you have to build a board
+like this:
 
-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).
+```ruby
+full_board = Robojora::Board.new.build
+```
 
-## Contributing
+Then, create a robot like this:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/robojora.
+```ruby
+robot = Robojora::Robot.new('tars')
+```
+
+Now, tars can start playing a board like this:
+
+```ruby
+robot.play_board(full_board)
+```
+
+From here you can start placing the robot like this:
+
+```ruby
+robot.place(3, 3, 'north')
+```
+
+And then, you can continue rotating, moving, and reporting the report!
+
+```ruby
+robot.left
+robot.move
+robot.report
+```
 
 ## License
 

data/lib/robojora/board.rb

@@ -1,13 +1,8 @@
-# frozen_string_literal: true
-
 module Robojora
   class Board
-    MINIMUM_AXIS_VALUE = 0
-    MAXIMUM_AXIS_VALUE = 4
-
     def initialize
-      @minimum_axis_value = MINIMUM_AXIS_VALUE
-      @maximum_axis_value = MAXIMUM_AXIS_VALUE
+      @minimum_axis_value = Robojora::Settings.minimum_axis_value
+      @maximum_axis_value = Robojora::Settings.maximum_axis_value
     end
 
     def build

data/lib/robojora/border_classifier.rb

@@ -1,7 +1,5 @@
 module Robojora
   class BorderClassifier
-    MINIMUM_AXIS_VALUE = 0
-    MAXIMUM_AXIS_VALUE = 4
 
     attr_reader :borders, :coordinates
 
@@ -21,19 +19,19 @@ module Robojora
     private
 
     def assign_to_north_border_if_north_coordinate
-      borders << 'north' if coordinates.last == MAXIMUM_AXIS_VALUE
+      borders << Robojora::Settings.north if coordinates.last == Robojora::Settings.maximum_axis_value
     end
 
     def assign_to_west_border_if_west_coordinate
-      borders << 'west' if coordinates.first == MINIMUM_AXIS_VALUE
+      borders << Robojora::Settings.west  if coordinates.first == Robojora::Settings.minimum_axis_value
     end
 
     def assign_to_south_border_if_south_coordinate
-      borders << 'south' if coordinates.last == MINIMUM_AXIS_VALUE
+      borders << Robojora::Settings.south if coordinates.last == Robojora::Settings.minimum_axis_value
     end
 
     def assign_to_east_border_if_east_coordinate
-      borders << 'east' if coordinates.first == MAXIMUM_AXIS_VALUE
+      borders << Robojora::Settings.east if coordinates.first == Robojora::Settings.maximum_axis_value
     end
   end
 end

data/lib/robojora/robot.rb

@@ -1,7 +1,7 @@
-require 'pry'
 module Robojora
   class Robot
     NOT_IN_BOARD = 'Robot is not on the board'.freeze
+    private_constant :NOT_IN_BOARD
 
     attr_reader :board, :name
     attr_accessor :facing
@@ -16,6 +16,9 @@ module Robojora
     end
 
     def place(x_coordinate, y_coordinate, facing)
+      raise ArgumentError, 'x_coordinate and y_coordinate must be integers' unless x_coordinate.is_a?(Integer) && y_coordinate.is_a?(Integer)
+      raise CardinalDirectionError, 'facing should be a cardinal point string' unless Robojora::Settings.cardinal_points.include?(facing) || !select_square_by_name.nil?
+
       square = select_square_by_coordinates(x_coordinate, y_coordinate)
       robot_removing_and_placing(facing, square) if square
     end
@@ -33,7 +36,7 @@ module Robojora
     end
 
     def move
-      raise Robojora::RobotNotOnBoardError if select_square_by_name.nil?
+      raise Robojora::RobotNotOnBoardError if not_movable?
 
       mover.move
     end
@@ -50,6 +53,7 @@ module Robojora
       remove_robot_from_current_square
       self.facing ||= facing
       square.presence = name
+      true
     end
 
     private
@@ -70,5 +74,9 @@ module Robojora
     def mover
       Robojora::Movers.const_get(facing.capitalize).new(self)
     end
+
+    def not_movable?
+      select_square_by_name.nil? || select_square_by_name.borders.include?(facing)
+    end
   end
 end

data/lib/robojora/rotator.rb

@@ -1,7 +1,9 @@
 module Robojora
   class Rotator
-    CARDINAL_POINTS_FOR_LEFT = %w[north west south east north].freeze
-    CARDINAL_POINTS_FOR_RIGHT = CARDINAL_POINTS_FOR_LEFT.reverse.freeze
+    LEFT = (Robojora::Settings.cardinal_points + [Robojora::Settings.north]).freeze
+    RIGHT = LEFT.reverse.freeze
+
+    private_constant :LEFT, :RIGHT
 
     attr_reader :initial_direction
 
@@ -10,21 +12,21 @@ module Robojora
     end
 
     def left
-      CARDINAL_POINTS_FOR_LEFT.fetch(left_desired_cardinal_direction_index)
+      LEFT.fetch(left_desired_cardinal_direction_index)
     end
 
     def right
-      CARDINAL_POINTS_FOR_RIGHT.fetch(right_desired_cardinal_direction_index)
+      RIGHT.fetch(right_desired_cardinal_direction_index)
     end
 
     private
 
     def left_desired_cardinal_direction_index
-      CARDINAL_POINTS_FOR_LEFT.index(initial_direction) + 1
+      LEFT.index(initial_direction) + 1
     end
 
     def right_desired_cardinal_direction_index
-      CARDINAL_POINTS_FOR_RIGHT.index(initial_direction) + 1
+      RIGHT.index(initial_direction) + 1
     end
   end
 end

data/lib/robojora/settings.rb

@@ -0,0 +1,45 @@
+module Robojora
+  class Settings
+    MINIMUM_AXIS_VALUE = 0
+    MAXIMUM_AXIS_VALUE = 4
+
+    NORTH = 'north'.freeze
+    WEST = 'west'.freeze
+    SOUTH = 'south'.freeze
+    EAST = 'east'.freeze
+
+    CARDINAL_POINTS = [NORTH, WEST, SOUTH, EAST].freeze
+
+
+    private_constant :NORTH, :WEST, :SOUTH, :EAST, :CARDINAL_POINTS,
+                     :MINIMUM_AXIS_VALUE, :MAXIMUM_AXIS_VALUE
+
+    def self.minimum_axis_value
+      MINIMUM_AXIS_VALUE
+    end
+
+    def self.maximum_axis_value
+      MAXIMUM_AXIS_VALUE
+    end
+
+    def self.cardinal_points
+      CARDINAL_POINTS
+    end
+
+    def self.north
+      NORTH
+    end
+
+    def self.west
+      WEST
+    end
+
+    def self.south
+      SOUTH
+    end
+
+    def self.east
+      EAST
+    end
+  end
+end

data/lib/robojora/version.rb

@@ -1,3 +1,3 @@
 module Robojora
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/robojora.rb

@@ -1,10 +1,10 @@
 require 'robojora/version'
+require 'robojora/settings'
 require 'robojora/board'
 require 'robojora/border_classifier'
 require 'robojora/square'
 require 'robojora/robot'
 require 'robojora/rotator'
-require 'robojora/cardinal_directions'
 require 'robojora/movers/mover'
 require 'robojora/movers/north'
 require 'robojora/movers/south'
@@ -13,4 +13,5 @@ require 'robojora/movers/east'
 
 module Robojora
   class RobotNotOnBoardError < StandardError; end
+  class CardinalDirectionError < StandardError; end
 end

data/robojora.gemspec

@@ -28,6 +28,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry', '~> 0.12.2'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: robojora
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Enrique Salceda
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +71,6 @@ files:
 - lib/robojora.rb
 - lib/robojora/board.rb
 - lib/robojora/border_classifier.rb
-- lib/robojora/cardinal_directions.rb
 - lib/robojora/movers/east.rb
 - lib/robojora/movers/mover.rb
 - lib/robojora/movers/north.rb
@@ -93,9 +78,11 @@ files:
 - lib/robojora/movers/west.rb
 - lib/robojora/robot.rb
 - lib/robojora/rotator.rb
+- lib/robojora/settings.rb
 - lib/robojora/square.rb
 - lib/robojora/version.rb
 - robojora.gemspec
+- smaller_robot.png
 homepage: https://github.com/enriquesalceda/robojora
 licenses:
 - MIT

data/lib/robojora/cardinal_directions.rb

@@ -1,15 +0,0 @@
-module Robojora
-  class CardinalDirections
-    CARDINAL_POINTS = %w[north west south east].freeze
-
-    def self.all
-      CARDINAL_POINTS
-    end
-
-    Robojora::CardinalDirections::CARDINAL_POINTS.each do |cardinal_point|
-      define_singleton_method(:"#{cardinal_point}") do
-        "#{state.upcase}"
-      end
-    end
-  end
-end