icu_tournament 1.3.15 → 1.4.0

data/lib/icu_tournament/tournament_krause.rb

@@ -57,8 +57,8 @@ module ICU
     #   daffy.rating                      # => nil
     #   daffy.fide_rating                 # => 2200
     #
-    # ID numbers, on the other hand, are automatically classified as either FIDE or ICU on the basis of size,
-    # since all FIDE IDs are greater than 100000 whereas ICU IDs are much smaller.
+    # ID numbers, on the other hand, are automatically classified as either FIDE or ICU on the basis of size.
+    # IDs larger than 100000 are assumed to be FIDE IDs, while smaller numbers are treated as ICU IDs.
     #
     # If the ranking numbers are missing from the file or inconsistent (e.g. player A is ranked above player B
     # but has less points) they are recalculated as a side effect of the parse.
@@ -78,6 +78,8 @@ module ICU
     # <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.
     #
+    # == Serialization
+    #
     # A tournament can be serialized back to Krause format (the reverse of parsing) with the _serialize_ method of the parser.
     #
     #   krause = parser.serialize(tournament)
@@ -92,24 +94,20 @@ module ICU
     #   krause = parser.serialize(tournament, :fide => true)
     #   krause = tournament.serialize('Krause', :fide => true)
     #
-    # The following lists Krause data identification numbers, their description and, where available, their corresponding
-    # attributes in an ICU::Tournament instance.
+    # By default all available information is output for each player, however, this is customizable. The player number,
+    # name, total points and results are always output but any of the remaining data (_gender_, _title_, _rating_ or _fide_rating_,
+    # _fed_, _id_ or _fide_id_, _dob_ and _rank_) can be omitted, if desired, by specifying an array of columns to include.
+    # To omitt all the optional data, supply an empty array:
     #
-    # [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.
+    #   krause = tournament.serialize('Krause', :columns => [])
+    #
+    # To omitt, for example, just federation and rating, include all columns but those two:
+    #
+    #   krause = tournament.serialize('Krause', :columns => [:gender, :title, :id, :dob, :rank])
+    #
+    # To output FIDE IDs and ratings use the _fide_ option in conjunctions with the _id_ and _rating_ columns:
+    #
+    #   krause = tournament.serialize('Krause', :columns => [:id, :rating], :fide => true)
     #
     # == Parser Strictness
     #
@@ -172,6 +170,27 @@ module ICU
     #   001    1      Mouse,Minerva                                                      1.0    2     2 b 0  0000 - +
     #   001    2      Mouse,Mickey                                                       1.5    1     1 w 1  0000 - =
     #
+    # == Tournament Attributes
+    #
+    # 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
 
@@ -481,17 +500,40 @@ module ICU
   class Player
     # Format a player's 001 record as it would appear in a Krause formatted file (including the final newline).
     def to_krause(rounds, arg)
+      default = [:gender, :title, :rating, :fed, :id, :dob, :rank]
+
+      # Optional columns.
+      optional = arg[:columns] if arg[:columns].instance_of?(Array)
+      optional.map!(&:to_s).map!(&:to_sym) if optional
+      optional = default.dup unless optional
+      optional = optional.inject({}) { |m, a| m[a] = true; m }
+
+      # Get the values to use.
+      val = default.inject({}) do |m, a|
+        if optional[a]
+          if arg[:fide] && (a == :rating || a == :id)
+            m[a] = send("fide_#{a}")
+          else
+            m[a] = send(a)
+          end
+        end
+        m
+      end
+      
+      # Output the mandatory and optional values.
       krause = '001'
       krause << sprintf(' %4d', @num)
-      krause << sprintf(' %1s', case @gender; when 'M' then 'm'; when 'F' then 'w'; else ''; end)
-      krause << sprintf(' %2s', case @title; when nil then ''; when 'IM' then 'm'; when 'WIM' then 'wm'; else @title[0, @title.length-1].downcase; end)
+      krause << sprintf(' %1s', case val[:gender]; when 'M' then 'm'; when 'F' then 'w'; else ''; end)
+      krause << sprintf(' %2s', case val[:title]; when nil then ''; when 'IM' then 'm'; when 'WIM' then 'wm'; else val[:title][0, val[:title].length-1].downcase; end)
       krause << sprintf(' %-33s', "#{@last_name},#{@first_name}")
-      krause << sprintf(' %4s', arg[:fide] ? @fide_rating : @rating)
-      krause << sprintf(' %3s', @fed)
-      krause << sprintf(' %11s', arg[:fide] ? @fide_id : @id)
-      krause << sprintf(' %10s', @dob)
+      krause << sprintf(' %4s', val[:rating])
+      krause << sprintf(' %3s', val[:fed])
+      krause << sprintf(' %11s', val[:id])
+      krause << sprintf(' %10s', val[:dob])
       krause << sprintf(' %4.1f', points)
-      krause << sprintf(' %4s', @rank)
+      krause << sprintf(' %4s', val[:rank])
+      
+      # And finally the round scores.
       (1..rounds).each do |r|
         result = find_result(r)
         krause << sprintf('  %8s', result ? result.to_krause : '')

data/lib/icu_tournament/tournament_spx.rb

@@ -197,8 +197,9 @@ module ICU
         rounds = t.last_round
 
         # Optional columns.
-        optional = arg[:columns] if arg.instance_of?(Hash) && arg[:columns].instance_of?(Array)
+        optional = arg[:columns] if arg[:columns].instance_of?(Array)
         optional = [:id, :points] unless optional
+        optional.map!(&:to_s).map!(&:to_sym)
 
         # Columns identifiers in SwissPerfect order.
         columns = Array.new

data/lib/icu_tournament/version.rb

@@ -2,6 +2,6 @@
 
 module ICU
   class Tournament
-    VERSION = "1.3.15"
+    VERSION = "1.4.0"
   end
 end

data/spec/tournament_krause_spec.rb

@@ -321,6 +321,120 @@ KRAUSE
         end
       end
 
+      context "customised serialisation with ICU IDs" do
+        before(:all) do
+          @k = <<KRAUSE
+012 Las Vegas National Open
+042 2008-06-07
+0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
+001    1 w    Ui Laighleis,Gearoidin            1985 IRL        3364 1964-06-10  1.0    2     2 b 0     3 w 1          
+001    2    m Orr,Mark                          2258 IRL        1350 1955-11-09  2.0    1     1 w 1               3 b 1
+001    3    g Svidler,Peter                     2663 RUS       16790 1971-01-01  0.0    3               1 b 0     2 w 0
+KRAUSE
+          @p = ICU::Tournament::Krause.new
+          @t = @p.parse(@k)
+        end
+
+        it "should include all data without any explict cusromisation" do
+          text = @t.serialize('Krause')
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin            1985 IRL        3364 1964-06-10  1.0    2/)
+          text.should match(/001    2    m Orr,Mark                          2258 IRL        1350 1955-11-09  2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                     2663 RUS       16790 1971-01-01  0.0    3/)
+        end
+
+        it "should omitt ratings and IDs if FIDE option is chosen" do
+          text = @t.serialize('Krause', :fide => true)
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin                 IRL             1964-06-10  1.0    2/)
+          text.should match(/001    2    m Orr,Mark                               IRL             1955-11-09  2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                          RUS             1971-01-01  0.0    3/)
+        end
+
+        it "should omitt all optional data if columns option is an empty hash" do
+          text = @t.serialize('Krause', :columns => [])
+          text.should match(/001    1      Ui Laighleis,Gearoidin                                             1.0     /)
+          text.should match(/001    2      Orr,Mark                                                           2.0     /)
+          text.should match(/001    3      Svidler,Peter                                                      0.0     /)
+        end
+
+        it "should should be able to include a subset of attributes, test 1" do
+          text = @t.serialize('Krause', :columns => [:gender, "dob", :id, "rubbish"])
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin                            3364 1964-06-10  1.0     /)
+          text.should match(/001    2      Orr,Mark                                          1350 1955-11-09  2.0     /)
+          text.should match(/001    3      Svidler,Peter                                    16790 1971-01-01  0.0     /)
+        end
+
+        it "should should be able to include a subset of attributes, test 2" do
+          text = @t.serialize('Krause', :columns => [:rank, "title", :fed, "rating"])
+          text.should match(/001    1      Ui Laighleis,Gearoidin            1985 IRL                         1.0    2/)
+          text.should match(/001    2    m Orr,Mark                          2258 IRL                         2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                     2663 RUS                         0.0    3/)
+        end
+
+        it "should should be able to include all attributes" do
+          text = @t.serialize('Krause', :columns => [:gender, :title, :rating, :fed, :id, :dob, :rank])
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin            1985 IRL        3364 1964-06-10  1.0    2/)
+          text.should match(/001    2    m Orr,Mark                          2258 IRL        1350 1955-11-09  2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                     2663 RUS       16790 1971-01-01  0.0    3/)
+        end
+      end
+
+      context "customised serialisation with FIDE IDs" do
+        before(:all) do
+          @k = <<KRAUSE
+012 Las Vegas National Open
+042 2008-06-07
+0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
+001    1 w    Ui Laighleis,Gearoidin            1985 IRL     2501171 1964-06-10  1.0    2     2 b 0     3 w 1          
+001    2    m Orr,Mark                          2258 IRL     2500035 1955-11-09  2.0    1     1 w 1               3 b 1
+001    3    g Svidler,Peter                     2663 RUS     4102142 1971-01-01  0.0    3               1 b 0     2 w 0
+KRAUSE
+          @p = ICU::Tournament::Krause.new
+          @t = @p.parse(@k, :fide => true)
+        end
+
+        it "should include all data without any explict cusromisation" do
+          text = @t.serialize('Krause', :fide => true)
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin            1985 IRL     2501171 1964-06-10  1.0    2/)
+          text.should match(/001    2    m Orr,Mark                          2258 IRL     2500035 1955-11-09  2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                     2663 RUS     4102142 1971-01-01  0.0    3/)
+        end
+
+        it "should omitt ratings and IDs if FIDE option is not chosen" do
+          text = @t.serialize('Krause')
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin                 IRL             1964-06-10  1.0    2/)
+          text.should match(/001    2    m Orr,Mark                               IRL             1955-11-09  2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                          RUS             1971-01-01  0.0    3/)
+        end
+
+        it "should omitt all optional data if columns option is an empty hash" do
+          text = @t.serialize('Krause', :columns => [])
+          text.should match(/001    1      Ui Laighleis,Gearoidin                                             1.0     /)
+          text.should match(/001    2      Orr,Mark                                                           2.0     /)
+          text.should match(/001    3      Svidler,Peter                                                      0.0     /)
+        end
+
+        it "should should be able to include a subset of attributes, test 1" do
+          text = @t.serialize('Krause', :columns => [:gender, "dob", :id], :fide => true)
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin                         2501171 1964-06-10  1.0     /)
+          text.should match(/001    2      Orr,Mark                                       2500035 1955-11-09  2.0     /)
+          text.should match(/001    3      Svidler,Peter                                  4102142 1971-01-01  0.0     /)
+        end
+
+        it "should should be able to include a subset of attributes, test 2" do
+          text = @t.serialize('Krause', :columns => [:rank, "title", :fed, "rating", :rubbish], :fide => true)
+          text.should match(/001    1      Ui Laighleis,Gearoidin            1985 IRL                         1.0    2/)
+          text.should match(/001    2    m Orr,Mark                          2258 IRL                         2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                     2663 RUS                         0.0    3/)
+        end
+
+        it "should should be able to include all attributes" do
+          text = @t.serialize('Krause', :columns => [:gender, :title, :rating, :fed, :id, :dob, :rank], :fide => true)
+          text.should match(/001    1 w    Ui Laighleis,Gearoidin            1985 IRL     2501171 1964-06-10  1.0    2/)
+          text.should match(/001    2    m Orr,Mark                          2258 IRL     2500035 1955-11-09  2.0    1/)
+          text.should match(/001    3    g Svidler,Peter                     2663 RUS     4102142 1971-01-01  0.0    3/)
+        end
+      end
+
       context "errors" do
         before(:each) do
           @k = <<KRAUSE

