killer_queen_scene_scoring 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d33202ac0d276376a6f6a5b044ff7c7780599eba401c8046359390cca7b0677e
+  data.tar.gz: e435962c1fd937190dc49cf950b5bfea1dd54d0aeab5f6431892330fe265ab9d
+SHA512:
+  metadata.gz: 9f0190a641d7e30c18d8c4a7d653d48360df7b45337ccc4266115192889c48509296374ebcb51f938108c6d4fc72f52f1d9bca88017fb93d4311247a1d41aba1
+  data.tar.gz: b39af761fbb5a74829b228b7bdcae7d732a0e99fa5a9b8cdfa6aec7bf66e28f6faf71fef3411479f3458143c85d30f208960cfc538391111fa92b381ef8a4951

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.gem
+.env

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+ruby "2.6.0"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in killer_queen_scene_scoring.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    killer_queen_scene_scoring (0.1.0)
+      dotenv (~> 2.7)
+      json (~> 2.2)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.1)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.2.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  killer_queen_scene_scoring!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+RUBY VERSION
+   ruby 2.6.0p0
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Michael Dunn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# KillerQueenSceneScoring
+
+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/killer_queen_scene_scoring`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'killer_queen_scene_scoring'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install killer_queen_scene_scoring
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/killer_queen_scene_scoring.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "killer_queen_scene_scoring"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/killer_queen_scene_scoring

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require "killer_queen_scene_scoring"
+
+id = ARGV[0]
+api_key = ENV["CHALLONGE_API_KEY"] || ARGV[1]
+
+unless id && api_key
+    puts <<~EOS
+        Usage: #{File.basename __FILE__} <bracket_id> <api_key>
+
+        bracket_id is the slug or numeric ID of the first bracket in the tournament.
+        api_key is your Challonge API key.
+
+        If you don't have a tournament ready, you can try one of these, which have
+        already been set up: tvtpeasf clonekqxxv bb3wc
+
+        For convenience, you can create a .env file in the current directory and
+        store your API key in that file.  The file should have this line:
+          CHALLONGE_API_KEY=Your_API_key_here
+    EOS
+
+    return
+end
+
+t = KillerQueenSceneScoring::Tournament.new(id: id, api_key: api_key)
+t.load
+t.calculate_points
+puts t.scene_scores.sort

data/killer_queen_scene_scoring.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "date"
+require "killer_queen_scene_scoring/version"
+
+Gem::Specification.new do |spec|
+    spec.name = "killer_queen_scene_scoring"
+    spec.version = KillerQueenSceneScoring::VERSION
+    spec.authors = ["Michael Dunn"]
+    spec.email = ["acidhelm@gmail.com"]
+
+    spec.summary = "Scene-wide scoring for Killer Queen tournaments."
+    spec.description = "Classes that implement scene-wide scoring for Killer Queen tournaments."
+    spec.homepage = "https://github.com/acidhelm/killer_queen_scene_scoring"
+    spec.license = "MIT"
+
+    if spec.respond_to?(:metadata)
+        spec.metadata["allowed_push_host"] = "https://rubygems.org"
+        spec.metadata["homepage_uri"] = spec.homepage
+        spec.metadata["source_code_uri"] = spec.homepage
+        # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+    else
+        raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    end
+
+    # Specify which files should be added to the gem when it is released.
+    spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+        `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+    end
+
+    spec.bindir = "exe"
+    spec.executables = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+    spec.require_paths = ["lib"]
+
+    spec.add_development_dependency "bundler", "~> 1.17"
+    spec.add_development_dependency "minitest", "~> 5.0"
+    spec.add_development_dependency "rake", "~> 10.0"
+
+    spec.add_runtime_dependency "dotenv", "~> 2.7"
+    spec.add_runtime_dependency "json", "~> 2.2"
+    spec.add_runtime_dependency "rest-client", "~> 2.0"
+end

data/lib/killer_queen_scene_scoring.rb

@@ -0,0 +1,18 @@
+require "dotenv/load"
+require "json"
+require "rest-client"
+require "killer_queen_scene_scoring/bracket.rb"
+require "killer_queen_scene_scoring/config"
+require "killer_queen_scene_scoring/match"
+require "killer_queen_scene_scoring/player"
+require "killer_queen_scene_scoring/scene"
+require "killer_queen_scene_scoring/team"
+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/bracket.rb

@@ -0,0 +1,334 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Bracket
+    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:)
+        @id = id
+        @api_key = api_key
+        @loaded = false
+        @state == ""
+    end
+
+    def complete?
+        @state == "complete"
+    end
+
+    # Reads the Challonge bracket with the ID that was passed to the constructor,
+    # and fills in all the data structures that represent that bracket.
+    # Returns a boolean indicating whether the bracket was loaded.
+    def load
+        url = "https://api.challonge.com/v1/tournaments/#{@id}.json"
+        params = { include_matches: 1, include_participants: 1 }
+
+        begin
+            response = send_get_request(url, params)
+        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."
+            return false
+        end
+
+        # Set `@challonge_bracket` to the data structure that represents the
+        # bracket, its teams, and its matches.  We also keep the bracket's
+        # state separately, for convenience.
+        @challonge_bracket = OpenStruct.new(response[:tournament])
+        @state = @challonge_bracket.state
+
+        # Bail out if the bracket hasn't started yet.  This lets the tournament
+        # organizer set the `next_bracket` value to a bracket that has been
+        # created on Challonge, but which will be started in the future.  For
+        # example, the organizer can create a wild card bracket and a finals
+        # 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."
+            return false
+        end
+
+        # Read all the things.
+        read_config
+        read_teams
+        read_matches
+        read_players
+
+        @loaded = true
+        true
+    end
+
+    # Calculates how many points each player has earned in this bracket.  If the
+    # bracket is not yet complete, the point values are the mininum number of
+    # points that the player can earn based on their current position in
+    # the bracket.
+    # On exit, `@players` contains a hash.  The keys are the Challonge IDs of
+    # the teams in the bracket.  The values are arrays of `Player` objects
+    # representing the players on the team.
+    # The caller must call `load`, and `load` must succeed, before calling this
+    # function.
+    def calculate_points
+        raise_error "The bracket was not loaded" if !@loaded
+
+        calculate_team_points
+        calculate_player_points
+    end
+
+    protected
+
+    def finalizable?
+        @state == "awaiting_review"
+    end
+
+    def raise_error(msg)
+        # TODO: Rails.logger.error "ERROR: #{msg}"
+        raise msg
+    end
+
+    # Reads the config file from the bracket.
+    def read_config
+        # Find the match that has the config file attached to it.  By convention,
+        # the file is attached to the first match, although we don't enforce that.
+        # We just look for a match with exactly one attachment.  We do require
+        # that exactly one match have exactly one attachment.
+        first_match = @challonge_bracket.matches.select do |match|
+            match[:match][:attachment_count] == 1
+        end
+
+        raise_error "No matches with one attachment were found in the bracket" if first_match.empty?
+        raise_error "Multiple matches have one attachment" if first_match.size > 1
+
+        # Read the options from the config file that's attached to that match.
+        url = "https://api.challonge.com/v1/tournaments/#{@id}/matches/" \
+                "#{first_match[0][:match][:id]}/attachments.json"
+
+        attachment_list = send_get_request(url)
+        asset_url = attachment_list[0][:match_attachment][:asset_url]
+
+        raise_error "Couldn't find the config file attachment" if asset_url.nil?
+
+        uri = URI(asset_url)
+
+        # The attachment URLs that Challonge returns don't have a scheme, and
+        # instead start with "//".  Default to HTTPS.
+        uri.scheme ||= "https"
+
+        # TODO: Rails.logger.debug "Reading the config file from #{uri}"
+
+        # Read the config file from the attchment.
+        config = send_get_request(uri.to_s)
+
+        # Ensure that the required values are in the config file.
+        %i(base_point_value max_players_to_count match_values).each do |key|
+            raise_error "The config file is missing \"#{key}\"" unless config.key?(key)
+        end
+
+        @config = Config.new(config)
+    end
+
+    # Reads the teams that are in this bracket, and sets `@teams` to an array
+    # of `Team` objects.
+    def read_teams
+        @teams = []
+
+        # Make a `Team` for each participant in the bracket.
+        @challonge_bracket.participants.each do |team|
+            @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(", ")
+
+        # 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
+        # capitalizations of prepositions and articles.  This is fine, because
+        # two teams' names will never be the same except for case.
+        missing_teams = []
+        config_team_names = @config.teams.map { |t| t[:name] }
+
+        @teams.each do |team|
+            if config_team_names.none? { |name| name.casecmp?(team.name) }
+                missing_teams << team.name
+            end
+        end
+
+        if missing_teams.any?
+            raise_error "These teams are in the bracket but not the config file: " +
+                        missing_teams.join(", ")
+        end
+    end
+
+    # Reads the matches that are in this bracket, and sets `@matches` to an array
+    # of `Match` objects.
+    def read_matches
+        # Check that `match_values` in the config file is the right size.
+        # The size must normally equal the number of matches.  However, if the
+        # bracket is complete (finalized, or not finalized but all matches have
+        # been played) and it is double-elimination, then the array size is
+        # allowed to be one more than the number of matches, to account for a grand
+        # final that was only one match long.
+        #
+        # TODO: Also check that grand_finals_modifier is not set.
+        #
+        # If this is a two-stage bracket, the matches in the first stage have
+        # `suggested_play_order` set to nil, so don't consider those matches.
+        # If there is a match for 3rd place, its `suggested_play_order` is nil.
+        # We also ignore that match, and instead, we award points to the 3rd-place
+        # and 4th-place teams after the bracket has finished.
+        @matches = []
+        elim_stage_matches =
+            @challonge_bracket.matches.select { |m| m[:match][:suggested_play_order] }
+        num_matches = elim_stage_matches.size
+        config_array_size = @config.match_values.size
+
+        if num_matches != config_array_size
+            if !(complete? || finalizable?) ||
+               @challonge_bracket.tournament_type != "double elimination" ||
+               config_array_size != num_matches + 1
+                raise_error "match_values in the config file is the wrong size." \
+                              " The size is #{config_array_size}, expected #{num_matches}."
+            end
+        end
+
+        # Make a `Match` for each match in the bracket.
+        elim_stage_matches.each do |match|
+            @matches << Match.new(match[:match], @config.match_values)
+        end
+    end
+
+    # Reads the players that are in this bracket, and sets `@players` to a hash.
+    # 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
+
+        # Read the team list from the config file and create structs for each
+        # player on each team.
+        @config.teams.each do |team|
+            # Look up the team in the `@teams` array.  This is how we associate a
+            # team in the config file with its Challonge ID.
+            team_obj = @teams.find { |t| t.name.casecmp?(team[:name]) }
+
+            # If the `find` call failed, then there is a team in the team list that
+            # 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]}"
+                next
+            end
+
+            team[:players].each do |player|
+                @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(", ")
+        end
+
+        # Bail out if any team doesn't have exactly 5 players.
+        # TODO: Do this in `read_config` instead.
+        invalid_teams = @players.select do |_, team|
+            team.size != 5
+        end.each_key.map do |team_id|
+            @teams.find { |t| t.id == team_id }.name
+        end
+
+        if invalid_teams.any?
+            raise_error "These teams don't have 5 players: #{invalid_teams.join(', ')}"
+        end
+    end
+
+    # Calculates how many points each team has earned in this bracket.  If the
+    # bracket is not yet complete, the values are the mininum number of points
+    # that the team can receive based on their current position in the bracket.
+    # Sets the `points` member of each object in `@teams` to the number of
+    # points that each team member has earned.
+    def calculate_team_points
+        # If the bracket is complete, we can calculate points based on the
+        # teams' `final_rank`s.
+        if complete?
+            calculate_team_points_by_final_rank
+            return
+        end
+
+        # For each team, look at the matches that it is in, look at the point
+        # values of those matches, and take the maximum point value.  That's the
+        # number of points that the team has earned so far in the bracket.
+        base_point_value = @config.base_point_value
+
+        @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"
+
+            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}"
+
+            team.points = points_earned + base_point_value
+        end
+    end
+
+    # Calculates how many points each player has earned in the tournament, and
+    # sets the `points` member of each object in `@players` to that value.
+    def calculate_player_points
+        # Iterate over the teams in descending order of their scores.  This way,
+        # 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(", ")
+
+            @players[team.id].each do |player|
+                player.points = team.points
+            end
+        end
+    end
+
+    # Calculates how many points each team earned in this bracket.
+    # Sets the `points` member of each object in `@teams` to the number of
+    # points that each team member has earned.
+    def calculate_team_points_by_final_rank
+        # Calculate how many points to award to each rank.  When multiple teams
+        # have the same rank (e.g., two teams tie for 5th place), those teams
+        # get the average of the points available to those ranks.  For example,
+        # in a 6-team bracket, the teams in 1st through 4th place get 6 through 3
+        # 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
+
+        sorted_teams.each_with_index do |team, idx|
+            final_rank_points[team.final_rank] << num_teams - idx
+        end
+
+        base_point_value = @config.base_point_value
+
+        sorted_teams.each do |team|
+            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}"
+
+            team.points = points_earned + base_point_value
+        end
+    end
+
+    # 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
+        resp = RestClient.get(url, params: params)
+
+        JSON.parse(resp, symbolize_names: true)
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Config
+    attr_reader :base_point_value, :next_bracket, :max_players_to_count,
+                :match_values, :teams
+
+    # `config_obj` is a hash that contains the data from the config file.
+    def initialize(config_obj)
+        @base_point_value = config_obj[:base_point_value]
+        @next_bracket = config_obj[:next_bracket]
+        @max_players_to_count = config_obj[:max_players_to_count]
+        @match_values = config_obj[:match_values]
+        @teams = config_obj[:teams]
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/match.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Match
+    attr_reader :points
+
+    # `challonge_obj` is the Challonge data for this match.  `match_values` is
+    # the array from the config file that holds how many points are awarded to
+    # the teams in that match.
+    def initialize(challonge_obj, match_values)
+        @team1_id = challonge_obj[:player1_id]
+        @team2_id = challonge_obj[:player2_id]
+
+        play_order = challonge_obj[:suggested_play_order]
+        @points = match_values[play_order - 1]
+    end
+
+    # Returns whether the team with the Challonge ID `team_id` is in this match.
+    def has_team?(team_id)
+        @team1_id == team_id || @team2_id == team_id
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/player.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Player
+    attr_reader :name, :scene
+    attr_accessor :points
+
+    # `config_obj` is a hash that contains the player's data from the config file.
+    def initialize(config_obj)
+        @name = config_obj[:name]
+        @scene = config_obj[:scene]
+        @points = 0.0
+    end
+
+    def hash
+        to_s.hash
+    end
+
+    def to_s
+        "#{@name} (#{@scene})"
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/scene.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Scene
+    attr_accessor :name, :score, :num_players
+
+    # `name` is the name of the scene.  `player_scores` is an array that holds
+    # the points that were awarded to each player in the scene.
+    def initialize(name, player_scores)
+        @name = name
+        @score = player_scores.sum
+        @num_players = player_scores.size
+    end
+
+    def to_s
+        "#{@name}: #{@score} points from #{@num_players} players"
+    end
+
+    def <=>(rhs)
+        # Sort by score in descending order so the largest scores come first.
+        @score != rhs.score ? rhs.score <=> @score : @name <=> rhs.name
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/team.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Team
+    attr_reader :players, :id, :name, :final_rank
+    attr_accessor :points
+
+    # `challonge_obj` is the Challonge data for this team.
+    def initialize(challonge_obj)
+        @id = challonge_obj[:id]
+        @name = challonge_obj[:name]
+        @final_rank = challonge_obj[:final_rank]
+        @points = 0.0
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/tournament.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module KillerQueenSceneScoring
+
+class Tournament
+    attr_reader :scene_scores, :complete
+
+    # `id` can be the slug or the challonge ID of the first bracket in the
+    # 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:)
+        @brackets = []
+        @scene_scores = []
+        @loaded = false
+        @complete = false
+        @id = id
+        @api_key = api_key
+    end
+
+    # Reads the Challonge bracket with the ID that was passed to the constructor,
+    # and fills in all the data structures that represent that bracket and any
+    # later brackets in the tournament.  `@complete` is also set to indicate
+    # whether the entire tournament is complete.
+    # Returns true if at least one bracket was loaded, and false otherwise.
+    def load
+        @loaded = false
+        tournament_id = @id
+        all_brackets_loaded = true
+
+        while tournament_id
+            # TODO: Rails.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)
+
+            if !bracket.load
+                all_brackets_loaded = false
+                break
+            end
+
+            # Store that bracket.
+            @brackets << bracket
+
+            # For debugging purposes, log the players in each scene ->
+            scenes = KillerQueenSceneScoring::hash_of_arrays
+
+            bracket.players.each_value do |team|
+                team.each do |player|
+                    scenes[player.scene] << player
+                end
+            end
+
+            scene_list = scenes.map do |scene, players|
+                "#{scene} has #{players.size} players: " +
+                  players.map(&:name).join(", ")
+            end
+
+            # TODO: Rails.logger.info scene_list.join("\n")
+            # <- end debug logging
+
+            # Go to the next bracket in the chain.
+            tournament_id = bracket.config.next_bracket
+        end
+
+        return false if @brackets.empty?
+
+        # Check that all the config files have the same `max_players_to_count`.
+        values = @brackets.map { |b| b.config.max_players_to_count }
+
+        if values.count(values[0]) != values.size
+            msg = "ERROR: All brackets must have the same \"max_players_to_count\"."
+            # TODO: Rails.logger.error msg
+            raise msg
+        end
+
+        # If we loaded all the brackets in the list of brackets, set our
+        # `complete` member based on the completed state of the last bracket.
+        # We only check the last bracket because previous brackets in the
+        # sequence are not guaranteed to be marked as complete on Challonge.
+        # For an example, see "bb3wc".  The BB3 wild card bracket was not
+        # marked as complete because play stopped once it got down to 4 teams.
+        @complete = all_brackets_loaded && @brackets.last.complete?
+
+        @loaded = true
+        true
+    end
+
+    # Calculates the score for each scene in the tournament, and sets
+    # `@scene_scores` to an array of `Scene` objects.
+    # The caller must call `load`, and `load` must succeed, before calling this
+    # function.
+    def calculate_points
+        raise "The tournament was not loaded" unless @loaded
+
+        @brackets.each(&:calculate_points)
+        calculate_scene_points
+    end
+
+    protected
+
+    # Calculates how many points each scene has earned in the tournament.
+    # Sets `@scene_scores` to an array of `Scene` objects.
+    def calculate_scene_points
+        # Collect the scores of all players from the same scene.  Since a player
+        # may be in multiple brackets, we find their greatest score across
+        # all brackets.
+        # `player_scores` is a hash from a `Player` object's hash to the `Player`
+        # object.  This is a hash to make lookups easier; the keys aren't used
+        # after# this loop.
+        player_scores = @brackets.each_with_object({}) do |bracket, scores|
+            bracket.players.each_value do |team_players|
+                team_players.each do |player|
+                    key = player.hash
+
+                    if !scores.key?(key) || player.points > scores[key].points
+                        scores[key] = player
+                    end
+                end
+            end
+        end
+
+        # 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
+
+        player_scores.each_value do |player|
+            scene_players_scores[player.scene] << player.points
+        end
+
+        @scene_scores = scene_players_scores.map do |scene, scores|
+            # If a scene has more players than the max number of players whose
+            # scores can be counted, drop the extra players' scores.
+            # Sort the scores for each scene in descending order, so we only
+            # keep the highest scores.
+            max_players_to_count = @brackets[0].config.max_players_to_count
+            scores.sort!.reverse!
+
+            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(", ")
+            end
+
+            # Add up the scores for this scene.
+            Scene.new(scene, scores)
+        end
+    end
+end
+
+end

data/lib/killer_queen_scene_scoring/version.rb

@@ -0,0 +1,3 @@
+module KillerQueenSceneScoring
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: killer_queen_scene_scoring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Dunn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Classes that implement scene-wide scoring for Killer Queen tournaments.
+email:
+- acidhelm@gmail.com
+executables:
+- killer_queen_scene_scoring
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/killer_queen_scene_scoring
+- killer_queen_scene_scoring.gemspec
+- lib/killer_queen_scene_scoring.rb
+- lib/killer_queen_scene_scoring/bracket.rb
+- lib/killer_queen_scene_scoring/config.rb
+- lib/killer_queen_scene_scoring/match.rb
+- lib/killer_queen_scene_scoring/player.rb
+- lib/killer_queen_scene_scoring/scene.rb
+- lib/killer_queen_scene_scoring/team.rb
+- lib/killer_queen_scene_scoring/tournament.rb
+- lib/killer_queen_scene_scoring/version.rb
+homepage: https://github.com/acidhelm/killer_queen_scene_scoring
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/acidhelm/killer_queen_scene_scoring
+  source_code_uri: https://github.com/acidhelm/killer_queen_scene_scoring
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Scene-wide scoring for Killer Queen tournaments.
+test_files: []