icu_tournament 1.0.6 → 1.0.7

data/lib/icu_tournament/tournament_sp.rb

@@ -12,35 +12,45 @@ module ICU
 
 This is the format produced by the Windows program, SwissPerfect[http://www.swissperfect.com/]. It consists of three
 files with the same name but different endings: <em>.ini</em> for meta data such as tournament name and tie-break
-rules, <em>.trn</em> for the player details such as name and ID, and <em>.sco</em> for the results. The first
+rules, <em>.trn</em> for the player details such as name and rating, and <em>.sco</em> for the results. The first
 file is text and the other two are in an old binary format known as <em>DBase 3</em>.
 
 To parse such a set of files, use either the _parse_file!_ or _parse_file_ method supplying the name of any one
 of the three files or just the stem name without any ending. In case of error, such as any of the files not being
 found, _parse_file!_ will throw an exception while _parse_file_ will return _nil_ and record an error message.
-As well as a file name or stem name, you must also supply a start date because SwissPerfect does not record this
-information.
+As well as a file name or stem name, you should also supply a start date in the options as SwissPerfect does not
+record this information.
 
   parser = ICU::Tournament::SwissPerfect.new
-  tournament = parser.parse_file('champs', "2010-07-03")  # looks for "champs.ini", "champs.trn" and "champs.sco"
+  tournament = parser.parse_file('champs', :start => '2010-07-03')  # looks for "champs.ini", "champs.trn" and "champs.sco"
   puts parser.error unless tournament
 
 Alternatively, if all three files are in a ZIP archive, the parser will extract them if the name of the
-archive file (including the .zip ending) is supplied to the _parse_file_ method:
+archive file is supplied to the _parse_file_ method and it ends in ".zip" (case insensitive):
 
-  tournament = parser.parse_file('champs.zip', "2010-07-03")
+  tournament = parser.parse_file('champs.zip', :start => '2010-07-03')
+
+Or, if the file is a ZIP archive but it's name doesn't end in ".zip", that can be signalled with an option:
+
+  tournament = parser.parse_file('/tmp/a84f21ge', :zip => true, :start => '2010-07-03')
 
 Note there must be only three files in the archive, they must all have the same stem name and
 their endings should be ".ini", ".trn" and ".sco" (case insensitive).
 
+If no start date is supplied it will default to 2000-01-01, and can be reset later.
+
+  tournament = parser.parse_file('champs.zip')
+  tournament.start                # => '2000-01-01'
+  tournament.start = '2010-07-03'
+
 By default, the parser extracts local ratings and IDs from the SwissPerfect files. If international
 ratings or IDs are required instead, use the options _id_ and _rating_. For example:
 
-  tournament = parser.parse_file('ncc', "2010-05-08")
+  tournament = parser.parse_file('ncc', :start => '2010-05-08')
   tournament.player(2).id         # =>  12379 (ICU ID)
   tournament.player(2).rating     # =>  2556  (ICU rating)
 
-  tournament = parser.parse_file('ncc', "2010-05-08", :id => :intl, :rating => :intl)
+  tournament = parser.parse_file('ncc', :start => '2010-05-08', :id => :intl, :rating => :intl)
   tournament.player(2).id         # =>  1205064 (FIDE ID)
   tournament.player(2).rating     # =>  2530    (FIDE rating)
 
@@ -69,7 +79,8 @@ renumbering method) before serializing. For example:
 
 There should be no need to explicitly rank the tournament first, as that information is already present in
 SwissPerfect files (i.e. each player should already have a rank after the files have been parsed).
-Additionally, the tie break rules used for the tournament will be available from:
+Additionally, the tie break rules used for the tournament will be available from the _tie_break_ method,
+dir example:
 
   tournament.tie_breaks           # => [:buchholz, :harkness]
 
@@ -78,6 +89,8 @@ Should you wish to rank the tournament using a different set of tie-break rules,
   tournament.tie_breaks = [:wins, :blacks]
   swiss_perfect = tournament.rerank.renumber.serialize('SwissPerfect')
 
+See ICU::Tournament for more about tie-breaks.
+
 =end
 
     class SwissPerfect
@@ -98,11 +111,12 @@ Should you wish to rank the tournament using a different set of tie-break rules,
       SCO = %w{ROUND WHITE BLACK W_SCORE B_SCORE W_TYPE B_TYPE}  # not used W_SUBSCO, B_SUBSCO
 
       # Parse SP data returning a Tournament or raising an exception on error.
-      def parse_file!(file, start, arg={})
-        @t = Tournament.new('Dummy', start)
+      def parse_file!(file, arg={})
+        @t = Tournament.new('Dummy', '2000-01-01')
+        @t.start = arg[:start] if arg[:start]
         @bonus = {}
         @start_no = {}
-        ini, trn, sco = get_files(file)
+        ini, trn, sco = get_files(file, arg)
         parse_ini(ini)
         parse_trn(trn, arg)
         parse_sco(sco)
@@ -113,9 +127,9 @@ Should you wish to rank the tournament using a different set of tie-break rules,
 
       # Parse SP data returning an ICU::Tournament or a nil on failure. In the latter
       # case, an error message will be available via the <em>error</em> method.
-      def parse_file(file, start, arg={})
+      def parse_file(file, arg={})
         begin
-          parse_file!(file, start, arg)
+          parse_file!(file, arg)
         rescue => ex
           @error = ex.message
           nil
@@ -153,8 +167,8 @@ Should you wish to rank the tournament using a different set of tie-break rules,
 
       private
 
-      def get_files(file)
-        file.match(/\.zip$/i) ? get_zip_files(file) : get_bare_files(file)
+      def get_files(file, arg)
+        file.match(/\.zip$/i) || arg[:zip] ? get_zip_files(file) : get_bare_files(file)
       end
 
       def get_bare_files(file)

data/lib/icu_tournament/version.rb

@@ -1,5 +1,5 @@
 module ICU
   class Tournament
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

data/spec/tournament_sp_spec.rb

@@ -28,7 +28,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'gonzaga_challengers_2010.trn', "2010-01-29")
+          @t = @p.parse_file(SAMPLES + 'gonzaga_challengers_2010.trn', :start => "2010-01-29")
           @s = open(SAMPLES + 'gonzaga_challengers_2010.txt') { |f| f.read }
         end
 
@@ -40,8 +40,8 @@ module ICU
         it "should have correct details for selected players" do
           @t.player(2).signature.should  == "Mullooly, Neil M.|6438|1083|6.0|1|123456|WWWWWW|WBWBWB|TTTTTT" # winner
           @t.player(4).signature.should  == "Gallagher, Mark|12138|1036|4.0|9|123456|WLWWWL|WBWBWB|FTTTTT"  # had one bye
-          @t.player(45).signature.should == "Catre, Loredan||507|3.5|18|123456|WDLWLW|BWBWBW|FTTTFT"         # had two byes
-          @t.player(56).signature.should == "McDonnell, Cathal||498|0.0|54|1|L|-|F"                          # last
+          @t.player(45).signature.should == "Catre, Loredan||507|3.5|18|123456|WDLWLW|BWBWBW|FTTTFT"        # had two byes
+          @t.player(56).signature.should == "McDonnell, Cathal||498|0.0|54|1|L|-|F"                         # last
         end
 
         it "should have consistent ranks" do
@@ -61,7 +61,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'junior_championships_u19_2010.sco', "2010-04-11")
+          @t = @p.parse_file(SAMPLES + 'junior_championships_u19_2010.sco', :start => "2010-04-11")
           @s = open(SAMPLES + 'junior_championships_u19_2010.txt') { |f| f.read }
         end
 
@@ -94,7 +94,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'LimerickClubChampionship09.ini', "2009-09-15")
+          @t = @p.parse_file(SAMPLES + 'LimerickClubChampionship09.ini', :start => "2009-09-15")
         end
 
         it "should parse and have the right basic details" do
@@ -124,7 +124,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'junior_provincials_u16_2010', "2010-02-02")
+          @t = @p.parse_file(SAMPLES + 'junior_provincials_u16_2010', :start => "2010-02-02")
         end
 
         it "should parse and have the right basic details" do
@@ -152,7 +152,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'mulcahy_2010', "2010-01-15")
+          @t = @p.parse_file(SAMPLES + 'mulcahy_2010', :start => "2010-01-15")
         end
 
         it "should parse and have the right basic details" do
@@ -177,7 +177,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'ncc', "2010-05-08")
+          @t = @p.parse_file(SAMPLES + 'ncc', :start => "2010-05-08")
         end
 
         it "should parse and have the right basic details" do
@@ -193,7 +193,7 @@ module ICU
         end
 
         it "should have correct details for selection of players, including international IDs and ratings when so configured" do
-          @t = @p.parse_file(SAMPLES + 'ncc', "2010-05-08", :id => :intl, :rating => :intl)
+          @t = @p.parse_file(SAMPLES + 'ncc', :start => "2010-05-08", :id => :intl, :rating => :intl)
           @t.player(2).signature.should  == "Szabo, Gergely|1205064||4.0|4|1234|WWWW|WBWB|TTTT"
           @t.player(5).signature.should  == "Daly, Colm|2500434||3.5|7|1234|WWWD|WBWB|TTTT"
           @t.player(8).signature.should  == "Vega, Marcos Llaneza|2253585||3.0|16|1234|DDWW|BWBW|TTTT"
@@ -205,7 +205,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'nosuchzipfile.zip', "2010-05-08")
+          @t = @p.parse_file(SAMPLES + 'nosuchzipfile.zip', :start => "2010-05-08")
         end
 
         it "should not parse and should have a relevant error" do
@@ -218,7 +218,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'notazipfile.zip', "2010-05-08")
+          @t = @p.parse_file(SAMPLES + 'notazipfile.zip', :start => "2010-05-08")
         end
 
         it "should not parse and have a should have relevant error" do
@@ -231,7 +231,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'notenoughfiles.zip', "2010-05-08")
+          @t = @p.parse_file(SAMPLES + 'notenoughfiles.zip', :start => "2010-05-08")
         end
 
         it "should not parse and should have a relevant error" do
@@ -244,7 +244,7 @@ module ICU
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'mixedstems.zip', "2010-05-08")
+          @t = @p.parse_file(SAMPLES + 'mixedstems.zip', :start => "2010-05-08")
         end
 
         it "should not parse and should have a relevant error" do
@@ -253,11 +253,11 @@ module ICU
         end
       end
 
-      context "National Club Champiomships 2010 ZIP file" do
+      context "ZIP file" do
 
         before(:all) do
           @p = ICU::Tournament::SwissPerfect.new
-          @t = @p.parse_file(SAMPLES + 'nccz.zip', "2010-05-08")
+          @t = @p.parse_file(SAMPLES + 'nccz.zip', :start => "2010-05-08")
         end
 
         it "should parse and have the right basic details" do
@@ -272,6 +272,33 @@ module ICU
           @t.player(67).signature.should == "Lee, Shane|780|1633|1.0|52|134|DLD|WWW|TTT"
         end
       end
+      
+      context "ZIP file without a ZIP ending" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+        end
+
+        it "should not parse unless ZIP format is signalled with an option" do
+          lambda { @p.parse_file!(SAMPLES + 'nccz.piz', :start => "2010-05-08") }.should raise_error(/cannot find/i)
+        end
+
+        it "should parse if ZIP format is signalled with an option" do
+          lambda { @p.parse_file!(SAMPLES + 'nccz.piz', :zip => true, :start => "2010-05-08") }.should_not raise_error
+        end
+      end
+      
+      context "Defaulting the start date" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'nccz.zip')
+        end
+
+        it "should default the start date if not supplied" do
+          @t.start.should == "2000-01-01"
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: icu_tournament
 version: !ruby/object:Gem::Version 
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-17 00:00:00 +01:00
+date: 2010-07-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency