icu_tournament 1.0.13 → 1.1.0

data/lib/icu_tournament/tournament.rb

@@ -35,7 +35,7 @@ and then:
 
 or equivalntly, just:
 
-  puts @t.serialize('Krause')
+  puts t.serialize('Krause')
 
 would result in the following output:
 
@@ -72,6 +72,22 @@ Side effects of calling <em>validate!</em> or _invalid_ include:
 * the number of rounds will be set if not set already
 * the finish date will be set if not set already and if there are round dates
 
+Optionally, additional validation checks can be performed given a tournament
+parser/serializer. For example:
+
+  t.validate!(:type => ICU::Tournament.ForeignCSV.new)
+
+Or equivalently:
+
+  t.validate!(:type => 'ForeignCSV')
+
+Such additional validation is always performed before a tournament is serialized.
+For example, the following are equivalent and will throw an exception if
+the tournament is invalid according to either the general rules or the rules
+specific for the type used:
+
+  t.serialize('ForeignCSV')
+  ICU::Tournament::ForeignCSV.new.serialize(t)
 
 == Ranking
 
@@ -370,6 +386,7 @@ in which case any options supplied to this method will be silently ignored.
       check_dates
       check_teams
       check_ranks(:allow_none => true)
+      check_type(options[:type]) if options[:type]
       true
     end
     
@@ -386,12 +403,14 @@ in which case any options supplied to this method will be silently ignored.
     end
 
     # Convenience method to serialise the tournament into a supported format.
-    # Throws and exception unless the name of a supported format is supplied (e.g. _Krause_).
+    # Throws an exception unless the name of a supported format is supplied
+    # or if the tournament is unsuitable for serialisation in that format.
     def serialize(format)
       serializer = case format.to_s.downcase
         when 'krause'       then ICU::Tournament::Krause.new
         when 'foreigncsv'   then ICU::Tournament::ForeignCSV.new
         when 'swissperfect' then ICU::Tournament::SwissPerfect.new
+        when ''             then raise "no format supplied"
         else raise "unsupported serialisation format: '#{format}'"
       end
       serializer.serialize(self)
@@ -486,6 +505,17 @@ in which case any options supplied to this method will be silently ignored.
       end
     end
 
+    # Validate against a specific type.
+    def check_type(type)
+      if type.respond_to?(:validate!)
+        type.validate!(self)
+      elsif type.to_s.match(/^(ForeignCSV|Krause|SwissPerfect)$/)
+        parser = "ICU::Tournament::#{type.to_s}".constantize.new.validate!(self)
+      else
+        raise "invalid type supplied for validation check"
+      end
+    end
+
     # Return an array of tie break methods and an array of tie break orders (+1 for asc, -1 for desc).
     # The first and most important method is always "score", the last and least important is always "name".
     def tie_break_data

data/lib/icu_tournament/tournament_fcsv.rb

@@ -1,6 +1,6 @@
 module ICU
   class Tournament
-    
+
 =begin rdoc
 
 == Foreign CSV
@@ -34,7 +34,7 @@ This file can be parsed as follows.
 
 If the file is correctly specified, the return value from the <em>parse_file</em> method is an instance of
 ICU::Tournament (rather than <em>nil</em>, which indicates an error). In this example the file is valid, so:
-  
+
   tournament.name                                     # => "Isle of Man Masters, 2007"
   tournament.start                                    # => "2007-09-22"
   tournament.rounds                                   # => 9
@@ -44,7 +44,7 @@ The main player (the player whose results are being reported for rating) played
 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.
 
   player = tournament.player(1)
@@ -86,6 +86,20 @@ Or equivalently, the _serialize_ instance method of the tournament, if the appro
 
   csv = tournament.serialize('ForeignCSV')
 
+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)
+* 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)
+
+If any of these are not satisfied, then the following method calls will all raise an exception:
+
+  tournament.validate!(:type => 'ForeignCSV')
+  tournament.serialize('ForeignCSV')
+  ICU::Tournament::ForeignCSV.new.serialize(tournament)
+
 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.
 
@@ -105,30 +119,29 @@ For example, here are the commands to reproduce the example above.
   t.add_result(ICU::Result.new(3, 1, 'D', :opponent => 4, :colour => 'B'))
   t.add_result(ICU::Result.new(4, 1, 'W', :opponent => 5, :colour => 'W'))
   t.add_result(ICU::Result.new(5, 1, 'W', :opponent => 6, :colour => 'B'))
-  t.add_result(ICU::Result.new(6, 1, 'L'))                 
+  t.add_result(ICU::Result.new(6, 1, 'L'))
   t.add_result(ICU::Result.new(7, 1, 'D', :opponent => 7, :colour => 'W'))
   t.add_result(ICU::Result.new(8, 1, 'L', :opponent => 8, :colour => 'B'))
   t.add_result(ICU::Result.new(9, 1, 'D', :opponent => 9, :colour => 'W'))
-  t.validate!
   puts t.serialize('ForeignCSV')
-  
+
 =end
 
     class ForeignCSV
       attr_reader :error
-      
+
       # Parse CSV data returning a Tournament on success or raising an exception on error.
       def parse!(csv)
         @state, @line, @round, @sum, @error = 0, 0, nil, nil, nil
         @tournament = Tournament.new('Dummy', '2000-01-01')
-        
+
         Util::CSV.parse(csv, :row_sep => :auto) do |r|
           @line += 1                            # increment line number
           next if r.size == 0                   # skip empty lines
           r = r.map{|c| c.nil? ? '' : c.strip}  # trim all spaces, turn nils to blanks
           next if r[0] == ''                    # skip blanks in column 1
           @r = r                                # remember this record for later
-          
+
           begin
             case @state
               when 0 then event
@@ -145,7 +158,7 @@ For example, here are the commands to reproduce the example above.
             raise
           end
         end
-        
+
         unless @state == 4
           exp = case @state
                 when 0 then "the event name"
@@ -158,12 +171,12 @@ For example, here are the commands to reproduce the example above.
           raise "line #{@line}: premature termination - expected #{exp}"
         end
         raise "line #{@line}: no players found in file" if @tournament.players.size == 0
-        
+
         @tournament.validate!
 
         @tournament
       end
-      
+
       # Parse CSV data returning a Tournament on success or a nil on failure.
       # In the case of failure, an error message can be retrived via the <em>error</em> method.
       def parse(csv)
@@ -174,13 +187,13 @@ For example, here are the commands to reproduce the example above.
           nil
         end
       end
-      
+
       # Same as <em>parse!</em> except the input is a file name rather than file contents.
       def parse_file!(file)
         csv = open(file) { |f| f.read }
         parse!(csv)
       end
-      
+
       # Same as <em>parse</em> except the input is a file name rather than file contents.
       def parse_file(file)
         begin
@@ -190,10 +203,10 @@ For example, here are the commands to reproduce the example above.
           nil
         end
       end
-      
+
       # Serialise a tournament back into CSV format.
       def serialize(t)
-        return nil unless t.class == ICU::Tournament;
+        t.validate!(:type => self)
         Util::CSV.generate do |csv|
           csv << ["Event", t.name]
           csv << ["Start", t.start]
@@ -226,36 +239,52 @@ For example, here are the commands to reproduce the example above.
         end
       end
 
+      # Additional tournament validation rules for this specific type.
+      def validate!(t)
+        raise "missing site" unless t.site.to_s.length > 0
+        icu = t.players.find_all { |p| p.id }
+        raise "there must be at least one ICU player (with an ID number)" if icu.size == 0
+        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|
+          (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
+          end
+        end
+      end
+
       private
-      
+
       def event
         abort "the 'Event' keyword", 0 unless @r[0].match(/^(Event|Tournament)$/i)
         abort "the event name",      1 unless @r.size > 1 && @r[1] != ''
         @tournament.name = @r[1]
         @state = 1
       end
-      
+
       def start
         abort "the 'Start' keyword", 0 unless @r[0].match(/^(Start(\s+Date)?|Date)$/i)
         abort "the start date",      1 unless @r.size > 1 && @r[1] != ''
         @tournament.start = @r[1]
         @state = 2
       end
-      
+
       def rounds
         abort "the 'Rounds' keyword", 0 unless @r[0].match(/(Number of )?Rounds$/)
         abort "the number of rounds", 1 unless @r.size > 1 && @r[1].match(/^[1-9]\d*/)
         @tournament.rounds = @r[1]
         @state = 3
       end
-      
+
       def website
         abort "the 'Website' keyword", 0 unless @r[0].match(/^(Web(\s?site)?|Site)$/i)
         abort "the event website",     1 unless @r.size > 1 && @r[1] != ''
         @tournament.site = @r[1]
         @state = 4
       end
-      
+
       def player
         abort "the 'Player' keyword",  0 unless @r[0].match(/^Player$/i)
         abort "a player's ICU number", 1 unless @r.size > 1 && @r[1].match(/^[1-9]/i)
@@ -274,7 +303,7 @@ For example, here are the commands to reproduce the example above.
         @round = 0
         @state = 5
       end
-      
+
       def result
         @round+= 1
         abort "round number #{round}",              0 unless @r[0].to_i == @round
@@ -309,14 +338,14 @@ For example, here are the commands to reproduce the example above.
         end
         @state = 6 if @round == @tournament.rounds
       end
-      
+
       def total
         points = @player.points
         abort "the 'Total' keyword", 0 unless @r[0].match(/^Total$/i)
         abort "the player's (#{@player.object_id}, #{@player.results.size}) total points to be #{points}", 1 unless @r[1].to_f == points
         @state = 4
       end
-      
+
       def abort(expected, cell)
         got = @r[cell]
         error = "line #{@line}"

data/lib/icu_tournament/tournament_krause.rb

@@ -199,7 +199,7 @@ attributes in an ICU::Tournament instance.
 
       # Serialise a tournament back into Krause format.
       def serialize(t)
-        return nil unless t.class == ICU::Tournament;
+        t.validate!(:type => self)
         krause = ''
         krause << "012 #{t.name}\n"
         krause << "022 #{t.city}\n"         if t.city
@@ -225,6 +225,11 @@ attributes in an ICU::Tournament instance.
         krause
       end
 
+      # Additional tournament validation rules for this specific type.
+      def validate!(t)
+        # None.
+      end
+
       private
 
       def set_name

data/lib/icu_tournament/tournament_sp.rb

@@ -146,7 +146,7 @@ See ICU::Tournament for more about tie-breaks.
 
       # Serialise a tournament to SwissPerfect text export format.
       def serialize(t)
-        return nil unless t.class == ICU::Tournament && t.players.size > 2;
+        t.validate!(:type => self)
 
         # Ensure a nice set of numbers.
         t.renumber(:order)
@@ -173,6 +173,11 @@ See ICU::Tournament for more about tie-breaks.
         sp
       end
 
+      # Additional tournament validation rules for this specific type.
+      def validate!(t)
+        # None.
+      end
+
       private
 
       def get_files(file, arg)

data/lib/icu_tournament/version.rb

@@ -1,5 +1,5 @@
 module ICU
   class Tournament
-    VERSION = "1.0.13"
+    VERSION = "1.1.0"
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
 require 'rubygems'
 require 'rspec'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/icu_tournament')
+
+RSpec.configure do |c|
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+end

data/spec/tournament_fcsv_spec.rb

@@ -412,10 +412,6 @@ CSV
         it "should serialize back to the original" do
           @f.serialize(@t).should == @csv
         end
-
-        it "should return nil on invalid input" do
-          @f.serialize('Rubbish').should be_nil
-        end
       end
       
       context "serialisation of ForeignCSV documentation example" do
@@ -515,9 +511,8 @@ Player,456,Fox,Anthony
 9,=,W,Phillips,Roy,2271,,MAU
 Total,4.0
 CSV
-          @t = ICU::Tournament.new("Isle of Man Masters, 2007", '2007-09-22', :round => 9)
+          @t = ICU::Tournament.new("Isle of Man Masters, 2007", '2007-09-22')
           @t.site = 'http://www.bcmchess.co.uk/monarch2007/'
-          @t.rounds = 9
           @t.add_player(ICU::Player.new('Anthony', 'Fox', 1, :id => 456, :rating => 2100, :fed => 'IRL'))
           @t.add_player(ICU::Player.new('Peter P.', 'Taylor', 2, :rating => 2209, :fed => 'ENG'))
           @t.add_player(ICU::Player.new('Egozi', 'Nadav', 3, :rating => 2205, :fed => 'ISR'))
@@ -574,6 +569,72 @@ CSV
           t.players.size.should == 16
         end
       end
+
+      context "type validation" do
+        before(:each) do
+          @p = ICU::Tournament::ForeignCSV.new
+          @t = ICU::Tournament.new("Isle of Man Masters, 2007", '2007-09-22')
+          @t.site = 'http://www.bcmchess.co.uk/monarch2007/'
+          @t.add_player(ICU::Player.new('Anthony', 'Fox', 1, :id => 456))
+          @t.add_player(ICU::Player.new('Peter', 'Cafolla', 2, :id => 159))
+          @t.add_player(ICU::Player.new('Peter P.', 'Taylor', 10, :rating => 2209, :fed => 'ENG'))
+          @t.add_player(ICU::Player.new('Egozi', 'Nadav', 20, :rating => 2205, :fed => 'ISR'))
+          @t.add_player(ICU::Player.new('Tim R.', 'Spanton', 30, :rating => 1982, :fed => 'ENG'))
+          @t.add_player(ICU::Player.new('Alan', 'Grant', 40, :rating => 2223, :fed => 'SCO'))
+          @t.add_result(ICU::Result.new(1, 1, 'W', :opponent => 10, :colour => 'W'))
+          @t.add_result(ICU::Result.new(1, 2, 'L', :opponent => 20, :colour => 'B'))
+          @t.add_result(ICU::Result.new(2, 1, 'D', :opponent => 30, :colour => 'B'))
+          @t.add_result(ICU::Result.new(2, 2, 'L', :opponent => 40, :colour => 'W'))
+        end
+
+        it "should pass" do
+          @t.invalid.should be_false
+          @t.invalid(:type => @p).should be_false
+        end
+
+        it "should fail if there's no site" do
+          @t.site = nil;
+          @t.invalid(:type => @p).to_s.should match(/site/)
+        end
+
+        it "should fail if there are no ICU players" do
+          [1, 2].each { |n| @t.player(n).id = nil }
+          @t.player(2).id = nil;
+          @t.invalid(:type => @p).to_s.should match(/ID/)
+        end
+
+        it "should fail unless all foreign players have a federation" do
+          @t.player(10).fed = nil;
+          @t.invalid(:type => @p).to_s.should match(/federation/)
+        end
+
+        it "should fail unless every ICU player has a result in every round" do
+          @t.add_player(ICU::Player.new('Mark', 'Orr', 3, :id => 1350))
+          @t.add_result(ICU::Result.new(1, 3, 'W', :opponent => 30, :colour => 'B'))
+          @t.invalid(:type => @p).to_s.should match(/result/)
+          @t.add_result(ICU::Result.new(2, 3, 'W', :opponent => 10, :colour => 'W'))
+          @t.invalid(:type => @p).should be_false
+        end
+
+        it "should fail unless every ICU player's opponents have a federation" do
+          @t.add_player(ICU::Player.new('Mark', 'Orr', 3, :id => 1350))
+          @t.add_result(ICU::Result.new(1, 3, 'W', :opponent => 30, :colour => 'B'))
+          @t.add_result(ICU::Result.new(2, 3, 'W', :opponent => 10, :colour => 'W'))
+          @t.add_result(ICU::Result.new(3, 1, 'D', :opponent => 40, :colour => 'W'))
+          @t.add_result(ICU::Result.new(3, 2, 'L', :opponent => 3,  :colour => 'B'))
+          @t.invalid(:type => @p).to_s.should match(/opponents.*federation/)
+          @t.player(2).fed = 'IRL'
+          @t.invalid(:type => @p).to_s.should match(/opponents.*federation/)
+          @t.player(3).fed = 'IRL'
+          @t.invalid(:type => @p).should be_false
+        end
+
+        it "should be serializable unless invalid" do
+          lambda { @p.serialize(@t) }.should_not raise_error
+          @t.site = nil;
+          lambda { @p.serialize(@t) }.should raise_error
+        end
+      end
     end
   end
 end

data/spec/tournament_krause_spec.rb

@@ -158,7 +158,7 @@ KRAUSE
           @t.add_result(ICU::Result.new(1, 1, 'L', :opponent => 2, :colour => 'B'))
           @t.add_result(ICU::Result.new(2, 1, 'L', :opponent => 2, :colour => 'W', :rateable => false))
           @t.add_result(ICU::Result.new(3, 1, 'W', :opponent => 2, :colour => 'B'))
-          @t.add_result(ICU::Result.new(4, 1, 'W', :opponent => 2, :colour => 'B'))
+          @t.add_result(ICU::Result.new(4, 1, 'D', :opponent => 2, :colour => 'W'))
           serializer = ICU::Tournament::Krause.new
           @k = serializer.serialize(@t)
         end
@@ -173,7 +173,7 @@ KRAUSE
       end
       
       context "serialisation" do
-        before(:all) do
+        before(:each) do
           @krause = <<KRAUSE
 012 Las Vegas National Open
 022 Las Vegas
@@ -204,10 +204,6 @@ KRAUSE
         it "should serialize using the convenience method of the tournament object" do
           @t.serialize('Krause').should == @krause
         end
-
-        it "should return nil on invalid input" do
-          @q.serialize('Rubbish').should be_nil
-        end
       end
 
       context "auto-ranking" do
@@ -374,13 +370,13 @@ KRAUSE
            lambda { t = @p.parse!(@k) }.should raise_error(/opponent/)
         end
       end
-      
+
       context "parsing files" do
         before(:each) do
           @p = ICU::Tournament::Krause.new
           @s = File.dirname(__FILE__) + '/samples/krause'
         end
-        
+
         it "should error on a non-existant valid file" do
           file = "#{@s}/not_there.tab"
           lambda { @p.parse_file!(file) }.should raise_error
@@ -388,7 +384,7 @@ KRAUSE
           t.should be_nil
           @p.error.should match(/no such file/i)
         end
-        
+
         it "should error on an invalid file" do
           file = "#{@s}/invalid.tab"
           lambda { @p.parse_file!(file) }.should raise_error
@@ -396,7 +392,7 @@ KRAUSE
           t.should be_nil
           @p.error.should match(/tournament name missing/i)
         end
-        
+
         it "should parse a valid file" do
           file = "#{@s}/valid.tab"
           lambda { @p.parse_file!(file) }.should_not raise_error

data/spec/tournament_spec.rb

@@ -853,5 +853,26 @@ EOS
         lambda { @c.parse_file!("#{@s}/krause/valid.tab", 'NoSuchType') }.should raise_error(/invalid format/i)
       end
     end
+
+    context "type specific validation" do
+      before(:all) do
+        @t = Tournament.new('Bangor Bash', '2009-11-09')
+        @t.add_player(Player.new('Bobby', 'Fischer', 1))
+        @t.add_player(Player.new('Garry', 'Kasparov', 2))
+        @t.add_player(Player.new('Mark', 'Orr', 3))
+        @t.add_result(Result.new(1, 1, '=', :opponent => 2, :colour => 'W'))
+        @t.add_result(Result.new(2, 2, 'L', :opponent => 3, :colour => 'W'))
+        @t.add_result(Result.new(3, 3, 'W', :opponent => 1, :colour => 'W'))
+      end
+
+      it "should pass generic validation" do
+        @t.invalid.should be_false
+      end
+
+      it "should fail type-specific validation when the type supplied is inappropriate" do
+        @t.invalid(:type => String).should match(/invalid type/)
+        @t.invalid(:type => "AbCd").should match(/invalid type/)
+      end
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 13
-  version: 1.0.13
+  version: 1.1.0
 platform: ruby
 authors: 
 - Mark Orr
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-16 00:00:00 +01:00
+date: 2010-10-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency