killer_queen_scene_scoring 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 040d02050af60eacc192dd7e2816874108af9a0cbea0b105669f302521824197
-  data.tar.gz: 9474fc2dfd47098250be9a903f019c772220876c5e20f1b900dda17b8f9997c4
+  metadata.gz: f2624dd8d6e07571ec2723fdf15598e2cbe1e8b2538559bec4b7a1855aadb546
+  data.tar.gz: 8fa7d60d1cee314eadc18a4253a2928a61d2eb31b83b30f662f3b3166f4fdc37
 SHA512:
-  metadata.gz: e74722718054d602614cab6cedb626f7625f74efc5b78af803c57042c555998986fb39e5c24c9ecfb161fa680ad144eb88c9c767865393f09fa0443d201f8f6b
-  data.tar.gz: 9468a376b4c0d18a915e351f3e6b5606606eed02c6ce3df71e8c224a0c5753193edb6bfe733bdc7a8fbf8f1956b4a3cdd68bff0c2356e6f3a37b895e30465ca8
+  metadata.gz: 41e3e9de1c70de42055ce87e3c1287d6927364aefb9cb035b04e7e20ef889828a5120655e49fe795864bc1c686cd9ad9e6d64bdb48d2839f337011ef91213ee4
+  data.tar.gz: 7f5fc09649d1681840b1f90e39eff167672c823a2b75de38e0b43332fa7f0bb6335d9ff660a415e3cf08daeaa1980e6205a43aa72e5fa2367d875a9f04c84808

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killer_queen_scene_scoring (0.3.1)
+    killer_queen_scene_scoring (0.3.2)
       dotenv (~> 2.7)
       json (~> 2.2)
       rest-client (~> 2.0)

data/lib/killer_queen_scene_scoring.rb

@@ -1,6 +1,7 @@
 require "dotenv/load"
 require "json"
 require "rest-client"
+require "killer_queen_scene_scoring/base.rb"
 require "killer_queen_scene_scoring/bracket.rb"
 require "killer_queen_scene_scoring/config"
 require "killer_queen_scene_scoring/match"
@@ -11,8 +12,4 @@ require "killer_queen_scene_scoring/tournament"
 require "killer_queen_scene_scoring/version"
 
 module KillerQueenSceneScoring
-    # Creates a hash whose values are arrays.
-    def self.hash_of_arrays
-        Hash.new { |h, k| h[k] = [] }
-    end
 end

data/lib/killer_queen_scene_scoring/base.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Base
+    attr_reader :api_key, :logger
+
+    def initialize(api_key, logger = nil)
+        @api_key = api_key
+
+        @logger = case logger
+                      when true
+                          Logger.new(STDOUT, progname: "KillerQueenSceneScoring")
+                      when Logger
+                          logger
+                      else
+                          nil
+                  end
+    end
+
+    # Creates a hash whose values are arrays.
+    def hash_of_arrays
+        Hash.new { |h, k| h[k] = [] }
+    end
+
+    def log_debug(msg)
+        @logger&.debug msg
+    end
+
+    def log_info(msg)
+        @logger&.info msg
+    end
+
+    def log_warn(msg)
+        @logger&.warn msg
+    end
+
+    def log_error(msg)
+        @logger&.error msg
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/bracket.rb

@@ -2,16 +2,16 @@
 
 module KillerQueenSceneScoring
 
-class Bracket
+class Bracket < Base
     attr_reader :players, :config
 
     # `id` can be the slug or the challonge ID of the bracket.  If you pass a
     #  and the bracket is owned by an organization, it must be of the form
     # "<org name>-<slug>".  `api_key` is your Challonge API key.
     def initialize(id:, api_key:, logger:)
+        super(api_key, logger)
+
         @id = id
-        @api_key = api_key
-        @logger = logger
         @loaded = false
         @state == ""
     end
@@ -32,7 +32,7 @@ class Bracket
         rescue RestClient::NotFound
             # Bail out if we got a 404 error.  The bracket doesn't exist on
             # Challonge right now, but it might be created in the future.
-            @logger&.warn "The bracket does not exist."
+            log_warn "The bracket does not exist."
             return false
         end
 
@@ -49,7 +49,7 @@ class Bracket
         # bracket, and set `next_bracket` in the wild card bracket to the ID
         # of the finals bracket before the wild card bracket has finished.
         if @challonge_bracket.started_at.nil?
-            @logger&.warn "The bracket has not been started yet."
+            log_warn "The bracket has not been started yet."
             return false
         end
 
@@ -86,7 +86,7 @@ class Bracket
     end
 
     def raise_error(msg)
-        @logger&.error "ERROR: #{msg}"
+        log_error "ERROR: #{msg}"
         raise msg
     end
 
@@ -118,7 +118,7 @@ class Bracket
         # instead start with "//".  Default to HTTPS.
         uri.scheme ||= "https"
 
-        @logger&.debug "Reading the config file from #{uri}"
+        log_debug "Reading the config file from #{uri}"
 
         # Read the config file from the attchment.
         config = send_get_request(uri.to_s)
@@ -141,8 +141,8 @@ class Bracket
             @teams << Team.new(team[:participant])
         end
 
-        @logger&.info "#{@teams.size} teams are in the bracket: " +
-                      @teams.sort_by(&:name).map { |t| %("#{t.name}") }.join(", ")
+        log_info "#{@teams.size} teams are in the bracket: " +
+                 @teams.sort_by(&:name).map { |t| %("#{t.name}") }.join(", ")
 
         # Check that all of the teams in the bracket are also in the config file.
         # We do case-insensitive name comparisons to allow for different
@@ -205,7 +205,7 @@ class Bracket
     # Each key is a Challonge ID of a team, and each value is an array of
     # `Player` objects for the players on that team.
     def read_players
-        @players = KillerQueenSceneScoring::hash_of_arrays
+        @players = hash_of_arrays
 
         # Read the team list from the config file and create structs for each
         # player on each team.
@@ -218,7 +218,7 @@ class Bracket
             # isn't in the bracket.  We allow this so that multiple brackets can
             # use the same master team list during a tournament.
             if team_obj.nil?
-                @logger&.info "Skipping a team that isn't in the bracket: #{team[:name]}"
+                log_info "Skipping a team that isn't in the bracket: #{team[:name]}"
                 next
             end
 
@@ -226,8 +226,8 @@ class Bracket
                 @players[team_obj.id] << Player.new(player)
             end
 
-            @logger&.info "#{team[:name]} (ID #{team_obj.id}) has: " +
-                          @players[team_obj.id].map { |p| "#{p.name} (#{p.scene})" }.join(", ")
+            log_info "#{team[:name]} (ID #{team_obj.id}) has: " +
+                     @players[team_obj.id].map { |p| "#{p.name} (#{p.scene})" }.join(", ")
         end
 
         # Bail out if any team doesn't have exactly 5 players.
@@ -264,12 +264,12 @@ class Bracket
         @teams.each do |team|
             matches_with_team = @matches.select { |match| match.has_team?(team.id) }
 
-            @logger&.info "Team #{team.name} was in #{matches_with_team.size} matches"
+            log_info "Team #{team.name} was in #{matches_with_team.size} matches"
 
             points_earned = matches_with_team.max_by(&:points).points
 
-            @logger&.info "The largest point value of those matches is #{points_earned}" \
-                            "#{" + #{base_point_value} base" if base_point_value > 0}"
+            log_info "The largest point value of those matches is #{points_earned}" \
+                       "#{" + #{base_point_value} base" if base_point_value > 0}"
 
             team.points = points_earned + base_point_value
         end
@@ -282,8 +282,8 @@ class Bracket
         # the debug output will follow the teams' finishing order, which will be
         # easier to read.
         @teams.sort_by(&:points).reverse_each do |team|
-            @logger&.info "Awarding #{team.points} points to #{team.name}: " +
-                          @players[team.id].map(&:to_s).join(", ")
+            log_info "Awarding #{team.points} points to #{team.name}: " +
+                     @players[team.id].map(&:to_s).join(", ")
 
             @players[team.id].each do |player|
                 player.points = team.points
@@ -302,7 +302,7 @@ class Bracket
         # points respectively.  The two teams in 5th get 1.5, the average of 2 and 1.
         sorted_teams = @teams.sort_by(&:final_rank)
         num_teams = sorted_teams.size.to_f
-        final_rank_points = KillerQueenSceneScoring::hash_of_arrays
+        final_rank_points = hash_of_arrays
 
         sorted_teams.each_with_index do |team, idx|
             final_rank_points[team.final_rank] << num_teams - idx
@@ -314,9 +314,9 @@ class Bracket
             points_earned = final_rank_points[team.final_rank].sum /
                               final_rank_points[team.final_rank].size
 
-            @logger&.info "#{team.name} finished in position #{team.final_rank}" \
-                            " and gets #{points_earned} points" \
-                            "#{" + #{base_point_value} base" if base_point_value > 0}"
+            log_info "#{team.name} finished in position #{team.final_rank}" \
+                       " and gets #{points_earned} points" \
+                       "#{" + #{base_point_value} base" if base_point_value > 0}"
 
             team.points = points_earned + base_point_value
         end
@@ -325,7 +325,7 @@ class Bracket
     # Sends a GET request to `url`, treats the returned data as JSON, parses it
     # into an object, and returns that object.
     def send_get_request(url, params = {})
-        params[:api_key] = @api_key
+        params[:api_key] = api_key
         resp = RestClient.get(url, params: params)
 
         JSON.parse(resp, symbolize_names: true)

data/lib/killer_queen_scene_scoring/config.rb

@@ -2,6 +2,8 @@
 
 module KillerQueenSceneScoring
 
+# `Config` holds the contents of the config file that is read from a
+# attachment in a bracket.
 class Config
     attr_reader :base_point_value, :next_bracket, :max_players_to_count,
                 :match_values, :teams

data/lib/killer_queen_scene_scoring/tournament.rb

@@ -2,7 +2,7 @@
 
 module KillerQueenSceneScoring
 
-class Tournament
+class Tournament < Base
     attr_reader :scene_scores, :complete
 
     # `id` can be the slug or the challonge ID of the first bracket in the
@@ -11,21 +11,13 @@ class Tournament
     # `api_key` is your Challonge API key.
     # `logger` can be a `Logger` object, or `true` to log to standard output.
     def initialize(id:, api_key:, logger: nil)
+        super(api_key, logger)
+
         @brackets = []
         @scene_scores = []
         @loaded = false
         @complete = false
         @id = id
-        @api_key = api_key
-
-        @logger = case logger
-                      when true
-                          Logger.new(STDOUT, progname: "KillerQueenSceneScoring")
-                      when Logger
-                          logger
-                      else
-                          nil
-                  end
     end
 
     # Reads the Challonge bracket with the ID that was passed to the constructor,
@@ -39,10 +31,10 @@ class Tournament
         all_brackets_loaded = true
 
         while tournament_id
-            @logger&.debug "Reading the bracket \"#{tournament_id}\""
+            log_debug "Reading the bracket \"#{tournament_id}\""
 
             # Load the next bracket in the chain.  Bail out if we can't load it.
-            bracket = Bracket.new(id: tournament_id, api_key: @api_key, logger: @logger)
+            bracket = Bracket.new(id: tournament_id, api_key: api_key, logger: logger)
 
             if !bracket.load
                 all_brackets_loaded = false
@@ -53,7 +45,7 @@ class Tournament
             @brackets << bracket
 
             # For debugging purposes, log the players in each scene ->
-            scenes = KillerQueenSceneScoring::hash_of_arrays
+            scenes = hash_of_arrays
 
             bracket.players.each_value do |team|
                 team.each do |player|
@@ -66,7 +58,7 @@ class Tournament
                   players.map(&:name).join(", ")
             end
 
-            @logger&.info scene_list.join("\n")
+            log_info scene_list.join("\n")
             # <- end debug logging
 
             # Go to the next bracket in the chain.
@@ -80,7 +72,7 @@ class Tournament
 
         if values.count(values[0]) != values.size
             msg = "ERROR: All brackets must have the same \"max_players_to_count\"."
-            @logger&.error msg
+            log_error msg
             raise msg
         end
 
@@ -133,7 +125,7 @@ class Tournament
         # Assemble the scores from the players in each scene.
         # `scene_players_scores` is a hash from a scene name to an array that
         # holds the scores of all the players in that scene.
-        scene_players_scores = KillerQueenSceneScoring::hash_of_arrays
+        scene_players_scores = hash_of_arrays
 
         player_scores.each_value do |player|
             scene_players_scores[player.scene] << player.points
@@ -150,8 +142,8 @@ class Tournament
             if scores.size > max_players_to_count
                 dropped = scores.slice!(max_players_to_count..-1)
 
-                @logger&.info "Dropping the #{dropped.size} lowest scores from #{scene}:" +
-                              dropped.join(", ")
+                log_info "Dropping the #{dropped.size} lowest scores from #{scene}:" +
+                         dropped.join(", ")
             end
 
             # Add up the scores for this scene.

data/lib/killer_queen_scene_scoring/version.rb

@@ -1,3 +1,3 @@
 module KillerQueenSceneScoring
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: killer_queen_scene_scoring
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Michael Dunn
@@ -142,6 +142,7 @@ files:
 - exe/killer_queen_scene_scoring
 - killer_queen_scene_scoring.gemspec
 - lib/killer_queen_scene_scoring.rb
+- lib/killer_queen_scene_scoring/base.rb
 - lib/killer_queen_scene_scoring/bracket.rb
 - lib/killer_queen_scene_scoring/config.rb
 - lib/killer_queen_scene_scoring/match.rb