Pickaxe 0.1.3 → 0.2.0

data/README.markdown

@@ -2,3 +2,5 @@
 
 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/).

data/bin/pickaxe

@@ -30,7 +30,7 @@ END_OF_BANNER
 		options[:sorted] = true
 	end
 	
-	opts.on("--select [NUMBER]", "Select certain amount of questions") do |v|
+	opts.on("--select [NUMBER]", "Select certain number of questions") do |v|
 		options[:select] = Integer(v)
 	end
 	

data/lib/pickaxe.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "bundler"
+
+Bundler.setup(:default)
+
+require 'active_support/all'
+
+module Pickaxe
+	VERSION = "0.2.0"
+	
+	class PickaxeError < StandardError
+		attr_reader :status_code
+    def self.status_code(code = nil)
+      define_method(:status_code) { code }
+    end
+  end
+  
+  autoload :Shell, 'pickaxe/shell'
+  autoload :Color, 'pickaxe/color'
+	autoload :Main, 'pickaxe/main'
+	autoload :Test, 'pickaxe/test'
+end
+
+require 'pickaxe/extensions'
+

data/lib/pickaxe/color.rb

@@ -0,0 +1,54 @@
+module Pickaxe 
+  # Extracted from https://github.com/wycats/thor/blob/master/lib/thor/shell/color.rb
+	module Color
+		# Embed in a String to clear all previous ANSI sequences.
+		CLEAR = "\e[0m"
+		# The start of an ANSI bold sequence.
+		BOLD = "\e[1m"
+
+		# Set the terminal's foreground ANSI color to black.
+		BLACK = "\e[30m"
+		# Set the terminal's foreground ANSI color to red.
+		RED = "\e[31m"
+		# Set the terminal's foreground ANSI color to green.
+		GREEN = "\e[32m"
+		# Set the terminal's foreground ANSI color to yellow.
+		YELLOW = "\e[33m"
+		# Set the terminal's foreground ANSI color to blue.
+		BLUE = "\e[34m"
+		# Set the terminal's foreground ANSI color to magenta.
+		MAGENTA = "\e[35m"
+		# Set the terminal's foreground ANSI color to cyan.
+		CYAN = "\e[36m"
+		# Set the terminal's foreground ANSI color to white.
+		WHITE = "\e[37m"
+
+		# Set the terminal's background ANSI color to black.
+		ON_BLACK = "\e[40m"
+		# Set the terminal's background ANSI color to red.
+		ON_RED = "\e[41m"
+		# Set the terminal's background ANSI color to green.
+		ON_GREEN = "\e[42m"
+		# Set the terminal's background ANSI color to yellow.
+		ON_YELLOW = "\e[43m"
+		# Set the terminal's background ANSI color to blue.
+		ON_BLUE = "\e[44m"
+		# Set the terminal's background ANSI color to magenta.
+		ON_MAGENTA = "\e[45m"
+		# Set the terminal's background ANSI color to cyan.
+		ON_CYAN = "\e[46m"
+		# Set the terminal's background ANSI color to white.
+		ON_WHITE = "\e[47m"
+
+		# Set color by using a string or one of the defined constants. If a third
+		# option is set to true, it also adds bold to the string. This is based
+		# on Highline implementation and it automatically appends CLEAR to the end
+		# 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}"
+		end
+	end
+end

data/lib/pickaxe/extensions.rb

@@ -0,0 +1,27 @@
+class String
+	def word_wrap(*args)
+		options = args.extract_options!
+		unless args.blank?
+			options[:line_width] = args[0] || Pickaxe::Shell.dynamic_width || 80
+		end
+		options.reverse_merge!(:line_width => Pickaxe::Shell.dynamic_width || 80)
+
+		self.split("\n").collect do |line|
+			line.length > options[:line_width] ? line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n").strip : line
+		end * "\n"
+	end
+	
+	def color(name, bold=false)
+		Pickaxe::Color.set_color(self, name, bold)
+	end
+end
+
+class Fixnum
+	def to_duration
+		s = self
+	  m = s / 60
+	  s -= m * 60
+	
+	  [m, s].compact.zip(["m", "s"]).collect(&:join).join(" ")
+	end
+end

data/lib/pickaxe/main.rb

@@ -0,0 +1,112 @@
+module Pickaxe
+	class Main
+		class NoTests < PickaxeError; status_code(1) ; end
+		
+		def initialize(paths, options = {})
+			raise NoTests, "no tests to run" if paths.empty?
+			@test = Test.new(options, *paths)
+			@questions = @test.shuffled_questions
+			@answers = Hash.new([])
+			
+			@started_at = Time.now			
+			@current_index = 0
+			while @current_index < @questions.length do
+				@question = @questions[@current_index]
+				
+				puts "#{@current_index+1} / #{@questions.length}\t\tFrom: #{@question.file}\t\tTime spent: #{spent?}"
+				puts @question.answered(@answers[@question])
+				
+				until (line = prompt?).nil? or command(line)
+					# empty
+				end
+											
+				break if puts or line.nil?
+			end
+			
+			statistics!
+		end
+		
+		#
+		# Available commands
+		# 	^ question 		jumps to given question
+		# 	<+						moves back one question
+		# 	>+						moves forward one question
+		# 	! a [ b ...]  answers the question and forces to show correct answers
+		# 	a [ b ...]    answers the question
+		#   ?							shows help
+		#
+		def command(line)
+			case line
+			when /^\s*@\s*(.+)/	then # @ question
+				@current_index = Integer($1) -1
+				true
+			when /<+/ then
+				if @current_index > 0
+					@current_index -= 1 
+					true
+				else
+					error "You are at first question"
+				end
+			when />+/ then
+				if @current_index < (@questions.length - 1)
+					@current_index += 1
+					true
+				else
+					error "You are at last question"
+				end
+			when "\n" then
+				@current_index += 1
+				true
+			when /^\s*!\s*(.+)/ then
+				raise NotImplementedError
+			when /\?/ then
+				puts <<END_OF_HELP
+				
+Available commands (whitespace does not matter):
+  @ question   jumps to given question
+  <            moves back one question
+  >            moves forward one question
+    a [ b ...] answers the question  
+  ! a [ b ...] answers the question and forces reveal correct answers
+  ?            shows help
+  
+END_OF_HELP
+				false
+			else
+				@answers[@question] = line.split(/\s+/).collect(&:strip)
+				@current_index += 1
+				true
+			end
+		end
+		
+		def statistics!
+			@stats = @test.statistics!(@answers)
+			
+			puts			
+			puts "Time: #{spent?}"
+			puts "All: #{@questions.length}"
+			stat :correct, :green
+			stat :unanswered, :yellow
+			stat :incorrect, :red
+		end
+		
+		def error(msg)
+			$stderr.puts(("! " + msg).color(:red))
+			false
+		end
+		
+		def prompt?(p = "? ")
+			print p
+			$stdin.gets
+		end
+		
+		def spent?
+			(Time.now - @started_at).to_i.to_duration			
+		end
+	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)
+		end
+	end
+end

data/lib/pickaxe/shell.rb

@@ -0,0 +1,16 @@
+module Pickaxe
+	module Shell
+		# Extracted from https://github.com/wycats/thor/blob/master/lib/thor/shell/basic.rb
+		def self.dynamic_width
+		  (dynamic_width_stty.nonzero? || dynamic_width_tput)
+		end
+
+		def self.dynamic_width_stty
+		  %x{stty size 2>/dev/null}.split[1].to_i
+		end
+
+		def self.dynamic_width_tput
+		  %x{tput cols 2>/dev/null}.to_i
+		end  
+	end
+end

data/lib/pickaxe/test.rb

@@ -0,0 +1,128 @@
+module Pickaxe
+	#
+	# Test is a file in which questions are separated by a blank line.
+	# Each question has content (first line), and answers remaining lines.
+	# 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
+		attr_reader :questions
+		
+		include Enumerable
+		
+		# Ruby-comments and C-comments
+		COMMENTS_RE = /^#.*|^\/\/.*/
+		
+		class PathError < PickaxeError; status_code(1) ; end
+		class MissingAnswers < PickaxeError; status_code(2) ; end
+		class BadAnswer < PickaxeError; status_code(3) ; end
+		
+		def initialize(options, *files)
+			@options = options
+			@files = files.collect do |file_or_directory|
+				raise PathError, "file or directory '#{file_or_directory}' does not exist" unless File.exist?(file_or_directory)
+				if File.file?(file_or_directory)
+					file_or_directory
+				else
+					Dir.glob("#{file_or_directory}/*.#{@options[:extension] || "txt"}")
+				end				
+			end.flatten
+			
+			@questions = []
+			@files.each do |file|
+				File.open(file) do |f|
+					lines = f.readlines.collect(&:strip)
+					lines = lines.reject {|line| line =~ COMMENTS_RE }
+					lines.split("").reject(&:blank?).each do |question|
+						@questions.push(Question.parse(file, question))
+					end
+				end
+			end
+		end
+		
+		# Yields questions randomly
+		def each(&block)
+			shuffled_questions.each(&block)
+		end
+		
+		def shuffled_questions
+			questions = if @options[:sorted]
+				@questions
+			else
+				@questions.shuffle			
+			end
+			
+			@selected = if @options[:select]
+				questions[0...(@options[:select])]
+			else
+				questions
+			end			
+		end
+		
+		def selected
+			@selected ||= @questions
+		end
+		
+		def statistics!(answers)
+			Hash.new(0).tap do |statistics|
+				selected.each do |question|
+					given = answers[question]
+					if question.correct?(given)
+						statistics[:correct] += 1
+					elsif given.blank?
+						statistics[:unanswered] += 1
+					else
+						statistics[:incorrect] += 1
+					end
+				end
+			end
+		end
+	end
+		
+	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) })
+		end
+		
+		def answered(indices)
+			"#{self.content.word_wrap}\n\n" + self.answers.collect do |answer|
+				selected = indices.include?(answer.index)
+				line = (selected ? ">> " : "   ") + answer.to_s
+				unless indices.blank?
+					if selected and answer.correctness
+						line.color(:green)
+					elsif not selected and answer.correctness
+						line.color(:yellow)
+					elsif selected and not answer.correctness
+						line.color(:red)
+					end
+				end || line				
+			end.join("\n") + "\n\n"
+		end
+		
+		def correct?(given)
+			given.sort == answers.select(&:correctness).collect(&:index).sort
+		end
+	end
+	
+	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?
+			Answer.new(m[m.size-1].strip, m[m.size-2].strip, m[1] == ">>")
+		end
+		
+		def to_s
+			"(#{self.index}) #{self.content}".word_wrap
+		end
+	end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: Pickaxe
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dawid Fatyga
@@ -62,7 +62,10 @@ dependencies:
   name: i18n
   prerelease: false
   type: :runtime
-description: "    Pickaxe provides a simple way to load, solve and rate tests (bundle of questions)\n    written in simple text format.\n"
+description: |
+  Pickaxe provides a simple way to load, solve and rate tests (bundle of questions)
+  written in simple text format.
+
 email: dawid.fatyga@gmail.com
 executables: 
 - pickaxe
@@ -71,8 +74,14 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
-- README.markdown
+- lib/pickaxe.rb
+- lib/pickaxe/test.rb
+- lib/pickaxe/color.rb
+- lib/pickaxe/extensions.rb
+- lib/pickaxe/shell.rb
+- lib/pickaxe/main.rb
 - bin/pickaxe
+- README.markdown
 has_rdoc: true
 homepage: https://github.com/dejw/pickaxe
 licenses: []