code2pdf 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4941f0a5f601ad6095ff1974786411e65b1a77cc
-  data.tar.gz: 61cde353d6a96c7181475fc1ad065660b0ade4e8
+  metadata.gz: cbd789fcae0b1e9a87bcbaf2a4cfd857e3f9530f
+  data.tar.gz: 995d1ba8d9cd25dc87f2bac42a5a46a0122f9430
 SHA512:
-  metadata.gz: ebb4244b65d10af3ae6f7e9ed142f66f8fa7df8922a41a673c5252c27656e3ad9bb63c3e1a235a95f9b0ea81f3dd6a4848e2721cead6d7e2e55c905c19d4c297
-  data.tar.gz: fd7fa00878664bc894745801f962ca868cefa9f6c7a718aaac0d2c15f669fec3c17d7ee02fe674617146ffb7a128cf4c90c70a5d1a2da08a7610caef0b5c3693
+  metadata.gz: 5e2226893a3293c0de832211e1694a133103286d8f949eb17b93423107ee4f461b614c89d428f8d165132edc51cbeeea6f41deb41ba707e359411f56890ebbd0
+  data.tar.gz: 4ec7dc0b1fdbe3b5013f79ed566fcd3b62b6bbe8f5e19e6a439d61d7cfa3428149df56d8db8ee22f93c3fc444ab80e5101b42b4e15b5835413ac0251db7d792b

data/Gemfile.lock

@@ -1,39 +1,50 @@
 PATH
   remote: .
   specs:
-    code2pdf (0.3.1)
-      prawn
+    code2pdf (0.4.1)
+      pdfkit
+      rouge
+      wkhtmltopdf-binary
 
 GEM
   remote: http://rubygems.org/
   specs:
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    method_source (0.8.2)
-    pdf-core (0.6.1)
-    prawn (2.1.0)
-      pdf-core (~> 0.6.1)
-      ttfunk (~> 1.4.0)
-    pry (0.10.4)
+    Ascii85 (1.0.2)
+    afm (0.2.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    hashery (2.1.2)
+    method_source (0.9.0)
+    pdf-inspector (1.3.0)
+      pdf-reader (>= 1.0, < 3.0.a)
+    pdf-reader (2.0.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    pdfkit (0.8.2)
+    pry (0.11.1)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (11.2.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+      method_source (~> 0.9.0)
+    rake (12.1.0)
+    rouge (3.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    slop (3.6.0)
-    ttfunk (1.4.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby-rc4 (0.1.5)
+    ttfunk (1.5.1)
+    wkhtmltopdf-binary (0.12.3.1)
 
 PLATFORMS
   ruby
@@ -41,9 +52,10 @@ PLATFORMS
 DEPENDENCIES
   bundler
   code2pdf!
+  pdf-inspector
   pry
   rake
   rspec
 
 BUNDLED WITH
-   1.12.5
+   1.15.4

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,8 @@
-Copyright (c) 2011 Lucas Caton
+LICENSE
+
+The MIT License
+
+Copyright (c) 2011-2017 Lucas Caton
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,7 @@
 # code2pdf
 
+[![Gem Version](https://badge.fury.io/rb/code2pdf.svg)](https://rubygems.org/gems/code2pdf)
+
 **code2pdf** is a simple tool for convert your source code to a PDF file.
 
 It can be useful if you need to licence you software.
@@ -47,4 +49,4 @@ The blacklist file must be a yaml file named `.code2pdf`, placed in project root
 
 ## Copyright
 
-Copyright © 2011 Lucas Caton. See LICENSE.txt for further details.
+Copyright © 2011-2017 Lucas Caton. See LICENSE for further details.

data/code2pdf.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.name                  = 'code2pdf'
   gem.summary               = 'Convert your source code to PDF'
   gem.description           = 'Convert your source code to PDF'
-  gem.authors               = %w(Lucas Caton)
+  gem.authors               = ['Lucas Caton']
   gem.platform              = Gem::Platform::RUBY
   gem.version               = Code2pdf::VERSION
   gem.required_ruby_version = '>= 2.0.0'
@@ -13,9 +13,12 @@ Gem::Specification.new do |gem|
   gem.executables           = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths         = %w(lib)
 
-  gem.add_dependency 'prawn'
+  gem.add_dependency 'pdfkit'
+  gem.add_dependency 'wkhtmltopdf-binary'
+  gem.add_dependency 'rouge'
   gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pdf-inspector'
 end

data/lib/code2pdf.rb

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

data/lib/code2pdf/convert_to_pdf.rb

@@ -3,7 +3,7 @@ class ConvertToPDF
     page_size: 'A4'
   }
 
-  def initialize(params={})
+  def initialize(params = {})
     if !params.has_key?(:from) || params[:from].nil?
       raise ArgumentError.new 'where is the codebase you want to convert to PDF?'
     elsif !valid_directory?(params[:from])
@@ -11,11 +11,10 @@ class ConvertToPDF
     elsif !params.has_key?(:to) || params[:to].nil?
       raise ArgumentError.new 'where should I save the generated pdf file?'
     else
-      @from, @to = params[:from], params[:to]
+      @from, @to, @except = params[:from], params[:to], params[:except].to_s
 
-      if params.has_key?(:except)
-        @except = params[:except]
-        raise LoadError.new "#{@except} is not a valid blacklist YAML file" unless valid_blacklist?
+      if File.exists?(@except) && invalid_blacklist?
+        raise LoadError.new "#{@except} is not a valid blacklist YAML file"
       end
 
       save
@@ -24,32 +23,42 @@ class ConvertToPDF
 
   private
 
+  def save
+    pdf.to_file(@to)
+  end
+
   def pdf
-    Prawn::Document.new PDF_OPTIONS do |pdf|
-      read_files.each do |file|
-        puts "Converting to PDF: #{file.first}"
-
-        pdf.font 'Courier' do
-          pdf.text "<strong>File: #{file.first}</strong>", size: 12, inline_format: true
-          pdf.move_down 20
-          pdf.text file.last, size: 12, inline_format: true
-          pdf.move_down 40
-        end
-      end
+    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 save
-    pdf.render_file @to
+  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 valid_blacklist?
-    return false if FileTest.directory?(@except)
+  def invalid_blacklist?
+    return true if FileTest.directory?(@except)
 
-    return true unless File.exists?(@except)
+    @blacklist = YAML.load_file(@except)
 
-    @blacklist = YAML.load(File.read(@except))
-    @blacklist.has_key?(:directories) && @blacklist.has_key?(:files)
+    !@blacklist.has_key?(:directories) || !@blacklist.has_key?(:files)
   end
 
   def in_directory_blacklist?(item_path)
@@ -77,13 +86,10 @@ class ConvertToPDF
     Dir.foreach(path) do |item|
       item_path = "#{path}/#{item}"
 
-      if valid_directory?(item_path) && !['.', '..'].include?(item)
-        read_files(item_path) unless in_directory_blacklist?(item_path)
-      elsif valid_file?(item_path)
-        unless in_file_blacklist?(item_path)
-          content = process_file(item_path)
-          @files << [item_path, content]
-        end
+      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
 
@@ -99,10 +105,18 @@ class ConvertToPDF
         content << "<color rgb='777777'>[binary]</color>"
       else
         f.each_line.with_index do |line_content, line_number|
-          content << line_content.gsub(/</,'&lt;').gsub(/^/, "<color rgb='AAAAAA'>#{line_number + 1}</color>  ")
+          content << line_content
         end
       end
     end
     content
   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

@@ -1,3 +1,3 @@
 module Code2pdf
-  VERSION = '0.3.1'
+  VERSION = '0.4.1'.freeze
 end

data/spec/code2pdf/convert_to_pdf_spec.rb

@@ -1,15 +1,24 @@
 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.pdf'
+      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
-      expect(Digest::MD5.hexdigest(File.read(pdf))).to eq('e8c7066d59eb2097fc8900d1a8bc386b')
+      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
 
@@ -32,4 +41,33 @@ describe ConvertToPDF do
       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/syntax_highlight.html

@@ -0,0 +1,15 @@
+<table class="rouge-table"><tbody><tr><td class="rouge-gutter gl"><pre class="lineno">1
+2
+3
+4
+5
+6
+7
+</pre></td><td class="rouge-code"><pre><span style="color: #aa759f">module</span> <span style="color: #f4bf75">HelloWorld</span>
+  <span style="color: #aa759f">class</span> <span style="color: #f4bf75">Helo</span>
+    <span style="color: #aa759f">def</span> <span style="color: #303030">say</span><span style="color: #d0d0d0">(</span><span style="color: #303030">name</span><span style="color: #d0d0d0">)</span>
+      <span style="color: #90a959">"Hi, </span><span style="color: #8f5536">#{</span><span style="color: #303030">name</span><span style="color: #8f5536">}</span><span style="color: #90a959">!"</span>
+    <span style="color: #aa759f">end</span>
+  <span style="color: #aa759f">end</span>
+<span style="color: #aa759f">end</span>
+</pre></td></tr></tbody></table>

data/spec/spec_helper.rb

@@ -1,2 +1,10 @@
-$:.push File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
 require 'code2pdf'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,18 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: code2pdf
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
-- Lucas
-- Caton
+- Lucas Caton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: prawn
+  name: pdfkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wkhtmltopdf-binary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Convert your source code to PDF
 email: 
 executables:
@@ -92,7 +133,7 @@ files:
 - ".rspec"
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/code2pdf
@@ -118,7 +159,9 @@ files:
 - spec/fixtures/hello_world/lib/goodbye.rb
 - spec/fixtures/hello_world/lib/hello.rb
 - spec/fixtures/hello_world/tmp.txt
+- spec/fixtures/hello_world_original.pdf
 - spec/fixtures/purplelist.yml
+- spec/fixtures/syntax_highlight.html
 - spec/spec_helper.rb
 homepage: 
 licenses: []
@@ -139,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Convert your source code to PDF