Pickaxe 0.4.1 → 0.4.2

data/README.markdown

@@ -4,3 +4,12 @@ Pickaxe provides a simple way to load, solve and rate tests
 (bundle of questions) written in simple text format.
 
 Documentation can be read [here](http://dejw.github.com/pickaxe/).
+
+**Note:** pickaxe was not tested on Windows yet (and it will not work there 
+since `Pickaxe::Shell` executes some terminal related code).
+
+## instalation
+
+    sudo gem install Pickaxe
+
+

data/bin/drill

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'pickaxe'
+require "pickaxe/cli"

data/bin/pickaxe

@@ -1,64 +1,4 @@
 #!/usr/bin/env ruby
-
-require 'optparse'
-
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
-
 require 'pickaxe'
-
-# TODO:
-# 	time limit
-# 	syntax check only
-# 	default -> warns + ignore, options for exception on syntax error ;-)
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = <<END_OF_BANNER
-Usage: 
-  pickaxe path [, path ...]
-  
-Uses given paths (files or directories) to generate a test from *.txt files.
-END_OF_BANNER
-  
-  opts.separator ""
-  opts.on("-e", "--ext [EXTENSION]", "Use files with given EXTENSION (default 'txt')") do |extension|
-    options[:extension] = extension
-  end
-  
-	opts.on("-s", "--sorted", "Do not shuffle questions") do |v|
-		options[:sorted] = true
-	end
-	
-	opts.on("--select [NUMBER]", "Select certain number of questions") do |v|
-		options[:select] = Integer(v)
-	end
-	  
-	opts.on("--full-test", "Checks test after all questions are answered") do |v|
-		options[:full_test] = true
-	end
-	
-	opts.on("--strict", "Quit on syntax error in test file") do |v|
-		options[:strict] = true
-	end
-	
-	opts.on_tail("--syntax-check", "Check syntax only - do not run test") do
-    options[:syntax_check] = true
-  end
-  
-  opts.on_tail("--version", "Show version") do
-    puts "pickaxe version #{Pickaxe::VERSION}"
-    exit
-  end
-  
-	opts.on_tail("-h", "--help", "Show this message") do
-		puts opts
-		exit
-	end
-end.parse!
-
-begin
-	Pickaxe::Main.new(ARGV, options)
-rescue Pickaxe::PickaxeError => e
-	$stderr.puts(("! " + e.message).color(:red))
-	exit(e.status_code)
-end
+require "pickaxe/cli"

data/lib/pickaxe.rb

@@ -5,7 +5,7 @@ require "active_support/all"
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
 module Pickaxe
-	VERSION = "0.4.1"
+	VERSION = "0.4.2"
 	
 	class PickaxeError < StandardError
 		attr_reader :status_code

data/lib/pickaxe/cli.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<END_OF_BANNER
+Usage: 
+  #{$0.split("/").last} path [, path ...]
+  
+Uses given paths (files or directories) to generate a test from *.txt files.
+END_OF_BANNER
+  
+  opts.separator ""
+  opts.on("-e", "--ext [EXTENSION]", "Use files with given EXTENSION (default 'txt')") do |extension|
+    options[:extension] = extension
+  end
+  
+	opts.on("-s", "--sorted", "Do not shuffle questions") do |v|
+		options[:sorted] = true
+	end
+	
+	opts.on("--select [NUMBER]", "Select certain number of questions") do |v|
+		options[:select] = Integer(v)
+	end
+	  
+	opts.on("--full-test", "Checks test after all questions are answered") do |v|
+		options[:full_test] = true
+	end
+	
+	opts.on("--strict", "Quit on syntax error in test file") do |v|
+		options[:strict] = true
+	end
+	
+	opts.on_tail("--syntax-check", "Check syntax only - do not run test") do
+    options[:syntax_check] = true
+  end
+  
+  opts.on_tail("--version", "Show version") do
+    puts "pickaxe version #{Pickaxe::VERSION}"
+    exit
+  end
+  
+	opts.on_tail("-h", "--help", "Show this message") do
+		puts opts
+		exit
+	end
+end.parse!
+
+begin
+	Pickaxe::Main.new(ARGV, options)
+rescue Pickaxe::PickaxeError => e
+	$stderr.puts(("! " + e.message).color(:red))
+	exit(e.status_code)
+end

data/lib/pickaxe/main.rb

@@ -18,6 +18,11 @@ END_OF_TEST
 			@test = Test.new(*paths)
 			return if options[:syntax_check]
 			
+			puts "! Hit Control-D to end test.\n\n"
+			
+			@logger = Logger.new(File.open('answers.log', File::WRONLY|File::TRUNC|File::CREAT))
+			@logger.formatter = lambda { |severity, time, progname, msg| msg.to_s + "\n" }
+			
 			@questions = @test.shuffled_questions
 			@answers = Hash.new([])					
 			@started_at = Time.now			
@@ -74,7 +79,7 @@ END_OF_TEST
 				if Main.options[:full_test] and @question.nil?
 					Main.options[:full_test] = false
 					Main.options[:force_show_answers] = true
-					
+								
 					@current_index = 0
 				else				
 					@current_index += 1
@@ -93,7 +98,7 @@ Available commands (whitespace does not matter):
 END_OF_HELP
 				false
 			else
-				@answers[@question] = line.split(/\s+/).collect(&:strip)
+				@answers[@question] = line.strip.split(/\s+/).collect(&:strip)				
 				puts @question.check?(@answers[@question]) unless Main.options[:full_test]
 				@current_index += 1
 				true
@@ -102,7 +107,11 @@ END_OF_HELP
 		
 		def statistics!
 			@stats = @test.statistics!(@answers)
-			
+						
+			@answers.each do |question, answers|
+				@logger << ("#{question.index}: #{answers.join(" ")}\n")
+			end
+				
 			puts			
 			puts "Time: #{spent?}"
 			puts "All: #{@questions.length}"

data/lib/pickaxe/test.rb

@@ -5,6 +5,7 @@ module Pickaxe
 	class TestSyntaxError < PickaxeError; status_code(2) ; end
 	class MissingAnswers < TestSyntaxError; status_code(2) ; end
 	class BadAnswer < TestSyntaxError; status_code(3) ; end
+	class BadQuestion < TestSyntaxError; status_code(4) ; end
 	class NoCorrectAnswer < TestSyntaxError; status_code(3) ; end
 		
 	class TestLine < String
@@ -34,7 +35,7 @@ module Pickaxe
 		include Enumerable
 		
 		# Ruby-comments and C-comments
-		COMMENTS_RE = /^#.*|^\/\/.*/
+		COMMENTS_RE = /^\s*#.*|^\/\/.*/
 		
 		def initialize(*files)
 			@files = files.collect do |file_or_directory|
@@ -44,7 +45,7 @@ module Pickaxe
 				else
 					Dir.glob("#{file_or_directory}/*.#{Main.options[:extension] || "txt"}")
 				end				
-			end.flatten.collect(&:squeeze)
+			end.flatten.collect { |f| f.squeeze('/') }
 			
 			@questions = []
 			@files.each do |file|
@@ -108,7 +109,9 @@ module Pickaxe
 		end
 	end
 		
-	class Question < Struct.new(:file, :content, :answers)
+	class Question < Struct.new(:file, :index, :content, :answers)
+		RE = /^\s*(\d+)\.?\s*(.+)$/
+		
 		def self.parse(file, answers)
 			content = []
 			until answers.first.nil? or Answer::RE.match(answers.first)
@@ -116,10 +119,22 @@ module Pickaxe
 			end
 			
 			raise MissingAnswers, "#{file}: line #{answers.first.index}: no content (check blank lines nearby)" if content.blank?			
-						
+			raise BadQuestion, "#{file}: line #{content.first.index}: '#{content.first.truncate(20)}' does not look like question" unless m = RE.match(content.first)
+									
 			error_template = "#{file}: line #{content.first.index}: question '#{content.first.truncate(20)}' %s"
 			raise MissingAnswers, (error_template % "has no answers") if answers.blank?
-			Question.new(file, content, answers.collect {|answer| Answer.parse(file, answer) }).tap do |q|
+			
+			answers = answers.inject([]) do |joined, line|
+				if Answer::RE.match(line)
+					joined << [line]
+				else
+					raise BadAnswer, "#{file}: line #{line.index}: '#{line.truncate(20)}' starts with weird characters" unless Answer::LINE_RE.match(line)
+					joined.last << line
+				end
+				joined
+			end
+			
+			Question.new(file, m[1], content, answers.collect {|answer| Answer.parse(file, answer) }).tap do |q|
 				raise NoCorrectAnswer, (error_template % "has no correct answer") if q.correct_answers.blank?
 			end
 		end
@@ -160,10 +175,12 @@ module Pickaxe
 	end
 	
 	class Answer < Struct.new(:content, :index, :correctness)
-		RE = /^\s*(>>)?(\?\?)?\s*\((\w+)\)\s*(.+)$/
-		def self.parse(file, line)
-			raise BadAnswer, "#{file}: line #{line.index}: '#{line.truncate(20)}' does not look like answer" if (m = RE.match(line)).nil?
-			Answer.new(m[m.size-1].strip, m[m.size-2].strip, m[1] == ">>")
+		RE = /^\s*(>>)?\s*(\?\?)?\s*\((\w+)\)\s*(.+)$/
+		LINE_RE = /^\s*(\w+)/
+		
+		def self.parse(file, lines)
+			m = RE.match(lines.shift)
+			Answer.new(m[m.size-1].strip + " " + lines.collect(&:strip).join(" "), m[m.size-2].strip, m[1] == ">>")
 		end
 		
 		def to_s

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Pickaxe
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Dawid Fatyga
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 +01:00
-default_executable: 
+date: 2010-12-01 00:00:00 +01:00
+default_executable: bin/pickaxe
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -73,6 +73,7 @@ description: |
 email: dawid.fatyga@gmail.com
 executables: 
 - pickaxe
+- drill
 extensions: []
 
 extra_rdoc_files: 
@@ -82,10 +83,12 @@ extra_rdoc_files:
 files: 
 - lib/pickaxe.rb
 - lib/pickaxe/test.rb
+- lib/pickaxe/cli.rb
 - lib/pickaxe/color.rb
 - lib/pickaxe/extensions.rb
 - lib/pickaxe/shell.rb
 - lib/pickaxe/main.rb
+- bin/drill
 - bin/pickaxe
 - README.markdown
 - Gemfile