sanichi-chess_icu 0.4.2 → 0.4.3

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 4
-:patch: 2
+:patch: 3

data/lib/player.rb

@@ -205,6 +205,14 @@ All other attributes are unaffected.
       @results.inject(0.0) { |t, r| t += r.points }
     end
     
+    # Renumber the player according to the supplied hash. Return self.
+    def renumber!(map)
+      raise "player number #{@num} not found in renumbering hash" unless map[@num]
+      self.num = map[@num]
+      @results.each{ |r| r.renumber!(map) }
+      self
+    end
+    
     # Loose equality test. Passes if the names match and the federations are not different.
     def ==(other)
       return true if equal?(other)

data/lib/result.rb

@@ -159,7 +159,7 @@ The _points_ read-only accessor always returns a floating point number: either 0
       end
     end
     
-    # Reverse a result so it is seen from the opponent's perspective.
+    # Return a reversed version (from the opponent's perspective) of a result.
     def reverse(rateable=nil)
       return unless @opponent
       r = Result.new(@round, @opponent, @score == 'W' ? 'L' : (@score == 'L' ? 'W' : 'D'))
@@ -170,6 +170,17 @@ The _points_ read-only accessor always returns a floating point number: either 0
       r
     end
     
+    # Renumber the player and opponent (if there is one) according to the supplied hash. Return self.
+    def renumber!(map)
+      raise "result player number #{@player} not found in renumbering hash" unless map[@player]
+      self.player = map[@player]
+      if @opponent
+        raise "result opponent number #{@opponent} not found in renumbering hash" unless map[@opponent]
+        self.opponent = map[@opponent]
+      end
+      self
+    end
+    
     # Loose equality. True if the round, player and opponent numbers, colour and score all match.
     def ==(other)
       return unless other.is_a? Result

data/lib/team.rb

@@ -68,6 +68,15 @@ Attempting to add non-numbers or duplicate numbers as new team members results i
       @members.push(pnum)
     end
     
+    # Renumber the players according to the supplied hash. Return self.
+    def renumber!(map)
+      @members.each_with_index do |pnum, index|
+        raise "player number #{pnum} not found in renumbering hash" unless map[pnum]
+        @members[index] = map[pnum]
+      end
+      self
+    end
+    
     # Detect if a member exists in a team.
     def include?(number)
       @members.include?(number)

data/lib/tournament.rb

@@ -52,7 +52,7 @@ Side effects of calling _validate!_ or _invalid_ include:
 
 If the _rerank_ option is set, as in this example:
 
-  tournament.validate!(:rerank => true)
+  t.validate!(:rerank => true)
 
 then there are additional side effects of validating a tournament:
 
@@ -61,6 +61,16 @@ then there are additional side effects of validating a tournament:
 
 Ranking is consistent if either no players have any rank or if all players have a rank and no player is ranked higher than another player with more points.
 
+The players in a tournament can be renumbered by rank or name. After any renumbering the player numbers,
+which initially can be any collection of unique integers, will start at 1 and go up to the number of players.
+
+  t.renumber!(:name)       # renumber by name
+  t.renumber!(:rank)       # renumber by rank
+  t.renumber!              # same - rank is the default
+
+A side effect of renumbering by rank is that if the tournament started without any player ranking or
+with inconsitent ranking, it will be reranked (i.e. the method _rerank_ will be called on it).
+
 =end
 
   class Tournament
@@ -234,7 +244,7 @@ Ranking is consistent if either no players have any rank or if all players have
       end
     end
         
-    # Rerank the tournament.
+    # Rerank the tournament by score, resolving ties using name.
     def rerank
       @player.values.map{ |p| [p, p.points] }.sort do |a,b|
         d = b[1] <=> a[1]
@@ -245,6 +255,29 @@ Ranking is consistent if either no players have any rank or if all players have
         v[0].rank = i + 1
       end
     end
