steam-upcoming 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e0b73c4b1a02bbca55e3d395ce27870817e386b
-  data.tar.gz: f16aa465b2d3db2867c9878518f91fac83fe2f05
+  metadata.gz: 60f01b9aab0c1d3bacfa0a33fab1b8de15e39770
+  data.tar.gz: b7d96181a097415fa89b3237e37a61cae653815c
 SHA512:
-  metadata.gz: 721c3d8bc6d9163d0dcb3a2d36168eeb4bd1bdc46cf8d93cba437b9080907aa97af5d70f927192125f346760b2fe6a80c1cc6a490d091643fe2c4650bb2a102f
-  data.tar.gz: 6db0be667baa2d2e0a3aaf3065fff1c859a8c5ac7ec6fba397803cb3414d380b71cd79da0da0497fdc9d0dd3f15c9e92253b168a839d7a5470abff161e3a590b
+  metadata.gz: cea802dc82d096666bc4e5aacd30e7bf2db61c4023994bf1654f19c75297063dfe8d735df8dc1ec1883715dbd25fee56f1d397cf81440a5b42a49ef3f7460748
+  data.tar.gz: 657b0553e3bb5170b02d7af469bd2a673df95bafd06722b68d959e3da260f412389931ef6cd90e9049e04293c729a1b2a5effbb84fdc3f3b4fe075fd5985137d

data/config/environment.rb

@@ -2,6 +2,7 @@ require 'open-uri'
 require 'pry'
 require 'nokogiri'
 require "colorize"
-require_relative "../lib/steam-upcoming/cli.rb"
+
+require_relative "../lib/steam-upcoming/scraper.rb"
 require_relative "../lib/steam-upcoming/game.rb"
-require_relative "../lib/steam-upcoming/scraper.rb"
+require_relative "../lib/steam-upcoming/cli.rb"

data/lib/steam-upcoming.rb

@@ -1,5 +1,4 @@
-require_relative "../config/environment"
-
 module SteamUpcoming
 end
 
+require_relative "../config/environment"

data/lib/steam-upcoming/cli.rb

@@ -3,7 +3,6 @@ class SteamUpcoming::CLI
 
   BASE_URL = "http://store.steampowered.com/search/?filter=comingsoon&sort_order=0&filter=comingsoon&page=1"
 
-
   def initialize 
     @url = "http://store.steampowered.com/search/?filter=comingsoon&sort_order=0&filter=comingsoon&page=1"
   end
@@ -15,21 +14,21 @@ class SteamUpcoming::CLI
     start
   end
 
-  def make_games(url) #creates the list of games from the URL
+  def make_games(url) #creates the list of game objects from the chosen URL
     game_array = SteamUpcoming::Scraper.scrape_index_page(url)
     SteamUpcoming::Game.create_from_collection(game_array)
   end
 
-  def pages #generate list of pages
+  def pages #generate list of page URLs as an array
     pages = SteamUpcoming::Game.create_pages(SteamUpcoming::Scraper.page_count(BASE_URL)) 
   end
 
   def change_page #allow the users to select another page
     print "Enter a page number > "
     input = gets.chomp.strip
-    if @url = pages[input.to_i-1]
-      SteamUpcoming::Game.reset
-      make_games(@url)
+    if @url = pages[input.to_i-1] #use the users input to select the corresponding page URL from the #pages array
+      SteamUpcoming::Game.reset #clear out the class variable so it can be populated with a new list of games
+      make_games(@url) #create the games with the new chosen URL
       list
     else
       puts "#{input}".concat(" is not a valid page number. Please enter a number between 1 and #{pages.count}.").colorize(:red)
@@ -62,15 +61,17 @@ class SteamUpcoming::CLI
   end
 
   def current_page
-    url = @url[-2,2]
-    array = url.split("").map {|x| x.to_i}
+    url = @url[-2,2] #return the last two characters of the URL string
+    array = url.split("").map {|x| x.to_i} #split the two characters into an array
     array[0] == 0 ? current_page = array[0] + array[1] : current_page = "#{array[0]}".concat("#{array[1]}")
+      #if the first element is a letter (it converts to 0), add it to the second element
+      #if the both elements are numbers, concatenate them and return the new string
   end
 
   def start #start the program loop
     list
     input = nil
-    while input != "exit"
+    while input != "exit" #loop user input until user types 'exit'
       puts "\nLearn more about a game by typing a name or number.\n".colorize(:yellow)
       puts "Enter \'list\'' to list games.".colorize(:light_blue)
       puts "Enter \'exit\' to exit.".colorize(:light_blue)
@@ -80,17 +81,17 @@ class SteamUpcoming::CLI
       if input == "list"
         list
       elsif input.to_i == 0 #if input is a name
-        if game = SteamUpcoming::Game.find_by_name(input)
+        if game = SteamUpcoming::Game.find_by_name(input) #find game and list corresponding game
           list_game(game)
-        elsif input == "exit"
+        elsif input == "exit" #exit the program
           break
-        elsif input == "page"
+        elsif input == "page" #commence the #change_page method
           change_page
         else
-          puts "\'#{input}\'".concat(" is not a valid title.").colorize(:red)
+          puts "\'#{input}\'".concat(" is not a valid command.").colorize(:red)
         end
-      elsif input.to_i > 0 #if a number, look up the number
-        if game = SteamUpcoming::Game.find(input.to_i)
+      elsif input.to_i > 0 #if a number
+        if game = SteamUpcoming::Game.find(input.to_i) #find number and list corresponding game
           list_game(game)
         else
           puts "\'#{input}\'".concat(" is not a valid number. Please enter a number between 1 and #{SteamUpcoming::Game.all.count}.").colorize(:red)
@@ -99,4 +100,6 @@ class SteamUpcoming::CLI
     end
     puts "\nShutting down...\n".colorize(:red)
   end
+
 end
+

data/lib/steam-upcoming/game.rb

@@ -1,3 +1,6 @@
+# The SteamUpcoming::Game class is responsible for taking informatino scraped from the Steam website
+# and creating new Game objects with attributes. 
+
 class SteamUpcoming::Game
   attr_accessor :name, :release_date, :platforms, :url, :about, :tags, :details 
 
@@ -14,11 +17,11 @@ class SteamUpcoming::Game
     end
   end
 
-  def add_game_attributes(game_attributes_hash) #add attributes to game
+  def add_game_attributes(game_attributes_hash) #add attributes to the Game object
     game_attributes_hash.each {|key, value| self.send(("#{key}="), value)} 
   end
 
-  def self.create_pages(page_count) #create the page urls
+  def self.create_pages(page_count) #Create the page urls
     i = 1
     pages = []
     while i <= page_count.to_i
@@ -28,10 +31,12 @@ class SteamUpcoming::Game
     pages
   end
 
+  private
   def self.all #show all games
     @@all
   end
 
+  private
   def self.reset #clear the list of games
     @@all.clear
   end

data/lib/steam-upcoming/scraper.rb

@@ -19,14 +19,14 @@ class SteamUpcoming::Scraper
     game_array
   end
 
-  def self.gather_platforms(parent) #gather a list of platforms, then return an array of legit platforms
+  def self.gather_platforms(parent) #gather a list of platforms, then return an array of actual platforms
     platforms = parent.children.map do |platform|
       platform.attr('class')
     end
     platforms.select {|platform| platform != nil} 
   end
 
-  def self.convert_platforms(platform_array) #need to convert the platform array items into actual names, because the source is an image, not
+  def self.convert_platforms(platform_array) #convert the platform array items into actual names, because the source is an image, not text
     platforms = platform_array.map! do |platform|
       if platform.include?("win")
         platform = "Windows"
@@ -47,7 +47,7 @@ class SteamUpcoming::Scraper
     platforms.select {|platform| platform != nil}
   end
 
-  def self.scrape_game_page(game_url)
+  def self.scrape_game_page(game_url) #scrape the page and create a hash of game attributes
     doc = Nokogiri::HTML(open(game_url))
     about = doc.css(".game_description_snippet")
     tags = doc.css(".glance_tags a").map {|tag| tag.text}
@@ -59,7 +59,7 @@ class SteamUpcoming::Scraper
     }
   end
 
-  def self.page_count(index_url)
+  def self.page_count(index_url) #scrape the pages to get the total number of pages
     doc = Nokogiri::HTML(open(index_url))
     page_count = doc.css(".search_pagination_right").first.children[5].text.to_i
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steam-upcoming
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Cassara