contestify 1.2.0 → 1.2.1

data/README.md

@@ -7,13 +7,19 @@ Usage
 ---
 
 ```
-  contestify coci_problems_url judge_upload_url judge_password
+contestify coci_problems_url judge_upload_url judge_password
 ```
 
 This will get the .zip file from the `coci_problems_url` and add the problems to the DOM Judge on the server. This **will not** create a new contest. Just add problems to the current one.
 
 It is assumed that the admin username is `admin`.
 
+### Example
+
+```
+contestify http://hsin.hr/coci/contest1_testdata.zip http://juez.factorcomun.org/jury/problem.php p4ssw0rd
+```
+
 Contributions
 ---
 

data/lib/contestify/configuration.rb

@@ -1,10 +1,29 @@
 module Contestify
+  # <tt>Contestify::Configuration</tt> is in charge of renaming files and
+  # adding DOMJudge specific configuration files to each problem.
   class Configuration
 
+    # <tt>Contestify::Configuration.configure!</tt> is *the only* method you
+    # should call from the contest interface. All the other methods should be
+    # called from here. This is the only method needed for future strategies
+    # for other judges.
+    #
+    # This should be called in a directory structure such that you have a
+    # `base_folder` with one folder for each problem you want to upload to the
+    # server. Each of these problems folders should have all the input/output
+    # files you want to use as test cases.
+    #
+    # This method **must** return the absolute paths of the problem folders in
+    # an array. This return value will be used in Contestify::Uploader.upload!
+    #
+    # ==== Parameters
+    # base_folder<String>:: The base folder where all the problems folders are
+    #                       stored.
+    #
     def self.configure!(base_folder)
       puts green "=> Configuring problems"
       problem_index = 0
-      Dir.glob("*").select { |f| File.directory?(f) }.each do |dir|
+      Dir.glob("*").select { |f| File.directory?(f) }.map do |dir|
         Dir.chdir File.join(base_folder, dir)
         dirid = Dir.pwd.split('/').last[0...8]
         puts green "==> #{dirid.upcase}"
@@ -12,9 +31,26 @@ module Contestify
         add_problem_config(dirid, problem_index)
         problem_index += 1
         puts green "==> All the work for #{dirid.upcase} is done"
+        Dir.pwd # Return the absolute path for this problem
       end
     end
 
+    # <tt>Contestify::Configuration.rename_data_files</tt> is in charge of
+    # giving each input/output file a standard name that DOMJudge understands.
+    #
+    # This method should be overriden in future strategies.
+    #
+    # After this method is called, every different input/output file **must**
+    # have the following structure:
+    #
+    #   `problemid`.`number`.in
+    #   `problemid`.`number`.out
+    #
+    # where:
+    #
+    # `problemid` is at most 8 letters long and it's the id for the judge and
+    # `number` is the test case number. The .in and .out will determine the
+    # input and compare file the judge will run/diff.
     def self.rename_data_files
       puts blue "===> Renaming input/output files"
       Dir.glob("*").select { |f| f =~ /\.in.[0-9]+/ }.each do |f|
@@ -33,6 +69,16 @@ module Contestify
       end
     end
 
+    # <tt>Contestify::Configuration.add_problem_config</tt> will add the
+    # configuration file needed for DOMJudge to understand the problem.
+    #
+    # ==== Parameters
+    # probid<String>:: The problem id for DOMJudge. This **must** be at most
+    #                  8 letters long.
+    #
+    # problem_index<Integer>:: This is the problem number. This is only used 
+    #                          to choose the problem ballon color.
+
     def self.add_problem_config(probid, problem_index)
       puts blue "===> Adding DOM Judge configuration #{probid}"
       file_content = <<-TEXT

data/lib/contestify/contest.rb

@@ -17,8 +17,8 @@ module Contestify
       get_problems
       unzip_problems
       @base_dir = Dir.pwd
-      Contestify::Configuration.configure!(@base_dir)
-      Contestify::Uploader.upload!(@judge_url, @judge_password, @base_dir)
+      problems_path = Contestify::Configuration.configure!(@base_dir)
+      Contestify::Uploader.upload!(@judge_url, @judge_password, problems_path)
       clean_dir!
     end
 

data/lib/contestify/uploader.rb

@@ -1,11 +1,24 @@
 module Contestify
+  # <tt>Contestify::Uploader</tt> is a simple class that will habdle the
+  # uploading part to the server.
   class Uploader
-    def self.upload!(server_url, admin_pwd, base_dir)
+    # <tt>Contestify::Uploader.upload!</tt> is *the only* method you should call
+    # to upload the problems to the server. It will receive 3 params.
+    #
+    # ==== Parameters
+    # server_url<String>:: The **upload** URL in the server. E.g http://your-dom-judge.com/jury/problem.php
+    #
+    # admin_pwd<String>:: This is the `admin` password needed to authenticate in the server
+    #
+    # problems_path<Array>:: An array having all the paths where the problems input/output are.
+    #                        This *should* be the return array from a <tt>Contestify::Configuration</tt> call.
+    #                        The paths here **must** be absolute paths.
+    #
+    def self.upload!(server_url, admin_pwd, problems_path)
       puts green "\n\n=> Uploading problems to the server"
-
-      Dir.chdir base_dir # Ensure you're on the `root` dir
-      Dir.glob("*").select { |f| File.directory?(f) }.each do |dir|
-        Dir.chdir File.join(base_dir, dir)
+      
+      for dir in problems_path do
+        Dir.chdir dir
 
         unless File.exists?("domjudge-problem.ini")
           puts cyan "domjudge-problem.ini not found. Skipping #{dir}."
@@ -21,6 +34,7 @@ module Contestify
         curl_output = system("curl -vv -F upload=Upload -F problem_archive=@bundle.zip --user admin:#{admin_pwd} #{server_url}")
         puts blue "===> Upload done\n"
       end
+
       puts green "\n\n=> All problems have been uploaded"
     end
   end

data/lib/contestify/version.rb

@@ -1,3 +1,3 @@
 module Contestify
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contestify
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000 Z
+date: 2011-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70178592865120 !ruby/object:Gem::Requirement
+  requirement: &70289636072180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70178592865120
+  version_requirements: *70289636072180
 description: Gem to prepare internal programming contests taking problems from the
   COCI contests.
 email:
@@ -60,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1661828008444752765
+      hash: 3991357628571573628
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1661828008444752765
+      hash: 3991357628571573628
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10