icu_tournament 1.3.5 → 1.3.6

data/lib/icu_tournament/tie_break.rb

@@ -0,0 +1,92 @@
+module ICU
+  #
+  # This class is used to recognise the names of tie break rules. The class method _identify_
+  # takes a string as it's only argument and returns a new intstance if it recognises a
+  # tie break rule from the string, or _nil_ otherwise. An instance has three read-only methods:
+  # _id_ (a shoet symbolic name), _code_ (a two letter code) and _name_ (the full name).
+  # For example:
+  #
+  #   ICU::TieBreak.identify("no such rule")           # => nil
+  #   tb = ICU::TieBreak.identify("Neustadlt")
+  #   tb.id                                            # => :neustadtl
+  #   tb.code                                          # => "SB"
+  #   tb.name                                          # => "Sonneborn-Berger"
+  #
+  # The method is case insensitive and can cope with extraneous white space and,
+  # to a limited extent, name variations and spelling mistakes:
+  #
+  #   ICU::TieBreak.identify("SB").name                # => "Sonneborn-Berger"
+  #   ICU::TieBreak.identify("NESTADL").name           # => "Sonneborn-Berger"
+  #   ICU::TieBreak.identify(" wins ").name            # => "Number of wins"
+  #   ICU::TieBreak.identify(:sum_ratings).name        # => "Sum of opponent's ratings"
+  #   ICU::TieBreak.identify("median").name            # => "Harkness"
+  #   ICU::TieBreak.identify("MODIFIED").name          # => "Modified median"
+  #   ICU::TieBreak.identify("Modified\nMedian").name  # => "Modified median"
+  #   ICU::TieBreak.identify("\tbuccholts\t").name     # => "Buchholz"
+  #   ICU::TieBreak.identify("progressive\r\n").name   # => "Sum of progressive scores"
+  #   ICU::TieBreak.identify("SumOfCumulative").name   # => "Sum of progressive scores"
+  #
+  # The full list of supported tie break rules is:
+  #
+  # * Buchholz (:buchholz, "BH"): sum of opponents' scores
+  # * Harkness (:harkness, "HK"): like Buchholz except the highest and lowest opponents' scores are discarded (or two highest and lowest if 9 rounds or more)
+  # * Modified median (:modified_median, "MM"): same as Harkness except only lowest (or highest) score(s) are discarded for players with more (or less) than 50%
+  # * Number of blacks (:blacks, "NB") number of blacks
+  # * Number of wins (:wins, "NW") number of wins
+  # * Player's name (:name, "PN"): alphabetical by name
+  # * Sonneborn-Berger (:neustadtl, "SB"): sum of scores of players defeated plus half sum of scores of players drawn against
+  # * Sum of opponents' ratings (:ratings, "SR"): sum of opponents ratings (FIDE ratings are used in preference to local ratings if available)
+  # * Sum of progressive scores (:progressive, "SP"): sum of running score for each round
+  #
+  # An array of all supported TieBreak instances (ordered by name) is returned by the class method _rules_.
+  #
+  #   rules = ICU::TieBreak.rules
+  #   rules.size                                       # => 9
+  #   rules.first.name                                 # => "Buchholz"
+  #
+  # Note that this class only deals with the recognition of tie break names, not the calculation of tie break scores.
+  # The latter is currently implemented in the ICU::Tournament class.
+  #
+  class TieBreak
+    attr_reader :id, :code, :name
+    private_class_method :new
+    
+    RULES =
+    {
+      :blacks          => ["NB", "Number of blacks",          %r{(number[-_ ]?of[-_ ])?blacks?}],
+      :buchholz        => ["BH", "Buchholz",                  %r{^buc{1,2}h{1,2}olt?[zs]}],
+      :harkness        => ["HK", "Harkness",                  %r{^(harkness?|median)$}],
+      :modified_median => ["MM", "Modified median",           %r{^modified([-_ ]?median)?$}],
+      :name            => ["PN", "Player's name",             %r{^(player('?s)?[-_ ]?)?name$}],
+      :neustadtl       => ["SB", "Sonneborn-Berger",          %r{^(sonn?eborn[-_ ]?berger|n[eu]{1,2}sta[dtl]{2,3})}],
+      :progressive     => ["SP", "Sum of progressive scores", %r{^(sum[-_ ]?(of[-_ ]?)?)?(progressive|cumulative)([-_ ]?scores?)?}],
+      :ratings         => ["SR", "Sum of opponent's ratings", %r{(sum[-_ ]?(of[-_ ]?)?)?(opponents'?[-_ ]?)?ratings}],
+      :wins            => ["NW", "Number of wins",            %r{(number[-_ ]?of[-_ ])?wins?}],
+    }
+
+    # Given a string, return the TieBreak rule it is recognised as, or return nil.
+    def self.identify(str)
+      return nil unless str
+      str = str.to_s.gsub(/\s+/, ' ').strip.downcase
+      return nil if str.length <= 1 || str.length == 3
+      RULES.each_pair { |id, rule| return new(id, rule[0], rule[1]) if str.upcase == rule[0] || str.match(rule[2]) }
+      nil
+    end
+
+    # Return an array of all tie break rules, ordered by name.
+    def self.rules
+      RULES.keys.sort_by{ |id| RULES[id][1] }.inject([]) do |rules, id|
+        rules << new(id, RULES[id][0], RULES[id][1])
+      end
+    end
+
+    # :enddoc:
+    private
+
+    def initialize(id, code, name)
+      @id   = id
+      @code = code
+      @name = name
+    end
+  end
+end

data/lib/icu_tournament/tournament.rb

@@ -105,17 +105,7 @@ module ICU
   #   t.tie_breaks = [:buchholz, :neustadtl, :blacks, :wins]
   #   t.tie_breaks = []  # reset to the default
   #
-  # The full list of supported methods is:
-  #
-  # * _Buchholz_: sum of opponents' scores
-  # * _Harkness_ (or _median_): like Buchholz except the highest and lowest opponents' scores are discarded (or two highest and lowest if 9 rounds or more)
-  # * _modified_median_: same as Harkness except only lowest (or highest) score(s) are discarded for players with more (or less) than 50%
-  # * _Neustadtl_ (or _Sonneborn-Berger_): sum of scores of players defeated plus half sum of scores of players drawn against
-  # * _progressive_ (or _cumulative_): sum of running score for each round
-  # * _ratings_: sum of opponents ratings (FIDE ratings are used in preference to local ratings if available)
-  # * _blacks_: number of blacks
-  # * _wins_: number of wins
-  # * _name_: alphabetical by name (if _tie_breaks_ is set to an empty array, as it is initially, then this will be used as the back-up tie breaker)
+  # See ICU::TieBreak for the full list of supported tie break methods.
   #
   # The return value from _rerank_ is the tournament object itself, to allow chaining, for example:
   #
@@ -226,28 +216,14 @@ module ICU
       @teams.find{ |t| t.matches(name) }
     end
 
-    # Set the tie break methods.
+    # Canonicalise the names in the tie break array.
     def tie_breaks=(tie_breaks)
       raise "argument error - always set tie breaks to an array" unless tie_breaks.class == Array
-      # Canonicalise the tie break method names.
-      tie_breaks.map! do |m|
-        m = m.to_s if m.class == Symbol
-        m = m.downcase.gsub(/[-\s]/, '_') if m.class == String
-        case m
-          when true                then 'name'
-          when 'sonneborn_berger'  then 'neustadtl'
-          when 'modified_median'   then 'modified'
-          when 'median'            then 'harkness'
-          when 'cumulative'        then 'progressive'
-          else m
-        end
+      @tie_breaks = tie_breaks.map do |str|
+        tb = ICU::TieBreak.identify(str)
+        raise "invalid tie break method '#{str}'" unless tb
+        tb.id
       end
-
-      # Check they're all valid.
-      tie_breaks.each { |m| raise "invalid tie break method '#{m}'" unless m.to_s.match(/^(blacks|buchholz|harkness|modified|name|neustadtl|progressive|ratings|wins)$/) }
-
-      # Finally set them.
-      @tie_breaks = tie_breaks;
     end
 
     # Add a new player to the tournament. Must have a unique player number.
@@ -508,7 +484,7 @@ module ICU
       end
     end
 
-    # Return an array of tie break methods and an array of tie break orders (+1 for asc, -1 for desc).
+    # Return an array of tie break rules and an array of tie break orders (+1 for asc, -1 for desc).
     # The first and most important method is always "score", the last and least important is always "name".
     def tie_break_data
 
@@ -516,19 +492,19 @@ module ICU
       methods, order, data = Array.new, Hash.new, Hash.new
 
       # Score is always the most important.
-      methods << 'score'
-      order['score'] = -1
+      methods << :score
+      order[:score] = -1
 
       # Add the configured methods.
       tie_breaks.each do |m|
         methods << m
-        order[m] = m == 'name' ? 1 : -1
+        order[m] = m == :name ? 1 : -1
       end
 
       # Name is included as the last and least important tie breaker unless it's already been added.
-      unless methods.include?('name')
-        methods << 'name'
-        order['name'] = 1
+      unless methods.include?(:name)
+        methods << :name
+        order[:name] = 1
       end
 
       # We'll need the number of rounds.
@@ -537,7 +513,7 @@ module ICU
       # Pre-calculate some scores that are not in themselves tie break scores
       # but are needed in the calculation of some of the actual tie-break scores.
       pre_calculated = Array.new
-      pre_calculated << 'opp-score'  # sum scores where a non-played games counts 0.5
+      pre_calculated << :opp_score  # sum scores where a non-played games counts 0.5
       pre_calculated.each do |m|
         data[m] = Hash.new
         @player.values.each { |p| data[m][p.num] = tie_break_score(data, m, p, rounds) }
@@ -557,20 +533,20 @@ module ICU
     # Return a tie break score for a given player and a given tie break method.
     def tie_break_score(hash, method, player, rounds)
       case method
-        when 'score'       then player.points
-        when 'wins'        then player.results.inject(0)   { |t,r| t + (r.opponent && r.score  == 'W' ? 1 : 0) }
-        when 'blacks'      then player.results.inject(0)   { |t,r| t + (r.opponent && r.colour == 'B' ? 1 : 0) }
-        when 'buchholz'    then player.results.inject(0.0) { |t,r| t + (r.opponent ? hash['opp-score'][r.opponent] : 0.0) }
-        when 'neustadtl'   then player.results.inject(0.0) { |t,r| t + (r.opponent ? hash['opp-score'][r.opponent] * r.points : 0.0) }
-        when 'opp-score'   then player.results.inject(0.0) { |t,r| t + (r.opponent ? r.points : 0.5) } + (rounds - player.results.size) * 0.5
-        when 'progressive' then (1..rounds).inject(0.0)    { |t,n| r = player.find_result(n); s = r ? r.points : 0.0; t + s * (rounds + 1 - n) }
-        when 'ratings'     then player.results.inject(0)   { |t,r| t + (r.opponent && (@player[r.opponent].fide_rating || @player[r.opponent].rating) ? (@player[r.opponent].fide_rating || @player[r.opponent].rating) : 0) }
-        when 'harkness', 'modified'
-          scores = player.results.map{ |r| r.opponent ? hash['opp-score'][r.opponent] : 0.0 }.sort
+        when :score       then player.points
+        when :wins        then player.results.inject(0)   { |t,r| t + (r.opponent && r.score  == 'W' ? 1 : 0) }
+        when :blacks      then player.results.inject(0)   { |t,r| t + (r.opponent && r.colour == 'B' ? 1 : 0) }
+        when :buchholz    then player.results.inject(0.0) { |t,r| t + (r.opponent ? hash[:opp_score][r.opponent] : 0.0) }
+        when :neustadtl   then player.results.inject(0.0) { |t,r| t + (r.opponent ? hash[:opp_score][r.opponent] * r.points : 0.0) }
+        when :opp_score   then player.results.inject(0.0) { |t,r| t + (r.opponent ? r.points : 0.5) } + (rounds - player.results.size) * 0.5
+        when :progressive then (1..rounds).inject(0.0)    { |t,n| r = player.find_result(n); s = r ? r.points : 0.0; t + s * (rounds + 1 - n) }
+        when :ratings     then player.results.inject(0)   { |t,r| t + (r.opponent && (@player[r.opponent].fide_rating || @player[r.opponent].rating) ? (@player[r.opponent].fide_rating || @player[r.opponent].rating) : 0) }
+        when :harkness, :modified_median
+          scores = player.results.map{ |r| r.opponent ? hash[:opp_score][r.opponent] : 0.0 }.sort
           1.upto(rounds - player.results.size) { scores << 0.0 }
           half = rounds / 2.0
           times = rounds >= 9 ? 2 : 1
-          if method == 'harkness' || player.points == half
+          if method == :harkness || player.points == half
             1.upto(times) { scores.shift; scores.pop }
           else
             1.upto(times) { scores.send(player.points > half ? :shift : :pop) }

data/lib/icu_tournament/tournament_spx.rb

@@ -100,7 +100,7 @@ module ICU
     #
     # You may wish set the tie-break rules before ranking:
     #
-    #   tournament.tie_breaks = [:buchholz, ::neustadtl]
+    #   tournament.tie_breaks = [:buchholz, :neustadtl]
     #   spexport = tournament.rerank.renumber.serialize('SwissPerfect')
     #
     # See ICU::Tournament for more about tie-breaks.

data/lib/icu_tournament/version.rb

@@ -2,6 +2,6 @@
 
 module ICU
   class Tournament
-    VERSION = "1.3.5"
+    VERSION = "1.3.6"
   end
 end

data/lib/icu_tournament.rb

@@ -3,7 +3,7 @@
 require 'icu_name'
 
 icu_tournament_files = Array.new
-icu_tournament_files.concat %w{util federation}
+icu_tournament_files.concat %w{util federation tie_break}
 icu_tournament_files.concat %w{player result team tournament}
 icu_tournament_files.concat %w{fcsv krause sp spx}.map{ |f| "tournament_#{f}"}
 

data/spec/tie_break_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module ICU
+  describe TieBreak do
+    context "#identify which rule" do
+      it "should recognize Buchholz" do
+        TieBreak.identify(:buchholz).id.should == :buchholz
+        TieBreak.identify(" BucholtS ").id.should == :buchholz
+        TieBreak.identify(" bh ").id.should == :buchholz
+        TieBreak.identify(" buccholts ").code.should == "BH"
+      end
+
+      it "should recognize Harkness (Median)" do
+        TieBreak.identify(:harkness).id.should == :harkness
+        TieBreak.identify("median").id.should == :harkness
+        TieBreak.identify(" hARKNES ").id.should == :harkness
+        TieBreak.identify("HK").id.should == :harkness
+        TieBreak.identify("MEDIAN").code.should == "HK"
+      end
+
+      it "should recognize Modified Median" do
+        TieBreak.identify(:modified).id.should == :modified_median
+        TieBreak.identify(" modified  MEDIAN ").id.should == :modified_median
+        TieBreak.identify("MM").code.should == "MM"
+      end
+
+      it "should recognize Number of Blacks" do
+        TieBreak.identify(:blacks).id.should == :blacks
+        TieBreak.identify("number\tof\tblacks\n").id.should == :blacks
+        TieBreak.identify("\tnb\t").id.should == :blacks
+        TieBreak.identify("number_blacks").code.should == "NB"
+      end
+
+      it "should recognize Number of Wins" do
+        TieBreak.identify(:wins).id.should == :wins
+        TieBreak.identify(" number-of-wins ").id.should == :wins
+        TieBreak.identify("NUMBER WINS\r\n").id.should == :wins
+        TieBreak.identify("nw").code.should == "NW"
+      end
+
+      it "should recognize Player's of Name" do
+        TieBreak.identify(:name).id.should == :name
+        TieBreak.identify("Player's Name").id.should == :name
+        TieBreak.identify("players_name").id.should == :name
+        TieBreak.identify("PN").id.should == :name
+        TieBreak.identify("PLAYER-NAME").code.should == "PN"
+      end
+
+      it "should recognize Sonneborn-Berger" do
+        TieBreak.identify(:sonneborn_berger).id.should == :neustadtl
+        TieBreak.identify(:neustadtl).id.should == :neustadtl
+        TieBreak.identify("  SONNEBORN\nberger").id.should == :neustadtl
+        TieBreak.identify("\t  soneborn_berger  \t").id.should == :neustadtl
+        TieBreak.identify("sb").id.should == :neustadtl
+        TieBreak.identify("NESTADL").code.should == "SB"
+      end
+
+      it "should recognize Sum of Progressive Scores" do
+        TieBreak.identify(:progressive).id.should == :progressive
+        TieBreak.identify("CUMULATIVE").id.should == :progressive
+        TieBreak.identify("sum of progressive scores").id.should == :progressive
+        TieBreak.identify("SUM-cumulative_SCORE").id.should == :progressive
+        TieBreak.identify(:cumulative_score).id.should == :progressive
+        TieBreak.identify("SumOfCumulative").id.should == :progressive
+        TieBreak.identify("SP").code.should == "SP"
+      end
+
+      it "should recognize Sum of Opponents' Ratings" do
+        TieBreak.identify(:ratings).id.should == :ratings
+        TieBreak.identify("sum of opponents ratings").id.should == :ratings
+        TieBreak.identify("Opponents' Ratings").id.should == :ratings
+        TieBreak.identify("SR").id.should == :ratings
+        TieBreak.identify("SUMOPPONENTSRATINGS").code.should == "SR"
+      end
+
+      it "should recognize player's name" do
+        TieBreak.identify(:name).id.should == :name
+        TieBreak.identify(" player's  NAME ").id.should == :name
+        TieBreak.identify("pn").code.should == "PN"
+      end
+
+      it "should return nil for unrecognized tie breaks" do
+        TieBreak.identify("XYZ").should be_nil
+        TieBreak.identify(nil).should be_nil
+      end
+    end
+    
+    context "return an array of tie break rules" do
+      before(:each) do
+        @rules = TieBreak.rules
+      end
+
+      it "should be an array in a specific order" do
+        @rules.size.should == 9
+        @rules.first.name.should == "Buchholz"
+        @rules.map(&:code).join("|").should == "BH|HK|MM|NB|NW|PN|SB|SR|SP"
+      end
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 5
-  version: 1.3.5
+  - 6
+  version: 1.3.6
 platform: ruby
 authors: 
 - Mark Orr
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-19 00:00:00 +00:00
+date: 2011-02-27 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -135,6 +135,7 @@ files:
 - lib/icu_tournament/player.rb
 - lib/icu_tournament/result.rb
 - lib/icu_tournament/team.rb
+- lib/icu_tournament/tie_break.rb
 - lib/icu_tournament/tournament.rb
 - lib/icu_tournament/tournament_fcsv.rb
 - lib/icu_tournament/tournament_krause.rb
@@ -148,6 +149,7 @@ files:
 - spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/team_spec.rb
+- spec/tie_break_spec.rb
 - spec/tournament_fcsv_spec.rb
 - spec/tournament_krause_spec.rb
 - spec/tournament_sp_spec.rb
@@ -194,6 +196,7 @@ test_files:
 - spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/team_spec.rb
+- spec/tie_break_spec.rb
 - spec/tournament_fcsv_spec.rb
 - spec/tournament_krause_spec.rb
 - spec/tournament_sp_spec.rb