icu_tournament 1.0.3 → 1.0.4

data/README.rdoc

@@ -9,11 +9,10 @@ The gem is hosted on gemcutter only:
 
   sudo gem install icu_tournament
 
-For Ruby prior to version 1.9 you also need:
+For handling SwissPerfect files the _dbf_, _inifile_ and _rubyzip_ gems are required.
+For Ruby prior to version 1.9 the _fastercsv_ gem is needed to handle CSV files.
+
 
-  sudo gem install fastercsv
-  
-  
 == Usage
 
 There are two main uses for this gem:
@@ -24,11 +23,11 @@ There are two main uses for this gem:
 * You have a file in a supported format and you need to extract the information it contains.
   For example, you have a Krause formatted file and want to extract the data and insert it into a database.
 
-The currently supported formats (more are planned) are:
+The currently supported formats are:
 
 * ICU::Tournament::Krause - the format used by FIDE.
 * ICU::Tournament::ForeignCSV - used by Irish players to report their individual results in foreign tournaments.
-* ICU::Tournament::SwissPerfect - very often used by Irish tournament controllers to report results.
+* ICU::Tournament::SwissPerfect - often used by Irish tournament controllers to report results.
 
 
 == Writing Files
@@ -41,7 +40,7 @@ the information that a Krause file might contain is included here (see ICU::Tour
   t.add_player(ICU::Player.new('Robert J.', 'Fischer', 1))
   t.add_player(ICU::Player.new('Boris V.', 'Spassky', 2))
 
-Then the results for each round are added using the ID numbers to refer to the players.
+Then the results for each round are added using the unique ID numbers to refer to the players.
 
   t.add_result(ICU::Result.new(1, 1, 'L', :opponent => 2, :colour => 'B'))
 
@@ -67,11 +66,13 @@ Suppose you have a tournament file in Krause format. Parse it into a tournament
   data = open('tournament.txt') { |f| f.read }
   parser = ICU::Tournament::Krause.new
   tournament = parser.parse(data)
-  
+
 On success, the _parse_ method returns an object of type ICU::Tournament. A tournament (ICU::Tournament)
 has two or more players (ICU::Player), and each player has one or more results (ICU::Result). See the
-rdoc for more details. On error, the _parse_ method returns _nil_ and an error message can be retrieved
-from the parser (parser.error).
+rdoc for more details. You can traverse these objects and do what you want with them, such as storing the
+information in a database.
+
+On error, the _parse_ method returns _nil_ and an error message can be retrieved from the parser (parser.error).
 
 == Author
 

data/lib/icu_tournament/tournament_sp.rb

@@ -1,5 +1,7 @@
 require 'inifile'
 require 'dbf'
+require 'zip/zipfilesystem'
+require 'tempfile'
 
 module ICU
   class Tournament
@@ -149,7 +151,7 @@ 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_zipped_files(file) : get_bare_files(file)
+        file.match(/\.zip$/i) ? get_zip_files(file) : get_bare_files(file)
       end
 
       def get_bare_files(file)
@@ -161,8 +163,32 @@ Should you wish to rank the tournament using a different set of tie-break rules,
         end
       end
 
-      def get_zipped_files(file)
-        raise "get_zip_files not implemented"
+      def get_zip_files(file)
+        temp = Hash.new
+        begin
+          Zip::ZipFile.open(file) do |zf|
+            raise "ZIP file should contain exactly 3 files (.ini, .trn and .sco)" unless zf.size == 3
+            stem = Hash.new
+            zf.entries.each do |e|
+              if e.file? && e.name.match(/^(.+)\.(ini|trn|sco)$/i)
+                stm = $1
+                ext = $2.downcase
+                stem[ext] = stm
+                tmp = Tempfile.new(e.name)
+                tmp.close
+                e.extract(tmp.path) { true }
+                temp[ext] = tmp.path
+              end
+            end
+            %w(ini trn sco).each { |ext| raise "no #{ext.upcase} file found" unless stem[ext] }
+            raise "different stem names found" unless stem['ini'] == stem['trn'] && stem['trn'] == stem['sco']
+          end
+        rescue Zip::ZipError
+          raise "invalid ZIP file"
+        rescue => ex
+          raise ex
+        end
+        %w(ini trn sco).map { |ext| temp[ext] }
       end
 
       def parse_ini(file)

data/lib/icu_tournament/version.rb

@@ -1,5 +1,5 @@
 module ICU
   class Tournament
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

data/spec/tournament_sp_spec.rb

@@ -43,11 +43,11 @@ module ICU
           @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
           @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
-        
+
         it "should have the correct tie breaks" do
           @t.tie_breaks.join('|').should == "buchholz|harkness"
         end
@@ -76,11 +76,11 @@ module ICU
           @t.player(3).signature.should == "Hulleman, Leon|6409|1466|1.0|3|123|LWL|BBW|TTT"
           @t.player(4).signature.should == "Dunne, Thomas|10914||0.0|4|123|LLL|BWB|TTT"
         end
-        
+
         it "should have consistent ranks" do
           @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
-        
+
         it "should have the no tie breaks" do
           @t.tie_breaks.join('|').should == ""
         end
@@ -110,11 +110,11 @@ module ICU
           @t.player(18).signature.should == "Freeman, Ruiri|||2.0|17|1234567|DDLLLLW|--WBBWB|FFTTTTF"             # had byes and bonus (in BONUS)
           @t.player(16).signature.should == "O'Connor, David|||1.0|19|123|WLL|WBW|FTF"                            # last
         end
-        
+
         it "should have consistent ranks" do
           @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
-        
+
         it "should have the correct tie breaks" do
           @t.tie_breaks.join('|').should == "harkness|buchholz"
         end
@@ -138,11 +138,11 @@ module ICU
           @t.player(8).signature.should  == "Berney, Mark|10328|1948|2.0|3|23|WW|BW|TT"             # didn't play in round 1
           @t.player(10).signature.should == "O'Donnell, Conor E.|10792|1073|2.0|10|123|LWW|WBW|TFT"  # got just 1 point for a bye
         end
-        
+
         it "should have consistent ranks" do
           @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
-        
+
         it "should have the correct tie breaks" do
           @t.tie_breaks.join('|').should == "neustadtl"
         end
@@ -167,7 +167,7 @@ module ICU
           @t.player(46).signature.should == "O'Riordan, Pat|10696|900|2.0|42|123456|LDDLDD|BWBWWB|TTTTFT"
           @t.player(38).signature.should == "Gill, Craig I.|10637|1081|2.0|43|123456|LLWDDL|BWBWWB|TTTTFT"
         end
-        
+
         it "should have consistent ranks" do
           @t.players.map{ |p| p.rank }.sort.join('').should == (1..@t.players.size).to_a.join('')
         end
@@ -191,7 +191,87 @@ module ICU
           @t.player(8).signature.should  == "Vega, Marcos Llaneza||2475|3.0|16|1234|DDWW|BWBW|TTTT"
           @t.player(67).signature.should == "Lee, Shane|780|1633|1.0|52|134|DLD|WWW|TTT"
         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.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"
+          @t.player(67).signature.should == "Lee, Shane|||1.0|52|134|DLD|WWW|TTT"
+        end
+      end
+
+      context "Non-existant ZIP file" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'nosuchzipfile.zip', "2010-05-08")
+        end
+
+        it "should not parse and should have a relevant error" do
+          @t.should be_nil
+          @p.error.should match(/invalid ZIP file/i)
+        end
+      end
+
+      context "Invalid ZIP file" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'notazipfile.zip', "2010-05-08")
+        end
+
+        it "should not parse and have a should have relevant error" do
+          @t.should be_nil
+          @p.error.should match(/invalid ZIP file/i)
+        end
+      end
+
+      context "ZIP file containing the wrong number of files" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'notenoughfiles.zip', "2010-05-08")
+        end
+
+        it "should not parse and should have a relevant error" do
+          @t.should be_nil
+          @p.error.should match(/3 files/i)
+        end
+      end
+
+      context "ZIP file containing the files with mixed stems" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'mixedstems.zip', "2010-05-08")
+        end
+
+        it "should not parse and should have a relevant error" do
+          @t.should be_nil
+          @p.error.should match(/different stem/i)
+        end
+      end
+
+      context "National Club Champiomships 2010 ZIP file" do
+
+        before(:all) do
+          @p = ICU::Tournament::SwissPerfect.new
+          @t = @p.parse_file(SAMPLES + 'nccz.zip', "2010-05-08")
+        end
+
+        it "should parse and have the right basic details" do
+          @p.error.should be_nil
+          @t.signature.should == "National Club Championship 2010|Gerry Graham|4|2010-05-08|77"
+        end
+
+        it "should have correct details for selection of players, including ICU IDs" do
+          @t.player(2).signature.should  == "Szabo, Gergely|12379|2530|4.0|4|1234|WWWW|WBWB|TTTT"
+          @t.player(5).signature.should  == "Daly, Colm|295|2314|3.5|7|1234|WWWD|WBWB|TTTT"
+          @t.player(8).signature.should  == "Vega, Marcos Llaneza||2475|3.0|16|1234|DDWW|BWBW|TTTT"
+          @t.player(67).signature.should == "Lee, Shane|780|1633|1.0|52|134|DLD|WWW|TTT"
+        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.player(2).signature.should  == "Szabo, Gergely|1205064||4.0|4|1234|WWWW|WBWB|TTTT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: icu_tournament
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-20 00:00:00 +01:00
+date: 2010-07-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.5
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development