icu_tournament 1.3.10 → 1.3.11

data/lib/icu_tournament/player.rb

@@ -169,10 +169,10 @@ module ICU
     # Add a result. Don't use this method directly - use ICU::Tournament#add_result instead.
     def add_result(result)
       raise "invalid result" unless result.class == ICU::Result
-      raise "player number (#{@num}) is not matched to result player number (#{result.player})" unless @num == result.player
+      raise "player number (#{@num}) is not matched to result player number (#{result.inspect})" unless @num == result.player
       already = @results.find_all { |r| r.round == result.round }
       return if already.size == 1 && already[0].eql?(result)
-      raise "round number (#{result.round}) of new result is not unique and new result is not the same as existing one" unless already.size == 0
+      raise "player #{@num} already has a result in round #{result.round} (#{already[0].inspect}) which does not match the one being added (#{result.inspect})" unless already.size == 0
       if @results.size == 0 || @results.last.round <= result.round
         @results << result
       else

data/lib/icu_tournament/result.rb

@@ -51,13 +51,7 @@ module ICU
   #   tluser.colour       # => 'B'
   #   tluser.round        # => 2
   #
-  # The reversed result copies the _rateable_ attribute of the original unless an
-  # explicit override is supplied.
-  #
-  #   result.rateable                 # => true
-  #   result.reverse.rateable         # => true (copied from original)
-  #   result.reverse(false).rateable  # => false (overriden)
-  #
+  # The _rateable_ attribute is the same in a result and it's reverse.
   # A result which has no opponent is not reversible (the _reverse_ method returns _nil_).
   #
   # The return value from the _score_ method is always one of _W_, _L_ or _D_. However,
@@ -145,13 +139,13 @@ module ICU
     end
 
     # Return a reversed version (from the opponent's perspective) of a result.
-    def reverse(rateable=nil)
+    def reverse
       return unless @opponent
       r = Result.new(@round, @opponent, @score == 'W' ? 'L' : (@score == 'L' ? 'W' : 'D'))
       r.opponent = @player
       r.colour = 'W' if @colour == 'B'
       r.colour = 'B' if @colour == 'W'
-      r.rateable = rateable || @rateable
+      r.rateable = @rateable
       r
     end
 
@@ -167,6 +161,11 @@ module ICU
       end
       self
     end
+    
+    # Short descrition mainly for debugging.
+    def inspect
+      "R#{@round}P#{@player}O#{@opponent || '-'}#{@score}#{@colour || '-'}#{@rateable ? 'R' : 'U'}"
+    end
 
     # Loose equality. True if the round, player and opponent numbers, colour and score all match.
     def ==(other)

data/lib/icu_tournament/tournament.rb

@@ -44,6 +44,17 @@ module ICU
   # raise an exception if the players it references through their tournament numbers
   # (10, 20 and 30 in this example) have not already been added to the tournament.
   #
+  # Adding a result from the perspective of one player automatically adds it from the
+  # perspective of the opponent, if there is one. The result may subsequently be added
+  # explicitly from opponent's perspective as long as it does not contradict what was
+  # implicitly added previously.
+  #
+  #   t.add_result(ICU::Result.new(3, 20, 'L', :opponent => 10, :colour => 'W'))
+  #   t.add_result(ICU::Result.new(3, 10, 'W', :opponent => 20, :colour => 'B'))  # unnecessary, but not a problem
+  #
+  #   t.add_result(ICU::Result.new(3, 20, 'L', :opponent => 10, :colour => 'W'))
+  #   t.add_result(ICU::Result.new(3, 10, 'D', :opponent => 20, :colour => 'B'))  # would raise an exception
+  #
   # See ICU::Player and ICU::Result for more details about players and results.
   #
   # == Validation
@@ -255,20 +266,16 @@ module ICU
 
     # Add a result to a tournament. An exception is raised if the players referenced in the result (by number)
     # do not exist in the tournament. The result, which remember is from the perspective of one of the players,
-    # is added to that player's results. Additionally, the reverse of the result is automatically added to the player's
-    # opponent, unless the opponent does not exist (e.g. byes, walkovers). By default, if the result is rateable
-    # then the opponent's result will also be rateable. To make the opponent's result unrateable, set the optional
-    # second parameter to false.
-    def add_result(result, reverse_rateable=true)
+    # is added to that player's results. Additionally, the reverse of the result is automatically added to the
+    # player's opponent, if there is one.
+    def add_result(result)
       raise "invalid result" unless result.class == ICU::Result
       raise "result round number (#{result.round}) inconsistent with number of tournament rounds" if @rounds && result.round > @rounds
       raise "player number (#{result.player}) does not exist" unless @player[result.player]
       @player[result.player].add_result(result)
       if result.opponent
         raise "opponent number (#{result.opponent}) does not exist" unless @player[result.opponent]
-        reverse = result.reverse
-        reverse.rateable = false unless reverse_rateable
-        @player[result.opponent].add_result(reverse)
+        @player[result.opponent].add_result(result.reverse)
       end
     end
 
@@ -398,7 +405,11 @@ module ICU
         raise "player #{num} has no results" if p.results.size == 0
         p.results.each do |r|
           next unless r.opponent
-          raise "opponent #{r.opponent} of player #{num} is not in the tournament" unless @player[r.opponent]
+          opponent = @player[r.opponent]
+          raise "opponent #{r.opponent} of player #{num} is not in the tournament" unless opponent
+          o = opponent.find_result(r.round)
+          raise "opponent #{r.opponent} of player #{num} has no result in round #{r.round}" unless o
+          raise "opponent's result (#{o.inspect}) is not reverse of player's (#{r.inspect})" unless o.reverse.eql?(r)
         end
       end
     end

data/lib/icu_tournament/tournament_fcsv.rb

@@ -36,17 +36,17 @@ module ICU
     #   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
+    # The main player (the ICU 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.
+    # Each player has a unique number for the tournament, starting at 1 for the first ICU player.
     #
     #   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).
+    # In the example, 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
@@ -61,13 +61,6 @@ module ICU
     #   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>
@@ -85,10 +78,11 @@ module ICU
     # 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)
+    # * there must be at least one player with an _id_ (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)
+    # * all the opponents of each ICU player must have a federation (this could include other ICU players with federation _IRL_)
+    # * at least one of each ICU player's opponents must have a rating
     #
     # If any of these are not satisfied, then the following method calls will all raise an exception:
     #
@@ -98,7 +92,7 @@ module ICU
     #
     # 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. Note that in this format
-    # opponents' ratings are FIDE while players' IDs are ICU.
+    # opponents' ratings are FIDE.
     #
     #   t = ICU::Tournament.new("Isle of Man Masters, 2007", '2007-09-22', :rounds => 9)
     #   t.site = 'http://www.bcmchess.co.uk/monarch2007/'
@@ -217,7 +211,7 @@ module ICU
               data << n
               r = p.find_result(n)
               data << case r.score; when 'W' then '1'; when 'L' then '0'; else '='; end
-              if r.rateable
+              if r.opponent
                 data << r.colour
                 o = t.player(r.opponent)
                 data << o.last_name
@@ -243,11 +237,14 @@ module ICU
         foreign = t.players.find_all { |p| !p.id }
         raise "all foreign players must have a federation" if foreign.detect { |f| !f.fed }
         icu.each do |p|
+          rated = 0
           (1..t.rounds).each do |r|
             result = p.find_result(r)
             raise "ICU players must have a result in every round" unless result
             raise "all opponents of ICU players must have a federation" if result.opponent && !t.player(result.opponent).fed
+            rated += 1 if result.opponent && t.player(result.opponent).fide_rating
           end
+          raise "player #{p.num} (#{p.name}) has no rated opponents" if rated == 0
         end
       end
 
@@ -320,17 +317,16 @@ module ICU
               old_player.merge(opponent)
               old_result = @player.find_result(@round)
               raise "missing result for player (#{@player.name}) in round #{@round}" unless old_result
-              raise "mismatched results for player (#{old_player.name}) in round #{@round}" unless result == old_result
-              old_result.rateable = true
+              raise "mismatched results for player (#{old_player.name}): #{result.inspect} #{old_result.inspect}" unless result.eql?(old_result)
             else
               old_result = old_player.find_result(@round)
               raise "a player (#{old_player.name}) has more than one game in the same round (#{@round})" if old_result
-              @tournament.add_result(result, false)
+              @tournament.add_result(result)
             end
           else
             @tournament.add_player(opponent)
             result.opponent = opponent.num
-            @tournament.add_result(result, false)
+            @tournament.add_result(result)
           end
         end
         @state = 6 if @round == @tournament.rounds

data/lib/icu_tournament/version.rb

@@ -2,6 +2,6 @@
 
 module ICU
   class Tournament
-    VERSION = "1.3.10"
+    VERSION = "1.3.11"
   end
 end

data/spec/player_spec.rb

@@ -227,7 +227,7 @@ module ICU
         player = Player.new('Mark', 'Orr', 3)
         player.add_result(Result.new(1, 3, 'W', :opponent => 1))
         player.add_result(Result.new(2, 3, 'D', :opponent => 2))
-        lambda { player.add_result(Result.new(2, 3, 'L', :opponent => 4)) }.should raise_error(/round number .* unique/)
+        lambda { player.add_result(Result.new(2, 3, 'L', :opponent => 4)) }.should raise_error(/does not match/)
       end
     end
 

data/spec/tournament_fcsv_spec.rb

@@ -58,9 +58,13 @@ CSV
 
         it "should have correct player details" do
           check_player(1, 'Gearoidin', 'Ui Laighleis', 4, 3, 2.0, :id => 3364)
-          check_player(2, 'April',     'Cronin',       1, 0, 1.0, :fide_rating => 2005, :fed => 'IRL')
-          check_player(3, 'Suzanne',   'Connolly',     1, 0, 0.5, :fide_rating => 1950, :fed => 'IRL')
-          check_player(4, 'Linda',     'Powell',       1, 0, 0.0, :fide_rating => 1850, :fed => 'WLS')
+          check_player(2, 'April',     'Cronin',       1, 1, 1.0, :fide_rating => 2005, :fed => 'IRL')
+          check_player(3, 'Suzanne',   'Connolly',     1, 1, 0.5, :fide_rating => 1950, :fed => 'IRL')
+          check_player(4, 'Linda',     'Powell',       1, 1, 0.0, :fide_rating => 1850, :fed => 'WLS')
+        end
+        
+        it "should be valid" do
+          @t.invalid.should be_false
         end
       end
 
@@ -114,7 +118,7 @@ CSV
           @o.size.should == 8
           @o.find_all{ |o| o.results.size == 1}.size.should == 8
           @r.name.should == "Taylor, Peter P."
-          @r.results[0].rateable.should be_false
+          @r.results[0].rateable.should be_true
         end
       end
 
@@ -154,9 +158,9 @@ CSV
         it "should have correct player details" do
           check_player(1, 'Gearoidin', 'Ui Laighleis', 2, 2, 1.0, :id => 3364)
           check_player(4, 'Mark',      'Orr',          2, 2, 1.5, :id => 1350)
