toyrobot 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38160974bafdf9946e5e665c58b1bf00dccaf40e
-  data.tar.gz: b9a29c8e8df15252a2453517cccda9057818502c
+  metadata.gz: b082d368cf8887b0daebff1875a1729bbbe8681d
+  data.tar.gz: 0a6ea773808f34d2b0bea8514533aea97782f2cd
 SHA512:
-  metadata.gz: 05978ae19f8a401719dc7f825127c36575efe3c116bcd8ae5613aad01e74687869e8ca0f889ce79c2976bf122bd2196993f730d1479054299a734f2c86b582c7
-  data.tar.gz: d24163a31a50ad221ebf1c00ca844d9a3bf08fcbb7cdb3a9f68b27f9070f0d6378c5bc3b5aa6eac3b43dad7119eae2a8dbef28c279199e25f6c3d785af13918a
+  metadata.gz: 8de85cff36714f10481d3bfc98ec23908bf84361a91e41e4f2d2e93b091b54c41345298dcb47d750a9b9a27fad796e7db3dc91e0cf57619f4737d1a889fa25af
+  data.tar.gz: 1534b36b3916fbaa236d5cbf3484cf2e814bb1709ec505dca46cceb76a81cd240262467f0befbc20e65a162e88755b985497175e37147b2da8909b171410bce7

data/CONTRIBUTING.md

@@ -4,7 +4,7 @@ Fork, then clone the repo:
 
     git clone git@github.com:your-username/toy-robot-simulator.git
 
-Check you ruby and development dependancies versions:
+Check you ruby and development dependencies versions:
 
     $ ruby -v
 
@@ -18,7 +18,7 @@ Make your change. Add tests for your change. Make the tests pass:
 
     rake test:all
 
-Push to your fork and submit a pull request. Some things that are equal parts necesary/epic:
+Push to your fork and submit a pull request. Some things that are equal parts necessary/epic:
 
  * Write tests.
 

data/README.md

@@ -8,18 +8,18 @@ A simulation of a toy robot moving on a square tabletop.
 
 via RubyGems:
 
-    $ gem install toy_robot
+    $ gem install toyrobot
 
 
 ## Usage
 
 Start the simulator in interactive mode:
 
-    $ toy_robot
+    $ toyrobot
 
-Or pipe it a file with commands:
+Or pipe in a file with commands:
 
-    $ toy_robot < path/to/file
+    $ toyrobot < path/to/file
 
 An example file with commands:
 
@@ -89,7 +89,7 @@ Response:
 * The application does not provide any graphical output showing the movement of the toy robot.
 
 
-## Dependancies
+## Dependencies
 
     ruby version ~> 2.1.0p0
 
@@ -106,14 +106,14 @@ To learn how to install ruby visit [ruby-lang.org/en/installation/](https://www.
 
  * OSX 10.8.5, ruby 2.1.2p95
 
-Development dependancies:
+Development dependencies:
 
     rake ~> 10.3
     minitest ~> 4.7.5
 
 To install them along the gem:
 
-    $ gem install --dev toy_robot
+    $ gem install --dev toyrobot
 
 ### Compatible environments
 
@@ -121,7 +121,7 @@ To install them along the gem:
 
 * Ubuntu 12.04 x32, ruby 2.1.0p0
 
-### Incompatible enviroments
+### Incompatible environments
 
 * ruby < 2.1.0
 
@@ -139,10 +139,166 @@ To run all tests:
 
     $ rake test:all
 
+## Design
+
+The application flows in the following way:
+
+#### 1 Launch
+
+    $ toyrobot < path/to/file
+
+##### 1.1 bin/toyrobot
+
+The `toyrobot` in the command is a ruby executable in your load path. This executable contains the following lines:
+
+```ruby
+require 'toy_robot'
+ToyRobot::Application.new(ARGV).run
+```
+
+The first line requires the file `./lib/toy_robot.rb` which loads the library. The second line creates and instance of the application and passes the command-line arguments to it.
+
+##### 1.2 lib/toy_robot/application.rb
+
+The `app.run()` method reads in robot_commands from the input source (defaults to `$stdin`) and passes them to the parser. The parser returns (might) a command_like_object which is used to message the controller.
+
+```ruby
+def run(options = nil)
+  loop do
+    raw_input = input.gets
+    break unless raw_input
+    raw_input.chomp!
+    command = parser.parse(raw_input)
+    controller.send(command.msg, command.args) if command
+  end
+end
+```
+
+##### 1.2.1 lib/toy_robot/command/parser.rb
+
+`parser.parse()` delegates the job of matching robot_commands and extracting arguments to the `Command::Parser::(Place/Move/Right/Left/Report)` objects. Each will receive the robot_command and try to match it. If it can, it will build a command_like_object and return it. The `parser.parse()` method will return the command_like_object as soon as a match is found.
+
+```ruby
+def self.parse(string)
+  all.each do |parser|
+    command = parser.build_with_match(string)
+    return command if command
+  end
+  nil
+end
+```
+
+##### 1.2.2 lib/toy_robot/controller.rb
+
+The controller will receive a valid message (`place`,`move`,`left`,`right`,`report`) and delegate it to the correct object (`robot`/`view`)
+
+```ruby
+def place(*args)
+  robot.place(*args)
+end
+
+def move(*_)
+  robot.move
+end
+
+def left(*_)
+  robot.left
+end
+
+def right(*_)
+  robot.right
+end
+
+def report(*_)
+  view.report
+end
+```
+
+##### 1.2.2.1 lib/toy_robot/robot.rb
+
+This is the entry point for all robot_commands in the system. Suffice it to say that from here on, every command will interact with a combination of the following objects:
+
+```ruby
+ToyRobot::Robot
+```
+
+```ruby
+ToyRobot::Pose
+```
+
+```ruby
+ToyRobot::Board
+```
+
+##### 1.2.2.2 lib/toy_robot/view.rb
+
+This is the output point of all robot_commands. The application only displays feedback for the report command, so the code in here is very basic, and by default writes to `$stdout`.
+
+```ruby
+def report
+  output.puts format_report(robot.report)
+end
+```
+
+```ruby
+def format_report(report)
+  "#{report[:x]},#{report[:y]},#{report[:orientation].upcase}" if report
+end
+```
+
+#### 2 Exit
+
+After all the commands are read, parsed and executed, the application exits.
+
 ## Discussion
 
-This piece of software is over-engineered. Over engineering does not feel good.
+Over-engineered. On the one hand it attempts to solve a static, straight-forward problem. On the other hand it tries to demonstrate coding and object-oriented design skills. This generates tensions which I feel are incompatible and creep into the code base.
+
+Most of the files/classes/modules/methods/lines in the source code are sensible to the argument that they are overkill for the problem in question.
+
+In the end I tried to keep it simple and apply OOD, while feeling like the person to whom 'every problem seems like a nail'.
+
+### The Not So Good Parts
+
+#### Code
+
+##### `Command::Parser#parse`
+
+This method/module has too many hidden dependency to work (aka magic) and is not clear enough how you would add more parsers to it.
+
+The parser is intended to be extended by adding constants to the `Command::Parser` name space, and each constant should be an instance of the Command::Parser::Base class. This is not self evident and thus bad.
+
+On the other hand, these constants need to be require by the application, which either means including them in the `/lib/toy_robot/command/parser.rb` or having a automatic loading of files under the `lib/toy_robot` directory.
+
+##### `Pose`
+
+```ruby
+EAST = :east
+NORTH = :north
+WEST = :west
+SOUTH = :south
+```
+
+These constants seem unnecessary for a small lib and a straight-forward concept. Maybe integer would suffice and make calculations easier.
+
+```
+Pose#rotate!
+```
+
+This method takes `(degrees)` as arguments which makes sense from a physical perspective, but none in the context of this application. Input comes in the form of four strings, which are the only valid states for `@orientation`. The whole application is converting back and forth between degrees and valid orientations. This complexity is not necessary.
+
+On the flip side, converting the whole application to degrees would make `#rotate!` much simpler.
+
+#### Naming
+
+`Command::Parser::Base` is not specific, maybe `Command::Parser::BaseMatcher` would be better.
+
+#### Testing
+
+`ToyRobot::Application` is only integration tested.
+
+`bin/toyrobot` is not tested.
 
 ## Contributing
 
-View [CONTRIBUTING.md](https://github.com/matiasanaya/toy-robot-simulator/blob/master/CONTRIBUTING.md).
+View [CONTRIBUTING.md](https://github.com/matiasanaya/toy-robot-simulator/blob/master/CONTRIBUTING.md)

data/lib/toy_robot/application.rb

@@ -14,25 +14,13 @@ module ToyRobot
         raw_input = input.gets
         break unless raw_input
         raw_input.chomp!
-        debug(raw_input)
         command = parser.parse(raw_input)
-        controller.input(command) if command
+        controller.send(command.msg, command.args) if command
       end
     end
 
     private
 
     attr_reader :input, :parser, :controller
-
-    def debug(raw_input)
-      case raw_input
-      when /\AR(EPORT_DEBUG)*\z/
-        puts controller.instance_variable_get(:@robot).inspect
-      when /\AE(XIT)*\z/
-        puts 'Have a nice day, bye :)'
-        puts '...'
-        exit(false)
-      end
-    end
   end
 end

data/lib/toy_robot/board.rb

@@ -6,7 +6,7 @@ module ToyRobot
     end
 
     def valid_pose?(pose)
-      pose && (0..x_size).include?(pose.x) && (0..y_size).include?(pose.y)
+      pose && (0..x_size).include?(pose[:x]) && (0..y_size).include?(pose[:y])
     end
 
     private

data/lib/toy_robot/command/parser.rb

@@ -1,12 +1,15 @@
-require_relative 'parser/base'
 require_relative 'parser/place'
+require_relative 'parser/move'
+require_relative 'parser/right'
+require_relative 'parser/left'
+require_relative 'parser/report'
 
 module ToyRobot
   module Command
     module Parser
       def self.parse(string)
-        all.each do |matcher|
-          command = matcher.build_with_match(string)
+        all.each do |parser|
+          command = parser.build_with_match(string)
           return command if command
         end
         nil

data/lib/toy_robot/command/parser/base.rb

@@ -1,5 +1,4 @@
-require_relative '../token'
-require_relative '../base'
+require 'ostruct'
 
 module ToyRobot
   module Command
@@ -7,7 +6,7 @@ module ToyRobot
       class Base
         def initialize(args)
           @regex = args[:regex]
-          @token = args[:token]
+          @msg = args[:msg]
           @args_extractor = args[:args_extractor]
         end
 
@@ -17,7 +16,7 @@ module ToyRobot
 
         private
 
-        attr_reader :regex, :token, :args_extractor
+        attr_reader :regex, :msg, :args_extractor
 
         def match?(string)
           string =~ regex
@@ -30,29 +29,9 @@ module ToyRobot
         end
 
         def build_command(string)
-          Command::Base.new(token, extract_args(string)) if match?(string)
+          OpenStruct.new(msg: msg, args:extract_args(string)) if match?(string)
         end
       end
-
-      Move = Base.new(
-        token: Command::Token::MOVE,
-        regex: /\AMOVE\z/
-      )
-
-      Right = Base.new(
-        token: Command::Token::RIGHT,
-        regex: /\ARIGHT\z/
-      )
-
-      Left = Base.new(
-        token: Command::Token::LEFT,
-        regex: /\ALEFT\z/
-      )
-
-      Report = Base.new(
-        token: Command::Token::REPORT,
-        regex: /\AREPORT\z/
-      )
     end
   end
 end

data/lib/toy_robot/command/parser/left.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module ToyRobot
+  module Command
+    module Parser
+      Left = Base.new(
+        msg: :left,
+        regex: /\ALEFT\z/
+      )
+    end
+  end
+end

data/lib/toy_robot/command/parser/move.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module ToyRobot
+  module Command
+    module Parser
+      Move = Base.new(
+        msg: :move,
+        regex: /\AMOVE\z/
+      )
+    end
+  end
+end

data/lib/toy_robot/command/parser/place.rb

@@ -1,5 +1,4 @@
 require_relative 'base'
-require_relative '../../pose'
 
 module ToyRobot
   module Command
@@ -20,15 +19,15 @@ module ToyRobot
       place_args_extractor = lambda do |raw_command|
         x, y, f = raw_command.split.pop.split(',')
 
-        Pose.new(
+        {
           x: x.to_i,
           y: y.to_i,
           orientation: constantize_orientation.call(f)
-        )
+        }
       end
 
       Place = Base.new(
-        token: Command::Token::PLACE,
+        msg: :place,
         regex: /\APLACE \d+,\d+,(NORTH|SOUTH|EAST|WEST)\z/,
         args_extractor: place_args_extractor
       )

data/lib/toy_robot/command/parser/report.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module ToyRobot
+  module Command
+    module Parser
+      Report = Base.new(
+        msg: :report,
+        regex: /\AREPORT\z/
+      )
+    end
+  end
+end

data/lib/toy_robot/command/parser/right.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module ToyRobot
+  module Command
+    module Parser
+      Right = Base.new(
+        msg: :right,
+        regex: /\ARIGHT\z/
+      )
+    end
+  end
+end