tournament 0.0.3 → 1.0.0

data/History.txt

@@ -1,8 +1,20 @@
-== 0.0.1 / 2008-03-23
+== 1.0.0 / 2008-03-26
 
-* Initial Release
+* Change the pool command line script usage to make it simpler (I hope)
+* Add a new report: final_four
+* FIXME: Final four report assumes payouts go to 1st and 2nd and last places.
+  This should be configurable.
+
+== 0.0.3 / 2008-03-23
+
+* Bugfix the picker wrapper script.  Getting used to bones/rubyforge.
 
 == 0.0.2 / 2008-03-23
 
 * Changed the picker wrapper script to ruby because it seems that
   that is what rubyforge tools expect.
+
+== 0.0.1 / 2008-03-23
+
+* Initial Release
+

data/README.txt

@@ -19,66 +19,82 @@ basketball tournament pool.
 
 == SYNOPSIS:
 
-The tournament command line program is installed as 'tournament'.  The library
+The tournament command line program is installed as 'pool'.  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).  
+file).  For usage, just execute
+
+   pool --help
+
+For command specific usage, execute
+
+   pool <command> --help
+
+where <command> is one of the available commands described below. The
+pool command saves state in a file called pool.yml by default.  This
+can be overridden in all cases by using the --save-file option.
 
 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.
+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.
 
-    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. Create a directory to hold the pool data and change to it
 
- 2. Initialize the pool
+3. Initialize the pool
 
-    tournament setup pool.yml [--scoring=upset_scoring_strategy]
+       pool setup [--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.
+   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 entry YAML file
+   As mentioned above, unless overridden by using the --save-file
+   option, the pool will save itself to the file 'pool.yml'
 
-    tournament bracket pool.yml tournament.yml
+3. Export a tournament entry YAML file
 
- 4. Create entries.  You can use the included buggy GUI (see below),
-    or edit YAML files by hand.
+       pool dump
 
- 5. Import the entry YAML files into the pool
+   This will save the tournament entry file as tournament.yml unless
+   the --entry option is used to override it.
 
-    tournament update pool.yml --add-entry=path/to/entry.yml
+4. Create entries.  You can use the included buggy GUI (see below),
+   or edit YAML files by hand.
 
- 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
+5. Import the entry YAML files into the pool
 
-    tournament update pool.yml --bracket=tournament.yml
+       pool entry --add=path/to/entry.yml
 
- 7. Run reports
+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
+   pool YAML file
+
+       pool update
+
+7. Run reports
   
-    tournament report pool.yml --type=[entry|region|leader|score]
+       pool report [final_four|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)
+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
+       pool report possibility
 
 == SHOES GUI:
 
@@ -90,8 +106,10 @@ Tournament::Entry object.   The picker program optionally takes one
 argument, the path to a Tournament::Entry YAML file.  It will open
 with the provided entry's picks pre filled in.
 
-The GUI may be used for keeping the NCAA tournament entry YAML file
-up to date.
+The GUI also may be used for keeping the NCAA tournament entry YAML file
+up to date:
+
+   picker tournament.yml
  
 == REQUIREMENTS:
 

data/Rakefile

@@ -16,7 +16,7 @@ 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.3'
+PROJ.version = '1.0.0'
 PROJ.group_id = 5863
 
 PROJ.spec_opts << '--color'
@@ -24,4 +24,7 @@ PROJ.spec_opts << '--color'
 PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc bin/fake bin/gui_v2.rb)
 PROJ.exclude << '^tags$'
 
+PROJ.rdoc_opts = ["--line-numbers", "--inline-source"]
+PROJ.rdoc_template = "tasks/jamis.rb"
+
 # EOF

data/bin/pool

@@ -31,16 +31,17 @@ Main do
     end
   end
 
-  argument('save-file') do
-    required
+  option('save-file', 's') do
+    optional
     argument :required
+    default 'pool.yml'
     arity 1
     description "Save file for the pool."
   end
 
   mode('setup') do
     description "Sets up the pool the first time"
-    option('scoring', 's') do
+    option('scoring', 'S') do
       optional
       argument :required
       arity 1
@@ -58,56 +59,79 @@ Main do
   end
 
   mode('update') do
-    option('bracket', 'b') do
+    option('entry', 'e') do
       optional
       argument :required
+      default 'tournament.yml'
       arity 1
-      description "Update the tournament bracket using supplied yaml file"
+      description "Update the tournament entry using supplied yaml file"
     end
-    option('add-entry', 'a') do
+    def run
+      load_pool
+      tournament = YAML::load_file(params['entry'].value)
+      @pool.bracket = tournament.picks
+      save_pool 
+    end
+  end
+
+  mode('entry') do
+    option('add', 'a') do
       optional
       argument :required
       arity -1
       description "Add an entry yaml file to the pool"
     end
+    option('remove', 'r') do
+      optional
+      argument :required
+      arity -1
+      description "Remove an entry by name"
+    end
     def run
       load_pool
-      if params['bracket'].given?
-        tournament = YAML::load_file(params['bracket'].value)
-        @pool.bracket = tournament.picks
+      if params['add'].given?
+        @pool.add_entry_yaml(params['add'].value)
         save_pool 
-      elsif params['add-entry'].given?
-        @pool.add_entry_yaml(params['add-entry'].value)
+      elsif params['remove'].given?
+        @pool.remove_by_name(params['remove'].value)
         save_pool 
       else
-        puts "Please specify bracket or add-entry"
+        puts "Please specify add or remove"
         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."
+  mode('dump') do
+    option('entry', 'e') do
+      optional
+      argument :required
+      default 'tournament.yml'
+      description "Dump the pool 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|
+      File.open(params['entry'].value, "w") do |f|
         YAML::dump(tournament, f)
       end
     end
   end
 
   mode('report') do
-    option('type', 't') do
+    available_reports = Tournament::Pool.instance_methods(false).map do |name|
+      if idx = name.index("_report")
+        name[0,idx]
+      else
+        nil
+      end
+    end.compact
+    argument('type') 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"
+      validate {|rt| available_reports.include?(rt)}
+      description "Which report to run among #{available_reports.join(', ')}"
     end
     def run
       load_pool
@@ -115,4 +139,9 @@ Main do
     end
   end
 
+  def run
+    print usage.to_s
+    exit_warn!
+  end
+
 end

data/lib/tournament/bracket.rb

@@ -176,7 +176,7 @@ class Tournament::Bracket
     #num_possibilities = 0
     #shifts.size.times { |n| num_possibilities |= (1 << n) }
 
-    puts "Checking #{num_possibilities} (#{number_of_outcomes}) possible outcomes."
+    #puts "Checking #{num_possibilities} (#{number_of_outcomes}) possible outcomes."
     possibility = num_possibilities - 1
     while possibility >= 0
       #puts "    possibility: #{Tournament::Bracket.jbin(possibility, teams.size - 1)}"
@@ -185,9 +185,9 @@ class Tournament::Bracket
         real_poss |= (((possibility & (1 << i)) > 0 ? 1 : 0) << s)
       end
       #puts "    real_poss: #{Tournament::Bracket.jbin(real_poss, teams.size - 1)}"
-      real_possibility = winners | real_poss
-      #puts "    possibility: #{Tournament::Bracket.jbin(real_possibility, teams.size - 1)}"
-      yield(real_possibility)
+      real_poss = winners | real_poss
+      #puts "    real_poss: #{Tournament::Bracket.jbin(real_poss, teams.size - 1)}"
+      yield(real_poss)
       possibility -= 1
     end
   end

data/lib/tournament/pool.rb

@@ -32,6 +32,14 @@ class Tournament::Pool
     @entries << YAML::load_file(yaml)
   end
 
+  # Remove an entry by name from the pool
+  def remove_by_name(name)
+    entry = @entries.find {|e| e.name == name}
+    if !entry.nil?
+      @entries.delete(entry)
+    end
+  end
+
   # Creates a bracket for the pool by combining all the
   # regions into one bracket of 64 teams.  By default the
   # bracket uses the basic scoring strategy.
@@ -289,7 +297,38 @@ class Tournament::Pool
     end
   end
 
