contestify 1.2.1 → 2.0.0

data/README.md

@@ -1,28 +1,46 @@
 Contestify
-====
+=====
 
-This is a simple ruby gem to automate the process of setting up a programming contest from a [COCI](http://www.hsin.hr/coci/) problem set using [DOMJudge](http://domjudge.sourceforge.net/).
+This is a simple ruby gem to automate the process of setting up a programming contest with [DOMJudge](http://domjudge.sourceforge.net/). You can choose from several judges and the problems will be uploaded without too much work, because, let's be honest, DOMJudge is a great online judge, but it sucks at UI.
 
-Usage
+Install
 ---
 
+Installing Contestify couldn't be easier. Just type
+
+  gem install contestify
+
+Then, you can run `contestify check` to check the OS dependencies. Most Unix systems _should_ have the dependencies installed.
+
+Usage & Help
+---
+
+You can run the `contestify` command with no arguments to see the available judges. Each available judge will ask for different arguments. If you need help with a specific judge, you can type `contestify help <judge>` and it will give you some help about it.
+
 ```
-contestify coci_problems_url judge_upload_url judge_password
+  contestify help coci
 ```
 
-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.
+Provide the requested data for each judge and it should run smoothly. It is important to notice that Contestify **DOES NOT** store **ANY** data. It asks for passwords just to be able to upload (and sometimes fetch) the problems. If you still doubt it, you can check the code for yourself.
+
+
+Notes
+---
+
+* Contestify **will not** create a new contest. Just add problems to the current one. So you'll need to have an active contest to run this.
 
-It is assumed that the admin username is `admin`.
+* It is assumed that the **Admin username** is `admin`.
 
-### Example
+Fast Example
+----
 
 ```
-contestify http://hsin.hr/coci/contest1_testdata.zip http://juez.factorcomun.org/jury/problem.php p4ssw0rd
+contestify coci http://hsin.hr/coci/contest1_testdata.zip http://juez.factorcomun.org/jury/problem.php p4ssw0rd
 ```
 
 Contributions
 ---
 
-If you find any bug or have any addition, please let us know. You can use the [issue tracker](https://github.com/nhocki/contestify/issues) for that. We would like to expand this script and be able to use any other problem (not just the ones from COCI).
+If you find any bug or have any addition, please let us know. You can use the [issue tracker](https://github.com/nhocki/contestify/issues) for that.
 
-This script was started by [Andrés Mejía](https://github.com/andmej). I added the config file option and gemified it.
+We would also love to have more and more judges, so if you want to write one, just submit a pull request with it.

data/bin/contestify

@@ -2,12 +2,8 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'contestify'
 
-problems_url    = ARGV[0]
-judge_url       = ARGV[1]
-judge_password  = ARGV[2]
-
 begin
-  Contestify::Contest.new(problems_url, judge_url, judge_password).setup!
+  Contestify::Contest.start
 rescue Exception => e
   puts e.message
 end

data/contestify.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "contestify"
   gem.require_paths = ["lib"]
   gem.version       = Contestify::VERSION
-  
+
+  gem.add_dependency "thor", "~> 0.14.6"
   gem.add_development_dependency "rake", "~> 0.9.2"
 end

data/lib/contestify/contest.rb

@@ -1,53 +1,18 @@
 module Contestify
-  class Contest
+  class Contest < Thor
     include Contestify::Util
 
-    attr_accessor :problems_url, :judge_url, :judge_password, :base_dir
-
-    def initialize(problems_url, judge_url, judge_password)
-      @problems_url, @judge_url, @judge_password = problems_url, judge_url, judge_password
-
-      if [@problems_url, @judge_url, @judge_password].any? {|attribute| attribute.nil? or attribute.empty?}
-        raise Exception.new(Contestify::HELP_MESSAGE)
-      end
+    desc "coci PROBLEMS_URL JUDGE_UPLOAD_URL JUDGE_PASSWORD", "Setups a contest based on a COCI problemset"
+    def coci(problems_url, judge_url, judge_password)
+      contest = Contestify::Judge::Coci.new problems_url
+      Contestify::Uploader.upload!(judge_url, judge_password, contest.problems_paths)
+      clean_dir! contest.working_root_path
     end
 
-    def setup!
+    desc "check", "Checks that the user has the required OS software installed"
+    def check
       check_dependencies
-      get_problems
-      unzip_problems
-      @base_dir = Dir.pwd
-      problems_path = Contestify::Configuration.configure!(@base_dir)
-      Contestify::Uploader.upload!(@judge_url, @judge_password, problems_path)
-      clean_dir!
-    end
-
-    private ######################################################################## PRIVATE
-
-    def clean_dir!
-      puts red "Deleting created files & folders (#{@base_dir})"
-      FileUtils.rm_rf @base_dir
-    end
-
-    def check_dependencies
-      system?(:zip)       and
-      system?(:curl)      and
-      system?(:unzip)     and
-      system?(:dos2unix)
-    end
-
-    def get_problems
-      FileUtils.mkdir_p File.join(Dir.pwd, "contestify")
-      Dir.chdir File.join(Dir.pwd, "contestify")
-      puts green "=> Fetching problems from #{@problems_url}"
-      curl_output = `curl #{@problems_url} > #{File.join(Dir.pwd, "problems.zip")}`
-      raise Exception.new(red Contestify::CURL_PROBLEM) unless $?.success?
-    end
-
-    def unzip_problems
-      puts green "=> Unzipping problems"
-      unzip_output = `unzip #{File.join(Dir.pwd, "problems.zip")}`
-      raise Exception.new(red Contestify::UNZIP_PROBLEM) unless $?.success?
+      puts green "Everything looks ok. You may now use Contestify."
     end
   end
 end

data/lib/contestify/judges/coci/README.md

@@ -0,0 +1,14 @@
+Contestify::Coci
+===
+
+This strategy will upload the problems from a given URL to the server. Usage:
+
+    contestify coci problem_url judge_upload_url judge_admin_password
+
+Note that the Judge URL is the actual **upload** URL, which is normally `http://you-dom-judge.com/jury/problem.php`.
+
+Here's an example of usage with _real_ data:
+
+    contestify http://hsin.hr/coci/contest1_testdata.zip http://domjudge.factorcomun.org/jury/problem.php p4ssw0rd
+
+This will get the .zip file from the `http://hsin.hr/coci/contest1_testdata.zip` and add the problems to the DOM Judge on the server. 

data/lib/contestify/judges/coci/coci.rb

@@ -0,0 +1,35 @@
+require 'contestify/judges/coci/configuration'
+
+module Contestify
+  module Judge
+    class Coci
+      attr_accessor :problems_url, :working_root_path, :problems_paths
+
+      def initialize(problems_url)
+        @problems_url = problems_url
+        get_problems
+        unzip_problems
+        @working_root_path = Dir.pwd
+        @problems_paths = Contestify::Coci::Configuration.configure!(@working_root_path)
+      end
+
+      private ################################################ PRIVATE
+
+      def get_problems
+        working_path = File.join(Dir.pwd, "contestify")
+        FileUtils.mkdir_p working_path
+        Dir.chdir working_path
+        puts green "=> Fetching problems from #{@problems_url}"
+        curl_output = `curl #{@problems_url} > #{File.join(Dir.pwd, "problems.zip")}`
+        raise Exception.new(red Contestify::CURL_PROBLEM) unless $?.success?
+      end
+
+      def unzip_problems
+        puts green "=> Unzipping problems"
+        unzip_output = `unzip #{File.join(Dir.pwd, "problems.zip")}`
+        raise Exception.new(red Contestify::UNZIP_PROBLEM) unless $?.success?
+      end
+
+    end
+  end
+end

data/lib/contestify/judges/coci/configuration.rb

@@ -0,0 +1,97 @@
+module Contestify
+  module Coci
+    # <tt>Coci::Configuration</tt> holds all the logic to configure a COCI based
+    # contest. This class **must** implement the `self.configure!` method.
+    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 (#{base_folder})"
+        problem_index = 0
+        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}"
+          rename_data_files
+          add_problem_config(dirid, problem_index)
+          problem_index += 1
+          puts green "==> All the work for #{dirid.upcase} is done"
+          # Return the absolute path for this problem
+          Dir.pwd
+        end
+      end
+
+      #########################################################################
+      private #################################################################
+
+      # <tt>Coci::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|
+          parts     = f.split(".")
+          new_name  = [parts[0], parts[2], parts[1]].join(".")
+          File.rename f, new_name
+
+          f.gsub!(".in", ".out")
+          parts = f.split(".")
+          new_name = [parts[0], parts[2], parts[1]].join(".")
+          File.rename f, new_name
+        end
+      end
+
+
+      # <tt>Coci::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
+        probid = #{probid}
+        name = #{probid}
+        allow_submit = true
+        color = #{Contestify::PROBLEM_COLORS[problem_index]}
+        timelimit = 1
+        TEXT
+        File.open(File.join(Dir.pwd, "domjudge-problem.ini"), 'w') {|f| f.write(file_content) }
+      end
+    end
+  end
+end

data/lib/contestify/judges.rb

@@ -0,0 +1 @@
+require 'contestify/judges/coci/coci'

data/lib/contestify/util.rb

@@ -4,5 +4,17 @@ module Contestify
       `which #{command.to_s}`
       raise Exception.new(red "`#{command}` is not installed. Please install it first") unless $?.success?
     end
+
+    def clean_dir!(directory)
+      puts red "Deleting created files & folders (#{directory})"
+      FileUtils.rm_rf directory
+    end
+
+    def check_dependencies
+      system?(:zip)       and
+      system?(:curl)      and
+      system?(:unzip)     and
+      system?(:dos2unix)
+    end
   end
 end

data/lib/contestify/version.rb

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

data/lib/contestify.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'thor'
 require "contestify/version"
 require "contestify/messages"
 require "contestify/colorize"
@@ -6,5 +7,6 @@ require "contestify/util"
 require "contestify/contest"
 require "contestify/configuration"
 require "contestify/uploader"
+require "contestify/judges"
 
 include Contestify::Colorize

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contestify
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-08 00:00:00.000000000 Z
+date: 2011-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70364193982720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70364193982720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70289636072180 !ruby/object:Gem::Requirement
+  requirement: &70364193981160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +32,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70289636072180
+  version_requirements: *70364193981160
 description: Gem to prepare internal programming contests taking problems from the
   COCI contests.
 email:
@@ -40,8 +51,11 @@ files:
 - contestify.gemspec
 - lib/contestify.rb
 - lib/contestify/colorize.rb
-- lib/contestify/configuration.rb
 - lib/contestify/contest.rb
+- lib/contestify/judges.rb
+- lib/contestify/judges/coci/README.md
+- lib/contestify/judges/coci/coci.rb
+- lib/contestify/judges/coci/configuration.rb
 - lib/contestify/messages.rb
 - lib/contestify/uploader.rb
 - lib/contestify/util.rb
@@ -60,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3991357628571573628
+      hash: -3999630116395939116
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -69,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3991357628571573628
+      hash: -3999630116395939116
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10

data/lib/contestify/configuration.rb

@@ -1,94 +0,0 @@
-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) }.map do |dir|
-        Dir.chdir File.join(base_folder, dir)
-        dirid = Dir.pwd.split('/').last[0...8]
-        puts green "==> #{dirid.upcase}"
-        rename_data_files
-        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|
-        # puts red "    Renaming #{f}..."
-        parts     = f.split(".")
-        new_name  = [parts[0], parts[2], parts[1]].join(".")
-        # puts blue "    " + new_name
-        File.rename f, new_name
-
-        f.gsub!(".in", ".out")
-        # puts red "    Renaming #{f}..."
-        parts = f.split(".")
-        new_name = [parts[0], parts[2], parts[1]].join(".")
-        # puts blue "    " + new_name
-        File.rename f, new_name
-      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
-      probid = #{probid}
-      name = #{probid}
-      allow_submit = true
-      color = #{Contestify::PROBLEM_COLORS[problem_index]}
-      timelimit = 1
-      TEXT
-      File.open(File.join(Dir.pwd, "domjudge-problem.ini"), 'w') {|f| f.write(file_content) }
-    end
-  end
-end