-          check_player(2, 'Gary',      'Kasparov',     1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
-          check_player(3, 'April',     'Cronin',       2, 0, 1.0, :fide_rating => 2005, :fed => 'IRL')
-          check_player(5, 'Bobby',     'Fischer',      1, 0, 0.0, :fide_rating => 2700, :fed => 'USA', :title => 'GM')
+          check_player(2, 'Gary',      'Kasparov',     1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
+          check_player(3, 'April',     'Cronin',       2, 2, 1.0, :fide_rating => 2005, :fed => 'IRL')
+          check_player(5, 'Bobby',     'Fischer',      1, 1, 0.0, :fide_rating => 2700, :fed => 'USA', :title => 'GM')
         end
       end
 
@@ -196,8 +200,8 @@ CSV
         it "should have correct player details" do
           check_player(1, 'Gearoidin', 'Ui Laighleis', 2, 2, 1.0, :fide_rating => 1800, :fed => 'IRL', :id => 3364)
           check_player(3, 'Mark',      'Orr',          2, 2, 1.0, :fide_rating => 2100, :fed => 'IRL', :id => 1350, :title => 'IM')
-          check_player(2, 'Gary',      'Kasparov',     1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS')
-          check_player(4, 'April',     'Cronin',       1, 0, 0.5, :fide_rating => 2005, :fed => 'IRL')
+          check_player(2, 'Gary',      'Kasparov',     1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS')
+          check_player(4, 'April',     'Cronin',       1, 1, 0.5, :fide_rating => 2005, :fed => 'IRL')
         end
       end
 
@@ -234,8 +238,8 @@ CSV
 
         it "should have correct player details" do
           check_player(1, 'Gearoidin', 'Ui Laighleis', 2, 2, 1.0, :id => 3364)
-          check_player(2, 'Gary',      'Kasparov',     1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
-          check_player(3, 'Mark',      'Orr',          1, 0, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
+          check_player(2, 'Gary',      'Kasparov',     1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
+          check_player(3, 'Mark',      'Orr',          1, 1, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
         end
         
         it "should still have original names" do
@@ -565,8 +569,8 @@ CSV
         it "should parse UTF-8" do
           lambda { @t = @f.parse!(@csv) }.should_not raise_error
           check_player(1, 'Gearoìdin', 'Uì Laighlèis', 2, 2, 1.0, :id => 3364)
-          check_player(2, 'Gary', 'Kasparov', 1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
-          check_player(3, 'Mârk', 'Örr', 1, 0, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
+          check_player(2, 'Gary', 'Kasparov', 1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
+          check_player(3, 'Mârk', 'Örr', 1, 1, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
           @t.name.should == "Brätto Open, 2001"
         end
 
@@ -574,8 +578,8 @@ CSV
           @csv = @csv.encode("ISO-8859-1")
           lambda { @t = @f.parse!(@csv) }.should_not raise_error
           check_player(1, 'Gearoìdin', 'Uì Laighlèis', 2, 2, 1.0, :id => 3364)
-          check_player(2, 'Gary', 'Kasparov', 1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
-          check_player(3, 'Mârk', 'Örr', 1, 0, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
+          check_player(2, 'Gary', 'Kasparov', 1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
+          check_player(3, 'Mârk', 'Örr', 1, 1, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
           @t.name.should == "Brätto Open, 2001"
         end
       end
@@ -614,8 +618,8 @@ CSV
           file = "#{@s}/utf-8.csv"
           lambda { @t = @p.parse_file!(file) }.should_not raise_error
           check_player(1, 'Gearoìdin', 'Uì Laighlèis', 2, 2, 1.0, :id => 3364)
-          check_player(2, 'Gary', 'Kasparov', 1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
-          check_player(3, 'Mârk', 'Örr', 1, 0, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
+          check_player(2, 'Gary', 'Kasparov', 1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
+          check_player(3, 'Mârk', 'Örr', 1, 1, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
           @t.name.should == "Brätto Open, 2001"
         end
 
@@ -623,8 +627,8 @@ CSV
           file = "#{@s}/latin-1.csv"
           lambda { @t = @p.parse_file!(file) }.should_not raise_error
           check_player(1, 'Gearoìdin', 'Uì Laighlèis', 2, 2, 1.0, :id => 3364)
-          check_player(2, 'Gary', 'Kasparov', 1, 0, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
-          check_player(3, 'Mârk', 'Örr', 1, 0, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
+          check_player(2, 'Gary', 'Kasparov', 1, 1, 0.5, :fide_rating => 2800, :fed => 'RUS', :title => 'GM')
+          check_player(3, 'Mârk', 'Örr', 1, 1, 0.5, :fide_rating => 2100, :fed => 'IRL', :title => 'IM')
           @t.name.should == "Brätto Open, 2001"
         end
       end

data/spec/tournament_spec.rb

@@ -333,13 +333,10 @@ EOS
         @boby.points.should == 0.5
       end
 
-      it "can be added symmetrically or asymmetrically with respect to rateability" do
+      it "asymmetric results cannot be added" do
         @t.add_result(Result.new(1, 1, 'W', :opponent => 2))
-        @mark.results[0].rateable.should be_true
-        @gary.results[0].rateable.should be_true
-        @t.add_result(Result.new(2, 1, 'W', :opponent => 3), false)
-        @mark.results[1].rateable.should be_true
-        @boby.results[0].rateable.should be_false
+        lambda { @t.add_result(Result.new(1, 2, 'D', :opponent => 1)) }.should raise_error(/result.*match/)
+        lambda { @t.add_result(Result.new(1, 2, 'L', :opponent => 1, :rateable => false)) }.should raise_error(/result.*match/)
       end
 
       it "should have a defined player" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 10
-  version: 1.3.10
+  - 11
+  version: 1.3.11
 platform: ruby
 authors: 
 - Mark Orr
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 +00:00
+date: 2011-03-11 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency