cool_soccer 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b3fd94f126775096201987af7f36fb3d66d9edb50e514b536c1af8d92cd5d68
+  data.tar.gz: ec3b056a6abe39c7f130d9d306b4e50e031e82b9c0c39ecc0c686cd5eb2d0019
+SHA512:
+  metadata.gz: 3854a4121220bc1b298bd1747801a5d087d780a2d37321bb1f9786bc0fd47be11d82faae40baa4288c50945359255197e2e99f09d12859bdcd14b0fa3bb7e547
+  data.tar.gz: f0725e89a483f9ac95819eb1a32cff5e5b6864caabbb7c35411ff0c40d537c6974d764ce842a539240f540588f3d10dfc35d8a8b471cdeed924fcd4361aaebe4

data/bin/cool_soccer

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/cool_soccer'
+
+app = CoolSoccer.new
+
+if !ARGV.empty?
+  file_path = ARGV[0]
+  File.foreach(file_path) do |line|
+    app.execute(line: line)
+  end
+else
+  $stdin.each_line 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?

data/lib/cool_soccer/soccer_helpers.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# SoccerHelpers is a module that provides a "functional core" to the program,
+# and allows us to answer discrete questions about the input/output of the program.
+module SoccerHelpers
+  # valid_game_result? answers the question: "Is a particular string a valid game result?"
+  #
+  # Valid game results consist of:
+  # Two team results, delimited by a comma, where each team result consists of:
+  # a team name (only alphabetic characters), and a score (only numeric characters).
+  #
+  # Game results are invalid if they only have one team, if they're missing a comma,
+  # if they have missing scores, or if they have missing team names.
+  #
+  # For example:
+  # Valid: "San Jose Earthquakes 3, Santa Cruz Slugs 3",
+  # Invalid: "San Jose Earthquakes 3", "San Jose Earthquakes, Santa Cruz Slugs",
+  #
+  # @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
+  end
+
+  # extract_team_and_score answers the question:
+  # "In this result string, what teams are included, and what did they score?"
+  # The response is a hash in the form:
+  # { 'San Jose Earthquakes' => 1, 'Santa Cruz Slugs' => 1 }
+  #
+  # As per the prompt, draws are worth one point,
+  # wins are worth 3 points, and losses are worth 0 points.
+  #
+  # @param result [String] the string to parse
+  # @return [Hash] a hash of team names and scores
+  def extract_team_and_score(result:)
+    # Split the string into two parts, separated by a comma
+    parts = result.split(',')
+
+    # Team names are everything in a given part,
+    # excluding any numeric characters.
+    # We preserve the whitespace between words,
+    # and we remove any leading or trailing whitespace.
+    team_names = parts.map { |part| part.gsub(/[^a-zA-Z ]/, '').strip }
+
+    # Scores are everything in a given part,
+    # excluding any non-numeric characters.
+    scores = parts.map { |part| part.gsub(/[^0-9]/, '').to_i }
+
+    # Compare the scores, and assign the win/loss/draw points.
+    scores = if scores[0] == scores[1]
+               [1, 1]
+             elsif scores[0] > scores[1]
+               [3, 0]
+             else
+               [0, 3]
+             end
+
+    # Zip the team names and scores together into a hash
+    Hash[team_names.zip(scores)]
+  end
+
+  # top_three answers the question: "What are the top three teams in the league?"
+  # It takes a hash of team names and scores, and returns the top three teams.
+  # If there are any ties in the top three, we return the tied teams in alphabetical order.
+  #
+  # 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
+
+    # Now we need to find the top three teams by score
+    sorted_scores = scores.sort_by { |_, score| score }.reverse
+
+    # Return only the top three
+    sorted_scores[0..2]
+  end
+
+  # update_leaderboard answers the question: "What is the new leaderboard, given a game result?"
+  # It takes a current leaderboard, and a game result as hashes.
+  # Then it updates the leaderboard - either adding a team's score if we haven't seen them,
+  # or incrementing a team's score if we have seen them.
+  #
+  # param leaderboard [Hash] the current leaderboard
+  # param changes [Hash] the changes to make to the leaderboard
+  # @return [Hash] the updated leaderboard
+  def update_leaderboard(leaderboard:, changes:)
+    # Make a copy of the leaderboard
+    new_leaderboard = leaderboard.clone || {}
+
+    # Loop through the changes, and update the leaderboard with the changes
+    changes.each do |team, score|
+      if new_leaderboard.key?(team)
+        new_leaderboard[team] += score
+      else
+        new_leaderboard[team] = score
+      end
+    end
+
+    # Return the updated leaderboard
+    new_leaderboard
+  end
+
+  # format_match_day answers the question of: "How would we format the match day results?"
+  # It takes an integer representing the current match day,
+  # and a hash of team names and scores that represent the current leaderboard.
+  # It returns a string in the format of expected-output.txt
+  #
+  # param day [Integer] the day number of the recently concluded day
+  # param leaderboard [Hash] the current leaderboard
+  # @return [String] the formatted leaderboard
+  def format_match_day(day:, leaderboard:)
+    # Get the top three from the leaderboard
+    leaders = top_three(scores: leaderboard)
+
+    # Format the output
+    output = "Matchday #{day}\n"
+    leaders.each do |leader|
+      # If it's just one point, we use `pt`, otherwise, we use `pts`
+      ordinal_points = leader[1] == 1 ? 'pt' : 'pts'
+      output += "#{leader[0]}, #{leader[1]} #{ordinal_points}\n"
+    end
+
+    # Return the output
+    output
+  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
+  #
+  # 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).
+  #
+  # Using named params helps make the long parameter list manageable:
+  # callers will get specific error messages if they pass in the wrong params.
+  #
+  # 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
+  end
+end

data/lib/cool_soccer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'cool_soccer/soccer_helpers'
+
+# CoolSoccer is an "imperative shell"
+# that allows the CLI to read a stream of game results from a soccer league,
+# and return the top teams at the end of each matchday.
+class CoolSoccer
+  include SoccerHelpers
+  attr_accessor :leaderboard, :match_day, :num_teams, :games_today
+
+  # When this class is instantiated, we want to provide it with some default instance variables.
+  def initialize
+    # First, let's keep track of a leaderboard, and initialize it as an empty hash.
+    @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
+  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)
+
+    # 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)
+
+      # 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
+      @match_day += 1
+      @games_today = 1
+    end
+
+    # Add the scores to the leaderboard
+    @leaderboard = update_leaderboard(leaderboard: @leaderboard, changes: scores)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: cool_soccer
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Tyler Williams
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.29.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+description: |2
+      A command-line application that reads a listing of game results for a soccer league as a stream,
+      and returns the top teams at the end of each matchday.
+email: tyler@coolsoftware.dev
+executables:
+- cool_soccer
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cool_soccer
+- lib/cool_soccer.rb
+- lib/cool_soccer/soccer_helpers.rb
+homepage: https://rubygems.org/gems/cool_soccer
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Tyler Williams Jane Technologies Coding Challenge
+test_files: []