cool_soccer 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3fd94f126775096201987af7f36fb3d66d9edb50e514b536c1af8d92cd5d68
-  data.tar.gz: ec3b056a6abe39c7f130d9d306b4e50e031e82b9c0c39ecc0c686cd5eb2d0019
+  metadata.gz: f9c5dd5b67b28fb8a8cb8e6eeced481d22f2a83d8848bd64c0c0ea4a59e91d7e
+  data.tar.gz: 8f7d990484715db577b1da34959bfdade276d66440c2122ed2221b11d8ef8539
 SHA512:
-  metadata.gz: 3854a4121220bc1b298bd1747801a5d087d780a2d37321bb1f9786bc0fd47be11d82faae40baa4288c50945359255197e2e99f09d12859bdcd14b0fa3bb7e547
-  data.tar.gz: f0725e89a483f9ac95819eb1a32cff5e5b6864caabbb7c35411ff0c40d537c6974d764ce842a539240f540588f3d10dfc35d8a8b471cdeed924fcd4361aaebe4
+  metadata.gz: 15e7bf21c7578cf1af656c2279916a48100b56e3ae7bae65456d3fa05ff1d6f5f15a6989192ddd594752e3e5aaecab2f413a08a51530d8c2e221896e25d9c4c8
+  data.tar.gz: f34e9ae6c2f8991a5e7d6fdb289f78a39722daf7f7590727269f95fce52c01b22541c53f61fde2543e75aa44add585e0061b383c15f0b92ed3535eadcc208a0c

data/bin/cool_soccer

@@ -3,19 +3,31 @@
 
 require_relative '../lib/cool_soccer'
 
+# If there are more than one arguments, exit with an error message.
+if ARGV.length > 1
+  puts 'Too many arguments. Expected to be passed a stream, or a path to a single file'
+  exit 1
+end
+
+# If the file at ARGV[0] does not exist, exit with an error message.
+if ARGV[0] && !File.exist?(ARGV[0])
+  puts "The file #{ARGV[0]} does not exist"
+  exit 1
+end
+
 app = CoolSoccer.new
 
-if !ARGV.empty?
-  file_path = ARGV[0]
-  File.foreach(file_path) do |line|
+if ARGV.empty?
+  $stdin.each_line do |line|
     app.execute(line: line)
   end
 else
-  $stdin.each_line do |line|
+  file_path = ARGV[0]
+  File.foreach(file_path) do |line|
     app.execute(line: line)
   end
-
-  # If we haven't reset the games_today to 0, we stopped before the end of a match day,
-  # so we need to print out the current top three
 end
-puts app.format_match_day(day: app.match_day, leaderboard: app.leaderboard) if app.games_today.positive?
+
+# If the input stops, we should print the final standings as the last match day,
+# since it will be incomplete.
+puts app.format_match_day(day: app.match_day, leaderboard: app.leaderboard)

data/lib/cool_soccer/soccer_helpers.rb

@@ -16,22 +16,12 @@ module SoccerHelpers
   # Valid: "San Jose Earthquakes 3, Santa Cruz Slugs 3",
   # Invalid: "San Jose Earthquakes 3", "San Jose Earthquakes, Santa Cruz Slugs",
   #
+  # We validate the input string with a regular expression, /([a-z-A-Z ]+)(\d+), ([a-zA-Z ]+)(\d+)/
+  #
   # @param result [String] the string to validate
   # @return [Boolean] is the input string a valid game result string?
   def valid_game_result?(result:)
-    # Make sure this string has two parts, delimited by a comment
-    parts = result.split(',')
-    return false if parts.length != 2
-
-    # For each part, make sure it contains some numeric value, the value is an integer,
-    # and we have a team name that consists of alphabetic characters.
-    parts.each do |part|
-      return false if part.count('0-9').zero?
-      return false if part.count('a-zA-Z').zero?
-    end
-
-    # If we have passed all of the above checks, then the string is a valid game result
-    true
+    result.match?(/^([a-zA-Z ]+)(\d+), ([a-zA-Z ]+)(\d+)$/)
   end
 
   # extract_team_and_score answers the question:
@@ -68,7 +58,7 @@ module SoccerHelpers
              end
 
     # Zip the team names and scores together into a hash
-    Hash[team_names.zip(scores)]
+    team_names.zip(scores).to_h
   end
 
   # top_three answers the question: "What are the top three teams in the league?"
@@ -78,13 +68,17 @@ module SoccerHelpers
   # param scores [Hash] a hash of team names and scores
   # @return [Array] an array of the top three teams, in the format [team, score]
   def top_three(scores:)
-    # Alphabetize by team name
-    scores = scores.sort_by { |name, _| name }.reverse
+    # Each item in scores has a key that corresponds to the team name,
+    # and a value that corresponds to the score.
+    # We want to sort the scores in descending order,
+    # and then take the top three scores.
+    #
+    # If there are any ties in the score, we want to return the tied teams in alphabetical order.
 
-    # Now we need to find the top three teams by score
-    sorted_scores = scores.sort_by { |_, score| score }.reverse
+    # sort_by allows us to do a keyed sort over a hash, with multiple criteria
+    sorted_scores = scores.sort_by { |name, score| [-score, name] }
 
-    # Return only the top three
+    # Just return the top three from the sorted order
     sorted_scores[0..2]
   end
 
@@ -138,35 +132,18 @@ module SoccerHelpers
   end
 
   # match_day_over answers the question: "Is the match day over?"
-  # There are two scenarios where the match day is over:
-  # 1. It is match day 1, and the leaderboard already has a key that matches one of the input scores teams
-  # 2. It is any match day past 1, and the number of games today is equal to num_teams / 2
+  # It takes two Sets, teams_in_day, which represents the teams we've seen in a current day,
+  # and teams_in_match, which represents the teams from a match string
   #
-  # This function takes a lot of parameters, which I don't love,
-  # but I prefer to call one function, rather than have two similar functions,
-  # (one for match day 1, and one for match day 2 and beyond).
+  # Then it returns whether or not any of the teams in teams_in_match already exist in teams_in_day.
   #
-  # Using named params helps make the long parameter list manageable:
-  # callers will get specific error messages if they pass in the wrong params.
+  # There is a different, slightly faster, but less readable solve for this.
+  # You can see a different approach in the diffs at https://gitlab.com/coolsoftwaretyler/coding-challenge-soccer/-/merge_requests/1
   #
-  # param leaderboard [Hash] the current leaderboard
-  # param scores [Hash] the scores of the current match day
-  # param match_day [Integer] the current match day
-  # param num_teams [Integer] the number of teams in the league
-  # param games_today [Integer] the number of games played today
-  # @return [Boolean] is the current match day over?
-  def match_day_over?(leaderboard:, scores:, match_day:, num_teams:, games_today:)
-    # If this is the first match day, and the leaderboard already has a key that matches one of the input scores teams,
-    # then the match day is over
-    return true if match_day == 1 && leaderboard.key?(scores.keys.first)
-
-    return true if match_day == 1 && leaderboard.key?(scores.keys.last)
-
-    # If this is any match day past 1, and the number of games today is equal to num_leagues / 2,
-    # then the match day is over
-    return true if match_day > 1 && games_today == num_teams / 2
-
-    # Otherwise, the match day is not over yet.
-    false
+  # @param teams [Set] the teams in the current match
+  # @param teams_in_match [Set] the teams in the current match
+  # @return [Boolean] is the match day over?
+  def match_day_over?(teams_in_day:, teams_in_match:)
+    teams_in_day.intersection(teams_in_match).any?
   end
 end

data/lib/cool_soccer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'cool_soccer/soccer_helpers'
+require 'set'
 
 # CoolSoccer is an "imperative shell"
 # that allows the CLI to read a stream of game results from a soccer league,
@@ -15,39 +16,33 @@ class CoolSoccer
     @leaderboard = {}
     # We'll also keep track of the current match day, initialized at 1
     @match_day = 1
-    # And we'll want to know how many teams are in the league. At first,
-    # we'll initialize this at 0.
-    @num_teams = 0
-    # Finally, we'll want to know how many games we've seen today,
-    # which we'll initialize at 0.
-    @games_today = 0
+    # We'll also have a Set that keeps tracks of the teams in a given day
+    @teams_in_day = Set.new
   end
 
   def execute(line:)
     # If the line is invalid, skip it
     return unless valid_game_result?(result: line)
 
-    # Increment the number of games we've played today
-    @games_today += 1
-
-    # If it's still match day 1, increment the number of teams by 2
-    @num_teams += 2 if @match_day == 1
-
     # Extract the team names and scores from the line
     scores = extract_team_and_score(result: line)
 
+    # From the scores, create a new set of team names in the given match
+    teams_in_match = Set.new(scores.keys)
+
     # Check if the match day is over
-    if match_day_over?(leaderboard: @leaderboard, scores: scores, match_day: @match_day, num_teams: @num_teams,
-                       games_today: @games_today)
+    if match_day_over?(teams_in_day: @teams_in_day, teams_in_match: teams_in_match)
 
       # Print out the current top three
       puts "#{format_match_day(day: @match_day, leaderboard: @leaderboard)}\n"
 
-      # If so, increment the match day and reset the games today counter
+      # If so, increment the match day and reset the teams_in_day set
       @match_day += 1
-      @games_today = 1
+      @teams_in_day = Set.new
     end
 
+    # Add the teams_in_match to the teams_in_day set
+    @teams_in_day.merge(teams_in_match)
     # Add the scores to the leaderboard
     @leaderboard = update_leaderboard(leaderboard: @leaderboard, changes: scores)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cool_soccer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Williams
@@ -44,6 +44,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.29.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +93,8 @@ files:
 homepage: https://rubygems.org/gems/cool_soccer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -82,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="