+  def final_four_report
+    if @entries.size == 0
+      puts "There are no entries in the pool."
+      return
+    end
+    if self.bracket.teams_left != 4
+      puts "The final four report should only be run when there"
+      puts "are exactly four teams left in the tournament."
+      return
+    end
+    print "Final Four: #{self.bracket.winners[4][0,2].map{|t| "(#{t.seed}) #{t.name}"}.join(" vs. ")}"
+    puts "    #{self.bracket.winners[4][2,2].map{|t| "(#{t.seed}) #{t.name}"}.join(" vs. ")}"
+    sep= "--------------+----------------+----------------------------"
+    puts " Championship |    Champion    |  Winners"
+    puts sep
+    self.bracket.each_possible_bracket do |poss|
+      rankings = @entries.map{|p| [p, p.picks.score_against(poss)] }.sort_by {|arr| -arr[1] }
+      first = rankings[0][0]
+      second = rankings[1][0]
+      last = rankings[-1][0]
+      puts "%14s|%16s|%s" % [poss.winners[5].map{|t| t.short_name}.join("-"),
+        poss.champion.name, "   1: #{first.name} (#{rankings[0][1]})"]
+      puts "%14s|%16s|%s" % ['', '',
+        "   2: #{second.name} (#{rankings[1][1]})"]
+      puts "%14s|%16s|%s" % ['', '',
+        "LAST: #{last.name} (#{rankings[-1][1]})"]
+      puts sep
+    end
+  end
+
   def possibility_report
+    $stdout.sync = true
     if @entries.size == 0
       puts "There are no entries in the pool."
       return
@@ -298,6 +337,9 @@ class Tournament::Pool
     min_ranking = @entries.map{|p| @entries.size + 1}
     times_winner = @entries.map{|p| 0 }
     count = 0
+    old_percentage = -1 
+    old_remaining = 1_000_000_000_000
+    puts "Checking #{self.bracket.number_of_outcomes} possible outcomes"
     start = Time.now.to_f
     self.bracket.each_possible_bracket do |poss|
       poss_scores = @entries.map{|p| p.picks.score_against(poss)}
@@ -310,15 +352,15 @@ class Tournament::Pool
         times_winner[i] += 1 if rank == 1
       end
       count += 1
-      percentage = (count * 100 / self.bracket.number_of_outcomes) * 1000
-      if (percentage % 1000) == 0
-        percentage /= 1000
-        hashes = '#' * percentage + '>'
-        elapsed = Time.now.to_f - start
-        spp = elapsed / count
-        remaining = ((self.bracket.number_of_outcomes - count) * spp).to_i
-        print "\rCalculating: %3d%% +#{hashes.ljust(100, '-')}+ %5d seconds remaining" % [percentage, remaining]
-
+      percentage = (count * 100.0 / self.bracket.number_of_outcomes)
+      elapsed = Time.now.to_f - start
+      spp = elapsed / count
+      remaining = ((self.bracket.number_of_outcomes - count) * spp).to_i
+      if (percentage.to_i != old_percentage) || (remaining < old_remaining)
+        old_remaining = remaining
+        old_percentage = percentage.to_i
+        hashes = '#' * (percentage.to_i/5) + '>'
+        print "\rCalculating: %3d%% +#{hashes.ljust(20, '-')}+ %5d seconds remaining" % [percentage.to_i, remaining]
       end
     end
     puts "\n"

data/tasks/doc.rake

@@ -8,6 +8,7 @@ namespace :doc do
   Rake::RDocTask.new do |rd|
     rd.main = PROJ.rdoc_main
     rd.rdoc_dir = PROJ.rdoc_dir
+    rd.template = PROJ.rdoc_template if PROJ.rdoc_template
 
     incl = Regexp.new(PROJ.rdoc_include.join('|'))
     excl = Regexp.new(PROJ.rdoc_exclude.join('|'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tournament
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Douglas A. Seifert
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-23 00:00:00 -07:00
+date: 2008-03-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,6 +70,8 @@ has_rdoc: true
 homepage: http://www.dseifert.net/code/tournament
 post_install_message: 
 rdoc_options: 
+- --line-numbers
+- --inline-source
 - --main
 - README.txt
 require_paths: