sanichi-chess_icu 0.2.7 → 0.2.8

data/VERSION.yml

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

data/lib/player.rb

@@ -47,14 +47,15 @@ The player number is irrelevant.
   john1 == john2                   # => true (federations don't disagree because one is unset)
   john2 == john3                   # => false (federations disagree)
 
-If, in addition, none of _rating_, _dob_ and _id_ disagree then two players are equal according to _eql?_.
+If, in addition, _rating_, _dob_, _gender_ and _id_ do not disagree then two players are equal
+according to the stricter criteria of _eql?_.
 
   mark1 = ICU::Player.new('Mark', 'Orr', 31, :fed = 'IRL', :rating => 2100)
   mark2 = ICU::Player.new('Mark', 'Orr', 33, :fed = 'IRL', :rating => 2100, :title => 'IM')
   mark3 = ICU::Player.new('Mark', 'Orr', 37, :fed = 'IRL', :rating => 2200, :title => 'IM')
 
   mark1.eql?(mark2)                # => true (ratings agree and titles don't disagree)
-  mark2.eql?(mark3)                # => false (the ratings are unequl)
+  mark2.eql?(mark3)                # => false (the ratings are not the same)
 
 The presence of two players in the same tournament that are equal according to _==_ but unequal
 according to _eql?__ is likely to indicate a data entry error.
@@ -63,7 +64,7 @@ If two instances represent the same player and are equal according to _==_ then
 _title_ and _fed_ attributes of the two can be merged. For example:
 
   fox1 = ICU::Player.new('Tony', 'Fox', 12, :id => 456)
-  fox2 = ICU::Player.new('Tony', 'Fox', 21, :rating => 2100, :fed => 'IRL')
+  fox2 = ICU::Player.new('Tony', 'Fox', 21, :rating => 2100, :fed => 'IRL', :gender => 'M')
   fox1.merge(fox2)
 
 Any attributes present in the second player but not in the first are copied to the first.
@@ -71,11 +72,12 @@ All other attributes are unaffected.
 
   fox1.rating                      # => 2100
   fox1.fed                         # => 'IRL'
+  fox1.gender                      # => 'M'
 
 =end
 
   class Player
-    attr_accessor :first_name, :last_name, :num, :id, :fed, :title, :rating, :rank, :dob
+    attr_accessor :first_name, :last_name, :num, :id, :fed, :title, :rating, :rank, :dob, :gender
     attr_reader :results
     
     # Constructor. Must supply both names and a unique number for the tournament.
@@ -83,7 +85,7 @@ All other attributes are unaffected.
       self.first_name = first_name
       self.last_name  = last_name
       self.num        = num
-      [:id, :fed, :title, :rating, :rank, :dob].each do |atr|
+      [:id, :fed, :title, :rating, :rank, :dob, :gender].each do |atr|
         self.send("#{atr}=", opt[atr]) unless opt[atr].nil?
       end
       @results = []
@@ -174,7 +176,15 @@ All other attributes are unaffected.
       raise "invalid DOB (#{dob})" if @dob.nil? && dob.length > 0
     end
     
-    # Add a result.
+    # Gender. Is either unknown (nil) or one of _M_ or _F_.
+    def gender=(gender)
+      @gender = gender.to_s.strip[0,1].upcase
+      @gender = nil if @gender == ''
+      @gender = 'F' if @gender == 'W'
+      raise "invalid gender (#{gender})" unless @gender.nil? || @gender.match(/^[MF]$/)
+    end
+    
+    # Add a result. Use the same name method in ICU::Tournament 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
@@ -202,11 +212,11 @@ All other attributes are unaffected.
       true
     end
     
-    # Strict equality test. Passes if the playes are loosly equal and also if their ID, rating and title are not different.
+    # Strict equality test. Passes if the playes are loosly equal and also if their ID, rating, gender and title are not different.
     def eql?(other)
       return true if equal?(other)
       return false unless self == other
-      [:id, :rating, :title].each do |m|
+      [:id, :rating, :title, :gender].each do |m|
         return false if self.send(m) && other.send(m) && self.send(m) != other.send(m)
       end
       true
@@ -215,7 +225,7 @@ All other attributes are unaffected.
     # Merge in some of the details of another player.
     def merge(other)
       raise "cannot merge two players that are not equal" unless self == other
-      [:id, :rating, :title, :fed].each do |m|
+      [:id, :rating, :title, :fed, :gender].each do |m|
         self.send("#{m}=", other.send(m)) unless self.send(m)
       end
     end

data/lib/tournament.rb

@@ -30,19 +30,19 @@ Would result in the following output.
   0.5 Mark Orr
 
 Note that the players should be added first because the _add_result_ method will
-raise an exception if the players it references through their numbers (10, 20
-and 30 in this example) have not already been added to the tournament.
+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.
 
 =end
 
   class Tournament
-    attr_reader :name, :start, :rounds, :site
+    attr_reader :name, :start, :finish, :rounds, :site, :city, :fed, :type, :arbiter, :deputy, :time_control
     
     # Constructor. Name and start date must be supplied. Other attributes are optional.
     def initialize(name, start, opt={})
       self.name  = name
       self.start = start
-      [:rounds, :site].each { |a| self.send("#{a}=", opt[a]) unless opt[a].nil? }
+      [:finish, :rounds, :site, :city, :fed, :type, :arbiter, :deputy, :time_control].each { |a| self.send("#{a}=", opt[a]) unless opt[a].nil? }
       @player = {}
     end
     
@@ -52,6 +52,29 @@ and 30 in this example) have not already been added to the tournament.
       @name = name.to_s.strip
     end
     
+    # Set the tournament city. Can be _nil.
+    def city=(city)
+      city = city.to_s.strip
+      if city == ''
+        @city = nil
+      else
+        raise "invalid tournament city (#{city})" unless city.match(/[a-z]/i)
+        @city = city
+      end
+    end
+    
+    # Set the tournament federation. Can be _nil.
+    def fed=(fed)
+      fed = fed.to_s.strip
+      if fed == ''
+        @fed = nil
+      else
+        raise "invalid tournament federation (#{fed})" unless fed.match(/^[-a-z ]+/i) && fed.length >= 3
+        fed.upcase! if fed.length == 3
+        @fed = fed
+      end
+    end
+    
     # Set a start date in yyyy-mm-dd format.
     def start=(start)
       start = start.to_s.strip
@@ -59,6 +82,17 @@ and 30 in this example) have not already been added to the tournament.
       raise "invalid start date (#{start})" unless @start
     end
     
+    # Set an end date in yyyy-mm-dd format.
+    def finish=(finish)
+      finish = finish.to_s.strip
+      if finish == ''
+        @finish = nil
+      else
+        @finish = Util.parsedate(finish)
+        raise "invalid finish date (#{finish})" unless @finish
+      end
+    end
+    
     # Set the number of rounds. Is either unknown (_nil_) or a positive integer.
     def rounds=(rounds)
       @rounds = case rounds
@@ -78,6 +112,34 @@ and 30 in this example) have not already been added to the tournament.
       raise "invalid site (#{site})" unless @site.nil? || @site.match(/^https?:\/\/[-\w]+(\.[-\w]+)+(\/[^\s]*)?$/i)
     end
     
+    # Set the tournament type. Should be either unknown (_nil_) or contain some letters.
+    def type=(type)
+      @type = type.to_s.strip
+      @type = nil if @type == ''
+      raise "invalid tournament type (#{type})" unless @type.nil? || @type.match(/[a-z]/i)
+    end
+    
+    # Set the tournament arbiter. Should be either unknown (_nil_) or contain some letters.
+    def arbiter=(arbiter)
+      @arbiter = arbiter.to_s.strip
+      @arbiter = nil if @arbiter == ''
+      raise "invalid tournament arbiter (#{arbiter})" unless @arbiter.nil? || @arbiter.match(/[a-z]/i)
+    end
+    
+    # Set the tournament deputy. Should be either unknown (_nil_) or contain some letters.
+    def deputy=(deputy)
+      @deputy = deputy.to_s.strip
+      @deputy = nil if @deputy == ''
+      raise "invalid tournament deputy (#{deputy})" unless @deputy.nil? || @deputy.match(/[a-z]/i)
+    end
+    
+    # Set the time control. Should be either unknown (_nil_) or contain some numbers.
+    def time_control=(time_control)
+      @time_control = time_control.to_s.strip
+      @time_control = nil if @time_control == ''
+      raise "invalid tournament time control (#{time_control})" unless @time_control.nil? || @time_control.match(/[1-9]\d/)
+    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

data/lib/tournament_fcsv.rb

@@ -73,6 +73,10 @@ However, none of the opponents' results are rateable. For example:
   opponent = tournament.players(2)
   opponent.name                                      # => "Taylor, Peter P."
   opponent.results[0].rateable                       # => false
+
+A tournament can be serialized back to CSV format (the reverse of parsing) with the serialise method.
+
+  csv = parser.serialize(tournament)
   
 =end
 
@@ -134,6 +138,41 @@ However, none of the opponents' results are rateable. For example:
         
         @tournament
       end
+      
+      # Serialise a tournament back into CSV format.
+      def serialise(t)
+        return nil unless t.class == ICU::Tournament;
+        FasterCSV.generate do |csv|
+          csv << ["Event", t.name]
+          csv << ["Start", t.start]
+          csv << ["Rounds", t.rounds]
+          csv << ["Website", t.site]
+          t.players.each do |p|
+            next unless p.id
+            csv << []
+            csv << ["Player", p.id, p.last_name, p.first_name]
+            (1..t.rounds).each do |n|
+              data = []
+              data << n
+              r = p.find_result(n)
+              data << case r.score; when 'W' then '1'; when 'L' then '0'; else '='; end
+              if r.rateable
+                data << r.colour
+                o = t.player(r.opponent)
+                data << o.last_name
+                data << o.first_name
+                data << o.rating
+                data << o.title
+                data << o.fed
+              else
+                data << '-'
+              end
+              csv << data
+            end
+            csv << ["Total", p.points]
+          end
+        end
+      end
 
       private
       

data/spec/player_spec.rb

@@ -144,6 +144,22 @@ module ICU
       end
     end
     
+    context "gender" do
+      it "defaults to nil" do
+        Player.new('Mark', 'Orr', 3).gender.should be_nil
+        Player.new('Mark', 'Orr', 3, :gender => '   ').gender.should be_nil
+      end
+
+      it "should be either M or F" do
+        Player.new('Mark', 'Orr', 3, :gender => 'male').gender.should == 'M'
+        Player.new('April', 'Cronin', 3, :gender => 'woman').gender.should == 'F'
+      end
+      
+      it "should raise an exception if the gender is not specified properly" do
+        lambda { Player.new('Mark', 'Orr', 3, :gender => 'X') }.should raise_error(/invalid gender/)
+      end
+    end
+    
     context "results and points" do
       it "should initialise to an empty array" do
         results = Player.new('Mark', 'Orr', 3).results

data/spec/tournament_fcsv_spec.rb

@@ -386,6 +386,37 @@ CSV
           lambda { @f.parse!(csv) }.should raise_error(/line 13.*same name.*conflicting/i)
         end
       end
+      
+      context "serialisation" do
+        before(:each) do
+          @csv = <<CSV
+Event,"Edinburgh Masters, 2007"
+Start,2007-08-09
+Rounds,2
+Website,http://www.chesscenter.com/twic/twic.html
+
+Player,3364,Ui Laighleis,Gearoidin
+1,0,W,Kasparov,Gary,2800,GM,RUS
+2,1,B,Cronin,April,2005,,IRL
+Total,1.0
+
+Player,1350,Orr,Mark
+1,=,W,Cronin,April,2005,,IRL
+2,=,-
+Total,1.0
+CSV
+          @f = ForeignCSV.new
+          @t = @f.parse!(@csv)
+        end
+
+        it "should serialize back to the original" do
+          @f.serialise(@t).should == @csv
+        end
+
+        it "should return nil on invalid input" do
+          @f.serialise('Rubbish').should be_nil
+        end
+      end
     end
   end
 end

data/spec/tournament_spec.rb

@@ -37,6 +37,61 @@ module ICU
       end
     end
     
+    # Tournament city.
+    context "city" do
+      before(:each) do
+        @t = Tournament.new('Edinburgh Masters', '2009-11-09', :city => 'Edinburgh')
+      end
+      
+      it "may be specified in constructor" do
+        @t.city.should == 'Edinburgh'
+      end
+      
+      it "can be replaced by accessor" do
+        @t.city = 'Glasgow'
+        @t.city.should == 'Glasgow'
+      end
+      
+      it "can be set to nil" do
+        @t.city = ''
+        @t.city.should be_nil
+      end
+      
+      it "should not be without letters if set" do
+        lambda { @t.city = '123' }.should raise_error(/invalid.*city/)
+      end
+    end
+
+    # Tournament federation.
+    context "federation" do
+      before(:each) do
+        @t = Tournament.new('Edinburgh Masters', '2009-11-09', :fed => 'SCO')
+      end
+      
+      it "may be specified in constructor" do
+        @t.fed.should == 'SCO'
+      end
+      
+      it "can be replaced by accessor" do
+        @t.fed = 'IRL'
+        @t.fed.should == 'IRL'
+      end
+      
+      it "can be set to nil" do
+        @t.fed = ''
+        @t.fed.should be_nil
+      end
+      
+      it "three letters will automatically be upcased" do
+        @t.fed = 'rus'
+        @t.fed.should == 'RUS'
+      end
+      
+      it "should not be without letters if set" do
+        lambda { @t.fed = '123' }.should raise_error(/invalid.*federation/)
+      end
+    end
+
     # Tournament start date.
     context "start date" do
       before(:each) do
@@ -58,6 +113,32 @@ module ICU
       end
     end
     
+    # Tournament finish date.
+    context "finish date" do
+      before(:each) do
+        @t = Tournament.new('Edinburgh Masters', '2009-11-09', :finish => '12th November 2009')
+      end
+      
+      it "may be specified in constructor" do
+        @t.finish.should == '2009-11-12'
+      end
+      
+      it "can be replaced by accessor" do
+        @t.finish = '16th December 2009'
+        @t.finish.should == '2009-12-16'
+      end
+      
+      it "can be set to nil" do
+        @t.finish = ''
+        @t.finish.should be_nil
+      end
+      
+      it "should be a valid date" do
+        lambda { Tournament.new('Edinburgh Masters', '2009-11-09', :finish => 'next week') }.should raise_error(/invalid.*date/)
+        lambda { @t.finish = 'X' }.should raise_error(/invalid.*date/)
+      end
+    end
+    
     # Number of rounds.
     context "rounds" do
       it "defaults to nil" do
@@ -84,6 +165,49 @@ module ICU
       end
     end
     
+    # Type, arbiter, deputy and time control.
+    context "type, arbiter, deputy and time control" do
+      before(:each) do
+        @t = Tournament.new('Edinburgh Masters', '2009-11-09', :type => 'Swiss', :arbiter => 'Gerry Graham', :deputy => 'Herbert Scarry', :time_control => '120 minutes')
+      end
+      
+      it "may be specified in constructor" do
+        @t.type.should == 'Swiss'
+        @t.arbiter.should == 'Gerry Graham'
+        @t.deputy.should == 'Herbert Scarry'
+        @t.time_control.should == '120 minutes'
+      end
+      
+      it "can be replaced by accessor" do
+        @t.type = 'all-play-all'
+        @t.type.should == 'all-play-all'
+        @t.arbiter = 'Michael Crowe'
+        @t.arbiter.should == 'Michael Crowe'
+        @t.deputy = 'Mark Orr'
+        @t.deputy.should == 'Mark Orr'
+        @t.time_control = '90 minutes'
+        @t.time_control.should == '90 minutes'
+      end
+      
+      it "can be set to nil" do
+        @t.type = ''
+        @t.type.should be_nil
+        @t.arbiter = ''
+        @t.arbiter.should be_nil
+        @t.deputy = ''
+        @t.deputy.should be_nil
+        @t.time_control = ''
+        @t.time_control.should be_nil
+      end
+      
+      it "should be valid" do
+        lambda { @t.type         = '123' }.should raise_error(/invalid.*type/)
+        lambda { @t.arbiter      = '123' }.should raise_error(/invalid.*arbiter/)
+        lambda { @t.deputy       = '123' }.should raise_error(/invalid.*deputy/)
+        lambda { @t.time_control = 'abc' }.should raise_error(/invalid.*time control/)
+      end
+    end
+    
     # Tournament players.
     context "players" do
       before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanichi-chess_icu
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Mark Orr