code2pdf_rdeterre 0.4.2

data/lib/code2pdf.rb

@@ -0,0 +1,4 @@
+require 'yaml'
+require 'pdfkit'
+require 'code2pdf/convert_to_pdf'
+require 'rouge'

data/lib/code2pdf/convert_to_pdf.rb

@@ -0,0 +1,120 @@
+class ConvertToPDF
+  PDF_OPTIONS = {
+    page_size: 'A4'
+  }.freeze
+
+  def initialize(params = {})
+    if !params.key?(:from) || params[:from].nil?
+      raise ArgumentError.new 'where is the codebase you want to convert to PDF?'
+    elsif !valid_directory?(params[:from])
+      raise LoadError.new "#{params[:from]} not found"
+    elsif !params.key?(:to) || params[:to].nil?
+      raise ArgumentError.new 'where should I save the generated pdf file?'
+    else
+      @from, @to, @except = params[:from], params[:to], params[:except].to_s
+
+      if File.exist?(@except) && invalid_blacklist?
+        raise LoadError.new "#{@except} is not a valid blacklist YAML file"
+      end
+
+      save
+    end
+  end
+
+  private
+
+  def save
+    pdf.to_file(@to)
+  end
+
+  def pdf
+    html ||= ''
+
+    style = 'size: 12px; font-family: Helvetica, sans-serif;'
+
+    read_files.each do |file|
+      html += "<strong style='#{style}'>File: #{file.first}</strong></br></br>"
+      html += prepare_line_breaks(syntax_highlight(file)).to_s
+      html += add_space(30)
+    end
+
+    @kit = PDFKit.new(html, page_size: 'A4')
+    @kit
+  end
+
+  def syntax_highlight(file)
+    file_type = File.extname(file.first)[1..-1]
+    file_lexer = Rouge::Lexer.find(file_type)
+    return file.last unless file_lexer
+
+    theme = Rouge::Themes::Base16.mode(:light)
+    formatter = Rouge::Formatters::HTMLInline.new(theme)
+    formatter = Rouge::Formatters::HTMLTable.new(formatter, start_line: 1)
+    formatter.format(file_lexer.lex(file.last))
+  end
+
+  def invalid_blacklist?
+    return true if FileTest.directory?(@except)
+
+    @blacklist = YAML.load_file(@except)
+
+    !@blacklist.key?(:directories) || !@blacklist.key?(:files)
+  end
+
+  def in_directory_blacklist?(item_path)
+    @blacklist[:directories].include?(item_path.gsub("#{@from}/", '')) if @blacklist
+  end
+
+  def in_file_blacklist?(item_path)
+    if @blacklist
+      @blacklist[:files].include?(item_path.split('/').last) || @blacklist[:files].include?(item_path.gsub("#{@from}/", ''))
+    end
+  end
+
+  def valid_directory?(dir)
+    File.exist?(dir) && FileTest.directory?(dir)
+  end
+
+  def valid_file?(file)
+    File.exist?(file) && FileTest.file?(file)
+  end
+
+  def read_files(path = nil)
+    @files ||= []
+    path   ||= @from
+
+    Dir.foreach(path) do |item|
+      item_path = "#{path}/#{item}"
+
+      if valid_directory?(item_path) && !%w[. ..].include?(item) && !in_directory_blacklist?(item_path)
+        read_files(item_path)
+      elsif valid_file?(item_path) && !in_file_blacklist?(item_path)
+        @files << [item_path, process_file(item_path)]
+      end
+    end
+
+    @files
+  end
+
+  def process_file(file)
+    puts "Reading file #{file}"
+
+    content = ''
+    File.open(file, 'r') do |f|
+      if `file #{file}` !~ /text/
+        content << "<color rgb='777777'>[binary]</color>"
+      else
+        f.each_line { |line_content| content << line_content }
+      end
+    end
+    content.encode("utf-8", invalid: :replace, undef: :replace)
+  end
+
+  def prepare_line_breaks(content)
+    content.gsub(/\n/, '<br>')
+  end
+
+  def add_space(height)
+    "<div style='margin-bottom: #{height}px'>&nbsp;</div>"
+  end
+end

data/lib/code2pdf/version.rb

@@ -0,0 +1,3 @@
+module Code2pdf
+  VERSION = '0.4.2'.freeze
+end

data/spec/code2pdf/convert_to_pdf_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'digest/md5'
+require 'pdf/inspector'
+
+describe ConvertToPDF do
+  after do
+    pdf = 'spec/fixtures/hello_world.pdf'
+    File.delete(pdf) if File.exist?(pdf)
+  end
+
+  describe '#pdf' do
+    it 'creates a PDF file containing all desired source code' do
+      path = 'spec/fixtures/hello_world'
+      pdf = 'spec/fixtures/hello_world_output.pdf'
+      original = 'spec/fixtures/hello_world_original.pdf'
+      blacklist = 'spec/fixtures/hello_world/.code2pdf'
+
+      ConvertToPDF.new from: path, to: pdf, except: blacklist
+      text_analysis = read_strings("#{Dir.pwd}/#{pdf}")
+      text_analysis_original = read_strings("#{Dir.pwd}/#{original}")
+      expect(text_analysis).to eq(text_analysis_original)
+      File.delete(pdf)
+    end
+
+    it 'raises an error if required params are not present' do
+      expect { ConvertToPDF.new(foo: 'bar') }.to raise_error(ArgumentError)
+    end
+
+    it 'raises an error if path does not exist' 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 'raises an error if blacklist file is not 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
+
+  describe '#prepare_line_breaks' do
+    let :pdf do
+      ConvertToPDF.new from: 'spec/fixtures/hello_world', to: 'spec/fixtures/hello_world.pdf'
+    end
+
+    it 'converts strings with \n to <br> for PDF generation' do
+      test_text = "test\ntest"
+      expect(pdf.send(:prepare_line_breaks, test_text)).to eq('test<br>test')
+    end
+  end
+
+  describe '#syntax_highlight' do
+    let :pdf do
+      ConvertToPDF.new from: 'spec/fixtures/hello_world', to: 'spec/fixtures/hello_world.pdf'
+    end
+
+    it 'returns file with syntax_highlight html clases' do
+      path = 'spec/fixtures/hello_world/lib/hello.rb'
+      output = File.read('spec/fixtures/syntax_highlight.html')
+      content = pdf.send(:process_file, path)
+      file = [path, content]
+      expect(pdf.send(:syntax_highlight, file)).to eq(output)
+    end
+  end
+end
+
+def read_strings(file)
+  PDF::Inspector::Text.analyze(File.read(file)).strings
+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>
+

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

@@ -0,0 +1,150 @@
+<?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>Class: HelloWorld::Gambi</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="class">
+
+	<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>
+					
+					</ul>
+				</div>
+			</div>
+
+			
+		</div>
+
+		<div id="class-metadata">
+
+			<!-- Parent Class -->
+			
+			<div id="parent-class-section" class="section">
+				<h3 class="section-header">Parent</h3>
+				
+				<p class="link">Object</p>
+				
+			</div>
+			
+
+			<!-- Namespace Contents -->
+			
+
+			<!-- 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="class">HelloWorld::Gambi</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>
+