+    
+    # Renumber the players according to a given criterion. Return self.
+    def renumber!(criterion = :rank)
+      map = Hash.new
+      
+      # Decide how to rank.
+      if criterion == :name
+        @player.values.sort_by{ |p| p.name }.each_with_index{ |p, i| map[p.num] = i + 1 }
+      else
+        begin check_ranks rescue rerank end
+        @player.values.each{ |p| map[p.num] = p.rank}
+      end
+      
+      # Apply ranking.
+      @teams.each{ |t| t.renumber!(map) }
+      @player = @player.values.inject({}) do |hash, player|
+        player.renumber!(map)
+        hash[player.num] = player
+        hash
+      end
+      
+      self
+    end
 
     # Is a tournament invalid? Either returns false (if it's valid) or an error message.
     def invalid(options={})
@@ -273,7 +306,13 @@ Ranking is consistent if either no players have any rank or if all players have
     # Check players.
     def check_players
       raise "the number of players (#{@player.size}) must be at least 2" if @player.size < 2
-      @player.each { |num, p| raise "player #{num} has no results" if p.results.size == 0 }
+      @player.each do |num, p|
+        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]
+        end
+      end
     end
     
     # Round should go from 1 to a maximum, there should be at least one result in every round and,
@@ -330,7 +369,7 @@ Ranking is consistent if either no players have any rank or if all players have
     # * no two players have the same rank
     # * the highest rank is 1
     # * the lowest rank is equal to the total of players
-    def check_ranks(options)
+    def check_ranks(options={})
       ranks = Hash.new
       @player.values.each do |p|
         if p.rank

data/spec/player_spec.rb

@@ -236,6 +236,25 @@ module ICU
       end
     end
     
+    context "renumber the player numbers" do
+      before(:each) do
+        @p = Player.new('Mark', 'Orr', 10)
+        @p.add_result(Result.new(1, 10, 'W', :opponent => 20))
+        @p.add_result(Result.new(2, 10, 'W', :opponent => 30))
+      end
+      
+      it "should renumber successfully if the map has the relevant player numbers" do
+        map = { 10 => 1, 20 => 2, 30 => 3 }
+        @p.renumber!(map).num.should == 1
+        @p.results.map{ |r| r.opponent }.sort.join('').should == '23'
+      end
+      
+      it "should raise exception if a player number is not in the map" do
+        lambda { @p.renumber!({ 100 => 1, 20 => 2, 30 => 3 }) }.should raise_error(/player.*10.*not found/)
+        lambda { @p.renumber!({ 10 => 1, 200 => 2, 30 => 3 }) }.should raise_error(/opponent.*20.*not found/)
+      end
+    end
+    
     context "loose equality" do
       before(:all) do
         @mark1 = Player.new('Mark', 'Orr', 1)

data/spec/result_spec.rb

@@ -138,6 +138,25 @@ module ICU
       end
     end
     
+    context "renumber the player numbers in a result" do
+      before(:each) do
+        @r1 = Result.new(1, 4, 0)
+        @r2 = Result.new(2, 3, 1, :opponent => 4, :color => 'B')
+      end
+      
+      it "should renumber successfully if the map has the relevant player numbers" do
+        map = { 4 => 1, 3 => 2 }
+        @r1.renumber!(map).player.should == 1
+        @r2.renumber!(map).player.should == 2
+        @r1.opponent.should be_nil
+        @r2.opponent.should == 1
+      end
+      
+      it "should raise exception if a player number is not in the map" do
+        lambda { @r1.renumber!({ 5 => 1, 3 => 2 }) }.should raise_error(/player.*4.*not found/)
+      end
+    end
+    
     context "loose equality" do
       before(:each) do
         @r1 = Result.new(1, 1, 0, :opponent => 2, :colour => 'W')

data/spec/team_spec.rb

@@ -45,6 +45,15 @@ module ICU
       it "should blow up if an attempt is made to add a duplicate number" do
         lambda { @t.add_member(3) }.should raise_error(/duplicate/)
       end
+
+      it "should renumber successfully if the map has the relevant player numbers" do
+        map = { 0 => 1, 3 => 2, -7 => 3 }
+        @t.renumber!(map).members.sort.join('').should == '123'
+      end
+
+      it "should raise exception if a player is missing from the renumber map" do
+        lambda { @t.renumber!({ 5 => 1, 3 => 2 }) }.should raise_error(/player.*not found/)
+      end
     end
   end
 end

data/spec/tournament_krause_spec.rb

@@ -171,15 +171,15 @@ KRAUSE
 KRAUSE
           @p = Krause.new
           @t = @p.parse!(@krause)
-          @s = Krause.new
+          @q = Krause.new
         end
 
         it "should serialize back to the original if the input is fully canonicalised" do
-          @s.serialize(@t).should == @krause
+          @q.serialize(@t).should == @krause
         end
 
         it "should return nil on invalid input" do
-          @s.serialize('Rubbish').should be_nil
+          @q.serialize('Rubbish').should be_nil
         end
       end
 
@@ -202,6 +202,32 @@ KRAUSE
           @t.player(3).rank.should == 3
         end
       end
+      
+      context "renumbering" do
+        before(:all) do
+          @krause = <<KRAUSE
+012 Las Vegas National Open
+042 2008-06-07
+001   10 w    Ui Laighleis,Gearoidin            1985 IRL                         1.0         20 b 0    30 w 1
+001   20 m  m Orr,Mark                          2258 IRL                         2.0         10 w 1              30 b 1
+001   30 m  g Bologan,Viktor                    2663 MDA                         0.0                   10 b 0    20 w 0
+KRAUSE
+          @p = Krause.new
+          @t = @p.parse!(@krause)
+          @reordered = <<REORDERED
+012 Las Vegas National Open
+042 2008-06-07
+001    1 m  m Orr,Mark                          2258 IRL                         2.0    1     2 w 1               3 b 1
+001    2 w    Ui Laighleis,Gearoidin            1985 IRL                         1.0    2     1 b 0     3 w 1          
+001    3 m  g Bologan,Viktor                    2663 MDA                         0.0    3               2 b 0     1 w 0
+REORDERED
+        end
+      
+        it "should serialise correctly after renumbering by rank" do
+          @t.renumber!
+          @p.serialize(@t).should == @reordered
+        end
+      end
 
       context "errors" do
         before(:each) do

data/spec/tournament_spec.rb

@@ -417,5 +417,39 @@ module ICU
         @t.invalid.should match(/already.*member/)
       end
     end
+    
+    context "renumbering" do
+      before(:each) do
+        @t = Tournament.new('Edinburgh Masters', '2009-11-09')
+        @t.add_player(@mark = Player.new('Mark', 'Orr', 10))
+        @t.add_player(@gary = Player.new('Gary', 'Kasparov', 20))
+        @t.add_player(@boby = Player.new('Bobby', 'Fischer', 30))
+        @t.add_result(Result.new(1, 10, 'W', :opponent => 20))
+        @t.add_result(Result.new(2, 20, 'W', :opponent => 30))
+        @t.add_result(Result.new(3, 30, 'L', :opponent => 10))
+      end
+      
+      it "sample tournament is valid but unranked" do
+        @t.invalid.should be_false
+        @t.player(10).rank.should be_nil
+      end
+
+      it "should be renumberable by rank" do
+        @t.renumber!.invalid.should be_false
+        @t.players.map{ |p| p.num }.join('|').should == '1|2|3'
+        @t.players.map{ |p| p.first_name }.join('|').should == 'Mark|Gary|Bobby'
+      end
+      
+      it "should be ranked after renumbering by rank" do
+        @t.renumber!.invalid.should be_false
+        @t.players.map{ |p| p.rank }.join('|').should == '1|2|3'
+      end
+      
+      it "should be renumberable by name" do
+        @t.renumber!(:name).invalid.should be_false
+        @t.players.map{ |p| p.num }.join('|').should == '1|2|3'
+        @t.players.map{ |p| p.last_name }.join('|').should == 'Fischer|Kasparov|Orr'
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanichi-chess_icu
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -07:00
+date: 2009-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency