Coding challenge

.gitignore

@@ -0,0 +1,3 @@
+# Ignore RSpec slow examples file
+spec/examples.txt
+/.byebug_history

.rspec

@@ -0,0 +1 @@
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+      - 'coffee_place'

.ruby-version

@@ -0,0 +1 @@
+ruby-3.0

Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# gem "rails"
+group :development, :test do
+  gem 'byebug', '~> 11.1'
+  gem 'rspec', '~> 3.10'
+  gem 'rubocop', '~> 1.20', require: false
+end

Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  rspec (~> 3.10)
+  rubocop (~> 1.20)
+
+BUNDLED WITH
+   2.2.25

LICENSE.md

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+====================
+
+* Copyright © 2021 Spataru Madalin Daniel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme.md

@@ -1,4 +1,71 @@
-## Overview
+## Copyright notice
+
+While the code itself is MIT licensed, the coding challenge itself, and its description,
+included in this `Readme.md` file belongs to Agile Freaks et al.
+
+
+## Coffee Place 
+
+This is an attempt at solving the closest coffee shop coding challenge. 
+
+All good software starts with making flawed assumptions.  
+
+To make things easier on ourselves, we will assume that the Earth is flat.  
+We all know this to be true - all of those satellite pictures are hoaxes!  
+
+Furthermore, walking over the edge of the Earth teleports you to the opposing  
+side - like in Snake, or other old school video games.
+
+This only works for the "left-right" sides, as crossing the 180 meridian takes  
+you to the other hemisphere. This does **not** work for the "up-down" sides,  
+as we don't have a good way of teleporting from the North Pole to the South Pole yet.
+
+```
+
+                        ↑
+                        Oy
+   -180_______-90_______|________90_______180     ____  90 latitude
+     |                  |                 |
+     |                  |                 |
+     |                  |                 |
+     |------------------0-----------------|-Ox->  ----   0 latitude
+     |                  |                 |
+     |                  |                 |
+     |                  |                 |
+     |__________________|_________________|       ____ -90 latitude
+
+
+```
+
+
+This project will use the Ruby programming languge to implement the CLI application.
+
+Let's do this!
+
+## Setup instructions
+
+This project uses Ruby 3.0.
+
+Setup steps:
+    - clone repo
+    - make sure you have Ruby 3.0 installed
+      using `rvm` or `chruby` will switch Ruby to the right version
+    - `gem install bundler`     # Make sure bundler is installed for Ruby 3.0
+    - `bundle install`          # Install dependencies
+    - `bundle exec rspec`       # Run tests
+    - `bundle exec rubocop`     # Delight in code style guide nagging :P
+
+
+## How to run the program:
+```
+# Using local file
+./coffee_place 47.6 -122.4 coffee_shops.csv
+
+# Using remote file
+./coffee_place 47.6 -122.4 https://raw.githubusercontent.com/Agilefreaks/test_oop/master/coffee_shops.csv
+```
+
+## Coding challenge Overview
 
 You have been hired by a company that builds a mobile app for coffee addicts.  You are 
 responsible for taking the user’s location and returning a list of the three closest coffee shops.

coffee_place

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+
+require_relative './lib/coffee_place/cli.rb'
+
+cli = CoffeePlace::CLI.new
+cli.run(ARGV)

lib/coffee_place.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CoffeePlace
+  VERSION = '0.1'
+  BANNER = 'Usage: ./coffee_place <user x coordinate> <user y coordinate> <shop data url or file>'
+end

