examiner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47e2a6a62cf3492f80d7e9e1e6025c2efea11e49
+  data.tar.gz: 8f06bf636a2da099d282209e5e018069d13684bc
+SHA512:
+  metadata.gz: ad52fa7af0abfadcd4ea88bd9f3c4f9352b72362e2925db404362d79f3416100f67c21de99360f735e73d8275a0e345fc4ac7bed1817effea34772a9d8915391
+  data.tar.gz: 8fa1fd9f36692ed873f77ab693ebcc49855649a6237ab61250b04e828fce137dff06856cc8140882e71b12ade06ce5abebb70391d2bb995524c11e0d8086e4e9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sebastien Saunier
+
+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,42 @@
+[![Build Status](https://travis-ci.org/ssaunier/examiner.svg?branch=master)](https://travis-ci.org/ssaunier/examiner)
+[![Gem Version](https://badge.fury.io/rb/examiner.svg)](http://badge.fury.io/rb/examiner)
+
+# Examiner
+
+Grade a student's exercise solution.
+
+Assumptions:
+
+- The exercise uses [minitest](https://github.com/seattlerb/minitest) to be checkied
+- There is a `Rakefile` in the exercise folder
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'examiner'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You can quickly grade a student's exercise solution with
+the following code.
+
+```ruby
+exercise_directory = "/path/to/student_exercise_with_rakefile"
+
+runner = Examiner::RakeRunner.new
+runner.run exercise_directory
+if runner.success?
+  puts "Results: #{runner.tests - runner.failures}/#{runner.tests}"
+end
+
+# You can display stdout and stderr
+puts runner.stdout_lines.join
+puts runner.stderr_lines.join
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+task :default => :test

data/examiner.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'examiner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "examiner"
+  spec.version       = Examiner::VERSION
+  spec.authors       = ["Sebastien Saunier"]
+  spec.email         = ["seb@saunier.me"]
+  spec.summary       = %q{Grade a student's exercise solution using rake and minitest}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/examiner.rb

@@ -0,0 +1,2 @@
+require "examiner/version"
+require "examiner/rake_runner"

data/lib/examiner/minitest_parser.rb

@@ -0,0 +1,32 @@
+module Examiner
+  class MinitestParser
+    attr_reader :tests, :failures
+
+    def initialize
+      @tests, @assertions, @failures, @errors, @skips = 0, 0, 0, 0, 0
+      @success = false
+    end
+
+    def parse(lines)
+      return unless lines.kind_of? Enumerable
+
+      lines.reverse_each.each do |line|
+        result = PATTERN.match line
+        if result
+          result.names.zip(result.captures.map(&:to_i)).each do |feature, number|
+            instance_variable_set :"@#{feature}", number
+          end
+          @success = true
+          break
+        end
+      end
+    end
+
+    def success?
+      @success
+    end
+
+    private
+      PATTERN = /(?<tests>\d+) (tests|runs), (?<assertions>\d+) assertions, (?<failures>\d+) failures, (?<errors>\d+) errors, (?<skips>\d+) skips/
+  end
+end

data/lib/examiner/rake_runner.rb

@@ -0,0 +1,44 @@
+require 'open3'
+require_relative 'minitest_parser'
+
+module Examiner
+  class RakeRunner
+    attr_reader :stdout_lines, :stderr_lines
+    attr_reader :tests, :failures
+
+    def initialize
+      @tests, @failures = 0, 0
+      @stdout_lines, @stderr_lines = [], []
+      @success = false
+    end
+
+    def run(directory)
+      return unless rakefile?(directory)
+
+      Open3.popen3('rake', chdir: directory) do |_, stdout, stderr, wait_thr|
+        @stdout_lines, @stderr_lines = stdout.readlines, stderr_lines
+        parse_stdout
+      end
+    end
+
+    def success?
+      @success
+    end
+
+    private
+
+      def parse_stdout
+        parser = MinitestParser.new
+        parser.parse @stdout_lines
+        if parser.success?
+          @tests = parser.tests
+          @failures = parser.failures
+          @success = true
+        end
+      end
+
+      def rakefile?(directory)
+        File.exists?(File.join(directory, 'Rakefile'))
+      end
+  end
+end

data/lib/examiner/version.rb

@@ -0,0 +1,3 @@
+module Examiner
+  VERSION = "0.1.0"
+end

data/spec/examiner/minitest_parser_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "examiner/minitest_parser"
+
+module Exmanier
+  describe "MinitestParser" do
+    let(:parser) { Examiner::MinitestParser.new }
+
+    describe "#parse" do
+      it "must not raise if given nil" do
+        parser.parse nil
+        parser.success?.must_equal false
+      end
+
+      it "must not raise if given an empty array" do
+        parser.parse []
+        parser.success?.must_equal false
+      end
+
+      it "must parse correctly a Minitest stdout" do
+        lines = [ "", "4 runs, 3 assertions, 3 failures, 0 errors, 0 skips", "rake aborted!" ]
+        parser.parse lines
+        parser.tests.must_equal 4
+        parser.failures.must_equal 3
+        parser.success?.must_equal true
+      end
+    end
+  end
+end

data/spec/examiner/rake_runner_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+require "examiner/rake_runner"
+
+module Exmanier
+  describe "RakeRunner" do
+    let(:runner) { Examiner::RakeRunner.new }
+
+    it "should handle a folder without Rakefile" do
+      runner.run directory("no_rake_file")
+      runner.success?.must_equal false
+    end
+
+    it "should be successful for 1_test_0_failure use case" do
+      runner.run directory("1_test_0_failure")
+      runner.success?.must_equal true
+      runner.tests.must_equal 1
+      runner.failures.must_equal 0
+      runner.stdout_lines.wont_be_empty
+      runner.stderr_lines.must_be_empty
+    end
+
+    it "should be successful for 2_tests_1_failure use case" do
+      runner.run directory("2_tests_1_failure")
+      runner.success?.must_equal true
+      runner.tests.must_equal 2
+      runner.failures.must_equal 1
+      runner.stdout_lines.wont_be_empty
+      runner.stderr_lines.must_be_empty
+    end
+
+    it "should handle a file with syntax errors" do
+      runner.run directory("syntax_error")
+      runner.success?.must_equal false
+    end
+
+    def directory(name)
+      File.expand_path("../../support/#{name}", __FILE__)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'minitest/pride'

data/spec/support/1_test_0_failure/Rakefile

@@ -0,0 +1,12 @@
+def plus_one(i)
+  i + 1
+end
+
+task :default do
+  require "minitest/autorun"
+  describe "#plus_one" do
+    it "should return 2 when passed 1" do
+      plus_one(1).must_equal 2
+    end
+  end
+end

data/spec/support/2_tests_1_failure/Rakefile

@@ -0,0 +1,21 @@
+def plus_one(i)
+  i + 1
+end
+
+def minus_one(i)
+  i  # Boffus implementation!
+end
+
+task :default do
+  require "minitest/autorun"
+  describe "#plus_one" do
+    it "should return 2 when passed 1" do
+      plus_one(1).must_equal 2
+    end
+  end
+  describe "#minus_one" do
+    it "should return 2 when passed 3" do
+      minus_one(3).must_equal 2
+    end
+  end
+end

data/spec/support/syntax_error/Rakefile

@@ -0,0 +1,14 @@
+def plus_one(i)
+  i + 1
+end
+
+def foo  # Deliberate syntax error
+
+task :default do
+  require "minitest/autorun"
+  describe "#plus_one" do
+    it "should return 2 when passed 1" do
+      plus_one(1).must_equal 2
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: examiner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastien Saunier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Grade a student's exercise solution using rake and minitest
+email:
+- seb@saunier.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examiner.gemspec
+- lib/examiner.rb
+- lib/examiner/minitest_parser.rb
+- lib/examiner/rake_runner.rb
+- lib/examiner/version.rb
+- spec/examiner/minitest_parser_spec.rb
+- spec/examiner/rake_runner_spec.rb
+- spec/spec_helper.rb
+- spec/support/1_test_0_failure/Rakefile
+- spec/support/2_tests_1_failure/Rakefile
+- spec/support/syntax_error/Rakefile
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Grade a student's exercise solution using rake and minitest
+test_files:
+- spec/examiner/minitest_parser_spec.rb
+- spec/examiner/rake_runner_spec.rb
+- spec/spec_helper.rb
+- spec/support/1_test_0_failure/Rakefile
+- spec/support/2_tests_1_failure/Rakefile
+- spec/support/syntax_error/Rakefile