tournament 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2008-03-09
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/benchmark_pool
+bin/gui.rb
+bin/picker
+bin/pool
+lib/tournament.rb
+lib/tournament/bracket.rb
+lib/tournament/entry.rb
+lib/tournament/pool.rb
+lib/tournament/team.rb
+spec/spec_helper.rb
+spec/tournament_spec.rb
+static/shoes-icon.png
+tasks/ann.rake
+tasks/annotations.rake
+tasks/bones.rake
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/post_load.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/spec.rake
+tasks/svn.rake
+tasks/test.rake
+test/test_tournament.rb

data/README.txt

@@ -0,0 +1,113 @@
+tournament
+    by Douglas A. Seifert
+    http://www.dseifert.net/code/ncaa_pool
+
+== DESCRIPTION:
+
+Small library and command line program for managing a NCAA
+basketball tournament pool.
+
+== FEATURES/PROBLEMS:
+
+* Add NCAA tournament pool entries and save them as YAML
+* Run a possibilities report for determining who is likely to win
+* Run other reports such as a leader board and entry report
+* Buggy, bug functional, Shoes GUI included for creating the entries
+  and updating the tournament bracket.
+* FIXME: Write a test suite.
+
+== SYNOPSIS:
+
+The tournament command line program is installed as 'tournament'.  The library
+has the 2008 NCAA tournament pre-configured.  If you were to use
+this library for the 2009 NCAA tournament, code changes would be
+necessary. FIXME (add ability to read teams from a simple configuration
+file).  
+
+The pool manager would use this program as follows:
+
+ 1. Choose a scoring strategy.  There are various scoring strategies
+    that could be used.  The library comes pre-configured with 
+    two scoring strategies:
+    
+    1. Basic scoring strategy: each correct pick is worth 2 X the round.
+    2. Upset favoring strategy: each correct pick is worth a
+       base amount per round plus the seed number of the winner.  As
+       pre-configured, the base amounts per round are 3, 5, 11, 19, 30
+       and 40 points.
+
+    If your scoring strategy is not one of the above, you will have to
+    write a class in the Bracket class, in file lib/tournament/bracket.rb.
+
+ 2. Initialize the pool
+
+    tournament setup pool.yml [--scoring=upset_scoring_strategy]
+
+    Use the --scoring argument to change to the upset favoring 
+    strategy.  If the basic strategy is ok, the --scoring argument is
+    not required.
+
+ 3. Export a tournament bracket YAML file
+
+    tournament bracket pool.yml tournament.yml
+
+ 4. Create entries.  You can use the included buggy GUI (see below),
+    or edit YAML files by hand.
+
+ 5. Import the entry YAML files into the pool
+
+    tournament update pool.yml --add-entry=path/to/entry.yml
+
+ 6. As games progress, update the tournament.yml file, again using the GUI or
+    editing the YAML file by hand.  Then update the pool with the new
+    tournament YAML file
+
+    tournament update pool.yml --bracket=tournament.yml
+
+ 7. Run reports
+  
+    tournament report pool.yml --type=[entry|region|leader|score]
+
+ 8. After about 22 teams are left, run a possibility report.  This report will
+    run through all the remaining ways the tournament can come out and
+    calculate the chance to win for each player.  The chance to win
+    is defined as the percentage of possibilities that lead to that player
+    coming out on top in the pool.  With more than about 22 teams left
+    (YMMV), this report could take months to run. FIXME (Investigate
+    possibly using EC2 or something to spread the load around, or 
+    otherwise optimize the possibility checking algorithm)
+
+    tournament report pool.yml --type=possibility
+
+== REQUIREMENTS:
+
+* main (2.8.0)
+
+== INSTALL:
+
+* FIXME (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008
+
+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/Rakefile

@@ -0,0 +1,27 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'tournament'
+
+task :default => 'spec:run'
+
+depend_on 'main'
+
+PROJ.name = 'tournament'
+PROJ.authors = 'Douglas A. Seifert'
+PROJ.email = 'doug+rubyforge@dseifert.net'
+PROJ.url = 'http://www.dseifert.net/code/tournament'
+PROJ.rubyforge_name = 'tournament'
+PROJ.version = '0.0.1'
+PROJ.group_id = 5863
+
+PROJ.spec_opts << '--color'
+
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc bin/fake bin/gui_v2.rb)
+PROJ.exclude << '^tags$'
+
+# EOF

data/bin/benchmark_pool

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'tournament'))
+
+
+require 'benchmark'
+
+Tournament::Pool.test
+Benchmark.bm(12) do |x|
+  x.report('final_8') { Tournament::Pool.test }
+end

data/bin/gui.rb

@@ -0,0 +1,236 @@
+#!/usr/bin/env shoes
+
+require 'yaml'
+require File.join('.', 'lib', 'tournament')
+
+# Define some constants
+WINDOW_HEIGHT = 600
+WINDOW_WIDTH = 800
+BLANK_LABEL = '    '
+
+Shoes.app :width => WINDOW_WIDTH, :height => 600 do
+  def load_data
+    @entry  = YAML::load_file(@save_file)
+  end
+
+  def save_data
+    @entry.name = @name.text
+    @entry.tie_breaker = @tie_break.text.to_i
+    File.open(@save_file, "w") do |f|
+      YAML::dump(@entry, f)
+    end
+  end
+
+  @pool = Tournament::Pool.ncaa_2008
+
+  if ARGV[1]
+    @save_file = ARGV[1]
+    load_data
+  else
+    @entry = Tournament::Entry.new
+    @entry.picks = Tournament::Bracket.new(@pool.bracket.teams)
+    #@picks = Tournament::Bracket.random_bracket(Tournament::Pool.ncaa_2008.bracket.teams)
+  end
+
+
+  @labels = Array.new(4) {Array.new(6) { Array.new }}
+  @teams = Array.new(4) {Array.new(6) { Array.new }}
+  @buttons = Array.new(4) {Array.new(6) { Array.new }}
+  @region_stacks = Array.new(4)
+  @champ = Array.new(4)
+
+  def round_stack(region_idx, round, games_per_round, gap, top, width)
+    stack :width => width do
+      if top > 0
+        stack :height => top, :width => 26 do
+          background white
+        end
+      end
+      1.upto(games_per_round) do |game|
+        bc = game % 2 == 0 || round > 1 ? lightgreen : white
+        real_game = game + region_idx * games_per_round
+        matchup_flow(region_idx, round, game, real_game, bc, gap)
+        if gap > 0
+          stack :height => gap, :width => width do
+            background white
+          end
+        end
+      end
+    end
+  end
+
+  def label_for(team, round = 1, game = 1)
+    label = if Tournament::Bracket::UNKNOWN_TEAM == team
+      "r:%d g:%d" % [round, game]
+    else
+      if round == 1 || round > 4
+        "%2d %s (%s)" % [team.seed, team.name, team.short_name]
+      else
+        "%4s" % team.short_name
+      end
+    end
+  end
+
+  def matchup_flow(region_idx, round, game, real_game, bc, gap)
+    @entry.picks.matchup(round,real_game).each_with_index do |team, idx|
+      flow do
+        background bc
+        flow_idx = (game-1)*2 + idx
+        @teams[region_idx][round-1][flow_idx] = team
+        stack :width => (width - 26) do
+          @labels[region_idx][round-1][flow_idx] = para label_for(team, round, game), :height => 26, :width => 175, :font => "Monospace 10px"
+        end
+        stack :width => 26 do
+          @buttons[region_idx][round-1][flow_idx] = button ">", :width => 26, :height => 26, :font => "Monospace 6px", :margin => 1 do
+            make_pick(region_idx, round, flow_idx, real_game)
+          end
+        end
+      end
+      if gap > 0 && idx == 0
+        stack :height => gap, :width => width do
+          background bc
+        end
+      end
+    end
+  end
+
+  def make_pick(region_idx, round, team_num, real_game)
+    team = @teams[region_idx][round-1][team_num]
+    return if team == Tournament::Bracket::UNKNOWN_TEAM
+
+    matchup = @entry.picks.matchup(round,real_game).reject{|t| t == team}[0]
+
+    if round == 4
+      @champ[region_idx].replace label_for(team, 6, 1)
+      #@labels[0][4][region_idx].replace label_for(team, 6, 1)
+    end
+
+    if round == 6
+      @overall_champ.replace label_for(team, 6, 1)
+    end
+
+    forward_round = round
+    forward_idx = team_num / 2
+    forward_team = @teams[region_idx][forward_round][forward_idx] rescue nil
+    while forward_team == matchup
+      ri = forward_round > 4 ? 0 : region_idx
+      @labels[ri][forward_round][forward_idx].replace BLANK_LABEL
+      forward_round += 1
+      forward_idx /= 2
+      if forward_round == 4
+        @champ[region_idx].replace 'Regional Champ'
+      end
+      if forward_round == 6
+        @overall_champ.replace 'NCAA Champion'
+      end
+      ri = forward_round > 4 ? 0 : region_idx
+      fi = forward_round == 5 ? region_idx : forward_idx
+      forward_team = @teams[ri][forward_round][fi] rescue nil
+    end
+
+    ri = round >= 4 ? 0 : region_idx
+    ti = team_num / 2
+    if round == 4
+      ti = region_idx
+    end
+    @entry.picks.set_winner(round, real_game, team)
+    return if round >= 6
+    begin
+      @labels[ri][round][ti].replace label_for(team, round+1, real_game)
+      @teams[ri][round][ti] = team
+    rescue Exception => e
+      alert "got error for ri #{ri} round #{round} team_num #{team_num}: #{e}"
+    end
+  end
+
+  def scrub_save_file
+    unless '.yml' == File.extname(@save_file)
+      @save_file += '.yml'
+    end
+  end
+
+  stack :margin => 5 do
+    stack do 
+      border black, :strokewidth => 1
+      flow :margin_bottom => 5 do
+        button "Save" do
+          if @save_file
+            alert("Saving #{@save_file} ...")
+          else
+            @save_file = ask_save_file
+            scrub_save_file
+          end
+          save_data
+        end
+        button "Save As ..." do
+          @save_file = ask_save_file
+          scrub_save_file
+          save_data
+        end
+      end
+      stack do
+        para "Name"
+        @name = edit_line @entry.name
+      end
+      stack do
+        para "Tie Breaker"
+        @tie_break = edit_line "#{@entry.tie_breaker}"
+      end
+    end
+    @pool.regions.each_with_index do |region, region_idx|
+      @region_stacks[region_idx] = stack do
+      stack :margin_bottom => 5 do
+        title region[:name]
+      end
+      flow do
+        top = gap = 0
+        games_per_round = 16
+        1.upto(4) do |round|
+          top = top + (round - 1) * 26 / 2
+          if round == 4
+            top = top + 13
+          end
+          gap = top * 2
+          width = 175
+          width = 75 if round > 1
+          games_per_round /= 2
+          round_stack(region_idx, round, games_per_round, gap, top, width)
+        end
+        stack :width => 200 do
+          stack :height => ((WINDOW_HEIGHT - 226) / 2) do
+            background white
+          end
+          champ = @entry.picks.winner(4, 1 + region_idx)
+          champ_label = if champ == Tournament::Bracket::UNKNOWN_TEAM
+            'Regional Champ'
+          else
+            champ.name
+          end
+          @champ[region_idx] = para champ_label, :font => 'Monospace 10px', :height => 26
+        end
+        end
+      end
+    end # regions.each_with_index
+    @final_four_stack = stack do
+      stack :margin_bottom => 5 do
+        title "Final Four"
+      end
+      flow do
+        round_stack(0, 5, 2, 0, 0, 175)
+        top = 13
+        gap = 26
+        round_stack(0, 6, 1, gap, top, 175)
+        top = 39
+        gap = 78
+        stack :width => 175 do
+          stack :width => 175, :top => top do
+            background white
+          end
+          stack :width => 175 do
+            @overall_champ = para label_for(@entry.picks.champion, 7, 1), :height => 26, :width => 175, :font => "Monospace 10px"
+          end
+        end
+      end
+    end
+  end
+end

data/bin/picker

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+dir=`dirname $0`
+
+file=''
+if [ ! -z "$1" ]; then
+  file=`pwd`/$1
+fi
+
+cd $dir/..
+
+./bin/gui.rb $file

data/bin/pool

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'tournament'))
+
+require 'rubygems'
+require 'main'
+require 'yaml'
+
+Main do
+
+  # Loads the pool from the save file.  If the save file
+  # does not exist, creates a default pool
+  def load_pool
+    @pool = YAML::load_file(save_file_name)
+  end
+
+  def save_file_name
+    params['save-file'].value
+  end
+
+  def init_pool
+    @pool = Tournament::Pool.ncaa_2008
+    @pool.bracket.scoring_strategy = Tournament::Bracket.strategy_for_name(params['scoring'].value)
+  end
+
+  def save_pool
+    if @pool
+      File.open(save_file_name, "w") do |f|
+        YAML::dump(@pool, f)
+      end
+    end
+  end
+
+  argument('save-file') do
+    required
+    argument :required
+    arity 1
+    description "Save file for the pool."
+  end
+
+  mode('setup') do
+    description "Sets up the pool the first time"
+    option('scoring', 's') do
+      optional
+      argument :required
+      arity 1
+      default 'basic_scoring_strategy'
+      validate {|s| Tournament::Bracket.available_strategies.include?(s)}
+      description "Sets the scoring strategy, should be one of #{Tournament::Bracket.available_strategies.join(', ')}"
+    end
+    def run
+      init_pool
+      puts "Initialized new pool"
+      puts "Scoring:"
+      puts @pool.bracket.scoring_strategy.description
+      save_pool
+    end
+  end
+
+  mode('update') do
+    option('bracket', 'b') do
+      optional
+      argument :required
+      arity 1
+      description "Update the tournament bracket using supplied yaml file"
+    end
+    option('add-entry', 'a') do
+      optional
+      argument :required
+      arity -1
+      description "Add an entry yaml file to the pool"
+    end
+    def run
+      load_pool
+      if params['bracket'].given?
+        tournament = YAML::load_file(params['bracket'].value)
+        @pool.bracket = tournament.picks
+        save_pool 
+      elsif params['add-entry'].given?
+        @pool.add_entry_yaml(params['add-entry'].value)
+        save_pool 
+      else
+        puts "Please specify bracket or add-entry"
+        print usage.to_s
+        exit_warn!
+      end
+    end
+  end
+  
+  mode('bracket') do
+    argument('bracket-yaml') do
+      required
+      description "Dump the pool's bracket as an Tournament::Entry object to a yaml file."
+    end
+    def run
+      load_pool
+      tournament = Tournament::Entry.new('Tournament', @pool.bracket, 0)
+      File.open(params['bracket-yaml'].value, "w") do |f|
+        YAML::dump(tournament, f)
+      end
+    end
+  end
+
+  mode('report') do
+    option('type', 't') do
+      required
+      arity 1
+      argument :required
+      validate {|rt| ['score', 'region', 'leader', 'possibility', 'entry'].include?(rt)}
+      description "Which report to run, score, leader, region, possibility or entry"
+    end
+    def run
+      load_pool
+      @pool.send("#{params['type'].value}_report")
+    end
+  end
+
+end