sanichi-chess_icu 0.3.5 → 0.4.0

data/VERSION.yml

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

data/lib/chess_icu.rb

@@ -2,7 +2,7 @@
 
 chess_icu_files = Array.new
 chess_icu_files.concat %w{util name federation}
-chess_icu_files.concat %w{player result tournament}
+chess_icu_files.concat %w{player result team tournament}
 chess_icu_files.concat %w{fcsv krause}.map{ |f| "tournament_#{f}"}
 
 dir = File.dirname(__FILE__)

data/lib/team.rb

@@ -0,0 +1,81 @@
+module ICU
+
+=begin rdoc
+
+== Team
+
+A team consists of a name and one or more players referenced by numbers.
+Typically the team will be attached to a tournament (ICU::Tournament)
+and the numbers will the unique numbers by which the players in that
+tournament are referenced. To instantiate a team, you must supply a
+name.
+
+  team = ICU::Team.new('Wandering Dragons')
+
+Then you simply add player's (numbers) to it.
+
+  team.add_player(1)
+  team.add_payeer(3)
+  team.add_player(7)
+
+To get the current members of a team
+
+  team.members                                 # => [1, 3, 7]
+
+You can enquire whether a team contains a given player number.
+
+  team.contains?(3)                            # => true
+  team.contains?(4)                            # => false
+
+Or whether it matches a given name (which ignoring case and removing spurious whitespace)
+  
+  team.matches(' wandering  dragons  ')        # => true
+  team.matches('Blundering Bishops')           # => false
+
+Whenever you reset the name of a tournament spurious whitespace is removed but case is not altered.
+
+  team.name = '  blundering  bishops  '
+  team.name                                    # => "blundering bishops"
+
+Attempting to add non-numbers or duplicate numbers as new team members results in an exception.
+
+  team.add(nil)                                # exception - not a number
+  team.add(3)                                  # exception - already a member
+
+=end
+
+  class Team
+
+    attr_reader :name, :members
+    
+    # Constructor. Name must be supplied.
+    def initialize(name)
+      self.name = name
+      @members = Array.new
+    end
+    
+    # Set name. Must not be blank.
+    def name=(name)
+      @name = name.strip.squeeze(' ')
+      raise "team can't be blank" if @name.length == 0
+    end
+    
+    # Add a team member referenced by any integer.
+    def add_member(number)
+      pnum = number.to_i
+      raise "'#{number}' is not a valid as a team member player number" if pnum == 0 && !number.to_s.match(/^[^\d]*0/)
+      raise "can't add duplicate player number #{pnum} to team '#{@name}'" if @members.include?(pnum)
+      @members.push(pnum)
+    end
+    
+    # Detect if a member exists in a team.
+    def include?(number)
+      @members.include?(number)
+    end
+    
+    # Does the team name match the given string (ignoring case and spurious whitespace).
+    def matches(name)
+      self.name.downcase == name.strip.squeeze(' ').downcase
+    end
+  end
+end

data/lib/tournament.rb

@@ -64,7 +64,7 @@ Ranking is consistent if either no players have any rank or if all players have
 =end
 
   class Tournament
-    attr_reader :name, :rounds, :start, :finish, :round_dates, :site, :city, :fed, :type, :arbiter, :deputy, :time_control
+    attr_reader :name, :rounds, :start, :finish, :round_dates, :site, :city, :fed, :type, :arbiter, :deputy, :time_control, :teams
     
     # Constructor. Name and start date must be supplied. Other attributes are optional.
     def initialize(name, start, opt={})
@@ -72,6 +72,7 @@ Ranking is consistent if either no players have any rank or if all players have
       self.start = start
       [:finish, :rounds, :site, :city, :fed, :type, :arbiter, :deputy, :time_control].each { |a| self.send("#{a}=", opt[a]) unless opt[a].nil? }
       @player = {}
+      @teams = []
       @round_dates = []
     end
     
@@ -178,6 +179,20 @@ Ranking is consistent if either no players have any rank or if all players have
       raise "invalid tournament time control (#{time_control})" unless @time_control.nil? || @time_control.match(/[1-9]\d/)
     end
     
+    # Add a new team. The argument is either a team (possibly already with members) or the name of a new team.
+    # The team's name must be unique in the tournament. Returns the the team instance.
+    def add_team(team)
+      team = Team.new(team.to_s) unless team.is_a? Team
+      raise "a team with a name similar to '#{team.name}' already exists" if self.get_team(team.name)
+      @teams << team
+      team
+    end
+    
+    # Return the team object that matches a given name, or nil if not found.
+    def get_team(name)
+      @teams.find{ |t| t.matches(name) }
+    end
+    
     # Add a new player to the tournament. Must have a unique player number.
     def add_player(player)
       raise "invalid player" unless player.class == ICU::Player
@@ -248,6 +263,7 @@ Ranking is consistent if either no players have any rank or if all players have
       check_players
       check_rounds
       check_dates
+      check_teams
       check_ranks(:allow_none => true)
       true
     end
@@ -290,6 +306,24 @@ Ranking is consistent if either no players have any rank or if all players have
         @finish = @round_dates[-1] unless @finish
       end
     end
+    
+    # Check teams. Either there are none or:
+    # * every team member is a valid player, and
+    # * every player is a member of exactly one team.
+    def check_teams
+      return if @teams.size == 0
+      member = Hash.new
+      @teams.each do |t|
+        t.members.each do |m|
+          raise "member #{m} of team '#{t.name}' is not a valid player number for this tournament" unless @player[m]
+          raise "member #{m} of team '#{t.name}' is already a member of team #{member[m]}" if member[m]
+          member[m] = t.name
+        end
+      end
+      @player.keys.each do |p|
+        raise "player #{p} is not a member of any team" unless member[p]
+      end
+    end
 
     # Check if the players ranking is consistent, which will be true if:
     # * every player has a rank

data/lib/tournament_krause.rb

@@ -65,7 +65,7 @@ The following lists Krause data identification numbers, their description and, w
 
 [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]                   Not implemented yet.
+[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.
@@ -124,7 +124,7 @@ The following lists Krause data identification numbers, their description and, w
             case din
               when '001' then add_player                        # player and results record
               when '012' then set_name                          # name (mandatory)
-              when '013' then add_comment                       # team name and members (not implemented yet)
+              when '013' then add_team                          # team name and members
               when '022' then @tournament.city = @data          # city
               when '032' then @tournament.fed = @data           # federation
               when '042' then set_start                         # start date (mandatory)
@@ -177,6 +177,11 @@ The following lists Krause data identification numbers, their description and, w
         krause << "102 #{t.arbiter}\n"      if t.arbiter
         krause << "112 #{t.deputy}\n"       if t.deputy
         krause << "122 #{t.time_control}\n" if t.time_control
+        t.teams.each do |team|
+          krause << sprintf('013 %-31s', team.name)
+          team.members.each{ |m| krause << sprintf(' %4d', m) }
+          krause << "\n"
+        end
         if t.round_dates.size > 0
           krause << "132 #{' ' * 85}"
           t.round_dates.each{ |d| krause << d.sub(/^../, '  ') }
@@ -246,6 +251,17 @@ The following lists Krause data identification numbers, their description and, w
         result.points
       end
       
+      def add_team
+        raise error "team record less than minimum length" if @line.length < 40
+        team = Team.new(@data[0, 31])
+        index = 32
+        while @data.length >= index + 4
+          team.add_member(@data[index, 4])
+          index+= 5
+        end
+        @tournament.add_team(team)
+      end
+      
       def add_round_dates
         raise "round dates record less than minimum length" if @line.length < 99
         index  = 87

data/spec/team_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module ICU
+  describe Team do
+    context "a typical team" do
+      before(:each) do
+        @t = Team.new('Wandering Dragons')
+        @t.add_member(0)
+        @t.add_member('3')
+        @t.add_member('  -7  ')
+      end
+      
+      it "should have a name" do
+        @t.name.should == 'Wandering Dragons'
+      end
+      
+      it "should have some members" do
+        @t.should have(3).members
+        @t.include?(0).should be_true
+        @t.include?(3).should be_true
+        @t.include?(-7).should be_true
+        @t.include?(7).should be_false
+      end
+      
+      it "should match names ignoring case and irrelevant whitespace" do
+        @t.matches('Wandering Dragons').should be_true
+        @t.matches('  wandering  dragons  ').should be_true
+        @t.matches('  wanderingdragons  ').should be_false
+        @t.matches('Blundering Bishops').should be_false
+      end
+      
+      it "should have a changeable name with irrelevant whitespace being trimmed" do
+        @t.name = '  blue    dragons   '
+        @t.name.should == 'blue dragons'
+      end
+      
+      it "should blowup if an attempt is made to blank the name" do
+        lambda { @t.name = '  ' }.should raise_error(/blank/)
+      end
+      
+      it "should blowup if an attempt is made to add a non-number" do
+        lambda { @t.add_member('  ') }.should raise_error(/number/)
+      end
+
+      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
+    end
+  end
+end

data/spec/tournament_krause_spec.rb

@@ -37,7 +37,7 @@ module ICU
 102 Hans Scmidt
 112 Gerry Graham, Herbert Scarry
 122 60 in 2hr, 30 in 1hr, rest in 1hr
-013 Coaching Team                      1    2
+013 Coaching Team                      1    2    3
 0         1         2         3         4         5         6         7         8         9         0         1         2
 0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
 132                                                                                        08.06.07  08.06.08  08.06.09
@@ -93,7 +93,6 @@ KRAUSE
 062 3
 072 3
 082 1
-013 Coaching Team                      1    2
 0         1         2         3         4         5         6         7         8         9         0         1         2
 0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
 COMMENTS
@@ -162,6 +161,8 @@ KRAUSE
 102 Hans Scmidt
 112 Gerry Graham, Herbert Scarry
 122 60 in 2hr, 30 in 1hr, rest in 1hr
+013 Boys                               2    3
+013 Girls                              1    4
 132                                                                                        08-06-07  08-06-08  08-06-09
 001    1 w    Ui Laighleis,Gearoidin            1985 IRL     2501171 1964-06-10  2.0    2     2 b 0     3 w +     4 b 1
 001    2 m  m Orr,Mark                          2258 IRL     2500035 1955-11-09  2.5    1     1 w 1  0000 - =     3 b 1

data/spec/tournament_spec.rb

@@ -294,7 +294,32 @@ module ICU
         @t.find_player(Player.new('John', 'Orr', 4, :fed => 'IRL')).should be_nil
       end
     end
+    
+    context "teams" do
+      before(:each) do
+        @t = Tournament.new('Bangor Bash', '2009-11-09')
+      end
 
+      it "should be able to create a new team, add it and retrieve it" do
+        team = Team.new('Wandering Dragons')
+        @t.add_team(team).should be_an_instance_of Team
+        @t.get_team('  wandering  dragons  ').should be_an_instance_of Team
+        @t.get_team('Blundering Bishops').should be_nil
+      end
+      
+      it "should be able to create and add a new team and retrieve it" do
+        @t.add_team('Blundering Bishops').should be_an_instance_of Team
+        @t.get_team('  blundering  bishops  ').should be_an_instance_of Team
+        @t.get_team('Wandering Dragons').should be_nil
+      end
+      
+      it "should throw and exception if there is an attempt to add a team with a name that matches an existing team" do
+        lambda { @t.add_team('Blundering Bishops') }.should_not raise_error
+        lambda { @t.add_team('Wandering Dragons') }.should_not raise_error
+        lambda { @t.add_team('  wandering   dragons  ') }.should raise_error(/similar.*exists/)
+      end
+    end
+    
     context "validation" do
       before(:each) do
         @t = Tournament.new('Edinburgh Masters', '2009-11-09')
@@ -364,6 +389,33 @@ module ICU
         @t.player(3).rank = 3
         lambda { @t.validate! }.should raise_error(/player 2.*above.*player 1/)
       end
+      
+      it "should be valid if there are teams, every player is in one of them, and no team has an invalid member" do
+        team1 = Team.new('International Masters')
+        team2 = Team.new('World Champions')
+        @t.add_team(team1)
+        @t.add_team(team2)
+        @t.invalid.should match(/not.*member/)
+        team1.add_member(1)
+        team2.add_member(2)
+        team2.add_member(3)
+        @t.invalid.should be_false
+        team1.add_member(4)
+        @t.invalid.should match(/not.*valid/)
+      end
+      
+      it "should not be valid if one player is in more than one team" do
+        team1 = Team.new('XInternational Masters')
+        team1.add_member(1)
+        team2 = Team.new('XWorld Champions')
+        team2.add_member(2)
+        team2.add_member(3)
+        @t.add_team(team1)
+        @t.add_team(team2)
+        @t.invalid.should be_false
+        team1.add_member(2)
+        @t.invalid.should match(/already.*member/)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanichi-chess_icu
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-09 00:00:00 -07:00
+date: 2009-05-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,7 @@ files:
 - lib/name.rb
 - lib/player.rb
 - lib/result.rb
+- lib/team.rb
 - lib/tournament.rb
 - lib/tournament_fcsv.rb
 - lib/tournament_krause.rb
@@ -51,6 +52,7 @@ files:
 - spec/player_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb
+- spec/team_spec.rb
 - spec/tournament_fcsv_spec.rb
 - spec/tournament_krause_spec.rb
 - spec/tournament_spec.rb
@@ -87,6 +89,7 @@ test_files:
 - spec/player_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb
+- spec/team_spec.rb
 - spec/tournament_fcsv_spec.rb
 - spec/tournament_krause_spec.rb
 - spec/tournament_spec.rb