code_rippa 0.0.1 → 0.0.3

data/README.md

@@ -1,35 +1,88 @@
 # CodeRippa
 
-CodeRippa takes your source code and turns it into a beautiful PDF file. 
+CodeRippa takes your source code and turns it into a beautiful PDF file. Currently, it supports 150 languages and 15 themes, all of which are available in TextMate. More syntaxes and themes will be available soon.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'code_rippa'
+	$ gem 'code_rippa'
 
 And then execute:
 
-    $ bundle
+	$ bundle
 
 Or install it yourself as:
 
-    $ gem install code_rippa
+	$ gem install code_rippa
 
 ## Usage
 
-	$ Usage: code_rippa [options] file_or_directory
-    $	-l, --list-themes                List all available themes
-    $	-t, --theme THEME                Selected theme
-    $	-n, --list-syntax                List all available syntax
-    $	-s, --syntax SYNTAX              Selected syntax
-    $	-x, --excluded-exts E1,E2,EN     Exclude these extensions when processing
-    $	-h, --help                       Display this screen
+### Command line options
+	 
+	Usage: code_rippa [options] file_or_directory
+    	-l, --list-themes                List all available themes
+    	-t, --theme THEME                Selected theme
+    	-n, --list-syntax                List all available syntax
+    	-s, --syntax SYNTAX              Selected syntax
+    	-x, --excluded-exts E1,E2,EN     Exclude these extensions when processing
+    	-h, --help                       Display this screen
+
+### List all available themes
+		
+	$ code_rippa -l
+	
+	active4d
+	all_hallows_eve
+	amy
+	moc
+	twilight
+	zenburnesque
+	... more themes omitted
+	
+### List all supported syntax
+
+	$ code_rippa -n
+	
+	actionscript
+	erlang
+	java
+	javascript
+	prolog
+	ruby
+	yaml
+	... more syntaxes omitted
+	
+### Producing PDF from a single file
+
+Example:
+	
+	$ code_rippa -s ruby -t zenburnesque path_to_single_file.rb
+
+Note that the output file is saved as _out.tex_ in the current directory where _code_rippa_ was called from. 
+
+	$ pdflatex out.tex			# Saved as out.pdf
+
+		
+### Producing PDF from a directory
+	
+Example:
+
+	$ code_rippa -s java -t moc path_to_directory
+
+Note that the output file is saved as _out.tex_ in the current directory where _code_rippa_ was called from. 
+
+Then, you'll need to run _pdflatex_ __twice__. This is because LaTeX needs to generate the bookmarks.
+
+	$ pdflatex out.tex			# Saved as out.pdf
+	$ pdflatex out.tex			# Remember to run this twice!
+	
+Note: In case your system doesn't have `pdflatex`, you can get a [LaTeX](http://www.tug.org/texlive/) distribution.
+
+## Credits
+
+None of this would be possible without the awesome [ultraviolet](https://github.com/giom/ultraviolet) and [spox-ultraviolet](https://github.com/spox/ultraviolet) and  [linguist](https://github.com/github/linguist) gems. Props to [__lwheng__](https://github.com/lwheng) for providing most of the LaTeX help.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Currently this gem is in its infancy. Any bug reports and feature requests are very welcomed.

data/bin/code_rippa

@@ -9,12 +9,34 @@ end
 
 options = {}
 option_parser = OptionParser.new do |opts|
+	
+	opts.banner =<<END
+
+  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.
+  
+  Example:
+
+     code_rippa -s ruby -t amy path_to_file.rb
 
-	opts.banner = CodeRippa.usage
+     Renders the contents of path_to_file.rb into out.tex.
 
+     Then run
+     
+     pdflatex out.tex
+     
+     to generate the PDF output.
+        
+  "-s" and "-t" are mandatory. The rest are optional.
+
+  Options:
+END
+	
 	opts.on('-l', '--list-themes', 'List all available themes') do
 		puts Uv.themes.join("\n")
-		exit
+		exit 0
 	end
 	
 	opts.on('-t', '--theme THEME', 'Selected theme') do |theme|
@@ -27,7 +49,7 @@ option_parser = OptionParser.new do |opts|
 	
 	opts.on('-n', '--list-syntax', 'List all available syntax') do
 		puts CodeRippa.supported_syntax.join("\n")
-		exit
+		exit 0
 	end
 	
 	opts.on('-s', '--syntax SYNTAX', 'Selected syntax') do |syntax|
@@ -55,24 +77,23 @@ option_parser = OptionParser.new do |opts|
 		
 	opts.on('-h', '--help', 'Display this screen') do
 		puts opts
-		exit
+		exit 0
 	end	 
 end
 
 begin
 	option_parser.parse!	
-	
 	if options[:theme] and options[:syntax] and ARGV.size == 1
 		if FileTest.file?(ARGV[0])
 			CodeRippa.rip_file(ARGV[0], options[:theme], options[:syntax], options[:excluded_exts])
 		elsif FileTest.directory?(ARGV[0])
 			CodeRippa.rip_dir(ARGV[0], options[:theme], options[:syntax], options[:excluded_exts])
 		end
+		exit 0
 	else
-		raise ArgumentError, "Missing arguments. Aborting.\n" + CodeRippa.usage
+		raise ArgumentError, "Missing arguments. Aborting.\n"
 	end
-	
 rescue ArgumentError => e
 	puts e
-	exit
+	exit 1
 end

data/code_rippa.gemspec

@@ -5,9 +5,9 @@ require File.expand_path('../lib/code_rippa/uv_overrides', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Benjamin Tan Wei Hao"]
   gem.email         = ["ben@witsvale.com"]
-  gem.platform    = Gem::Platform::RUBY
+  gem.platform      = Gem::Platform::RUBY
   gem.description   = %q{Converts source code into a (bookmarked, themed, and syntax highlighted!) PDF.}
-  gem.summary       = %q{Converts source code into a (bookmarked, themed, and syntax highlighted!) PDF. Supports 150 languages and Textmate themes. }
+  gem.summary       = %q{CodeRippa takes your source code and turns it into a beautiful PDF file. Currently, it supports 150 languages and 15 themes, all of which are available in TextMate. More syntaxes and themes will be available soon.}
   gem.homepage      = "http://code-rippa.heroku.com"
   gem.has_rdoc      = false
   gem.files         = `git ls-files`.split($\)

data/lib/code_rippa/version.rb

@@ -1,3 +1,3 @@
 module CodeRippa
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/code_rippa.rb

@@ -45,7 +45,7 @@ module CodeRippa
 				Find.prune
 			else
 				begin
-					puts ">> #{path}"
+
 					is_rippable = rippable?(path, syntax, excluded_exts)
 
 					if is_rippable
@@ -72,11 +72,6 @@ module CodeRippa
 	end
 															
 	private
-
-	
-		def self.usage
-		 "Usage: code_rippa [options] file_or_directory"
-		end
 	
 		def self.syntax_path
 			Uv.syntax_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_rippa
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -239,7 +239,8 @@ rubyforge_project:
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Converts source code into a (bookmarked, themed, and syntax highlighted!)
-  PDF. Supports 150 languages and Textmate themes.
+summary: CodeRippa takes your source code and turns it into a beautiful PDF file.
+  Currently, it supports 150 languages and 15 themes, all of which are available in
+  TextMate. More syntaxes and themes will be available soon.
 test_files: []
 has_rdoc: false