rain_jackets 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: '0995f74068a6719cf371aafd4f3b48425bc8b8620a60408a7506ccee8f06476e'
-  data.tar.gz: 23c70660023c2fe4866eaca0487a335975cfe2be50f9a41e9e98b5496fe0b554
+SHA1:
+  metadata.gz: b14aafb20e54a79c1568eaa735a1f847d060f67b
+  data.tar.gz: 5a7767e72ed22a18855071717dfe4e803f29f4c1
 SHA512:
-  metadata.gz: a7efa8a84dc66d59412f2ad7af7eae5bfdb0bb5d427fc98530191850bd7c1884a2fab1ad3103188769470abab58e25a47a06ec2d61b0f87399f0834a9c51af33
-  data.tar.gz: 998c956c6b2ba4d4548d6e1ba21664ef5841a5b6e885231237808b52070396e25708360be0cef6db8ea23d8eca326dec4ad2ed1c18ac42506927345b2778010b
+  metadata.gz: e374b6145f1b979c36002302d6bf100191ded907115da852d02a1617a50d3983f26a6126c208d82844e545756c9b0843177c8977806a15a7c75328e758508159
+  data.tar.gz: 980baf955e83bdcf702baccfd5309396270914792603183908a07faf0770bb1c04a5c4c76f0e4bc10f912bc06373ccc8e49913944216b7efb57590ff3190adb5

data/lib/rain_jackets/cli.rb

@@ -1,61 +1,67 @@
 class RainJackets::CLI
   attr_accessor :jackets
-  
+
   def initialize
+    # store all jacket instances in CLI's instance variable @all
     @jackets = RainJackets::Scraper.initialize_jacket_objects
-    puts "Welcome to the Best Rain Jackets Rater!"
-    prompt_user_input
+    puts ""
+    puts "Welcome to the Best Women's Rain Jackets Rater!"
+    prompt_input
   end
- 
-  def prompt_user_input
+
+  # Print instructions to screen and get user input
+  def prompt_input
     puts "► What would you like to do?"
     puts "► Enter: 'menu' to see all commands / 'exit' to exit program."
-    call
+    get_input
   end
-  
+
   # Initiates call procedure to get and handle user input
-  def call 
+  def get_input
     input = gets.chomp.strip
     handle_input(input)
-  end    
-  
+  end
+
   # Handles the user pint
-  def handle_input(input)  
+  def handle_input(input)
     if input == "all"
       print_list_all
-      
-    elsif (1..5).include?(input.to_i) 
+
+    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 input == "menu"
       print_menu
-      call
-    
+      get_input
+
     elsif input == "exit"
-      puts "Goodbye! Have a great day!"
+      puts "Goodbye! Hope you found your favorite jacket!"
       exit
-      
-    else #- make sure that the program doesn't break when user's input is unexpected
-      puts "I don't understand that answer. Please try again" 
+
+    else # Make sure that the program doesn't break with unexpected user input
+      puts "I don't understand that answer. Please try again!"
     end
-    
-    prompt_user_input 
-    call #reinitiate call loop at the end of non-exited handle_input logic
+
+    prompt_input # Reinitiate get_input loop at the end of non-exited handle_input logic
   end
-  
+
+  # Display all best rain jackets
   def print_list_all
-    puts "---------------------------- Best Rain Jackets of 2019: ------------------------"
+    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"
       end
-    puts "--------------------------------------------------------------------------------"
+    puts "-----------------------------------------------------------------------------------"
   end
-  
+
+  # Display details of chosen jacket
   def print_selected_jacket(jacket_number)
     jacket = @jackets[jacket_number - 1]
+    puts ""
     puts "---------------- #{jacket_number}. #{jacket.name} ----------------"
     puts "• Jacket Description: #{jacket.description}"
     puts "• Price: #{jacket.price}"
@@ -72,8 +78,8 @@ class RainJackets::CLI
     puts "  - Packed Size: #{jacket.packed_size_rating}/10"
     puts "-----------------------------------------------------------------"
   end
-  
-  # Converts user shortcut input to jacket attribute name as string
+
+  # Convert user shortcut input to jacket attribute name as string
   def read_rating_input(input)
     if input == 'wr'
       rating_category = "water_resistance_rating"
@@ -87,29 +93,29 @@ class RainJackets::CLI
       rating_category = "durability_rating"
     elsif input == 'ps'
       rating_category = "packed_size_rating"
-    else
-      puts "Incorrect input. Please try again."
-      prompt_user_input
     end
     rating_category
   end
-  
+
+  # 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
-    
+
     # Convert rating attribute name to readable capitalized title
     rating_category_name = rating_attribute.split('_').map(&:capitalize).join(' ')
-    
+
+    puts ""
     puts "-------------Best Jackets Ranked by #{rating_category_name} ------------------"
     jackets_sorted_by_rating.each_with_index do |jacket, idx|
       puts " #{idx + 1}. #{jacket.name} — #{jacket.send(rating_attribute)}/10"
     end
-    puts "-----------------------------------------------------------------"
+    puts "---------------------------------------------------------------------"
   end
-  
+
   # Display all menu commands
-  def print_menu 
+  def print_menu
+    puts ""
     puts "========================== MENU ==============================="
     puts "• List all jackets -> enter 'all'"
     puts "• More information on specific jacket -> enter jacket #'1-5'"
@@ -119,7 +125,7 @@ class RainJackets::CLI
     puts "  'c' — Comfort"
     puts "  'w' — Weight"
     puts "  'd' — Durability"
-    puts "  'ps' — Packed Size" 
+    puts "  'ps' — Packed Size"
     puts "• Exit program -> enter 'exit'"
     puts "==============================================================="
     puts "► What would you like to do?"

data/lib/rain_jackets/jacket.rb

@@ -1,16 +1,16 @@
 class RainJackets::Jacket
   attr_accessor :name, :url, :price, :description, :pros, :cons, :overall_rating
   attr_accessor :water_resistance_rating, :breathability_rating, :comfort_rating, :weight_rating, :durability_rating, :packed_size_rating, :rating_category
-  
+
   @@all = []
-  
-  # Take in an argument of an array and sets new jacket's attributes
+
+  # Add jacket instance into class variable @@all (array)
   def initialize
     @@all << self
   end
-  
+
   def self.all # Class method to expose variable @@all
     @@all
   end
-  
+
 end

data/lib/rain_jackets/scraper.rb

@@ -3,11 +3,11 @@ class RainJackets::Scraper
   def self.get_page
     Nokogiri::HTML(open("https://www.outdoorgearlab.com/topics/clothing-womens/best-rain-jacket-womens"))
   end
-  
+
   def self.scrape_jackets_table
     self.get_page.css("div.content_table_xwide tr")
   end
-  
+
   def self.initialize_jacket_objects
     all_jackets = []
     # Determines which row you're on, hence which property you're trying to populate
@@ -15,58 +15,62 @@ class RainJackets::Scraper
 
       # Product name and URL
       if tr_index == 0
-        # td_value = td_element
         product_name_row = tr_element.css("div.compare_product_name")
-        
+
         product_name_row.each do |td_element|
+          # Initialize a new jacket instance
           new_jacket = RainJackets::Jacket.new
           new_jacket.name = td_element.text
           new_jacket.url = "https://www.outdoorgearlab.com" + td_element.css("a").first.attributes["href"].value
           all_jackets << new_jacket
         end
-      
+
       # Product Price
       elsif tr_index == 2
-        product_price_row = tr_element.css("td.compare_items span").each_with_index do |td_element, td_index|
+        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"
         end
-  
+
       # Overall rating
       elsif tr_index == 3
         overall_rating_row = tr_element.css("div.rating_score")
+        # Iterate through each rating_score (column) and
+        # Populate each jacket's overall_rating attribute
         overall_rating_row.each_with_index do |rating_score, rating_row_index|
-          # rating_score.text is an Intergerç
-          all_jackets[rating_row_index].overall_rating = rating_score.text
+          all_jackets[rating_row_index].overall_rating = rating_score.text #an integer
         end
-      
+
       # 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
       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
-      
-      # Desciption
+
+      # 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 11-14): water_resistance_rating, breathability_rating, comfort_rating, weight_rating, packed_size_rating
+
+      # Rating categories (tr_index 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]
           rating_score = rating_score.text
-  
+
           if tr_index == 9
             jacket.water_resistance_rating = rating_score
           elsif tr_index == 10
@@ -80,12 +84,12 @@ class RainJackets::Scraper
           elsif tr_index == 14
             jacket.packed_size_rating = rating_score
           end
-  
+
           all_jackets[rating_row_index] = jacket
         end
-      end 
-    end  
-    
+      end
+    end
+    # Returns an array of all 5 jacket instances
     all_jackets
-  end 
-end 
+  end
+end

data/lib/rain_jackets/version.rb

@@ -1,3 +1,3 @@
 module RainJackets
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rain_jackets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - "'Jacqueline Lam'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2019-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Get the details for 2019's best rain jackets from Outdoor Gear Lab.
+description: Get the details for 2019's best rain jackets from Outdoor Gear Lab. Type
+  `gem install rain_jackets` to install gem and type`rain_jackets` to run.
 email:
 - "'jacqueline.karin.lam@gmail.com'"
 executables:
@@ -99,7 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: CLI for best rain jackets