code2pdf 0.1.2 → 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/Gemfile.lock

@@ -1,17 +1,27 @@
 PATH
   remote: .
   specs:
-    code2pdf (0.0.1)
+    code2pdf (0.2.0)
+      prawn (~> 0.11.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
     Ascii85 (1.0.1)
+    diff-lcs (1.1.2)
     pdf-reader (0.9.2)
       Ascii85 (>= 0.9)
     prawn (0.11.1)
       pdf-reader (>= 0.9.0)
       ttfunk (~> 1.0.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     ttfunk (1.0.1)
 
 PLATFORMS
@@ -19,4 +29,4 @@ PLATFORMS
 
 DEPENDENCIES
   code2pdf!
-  prawn
+  rspec

data/README.textile

@@ -12,11 +12,11 @@ h1. Usage
 
 Open a terminal and run:
 
-<pre><code>code2pdf <project path> <blacklist file></code></pre>
+<pre><code>code2pdf <project path></code></pre>
 
 h2. BlackList file example:
 
-The blacklist file must be a yaml file, as such:
+The blacklist file must be a yaml file, named .code2pdf and it should be located in <project path> root, containing a list of ignored files and/or directories, such as:
 <pre><code>:directories:
   - .git
   - db/migrate

data/bin/code2pdf

@@ -4,23 +4,22 @@
 # Created by Lucas Caton at 2011, may 31
 #
 
-require 'optparse'
-require 'yaml'
 require 'rubygems'
-require 'prawn'
-require 'code2pdf/convert_to_pdf'
+require 'optparse'
+$:.push File.expand_path('../../lib', __FILE__)
+require 'code2pdf'
 
 options = {}
 
 optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: code2pdf <project path> <blacklist file>\n\nYou can use flags as such:"
+  opts.banner = "Usage: code2pdf <project path>\n\nYou can use flags as such:"
 
   opts.on('-h', '--help', 'Display this screen') do
     puts opts
     exit
   end
 
-  if ARGV.size < 2
+  if ARGV.size < 1
     puts opts
     exit
   end
@@ -34,58 +33,7 @@ rescue OptionParser::InvalidOption => e
 end
 
 PATH = ARGV[0].gsub(/\/$/, '')
-
-# Check if path exists
-if !File.exists?(PATH) || FileTest.file?(PATH)
-  puts "'#{PATH}' path does not exist or it is not a directory."
-  exit
-end
-
-BLACK_LIST_YML_FILE = ARGV[1]
-
-# Check if blacklist file exists
-if !File.exists?(BLACK_LIST_YML_FILE) || FileTest.directory?(BLACK_LIST_YML_FILE)
-  puts "'#{BLACK_LIST_YML_FILE}' file does not exist or it is not a regular file."
-  exit
-end
-
-BLACK_LIST = YAML.load File.read(BLACK_LIST_YML_FILE)
-
-# Check if blacklist file has directories and files keys
-if !BLACK_LIST.keys.include?(:directories) || !BLACK_LIST.keys.include?(:files)
-  puts "'#{BLACK_LIST_YML_FILE}' file has no directories and files keys."
-  exit
-end
-
-BLACK_LIST_DIRECTORIES = BLACK_LIST[:directories].map {|directory| "#{PATH}/#{directory}"}
-BLACK_LIST_FILES = BLACK_LIST[:files]
-
-@code_files = []
-
-# Read code files from path
-def read_code_files_from_path(path)
-  Dir.foreach path do |it|
-    path_and_name = "#{path}/#{it}"
-    if FileTest.directory?(path_and_name) && it != '.' && it != '..'
-      read_code_files_from_path path_and_name unless BLACK_LIST_DIRECTORIES.include? path_and_name
-    elsif FileTest.file?(path_and_name) && !BLACK_LIST_FILES.include?(it)
-      puts "Processing => #{path_and_name}"
-      file = File.open(path_and_name, 'r')
-      file_content = ''
-      line_number = 1
-      file.each_line do |line|
-        file_content << line.gsub(/</, '&lt;').gsub(/^/, "<color rgb='AAAAAA'>#{line_number}</color>  "); line_number += 1
-      end
-      file.close
-      @code_files << [path_and_name, file_content]
-    end
-  end
-end
-
-read_code_files_from_path PATH
-
+BLACK_LIST_YML_FILE = "#{PATH}/.code2pdf"
 # Convert to PDF
-puts "\n\nConverting to PDF..."
-filename = PATH.gsub(/(\.|\/)/, '_')
-pdf = ConvertToPDF.new "#{filename}.pdf", @code_files
-pdf.save
+filename = "#{PATH.gsub(/(\.|\/)/, '_')}.pdf"
+ConvertToPDF.new :from => PATH, :to => filename, :except => BLACK_LIST_YML_FILE

data/code2pdf.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.summary     = %q{Convert your source code to PDF}
   s.description = %q{Convert your source code to PDF}
 
-  s.add_development_dependency 'prawn'
-  s.add_development_dependency 'prawn', '~> 0.11.1'
+  s.add_dependency 'prawn', '~> 0.11.1'
+  s.add_development_dependency 'rspec'
 
   s.rubyforge_project = 'code2pdf'
 

data/lib/code2pdf.rb

@@ -0,0 +1,3 @@
+require 'yaml'
+require 'prawn'
+require 'code2pdf/convert_to_pdf'

data/lib/code2pdf/convert_to_pdf.rb

@@ -4,13 +4,27 @@ class ConvertToPDF
     :page_size   => 'A4'
   }
 
-  def initialize(filename, code_files)
-    @filename, @code_files = filename, code_files
+  def initialize(params={})
+    if not params.has_key?(:from) or params[:from].nil?
+      raise ArgumentError.new 'where are the codes you want to convert to pdf?'
+    elsif not valid_directory?(params[:from])
+      raise LoadError.new "#{params[:from]} not found"
+    elsif not params.has_key?(:to) or params[:to].nil?
+      raise ArgumentError.new 'where should I save the generated pdf file?'
+    else
+      @from, @to = params[:from], params[:to]
+      if params.has_key?(:except)
+        @except = params[:except]
+        raise LoadError.new "#{@except} is not a valid blacklist yaml file" unless valid_blacklist?
+      end
+      save
+    end
   end
 
+  private
   def pdf
     Prawn::Document.new PDF_OPTIONS do |pdf|
-      @code_files.each do |file|
+      read_files.each do |file|
         puts "Converting to PDF => #{file.first}"
         pdf.font 'Courier' do
           pdf.text "File: <strong>#{file.first}</strong>", :size => 12, :inline_format => true
@@ -23,6 +37,53 @@ class ConvertToPDF
   end
 
   def save
-    pdf.render_file @filename
+    pdf.render_file @to
+  end
+
+  def valid_blacklist?
+    return false if not File.exists?(@except) or FileTest.directory?(@except)
+    @blacklist = YAML.load(File.read(@except))
+    @blacklist.has_key?(:directories) and @blacklist.has_key?(:files)
+  end
+
+  def in_blacklist?(item)
+    if @blacklist
+      @blacklist[:directories].include?(item) or @blacklist[:files].include?(item)
+    end
+  end
+
+  def valid_directory?(dir)
+    File.exists?(dir) and FileTest.directory?(dir)
+  end
+
+  def valid_file?(file)
+    File.exists?(file) and FileTest.file?(file)
+  end
+
+  def read_files(path=nil)
+    @files ||= [] ; path ||= @from
+    Dir.foreach(path) do |item|
+      item_path = "#{path}/#{item}"
+      unless in_blacklist?(item)
+        if valid_directory?(item_path) and not ['.','..'].include?(item)
+          read_files(item_path)
+        elsif valid_file?(item_path)
+          content = processing_file(item_path)
+          @files << ["File: <strong>#{item_path}</strong>", content]
+        end
+      end
+    end
+    @files
+  end
+
+  def processing_file(file)
+    content = ''
+    File.open(file,'r') do |f|
+      f.each_line.with_index do |line_content,line_number|
+        # TODO: this line is ugly, need find a better way ;D
+        content << line_content.gsub(/</,'&lt;').gsub(/^/, "<color rgb='AAAAAA'>#{line_number+1}</color>  ")
+      end
+    end
+    content
   end
 end

data/lib/code2pdf/version.rb

@@ -1,3 +1,3 @@
 module Code2pdf
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/spec/code2pdf/convert_to_pdf_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'digest/md5'
+
+describe ConvertToPDF do
+  describe '#pdf' do
+    it 'should create a PDF file containing all desired source code' do
+      path      = 'spec/fixtures/hello_world'
+      pdf       = 'spec/fixtures/hello_world.pdf'
+      blacklist = 'spec/fixtures/hello_world/.code2pdf'
+      ConvertToPDF.new :from => path, :to => pdf, :except => blacklist
+      Digest::MD5.hexdigest(File.read(pdf)).should eq 'f0270dcebd0abc942739d3c83ad4b978'
+      File.delete pdf
+    end
+
+    it 'should verify if essential params are present' do
+      expect{ConvertToPDF.new(:foo => 'bar')}.to raise_error ArgumentError
+    end
+
+    it 'should verify if specified path exists' do
+      path = 'spec/fixtures/isto_non_existe_quevedo'
+      pdf  = 'spec/fixtures/isto_non_existe_quevedo.pdf'
+      expect{ConvertToPDF.new(:from => path, :to => pdf)}.to raise_error LoadError
+    end
+
+    it 'should verify if specified blacklist file is valid' do
+      path      = 'spec/fixtures/hello_world'
+      pdf       = 'spec/fixtures/hello_world.pdf'
+      blacklist = 'spec/fixtures/purplelist.yml'
+      expect{ConvertToPDF.new :from => path, :to => pdf, :except => blacklist}.to raise_error LoadError
+    end
+  end
+end

data/spec/fixtures/hello_world/.code2pdf

@@ -0,0 +1,7 @@
+:directories:
+  - doc
+:files:
+  - .DS_Store
+  - .code2pdf
+  - tmp.txt
+  - gambi.rb

data/spec/fixtures/hello_world/doc/HelloWorld.html

@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+	<title>Module: HelloWorld</title>
+
+	<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+	<script src="./js/jquery.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/thickbox-compressed.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/quicksearch.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/darkfish.js" type="text/javascript"
+		charset="utf-8"></script>
+
+</head>
+<body class="module">
+
+	<div id="metadata">
+		<div id="home-metadata">
+			<div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+			</div>
+		</div>
+
+		<div id="file-metadata">
+			<div id="file-list-section" class="section">
+				<h3 class="section-header">In Files</h3>
+				<div class="section-body">
+					<ul>
+					
+						<li><a href="./lib/gambi_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+							class="thickbox" title="lib/gambi.rb">lib/gambi.rb</a></li>
+					
+						<li><a href="./lib/goodbye_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+							class="thickbox" title="lib/goodbye.rb">lib/goodbye.rb</a></li>
+					
+						<li><a href="./lib/hello_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+							class="thickbox" title="lib/hello.rb">lib/hello.rb</a></li>
+					
+					</ul>
+				</div>
+			</div>
+
+			
+		</div>
+
+		<div id="class-metadata">
+
+			<!-- Parent Class -->
+			
+
+			<!-- Namespace Contents -->
+			
+			<div id="namespace-list-section" class="section">
+				<h3 class="section-header">Namespace</h3>
+				<ul class="link-list">
+					
+					<li><span class="type">CLASS</span> <a href="HelloWorld/Gambi.html">HelloWorld::Gambi</a></li>
+					
+					<li><span class="type">CLASS</span> <a href="HelloWorld/Goodbye.html">HelloWorld::Goodbye</a></li>
+					
+					<li><span class="type">CLASS</span> <a href="HelloWorld/Helo.html">HelloWorld::Helo</a></li>
+					
+				</ul>
+			</div>
+			
+
+			<!-- Method Quickref -->
+			
+
+			<!-- Included Modules -->
+			
+		</div>
+
+		<div id="project-metadata">
+			
+			
+			<div id="fileindex-section" class="section project-section">
+				<h3 class="section-header">Files</h3>
+				<ul>
+				
+					<li class="file"><a href="./tmp_txt.html">tmp.txt</a></li>
+				
+				</ul>
+			</div>
+			
+
+			<div id="classindex-section" class="section project-section">
+				<h3 class="section-header">Class Index
+					<span class="search-toggle"><img src="./images/find.png"
+						height="16" width="16" alt="[+]"
+						title="show/hide quicksearch" /></span></h3>
+				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+				<fieldset>
+					<legend>Quicksearch</legend>
+					<input type="text" name="quicksearch" value=""
+						class="quicksearch-field" />
+				</fieldset>
+				</form>
+
+				<ul class="link-list">
+				
+					<li><a href="./HelloWorld.html">HelloWorld</a></li>
+				
+					<li><a href="./HelloWorld/Gambi.html">HelloWorld::Gambi</a></li>
+				
+					<li><a href="./HelloWorld/Goodbye.html">HelloWorld::Goodbye</a></li>
+				
+					<li><a href="./HelloWorld/Helo.html">HelloWorld::Helo</a></li>
+				
+				</ul>
+				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
+			</div>
+
+			
+		</div>
+	</div>
+
+	<div id="documentation">
+		<h1 class="module">HelloWorld</h1>
+
+		<div id="description">
+			
+		</div>
+
+		<!-- Constants -->
+		
+
+		<!-- Attributes -->
+		
+
+		<!-- Methods -->
+		
+
+	</div>
+
+
+	<div id="rdoc-debugging-section-dump" class="debugging-section">
+	
+		<p>Disabled; run with --debug to generate this.</p>
+	
+	</div>
+
+	<div id="validator-badges">
+		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+			Rdoc Generator</a> 1.1.6</small>.</p>
+	</div>
+
+</body>
+</html>
+