data/spec/tournament_spx_spec.rb

@@ -156,9 +156,9 @@ EXPORT
           @x.should match(/^No\s*Name\s*Loc Id\s*Total\s*1\s*2\s*3\s*/)
           @x = @t.serialize('SPExport', :columns => [:points, :id, :fed])
           @x.should match(/^No\s*Name\s*Feder\s*Loc Id\s*Total\s*1\s*2\s*3\s*/)
-          @x = @t.serialize('SPExport', :columns => [:points, :id, :fed, :fed, :rubbish, :fide_id])
+          @x = @t.serialize('SPExport', :columns => [:points, :id, :fed, "fed", :rubbish, :fide_id])
           @x.should match(/^No\s*Name\s*Feder\s*Intl Id\s*Loc Id\s*Total\s*1\s*2\s*3\s*/)
-          @x = @t.serialize('SPExport', :columns => [:fed, :fide_id, :points, :id, :rating])
+          @x = @t.serialize('SPExport', :columns => [:fed, "fide_id", :points, :id, :rating])
           @x.should match(/^No\s*Name\s*Feder\s*Intl Id\s*Loc Id\s*Loc\s*Total\s*1\s*2\s*3\s*/)
           @x = @t.serialize('SPExport', :columns => [:fed, :fide_id, :fide_rating, :points, :id, :rating])
           @x.should match(/^No\s*Name\s*Feder\s*Intl Id\s*Loc Id\s*Rtg\s*Loc\s*Total\s*1\s*2\s*3\s*/)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 3
-  - 15
-  version: 1.3.15
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Mark Orr
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-16 00:00:00 +01:00
+date: 2011-04-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency