Pickaxe 0.5.1 → 0.5.2

data/lib/pickaxe.rb

@@ -5,19 +5,15 @@ require "active_support/all"
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
 module Pickaxe
-	VERSION = "0.5.1"
+	VERSION = "0.5.2"
 	
-	class PickaxeError < StandardError
-		attr_reader :status_code
-    def self.status_code(code = nil)
-      define_method(:status_code) { code }
-    end
-  end
+	class PickaxeError < StandardError; end
   
   autoload :Shell, 'pickaxe/shell'
   autoload :Color, 'pickaxe/color'
 	autoload :Main, 'pickaxe/main'
 	autoload :Test, 'pickaxe/test'
+	autoload :Errors, 'pickaxe/errors'
 end
 
 require 'pickaxe/extensions'

data/lib/pickaxe/cli.rb

@@ -1,7 +1,7 @@
 require 'optparse'
 
 options = { :extension => "txt" }
-OptionParser.new do |opts|
+parser = OptionParser.new do |opts|
   opts.banner = <<END_OF_BANNER
 Usage: 
   #{$0.split("/").last} path [, path ...]
@@ -19,6 +19,10 @@ END_OF_BANNER
 		options[:sorted] = true
 	end
 	
+	opts.on("--sorted-answers", "Do not shuffle answers") do |v|
+		options[:sorted_answers] = true
+	end	
+	
 	opts.on("--select [NUMBER]", "Select certain number of questions") do |v|
 		options[:select] = Integer(v)
 	end
@@ -35,6 +39,10 @@ END_OF_BANNER
     options[:syntax_check] = true
   end
   
+	opts.on("--no-color", "Turn off colors") do |v|
+		options[:no_colors] = true
+	end	
+  
   opts.on_tail("--version", "Show version") do
     puts "pickaxe version #{Pickaxe::VERSION}"
     exit
@@ -44,11 +52,11 @@ END_OF_BANNER
 		puts opts
 		exit
 	end
-end.parse!
+end
 
 begin
+	parser.parse!
 	Pickaxe::Main.new(ARGV, options)
-rescue Pickaxe::PickaxeError => e
-	$stderr.puts(("! " + e.message).color(:red))
-	exit(e.status_code)
+rescue Pickaxe::PickaxeError, OptionParser::InvalidOption => e
+	$stderr.puts(("! " + e.to_s).color(:red))
 end

data/lib/pickaxe/color.rb

@@ -47,9 +47,13 @@ module Pickaxe
 		# of the returned String.
 		#
 		def self.set_color(string, color, bold=false)
-		  color = self.const_get(color.to_s.upcase) if color.is_a?(Symbol)
-		  bold = bold ? BOLD : ""
-		  "#{bold}#{color}#{string}#{CLEAR}"
+			unless (Main.options || {})[:no_colors]
+				color = self.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+				bold = bold ? BOLD : ""
+				"#{bold}#{color}#{string}#{CLEAR}"
+			else
+				"#{CLEAR}#{string}"
+			end
 		end
 	end
 end

data/lib/pickaxe/errors.rb

@@ -0,0 +1,60 @@
+module Pickaxe
+	module Errors
+		class PathError < PickaxeError
+			def initialize(file_or_directory)
+				super("file or directory '#{file_or_directory}' does not exist")
+			end
+		end
+	
+		class TestSyntaxError < PickaxeError
+			def initialize(line, message)
+				super("  line #{line}: #{message}")
+			end
+		end
+	
+		class MissingContent < TestSyntaxError
+			def initialize(line)
+				super(line, "no content (check blank lines nearby)")
+			end	
+		end
+	
+		class MissingAnswers < TestSyntaxError
+			def initialize(question)
+				super(question.index, 
+					BadQuestion.message(question, "has no answers"))
+			end
+		end
+	
+		class BadAnswer < TestSyntaxError
+			def initialize(line)
+				super(line.index, 
+					"'#{line.truncate(20)}' starts with weird characters")
+			end
+		end
+	
+		class BadQuestion < TestSyntaxError
+			def self.message(question, m)
+				"question '#{question.truncate(20)}' #{m}"
+			end		
+		
+			def initialize(question)
+				super(question.index, 
+					"'#{question.truncate(20)}' does not look like question")
+			end	
+		end
+
+		class NoCorrectAnswer < TestSyntaxError
+			def initialize(question)
+				super(question.content.first.index,
+					BadQuestion.message(question.content.first, "has no correct answers"))
+			end
+		end
+	
+		class NotUniqueAnswerIndices < TestSyntaxError
+			def initialize(question)
+				super(question.content.first.index,
+					BadQuestion.message(question.content.first, "answer indices are not unique"))
+			end
+		end
+	end
+end

data/lib/pickaxe/extensions.rb

@@ -4,15 +4,20 @@ class String
 		unless args.blank?
 			options[:line_width] = args[0] || Pickaxe::Shell.dynamic_width || 80
 		end
-		options.reverse_merge!(:line_width => Pickaxe::Shell.dynamic_width || 80)
+		options.reverse_merge!({
+			:line_width => (Pickaxe::Shell.dynamic_width || 80),
+			:indent => 0
+		})
+		
+		options[:line_width] -= options[:indent]
 
 		self.split("\n").collect do |line|
 			if line.length > options[:line_width]
-			 line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n").strip
+			 line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n#{" " * options[:indent]}").strip
 			else
-				line
+				line.strip
 			end
-		end * "\n"
+		end * "\n#{" " * options[:indent]}"
 	end
 	
 	def color(name, bold=false)

data/lib/pickaxe/main.rb

@@ -1,6 +1,6 @@
 module Pickaxe
 	class Main
-		class NoTests < PickaxeError; status_code(1) ; end
+		class NoTests < PickaxeError; end
 		
 		cattr_accessor :options
 		
@@ -19,9 +19,7 @@ END_OF_TEST
 			Main.options = options			
 			@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 { |s, t, p, msg| msg.to_s + "\n" }
@@ -31,7 +29,13 @@ END_OF_TEST
 			@answers = Hash.new([])					
 			@started_at = Time.now			
 			@current_index = 0
+
+			if @questions_length == 0
+				$stderr.puts "! No questions in test!".color(:red)
+				return
+			end
 			
+			puts "! Hit Control-D to end test.\n\n".color(:green)	
 			info = Main.options[:full_test] ? 1 : 0
 			while @current_index < @questions.length + info do
 				@question = @questions[@current_index]

data/lib/pickaxe/test.rb

@@ -1,55 +1,4 @@
 module Pickaxe
-
-	class PathError < PickaxeError
-		def initialize(file_or_directory)
-			super("file or directory '#{file_or_directory}' does not exist")
-		end
-	end
-	
-	class TestSyntaxError < PickaxeError
-		def initialize(file, line, message)
-			super("#{file}: line #{line}: #{message}")
-		end
-	end
-	
-	class MissingContent < TestSyntaxError
-		def initialize(file, line)
-			super(file, line, "no content (check blank lines nearby)")
-		end	
-	end
-	
-	class MissingAnswers < TestSyntaxError
-		def initialize(file, question)
-			super(file, question.index, 
-				BadQuestion.message(question, "has no answers"))
-		end
-	end
-	
-	class BadAnswer < TestSyntaxError
-		def initialize(file, line)
-			super(file, line.index, 
-				"'#{line.truncate(20)}' starts with weird characters")
-		end
-	end
-	
-	class BadQuestion < TestSyntaxError
-		def self.message(question, m)
-			"question '#{question.truncate(20)}' #{m}"
-		end		
-		
-		def initialize(file, question)
-			super(file, question.index, 
-				"'#{question.truncate(20)}' does not look like question")
-		end	
-	end
-	
-	class NoCorrectAnswer < TestSyntaxError
-		def initialize(file, question)
-			super(file, question.content.first.index,
-				BadQuestion.message(question.content.first, "has no correct answers"))
-		end
-	end
-		
 	class TestLine < String
 		attr_accessor :index
 		def initialize(itself, index)
@@ -58,20 +7,9 @@ module Pickaxe
 		end
 	end
 		
-	#
-	# Test is a file in which questions are separated by a blank line.
-	# 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.
-	#
-	# Example:
-	#
-	#  1. To be or not to be?
-	#  (a) To be.
-	#  (b) Not to be.
-	#  >> (c) I do not know.
-	#
 	class Test
+		include Pickaxe::Errors
+		
 		attr_reader :questions
 		
 		include Enumerable
@@ -93,7 +31,7 @@ module Pickaxe
 			end.flatten.collect { |f| f.squeeze('/') }
 			
 			@questions = []
-			@files.each do |file|
+			@files.inject(nil) do |last, file|				
 				File.open(file) do |f|
 					lines = f.readlines.collect(&:strip).each_with_index.collect do |l, i|
 						TestLine.new(l, i)
@@ -107,15 +45,20 @@ module Pickaxe
 							if Main.options[:strict]						
 								raise e 
 							else
-								$stderr.puts(e.message.color(:red))
+								if last != file									
+									$stderr.puts unless last.nil?
+									$stderr.puts("#{file}:".color(:red))
+									last = file
+								end
+								$stderr.puts(e.message.color(:red).word_wrap(:indent => 2))
 							end
 						end					
 					end
+					file
 				end
 			end
 		end
 		
-		# Yields questions randomly
 		def each(&block)
 			shuffled_questions.each(&block)
 		end
@@ -155,6 +98,8 @@ module Pickaxe
 	end
 		
 	class Question < Struct.new(:file, :index, :content, :answers)
+		include Pickaxe::Errors
+		
 		RE = /^\s*(\d+)\.?\s*(.+)$/u
 		
 		def self.parse(file, answers)
@@ -163,31 +108,46 @@ module Pickaxe
 				content << answers.shift
 			end
 						
-			raise MissingAnswers.new(file, answers.first.index) if content.blank?			
-			unless m = RE.match(content.first)
-				raise BadQuestion.new(file, content.first) 
-			end
-			raise MissingAnswers.new(file, content.first) if answers.blank?
+			raise MissingAnswers.new(file, answers.first.index) if content.blank?
+			raise BadQuestion.new(content.first) unless m = RE.match(content.first)
+			raise MissingAnswers.new(content.first) if answers.blank?
 									
 			answers = answers.inject([]) do |joined, line|
 				if Answer::RE.match(line)
 					joined << [line]
 				else
-					raise BadAnswer.new(file, line)unless Answer::LINE_RE.match(line)
+					raise BadAnswer.new(line) unless Answer::LINE_RE.match(line)
 					joined.last << line
 				end
 				joined
 			end
 			
-			answers = answers.collect {|answer| Answer.parse(file, answer) }
+			answers = answers.collect {|answer| Answer.parse(answer) }
 			Question.new(file, m[1], content, answers).tap do |q|
-				raise NoCorrectAnswer.new(file, q) if q.correct_answers.blank?
+				raise NoCorrectAnswer.new(q) if q.correct_answers.blank?				
+				raise NotUniqueAnswerIndices.new(q) unless q.answer_indices.uniq!.nil?
+				q.content = q.content.join(" ").gsub("\\n", "\n")
 			end
 		end
 		
+		def shuffled_answers
+			if @shuffled_answers.nil?
+				unless Main.options[:sorted_answers]
+					@shuffled_answers = self.answers.shuffle
+					answer_indices.sort.each_with_index do |index, order|
+						@shuffled_answers[order].index = index
+					end
+				else
+					@shuffled_answers = self.answers
+				end
+			end
+			
+			@shuffled_answers
+		end
+		
 		def answered(indices)
-			content = self.content.collect(&:word_wrap).join("\n")
-			"#{content}\n\n" + self.answers.collect do |answer|
+			content = self.content.word_wrap(:indent => index.to_s.length+2)
+			content + "\n\n" + self.shuffled_answers.collect do |answer|
 				selected = indices.include?(answer.index)
 				line = (selected ? ">> " : "   ") + answer.to_s
 				
@@ -212,6 +172,10 @@ module Pickaxe
 			answers.select(&:correctness).collect(&:index).sort
 		end
 		
+		def answer_indices
+			shuffled_answers.collect(&:index)
+		end
+		
 		def check?(given)
 			if correct?(given)
 				"Correct!".color(:green)
@@ -223,16 +187,16 @@ module Pickaxe
 	
 	class Answer < Struct.new(:content, :index, :correctness)
 		RE = /^\s*(>+)?\s*(\?+)?\s*\(?(\w)\)\s*(.+)$/u
-		LINE_RE = /^\s*([[:alpha:]]|\w+)/u
+		LINE_RE = /^\s*\\?\s*([[:alpha:]]|\w+)/u
 		
-		def self.parse(file, lines)
+		def self.parse(lines)
 			m = RE.match(lines.shift)
-			Answer.new(m[4].strip + " " + lines.collect(&:strip).join(" "), 
+			Answer.new(m[4].strip + " " + lines.map(&:strip).join(" ").gsub("\\n", "\n"),
 				m[3].strip, !m[1].nil?)
 		end
 		
 		def to_s
-			"(#{self.index}) #{self.content}".word_wrap
+			"(#{self.index}) #{self.content}".word_wrap(:indent => 7)
 		end
 	end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Pickaxe
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Dawid Fatyga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-02 00:00:00 +01:00
+date: 2010-12-03 00:00:00 +01:00
 default_executable: bin/pickaxe
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,6 +87,7 @@ files:
 - lib/pickaxe/color.rb
 - lib/pickaxe/extensions.rb
 - lib/pickaxe/shell.rb
+- lib/pickaxe/errors.rb
 - lib/pickaxe/main.rb
 - bin/drill
 - bin/pickaxe