jekyll-pdf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4cf106be791a9f308c0de674aed203c8ecd1ef8
-  data.tar.gz: 571837054e5dbddfeed124ec363423f76ed1304c
+  metadata.gz: f528a86edb39066d05296d4e90d9daec587fbe3a
+  data.tar.gz: d7bae1c70e0528ce1b2db37637a0d50c3e8c8d29
 SHA512:
-  metadata.gz: 000375ef0c4fc01bca89baf80411b00abddb0fb4c900ef9c7d7422a61dfd65c8ef8283b07d3ba955bb51fbc22254c5f6b5101bbc663ceb067758e3e379174784
-  data.tar.gz: 6c5309d325532b122926cd6da99eca07215f990b9fc3a97d3aac6a972622b2737a35d1a8e91c97570c6459c8e755e5a4fcad80903b3bfb242e48828c944ca177
+  metadata.gz: 8799316ad79950136609dc1ec7a2040a81f50462d9d22692ce504f4fde00b7ae46ce1900b9b8d11980a08381b4d792514e28aaf4385be238bf65dd099a3dddf3
+  data.tar.gz: 52d509a1be9525b904a393838f4b50c44d808a3df5de4f25833283ba4bcb03aabd7c43db1c39ce289f7ef7d8e9d3f5cbdaa42020cf05ff670f2fed589f5a10e6

data/Gemfile

@@ -1,9 +1,8 @@
 source "https://rubygems.org"
+gemspec
 
-gem 'wkhtmltopdf-installer'
-gem 'pdfkit'
-gem 'digest'
-gem 'activesupport'
+group :test do
+  gem "rake"
+end
 
-
-gem "jekyll-assets", "~> 2.0.0", :require => false
+gem "jekyll-assets", "~> 2.2", :require => false

data/README.md

@@ -2,27 +2,38 @@
 
 Dynamically generate PDFs from Jekyll pages, posts & documents.
 
-## Using Jekyll Assets with Jekyll
+[![Build Status](https://travis-ci.org/abeMedia/jekyll-pdf.svg?branch=master)](https://travis-ci.org/abeMedia/jekyll-pdf)
+[![Dependency Status](https://gemnasium.com/badges/github.com/abeMedia/jekyll-pdf.svg)](https://gemnasium.com/github.com/abeMedia/jekyll-pdf)
 
-Add `gem "jekyll-pdf"` to your `Gemfile` and add `jekyll-pdf` to your `_config.yml` like the following:
+## Usage
+
+Add `gem "jekyll-pdf"` to your `Gemfile` and run `bundle`, then add `jekyll-pdf` to your `_config.yml` like so:
 
 ```yaml
 gems:
   - jekyll-pdf
 ```
 
-Now add the following to any page's or document's front-matter, that you'd like to create a PDF version of. 
+Now add `pdf: true` to any page's or document's front-matter, that you'd like to create a PDF version of.
+
+To activate **Jekyll PDF** for multiple pages or entire collections you can use Jekyll's [front-matter defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults). The following example will create PDFs for each post in your blog.
 
 ```yaml
-pdf: true
+defaults:
+  -
+    scope:
+      path: ""
+      type: "posts"
+    values:
+      pdf: true
 ```
 
-To activate **Jekyll PDF** for multiple pages or entire collections you can use Jekyll's [front-matter defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults).
+Link to the PDF using the `{{ page.pdf_url }}` liquid variable.
 
 
 ## Configuration
 
-**Jekyll PDF** uses [wkhtmltopdf](http://wkhtmltopdf.org/) to generate the PDFs. For a full list of configuration parameters it supports see http://wkhtmltopdf.org/usage/wkhtmltopdf.txt
+**Jekyll PDF** supports any configuration parameters [wkhtmltopdf](http://wkhtmltopdf.org/) does. For a full list of configuration parameters it supports see http://wkhtmltopdf.org/usage/wkhtmltopdf.txt
 
 ```yaml
 pdf:
@@ -31,32 +42,64 @@ pdf:
   layout: layout | default: pdf
 ```
 
-## PDF Layouts
+All configuration parameters (with exception of `cache`) can be overridden from your page's or it's PDF layout's front-matter.
+
+### Cache Folder
+
+If Jekyll Assets is installed, Jekyll PDF will automatically use the same cache folder as Jekyll Assets (unless specified otherwise).
+
+## Layouts
 
 **Jekyll PDF** will check for your current layout suffixed with `_pdf` e.g. if you're using a layout called `post`, it will look for `_layouts/post_pdf.html`, falling back to your default PDF layout (usually `_layouts/pdf.html`). 
 
-To override this add the `pdf_layout` variable to your page's YAML front-matter. For example:
+To override this behaviour, add the `pdf_layout` variable to your page's YAML front-matter. For example:
 
 ```yaml
 pdf_layout: my_custom_pdf_layout
 ```
 
-## Partials - Headers, Footers & Covers
+## Partials (Header, Footer & Cover Page)
 
-We'll automatically look for all partials in `_includes` directory, e.g. `header_html: pdf_header.html` will tell Jekyll PDF use `_includes/pdf_header.html`. Please note that wkhtmltopdf requires all partials to be valid HTML documents (including DOCTYPE).
+We'll automatically look for all partials in `_includes` directory, e.g. `header_html: pdf_header.html` will tell Jekyll PDF use `_includes/pdf_header.html`. 
 
-## Cache Folder
+Please note that wkhtmltopdf requires all partials to be valid HTML documents for example:
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/css/bootstrap.css">
+</head>
+<body>
+  Page {{ page.pdf.page }} of {{ page.pdf.topage }}
+</body>
+</html>
+```
+
+### Supported header & footer variables
+
+| Liquid                         | Description                                                 |
+|--------------------------------|-------------------------------------------------------------|
+| `{{ page.pdf.page }}`          | Replaced by the number of the pages currently being printed |
+| `{{ page.pdf.topage }}`        | Replaced by the number of the last page to be printed       |
+| `{{ page.pdf.section }}`       | Replaced by the content of the current h1 tag               |
+| `{{ page.pdf.subsection }}`    | Replaced by the content of the current h2 tag               |
+| `{{ page.pdf.subsubsection }}` | Replaced by the content of the current h3 tag               |
 
-If Jekyll Assets is installed, Jekyll PDF will automatically use the same cache folder as Jekyll Assets unless specified otherwise.
 
 ## Troubleshooting
 
-### Resources aren't included in the PDF
+### Images aren't displaying in the PDF
+
+If your images aren't displaying in the PDF, this is most likely due to the fact that wkhtmltopdf doesn't know where to look. Try prefixing your image URLs with `file://{{ site.dest }}`.  
+For asset URLs in CSS files we recommend creating a separate CSS file overriding the URLs with the prefix mentioned above.
 
-If your Images, CSS, or JavaScript aren't displaying in the PDF, this is most likely due to the fact that wkhtmltopdf doesn't know where to look. Try prefixing your asset URLs with `file://{{ site.dest }}`. For asset URLs in CSS files we recommend creating a separate CSS file overriding the URLs will the mentioned prefix.
+---
 
 ## To Do
 
-- Support layouts in partials
-- Default PDF layout file in Gem
-- Write tests
+- Remove dependencies for ActiveSupport & PDFKit
+- Write tests (rspec)
+- Package default PDF layout file in Gem
+- Support layouts in partials

data/lib/jekyll/pdf/document.rb

@@ -1,5 +1,4 @@
 require 'pdfkit'
-require 'active_support/core_ext/hash/deep_merge'
     
 module Jekyll
   module PDF
@@ -22,7 +21,7 @@ module Jekyll
         self.data['layout'] = layout
         
         # Get PDF settings from the layouts
-        @settings = (site.config['pdf'] || {}).deep_merge(self.getConfig(self.data))
+        Jekyll::Utils.deep_merge_hashes!(@settings, self.getConfig(self.data))
         
         PDFKit.configure do |config|
           config.verbose = site.config['verbose']
@@ -50,7 +49,8 @@ module Jekyll
         return settings if layout == nil
         
         # Merge settings with parent layout settings
-        layout['pdf'] = (layout['pdf'] || {}).deep_merge(settings)
+        layout['pdf'] ||= {}
+        Jekyll::Utils.deep_merge_hashes!(layout['pdf'], settings)
         
         return self.getConfig(layout)
       end

data/lib/jekyll/pdf/helper.rb

@@ -2,8 +2,7 @@ module Jekyll
   module PDF
     module Helper
       def fix_relative_paths
-        prefix = "file://#{site.dest}/"
-        output = output.gsub(/(href|src)=(['"])\/([^\/"']([^\"']*|[^"']*))?['"]/, "\\1=\\2#{prefix}\\3\\2")
+        output.gsub!(/(href|src)=(['"])\/([^\/"']([^\"']*|[^"']*))?['"]/, "\\1=\\2file://#{site.dest}/\\3\\2") if output != nil
       end
     end
   end

data/lib/jekyll/pdf/hooks.rb

@@ -2,7 +2,7 @@
 Jekyll::Hooks.register :site, :post_write do |jekyll, payload|
   if jekyll.data[:jekyll_pdf_partials]
     jekyll.data[:jekyll_pdf_partials].each do |partial|
-      partial.clean
+      File.delete(partial) if File.exist?(partial)
     end
     jekyll.data.delete(:jekyll_pdf_partials)
   end

data/lib/jekyll/pdf/partial.rb

@@ -42,8 +42,7 @@ module Jekyll
         File.join(doc.path, partial)
       end
       
-      # Returns the file name for the temporary file
-      def filename
+      def id
         File.basename(path, File.extname(path)) + "-" + Digest::MD5.hexdigest(to_s) + File.extname(path)
       end
       
@@ -74,19 +73,16 @@ module Jekyll
       
       # generate temp file & set output to it's path
       def write
-        tempfile = File.join(dir, filename)
+        tempfile = File.absolute_path(File.join(dir, id))
         unless File.exist?(tempfile)
           FileUtils.mkdir_p(File.dirname(tempfile)) unless File.exist?(File.dirname(tempfile))
           File.open(tempfile, 'w') {|f| f.write(to_s) }
         end
-        site.data[:jekyll_pdf_partials] ||= []
-        site.data[:jekyll_pdf_partials] << self
         @output = tempfile
-      end
-      
-      # delete temp file
-      def clean
-        File.delete(@output)
+        
+        # store path for cleanup
+        site.data[:jekyll_pdf_partials] ||= []
+        site.data[:jekyll_pdf_partials] << "#{self}"
       end
   
       def place_in_layout?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Bouqdib
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wkhtmltopdf-installer
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -86,20 +72,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement