rain_jackets 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 774adb1e37745af58e1de5b0b6301f92c8f054a3
-  data.tar.gz: b0a41bdcd8ad0638ed0e8b4d18e566ee3289b65e
+  metadata.gz: 2db2b5acf891f0b2bcea3c4d438dd3b5efd5bc6a
+  data.tar.gz: 6bd0e9787540efb11ecd0836fc1636dee16c2969
 SHA512:
-  metadata.gz: bf4010a22558961890686629a9ff8aff699f96d25704d8256c51051fe4ddb4420248c56b19dcde0c3ecc8161dc6ed53e3545a74317c4da3b06210dbecbaf22a9
-  data.tar.gz: 7a4a8d4428965b87648bc1c71fee479e5ee8f3d2300363c5264a2f345a6e262b95c4304fc6703aa465b26dd0680d01fce4e06b6b3ccb4bbeafbb1eb941a79102
+  metadata.gz: 4f64bb9034469c3d03326231de09023988beda0096457449b3412355cab4d99f1c139d0e369f35173ad959055e7f590dd55e467e4c7f0fe09adb2471a82c61c0
+  data.tar.gz: 0644436574c221a574e4cab7cad3f745ab4444c6f64ebde78332b9bb681905cb13d6f671580bc82422d5e3917dcb01f01ab627fc967b910f25d4b31f390d3a83

data/bin/rain_jackets

@@ -2,4 +2,5 @@
 
 require_relative '../config/environment/'
 
+# Initiates call procedure to start CLI app
 RainJackets::CLI.new.call

data/config/environment.rb

@@ -1,7 +1,9 @@
+# All the required code to initialize the environment
+
 ### REQUIRED GEMS ###
 require 'nokogiri'
 require 'open-uri'
-require 'pry'
+# require 'pry'
 
 ### REQUIRED FILES ###
 require_relative '../lib/rain_jackets/version'

data/lib/rain_jackets/cli.rb

@@ -2,23 +2,25 @@ class RainJackets::CLI
   attr_accessor :jackets
 
   def call
-    # store all jacket instances in CLI's instance variable @all
-    @jackets = RainJackets::Scraper.initialize_jacket_objects
+    # Calls Scraper class method that will return array of all jacket objects
+    # Store all Jacket instances in CLI's instance variable @jackets
+    RainJackets::Scraper.initialize_jacket_objects
+    @jackets = RainJackets::Jacket.all
+    # Greet user with text input
     puts ""
     puts "Welcome to the Best Women's Rain Jackets Rater!"
     prompt_input
   end
 
-  # Print instructions to screen and get user input
+  # Print instructions to screen and prompts user for input
   def prompt_input
     puts "► What would you like to do?"
     puts "► Enter: 'menu' to see all commands / 'exit' to exit program."
     get_input
   end
 
-  # Initiates call procedure to get and handle user input
   def get_input
-    input = gets.chomp.strip
+    input = gets.strip.downcase
     handle_input(input)
   end
 
@@ -30,8 +32,8 @@ class RainJackets::CLI
     elsif (1..5).include?(input.to_i)
       print_selected_jacket(input.to_i)
 
-    elsif ['wr', 'b', 'c', 'w', 'd', 'ps'].include?(input.downcase)
-      print_ratings(input.downcase)
+    elsif ['wr', 'b', 'c', 'w', 'd', 'ps'].include?(input)
+      print_ratings(input)
 
     elsif input == "menu"
       print_menu
@@ -42,10 +44,11 @@ class RainJackets::CLI
       exit
 
     else # Make sure that the program doesn't break with unexpected user input
+      puts ""
       puts "I don't understand that answer. Please try again!"
     end
 
-    prompt_input # Reinitiate get_input loop at the end of non-exited handle_input logic
+    prompt_input # Reinitiate program loop at the end of non-exited handle_input logic
   end
 
   # Display all best rain jackets
@@ -53,7 +56,8 @@ class RainJackets::CLI
     puts ""
     puts "----------------------- Best Women's Rain Jackets of 2019: -----------------------------"
       @jackets.each_with_index do |jacket, i|
-        puts " #{(i+1).to_s}. #{jacket.name.split(" - ").first} — #{jacket.price} - #{jacket.overall_rating}/100 Overall Rating"
+        ranking = (i+1).to_s
+        puts " #{ranking}. #{jacket.name.split(" - ").first} — #{jacket.price} - #{jacket.overall_rating}/100 Overall Rating"
       end
     puts "-----------------------------------------------------------------------------------"
   end
@@ -79,20 +83,22 @@ class RainJackets::CLI
     puts "-----------------------------------------------------------------"
   end
 
-  # Convert user shortcut input to jacket attribute name as string
+  # Convert user input to jacket attribute name string
   def read_rating_input(input)
-    if input == 'wr'
-      rating_category = "water_resistance_rating"
-    elsif input == 'b'
-      rating_category = "breathability_rating"
-    elsif input == 'c'
-      rating_category = "comfort_rating"
-    elsif input == 'w'
-      rating_category = "weight_rating"
-    elsif input == 'd'
-      rating_category = "durability_rating"
-    elsif input == 'ps'
-      rating_category = "packed_size_rating"
+    # case statement to run multiple conditions against input value
+    case input
+      when 'wr'
+        rating_category = "water_resistance_rating"
+      when 'b'
+        rating_category = "breathability_rating"
+      when 'c'
+        rating_category = "comfort_rating"
+      when 'w'
+        rating_category = "weight_rating"
+      when 'd'
+        rating_category = "durability_rating"
+      when 'ps'
+        rating_category = "packed_size_rating"
     end
     rating_category
   end
@@ -100,7 +106,9 @@ class RainJackets::CLI
   # Display ranked list based on chosen rating category
   def print_ratings(input)
     rating_attribute = read_rating_input(input)
-    jackets_sorted_by_rating = @jackets.sort_by { |jacket| jacket.send(rating_attribute) }.reverse
+    # Dynamically access specified attribute reader and
+    # Sort all jacket instances in descending order of the rating attribute's value
+    jackets_sorted_by_rating = @jackets.sort_by { |jacket| jacket.send(rating_attribute)}.reverse
 
     # Convert rating attribute name to readable capitalized title
     rating_category_name = rating_attribute.split('_').map(&:capitalize).join(' ')
@@ -113,7 +121,7 @@ class RainJackets::CLI
     puts "---------------------------------------------------------------------"
   end
 
-  # Display all menu commands
+  # Display all menu commands/ Define input interface
   def print_menu
     puts ""
     puts "========================== MENU ==============================="

data/lib/rain_jackets/jacket.rb

@@ -4,13 +4,13 @@ class RainJackets::Jacket
 
   @@all = []
 
-  # Add jacket instance into class variable @@all (array)
-  def initialize
-    @@all << self
+  # Set class method @@all to equate jackets array created by Scraper
+  def self.all=(jackets)
+    @@all = jackets.uniq
   end
 
-  def self.all # Class method to expose variable @@all
+  # Class method to expose variable @@all
+  def self.all
     @@all
   end
-
-end
+end

data/lib/rain_jackets/scraper.rb

@@ -1,41 +1,53 @@
 class RainJackets::Scraper
 
+  # Take HTML string returned by open-uri's open method
+  # and convert it into a NodeSet
   def self.get_page
     Nokogiri::HTML(open("https://www.outdoorgearlab.com/topics/clothing-womens/best-rain-jacket-womens"))
   end
 
   def self.scrape_jackets_table
+    # Use CSS selector to grab all HTML elements that contain a table
+    # return array of Nokogiri XML elements representing
+    # table described on scraped webpage
     self.get_page.css("div.content_table_xwide tr")
   end
 
+  # Instantiate jacket objects and assign attributes to each instance
   def self.initialize_jacket_objects
     all_jackets = []
+
     # Determines which row you're on, hence which property you're trying to populate
+    # Iterate through collection of table rows
+
     scrape_jackets_table.each_with_index do |tr_element, tr_index|
 
-      # Product name and URL
+      # Scrape product Name and URL
       if tr_index == 0
+        # Grab the element that contains our desired data
         product_name_row = tr_element.css("div.compare_product_name")
 
+        # Iterate through each of td element and instantiate new jacket
         product_name_row.each do |td_element|
-          # Initialize a new jacket instance
+          # Create a new Jacket instance out of each aray element
+          # instantiating Jacket objects and giving each jacket object the correct attributes
           new_jacket = RainJackets::Jacket.new
-          new_jacket.name = td_element.text
+          new_jacket.name = td_element.text #access text content inside an element scraped by Nokogiri
           new_jacket.url = "https://www.outdoorgearlab.com" + td_element.css("a").first.attributes["href"].value
           all_jackets << new_jacket
         end
 
-      # Product Price
+      # Scrape Price
       elsif tr_index == 2
         product_price_row = tr_element.css("td.compare_items span")
         # Iterate through each td_element (column) and
         # Populate each jacket's price attribute
         product_price_row.each_with_index do |td_element, td_index|
           td_value = td_element.text
-          all_jackets[td_index].price = td_value #price in string "$149.93"
+          all_jackets[td_index].price = td_value # Price in string "$149.93"
         end
 
-      # Overall rating
+      # Scrape Overall Rating
       elsif tr_index == 3
         overall_rating_row = tr_element.css("div.rating_score")
         # Iterate through each rating_score (column) and
@@ -44,28 +56,28 @@ class RainJackets::Scraper
           all_jackets[rating_row_index].overall_rating = rating_score.text #an integer
         end
 
-      # Pros
+      # Scrape Pros
       elsif tr_index == 5
         pros_row = tr_element.css("td.compare_items").each_with_index do |td_element, td_index|
           td_value = td_element.text
           all_jackets[td_index].pros = td_value
         end
 
-      # Cons
+      # Scrape Cons
       elsif tr_index == 6
         pros_row = tr_element.css("td.compare_items").each_with_index do |td_element, td_index|
           td_value = td_element.text
           all_jackets[td_index].cons = td_value
         end
 
-      # Description
+      # Scrape Description
       elsif tr_index == 7
         description_row = tr_element.css("td.compare_items").each_with_index do |td_element, td_index|
           td_value = td_element.text
           all_jackets[td_index].description = td_value
         end
 
-      # Rating categories (tr_index 9-14)
+      # Scrape rating categories if tr_index is between 9-14
       elsif (9..14).include?(tr_index)
         tr_element.css("div.rating_score").each_with_index do |rating_score, rating_row_index|
           jacket = all_jackets[rating_row_index]
@@ -84,12 +96,10 @@ class RainJackets::Scraper
           elsif tr_index == 14
             jacket.packed_size_rating = rating_score
           end
-
-          all_jackets[rating_row_index] = jacket
         end
       end
     end
-    # Returns an array of all 5 jacket instances
-    all_jackets
+    # Store all_jackets array in Jacket class variable @@all
+    RainJackets::Jacket.all = all_jackets
   end
 end

data/lib/rain_jackets/version.rb

@@ -1,3 +1,3 @@
 module RainJackets
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rain_jackets
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - "'Jacqueline Lam'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-03 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler