killer_queen_scene_scoring 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3fffddeed7587fbc19cab2322b80d85a218a26d6dc948b15db8a653fbb954c5
-  data.tar.gz: 75fd1ed1d095ed0ce199512a754fc987a2a42b0c7f362b4617b334c35beb4c30
+  metadata.gz: d7f77f6799315d7f83d6983b58afdd4238e9fefec3b2b1373d44a544c609b0fa
+  data.tar.gz: 92a9376cabf9522a4f622ef254b12f235f7b9b4c6342c351c0d9ad0c6893b44a
 SHA512:
-  metadata.gz: f6ff2591b6f9bac96193317c02e70fc75c96fb191ed0cb93b93adc98e47f1eb0bd44430b3ac45589370983301ec82d02f47f73dda4b0db669f87c072dd6e1793
-  data.tar.gz: c4f1b932ce628944226b4fd48aabf7b1f15a93749eff8507635331b54ec169a22af1e5f6e3a0c2b65dc64affb1d7153200f555da2601b0ea5778d14041824114
+  metadata.gz: 97dbba12475dc82e9ff3e5232f06337535e42fe0f3cb9bcaa917c52a118ea3037c5d5d55fb2008f626f4e3f155968934818d1c12acb9e3cfdd49bc1e2ed04379
+  data.tar.gz: adc0b6dbb14ad7fb8f9ca6fc4534ba0f00f7c46a03b0d5bdb192304fa025e771ff0d3d445874f34c00912952d13159e027196150fa184745a0d52da8c6f63616

data/Gemfile.lock

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

data/exe/killer_queen_scene_scoring

@@ -23,7 +23,7 @@ unless id && api_key
     return
 end
 
-t = KillerQueenSceneScoring::Tournament.new(id: id, api_key: api_key)
+t = KillerQueenSceneScoring::Tournament.new(id: id, api_key: api_key, logger: true)
 t.load
 t.calculate_points
 puts t.scene_scores.sort

data/lib/killer_queen_scene_scoring/bracket.rb

@@ -8,9 +8,10 @@ class Bracket
     # `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:)
+    def initialize(id:, api_key:, logger:)
         @id = id
         @api_key = api_key
+        @logger = logger
         @loaded = false
         @state == ""
     end
@@ -31,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.
-            # TODO: Rails.logger.warn "The bracket does not exist."
+            @logger&.warn "The bracket does not exist."
             return false
         end
 
@@ -48,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?
-            # TODO: Rails.logger.warn "The bracket has not been started yet."
+            @logger&.warn "The bracket has not been started yet."
             return false
         end
 
@@ -85,7 +86,7 @@ class Bracket
     end
 
     def raise_error(msg)
-        # TODO: Rails.logger.error "ERROR: #{msg}"
+        @logger&.error "ERROR: #{msg}"
         raise msg
     end
 
@@ -117,7 +118,7 @@ class Bracket
         # instead start with "//".  Default to HTTPS.
         uri.scheme ||= "https"
 
-        # TODO: Rails.logger.debug "Reading the config file from #{uri}"
+        @logger&.debug "Reading the config file from #{uri}"
 
         # Read the config file from the attchment.
         config = send_get_request(uri.to_s)
@@ -140,8 +141,8 @@ class Bracket
             @teams << Team.new(team[:participant])
         end
 
-        # TODO: Rails.logger.info "#{@teams.size} teams are in the bracket: " +
-        #                  @teams.sort_by(&:name).map { |t| %("#{t.name}") }.join(", ")
+        @logger&.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
@@ -217,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?
-                # TODO: Rails.logger.info "Skipping a team that isn't in the bracket: #{team[:name]}"
+                @logger&.info "Skipping a team that isn't in the bracket: #{team[:name]}"
                 next
             end
 
@@ -225,8 +226,8 @@ class Bracket
                 @players[team_obj.id] << Player.new(player)
             end
 
-            # TODO: Rails.logger.info "#{team[:name]} (ID #{team_obj.id}) has: " +
-            #                  @players[team_obj.id].map { |p| "#{p.name} (#{p.scene})" }.join(", ")
+            @logger&.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.
@@ -263,12 +264,12 @@ class Bracket
         @teams.each do |team|
             matches_with_team = @matches.select { |match| match.has_team?(team.id) }
 
-            # TODO: Rails.logger.info "Team #{team.name} was in #{matches_with_team.size} matches"
+            @logger&.info "Team #{team.name} was in #{matches_with_team.size} matches"
 
             points_earned = matches_with_team.max_by(&:points).points
 
-            # TODO: Rails.logger.info "The largest point value of those matches is #{points_earned}" \
-            #                  "#{" + #{base_point_value} base" if base_point_value > 0}"
+            @logger&.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
@@ -281,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|
-            # TODO: Rails.logger.info "Awarding #{team.points} points to #{team.name}: " +
-            #                  @players[team.id].map(&:to_s).join(", ")
+            @logger&.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
@@ -313,9 +314,9 @@ class Bracket
             points_earned = final_rank_points[team.final_rank].sum /
                               final_rank_points[team.final_rank].size
 
-            # TODO: Rails.logger.info "#{team.name} finished in position #{team.final_rank}" \
-            #                  " and gets #{points_earned} points" \
-            #                  "#{" + #{base_point_value} base" if base_point_value > 0}"
+            @logger&.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

data/lib/killer_queen_scene_scoring/tournament.rb

@@ -9,13 +9,23 @@ class Tournament
     # tournament.  If you pass a slug, 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` can be a `Logger` object, or `true` to log to standard output.
+    def initialize(id:, api_key:, logger: nil)
         @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,
@@ -29,10 +39,10 @@ class Tournament
         all_brackets_loaded = true
 
         while tournament_id
-            # TODO: Rails.logger.debug "Reading the bracket \"#{tournament_id}\""
+            @logger&.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)
+            bracket = Bracket.new(id: tournament_id, api_key: @api_key, logger: @logger)
 
             if !bracket.load
                 all_brackets_loaded = false
@@ -56,7 +66,7 @@ class Tournament
                   players.map(&:name).join(", ")
             end
 
-            # TODO: Rails.logger.info scene_list.join("\n")
+            @logger&.info scene_list.join("\n")
             # <- end debug logging
 
             # Go to the next bracket in the chain.
@@ -70,7 +80,7 @@ class Tournament
 
         if values.count(values[0]) != values.size
             msg = "ERROR: All brackets must have the same \"max_players_to_count\"."
-            # TODO: Rails.logger.error msg
+            @logger&.error msg
             raise msg
         end
 
@@ -140,8 +150,8 @@ class Tournament
             if scores.size > max_players_to_count
                 dropped = scores.slice!(max_players_to_count..-1)
 
-                # TODO: Rails.logger.info "Dropping the #{dropped.size} lowest scores from #{scene}:" +
-                #                  dropped.join(", ")
+                @logger&.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.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killer_queen_scene_scoring
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Dunn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler