sec_mens_bball 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f104e4e09bf9b122368452ffeee8e5ced3aa4c62
-  data.tar.gz: 9f838831a87c12a01341a149d018a9860042910c
+  metadata.gz: 286370c40adbe2183890e052b8ef86dc3387f362
+  data.tar.gz: 52e46b5e79c6fa43b2d52901294871a4a6fd8dc8
 SHA512:
-  metadata.gz: 00c149aaff4099aac76abfeaf6a01a31ad8d412445b224c02f269f62297029175c6f53a0d4ba3b3e7ae7f29a5d966944aa5624153b6a90d8b5f899bd7039286a
-  data.tar.gz: 351ade7e7744a6453602105d2828edaa62b7de5935f4030d06351f3ab9e73e7cf016937243951875ed53e70ee8c6bb47d94cafbbe01a1bad5bc0bb97777b2612
+  metadata.gz: 5beddac83f53bdb9094cb9b0a365c6ed891c348ad35d08bfc10bd63f110c58ac90367e30e38f949126c9589b9ce92d7515fd3113c6809b08fd46bc9608bf1434
+  data.tar.gz: 848757031f299e05e302ae09a429ee265e0efa62c2729fa898ab7e86b8d4e43bb80b6b67dc684af97300169320f7ee8df0996d9b78a309737d0b54a8f40aee5b

data/Gemfile

@@ -1,6 +1,4 @@
 source "https://rubygems.org"
 
-# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
 # Specify your gem's dependencies in sec_mens_bball.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sec_mens_bball (0.1.0)
