icu_tournament 1.0.12 → 1.0.13

data/lib/icu_tournament/tournament.rb

@@ -126,6 +126,22 @@ argument to specify how the renumbering is done.
 
 The return value from _renumber_ is the tournament object itself.
 
+
+== Parsing Files
+
+As an alternative to processing files by first instantiating a parser of the appropropriate class
+(such as ICU::Tournament::SwissPerfect, ICU::Tournament::Krause and ICU::Tournament::ForeignCSV)
+and then calling the parser's <em>parse_file</em> or <em>parse_file!</em> instance method,
+a convenience class method, <em>parse_file!</em>, is available when a parser instance is not required.
+For example:
+
+  t = ICU::Tournament.parse_file!('champs.zip', 'SwissPerfect', :start => '2010-07-03')
+
+The method takes a filename, format and an options hash as arguments. It either returns
+an instance of ICU::Tournament or throws an exception. See the documentation for the
+different formats for what options are available. For some, no options are available,
+in which case any options supplied to this method will be silently ignored.
+
 =end
 
   class Tournament
@@ -356,6 +372,18 @@ The return value from _renumber_ is the tournament object itself.
       check_ranks(:allow_none => true)
       true
     end
+    
+    # Convenience method to parse a file.
+    def self.parse_file!(file, format, opts={})
+      type = format.to_s
+      raise "Invalid format" unless type.match(/^(SwissPerfect|Krause|ForeignCSV)$/);
+      parser = "ICU::Tournament::#{format}".constantize.new
+      if type == 'SwissPerfect'
+        parser.parse_file!(file, opts)
+      else
+        parser.parse_file!(file)
+      end
+    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_).

data/lib/icu_tournament/version.rb

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

data/spec/tournament_spec.rb

@@ -799,5 +799,59 @@ EOS
         @t.player(6).rank.should == 6  # 0/5
       end
     end
+
+    context "convenience file parser" do
+      before(:all) do
+        @s = File.dirname(__FILE__) + '/samples'
+        @c = ICU::Tournament
+      end
+
+      it "should parse a valid SwissPerfect file" do
+        t = nil
+        lambda { t = @c.parse_file!("#{@s}/sp/nccz.zip", 'SwissPerfect', :start => '2010-05-08') }.should_not raise_error
+        t.players.size.should == 77
+        t.start.should == '2010-05-08'
+      end
+
+      it "should parse a valid CSV file" do
+        t = nil
+        lambda { t = @c.parse_file!("#{@s}/fcsv/valid.csv", 'ForeignCSV') }.should_not raise_error
+        t.players.size.should == 16
+      end
+
+      it "should parse a valid Krause file" do
+        t = nil
+        lambda { t = @c.parse_file!("#{@s}/krause/valid.tab", 'Krause') }.should_not raise_error
+        t.players.size.should == 12
+      end
+
+      it "should ignore options where appropriate" do
+        t = nil
+        lambda { t = @c.parse_file!("#{@s}/krause/valid.tab", 'Krause', :start => '2010-05-08') }.should_not raise_error
+        t.start.should == '2008-02-01'
+      end
+
+      it "should raise exceptions for invalid files" do
+        lambda { @c.parse_file!("#{@s}/sp/notenoughfiles.zip", 'SwissPerfect', :start => '2010-05-08') }.should raise_error(/files/)
+        lambda { @c.parse_file!("#{@s}/krause/invalid.tab", 'Krause') }.should raise_error(/name/)
+        lambda { @c.parse_file!("#{@s}/fcsv/invalid.csv", 'ForeignCSV') }.should raise_error(/termination/)
+      end
+
+      it "should raise exceptions if the wrong type is used" do
+        lambda { @c.parse_file!("#{@s}/krause/valid.tab", 'ForeignCSV') }.should raise_error(/expected/)
+        lambda { @c.parse_file!("#{@s}/fcsv/valid.csv", 'SwissPerfect') }.should raise_error(/cannot/)
+        lambda { @c.parse_file!("#{@s}/sp/nccz.zip", 'Krause') }.should raise_error(/missing/)
+      end
+
+      it "should raise an exception if file does not exist" do
+        lambda { @c.parse_file!("#{@s}/nosuchfile.cvs", 'ForeignCSV') }.should raise_error(/no such file/i)
+        lambda { @c.parse_file!("#{@s}/nosuchfile.zip", 'SwissPerfect') }.should raise_error(/invalid/i)
+        lambda { @c.parse_file!("#{@s}/nosuchfile.tab", 'Krause') }.should raise_error(/no such file/i)
+      end
+
+      it "should raise an exception if an invalid type is used" do
+        lambda { @c.parse_file!("#{@s}/krause/valid.tab", 'NoSuchType') }.should raise_error(/invalid format/i)
+      end
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 12
-  version: 1.0.12
+  - 13
+  version: 1.0.13
 platform: ruby
 authors: 
 - Mark Orr
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-14 00:00:00 +01:00
+date: 2010-10-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency