code_rippa 0.0.4 → 0.0.5

data/bin/code_rippa

@@ -13,22 +13,18 @@ option_parser = OptionParser.new do |opts|
 
   Usage: code_rippa [options] input_file_or_directory
 
-  Parses input_file or directory and outputs a file named out.tex. 
-  It expects both the syntax and theme to be specified.
+     Parses input_file or directory and outputs a file named out.tex. 
+     It expects both the syntax and theme to be specified.
   
   Example:
 
-     code_rippa -s ruby -t amy path_to_file.rb
+    code_rippa -s ruby -t amy path_to_file.rb
 
-     Renders the contents of path_to_file.rb into out.tex.
+    Renders the contents of path_to_file.rb into out.tex.
 
-     Then run
-     
-     pdflatex out.tex
-     
-     to generate the PDF output.
+    Then run `pdflatex out.tex` to generate the PDF output.
         
-  "-s" and "-t" are mandatory. The rest are optional.
+    "-s" and "-t" are mandatory. The rest are optional.
 
   Options:
 END
@@ -59,7 +55,7 @@ END
 		exit 0
 	end
 	
-	opts.on('-c', '--version', 'Display version number') do
+	opts.on('-v', '--version', 'Display version number') do
 		puts CodeRippa::VERSION
 		exit 0
 	end

data/code_rippa.gemspec

@@ -17,5 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CodeRippa::VERSION
   gem.required_ruby_version = '>= 1.9.0'
+  gem.add_dependency "rainbow"
+  gem.add_dependency "ansi"  
   gem.add_dependency "spox-ultraviolet", "~> 0.10.5"
 end

data/lib/code_rippa.rb

@@ -2,34 +2,77 @@ require 'uv'
 require 'find'
 require 'code_rippa/uv_overrides'
 require 'code_rippa/version'
+require 'ansi/progressbar'
+require 'rainbow'
+include ANSI
 
-YAML::ENGINE.yamler= 'syck'
+
+YAML::ENGINE.yamler = 'syck'
 
 module CodeRippa
-			
+	
+	@@supported_syntax = nil
+	@@supported_ext = nil
+	
+	# Parses the given file, and writes the output file (out.tex)
+	# into the current directory.
+	# 
+	# path					- The file path
+	# syntax				- The syntax to perform parsing/syntax highlighting. 
+	#									Note the the syntax should be supported by code_rippa.
+	# excluded_exts - An Array of extensions to ignore during parsing. 
+	# 
+	# Examples
+	#
+	#		rip_dir("~/code/ruby/some_folder/some_file.rb", "space_cadet", "ruby", [])
+	#
+	# Returns nothing.
 	def self.rip_file(path, theme, syntax)
 		begin 
 			srcfile = File.read(path)
 			src_ext = File.extname(path)[1..-1]					
-		  outfile = File.open('out.tex', 'w') 
+			outfile = File.open('out.tex', 'w') 
 			outfile.write preamble theme
 			outfile.write "\\textcolor{headingcolor}{\\textbf{\\texttt{#{path.gsub('_','\_').gsub('%','\%')}}}}\\\\\n"
 			outfile.write "\\textcolor{headingcolor}{\\rule{\\linewidth}{1.0mm}}\\\\\n"
 			outfile.write Uv.parse(srcfile, 'latex', syntax, true, theme) 
 			outfile.write endtag
+			
+			msg =	 "Completed successfully.\n".color(:green)
+			msg << "Output file written to: "
+			msg << "#{File.expand_path(outfile)}\n".color(:yellow)
+			msg << "Now run "
+			msg << "pdflatex #{File.expand_path(outfile)} ".color(:red)
+			msg << "** TWICE ** to generate PDF."
+			puts msg
 			outfile.close
 		rescue Exception => e
 			puts e
 		end
 	end
 
+	# Parses the given directory, and writes the output file (out.tex)
+	# into the current directory.
+	# 
+	# dir_path			- The directory path
+	# syntax				- The syntax to perform parsing/syntax highlighting. 
+	#									Note the the syntax should be supported by code_rippa.
+	# excluded_exts - An Array of extensions to ignore during parsing. 
+	# 
+	# Examples
+	#
+	#		rip_dir("~/code/ruby/some_folder", "space_cadet", "ruby", [])
+	#
+	# Returns nothing.
 	def self.rip_dir(dir_path, theme, syntax, excluded_exts = [])
-		counter = 0					
-		outfile = File.open('out.tex', 'w') 
-		outfile.write preamble(theme)
-		Find.find(dir_path) do |path|
+		pbar		 = Progressbar.new("Rippin'".color(:blue), Dir["**/*"].length)
+		counter	 = 0					
+		outfile	 = File.open('out.tex', 'w') 
+		
+		outfile.write preamble theme
+		 Find.find dir_path do |path|
 			depth = path.to_s.count('/')
-			if File.basename(path)[0] == ?.
+			if File.basename(path)[0] == ?. or File.basename(path) == "out.tex"
 				Find.prune
 			else
 				begin
@@ -52,26 +95,60 @@ module CodeRippa
 				end
 				counter += 1
 			end
+			pbar.inc
 		end
+		
 		outfile.write endtag
+		pbar.finish
+		
+		msg =	 "Completed successfully.\n".color(:green)
+		msg << "Output file written to: "
+		msg << "#{File.expand_path(outfile)}\n".color(:yellow)
+		msg << "Now run "
+		msg << "pdflatex #{File.expand_path(outfile)} ".color(:red)
+		msg << "** TWICE ** to generate PDF."
+		puts msg
+		
 		outfile.close
 	end
 															
-	private
+	private 
 		def self.syntax_path
 			Uv.syntax_path
 		end
 		
+		# Returns an Array of supported syntaxes. This is done by parsing 
+		# all the file names in the syntax folder.
+		#
+		# Examples
+		#
+		#		supported_syntax 
+		#		# => ['ruby','prolog'] 
+		#
+		# Returns an Array of supported languages 
 		def self.supported_syntax
-			syntax = []
-			Dir.foreach(syntax_path) do |f|
-				if File.extname(f) == ".syntax"
-					syntax << File.basename(f, '.*') 
+			if @@supported_syntax
+				@@supported_syntax
+			else	
+				@@supported_syntax = []
+				Dir.foreach(syntax_path) do |f|
+					if File.extname(f) == ".syntax"
+						@@supported_syntax << File.basename(f, '.*') 
+					end
 				end
+			@@supported_syntax
 			end
-			syntax
 		end
 		
+		# Returns an Array of supported languages. This is done by parsing 
+		# all the file names in the syntax folder.
+		#
+		# Examples
+		#
+		#		supported_langs 
+		#		# => ['Ruby','Prolog'] 
+		#
+		# Returns an Array of supported languages
 		def self.supported_langs
 			langs = []
 			Dir.foreach(syntax_path) do |f|
@@ -82,39 +159,96 @@ module CodeRippa
 			end
 			langs
 		end
-
+		
+		# Returns an Array of file extensions that is supported by code_rippa 
+		#
+		# Examples
+		#
+		#		supported_langs 
+		#		# => ['rb', 'Gemfile', 'erb'] 
+		#
+		# Returns an Array of supported extensions.
 		def self.supported_exts
-			filetypes = []
-			Dir.foreach(syntax_path) do |f|
-				if File.extname(f) == ".syntax"
-					y = YAML.load(File.read "#{syntax_path}/#{f}")
-					filetypes += y["fileTypes"] if y["fileTypes"]
+			if @@supported_ext
+				@@supported_ext
+			else
+				@@supported_ext = []
+				Dir.foreach(syntax_path) do |f|
+					if File.extname(f) == ".syntax"
+						y = YAML.load(File.read "#{syntax_path}/#{f}")
+						@@supported_ext += y["fileTypes"] if y["fileTypes"]
+					end
 				end
+				@@supported_ext				
 			end
-			filetypes
 		end
 
+		# Returns True if path should be bookmarked in the output TEX/PDF document.
+		#
+		# path					- The file/directory path
+		# syntax				- The syntax to perform parsing/syntax highlighting. 
+		#									Note the the syntax should be supported by code_rippa.
+		# excluded_exts - An Array of extensions to ignore during parsing.
+		#
+		#
+		# Examples
+		#
+		#		bookmarkable?("hello.rb", "ruby", []) 
+		#		# => true 
+		#
+		#		bookmarkable?("hello.rb", "ruby", ["rb", "html"]) 
+		#		# => false
+		#
+		#		bookmarkable?("hello.klingon", "klingon", []) 
+		#		# => false
+		#
+		# Returns True if path should be bookmarked.
 		def self.bookmarkable?(path, syntax, excluded_exts)
 			if FileTest.directory?(path)
 				true
 			else
 				src_ext = File.extname(path)[1..-1]
-				if excluded_exts.include?(src_ext)
+				if File.basename(path) == "out.tex"
+					false
+				elsif excluded_exts.include?(src_ext)
 					false
 				elsif supported_exts.include?(src_ext)
-  				true
+					true
 				else
-				  false
+					false
 				end
 			end
 		end
-
+		
+		# Returns True if path should be ripped as part of the output TEX file. 
+		#
+		# path					- The file. (directories will return false.)
+		# syntax				- The syntax to perform parsing/syntax highlighting. 
+		#									Note the the syntax should be supported by code_rippa.
+		# excluded_exts - An Array of extensions to ignore during parsing.
+		#
+		#
+		# Examples
+		#
+		#		rippable?("hello.rb", "ruby", []) 
+		#		# => true 
+		#
+		#		rippable?("~/code/", "ruby", []) 
+		#		# => false
+		#
+		#		rippable?("hello.rb", "ruby", ["rb", "html"]) 
+		#		# => false
+		#
+		#		rippable?("hello.klingon", "klingon", []) 
+		#		# => false
+		#
+		# Returns true if path should be ripped.
 		def self.rippable?(path, syntax, excluded_exts)
 			if FileTest.directory?(path)
 				false
 			else
 				src_ext = File.extname(path)[1..-1]
-        if excluded_exts.include? src_ext
+				if excluded_exts.include? src_ext
 					false
 				elsif supported_exts.include?(src_ext)
 					true
@@ -124,11 +258,34 @@ module CodeRippa
 			end
 		end
 
+		# Returns the hex color code of the page color. This is done by looking at
+		# the *.render file of the selected theme.
+		#
+		# theme - The selected theme.
+		# 
+		# Examples
+		#
+		#		page_color('moc') 
+		#		# => "E8E8E8"
+		#
+		# Returns an String containing the hex color code of the page.
 		def self.page_color(theme)
 			f = YAML.load(File.read("#{Uv.render_path}/latex/#{theme}.render"))						
 			/([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})/.match(f['listing']['begin'].split('\\')[3]).to_s
 		end
 	
+		# Returns the hex color code of the heading. This is done by looking at
+		# the *.render file of the selected theme. The heading is present at 
+		# the top of each new document in the output TEX/PDF file.
+		#
+		# theme - The selected theme.
+		# 
+		# Examples
+		#
+		#		heading_color('moc') 
+		#		# => "E8E8E8"
+		#
+		# Returns an String containing the hex color code of the heading.
 		def self.heading_color(theme)
 			f = YAML.load(File.read("#{Uv.render_path}/latex/#{theme}.render"))						
 			/([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})/.match(f['listing']['begin'].split('\\')[2]).to_s

data/lib/code_rippa/uv_overrides.rb

@@ -1,5 +1,7 @@
 require 'uv'
 
+# These module monkey patches the original Spox's Ultraviolet, in order 
+# to override defaults.
 module Uv
 	@@set_table_columns = true
 	

data/lib/code_rippa/version.rb

@@ -1,3 +1,3 @@
 module CodeRippa
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_rippa
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 Z
+date: 2012-03-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spox-ultraviolet
   requirement: !ruby/object:Gem::Requirement