icu_tournament 1.0.1 → 1.0.3

data/lib/icu_tournament/tournament_sp.rb

@@ -23,6 +23,17 @@ information.
   tournament = parser.parse_file('champs', "2010-07-03")  # looks for "champs.ini", "champs.trn" and "champs.sco"
   puts parser.error unless tournament
 
+By default, the parser extracts local ratings and IDs from the SwissPerfect files. If instead international
+ratings or IDs are required, use the options _id_ and _rating_. For example:
+
+  tournament = parser.parse_file('ncc', "2010-05-08")
+  tournament.player(2).id         # =>  12379 (ICU ID)
+  tournament.player(2).rating     # =>  2556  (ICU rating)
+  
+  tournament = parser.parse_file('ncc', "2010-05-08", :id => :intl, :rating => :intl)
+  tournament.player(2).id         # =>  1205064 (FIDE ID)
+  tournament.player(2).rating     # =>  2530    (FIDE rating)
+
 Because the data is in three parts, some of which are in a legacy binary format, serialization to this format is
 not supported. Instead, a method is provided to serialize any tournament text in the format of <em>SwissPerfects</em>
 text export format, an example of which is shown below.
@@ -39,16 +50,28 @@ implementation of the ICU ratings database.
 
   swiss_perfect = tournament.serialize('SwissPerfect')
 
-As a side effect of serialization, the player numbers will be reordered (to ensure they range from 1 to the total
-number of players) and their order in the serialized format will be by player number. If you would like to have
-rank order instead, then first rank the tournament (if it isn't already ranked) and then call the _renumber_ method
-without the option argument (which will renumber by rank) before serializing. For example:
+The order of players in the serialized output is always by player number and as a side effect of serialization,
+the player numbers will be adjusted to ensure they range from 1 to the total number of players (i.e. renumbered
+in order). If you would prefer rank-order instead, then you must first renumber the players by rank (the default
+renumbering method) before serializing. For example:
+
+  swiss_perfect = tournament.renumber.serialize('SwissPerfect')
+
+There should be no need to explicitly rank the tournament first, as that information is already present in
+SwissPerfect files (i.e. each player should already have a rank after the files have been parsed).
+Additionally, the tie break rules used for the tournament will be available from:
+
+  tournament.tie_breaks           # => [:buchholz, :harkness]
+
+Should you wish to rank the tournament using a different set of tie-break rules, you can do something like the following:
 
-  swiss_perfect = tournament.rerank(:neustadtl, :buchholz).renumber.serialize('SwissPerfect)
+  tournament.tie_breaks = [:wins, :blacks]
+  swiss_perfect = tournament.rerank.renumber.serialize('SwissPerfect')
 
 == Todo
 
 * Allow parsing from 1 zip file
+* Implement the extra tie-break rules that SP has
 
 =end
 
@@ -70,13 +93,13 @@ without the option argument (which will renumber by rank) before serializing. Fo
       SCO = %w{ROUND WHITE BLACK W_SCORE B_SCORE W_TYPE B_TYPE}  # not used W_SUBSCO, B_SUBSCO
 
       # Parse SP data returning a Tournament or raising an exception on error.
-      def parse_file!(file, start)
+      def parse_file!(file, start, arg={})
         @t = Tournament.new('Dummy', start)
         @bonus = {}
         @start_no = {}
         ini, trn, sco = get_files(file)
         parse_ini(ini)
-        parse_trn(trn)
+        parse_trn(trn, arg)
         parse_sco(sco)
         fixup
         @t.validate!(:rerank => true)
@@ -85,9 +108,9 @@ without the option argument (which will renumber by rank) before serializing. Fo
 
       # Parse SP data returning an ICU::Tournament or a nil on failure. In the latter
       # case, an error message will be available via the <em>error</em> method.
-      def parse_file(file, start)
+      def parse_file(file, start, arg={})
         begin
-          parse_file!(file, start)
+          parse_file!(file, start, arg)
         rescue => ex
           @error = ex.message
           nil
@@ -168,7 +191,7 @@ without the option argument (which will renumber by rank) before serializing. Fo
         end.find_all { |tb| tb }
       end
 
-      def parse_trn(file)
+      def parse_trn(file, arg={})
         begin
           trn = DBF::Table.new(file)
         rescue
@@ -177,7 +200,7 @@ without the option argument (which will renumber by rank) before serializing. Fo
         raise "invalid TRN file (no records)" if trn.record_count == 0
         trn.each do |r|
           next unless r
-          h = trn_record_to_hash(r)
+          h = trn_record_to_hash(r, arg)
           @t.add_player(ICU::Player.new(h.delete(:first_name), h.delete(:last_name), h.delete(:num), h))
         end
       end
@@ -196,18 +219,18 @@ without the option argument (which will renumber by rank) before serializing. Fo
         end
       end
 
-      def trn_record_to_hash(r)
+      def trn_record_to_hash(r, arg={})
         @bonus[r.attributes["ID"]] = %w{BONUS MEMO}.inject(0.0){ |b,k| b > 0.0 ? b : r.attributes[k].to_f }
         @start_no[r.attributes["ID"]] = r.attributes["START_NO"]
         TRN.inject(Hash.new) do |hash, pair|
-          keys = pair[1]
-          keys = [keys] unless keys.class == Array
-          val, val2 = keys.map { |k| r.attributes[k] }
+          key = pair[1]
+          key = key[arg[pair[0]].to_s == 'intl' ? 1 : 0] if key.class == Array
+          val = r.attributes[key]
           case pair[0]
           when :fed    then val = val && val.match(/^[A-Z]{3}$/i) ? val.upcase : nil
           when :gender then val = val.to_i > 0 ? %w(M F)[val.to_i-1] : nil
-          when :id     then val = val.to_i > 0 ? val : (val2.to_i > 0 ? val2 : nil)
-          when :rating then val = val.to_i > 0 ? val : (val2.to_i > 0 ? val2 : nil)
+          when :id     then val = val.to_i > 0 ? val : nil
+          when :rating then val = val.to_i > 0 ? val : nil
           when :title  then val = val.to_i > 0 ? %w(GM WGM IM WIM FM WFM)[val.to_i-1] : nil
           end
           hash[pair[0]] = val unless val.nil? || val == ''

data/lib/icu_tournament/version.rb

@@ -1,5 +1,5 @@
 module ICU
   class Tournament
-    VERSION = "1.0.1"
+    VERSION = "1.0.3"
   end
 end

data/spec/tournament_sp_spec.rb

@@ -10,7 +10,7 @@ module ICU
   class Player
     def signature
       [
-        name, id, rating, points,
+        name, id, rating, points, rank,
         results.map{ |r| r.round }.join(''),
         results.map{ |r| r.score }.join(''),
         results.map{ |r| r.colour || "-" }.join(''),
@@ -38,10 +38,14 @@ module ICU
         end
 
         it "should have correct details for selected players" do
-          @t.player(2).signature.should  == "Mullooly, Neil M.|6438|1083|6.0|123456|WWWWWW|WBWBWB|TTTTTT" # winner
-          @t.player(4).signature.should  == "Gallagher, Mark|12138|1036|4.0|123456|WLWWWL|WBWBWB|FTTTTT"  # had one bye
-          @t.player(45).signature.should == "Catre, Loredan||507|3.5|123456|WDLWLW|BWBWBW|FTTTFT"         # had two byes
-          @t.player(56).signature.should == "McDonnell, Cathal||498|0.0|1|L|-|F"                          # last
+          @t.player(2).signature.should  == "Mullooly, Neil M.|6438|1083|6.0|1|123456|WWWWWW|WBWBWB|TTTTTT" # winner
+          @t.player(4).signature.should  == "Gallagher, Mark|12138|1036|4.0|9|123456|WLWWWL|WBWBWB|FTTTTT"  # had one bye
+          @t.player(45).signature.should == "Catre, Loredan||507|3.5|18|123456|WDLWLW|BWBWBW|FTTTFT"         # had two byes
+          @t.player(56).signature.should == "McDonnell, Cathal||498|0.0|54|1|L|-|F"                          # last
+        end
+        
+        it "should have consistent ranks" do
+          @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
         
         it "should have the correct tie breaks" do
@@ -67,10 +71,14 @@ module ICU
         end
 
         it "should have correct details for selected players" do
-          @t.player(1).signature.should == "Griffiths, Ryan-Rhys|6897|2225|3.0|123|WWW|WWB|TTT"
-          @t.player(2).signature.should == "Flynn, Jamie|5226|1633|2.0|123|WLW|WBW|TTT"
-          @t.player(3).signature.should == "Hulleman, Leon|6409|1466|1.0|123|LWL|BBW|TTT"
-          @t.player(4).signature.should == "Dunne, Thomas|10914||0.0|123|LLL|BWB|TTT"
+          @t.player(1).signature.should == "Griffiths, Ryan-Rhys|6897|2225|3.0|1|123|WWW|WWB|TTT"
+          @t.player(2).signature.should == "Flynn, Jamie|5226|1633|2.0|2|123|WLW|WBW|TTT"
+          @t.player(3).signature.should == "Hulleman, Leon|6409|1466|1.0|3|123|LWL|BBW|TTT"
+          @t.player(4).signature.should == "Dunne, Thomas|10914||0.0|4|123|LLL|BWB|TTT"
+        end
+        
+        it "should have consistent ranks" do
+          @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
         
         it "should have the no tie breaks" do
@@ -95,12 +103,16 @@ module ICU
         end
 
         it "should have correct details for selected players" do
-          @t.player(15).signature.should == "Talazec, Laurent|10692|1570|5.5|1234567|WWWDDDW|WWBWBWB|FTTTTTT"  # winner
-          @t.player(6).signature.should  == "Foenander, Phillip|7168|1434|4.0|1234567|WLWLLWW|BWBWBWB|TTFFTTT" # had some byes
-          @t.player(19).signature.should == "Wall, Robert|||3.0|34567|WWLWL|WWBBW|FTTTT"                       # didn't play 1st 2 rounds
-          @t.player(17).signature.should == "Freeman, Conor|||2.0|1234567|DDLWLLL|--BWBWB|FFTTTTT"             # had byes and bonus (in BONUS)
-          @t.player(18).signature.should == "Freeman, Ruiri|||2.0|1234567|DDLLLLW|--WBBWB|FFTTTTF"             # had byes and bonus (in BONUS)
-          @t.player(16).signature.should == "O'Connor, David|||1.0|123|WLL|WBW|FTF"                            # last
+          @t.player(15).signature.should == "Talazec, Laurent|10692|1570|5.5|1|1234567|WWWDDDW|WWBWBWB|FTTTTTT"  # winner
+          @t.player(6).signature.should  == "Foenander, Phillip|7168|1434|4.0|7|1234567|WLWLLWW|BWBWBWB|TTFFTTT" # had some byes
+          @t.player(19).signature.should == "Wall, Robert|||3.0|14|34567|WWLWL|WWBBW|FTTTT"                       # didn't play 1st 2 rounds
+          @t.player(17).signature.should == "Freeman, Conor|||2.0|16|1234567|DDLWLLL|--BWBWB|FFTTTTT"             # had byes and bonus (in BONUS)
+          @t.player(18).signature.should == "Freeman, Ruiri|||2.0|17|1234567|DDLLLLW|--WBBWB|FFTTTTF"             # had byes and bonus (in BONUS)
+          @t.player(16).signature.should == "O'Connor, David|||1.0|19|123|WLL|WBW|FTF"                            # last
+        end
+        
+        it "should have consistent ranks" do
+          @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
         
         it "should have the correct tie breaks" do
@@ -121,10 +133,14 @@ module ICU
         end
 
         it "should have correct details for selected players" do
-          @t.player(15).signature.should == "Gupta, Radhika||1247|3.0|123|WWW|BBW|TTT"            # won all his games
-          @t.player(18).signature.should == "Hurley, Thomas|6292|820|1.0|1|W|B|F"                 # scored just 1 from a bye in R1
-          @t.player(8).signature.should  == "Berney, Mark|10328|1948|2.0|23|WW|BW|TT"             # didn't play in round 1
-          @t.player(10).signature.should == "O'Donnell, Conor E.|10792|1073|2.0|123|LWW|WBW|TFT"  # got just 1 point for a bye
+          @t.player(15).signature.should == "Gupta, Radhika||1247|3.0|1|123|WWW|BBW|TTT"            # won all his games
+          @t.player(18).signature.should == "Hurley, Thomas|6292|820|1.0|14|1|W|B|F"                 # scored just 1 from a bye in R1
+          @t.player(8).signature.should  == "Berney, Mark|10328|1948|2.0|3|23|WW|BW|TT"             # didn't play in round 1
+          @t.player(10).signature.should == "O'Donnell, Conor E.|10792|1073|2.0|10|123|LWW|WBW|TFT"  # got just 1 point for a bye
+        end
+        
+        it "should have consistent ranks" do
+          @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
         
         it "should have the correct tie breaks" do
@@ -145,11 +161,43 @@ module ICU
         end
 
         it "should have correct details for selection of players who got bonuses (in MEMO)" do
-          @t.player(23).signature.should == "Long, Killian|10293|1506|2.5|123456|WDLLWL|WWBWBB|TFTTTT"
-          @t.player(26).signature.should == "Bradley, Michael|6756|1413|3.0|123456|DDLWWL|BWWBWW|TFTTTT"
-          @t.player(15).signature.should == "Twomey, Pat|1637|1656|4.5|123456|WDLWWW|WWWBWB|FFTTTT"
-          @t.player(46).signature.should == "O'Riordan, Pat|10696|900|2.0|123456|LDDLDD|BWBWWB|TTTTFT"
-          @t.player(38).signature.should == "Gill, Craig I.|10637|1081|2.0|123456|LLWDDL|BWBWWB|TTTTFT"
+          @t.player(23).signature.should == "Long, Killian|10293|1506|2.5|33|123456|WDLLWL|WWBWBB|TFTTTT"
+          @t.player(26).signature.should == "Bradley, Michael|6756|1413|3.0|26|123456|DDLWWL|BWWBWW|TFTTTT"
+          @t.player(15).signature.should == "Twomey, Pat|1637|1656|4.5|7|123456|WDLWWW|WWWBWB|FFTTTT"
+          @t.player(46).signature.should == "O'Riordan, Pat|10696|900|2.0|42|123456|LDDLDD|BWBWWB|TTTTFT"
+          @t.player(38).signature.should == "Gill, Craig I.|10637|1081|2.0|43|123456|LLWDDL|BWBWWB|TTTTFT"
+        end
+        
+        it "should have consistent ranks" do
+          @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
+        end
+      end
+
+      context "National Club Champiomships 2010" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'ncc', "2010-05-08")
+        end
+
+        it "should parse and have the right basic details" do
+          @p.error.should be_nil
+          @t.signature.should == "National Club Championship 2010|Gerry Graham|4|2010-05-08|77"
+        end
+
+        it "should have correct details for selection of players, including ICU IDs" do
+          @t.player(2).signature.should  == "Szabo, Gergely|12379|2530|4.0|4|1234|WWWW|WBWB|TTTT"
+          @t.player(5).signature.should  == "Daly, Colm|295|2314|3.5|7|1234|WWWD|WBWB|TTTT"
+          @t.player(8).signature.should  == "Vega, Marcos Llaneza||2475|3.0|16|1234|DDWW|BWBW|TTTT"
+          @t.player(67).signature.should == "Lee, Shane|780|1633|1.0|52|134|DLD|WWW|TTT"
+        end
+        
+        it "should have correct details for selection of players, including international IDs and ratings when so configured" do
+          @t = @p.parse_file(SAMPLES + 'ncc', "2010-05-08", :id => :intl, :rating => :intl)
+          @t.player(2).signature.should  == "Szabo, Gergely|1205064||4.0|4|1234|WWWW|WBWB|TTTT"
+          @t.player(5).signature.should  == "Daly, Colm|2500434||3.5|7|1234|WWWD|WBWB|TTTT"
+          @t.player(8).signature.should  == "Vega, Marcos Llaneza|2253585||3.0|16|1234|DDWW|BWBW|TTTT"
+          @t.player(67).signature.should == "Lee, Shane|||1.0|52|134|DLD|WWW|TTT"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: icu_tournament
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 +01:00
+date: 2010-05-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency