icu_tournament 1.1.2 → 1.2.0

data/lib/icu_tournament/tournament_sp.rb

@@ -5,105 +5,99 @@ require 'tempfile'
 
 module ICU
   class Tournament
-
-=begin rdoc
-
-== SwissPerfect
-
-This is the format produced by the Windows program, SwissPerfect[http://www.swissperfect.com/]. It consists of three
-files with the same name but different endings: <em>.ini</em> for meta data such as tournament name and tie-break
-rules, <em>.trn</em> for the player details such as name and rating, and <em>.sco</em> for the results. The first
-file is text and the other two are in an old binary format known as <em>DBase 3</em>.
-
-To parse such a set of files, use either the <em>parse_file!</em> or _parse_file_ method supplying the name of any one
-of the three files or just the stem name without any ending. In case of error, such as any of the files not being
-found, <em>parse_file!</em> will throw an exception while _parse_file_ will return _nil_ and record an error message.
-As well as a file name or stem name, you should also supply a start date in the options as SwissPerfect does not
-record this information.
-
-  parser = ICU::Tournament::SwissPerfect.new
-  tournament = parser.parse_file('champs', :start => '2010-07-03')  # looks for "champs.ini", "champs.trn" and "champs.sco"
-  puts tournament ? 'ok' : "problem: #{parser.error}"
-
-Alternatively, if all three files are in a ZIP archive, the parser will extract them if the name of the
-archive file is supplied to the _parse_file_ method and it ends in ".zip" (case insensitive):
-
-  tournament = parser.parse_file('champs.zip', :start => '2010-07-03')
-
-Or, if the file is a ZIP archive but it's name doesn't end in ".zip", that can be signalled with an option:
-
-  tournament = parser.parse_file('/tmp/a84f21ge', :zip => true, :start => '2010-07-03')
-
-Note there must be only three files in the archive, they must all have the same stem name and
-their endings should be ".ini", ".trn" and ".sco" (case insensitive).
-
-If no start date is supplied it will default to 2000-01-01, and can be reset later.
-
-  tournament = parser.parse_file('champs.zip')
-  tournament.start                # => '2000-01-01'
-  tournament.start = '2010-07-03'
-
-SwissPerfect files have slots for both local and international IDs and these, if present
-and if intergers are copied to the _id_ and _fide_ attributes respectively.
-
-By default, the parser extracts the local rating from the SwissPerfect files and not the international one.
-If international ratings are required instead, set the _rating_ option to "intl". For example:
-
-  tournament = parser.parse_file('ncc', :start => '2010-05-08')
-  tournament.player(2).id         # =>  12379 (ICU ID)
-  tournament.player(2).fide       # =>  1205064 (FIDE ID)
-  tournament.player(2).rating     # =>  2556 (ICU rating)
-
-  tournament = parser.parse_file('ncc', :start => '2010-05-08', :rating => 'intl')
-  tournament.player(2).rating     # =>  2530 (FIDE rating)
-
-By default, the parse will fail completely if the ".trn" file contains any invalid federations (see ICU::Federation).
-There are two alternative behaviours controlled by setting the _fed_ option:
-
-  tournament = parser.parse_file('ncc', :start => '2010-05-08', :fed == 'skip')    # => silently skips invalid federations
-  tournament = parser.parse_file('ncc', :start => '2010-05-08', :fed == 'ignore')  # => ignores all federations
-
-Note that federations that don't match 3 letters are always silently skipped.
-
-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 type into the text export format of
-erfect, an example of which is shown below.
-
-  No  Name                 Loc Id  Total   1     2     3
-
-  1   Griffiths, Ryan-Rhys 6897    3       4:W   2:W   3:W
-  2   Flynn, Jamie         5226    2       3:W   1:L   4:W
-  3   Hulleman, Leon       6409    1       2:L   4:W   1:L
-  4   Dunne, Thomas        10914   0       1:L   3:L   2:L
-
-This format is important in Irish chess, as it's the format used to submit results to the <em>MicroSoft Access</em>
-implementation of the ICU ratings database.
-
-  swiss_perfect = tournament.serialize('SwissPerfect')
-
-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 are available from the _tie_break_ method,
-for example:
-
-  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:
-
-  tournament.tie_breaks = [:wins, :blacks]
-  swiss_perfect = tournament.rerank.renumber.serialize('SwissPerfect')
-
-See ICU::Tournament for more about tie-breaks.
-
-=end
-
+    #
+    # This is the format produced by the Windows program, SwissPerfect[http://www.swissperfect.com/]. It consists of three
+    # files with the same name but different endings: <em>.ini</em> for meta data such as tournament name and tie-break
+    # rules, <em>.trn</em> for the player details such as name and rating, and <em>.sco</em> for the results. The first
+    # file is text and the other two are in an old binary format known as <em>DBase 3</em>.
+    #
+    # To parse such a set of files, use either the <em>parse_file!</em> or _parse_file_ method supplying the name of any one
+    # of the three files or just the stem name without any ending. In case of error, such as any of the files not being
+    # found, <em>parse_file!</em> will throw an exception while _parse_file_ will return _nil_ and record an error message.
+    # As well as a file name or stem name, you should also supply a start date in the options as SwissPerfect does not
+    # record this information.
+    #
+    #   parser = ICU::Tournament::SwissPerfect.new
+    #   tournament = parser.parse_file('champs', :start => '2010-07-03')  # looks for "champs.ini", "champs.trn" and "champs.sco"
+    #   puts tournament ? 'ok' : "problem: #{parser.error}"
+    #
+    # Alternatively, if all three files are in a ZIP archive, the parser will extract them if the name of the
+    # archive file is supplied to the _parse_file_ method and it ends in ".zip" (case insensitive):
+    #
+    #   tournament = parser.parse_file('champs.zip', :start => '2010-07-03')
+    #
+    # Or, if the file is a ZIP archive but it's name doesn't end in ".zip", that can be signalled with an option:
+    #
+    #   tournament = parser.parse_file('/tmp/a84f21ge', :zip => true, :start => '2010-07-03')
+    #
+    # Note there must be only three files in the archive, they must all have the same stem name and
+    # their endings should be ".ini", ".trn" and ".sco" (case insensitive).
+    #
+    # If no start date is supplied it will default to 2000-01-01, and can be reset later.
+    #
+    #   tournament = parser.parse_file('champs.zip')
+    #   tournament.start                # => '2000-01-01'
+    #   tournament.start = '2010-07-03'
+    #
+    # SwissPerfect files have slots for both local and international IDs and these, if present
+    # and if intergers are copied to the _id_ and _fide_ attributes respectively.
+    #
+    # By default, the parser extracts the local rating from the SwissPerfect files and not the international one.
+    # If international ratings are required instead, set the _rating_ option to "intl". For example:
+    #
+    #   tournament = parser.parse_file('ncc', :start => '2010-05-08')
+    #   tournament.player(2).id         # =>  12379 (ICU ID)
+    #   tournament.player(2).fide       # =>  1205064 (FIDE ID)
+    #   tournament.player(2).rating     # =>  2556 (ICU rating)
+    #
+    #   tournament = parser.parse_file('ncc', :start => '2010-05-08', :rating => 'intl')
+    #   tournament.player(2).rating     # =>  2530 (FIDE rating)
+    #
+    # By default, the parse will fail completely if the ".trn" file contains any invalid federations (see ICU::Federation).
+    # There are two alternative behaviours controlled by setting the _fed_ option:
+    #
+    #   tournament = parser.parse_file('ncc', :start => '2010-05-08', :fed == 'skip')    # => silently skips invalid federations
+    #   tournament = parser.parse_file('ncc', :start => '2010-05-08', :fed == 'ignore')  # => ignores all federations
+    #
+    # Note that federations that don't match 3 letters are always silently skipped.
+    #
+    # 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 type into the text export format of
+    # erfect, an example of which is shown below.
+    #
+    #   No  Name                 Loc Id  Total   1     2     3
+    #
+    #   1   Griffiths, Ryan-Rhys 6897    3       4:W   2:W   3:W
+    #   2   Flynn, Jamie         5226    2       3:W   1:L   4:W
+    #   3   Hulleman, Leon       6409    1       2:L   4:W   1:L
+    #   4   Dunne, Thomas        10914   0       1:L   3:L   2:L
+    #
+    # This format is important in Irish chess, as it's the format used to submit results to the <em>MicroSoft Access</em>
+    # implementation of the ICU ratings database.
+    #
+    #   swiss_perfect = tournament.serialize('SwissPerfect')
+    #
+    # 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 are available from the _tie_break_ method,
+    # for example:
+    #
+    #   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:
+    #
+    #   tournament.tie_breaks = [:wins, :blacks]
+    #   swiss_perfect = tournament.rerank.renumber.serialize('SwissPerfect')
+    #
+    # See ICU::Tournament for more about tie-breaks.
+    #
     class SwissPerfect
       attr_reader :error
 

data/lib/icu_tournament/util.rb

@@ -1,38 +1,16 @@
 module ICU
   class Util
 
-=begin rdoc
-
-== Loading the best CSV parser
-
-For Ruby 1.8.7 the CSV parser used here was FasterCSV (in preference to CSV from the standard library).
-From Ruby 1.9.1, the standard CSV is replaced by an updated version of FasterCSV while the old
-FasterCSV remains incompatible with the new Ruby. ICU::Util::CSV is therefore set to whichever
-class is the right one for the version of Ruby being used.
-
-== Parsing dates
-
-Parse dates into yyyy-mm-dd format, preferring European over US convention. Returns nil on error.
-
-  Util.parsedate('1955-11-09')       # => '1955-11-09'
-  Util.parsedate('02/03/2009')       # => '2009-03-02'
-  Util.parsedate('02/23/2009')       # => '2009-02-23'
-  Util.parsedate('16th June 1986')   # => '1986-06-16'
-
-Note that the parse method of the Date class behaves differently in Ruby 1.8.7 and 1.9.1.
-In 1.8.7 it assumes American dates and will raise ArgumentError on "30/03/2003".
-In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
-
-=end
-
-    if RUBY_VERSION > '1.9'
-      require 'csv'
-      CSV = ::CSV
-    else
-      require 'fastercsv'
-      CSV = ::FasterCSV
-    end
-
+    # Parse dates into yyyy-mm-dd format, preferring European over US convention. Returns nil on error.
+    #
+    #   Util.parsedate('1955-11-09')       # => '1955-11-09'
+    #   Util.parsedate('02/03/2009')       # => '2009-03-02'
+    #   Util.parsedate('02/23/2009')       # => '2009-02-23'
+    #   Util.parsedate('16th June 1986')   # => '1986-06-16'
+    #
+    # Note that the parse method of the Date class behaves differently in Ruby 1.8 and 1.9.
+    # In 1.8 it assumes American dates and will raise ArgumentError on "30/03/2003".
+    # In 1.9 it assumes European dates and will raise ArgumentError on "03/30/2003".
     def self.parsedate(date)
       date = date.to_s.strip
       return nil unless date.match(/[1-9]/)
@@ -44,7 +22,10 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
       end
     end
   end
-  
+
+  #
+  # Miscellaneous accessor helpers.
+  #
   module Accessor
     def attr_accessor(name, &block)
       attr_reader name
@@ -55,7 +36,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-    
+
     def attr_integer(*names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -65,7 +46,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-    
+
     def attr_integer_or_nil(*names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -80,7 +61,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-    
+
     def attr_positive(*names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -90,7 +71,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-    
+
     def attr_positive_or_nil(*names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -105,7 +86,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-  
+
     def attr_date(*names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -116,7 +97,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-  
+
     def attr_date_or_nil(*names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -131,7 +112,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-    
+
     def attr_string(regex, *names)
       names.each do |name|
         attr_accessor(name) do |val|
@@ -141,7 +122,7 @@ In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
         end
       end
     end
-    
+
     def attr_string_or_nil(regex, *names)
       names.each do |name|
         attr_accessor(name) do |val|

data/lib/icu_tournament/version.rb

@@ -1,5 +1,7 @@
+# :enddoc:
+
 module ICU
   class Tournament
-    VERSION = "1.1.2"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Mark Orr
@@ -18,7 +18,7 @@ date: 2010-12-31 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: fastercsv
+  name: inifile
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -26,14 +26,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 4
         - 0
-        version: 1.4.0
+        - 3
+        - 0
+        version: 0.3.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: inifile
+  name: dbf
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -41,14 +41,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        - 3
-        - 0
-        version: 0.3.0
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: dbf
+  name: rubyzip
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -56,14 +56,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 2
-        - 5
-        version: 1.2.5
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rubyzip
+  name: icu_name
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -72,9 +72,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 9
-        - 4
-        version: 0.9.4
+        - 0
+        - 2
+        version: 0.0.2
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -87,9 +87,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
+        - 3
         - 0
-        - 0
-        version: 2.0.0
+        version: 2.3.0
   type: :development
   version_requirements: *id005
 description: Convert files of chess tournament data in different formats to ruby classes and vice-versa.
@@ -103,7 +103,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/icu_tournament/federation.rb
-- lib/icu_tournament/name.rb
 - lib/icu_tournament/player.rb
 - lib/icu_tournament/result.rb
 - lib/icu_tournament/team.rb
@@ -115,7 +114,6 @@ files:
 - lib/icu_tournament/version.rb
 - lib/icu_tournament.rb
 - spec/federation_spec.rb
-- spec/name_spec.rb
 - spec/player_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb
@@ -154,14 +152,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: icu_tournament
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: For reading and writing files of chess tournament data.
 test_files: 
 - spec/federation_spec.rb
-- spec/name_spec.rb
 - spec/player_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb