coding_challenge 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b402c49ac44e0b69892c35722a391481078caba6dea4b116b830d98716de84c8
-  data.tar.gz: 19fc88c46f3c15a813004a82b1ff63d42ce72bfd25627f1fb5e9d42be3654037
+  metadata.gz: bfa7e08afbb3d98f9be768a7b97f9ec2c3d39ae40d5d4a1db52e4c8f2da4b87b
+  data.tar.gz: d85e74ec08bb62fb508dc06f760acb8f6a562399b797cbb19239d374dbe9a9c0
 SHA512:
-  metadata.gz: 730739aea7cb1626cfe6211aea8fff5a4035ec3e852e64a4a4b6783f8b58a39b45c67bab546face8a3473ce80ad772b6b56654f3c610602e06a223dabace5d8e
-  data.tar.gz: 253be807c4c0b9746aed688ee21a7b615721ce55bc8601db3757f59da8794b3a69788b61593868310f0c8d1750cf518be6228204a22ebce8be4f51b0c7203d67
+  metadata.gz: ce40b7010eaadf8b84842db73b690938f311627498bbedd01df1d8e09382aa1377e54ed0a8307f232ed7725277ba6201c40f5a7e5f8073f050cc1d77e9d9a975
+  data.tar.gz: fb13542e35ab806616132e23a8f2166d10d95d55b24cd46f62242e6e2182f63ad226e8bb1d76930c72955da03b872c36d759efcab914dd56f0ca500b442a58d6

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coding_challenge (0.1.0)
+    coding_challenge (0.1.2)
       colorize (~> 0.8.1)
       lolcat (~> 100.0, >= 100.0.1)
       thor (~> 1.0, >= 1.0.1)

data/README.md

@@ -1,6 +1,18 @@
 # CodingChallenge
 
-Had fun with this. Published it as gem.
+Had fun with this. I published it as gem here: https://rubygems.org/gems/coding_challenge.
+
+## Quickstart
+
+`gem install coding_challenge` then
+`coding_challenge start`
+
+## Screenshots
+
+1. using CLI menu to input arguements
+   ![gif1](./gif1.gif)
+2. inputting arguments directly from commandline
+   ![gif2](./gif2.gif)
 
 ## Installation
 
@@ -10,7 +22,7 @@ Clone repo. Then in project directory `bundle install`.
 
 2. via rubygems
 
-``gem install coding_challenge```
+`gem install coding_challenge`
 
 ## Usage
 
@@ -20,91 +32,96 @@ To run with a cool CLI UI at the start, either do:
 - (IF INSTALLED AS GEM) from CLI do: `coding_challenge start [product type] [options]`
 
 To run without a cool CLI UI at the start but have it appear after, either do:
-_ (IF CLONED) Go to project directory and: `./exe/coding_challenge start [product type] [options] --skip_intro_animation=true`
-_ (IF INSTALLED AS GEM) from CLI do: `coding_challenge start [product type] [options] --skip_intro_animation=true`
+
+- (IF CLONED) Go to project directory and: `./exe/coding_challenge start [product type] [options] --skip_intro_animation=true`
+- (IF INSTALLED AS GEM) from CLI do: `coding_challenge start [product type] [options] --skip_intro_animation=true`
 
 ## Testing
 
 Clone and go to project directory and do `rspec spec`
 
-## Code Highlight
-
-I use an object to group together the query args and results like so
-
-```
-class Query
-  attr_reader :product_type, :options, :results
-  attr_writer :performed_at, :results
-
-  def initialize(query_args)
-    @product_type = query_args[0]
-    @options = query_args.slice(1, query_args.length)
-    @performed_at = nil
-    @results = nil
-  end
+## Code Explanation
 
-  def formatted_results
-    results_str = "Performed At #{@performed_at}\n"
-    results_str +=  "   Product Type Arg: #{@product_type}\n"
-    results_str +=  "   Options Args: #{@options.join(', ')}\n"
-    results_str +=  "   Results:\n"
-    results_str +=  "      #{@results.join("\n      ")}"
+Since the product list is represented as an array, there is NO
+way to solve this problem in O(1) time.
 
-    results_str
-  end
-end
-```
+At the very least, any solution is going to require 1 full iteration through the product list.
+What we can do, is create a hash based schema that will group all of the product types, option types,
+and option values as keys in a logical hierachy so that afterwards, detecting the prescence of data can be done
+simply by attempting to access it from the hash as a key O(1) time.
 
-This an instance of this class is then passed to an instance of a class I made in lib/coding_challenge/commands/util/Inventory.rb as an arg to this method
+I tried to do this compactly/elegantly by creating the following method and having it execute
+immediately after reading the products list:
 
 ```
-  def handle_query(query)
-    remaining_props_seen = {}
-    remaining_props = []
-
-    @products_list.each do |product|
-      next if product['product_type'] != query.product_type
-
-      search_start = query.options.length
-      option_types = product['options'].keys
-
-      (search_start..option_types.length - 1).each do |i|
-        option_type = option_types[i]
-        option_value = product['options'][option_type]
-
-        if remaining_props_seen[option_type].nil?
-          remaining_props_seen[option_type] = {}
-          remaining_props_seen[option_type][option_value] = true
-          remaining_props.push("#{option_type.capitalize}: #{option_value}")
-        elsif !remaining_props_seen[option_type][option_value]
-          remaining_props_seen[option_type][option_value] = true
-          remaining_props[i - search_start] += ", #{option_value}"
-        end
+  def index_product_schema(products_list)
+    products_schema = {}
+    products_list.each do |p|
+      if !products_schema.key?(p['product_type'])
+        products_schema[p['product_type']] = p['options'].transform_values { |o| Hash[o, true] }
+      else
+        products_schema[p['product_type']].merge!(p['options']) { |_, o, n| o.merge(Hash[n, true]) }
       end
     end
+    products_schema
+  end
 ```
 
-This is the main query algorithm.
+The above operation going to require one loop through the product list and then for each item,
+a nested loop that runs for the number of option types that exist for that item.
 
-A cool thing you can do is specify for the Inventory class to load in a product list in a JSON file from a URL or alternate file path. You can do this from the CLI menu.
-This method invokes some private methods I created for handling the cases but the logic is captured here:
+The generated products schema would look like this:
 
-```
-  def load_products_list_from_source(source_type, source_uri)
-    if source_type == 'FILE PATH'
-      load_from_file_path(source_uri)
-    elsif source_type == 'URL'
-      load_from_file_url(source_uri)
-    end
+`{"tshirt"=>{"gender"=>{"male"=>true, "female"=>true}, "color"=>{"red"=>true, "green"=>true, "navy"=>true, "white"=>true, "black"=>true}, "size"=>{"small"=>true, "medium"=>true, "large"=>true, "extra-large"=>true, "2x-large"=>true}}, "mug"=>{"type"=>{"coffee-mug"=>true, "travel-mug"=>true}}, "sticker"=>{"size"=>{"x-small"=>true, "small"=>true, "medium"=>true, "large"=>true, "x-large"=>true}, "style"=>{"matte"=>true, "glossy"=>true}}}`
+
+Run Time ~> sum of O(num_option_types<sub>i</sub>) where i goes from 1 to the length of the products_list array
 
-    unless @products_list.nil?
-      @source_type = source_type
-      @source_uri = source_uri
+Next, the following method below will execute using the product_schema produced by `index_product_schema`.
+
+You can see that validating the precesence of/accessing the options schema for a particular
+product type is done in O(1) in the first line.
+
+In an option schema for a given product type, the keys are option types and the values are hashes that contain keys
+every possible option value for a given option type.
+ex for sticker:
+
+`{"size"=>{"x-small"=>true, "small"=>true, "medium"=>true, "large"=>true, "x-large"=>true}, "style"=>{"matte"=>true, "glossy"=>true}}`
+We can now iterate through all of the option types/option values pairs using an index value (arg_position) to keep
+track of our position in the hash.
+
+Validating an options argument against possible option values is done using the index to match up
+the CLI argument at the position of the index to the current option types/option values pair. We do this in O(1)
+time by seeing if the argument exists as a key in the option values pair.
+
+The current option values hash is transformed into a friendly string by joining the keys
+together with commas.
+
+The main loop will execute for the number of option types for a given product type regardless of the
+size of the cli arguments input, which is a respective constant for each product type, so it is there for O(1).
+
+```
+  def handle_query(query)
+    product_options_schema = @products_schema[query.product_type.downcase]
+    is_invalid_product_type = product_options_schema.nil?
+    raise InvalidProductTypeError, query.product_type if is_invalid_product_type
+
+    results = []
+    product_options_schema.each_with_index do |(option_type, option_values_map), arg_position|
+      option_argument = query.options[arg_position]
+      is_argument_provided = !option_argument.nil?
+
+      if is_argument_provided
+        is_invalid_argument = !option_values_map.key?(option_argument)
+        raise InvalidOptionError.new(query.product_type, option_type, option_argument) if is_invalid_argument
+      else
+        possible_option_values = option_values_map.keys
+        results << "#{option_type.capitalize}: #{possible_option_values.join(', ')}"
+      end
     end
 
-    @products_list
+    query.results = results
+    query
   end
-
 ```
 
 ## Contributing
@@ -118,7 +135,3 @@ Everyone interacting in the CodingChallenge project's codebases, issue trackers,
 ## Copyright
 
 Copyright (c) 2020 Jorge Navarro. See [MIT License](LICENSE.txt) for further details.
-
-```
-
-```

data/coding_challenge.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A hiring coding challenge.'
   spec.description   = 'A Ruby CLI app made for hiring coding challenge.'
   spec.homepage      = 'https://github.com/Jnavarr56/REDACTED-3-coding-challenge'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   # blank for now
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

data/lib/coding_challenge/commands/start.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require_relative '../command'
-require_relative './util/Inventory'
-require_relative './util/Query'
+require_relative './util/inventory'
+require_relative './util/query'
 require_relative './util/animation'
+require_relative './util/invalid_product_type_error'
+require_relative './util/invalid_option_error'
+require_relative './util/file_read_error'
 
 require 'tty-spinner'
 require 'colorize'
@@ -35,16 +38,20 @@ module CodingChallenge
           loading_animation('Calculating results...', 2)
 
           new_inventory = Inventory.new
-          new_inventory.load_products_list_from_default
-          @inventory = new_inventory
 
-          new_query = Query.new(cli_args)
-          query_with_results = @inventory.handle_query(new_query)
+          begin
+            new_inventory.load_products_list_from_default
+            @inventory = new_inventory
+            new_query = Query.new(cli_args)
+            query_with_results = @inventory.handle_query(new_query)
 
-          puts 'Results:'.colorize(:yellow)
-          puts query_with_results.results
+            puts 'Results:'.colorize(:yellow)
+            puts query_with_results.results
 
-          @queries.push(query_with_results.formatted_results)
+            @queries.push(query_with_results.formatted_results)
+          rescue StandardError => e
+            puts "#{e.class.name}: #{e.message}".colorize(:red)
+          end
         end
 
         exited = false
@@ -124,14 +131,11 @@ module CodingChallenge
               loading_animation('Checking file readability...', 2)
               begin
                 new_inventory.load_products_list_from_source('FILE PATH', new_filepath)
-
-                raise StandardError if new_inventory.products_list.nil?
-
                 @inventory = new_inventory
                 prompt.say("\nFile loaded successfully!")
                 done = true
-              rescue StandardError
-                prompt.say('Could not read this file!')
+              rescue StandardError => e
+                puts "#{e.class.name}: #{e.message}".colorize(:red)
               end
             end
           end
@@ -146,15 +150,14 @@ module CodingChallenge
               spinner.auto_spin
               begin
                 new_inventory.load_products_list_from_source('URL', new_file_url)
-                raise StandardError if new_inventory.products_list.nil?
-
                 @inventory = new_inventory
                 prompt.say("\nFile fetched successfully!")
                 done = true
-              rescue StandardError
-                prompt.say('Could not fetch this file!')
+                spinner.stop
+              rescue StandardError => e
+                spinner.stop
+                puts "#{e.class.name}: #{e.message}".colorize(:red)
               end
-              spinner.stop
             end
 
           end
@@ -163,12 +166,10 @@ module CodingChallenge
           spinner.auto_spin
           begin
             new_inventory.load_products_list_from_default
-            raise StandardError if new_inventory.products_list.nil?
-
             @inventory = new_inventory
             prompt.say("\nDefault file fetched successfully!")
-          rescue StandardError
-            prompt.say('Could not fetch the default file!')
+          rescue StandardError => e
+            puts "#{e.class.name}: #{e.message}".colorize(:red)
           end
           spinner.stop
         end
@@ -202,11 +203,15 @@ module CodingChallenge
         puts ''
 
         new_query = Query.new(args)
-        query_with_results = @inventory.handle_query(new_query)
-        loading_animation('Calculating...', 2)
-        puts 'Results:'.colorize(:yellow)
-        puts query_with_results.results
-        @queries.push(query_with_results.formatted_results)
+
+        begin
+          query_with_results = @inventory.handle_query(new_query)
+          puts 'Results:'.colorize(:yellow)
+          puts query_with_results.results
+          @queries.push(query_with_results.formatted_results)
+        rescue StandardError => e
+          puts "#{e.class.name}: #{e.message}".colorize(:red)
+        end
 
         0
       end

data/lib/coding_challenge/commands/util/Inventory.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require_relative './invalid_product_type_error'
+require_relative './invalid_option_error'
+require_relative './file_read_error'
+
 require 'net/http'
 require 'json'
 require 'date'
@@ -11,87 +15,86 @@ class Inventory
     @source_type = nil
     @source_uri = nil
     @products_list = nil
+    @products_schema = nil
   end
 
   def handle_query(query)
-    remaining_props_seen = {}
-    remaining_props = []
-
-    @products_list.each do |product|
-      next if product['product_type'] != query.product_type
-
-      search_start = query.options.length
-      option_types = product['options'].keys
-
-      (search_start..option_types.length - 1).each do |i|
-        option_type = option_types[i]
-        option_value = product['options'][option_type]
-
-        if remaining_props_seen[option_type].nil?
-          remaining_props_seen[option_type] = {}
-          remaining_props_seen[option_type][option_value] = true
-          remaining_props.push("#{option_type.capitalize}: #{option_value}")
-        elsif !remaining_props_seen[option_type][option_value]
-          remaining_props_seen[option_type][option_value] = true
-          remaining_props[i - search_start] += ", #{option_value}"
-        end
+    product_options_schema = @products_schema[query.product_type.downcase]
+    is_invalid_product_type = product_options_schema.nil?
+    raise InvalidProductTypeError, query.product_type if is_invalid_product_type
+
+    results = []
+    product_options_schema.each_with_index do |(option_type, option_values_map), arg_position|
+      option_argument = query.options[arg_position]
+      is_argument_provided = !option_argument.nil?
+
+      if is_argument_provided
+        is_invalid_argument = !option_values_map.key?(option_argument)
+        raise InvalidOptionError.new(query.product_type, option_type, option_argument) if is_invalid_argument
+      else
+        possible_option_values = option_values_map.keys
+        results << "#{option_type.capitalize}: #{possible_option_values.join(', ')}"
       end
     end
 
-    query.performed_at = DateTime.now
-    query.results = remaining_props
-
+    query.results = results
     query
   end
 
   def load_products_list_from_source(source_type, source_uri)
-    if source_type == 'FILE PATH'
-      load_from_file_path(source_uri)
-    elsif source_type == 'URL'
-      load_from_file_url(source_uri)
+    begin
+      products_list = load_from_file_path(source_uri) if source_type == 'FILE PATH'
+      products_list = load_from_file_url(source_uri) if source_type == 'URL'
+      raise StandardError if products_list.nil?
+    rescue StandardError
+      raise FileReadError, source_uri
     end
+    set_as_data_source(source_type, source_uri, products_list)
+  end
 
-    unless @products_list.nil?
-      @source_type = source_type
-      @source_uri = source_uri
+  def load_products_list_from_default
+    begin
+      products_list = load_from_file_url(@@DEFAULT_PRODUCTS_LIST_URL)
+      raise StandardError if products_list.nil?
+    rescue StandardError
+      raise FileReadError, source_uri
     end
-
-    @products_list
+    set_as_data_source('DEFAULT', @@DEFAULT_PRODUCTS_LIST_URL, products_list)
   end
 
-  def load_products_list_from_default
-    load_from_file_url(@@DEFAULT_PRODUCTS_LIST_URL)
+  private
 
-    unless @products_list.nil?
-      @source_type = 'DEFAULT'
-      @source_uri = @@DEFAULT_PRODUCTS_LIST_URL
+  def index_product_schema(products_list)
+    products_schema = {}
+    products_list.each do |p|
+      if !products_schema.key?(p['product_type'])
+        products_schema[p['product_type']] = p['options'].transform_values { |o| Hash[o, true] }
+      else
+        products_schema[p['product_type']].merge!(p['options']) { |_, o, n| o.merge(Hash[n, true]) }
+      end
     end
-
-    @products_list
+    products_schema
   end
 
-  private
+  def set_as_data_source(source_type, source_uri, products_list)
+    @products_list = products_list
+    @products_schema = index_product_schema(products_list)
+    @source_type = source_type
+    @source_uri = source_uri
+  end
 
   def load_from_file_path(file_path)
     products_list_file = File.open(file_path)
     products_list_file_content = products_list_file.read
     products_list_hash = JSON.parse(products_list_file_content)
-
-    @products_list = products_list_hash
-  rescue StandardError
-    @products_list = nil
+    products_list_hash
   end
 
   def load_from_file_url(url)
     request_uri = URI(url)
-    begin
-      request_response = Net::HTTP.get_response(request_uri)
-      request_response_content = request_response.body
-      products_list_hash = JSON.parse(request_response_content)
-
-      @products_list = products_list_hash
-    rescue StandardError
-      @products_list = nil
-    end
+    request_response = Net::HTTP.get_response(request_uri)
+    request_response_content = request_response.body
+    products_list_hash = JSON.parse(request_response_content)
+    products_list_hash
   end
 end

data/lib/coding_challenge/commands/util/file_read_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FileReadError < StandardError
+  def initialize(source_uri)
+    super("Could not read file from #{source_uri}!")
+  end
+end

data/lib/coding_challenge/commands/util/invalid_option_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class InvalidOptionError < StandardError
+  def initialize(product_type, option_type, option_argument)
+    super("Product of type #{product_type.upcase} and #{option_type.upcase} option type of value #{option_argument.upcase} not in catalog!")
+  end
+end

data/lib/coding_challenge/commands/util/invalid_product_type_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class InvalidProductTypeError < StandardError
+  def initialize(product_type)
+    super("Product of type #{product_type.upcase} not in catalog!")
+  end
+end

data/lib/coding_challenge/version.rb

@@ -1,3 +1,3 @@
 module CodingChallenge
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coding_challenge
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jorge Navarro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -127,6 +127,8 @@ files:
 - bin/setup
 - coding_challenge.gemspec
 - exe/coding_challenge
+- gif1.gif
+- gif2.gif
 - lib/coding_challenge.rb
 - lib/coding_challenge/cli.rb
 - lib/coding_challenge/command.rb
@@ -135,6 +137,9 @@ files:
 - lib/coding_challenge/commands/util/Inventory.rb
 - lib/coding_challenge/commands/util/Query.rb
 - lib/coding_challenge/commands/util/animation.rb
+- lib/coding_challenge/commands/util/file_read_error.rb
+- lib/coding_challenge/commands/util/invalid_option_error.rb
+- lib/coding_challenge/commands/util/invalid_product_type_error.rb
 - lib/coding_challenge/templates/.gitkeep
 - lib/coding_challenge/templates/start/.gitkeep
 - lib/coding_challenge/version.rb
@@ -153,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="