lib/coffee_place/cli.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative '../coffee_place'
+require_relative './location'
+require_relative './cli_parser'
+require_relative './importer'
+require_relative './search'
+
+module CoffeePlace
+  # Parses and runs CLI application using supplied args.
+  class CLI
+    attr_accessor :cli_opts, :parsed_args
+
+    def initialize(parser: CLIParser.new,
+                   importer: Importer.new)
+      @parser = parser
+      @importer = importer
+    end
+
+    def run(args)
+      cli_opts = parse_cli_options!(args)
+
+      show_help_and_exit! if cli_opts.print_help?
+      show_version_and_exit! if cli_opts.show_version?
+
+      user_location = validate_user_location!(cli_opts)
+      locations = import_locations_from!(cli_opts)
+
+      search = Search.new(locations)
+      closest_locations = search.find_closest_to(user_location, cli_opts.num_results)
+
+      display_closest_locations(closest_locations)
+    end
+
+    private
+
+    def parse_cli_options!(args)
+      result = @parser.parse(args)
+      show_help_and_exit!(exit_status: 1) unless result.success?
+
+      cli_opts = result.value
+
+      # We must have [lat, lon, filename] as args
+      unless cli_opts.num_args == 3
+        puts 'Incorrect number of CLI arguments passed in'
+        show_help_and_exit!(exit_status: 1)
+      end
+
+      cli_opts
+    end
+
+    def validate_user_location!(cli_opts)
+      lat, lon = cli_opts.remaining
+      location = Location.new(lat: lat, lon: lon, name: 'Current user')
+
+      if location.valid?
+        location
+      else
+        print_errors_and_exit!(location.errors)
+      end
+    end
+
+    def import_locations_from!(cli_opts)
+      source_name = cli_opts.source_name
+      locations_result = @importer.import_from(source_name)
+
+      if locations_result.success?
+        locations_result.value
+      else
+        puts "Failed to import locations from: #{source_name.inspect}"
+        print_errors_and_exit!(locations_result.error)
+      end
+    end
+
+    def display_closest_locations(locations)
+      locations.each do |distance, location|
+        puts "#{location.name},#{distance.round(4)}"
+      end
+    end
+
+    def show_help_and_exit!(exit_status: 0)
+      @parser.show_help
+      exit exit_status
+    end
+
+    def show_version_and_exit!(exit_status: 0)
+      puts CoffeePlace::VERSION
+      exit exit_status
+    end
+
+    def print_errors_and_exit!(errors)
+      Array(errors).each do |error|
+        puts error
+      end
+
+      exit 1
+    end
+  end
+end

lib/coffee_place/cli_options.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CoffeePlace
+  # Keeps parsed CLI options, also defining defaults.
+  class CLIOptions
+    attr_accessor :version, :help, :remaining, :num_results
+
+    def initialize(version: false, help: false, remaining: [])
+      @version = version
+      @help = help
+      @remaining = remaining
+    end
+
+    def show_version?
+      @version
+    end
+
+    def print_help?
+      @help
+    end
+
+    def source_name
+      @remaining.last
+    end
+
+    def <<(arg_value)
+      @remaining << arg_value
+    end
+
+    # Counts free standing CLI arguments, not taking flags into account
+    def num_args
+      @remaining.size
+    end
+  end
+end

lib/coffee_place/cli_parser.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../coffee_place'
+require_relative './result'
+require_relative './cli_options'
+
+module CoffeePlace
+  # Parses CLI arguments into a `CLIOptions` instance.
+  class CLIParser
+    attr_accessor :cli_opts, :parsed_args
+
+    def parse(args)
+      # Make sure we are not modifying `args` directly
+      args = args.clone
+
+      @cli_opts = CLIOptions.new
+      @opt_parser = build_args_parser
+      @parsed_args = extract_free_standing_arguments(args)
+
+      Result.success(@cli_opts)
+    end
+
+    def show_help
+      puts @opt_parser
+    end
+
+    private
+
+    # Since we are declaratively defining independent flags, method length isn't a concern
+    #
+    # rubocop:disable Metrics/MethodLength
+    def build_args_parser
+      OptionParser.new do |opts|
+        opts.banner = CoffeePlace::BANNER
+
+        opts.on('-h', '--help', 'Print this help message') do
+          @cli_opts.help = true
+        end
+
+        opts.on('-v', '--version', 'Print version and exit') do
+          @cli_opts.version = true
+        end
+
+        opts.on('-n[NUM]', '--num=[NUM]', 'Number of search results to return - default is 3') do |num|
+          @cli_opts.num_results = num.to_i
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Sadly, ruby's OptParser does not like arguments that start with a minus sign,
+    # as it interprets them as CLI command switches, e.g -122.4 raises OptionParser::InvalidOption
+    #
+    # This method catches `InvalidOption`, and gathers arguments that `optparser` can't parse.
+    #
+    # https://stackoverflow.com/questions/3642331/can-optionparser-skip-unknown-options-to-be-processed-later-in-a-ruby-program
+    def extract_free_standing_arguments(args)
+      @opt_parser.order!(args) do |unrecognized_opt|
+        @cli_opts << unrecognized_opt
+      end
+    rescue OptionParser::InvalidOption => e
+      # Push back unrecognized argument onto args so we can shift it afterwards
+      e.recover(args)
+      @cli_opts << args.shift
+
+      retry
+    end
+  end
+end