nasa_rovers 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bde9963aec22cee7e62520420adf36418152e750fcae772b460ffb66f366a0b5
+  data.tar.gz: ceb0fd9641e1d3fd48b8eff336033281bbc1681077894827439fbc4e46ee29f4
+SHA512:
+  metadata.gz: 112a7da8ac2e1a06b0db42aa6af6188ab4b2bc58b4ea55bd14f9aad5bb4199c730462644304ce87c36a24685d1be6e08f1848587c520ccace279bd95b1395bb7
+  data.tar.gz: 73687811157685f0bf75e0c78575c304779b6f369a348706fe5893d329d7ec0d4c673eeb14eddeae3368d4eb31e2baee70b0b92c7f1f8a0cf4c814613f0ec32f

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.4.0
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nasa_rovers.gemspec
+gemspec

data/OBJECTIVES.md

@@ -0,0 +1,41 @@
+## Table of Contents
+* [Summary](#summary)
+
+## Summary
+A squad of robotic rovers are to be landed by NASA on a plateau on Mars. This plateau, which is curiously rectangular, must be navigated by the rovers so that their on-board cameras can get a complete view of the surrounding terrain to send back to Earth.  
+A rover's position and location is represented by a combination of x and y coordinates and a letter representing one of the four cardinal compass points. The plateau is divided up into a grid to simplify navigation.  
+
+An example position might be `0, 0, N`, which means the rover is in the bottom left corner and facing North.
+
+In order to control a rover, NASA sends a simple string of letters. The possible letters are `L`, `R` and `M`. `L` and `R` makes the rover spin 90 degrees left or right respectively, without moving from its current spot. `M` means move forward one grid point, and maintain the same heading.
+
+Assume that the square directly North from (x, y) is (x, y+1).
+
+### Input
+The first line of input is the upper-right coordinates of the plateau, the lower-left coordinates are assumed to be `0,0`.
+
+The rest of the input is information pertaining to the rovers that have been deployed. Each rover has two lines of input. The first line gives the rover's position, and the second line is a series of instructions telling the rover how to explore the plateau.
+
+The position is made up of two integers and a letter separated by spaces, corresponding to the x and y co-ordinates and the rover's orientation.
+
+Each rover will be finished sequentially, which means that the second rover won't start to move until the first one has finished moving.
+
+### Output
+The output for each rover should be its final co-ordinates and heading.
+
+### Input and Output
+
+#### Test Input
+```
+5 5
+1 2 N
+LMLMLMLMM
+3 3 E
+MMRMMRMRRM
+```
+
+#### Expected Output
+```
+1 3 N
+5 1 E
+```

data/README.md

@@ -0,0 +1,81 @@
+## Table of Contents
+* [Scope](#scope)
+* [Design](#design)
+  * [Footprint](#footprint)
+  * [SRP](#srp)
+  * [Test](#test)
+* [Usage](#usage)
+  * [Library](#library)
+  * [CLI](#cli)
+
+## Scope
+This gem is the Ruby implementation of the for the [NASA rovers](https://github.com/costajob/nasa_rovers/blob/master/OBJECTIVES.md) code kata.
+
+## Design
+
+### Footprint
+The code keeps a minimal footprint, relying on standard library only and reducing it to its minimum (i.e. `optparse` was overkill for the simple CLI interface).
+
+### SRP
+The code design follows the single responsibility principle by using a dedicated class for any specific task.  
+
+### Test
+The code is covered by fast, isolated unit testing, implemented by `minitest` spec (a standard, faster and as same as powerful alternative to `rspec`).  
+To run tests just execute rake:
+
+```shell
+bundle exec rake
+Run options: --seed 4303
+
+# Running:
+
+.....................
+
+Finished in 0.004475s, 4692.7374 runs/s, 7374.3017 assertions/s.
+```
+
+## Usage
+
+### Library
+Just execute the `bundle console` command and pass an array of instructions to the `Rover.instruct` method:
+
+```ruby
+nasa_data = ["5 5", "1 2 N", "LMLMLMLMM", "3 3 E", "MMRMMRMRRM"]
+puts NasaRovers::Rover.instruct(nasa_data)
+#1 3 N
+#5 1 E
+#=> nil
+```
+
+### CLI
+The library provides a CLI interface via the `nasa_rovers` command from the terminal.  
+
+#### Help
+You can print CLI help by:
+
+```shell
+$ ./bin/nasa_rovers -h
+Usage: nasa_rovers ./nasa_data.txt
+    -h --help               Print this help
+    <path-to-file>          Instruct rovers with NASA data
+```
+
+#### Input
+The program accepts as input a file containing the NASA data (for more info check ``SUMMARY.md`)
+
+```txt
+# ./nasa_data.txt
+5 5
+1 2 N
+LMLMLMLMM
+3 3 E
+MMRMMRMRRM
+```
+
+Just pass the file path to the program:
+
+```shell
+$ ./bin/nasa_rovers ./nasa_data.txt
+1 3 N
+5 1 E
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nasa_rovers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/nasa_rovers

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "nasa_rovers"
+
+input = ARGV.fetch(0, "")
+NasaRovers::CLI.new(input).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nasa_rovers.rb

@@ -0,0 +1,11 @@
+require "nasa_rovers/cli"
+require "nasa_rovers/coord"
+require "nasa_rovers/plateau"
+require "nasa_rovers/position"
+require "nasa_rovers/rover"
+
+module NasaRovers
+  extend self
+
+  CARDINALS = %w[N E S W]
+end

data/lib/nasa_rovers/cli.rb

@@ -0,0 +1,41 @@
+require "nasa_rovers/rover"
+
+module NasaRovers
+  class CLI
+    HELP_FLAGS = %w[-h --help]
+    COL_WIDTH = 23
+
+    def initialize(input, pipe=STDOUT, rover_class=Rover)
+      @input = input
+      @pipe = pipe
+      @rover = rover_class
+    end
+
+    def call
+      @pipe.puts output
+    end
+
+    private def output
+      return help if help?
+      return unless file?
+      data = File.readlines(@input).map(&:strip)
+      @rover.instruct(data)
+    end
+
+    private def file?
+      File.file?(File.expand_path(@input))
+    end
+
+    private def help?
+      HELP_FLAGS.include?(@input)
+    end
+
+    private def help
+      [].tap do |h|
+        h << %q{Usage: nasa_rovers ~/nasa_data.txt}
+        h << "    %-#{COL_WIDTH}s Print this help" % "-h --help"
+        h << "    %-#{COL_WIDTH}s Instruct rovers with NASA data" % "<path-to-file>"
+      end
+    end
+  end
+end

data/lib/nasa_rovers/coord.rb

@@ -0,0 +1,33 @@
+module NasaRovers
+  class Coord
+    def self.origin
+      @origin ||= new(0, 0)
+    end
+
+    def self.factory(data)
+      new(*data.split(" "))
+    end
+
+    attr_accessor :x, :y
+
+    def initialize(x, y)
+      @x, @y = x.to_i, y.to_i
+    end
+
+    def to_s
+      "#{x} #{y}"
+    end
+
+    def >=(other)
+      x >= other.x && y >= other.y
+    end
+
+    def <=(other)
+      x <= other.x && y <= other.y
+    end
+
+    def ==(other)
+      x == other.x && y == other.y
+    end
+  end
+end

data/lib/nasa_rovers/plateau.rb

@@ -0,0 +1,24 @@
+require "nasa_rovers/coord"
+
+module NasaRovers
+  class Plateau
+    def self.factory(data, coord_class=Coord)
+      new(*data.split(" "), coord_class)
+    end
+
+    attr_reader :bot_lt, :top_rt
+
+    def initialize(x, y, coord_class=Coord)
+      @bot_lt = coord_class.origin
+      @top_rt = coord_class.new(x, y)
+    end
+
+    def include?(coord)
+      coord >= bot_lt && coord <= top_rt
+    end
+
+    def to_s
+      "#{bot_lt} - #{top_rt}"
+    end
+  end
+end

data/lib/nasa_rovers/position.rb

@@ -0,0 +1,32 @@
+require "nasa_rovers/coord"
+
+module NasaRovers
+  class Position
+    class CardinalError < StandardError; end
+
+    def self.factory(data)
+      new(*data.split(" "))
+    end
+
+    attr_reader :coord
+    attr_accessor :cardinal
+
+    def initialize(x, y, cardinal, coord_class=Coord)
+      @coord = coord_class.new(x, y)
+      @cardinal = check(cardinal)
+    end
+
+    def to_s
+      "#{coord} #{cardinal}"
+    end
+
+    def ==(other)
+      coord == other.coord && cardinal == other.cardinal
+    end
+
+    private def check(cardinal)
+      return cardinal if CARDINALS.include?(cardinal)
+      fail CardinalError.new("#{cardinal} is not a valid cardinal point")
+    end
+  end
+end

data/lib/nasa_rovers/rover.rb

@@ -0,0 +1,84 @@
+require "forwardable"
+require "nasa_rovers/plateau"
+require "nasa_rovers/position"
+
+module NasaRovers
+  class Rover
+    extend Forwardable
+
+    MAPPING = {
+      M: :move,
+      L: :left,
+      R: :right
+    }
+
+    INST_ROWS = 2
+
+    def self.factory(data, plateau, position_class=Position)
+      position = position_class.factory(data)
+      new(position, plateau)
+    end
+
+    def self.instruct(data, plateau_class=Plateau)
+      plateau = plateau_class.factory(data.shift)
+      data.each_slice(INST_ROWS).reduce([]) do |rovers, rows|
+        position, instructions = rows
+        rover = factory(position, plateau)
+        rover.call(instructions)
+        rovers << rover
+      end
+    end
+
+    def_delegators :@position, :cardinal, :coord, :to_s
+
+    attr_reader :plateau, :position
+
+    def initialize(position, plateau)
+      @position = position
+      @plateau = plateau
+    end
+
+    def call(data)
+      instructions(data).each do |inst|
+        action = MAPPING.fetch(inst) { :stay }
+        send(action)
+      end
+    end
+
+    private def instructions(data)
+      data.split("").map(&:strip).map(&:to_sym)
+    end
+
+    private def left
+      position.cardinal = CARDINALS[cardinal_idx-1]
+    end
+
+    private def right
+      idx = CARDINALS[cardinal_idx+1] ? cardinal_idx+1 : 0
+      position.cardinal = CARDINALS[idx]
+    end
+
+    private def cardinal_idx
+      CARDINALS.index(cardinal)
+    end
+
+    private def move
+      case cardinal
+      when "N"
+        coord.y += 1
+        coord.y = plateau.top_rt.y unless plateau.include?(coord)
+      when "E"
+        coord.x += 1
+        coord.x = plateau.top_rt.x unless plateau.include?(coord)
+      when "S"
+        coord.y -= 1
+        coord.y = plateau.bot_lt.y unless plateau.include?(coord)
+      when "W"
+        coord.x -= 1
+        coord.x = plateau.bot_lt.x unless plateau.include?(coord)
+      end
+    end
+
+    private def stay; end
+  end
+end

data/lib/nasa_rovers/version.rb

@@ -0,0 +1,3 @@
+module NasaRovers
+  VERSION = "1.0.1"
+end

data/nasa_data.txt

@@ -0,0 +1,5 @@
+5 5
+1 2 N
+LMLMLMLMM
+3 3 E
+MMRMMRMRRM

data/nasa_rovers.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nasa_rovers/version"
+
+Gem::Specification.new do |s|
+  s.name = "nasa_rovers"
+  s.version = NasaRovers::VERSION
+  s.authors = ["costajob"]
+  s.email = ["costajob@gmail.com"]
+  s.summary = "The Ruby implementation of the NASA rovers code kata."
+  s.homepage = "https://github.com/costajob/nasa_rovers"
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir = "bin"
+  s.executables << "nasa_rovers" 
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 2.3.1"
+  s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "rake", "~> 12.3"
+  s.add_development_dependency "minitest", "~> 5.1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: nasa_rovers
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- costajob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: 
+email:
+- costajob@gmail.com
+executables:
+- nasa_rovers
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- OBJECTIVES.md
+- README.md
+- Rakefile
+- bin/console
+- bin/nasa_rovers
+- bin/setup
+- lib/nasa_rovers.rb
+- lib/nasa_rovers/cli.rb
+- lib/nasa_rovers/coord.rb
+- lib/nasa_rovers/plateau.rb
+- lib/nasa_rovers/position.rb
+- lib/nasa_rovers/rover.rb
+- lib/nasa_rovers/version.rb
+- nasa_data.txt
+- nasa_rovers.gemspec
+homepage: https://github.com/costajob/nasa_rovers
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: The Ruby implementation of the NASA rovers code kata.
+test_files: []