clicoder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 191b32a24645db71142a867c9d5663ccc529657e
+  data.tar.gz: 7a2427b24acb997930e00486f68971e8f4fc3616
+SHA512:
+  metadata.gz: 1f4a2a6a5910de3a7148dc0399cefa73d62590b006a4acc09a391ebf67e22975521d6c1e91f85ff144d02c87ac289471cf7cb6e8f7fcfa9ba3e791a36d3d4a74
+  data.tar.gz: 7bbd322adfafb27d7c8febffa834aa5f7d5bde772054831b8261e24dc415c19bf47a16b31dc4e56ab91b487ecf790d5719034d83db2fed500a3e498ca2cb06ca

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clicoder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Genki Sugimoto
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,202 @@
+# CLI Coder
+
+Command Line Interface for Online Programming Contests.
+
+# Why
+
+Programming contests are fun.
+However, there are chores which are not fun, like
+
+* copy a sample input and run a program against it
+* compare it with a sample answer
+* submit (copy & paste or select a file)
+
+This tool automate these chores so that we can enjoy only really fun part of programming contests (which is, thinking and implementing).
+
+# Demo Video
+
+Here is a demo solving a problem from AOJ (links to youtube):
+
+[![CLI Coder demo](http://img.youtube.com/vi/sVH5EIOxDf8/0.jpg)](http://www.youtube.com/watch?v=sVH5EIOxDf8)
+
+# Installation
+
+    $ gem install clicoder
+
+# Preparation
+
+## ~/.clicoder.d/config.yml (required)
+
+It contains
+
+* configurations of template files
+* configurations for various programming contest sites.
+
+Example:
+
+```yaml
+---
+default:
+    template: template.cpp # template file. relative to this file
+    makefile: Makefile # Makefile used by CLI Coder. relative to this file
+aoj:
+    template: aoj_template.cpp # template only used for site 'aoj'
+    user_id: Glen_S
+    password: PASSWORD
+atcoder:
+    user_id: Glen_S
+    password: PASSWORD
+```
+
+## template.cpp etc. (recommended)
+
+It is recommended to put your template file under `~/.clicoder.d`.
+It will be copied into working directories as `main.*` each time you start solving new problems.
+
+If you don't use templates, make sure you write your solutions in files named `main.*`.
+
+## Makefile (required)
+
+It is recommended to put your `Makefile` under `~/.clicoder.d`.
+
+CLI Coder uses Makefile to build and execute your program.
+
+## "build" rule
+
+It should build your program.
+
+Example:
+
+    build:
+        g++ -g main.cpp -o a.out
+
+## "execute" rule
+
+It has to run your program with redirection from "in.txt" and redirection to "out.txt".
+
+Example:
+
+    execute:
+        ./a.out < in.txt > out.txt
+
+# Usage
+
+```sh
+Commands:
+  clicoder add_test        # Add new test case
+  clicoder all             # build, execute, and judge
+  clicoder browse          # Open problem page with the browser
+  clicoder build           # Build your program using `make build`
+  clicoder download        # Download description, inputs and outputs
+  clicoder execute         # Execute your program using `make execute`
+  clicoder help [COMMAND]  # Describe available commands or one specific command
+  clicoder judge           # Judge your outputs
+  clicoder new <command>   # start a new problem
+  clicoder submit          # Submit your program
+```
+
+## Sites Available
+
+* [AOJ](http://judge.u-aizu.ac.jp/onlinejudge/)
+* [AtCoder](http://atcoder.jp/)
+
+```sh
+clicoder new aoj PROBLEM_NUMBER                 # Prepare directory to deal with new problem from AOJ
+clicoder new atcoder CONTEST_ID PROBLEM_NUMBER  # Prepare directory to deal with new problem from AtCoder
+```
+
+### AOJ
+
+PROBLEM_NUMBER is shown in problem URL like this:
+
+<pre>http://judge.u-aizu.ac.jp/onlinejudge/description.jsp?id=<strong>0001</strong></pre>
+
+### AtCoder
+
+CONTEST_ID is shown in contest URL like this:
+
+<pre>http://<strong>arc001</strong>.contest.atcoder.jp/</pre>
+
+PROBLEM_NUMBER is a number starting from 1, or it can be found in problem URL like this:
+
+<pre>http://arc001.contest.atcoder.jp/tasks/arc001_<strong>1</strong></pre>
+
+# Tips
+
+I recommend you to use this shell function for AOJ:
+
+```sh
+function aoj() {
+    clicoder new aoj $1
+    dir=$(printf "%04d" $1)
+    cd $dir
+}
+```
+
+# Contributing
+
+**Please send your pull requests to "develop" branch.**
+Thank you for your contributions.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Add a Site
+
+It's easy to add new sites.
+
+1. Implement new site class
+2. Add it to the factory method (`new_with_config`) in `lib/clicoder/site_base.rb`
+3. Add new command (`clicoder new new_site ARGS`) in `lib/clicoder/cli.rb`
+
+Site classes resides in `lib/clicoder/sites` directory.
+See existing sites for examples.
+
+Basically, you need to implement these methods:
+
+### initialize
+
+Initialize a site instance (i.e. a problem) and set local configurations (like problem id).
+
+### submit
+
+Submit your code.
+
+### open_submission
+
+Open submission status page. This will be called automatically after successful submissions.
+
+### login
+
+Sometimes you need to login to see problems or to submit your solutions.
+This method has to log in and execute given block under logged-in condition.
+
+### site_name
+
+Returns site name.
+
+### problem_url
+
+Returns problem url.
+
+### description_xpath
+
+Returns xpath which indicates where the problem description is.
+Used to download problem description.
+
+### inputs_xpath
+
+Returns xpath which indicates where the sample inputs are.
+Used to download sample inputs.
+
+### outputs_xpath
+
+Returns xpath which indicates where the sample outputs are.
+Used to download sample outputs.
+
+### working_directory
+
+Returns a directory name it should create with `clicoder new` command.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/clicoder

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'clicoder/cli'
+Clicoder::ArubaCLI.new(ARGV.dup).execute!

data/clicoder.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clicoder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clicoder"
+  spec.version       = Clicoder::VERSION
+  spec.authors       = ["Genki Sugimoto"]
+  spec.email         = ["cfhoyuk.reccos.nelg@gmail.com"]
+  spec.description   = %q{Make it easy to deal with online programming contests from the command line}
+  spec.summary       = %q{CLI interface to online programming contests}
+  spec.homepage      = "https://github.com/Genki-S/clicoder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "thor"
+  spec.add_dependency "abstract_method"
+  spec.add_dependency "launchy"
+  spec.add_dependency "reverse_markdown"
+  spec.add_dependency "mechanize"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "pry"
+end

data/features/sample_site.feature

@@ -0,0 +1,79 @@
+Feature: SampleSite
+	In order to make it easy to deal with programming contests
+	As a CLI
+	I want to provide commands to perform common tasks
+
+	Scenario: Start a new problem
+		When I run `clicoder new sample_site`
+		Then the output should contain "created directory working_directory"
+
+	Scenario: Build a program
+		Given in a problem directory
+		When I run `clicoder build`
+		Then an executable should be generated
+
+	Scenario: Run a program
+		Given in a problem directory
+		When I run `clicoder build`
+		And I run `clicoder execute`
+		Then my answer should be output in my outputs directory
+
+	Scenario: Judge without outputs
+		Given in a problem directory
+		When I run `clicoder judge`
+		Then the output should contain "Wrong Answer"
+
+	Scenario: Judge wrong outputs
+		Given in a problem directory
+		When I run `clicoder build`
+		And I run `clicoder execute`
+		Given outputs are wrong
+		When I run `clicoder judge`
+		Then the output should contain "Wrong Answer"
+
+	Scenario: Judge correct outputs
+		Given in a problem directory
+		When I run `clicoder build`
+		And I run `clicoder execute`
+		Given outputs are correct
+		When I run `clicoder judge`
+		Then the output should contain "Correct Answer"
+
+	Scenario: Judge outputs within allowed absolute error
+		Given in a problem directory
+		And the answer differs in second decimal place
+		When I run `clicoder judge`
+		Then the output should contain "Wrong Answer"
+
+	Scenario: Judge outputs within allowed absolute error
+		Given in a problem directory
+		And the answer differs in second decimal place
+		When I run `clicoder judge -d 2`
+		Then the output should contain "Wrong Answer"
+
+	Scenario: Judge outputs within allowed absolute error
+		Given in a problem directory
+		And the answer differs in second decimal place
+		When I run `clicoder judge -d 1`
+		Then the output should contain "Correct Answer"
+
+	Scenario: Submit with user_id and password
+		Given SampleSite submission url is stubbed with webmock
+		And in a problem directory
+		And Launchy.open is stubbed
+		When I run `clicoder submit`
+		Then the output should contain "Submission Succeeded."
+		And the submission status should be opened
+
+	Scenario: Submit without user_id and password
+		Given SampleSite submission url is stubbed with webmock
+		Given in a problem directory
+		Given I don't have user_id and password
+		When I run `clicoder submit`
+		Then the output should contain "Submission Failed."
+
+	Scenario: Open problem page with browser
+		Given in a problem directory
+		And Launchy.open is stubbed
+		When I run `clicoder browse`
+		Then the problem page should be opened

data/features/step_definitions/sample_site_steps.rb

@@ -0,0 +1,80 @@
+require 'clicoder'
+require 'clicoder/sites/sample_site'
+require 'launchy'
+
+Given /^SampleSite submission url is stubbed with webmock/ do
+  stub_request(:post, "http://samplesite.com/submit").
+    with(:body => {"password"=>"sample_password", "user_id"=>"sample_user_id"},
+         :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'samplesite.com', 'User-Agent'=>'Ruby'}).
+    to_return(:status => 200, :body => "Success", :headers => {})
+  stub_request(:post, "http://samplesite.com/submit").
+    with(:body => {"password"=>"", "user_id"=>""},
+         :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'Host'=>'samplesite.com', 'User-Agent'=>'Ruby'}).
+    to_return(:status => 200, :body => "Failure", :headers => {})
+end
+
+Given /^I don't have user_id and password/ do
+  FileUtils.rm("#{ENV['HOME']}/.clicoder.d/config.yml")
+end
+
+Given /^in a problem directory/ do
+  sample_site = Clicoder::SampleSite.new
+  sample_site.start
+  Dir.chdir(sample_site.working_directory)
+end
+
+Given /^there is no output/ do
+  FileUtils.rm(Dir.glob("#{Clicoder::MY_OUTPUTS_DIRNAME}/*.txt"))
+end
+
+Given /^outputs are wrong/ do
+  # it's wrong already
+end
+
+Given /^outputs are correct/ do
+  FileUtils.cp(Dir.glob("#{Clicoder::OUTPUTS_DIRNAME}/*.txt"), Clicoder::MY_OUTPUTS_DIRNAME)
+end
+
+Given /^the answer differs in second decimal place/ do
+  FileUtils.rm(Dir.glob("#{Clicoder::OUTPUTS_DIRNAME}/*"))
+  FileUtils.rm(Dir.glob("#{Clicoder::MY_OUTPUTS_DIRNAME}/*"))
+  File.open("#{Clicoder::OUTPUTS_DIRNAME}/0.txt", 'w') do |f|
+    f.write(<<-EOS)
+    0.11 0.11
+    0.13 0.13
+    EOS
+  end
+  File.open("#{Clicoder::MY_OUTPUTS_DIRNAME}/0.txt", 'w') do |f|
+    f.write(<<-EOS)
+    0.12 0.12
+    0.12 0.12
+    EOS
+  end
+end
+
+Given /^Launchy.open is stubbed/ do
+  @launchy_open_count = 0
+  Launchy.stub(:open) do |url|
+    @launchy_open_count += 1
+    puts "opening #{url}"
+  end
+end
+
+Then /^an executable should be generated/ do
+  expect(File.exists?('a.out')).to be_true
+end
+
+Then /^my answer should be output in my outputs directory/ do
+  Dir.glob("#{Clicoder::INPUTS_DIRNAME}/*.txt") do |file|
+    basename = File.basename(file)
+    expect(File.exists?("#{Clicoder::MY_OUTPUTS_DIRNAME}/#{basename}")).to be_true
+  end
+end
+
+Then /^the submission status should be opened/ do
+  @launchy_open_count.should eq(1)
+end
+
+Then /^the problem page should be opened/ do
+  @launchy_open_count.should eq(1)
+end

data/features/support/setup.rb

@@ -0,0 +1,26 @@
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'cucumber/rspec/doubles'
+
+require 'clicoder/cli'
+
+ENV['PATH'] = "#{Dir.pwd}/bin:#{ENV['PATH']}"
+
+Aruba::InProcess.main_class = Clicoder::ArubaCLI
+Aruba.process = Aruba::InProcess
+
+Before do
+  # Don't use tmp/aruba dir
+  @dirs = ['.']
+end
+
+Around do |scenario, block|
+  Dir.mktmpdir do |dir|
+    Dir.chdir(dir) do
+      ENV['HOME'] = Dir.pwd
+      FileUtils.cp_r("#{FIXTURE_DIR}/clicoder.d", '.clicoder.d')
+
+      block.call
+    end
+  end
+end

data/features/support/webmock.rb

@@ -0,0 +1,5 @@
+require 'webmock/cucumber'
+
+# TODO: DRY. see spec/spec_helper.rb
+GEM_ROOT = Gem::Specification.find_by_name('clicoder').gem_dir
+FIXTURE_DIR = GEM_ROOT + '/fixtures'

data/fixtures/clicoder.d/Makefile

@@ -0,0 +1,6 @@
+build:
+	g++ main.cpp
+
+execute:
+	./a.out < in.txt > out.txt
+

data/fixtures/clicoder.d/config.yml

@@ -0,0 +1,9 @@
+---
+default:
+    template: template.cpp
+    makefile: Makefile
+sample_site:
+    user_id: sample_user_id
+    password: sample_password
+    template: sample_template.cpp
+    makefile: sample_Makefile

data/fixtures/clicoder.d/template.cpp

@@ -0,0 +1,6 @@
+#include <iostream>
+
+int main()
+{
+	printf("Hello, World.\n");
+}

data/fixtures/sample_problem.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<title>Sample Problem</title>
+</head>
+<body>
+	<div id="description">
+		<h1>Sample Problem</h1>
+		<p>
+			Double the numbers.
+		</p>
+	</div>
+	<div id="inputs">
+		<pre>10</pre>
+		<pre>0.01</pre>
+	</div>
+	<div id="outputs">
+		<pre>20</pre>
+		<pre>0.02</pre>
+	</div>
+</body>
+</html>