Pickaxe 0.3.2 → 0.4.1

data/Gemfile

@@ -1,6 +1,6 @@
 # A Gemfile for Pickaxe
 source "http://rubygems.org"
 
-gem 'activesupport', :require => 'active_support/all'
-gem 'i18n'
+gem 'activesupport', "3.0.1", :require => 'active_support/all'
+gem 'i18n', "0.4.2"
 

data/Gemfile.lock

@@ -8,5 +8,5 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
-  i18n
+  activesupport (= 3.0.1)
+  i18n (= 0.4.2)

data/bin/pickaxe

@@ -15,7 +15,6 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = <<END_OF_BANNER
 Usage: 
-  pick path [, path ...]
   pickaxe path [, path ...]
   
 Uses given paths (files or directories) to generate a test from *.txt files.
@@ -38,6 +37,14 @@ END_OF_BANNER
 		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

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.3.2"
+	VERSION = "0.4.1"
 	
 	class PickaxeError < StandardError
 		attr_reader :status_code

data/lib/pickaxe/main.rb

@@ -14,9 +14,10 @@ END_OF_TEST
 		def initialize(paths, options = {})
 			raise NoTests, "no tests to run" if paths.empty?
 			
-			Main.options = options
-			
+			Main.options = options			
 			@test = Test.new(*paths)
+			return if options[:syntax_check]
+			
 			@questions = @test.shuffled_questions
 			@answers = Hash.new([])					
 			@started_at = Time.now			
@@ -126,7 +127,7 @@ END_OF_HELP
 	protected
 		def stat(name, color)
 			value = @stats[name.to_s.downcase.to_sym]
-			puts "#{name.to_s.capitalize}: #{value} (#{value/@questions.length.to_f * 100}%%)".color(color)
+			puts format("#{name.to_s.capitalize}: #{value} (%g%%)", value/@questions.length.to_f * 100).color(color)
 		end
 	end
 end

data/lib/pickaxe/test.rb

@@ -1,12 +1,23 @@
 module Pickaxe
 
 	class PathError < PickaxeError; status_code(1) ; end
-	class MissingAnswers < PickaxeError; status_code(2) ; end
-	class BadAnswer < PickaxeError; status_code(3) ; end
+	
+	class TestSyntaxError < PickaxeError; status_code(2) ; end
+	class MissingAnswers < TestSyntaxError; status_code(2) ; end
+	class BadAnswer < TestSyntaxError; status_code(3) ; end
+	class NoCorrectAnswer < TestSyntaxError; status_code(3) ; end
+		
+	class TestLine < String
+		attr_accessor :index
+		def initialize(itself, index)
+			super(itself)
+			self.index = index + 1
+		end
+	end
 		
 	#
 	# Test is a file in which questions are separated by a blank line.
-	# Each question has content (first line), and answers remaining lines.
+	# Each question has content (lines until answer), and answers.
 	# Answers are listed one per line which starts with optional >> (means answer
 	# is correct), followed by index in parenthesis (index) and followed by text.
 	#
@@ -33,15 +44,26 @@ module Pickaxe
 				else
 					Dir.glob("#{file_or_directory}/*.#{Main.options[:extension] || "txt"}")
 				end				
-			end.flatten
+			end.flatten.collect(&:squeeze)
 			
 			@questions = []
 			@files.each do |file|
 				File.open(file) do |f|
-					lines = f.readlines.collect(&:strip)
+					lines = f.readlines.collect(&:strip).enum_with_index.collect do |line, index|
+						TestLine.new(line, index)
+					end
+					
 					lines = lines.reject {|line| line =~ COMMENTS_RE }
 					lines.split("").reject(&:blank?).each do |question|
-						@questions.push(Question.parse(file, question))
+						begin
+							@questions.push(Question.parse(file, question))
+						rescue TestSyntaxError => e
+							if Main.options[:strict]						
+								raise e 
+							else
+								$stderr.puts(e.message.color(:red))
+							end
+						end					
 					end
 				end
 			end
@@ -88,13 +110,23 @@ module Pickaxe
 		
 	class Question < Struct.new(:file, :content, :answers)
 		def self.parse(file, answers)
-			content = answers.shift
-			raise MissingAnswers, "question '#{content.truncate(20)}' has no answers'" if answers.blank?
-			Question.new(file, content, answers.collect {|answer| Answer.parse(answer) })
+			content = []
+			until answers.first.nil? or Answer::RE.match(answers.first)
+				content << answers.shift
+			end
+			
+			raise MissingAnswers, "#{file}: line #{answers.first.index}: no content (check blank lines nearby)" if content.blank?			
+						
+			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|
+				raise NoCorrectAnswer, (error_template % "has no correct answer") if q.correct_answers.blank?
+			end
 		end
 		
 		def answered(indices)
-			"#{self.content.word_wrap}\n\n" + self.answers.collect do |answer|
+			content = self.content.collect(&:word_wrap).join("\n")
+			"#{content}\n\n" + self.answers.collect do |answer|
 				selected = indices.include?(answer.index)
 				line = (selected ? ">> " : "   ") + answer.to_s
 				
@@ -129,8 +161,8 @@ module Pickaxe
 	
 	class Answer < Struct.new(:content, :index, :correctness)
 		RE = /^\s*(>>)?(\?\?)?\s*\((\w+)\)\s*(.+)$/
-		def self.parse(line)
-			raise BadAnswer, "'#{line.truncate(20)}' does not look like answer" if (m = RE.match(line)).nil?
+		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] == ">>")
 		end
 		

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Pickaxe
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Dawid Fatyga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-20 00:00:00 +01:00
+date: 2010-11-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,12 +38,14 @@ dependencies:
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
+        - 3
         - 0
-        version: "0"
+        - 1
+        version: 3.0.1
   requirement: *id002
   name: activesupport
   prerelease: false
@@ -52,12 +54,14 @@ dependencies:
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 11
         segments: 
         - 0
-        version: "0"
+        - 4
+        - 2
+        version: 0.4.2
   requirement: *id003
   name: i18n
   prerelease: false