wicked_pdf 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54d0ec248323c907fe336b0dea9afff757737f6d
-  data.tar.gz: 35626a59f71132ef14fb866f453e23998e1c1982
+  metadata.gz: dd7dae1230ac2e120e6ca1cb235a8f21465df966
+  data.tar.gz: c66399843e25433bc83ac7970ff392f2a217bf95
 SHA512:
-  metadata.gz: 41d0c2d5e21c6b1086c425e0e4ebe65f09421694f054435b0d97d9d10622dd493a6dc89c606bbbe6afe9a6261a7639d1545efeb7a0faae1d157518c8e6654886
-  data.tar.gz: 38cf8a6e92c561713effa3e3f28259a19b8252f9d9810b46f9ee6c31801f895ffbe229748ad10dc81bd215c2db79b78aba8896fbdb81a735d0813c30d83ac077
+  metadata.gz: 86a57ed7f58c19916f48c8cfc98074c5e6cb3ca060c1563abbb2c62e2c0eecefeaba635502ece68c870be7b4049422ef7fd326d59507a6a8709d3938def96491
+  data.tar.gz: e97feccdf135d2e74d2d14e9ba1e944c130ed631c27a2f18c46e5be1f6804ac439e75755a0a3ddeffffe877d33547c07c76f13980b5b42d0eda45f243f98e399

data/.gitignore

@@ -16,6 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 *.swp
-test/dummy/log/*.log
+test/dummy/**/*
 gemfiles/*.lock
 .DS_Store

data/.travis.yml

@@ -1,15 +1,17 @@
 language:
   - ruby
 bundler_args: --verbose
-rvm:  
+rvm:
   - 1.9.2
   - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - 2.2
 gemfile:
   - gemfiles/3.0.gemfile
   - gemfiles/3.1.gemfile
   - gemfiles/3.2.gemfile
-before_script: 
+before_script:
   - bundle list
   - sudo apt-get install -y wkhtmltopdf
   - "export DISPLAY=:99.0"
@@ -33,8 +35,16 @@ matrix:
       gemfile: gemfiles/4.0.gemfile
     - rvm: 2.0.0
       gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.2.0
+      gemfile: gemfiles/4.1.gemfile
+    - rvm: 2.2.0
+      gemfile: gemfiles/4.2.gemfile
+    - rvm: 2.2.0
+      gemfile: gemfiles/rails_edge.gemfile
   allow_failures:
     - rvm: 1.9.3
       gemfile: gemfiles/rails_edge.gemfile
     - rvm: 2.0.0
       gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.2.0
+      gemfile: gemfiles/rails_edge.gemfile

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,54 +1,49 @@
-# Wicked PDF [![Build Status](https://secure.travis-ci.org/mileszs/wicked_pdf.png)](http://travis-ci.org/mileszs/wicked_pdf)
+# Wicked PDF [![Build Status](https://secure.travis-ci.org/mileszs/wicked_pdf.png)](http://travis-ci.org/mileszs/wicked_pdf) [![Gem Version](https://badge.fury.io/rb/wicked_pdf.svg)](http://badge.fury.io/rb/wicked_pdf)
 
 ## A PDF generation plugin for Ruby on Rails
 
-Wicked PDF uses the shell utility [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) to serve a PDF file to a user from HTML.  In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, then let Wicked take care of the hard stuff.
+Wicked PDF uses the shell utility [wkhtmltopdf](http://wkhtmltopdf.org) to serve a PDF file to a user from HTML.  In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, then let Wicked PDF take care of the hard stuff.
 
-_Wicked PDF has been verified to work on Ruby 1.8.7 and 1.9.2; Rails 2 and Rails 3_
+_Wicked PDF has been verified to work on Ruby versions 1.8.7 through 2.1; Rails 2 through 4.1_
 
 ### Installation
 
-First, be sure to install [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/).
-
-One simple way to install all of the binaries (Linux, OSX, Windows) is through the gem [wkhtmltopdf-binary](https://github.com/steerio/wkhtmltopdf-binary).
-To install, simply add
+Add this to your Gemfile and run `bundle install`:
 
 ```ruby
-gem 'wkhtmltopdf-binary'
+gem 'wicked_pdf'
 ```
 
-To your Gemfile.
+Then create the initializer with
 
-If your wkhtmltopdf executable is not on your webserver's path, configure it in an initializer:
+    rails generate wicked_pdf
 
+You may also need to add
 ```ruby
-WickedPdf.config = {
-  :exe_path => '/usr/local/bin/wkhtmltopdf'
-}
+Mime::Type.register "application/pdf", :pdf
 ```
-Note that versions before 0.9.0 [have problems](http://code.google.com/p/wkhtmltopdf/issues/detail?id=82&q=vodnik) on some machines with reading/writing to streams.
-This plugin relies on streams to communicate with wkhtmltopdf.
-
-For more information about wkhtmltopdf, see the project's [homepage](http://code.google.com/p/wkhtmltopdf/) and
-[github repo](https://github.com/antialize/wkhtmltopdf). There's also some documentation for a recent, stable version
-on the author's website, [here](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf-0.9.9-doc.html).
-
-Next:
+to `config/initializers/mime_types.rb` in older versions of Rails.
 
-    script/plugin install git://github.com/mileszs/wicked_pdf.git
-    script/generate wicked_pdf
+Because `wicked_pdf` is a wrapper for  [wkhtmltopdf](http://wkhtmltopdf.org/), you'll need to install that, too.
 
-or add this to your Gemfile:
+The simplest way to install all of the binaries (Linux, OSX, Windows) is through the gem [wkhtmltopdf-binary](https://github.com/steerio/wkhtmltopdf-binary).
+To install that, add a second gem
 
 ```ruby
-gem 'wicked_pdf'
+gem 'wkhtmltopdf-binary'
 ```
 
-You may also need to add
+To your Gemfile and run `bundle install`.
+
+If your wkhtmltopdf executable is not on your webserver's path, you can configure it in an initializer:
+
 ```ruby
-Mime::Type.register "application/pdf", :pdf
+WickedPdf.config = {
+  exe_path: '/usr/local/bin/wkhtmltopdf'
+}
 ```
-to `config/initializers/mime_types.rb`
+
+For more information about `wkhtmltopdf`, see the project's [homepage](http://wkhtmltopdf.org/).
 
 ### Basic Usage
 ```ruby
@@ -57,7 +52,7 @@ class ThingsController < ApplicationController
     respond_to do |format|
       format.html
       format.pdf do
-        render :pdf => "file_name"
+        render pdf: "file_name"   # Excluding ".pdf" extension.
       end
     end
   end
@@ -69,11 +64,10 @@ The wkhtmltopdf binary is run outside of your Rails application; therefore, your
 
 #### wicked_pdf helpers
 ```html
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!doctype html>
+<html>
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <meta charset='utf-8' />
     <%= wicked_pdf_stylesheet_link_tag "pdf" -%>
     <%= wicked_pdf_javascript_include_tag "number_pages" %>
   </head>
@@ -91,8 +85,8 @@ The wkhtmltopdf binary is run outside of your Rails application; therefore, your
 
 In this case, you can use that standard Rails helpers and point to the current CDN for whichever framework you are using. For jQuery, it would look somethng like this, given the current versions at the time of this writing.
 ```html
-    <!DOCTYPE...
-    <html...
+    <!doctype html>
+    <html>
       <head>
         <%= javascript_include_tag "http://code.jquery.com/jquery-1.10.0.min.js" %>
         <%= javascript_include_tag "http://code.jquery.com/ui/1.10.3/jquery-ui.min.js" %>
@@ -110,104 +104,112 @@ class ThingsController < ApplicationController
     respond_to do |format|
       format.html
       format.pdf do
-        render :pdf                            => 'file_name',
-               :disposition	                   => 'attachment',                 # default 'inline'
-               :template                       => 'things/show.pdf.erb',
-               :file                           => "#{Rails.root}/files/foo.erb"
-               :layout                         => 'pdf.html',                   # use 'pdf.html' for a pdf.html.erb file
-               :wkhtmltopdf                    => '/usr/local/bin/wkhtmltopdf', # path to binary
-               :show_as_html                   => params[:debug].present?,      # allow debugging based on url param
-               :orientation                    => 'Landscape',                  # default Portrait
-               :page_size                      => 'A4, Letter, ...',            # default A4
-               :save_to_file                   => Rails.root.join('pdfs', "#{filename}.pdf"),
-               :save_only                      => false,                        # depends on :save_to_file being set first
-               :proxy                          => 'TEXT',
-               :basic_auth                     => false                         # when true username & password are automatically sent from session
-               :username                       => 'TEXT',
-               :password                       => 'TEXT',
-               :cover                          => 'URL, Pathname, or raw HTML string',
-               :dpi                            => 'dpi',
-               :encoding                       => 'TEXT',
-               :user_style_sheet               => 'URL',
-               :cookie                         => ['_session_id SESSION_ID'], # could be an array or a single string in a 'name value' format
-               :post                           => ['query QUERY_PARAM'],      # could be an array or a single string in a 'name value' format
-               :redirect_delay                 => NUMBER,
-               :javascript_delay               => NUMBER,
-               :image_quality                  => NUMBER,
-               :zoom                           => FLOAT,
-               :page_offset                    => NUMBER,
-               :javascript_delay               => NUMBER,
-               :book                           => true,
-               :default_header                 => true,
-               :disable_javascript             => false,
-               :grayscale                      => true,
-               :lowquality                     => true,
-               :enable_plugins                 => true,
-               :disable_internal_links         => true,
-               :disable_external_links         => true,
-               :print_media_type               => true,
-               :disable_smart_shrinking        => true,
-               :use_xserver                    => true,
-               :no_background                  => true,
-               :viewport_size                  => 'TEXT'                    # available only with use_xserver or patched QT
-               :extra                          => ''                        # directly inserted into the command to wkhtmltopdf
-               :margin => {:top                => SIZE,                     # default 10 (mm)
-                           :bottom             => SIZE,
-                           :left               => SIZE,
-                           :right              => SIZE},
-               :header => {:html => { :template => 'users/header.pdf.erb',  # use :template OR :url
-                                      :layout   => 'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
-                                      :url      => 'www.example.com',
-                                      :locals   => { :foo => @bar }},
-                           :center             => 'TEXT',
-                           :font_name          => 'NAME',
-                           :font_size          => SIZE,
-                           :left               => 'TEXT',
-                           :right              => 'TEXT',
-                           :spacing            => REAL,
-                           :line               => true,
-                           :content            => 'HTML CONTENT ALREADY RENDERED'}, # optionally you can pass plain html already rendered (useful if using pdf_from_string)
-               :footer => {:html => { :template => 'shared/footer.pdf.erb', # use :template OR :url
-                                      :layout   => 'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
-                                      :url      => 'www.example.com',
-                                      :locals   => { :foo => @bar }},
-                           :center             => 'TEXT',
-                           :font_name          => 'NAME',
-                           :font_size          => SIZE,
-                           :left               => 'TEXT',
-                           :right              => 'TEXT',
-                           :spacing            => REAL,
-                           :line               => true,
-                           :content            => 'HTML CONTENT ALREADY RENDERED'}, # optionally you can pass plain html already rendered (useful if using pdf_from_string)
-               :toc    => {:font_name          => "NAME",
-                           :depth              => LEVEL,
-                           :header_text        => "TEXT",
-                           :header_fs          => SIZE,
-                           :l1_font_size       => SIZE,
-                           :l2_font_size       => SIZE,
-                           :l3_font_size       => SIZE,
-                           :l4_font_size       => SIZE,
-                           :l5_font_size       => SIZE,
-                           :l6_font_size       => SIZE,
-                           :l7_font_size       => SIZE,
-                           :l1_indentation     => NUM,
-                           :l2_indentation     => NUM,
-                           :l3_indentation     => NUM,
-                           :l4_indentation     => NUM,
-                           :l5_indentation     => NUM,
-                           :l6_indentation     => NUM,
-                           :l7_indentation     => NUM,
-                           :no_dots            => true,
-                           :disable_links      => true,
-                           :disable_back_links => true},
-               :outline => {:outline           => true,
-                            :outline_depth     => LEVEL}
+        render pdf:                            'file_name',
+               disposition:                    'attachment',                 # default 'inline'
+               template:                       'things/show.pdf.erb',
+               file:                           "#{Rails.root}/files/foo.erb"
+               layout:                         'pdf.html',                   # use 'pdf.html' for a pdf.html.erb file
+               wkhtmltopdf:                    '/usr/local/bin/wkhtmltopdf', # path to binary
+               show_as_html:                   params.key?('debug'),         # allow debugging based on url param
+               orientation:                    'Landscape',                  # default Portrait
+               page_size:                      'A4, Letter, ...',            # default A4
+               page_height:                    NUMBER,
+               page_width:                     NUMBER,
+               save_to_file:                   Rails.root.join('pdfs', "#{filename}.pdf"),
+               save_only:                      false,                        # depends on :save_to_file being set first
+               proxy:                          'TEXT',
+               basic_auth:                     false                         # when true username & password are automatically sent from session
+               username:                       'TEXT',
+               password:                       'TEXT',
+               title:                          'Alternate Title',            # otherwise first page title is used
+               cover:                          'URL, Pathname, or raw HTML string',
+               dpi:                            'dpi',
+               encoding:                       'TEXT',
+               user_style_sheet:               'URL',
+               cookie:                         ['_session_id SESSION_ID'], # could be an array or a single string in a 'name value' format
+               post:                           ['query QUERY_PARAM'],      # could be an array or a single string in a 'name value' format
+               redirect_delay:                 NUMBER,
+               javascript_delay:               NUMBER,
+               image_quality:                  NUMBER,
+               no_pdf_compression:             true,
+               zoom:                           FLOAT,
+               page_offset:                    NUMBER,
+               book:                           true,
+               default_header:                 true,
+               disable_javascript:             false,
+               grayscale:                      true,
+               lowquality:                     true,
+               enable_plugins:                 true,
+               disable_internal_links:         true,
+               disable_external_links:         true,
+               print_media_type:               true,
+               disable_smart_shrinking:        true,
+               use_xserver:                    true,
+               no_background:                  true,
+               viewport_size:                  'TEXT',                    # available only with use_xserver or patched QT
+               extra:                          '',                        # directly inserted into the command to wkhtmltopdf
+               outline: {   outline:           true,
+                            outline_depth:     LEVEL },
+               margin:  {   top:               SIZE,                     # default 10 (mm)
+                            bottom:            SIZE,
+                            left:              SIZE,
+                            right:             SIZE },
+               header:  {   html: {            template: 'users/header.pdf.erb',  # use :template OR :url
+                                               layout:   'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
+                                               url:      'www.example.com',
+                                               locals:   { foo: @bar }},
+                            center:            'TEXT',
+                            font_name:         'NAME',
+                            font_size:         SIZE,
+                            left:              'TEXT',
+                            right:             'TEXT',
+                            spacing:           REAL,
+                            line:              true,
+                            content:           'HTML CONTENT ALREADY RENDERED'}, # optionally you can pass plain html already rendered (useful if using pdf_from_string)
+               footer:  {   html: {   template:'shared/footer.pdf.erb', # use :template OR :url
+                                      layout:  'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
+                                      url:     'www.example.com',
+                                      locals:  { foo: @bar }},
+                            center:            'TEXT',
+                            font_name:         'NAME',
+                            font_size:         SIZE,
+                            left:              'TEXT',
+                            right:             'TEXT',
+                            spacing:           REAL,
+                            line:              true,
+                            content:           'HTML CONTENT ALREADY RENDERED'}, # optionally you can pass plain html already rendered (useful if using pdf_from_string)
+               toc:     {   font_name:         "NAME",
+                            depth:             LEVEL,
+                            header_text:       "TEXT",
+                            header_fs:         SIZE,
+                            text_size_shrink:  0.8,
+                            l1_font_size:      SIZE,
+                            l2_font_size:      SIZE,
+                            l3_font_size:      SIZE,
+                            l4_font_size:      SIZE,
+                            l5_font_size:      SIZE,
+                            l6_font_size:      SIZE,
+                            l7_font_size:      SIZE,
+                            level_indentation: NUM,
+                            l1_indentation:    NUM,
+                            l2_indentation:    NUM,
+                            l3_indentation:    NUM,
+                            l4_indentation:    NUM,
+                            l5_indentation:    NUM,
+                            l6_indentation:    NUM,
+                            l7_indentation:    NUM,
+                            no_dots:           true,
+                            disable_dotted_lines:  true,
+                            disable_links:     true,
+                            disable_toc_links: true,
+                            disable_back_links:true,
+                            xsl_style_sheet:   'file.xsl'} # optional XSLT stylesheet to use for styling table of contents
       end
     end
   end
 end
 ```
-By default, it will render without a layout (:layout => false) and the template for the current controller and action.
+By default, it will render without a layout (layout: false) and the template for the current controller and action.
 
 ### Super Advanced Usage ###
 
@@ -220,16 +222,19 @@ pdf = WickedPdf.new.pdf_from_string('<h1>Hello There!</h1>')
 # Path must be absolute path
 pdf = WickedPdf.new.pdf_from_html_file('/your/absolute/path/here')
 
+# create a pdf from a URL
+pdf = WickedPdf.new.pdf_from_url('https://github.com/mileszs/wicked_pdf')
+
 # create a pdf from string using templates, layouts and content option for header or footer
-WickedPdf.new.pdf_from_string(
-  render_to_string('templates/pdf.html.erb', :layout => 'pdfs/layout_pdf'),
-  :footer => {
-    :content => render_to_string(:layout => 'pdfs/layout_pdf')
+pdf = WickedPdf.new.pdf_from_string(
+  render_to_string('templates/pdf.html.erb', layout: 'pdfs/layout_pdf'),
+  footer: {
+    content: render_to_string(layout: 'pdfs/layout_pdf')
   }
 )
 
 # or from your controller, using views & templates and all wicked_pdf options as normal
-pdf = render_to_string :pdf => "some_file_name"
+pdf = render_to_string pdf: "some_file_name", template: "templates/pdf.html.erb", encoding: "UTF-8"
 
 # then save to a file
 save_path = Rails.root.join('pdfs','filename.pdf')
@@ -239,7 +244,7 @@ end
 ```
 If you need to display utf encoded characters, add this to your pdf views or layouts:
 ```html
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<meta charset="utf-8" />
 ```
 ### Page Numbering
 
@@ -251,7 +256,7 @@ A bit of javascript can help you number your pages. Create a template or header/
       function number_pages() {
         var vars={};
         var x=document.location.search.substring(1).split('&');
-        for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = unescape(z[1]);}
+        for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = decodeURIComponent(z[1]);}
         var x=['frompage','topage','page','webpage','section','subsection','subsubsection'];
         for(var i in x) {
           var y = document.getElementsByClassName(x[i]);
@@ -269,7 +274,7 @@ Anything with a class listed in "var x" above will be auto-filled at render time
 
 If you do not have explicit page breaks (and therefore do not have any "page" class), you can also use wkhtmltopdf's built in page number generation by setting one of the headers to "[page]":
 ```ruby
-render :pdf => 'filename', :header => { :right => '[page] of [topage]' }
+render pdf: 'filename', header: { right: '[page] of [topage]' }
 ```
 ### Configuration
 
@@ -286,10 +291,10 @@ config.middleware.use WickedPdf::Middleware
 If you want to turn on or off the middleware for certain urls, use the `:only` or `:except` conditions like so:
 ```ruby
 # conditions can be plain strings or regular expressions, and you can supply only one or an array
-config.middleware.use WickedPdf::Middleware, {}, :only => '/invoice'
-config.middleware.use WickedPdf::Middleware, {}, :except => [ %r[^/admin], '/secret', %r[^/people/\d] ]
+config.middleware.use WickedPdf::Middleware, {}, only: '/invoice'
+config.middleware.use WickedPdf::Middleware, {}, except: [ %r[^/admin], '/secret', %r[^/people/\d] ]
 ```
-If you use the standard `render :pdf => 'some_pdf'` in your app, you will want to exclude those actions from the middleware.
+If you use the standard `render pdf: 'some_pdf'` in your app, you will want to exclude those actions from the middleware.
 
 ### Further Reading
 
@@ -303,14 +308,19 @@ StackOverflow [questions with the tag "wicked-pdf"](http://stackoverflow.com/que
 
 Now you can use a debug param on the URL that shows you the content of the pdf in plain html to design it faster.
 
-First of all you must configure the render parameter ":show_as_html => params[:debug]" and then just use it like normally but adding "debug=1" as a param:
+First of all you must configure the render parameter `show_as_html: params.key?('debug')` and then just use it like you normally would but add "debug" as a GET param in the URL:
 
-http://localhost:3001/CONTROLLER/X.pdf?debug=1
+http://localhost:3001/CONTROLLER/X.pdf?debug
 
 However, the wicked_pdf_* helpers will use file:/// paths for assets when using :show_as_html, and your browser's cross-domain safety feature will kick in, and not render them. To get around this, you can load your assets like so in your templates:
 ```html
-    <%= params[:debug].present? ? image_tag('foo') : wicked_pdf_image_tag('foo') %>
+    <%= params.key?('debug') ? image_tag('foo') : wicked_pdf_image_tag('foo') %>
 ```
+
+#### Gotchas
+
+If one image from your HTML cannot be found (relative or wrong path for ie), others images with right paths **may not** be displayed in the output PDF as well (it seems to be an issue with wkhtmltopdf).
+
 ### Inspiration
 
 You may have noticed: this plugin is heavily inspired by the PrinceXML plugin [princely](http://github.com/mbleigh/princely/tree/master).  PrinceXML's cost was prohibitive for me. So, with a little help from some friends (thanks [jqr](http://github.com/jqr)), I tracked down wkhtmltopdf, and here we are.