icu_tournament 1.1.2 → 1.2.0

data/lib/icu_tournament/tournament_fcsv.rb

@@ -1,132 +1,126 @@
 module ICU
   class Tournament
-
-=begin rdoc
-
-== Foreign CSV
-
-This is a format ({specification}[http://www.icu.ie/articles/display.php?id=172]) used by the ICU[http://icu.ie]
-for players to submit their individual results in foreign tournaments for domestic rating.
-
-Suppose, for example, that the following data is the file <em>tournament.csv</em>:
-
-  Event,"Isle of Man Masters, 2007"
-  Start,2007-09-22
-  Rounds,9
-  Website,http://www.bcmchess.co.uk/monarch2007/
-
-  Player,456,Fox,Anthony
-  1,0,B,Taylor,Peter P.,2209,,ENG
-  2,=,W,Nadav,Egozi,2205,,ISR
-  3,=,B,Cafolla,Peter,2048,,IRL
-  4,1,W,Spanton,Tim R.,1982,,ENG
-  5,1,B,Grant,Alan,2223,,SCO
-  6,0,-
-  7,=,W,Walton,Alan J.,2223,,ENG
-  8,0,B,Bannink,Bernard,2271,FM,NED
-  9,=,W,Phillips,Roy,2271,,MAU
-  Total,4
-
-This file can be parsed as follows.
-
-  parser = ICU::Tournament::ForeignCSV.new
-  tournament = parser.parse_file('tournament.csv')
-
-If the file is correctly specified, the return value from the <em>parse_file</em> method is an instance of
-ICU::Tournament (rather than <em>nil</em>, which indicates an error). In this example the file is valid, so:
-
-  tournament.name                                     # => "Isle of Man Masters, 2007"
-  tournament.start                                    # => "2007-09-22"
-  tournament.rounds                                   # => 9
-  tournament.website                                  # => "http://www.bcmchess.co.uk/monarch2007/"
-
-The main player (the player whose results are being reported for rating) played 9 rounds
-but only 8 other players (he had a bye in round 6), so the total number of players is 9.
-
-  tournament.players.size                             # => 9
-
-Each player has a unique number for the tournament. The main player always occurs first in this type of file, so his number is 1.
-
-  player = tournament.player(1)
-  player.name                                         # => "Fox, Anthony"
-
-This player has 4 points from 9 rounds but only 8 of his results are are rateable (because of the bye).
-
-  player.points                                       # => 4.0
-  player.results.size                                 # => 9
-  player.results.find_all{ |r| r.rateable }.size      # => 8
-
-The other players all have numbers greater than 1.
-
-  opponents = tournamnet.players.reject { |o| o.num == 1 }
-
-There are 8 opponents (of the main player) each with exactly one game.
-
-  opponents.size                                      # => 8
-  opponents.find_all{ |o| o.results.size == 1 }.size  # => 8
-
-However, none of the opponents' results are rateable because they are foreign to the domestic rating list
-to which the main player belongs. For example:
-
-  opponent = tournament.players(2)
-  opponent.name                                       # => "Taylor, Peter P."
-  opponent.results[0].rateable                        # => false
-
-If the file contains errors, then the return value from <em>parse_file</em> is <em>nil</em> and
-an error message is returned by the <em>error</em> method of the parser object. The method
-<em>parse_file!</em> is similar except that it raises errors, and the methods <em>parse</em>
-and <em>parse!</em> are similar except their inputs are strings rather than file names.
-
-A tournament can be serialized back to CSV format (the reverse of parsing) with the _serialize_ method
-of the parser object.
-
-  csv = parser.serialize(tournament)
-
-Or equivalently, the _serialize_ instance method of the tournament, if the appropriate parser name is supplied.
-
-  csv = tournament.serialize('ForeignCSV')
-
-Extra condtions, over and above the normal validation rules, apply before any tournament validates or can be serialized in this format.
-
-* the tournament must have a _site_ attribute
-* there must be at least one player with an _id_ (interpreted as an ICU ID number)
-* all foreign players (those without an ICU ID) must have a _fed_ attribute (federation)
-* all ICU players must have a result in every round (even if it is just bye or is unrateable)
-* the opponents of all ICU players must have a federation (this could include other ICU players)
-
-If any of these are not satisfied, then the following method calls will all raise an exception:
-
-  tournament.validate!(:type => 'ForeignCSV')
-  tournament.serialize('ForeignCSV')
-  ICU::Tournament::ForeignCSV.new.serialize(tournament)
-
-You can also build the tournament object from scratch using your own data and then serialize it.
-For example, here are the commands to reproduce the example above.
-
-  t = ICU::Tournament.new("Isle of Man Masters, 2007", '2007-09-22', :rounds => 9)
-  t.site = 'http://www.bcmchess.co.uk/monarch2007/'
-  t.add_player(ICU::Player.new('Anthony',  'Fox',      1, :rating => 2100, :fed => 'IRL', :id => 456))
-  t.add_player(ICU::Player.new('Peter P.', 'Taylor',   2, :rating => 2209, :fed => 'ENG'))
-  t.add_player(ICU::Player.new('Egozi',    'Nadav',    3, :rating => 2205, :fed => 'ISR'))
-  t.add_player(ICU::Player.new('Peter',    'Cafolla',  4, :rating => 2048, :fed => 'IRL'))
-  t.add_player(ICU::Player.new('Tim R.',   'Spanton',  5, :rating => 1982, :fed => 'ENG'))
-  t.add_player(ICU::Player.new('Alan',     'Grant',    6, :rating => 2223, :fed => 'SCO'))
-  t.add_player(ICU::Player.new('Alan J.',  'Walton',   7, :rating => 2223, :fed => 'ENG'))
-  t.add_player(ICU::Player.new('Bernard',  'Bannink',  8, :rating => 2271, :fed => 'NED', :title => 'FM'))
-  t.add_player(ICU::Player.new('Roy',      'Phillips', 9, :rating => 2271, :fed => 'MAU'))
-  t.add_result(ICU::Result.new(1, 1, 'L', :opponent => 2, :colour => 'B'))
-  t.add_result(ICU::Result.new(2, 1, 'D', :opponent => 3, :colour => 'W'))
-  t.add_result(ICU::Result.new(3, 1, 'D', :opponent => 4, :colour => 'B'))
-  t.add_result(ICU::Result.new(4, 1, 'W', :opponent => 5, :colour => 'W'))
-  t.add_result(ICU::Result.new(5, 1, 'W', :opponent => 6, :colour => 'B'))
-  t.add_result(ICU::Result.new(6, 1, 'L'))
-  t.add_result(ICU::Result.new(7, 1, 'D', :opponent => 7, :colour => 'W'))
-  t.add_result(ICU::Result.new(8, 1, 'L', :opponent => 8, :colour => 'B'))
-  t.add_result(ICU::Result.new(9, 1, 'D', :opponent => 9, :colour => 'W'))
-  puts t.serialize('ForeignCSV')
-
-=end
-
+    #
+    # This is a format ({specification}[http://www.icu.ie/articles/display.php?id=172]) used by the ICU[http://icu.ie]
+    # for players to submit their individual results in foreign tournaments for domestic rating.
+    #
+    # Suppose, for example, that the following data is the file <em>tournament.csv</em>:
+    #
+    #   Event,"Isle of Man Masters, 2007"
+    #   Start,2007-09-22
+    #   Rounds,9
+    #   Website,http://www.bcmchess.co.uk/monarch2007/
+    #
+    #   Player,456,Fox,Anthony
+    #   1,0,B,Taylor,Peter P.,2209,,ENG
+    #   2,=,W,Nadav,Egozi,2205,,ISR
+    #   3,=,B,Cafolla,Peter,2048,,IRL
+    #   4,1,W,Spanton,Tim R.,1982,,ENG
+    #   5,1,B,Grant,Alan,2223,,SCO
+    #   6,0,-
+    #   7,=,W,Walton,Alan J.,2223,,ENG
+    #   8,0,B,Bannink,Bernard,2271,FM,NED
+    #   9,=,W,Phillips,Roy,2271,,MAU
+    #   Total,4
+    #
+    # This file can be parsed as follows.
+    #
+    #   parser = ICU::Tournament::ForeignCSV.new
+    #   tournament = parser.parse_file('tournament.csv')
+    #
+    # If the file is correctly specified, the return value from the <em>parse_file</em> method is an instance of
+    # ICU::Tournament (rather than <em>nil</em>, which indicates an error). In this example the file is valid, so:
+    #
+    #   tournament.name                                     # => "Isle of Man Masters, 2007"
+    #   tournament.start                                    # => "2007-09-22"
+    #   tournament.rounds                                   # => 9
+    #   tournament.website                                  # => "http://www.bcmchess.co.uk/monarch2007/"
+    #
+    # The main player (the player whose results are being reported for rating) played 9 rounds
+    # but only 8 other players (he had a bye in round 6), so the total number of players is 9.
+    #
+    #   tournament.players.size                             # => 9
+    #
+    # Each player has a unique number for the tournament. The main player always occurs first in this type of file, so his number is 1.
+    #
+    #   player = tournament.player(1)
+    #   player.name                                         # => "Fox, Anthony"
+    #
+    # This player has 4 points from 9 rounds but only 8 of his results are are rateable (because of the bye).
+    #
+    #   player.points                                       # => 4.0
+    #   player.results.size                                 # => 9
+    #   player.results.find_all{ |r| r.rateable }.size      # => 8
+    #
+    # The other players all have numbers greater than 1.
+    #
+    #   opponents = tournamnet.players.reject { |o| o.num == 1 }
+    #
+    # There are 8 opponents (of the main player) each with exactly one game.
+    #
+    #   opponents.size                                      # => 8
+    #   opponents.find_all{ |o| o.results.size == 1 }.size  # => 8
+    #
+    # However, none of the opponents' results are rateable because they are foreign to the domestic rating list
+    # to which the main player belongs. For example:
+    #
+    #   opponent = tournament.players(2)
+    #   opponent.name                                       # => "Taylor, Peter P."
+    #   opponent.results[0].rateable                        # => false
+    #
+    # If the file contains errors, then the return value from <em>parse_file</em> is <em>nil</em> and
+    # an error message is returned by the <em>error</em> method of the parser object. The method
+    # <em>parse_file!</em> is similar except that it raises errors, and the methods <em>parse</em>
+    # and <em>parse!</em> are similar except their inputs are strings rather than file names.
+    #
+    # A tournament can be serialized back to CSV format (the reverse of parsing) with the _serialize_ method
+    # of the parser object.
+    #
+    #   csv = parser.serialize(tournament)
+    #
+    # Or equivalently, the _serialize_ instance method of the tournament, if the appropriate parser name is supplied.
+    #
+    #   csv = tournament.serialize('ForeignCSV')
+    #
+    # Extra condtions, over and above the normal validation rules, apply before any tournament validates or can be serialized in this format.
+    #
+    # * the tournament must have a _site_ attribute
+    # * there must be at least one player with an _id_ (interpreted as an ICU ID number)
+    # * all foreign players (those without an ICU ID) must have a _fed_ attribute (federation)
+    # * all ICU players must have a result in every round (even if it is just bye or is unrateable)
+    # * the opponents of all ICU players must have a federation (this could include other ICU players)
+    #
+    # If any of these are not satisfied, then the following method calls will all raise an exception:
+    #
+    #   tournament.validate!(:type => 'ForeignCSV')
+    #   tournament.serialize('ForeignCSV')
+    #   ICU::Tournament::ForeignCSV.new.serialize(tournament)
+    #
+    # You can also build the tournament object from scratch using your own data and then serialize it.
+    # For example, here are the commands to reproduce the example above.
+    #
+    #   t = ICU::Tournament.new("Isle of Man Masters, 2007", '2007-09-22', :rounds => 9)
+    #   t.site = 'http://www.bcmchess.co.uk/monarch2007/'
+    #   t.add_player(ICU::Player.new('Anthony',  'Fox',      1, :rating => 2100, :fed => 'IRL', :id => 456))
+    #   t.add_player(ICU::Player.new('Peter P.', 'Taylor',   2, :rating => 2209, :fed => 'ENG'))
+    #   t.add_player(ICU::Player.new('Egozi',    'Nadav',    3, :rating => 2205, :fed => 'ISR'))
+    #   t.add_player(ICU::Player.new('Peter',    'Cafolla',  4, :rating => 2048, :fed => 'IRL'))
+    #   t.add_player(ICU::Player.new('Tim R.',   'Spanton',  5, :rating => 1982, :fed => 'ENG'))
+    #   t.add_player(ICU::Player.new('Alan',     'Grant',    6, :rating => 2223, :fed => 'SCO'))
+    #   t.add_player(ICU::Player.new('Alan J.',  'Walton',   7, :rating => 2223, :fed => 'ENG'))
+    #   t.add_player(ICU::Player.new('Bernard',  'Bannink',  8, :rating => 2271, :fed => 'NED', :title => 'FM'))
+    #   t.add_player(ICU::Player.new('Roy',      'Phillips', 9, :rating => 2271, :fed => 'MAU'))
+    #   t.add_result(ICU::Result.new(1, 1, 'L', :opponent => 2, :colour => 'B'))
+    #   t.add_result(ICU::Result.new(2, 1, 'D', :opponent => 3, :colour => 'W'))
+    #   t.add_result(ICU::Result.new(3, 1, 'D', :opponent => 4, :colour => 'B'))
+    #   t.add_result(ICU::Result.new(4, 1, 'W', :opponent => 5, :colour => 'W'))
+    #   t.add_result(ICU::Result.new(5, 1, 'W', :opponent => 6, :colour => 'B'))
+    #   t.add_result(ICU::Result.new(6, 1, 'L'))
+    #   t.add_result(ICU::Result.new(7, 1, 'D', :opponent => 7, :colour => 'W'))
+    #   t.add_result(ICU::Result.new(8, 1, 'L', :opponent => 8, :colour => 'B'))
+    #   t.add_result(ICU::Result.new(9, 1, 'D', :opponent => 9, :colour => 'W'))
+    #   puts t.serialize('ForeignCSV')
+    #
     class ForeignCSV
       attr_reader :error
 
@@ -135,7 +129,7 @@ For example, here are the commands to reproduce the example above.
         @state, @line, @round, @sum, @error = 0, 0, nil, nil, nil
         @tournament = Tournament.new('Dummy', '2000-01-01')
 
-        Util::CSV.parse(csv, :row_sep => :auto) do |r|
+        CSV.parse(csv, :row_sep => :auto) do |r|
           @line += 1                            # increment line number
           next if r.size == 0                   # skip empty lines
           r = r.map{|c| c.nil? ? '' : c.strip}  # trim all spaces, turn nils to blanks
@@ -207,7 +201,7 @@ For example, here are the commands to reproduce the example above.
       # Serialise a tournament back into CSV format.
       def serialize(t, arg={})
         t.validate!(:type => self)
-        Util::CSV.generate do |csv|
+        CSV.generate do |csv|
           csv << ["Event", t.name]
           csv << ["Start", t.start]
           csv << ["Rounds", t.rounds]

data/lib/icu_tournament/tournament_krause.rb

@@ -1,118 +1,112 @@
 module ICU
   class Tournament
-
-=begin rdoc
-
-== Krause
-
-This is the {format}[http://www.fide.com/component/content/article/5-whats-news/2245-736-general-data-exchange-format-for-tournament-results]
-used to submit tournament results to FIDE[http://www.fide.com] for rating.
-
-Suppose, for example, that the following data is the file <em>tournament.tab</em>:
-
-  012 Fantasy Tournament
-  032 IRL
-  042 2009.09.09
-  0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
-  132                                                                                        09.09.09  09.09.10  09.09.11
-  001    1 w    Mouse,Minerva                     1900 USA     1234567 1928.05.15  1.0    2     2 b 0     3 w 1
-  001    2 m  m Duck,Daffy                        2200 IRL     7654321 1937.04.17  2.0    1     1 w 1               3 b 1
-  001    3 m  g Mouse,Mickey                      2600 USA     1726354 1928.05.15  0.0    3               1 b 0     2 w 0
-
-This file can be parsed as follows.
-
-  parser = ICU::Tournament::Krause.new
-  tournament = parser.parse_file('tournament.tab')
-
-If the file is correctly specified, the return value from the <em>parse_file</em> method is an instance of
-ICU::Tournament (rather than <em>nil</em>, which indicates an error). In this example the file is valid, so:
-
-  tournament.name                   # => "Fantasy Tournament"
-  tournament.start                  # => "2009-09-09"
-  tournament.fed                    # => "IRL"
-  tournament.players.size           # => 9
-
-Some values, not explicitly set in the file, are deduced:
-
-  tournament.rounds                 # => 3
-  tournament.finish                 # => "2009-09-11"
-
-A player can be retrieved from the tournament via the _players_ array or by sending a valid player number to the _player_ method.
-
-  minnie = tournament.player(1)
-  minnie.name                       # => "Mouse, Minerva"
-  minnie.points                     # => 1.0
-  minnie.results.size               # => 2
-
-  daffy = tournament.player(2)
-  daffy.title                       # => "IM"
-  daffy.rating                      # => 2200
-  daffy.fed                         # => "IRL"
-  daffy.id                          # => 7654321
-  daffy.fide                        # => nil
-  daffy.dob                         # => "1937-04-17"
-
-By default, ID numbers in the input are interpreted as local IDs. If, instead, they should be interpreted as
-FIDE IDs, add the following option:
-
-  tournament = parser.parse_file('tournament.tab', :fide => true)
-  daffy = tournament.player(2)
-  daffy.id                          # => nil
-  daffy.fide                        # => 7654321
-
-If the ranking numbers are missing from the file or inconsistent (e.g. player A is ranked above player B
-but has less points than player B) they are recalculated as a side effect of the parse.
-
-  daffy.rank                        # => 1
-  minnie.rank                       # => 2
-  mickey.rank                       # => 3
-
-Comments in the input file (lines that do not start with a valid data identification number) are available from the parser
-instance via its _comments_ method (returning a string). Note that these comments are reset evry time the instance is used
-to parse another file.
-
-  parser.comments                   # => "0123456789..."
-
-If the file contains errors, then the return value from <em>parse_file</em> is <em>nil</em> and
-an error message is returned by the <em>error</em> method of the parser object. The method
-<em>parse_file!</em> is similar except that it raises errors, and the methods <em>parse</em>
-and <em>parse!</em> are similar except their inputs are strings rather than file names.
-
-A tournament can be serialized back to Krause format (the reverse of parsing) with the _serialize_ method of the parser.
-
-  krause = parser.serialize(tournament)
-
-Or alternatively, by the _serialize_ method of the tournament object if the name of the serializer is supplied.
-
-  krause = tournament.serialize('Krause')
-
-By default, local (ICU) IDs are used for the serialization, but both methods accept an option that
-causes FIDE IDs to be used instead:
-
-  krause = parser.serialize(tournament, :fide => true)
-  krause = parser.serialize(tournament, :fide => true)
-
-The following lists Krause data identification numbers, their description and, where available, their corresponding
-attributes in an ICU::Tournament instance.
-
-[001 Player record]           Use _players_ to get all players or _player_ with a player number to get a single instance.
-[012 Name]                    Get or set with _name_. Free text. A tounament name is mandatory.
-[013 Teams]                   Create an ICU::Team, add player numbers to it, use _add_team_ to add to tournament, _get_team_/_teams_ to retrive it/them.
-[022 City]                    Get or set with _city_. Free text.
-[032 Federation]              Get or set with _fed_. Getter returns either _nil_ or a three letter code. Setter can take various formats (see ICU::Federation).
-[042 Start date]              Get or set with _start_. Getter returns <em>yyyy-mm-dd</em> format, but setter can use any reasonable date format. Start date is mandadory.
-[052 End date]                Get or set with _finish_. Returns either <em>yyyy-mm-dd</em> format or _nil_ if not set. Like _start_, can be set with various date formats.
-[062 Number of players]       Not used. Treated as comment in parsed files. Can be determined from the size of the _players_ array.
-[072 Number of rated players] Not used. Treated as comment in parsed files. Can be determined by analysing the array returned by _players_.
-[082 Number of teams]         Not used. Treated as comment in parsed files.
-[092 Type of tournament]      Get or set with _type_. Free text.
-[102 Arbiter(s)]              Get or set with -arbiter_. Free text.
-[112 Deputy(ies)]             Get or set with _deputy_. Free text.
-[122 Time control]            Get or set with _time_control_. Free text.
-[132 Round dates]             Get an array of dates using _round_dates_ or one specific round date by calling _round_date_ with a round number.
-
-=end
-
+    #
+    # This is the {format}[http://www.fide.com/component/content/article/5-whats-news/2245-736-general-data-exchange-format-for-tournament-results]
+    # used to submit tournament results to FIDE[http://www.fide.com] for rating.
+    #
+    # Suppose, for example, that the following data is the file <em>tournament.tab</em>:
+    #
+    #   012 Fantasy Tournament
+    #   032 IRL
+    #   042 2009.09.09
+    #   0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
+    #   132                                                                                        09.09.09  09.09.10  09.09.11
+    #   001    1 w    Mouse,Minerva                     1900 USA     1234567 1928.05.15  1.0    2     2 b 0     3 w 1
+    #   001    2 m  m Duck,Daffy                        2200 IRL     7654321 1937.04.17  2.0    1     1 w 1               3 b 1
+    #   001    3 m  g Mouse,Mickey                      2600 USA     1726354 1928.05.15  0.0    3               1 b 0     2 w 0
+    #
+    # This file can be parsed as follows.
+    #
+    #   parser = ICU::Tournament::Krause.new
+    #   tournament = parser.parse_file('tournament.tab')
+    #
+    # If the file is correctly specified, the return value from the <em>parse_file</em> method is an instance of
+    # ICU::Tournament (rather than <em>nil</em>, which indicates an error). In this example the file is valid, so:
+    #
+    #   tournament.name                   # => "Fantasy Tournament"
+    #   tournament.start                  # => "2009-09-09"
+    #   tournament.fed                    # => "IRL"
+    #   tournament.players.size           # => 9
+    #
+    # Some values, not explicitly set in the file, are deduced:
+    #
+    #   tournament.rounds                 # => 3
+    #   tournament.finish                 # => "2009-09-11"
+    #
+    # A player can be retrieved from the tournament via the _players_ array or by sending a valid player number to the _player_ method.
+    #
+    #   minnie = tournament.player(1)
+    #   minnie.name                       # => "Mouse, Minerva"
+    #   minnie.points                     # => 1.0
+    #   minnie.results.size               # => 2
+    #
+    #   daffy = tournament.player(2)
+    #   daffy.title                       # => "IM"
+    #   daffy.rating                      # => 2200
+    #   daffy.fed                         # => "IRL"
+    #   daffy.id                          # => 7654321
+    #   daffy.fide                        # => nil
+    #   daffy.dob                         # => "1937-04-17"
+    #
+    # By default, ID numbers in the input are interpreted as local IDs. If, instead, they should be interpreted as
+    # FIDE IDs, add the following option:
+    #
+    #   tournament = parser.parse_file('tournament.tab', :fide => true)
+    #   daffy = tournament.player(2)
+    #   daffy.id                          # => nil
+    #   daffy.fide                        # => 7654321
+    #
+    # If the ranking numbers are missing from the file or inconsistent (e.g. player A is ranked above player B
+    # but has less points than player B) they are recalculated as a side effect of the parse.
+    #
+    #   daffy.rank                        # => 1
+    #   minnie.rank                       # => 2
+    #   mickey.rank                       # => 3
+    #
+    # Comments in the input file (lines that do not start with a valid data identification number) are available from the parser
+    # instance via its _comments_ method (returning a string). Note that these comments are reset evry time the instance is used
+    # to parse another file.
+    #
+    #   parser.comments                   # => "0123456789..."
+    #
+    # If the file contains errors, then the return value from <em>parse_file</em> is <em>nil</em> and
+    # an error message is returned by the <em>error</em> method of the parser object. The method
+    # <em>parse_file!</em> is similar except that it raises errors, and the methods <em>parse</em>
+    # and <em>parse!</em> are similar except their inputs are strings rather than file names.
+    #
+    # A tournament can be serialized back to Krause format (the reverse of parsing) with the _serialize_ method of the parser.
+    #
+    #   krause = parser.serialize(tournament)
+    #
+    # Or alternatively, by the _serialize_ method of the tournament object if the name of the serializer is supplied.
+    #
+    #   krause = tournament.serialize('Krause')
+    #
+    # By default, local (ICU) IDs are used for the serialization, but both methods accept an option that
+    # causes FIDE IDs to be used instead:
+    #
+    #   krause = parser.serialize(tournament, :fide => true)
+    #   krause = parser.serialize(tournament, :fide => true)
+    #
+    # The following lists Krause data identification numbers, their description and, where available, their corresponding
+    # attributes in an ICU::Tournament instance.
+    #
+    # [001 Player record]           Use _players_ to get all players or _player_ with a player number to get a single instance.
+    # [012 Name]                    Get or set with _name_. Free text. A tounament name is mandatory.
+    # [013 Teams]                   Create an ICU::Team, add player numbers to it, use _add_team_ to add to tournament, _get_team_/_teams_ to retrive it/them.
+    # [022 City]                    Get or set with _city_. Free text.
+    # [032 Federation]              Get or set with _fed_. Getter returns either _nil_ or a three letter code. Setter can take various formats (see ICU::Federation).
+    # [042 Start date]              Get or set with _start_. Getter returns <em>yyyy-mm-dd</em> format, but setter can use any reasonable date format. Start date is mandadory.
+    # [052 End date]                Get or set with _finish_. Returns either <em>yyyy-mm-dd</em> format or _nil_ if not set. Like _start_, can be set with various date formats.
+    # [062 Number of players]       Not used. Treated as comment in parsed files. Can be determined from the size of the _players_ array.
+    # [072 Number of rated players] Not used. Treated as comment in parsed files. Can be determined by analysing the array returned by _players_.
+    # [082 Number of teams]         Not used. Treated as comment in parsed files.
+    # [092 Type of tournament]      Get or set with _type_. Free text.
+    # [102 Arbiter(s)]              Get or set with -arbiter_. Free text.
+    # [112 Deputy(ies)]             Get or set with _deputy_. Free text.
+    # [122 Time control]            Get or set with _time_control_. Free text.
+    # [132 Round dates]             Get an array of dates using _round_dates_ or one specific round date by calling _round_date_ with a round number.
+    #
     class Krause
       attr_reader :error, :comments