roversim_abrophy 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139cf4733fa5c2d21d2a906e687233e8063f052b8fb77798cf0b7ba4f992f02f
-  data.tar.gz: 65e52dba05cc0bccd5a24479e07f0f6ff94b9afc0b7edcb54917917017814676
+  metadata.gz: d2cc74a57ccc874e8adb7b70b9cafb96abc367dc6ae977c53856f5d8376ea1ed
+  data.tar.gz: b57e32374a0db08fd04258b7ab28339927157d8af79f4e642a42c53cd9a7dede
 SHA512:
-  metadata.gz: c52bad1e3526f0eb415ba02cc6f05783327d5110297a4589eaa33f82859adfa13495d76a7d11048a2f0153dcf58244492c82d17b68024dcdd33c01e973578cfa
-  data.tar.gz: eeccf05bbc946b996c677209054b7e350c3ed0d123d3ed7af91da30f93cc3883c38015c704e0e2dd9438ece8cb38abe55ff90790818c532a3ed3f8a47ffd4730
+  metadata.gz: c89943f0af11e2afedb5670f84a048115b1e00ae674dd9be480a1eba3935279d2b107099b771438e64797f6674c93148201c42999903588f421d437ac63e6e20
+  data.tar.gz: bba2621eacacb7dc8619b8603c7d5ca44edf87f30d8f00c64659bb29cc6a28d4e8a2c2dd2594093c5bf5d80c9e529081ca1d998afbcff876d7a076cf33c007a9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roversim_abrophy (0.1.0)
+    roversim_abrophy (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,43 +1,113 @@
 # RoversimAbrophy
 
-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/roversim_abrophy`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem serves as a solution to an OOP problem where it is required to
+build out a class heirarchy to simulate and predict the movement of a
+rover on mars
 
-TODO: Delete this and the text above, and describe your gem
+## Installation and Usage
 
-## Installation
+There are three ways to install and use the gem:
 
-Add this line to your application's Gemfile:
+### clone from github
+
+```
+git clone https://github.com/abrophy/roversim.git
+```
+
+after cloning the repo onto your computer, enter the directory and run:
+```
+bundle install
+```
+To install the dev dependencies.
+
+A sample input file has been provided with the repo as
+`roversim_input.example`.
+
+You can then use rake to process this sample input file:
+
+```
+rake run roversim_input.example
+```
+
+simply replace the sample input filename with your own if desired.
+
+### install gem for command line usage
+
+The gem is hosted on rubygems so it can be installed to your environment
+through a simple gem install:
+
+```
+gem install roversim_abrophy
+```
+
+to process an input file call from command line via
+
+```
+roversim abrophy input_file_name
+```
+
+### requiring it into an existing ruby project
+
+Add the gem to your gemfile:
+
+```ruby
+gem 'roversim_abrophy', '1.2.0'
+```
+
+it can then be required and used to process inputs already split into an
+array:
 
 ```ruby
-gem 'roversim_abrophy'
+require 'roversim_abrophy'
+
+input_array = [
+  '88',
+  '12 E',
+  'MMLMRMMRRMML'
+]
+
+RoversimAbrophy.process(input_array)
+#=>'3 3 S'
 ```
 
-And then execute:
+## Testing
 
-    $ bundle
+After cloning the repo and installing dev dependencies with bundle, you can run tests against the codebase through:
 
-Or install it yourself as:
+```
+rake test
+```
 
-    $ gem install roversim_abrophy
+## Notes on Design and testing
 
-## Usage
+While working out the design for these classes the most interesting
+relationship I found was between the tracers and the rover class. I
+inject the rover class into the tracers when moving so that the tracers
+are responsible for knowing how to update the coordinates of the rover.
 
-TODO: Write usage instructions here
+The Tracer class is called when performing turns and returns the correct
+new tracer class depending on the turn which also holds the correct
+movement behavior for the new direction.
 
-## Development
+Actually generating the correct tracer for the rover class on
+initialization is done with a case statement, though I know this is an
+OOP smell, given the time constraint and the class heirarchy ( there
+will likely be no new cardinal directions added anytime soon and the
+rover operates on a two dimensional grid ), I don't see anything wrong
+with the implementation.
 
-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.
+I used RSpec to cover unit and integration tests, and used rubocop to test
+code style across the project.
 
-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).
+The only complaint from rubocop I haven't dealt with is the length of
+the #process_instructions method in the controller.
 
-## Contributing
+This is due to the message parsing happening in the controller class.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/roversim_abrophy. 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.
+If the message structure or nature of the input were to change in the
+future I would implement a new message parsing class to deal with this
+issue, but for now am happy with the implementation.
 
 ## 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 RoversimAbrophy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/roversim_abrophy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -4,7 +4,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:test)
 
 task :run do
-  sh "ruby bin/roversim_abrophy.rb roversim_input"
+  sh "ruby bin/roversim_abrophy #{ARGV[1]}"
 end
 
 task default: :test

data/lib/rover.rb

@@ -2,7 +2,7 @@ require 'roversim_abrophy/version'
 
 # Rover class that stores rover position state
 class Rover
-  attr_accessor :direction, :x, :y
+  attr_accessor :x, :y
 
   def initialize(zone, position_string)
     @zone = zone

data/lib/roversim_abrophy.rb

@@ -8,8 +8,8 @@ require_relative './tracers/east'
 require_relative './tracers/south'
 require_relative './tracers/west'
 
+# Generates classes from input and returns destination
 module RoversimAbrophy
-  # Generates classes from input and returns destination
   def self.process(input_array)
     zone = Zone.new(input_array[0])
     rover = Rover.new(zone, input_array[1])

data/lib/roversim_abrophy/version.rb

@@ -1,3 +1,3 @@
 module RoversimAbrophy
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/tracers/east.rb

@@ -1,4 +1,5 @@
 module Tracers
+  # Handles Eastern travel by rover
   class East
     def turn_left
       Tracers::North.new

data/lib/tracers/north.rb

@@ -1,4 +1,5 @@
 module Tracers
+  # Handles Northern travel by rover
   class North
     def turn_left
       Tracers::West.new

data/lib/tracers/south.rb

@@ -1,4 +1,5 @@
 module Tracers
+  # Handles Southern travel by rover
   class South
     def turn_left
       Tracers::East.new

data/lib/tracers/west.rb

@@ -1,4 +1,5 @@
 module Tracers
+  # Handles Western travel by rover
   class West
     def turn_left
       Tracers::South.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roversim_abrophy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Arthur Brophy