+    sec_mens_bball (0.1.1)
       nokogiri
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
 # SecMensBball
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sec_mens_bball`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Welcome to SecMensBball. This gem displays the current mens' basketball standings in the Southeastern Conference. It ranks the teams (1-14) by conference record, and also gives the teams' overall record. Select a particular team and it displays a team page that has the scheduling data for that teams entire season, including dates, opponents, and the score if the game has already been played.
 
 ## Installation
 
@@ -22,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installation, go to the directory the gem was installed in and enter "bin/bball". The current Southeastern Conference Mens' Basketball Standings is then displayed in rank order from 1-14. Enter the number of a team to display that teams season's schedule. Included in the display is the game's date, matchup, and result, if game has already been played and time, if game is yet to be played. Matchup includes opponents name and whether the game is home (vs) or away (@). Result includes win or loss and the score. Once a number has been entered to see a team's season schedule, enter another number to see a different team's schedule. Enter the word "league" to see the league standings again, and enter 'exit' to leave.
 
 ## Development
 

data/bin/bball

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
 
+#run Bundler and setup my gems and their dependencies
 require "bundler/setup"
-require "sec_mens_bball"
 
+#require the file that contains all my other requires
+require "sec_mens_bball"
 
+#start the CLI gem
 CLI.new.call

data/lib/sec_mens_bball/cli.rb

@@ -3,6 +3,7 @@ require 'pry'
 class CLI
 
 	def call
+		#give a brief welcoming statement, then display the latest league standings, then prompt for a team choice
 		welcome
 		display_league
 		choose
@@ -16,13 +17,17 @@ class CLI
 	end
 
 	def display_league
+		#display a header
 		puts
 		puts "No.            Team 	     League Record	 Overall Record"
 		puts "----------------------------------------------------------------"
+		# scrape the entire standings page
 		@standings = Scraper.scrape_standings_page
 		rank = 0
+		#go through each line of the standings and build a team object
 		@standings.each do |team|
 			rank += 1
+			#print out team information with proper formatting to make info align
 			print rank.to_s.rjust(2)
 			print team.name.rjust(20)
 			print team.conf_record.rjust(15)
@@ -31,36 +36,42 @@ class CLI
 	end
 
 	def choose
-		puts
-		loop do
-		  puts "Enter a team's number to see its schedule, type 'league' to see league standings again, or type 'exit' to leave site"
-		  input = gets.strip 
-		  if input == "exit"
+		puts   #print a blank line for readability
+		loop do  #continuously loop until user inputs 'exit'
+			#prompt user
+			puts
+		  puts "Enter a team's number to see its schedule, type 'league' to see league standings again,"
+		  puts "or type 'exit' to leave site"
+		  puts
+		  input = gets.strip  #get user's input and put it into the variable 'input'
+		  if input == "exit"  #if 'exit', print a short goodbye message and break from if statement to end program
 		  	goodbye
 		  	break
-		  elsif (1..14).cover?(input.to_i)
-		  	team = @standings[input.to_i - 1]
-		  	Scraper.scrape_team_page(team)
-		  	display_team_schedule(team)	
-		  elsif input == "league"	
+		  elsif (1..14).cover?(input.to_i) #change string input to an integer and check to see the number is between 1 and 14
+		  	team = @standings[input.to_i - 1] # @standings is an array of previously scraped team objects
+		  	Scraper.scrape_team_page(team) # scrape the team page that corresponds to the input number
+		  	display_team_schedule(team)	#display the schedule attributes of the input team
+		  elsif input == "league"	# if 'league' call 'display_league' method to display the standings of the league
 		  	display_league  	
-		  else
-		  	puts "Please type a number between 1 and 14."
+		  else # if the input is anything else, tell user what the acceptable inputs are
+		  	puts "Please type a number between 1 and 14"
+		  	puts
 		  end
 		end
 	end
 
 	def display_team_schedule(team)
+		# this method accepts a team input, prints a header, and prints schedule attributes for that team
 		puts
 		puts "#{team.name} Men's Basketball Team Schedule 2018"
 		puts "   Date                    Matchup         Result/Time "
 		puts "--------------------------------------------------------"
-		team.games.each do |game|
+		team.games.each do |game| # print each game on a teams schedule
 		  print game.date.rjust(13) 
 		  print game.opponent.rjust(25)
 		  puts game.result.rjust(15) 
 		end
-		puts "* Game Played At Neutral Venue"
+		puts "* Game Played At Neutral Venue" # print this line to explain the asterisks that show up in the schedule
 	end
 
 	def goodbye
@@ -68,6 +79,7 @@ class CLI
 	end
 
 	def find_team_url(input)
+		# this method changes the input from the command line to an index for the @standings array
 		index = input.to_i - 1
 		team = @standings[index] 
 		team.url

data/lib/sec_mens_bball/scraper.rb

@@ -4,28 +4,33 @@ require 'pry'
 
 class Scraper
 
-	def self.scrape_standings_page		
-		doc = Nokogiri::HTML(open("http://www.secsports.com/standings/mens-basketball"))
-		standings = doc.css("#wrapper > div > main > section > div > section > div > div > div > div.panel-body > div > table > tbody")
-		league = []
+	def self.scrape_standings_page
+		# open is an open-URI method that takes an URL and outputs the HTML from that page
+		# Nokogiri::HTML changes HTML to a nodeset		
+		doc = Nokogiri::HTML(open("http://www.secsports.com/standings/mens-basketball"))		
+		standings = doc.css("tbody") # nodeset of the table  of 14 teams
+		league = [] # create an empty array
 		standings.css("tr").each do |team_table|
+			# take data from each row of the table and build a team object
 			t = Team.new
 			t.name = team_table.css("a:first").text
 			t.url =  team_table.css("a:first").attr("href").text.strip
 			t.conf_record = team_table.css("td")[1].text
 			t.overall_record = team_table.css("td")[2].text
-			league << t
+			league << t # insert each team object into the array called league
 		end
-		league
+		league #return the league array
 	end
 
 def self.scrape_team_page(team)
+		# build up the schedul_url for a given team
 		schedule_url =  ("http://www.secsports.com" + team.url).gsub("clubhouse", "schedule")
 		doc = Nokogiri::HTML(open(schedule_url))
-		schedule = doc.css("#wrapper > div > main > section > div > section > div > div > div > div.panel-body > div > table > tbody")
+		schedule = doc.css("tbody") # scrape the schedule for that team
 		team.games = []		
-		schedule.css("tr").each do |game| 
-		  unless game.css("td")[0].text.strip == "* Game Played At Neutral Venue"
+		schedule.css("tr").each do |game| #iterate the schedule game by game
+		  unless game.css("td")[0].text.strip == "* Game Played At Neutral Venue" #if you see this string you have gone to far
+			  #build a game object for each line of game data
 			  g = Game.new
 			  g.date = game.css("td")[0].text
 			  g.opponent = game.css("td")[1].text  

data/lib/sec_mens_bball/version.rb

@@ -1,3 +1,3 @@
 module SecMensBball
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sec_mens_bball
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - halfields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler