adzap-wicked_pdf 2.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56cc9f21233c4aa590afe1bf5577c967a56abeec26c3fccbd302effe839c3421
+  data.tar.gz: 9b0d47a24d5c9fe990efc2290fc64606b9177862217107186bea786955f93ac0
+SHA512:
+  metadata.gz: ee172642130eedcb6fbfed05656e9f420625e5fcd9be1763dec387b76d4b21051581bf7ba7dd9a4499b6941462a347e08c7bf8b279d100e56378610762d5dc5d
+  data.tar.gz: 687d4369110d2c14e8d08fe4bad877fca2fc38182ab5632efb3dd903c341619e66bdc864e3a10f27f96a87f9c1444aa6022e59ead5bec20e176251778a9739fb

data/.github/issue_template.md

@@ -0,0 +1,15 @@
+## Issue description
+
+## Expected or desired behavior
+
+## System specifications
+
+wicked_pdf gem version (output of `cat Gemfile.lock | grep wicked_pdf`):
+
+wkhtmltopdf version (output of `wkhtmltopdf --version`):
+
+whtmltopdf [provider gem](https://rubygems.org/search?utf8=%E2%9C%93&query=wkhtmltopdf) and version if one is used:
+
+platform/distribution and version (e.g. Windows 10 / Ubuntu 16.04 / Heroku cedar):
+
+

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+gemfiles/*.lock
+.DS_Store
+test/dummy/db/

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'test/dummy/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'wicked_pdf.gemspec'
+
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/SafeNavigation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-11-08 18:41:57 -0500 using RuboCop version 0.32.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+
+# Offense count: 9
+Metrics/AbcSize:
+  Max: 45
+
+# Offense count: 2
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/ModuleLength:
+  Max: 120
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 92
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 563
+
+# Offense count: 14
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 30
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 2
+Naming/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 1
+Style/CaseEquality:
+  Enabled: false
+
+# Offense count: 1
+Style/ClassVars:
+  Enabled: false
+
+# Offense count: 15
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,30 @@
+language: ruby
+git:
+  depth: 1
+  quiet: true
+sudo: required
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+  - sudo apt-get update -qq
+bundler_args: --verbose
+before_script:
+  - bundle list
+  - sudo apt-get install -y wkhtmltopdf
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+env: WKHTMLTOPDF_BIN=/usr/bin/wkhtmltopdf
+script:
+  - bundle exec rake
+
+gemfile:
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
+
+rvm:
+  - "2.3"
+  - "2.4"
+  - "2.5"
+  - "2.6"

data/CHANGELOG.md

@@ -0,0 +1,135 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.2.1] - 2019-03-16
+### Changed
+- [Fix `SystemStackError` in some setups](https://github.com/mileszs/wicked_pdf/pull/813)
+
+## [1.2.0] - 2019-03-16
+### Added
+- [Add `raise_on_all_errors: true` option to raise on any error that prints to STDOUT during PDF generation](https://github.com/mileszs/wicked_pdf/pull/751)
+- [Add ability to use the `assigns` option to `render` to assign instance variables to a PDF template](https://github.com/mileszs/wicked_pdf/pull/801)
+- [Add ability to track console progress](https://github.com/mileszs/wicked_pdf/pull/804) with `progress: -> (output) { puts output }`. This is useful to add reporting hooks to show your frontend what page number is being generated.
+
+### Changed
+- [Fix conflict with other gems that hook into `render`](https://github.com/mileszs/wicked_pdf/pull/574) and avoid using `alias_method_chain` where possible
+- [Fix issue using the shell to locate `wkhtmltopdf` in a Bundler environment](https://github.com/mileszs/wicked_pdf/pull/728)
+- [Fix `wkhtmltopdf` path detection when HOME environment variable is unset](https://github.com/mileszs/wicked_pdf/pull/568)
+- [Fix error when the `Rails` constant is defined but not actually using Rails](https://github.com/mileszs/wicked_pdf/pull/613)
+- [Fix compatibility issue with Sprockets 4](https://github.com/mileszs/wicked_pdf/pull/615)
+- [Fix compatibility issue with `Mime::JS` in Rails 5.1+](https://github.com/mileszs/wicked_pdf/pull/627)
+- [Fix deprecation warning by using `after_action` instead of `after_filter` when available](https://github.com/mileszs/wicked_pdf/pull/663)
+- [Provide Rails `base_path` to `find_asset` calls for Sprockets file lookup](https://github.com/mileszs/wicked_pdf/pull/688)
+- Logger changes:
+    - [Use `Rails.logger.debug` instead of `p`](https://github.com/mileszs/wicked_pdf/pull/575)
+    - [Change logger message to prepend `[wicked_pdf]` instead of nonstandard `****************WICKED****************`](https://github.com/mileszs/wicked_pdf/pull/589)
+- Documentation changes:
+    - [Update link to wkhtmltopdf homepage](https://github.com/mileszs/wicked_pdf/pull/582)
+    - [Update link to `wkhtmltopdf_binary_gem`](https://github.com/mileszs/wicked_pdf/commit/59e6c5fca3985f2fa2f345089596250df5da2682)
+    - [Update documentation for usage with the Asset Pipeline](https://github.com/mileszs/wicked_pdf/commit/690d00157706699a71b7dcd71834759f4d84702f)
+    - [Document `default_protocol` option](https://github.com/mileszs/wicked_pdf/pull/585)
+    - [Document `image` and `no_image` options](https://github.com/mileszs/wicked_pdf/pull/689)
+    - [Document issue with DPI/scaling on various platforms](https://github.com/mileszs/wicked_pdf/pull/715)
+    - [Document creating and attaching a PDF in a mailer](https://github.com/mileszs/wicked_pdf/pull/746)
+    - [Document dependency on `wkhtmltopdf` with RubyGems](https://github.com/mileszs/wicked_pdf/pull/656)
+    - [Add example using WickedPDF with Rails in an API-only configuration](https://github.com/mileszs/wicked_pdf/pull/796)
+    - [Add example for rending a template as a header/footer](https://github.com/mileszs/wicked_pdf/pull/603)
+    - [Add GitHub issue template](https://github.com/mileszs/wicked_pdf/pull/805)
+    - [Add CodeClimate Badge](https://github.com/mileszs/wicked_pdf/pull/646)
+- RuboCop cleanup
+- Updates to Travis CI pipeline to support newer versions of Ruby & Rails
+
+## [1.1.0] - 2016-08-30
+### Added
+- Support Rails 5.x and Sprockets 3.x
+- Support `window_status: 'somestring'` option, to instruct wkhtmltopdf to wait until the browser `window.status` is equal to the supplied string. This can be useful to force rendering to wait [as explained quite well here](https://spin.atomicobject.com/2015/08/29/ember-app-done-loading/)
+- Support `no_stop_slow_scripts: true` to let slow running scripts delay rendering
+
+### Changed
+- [Improved error handling](https://github.com/mileszs/wicked_pdf/pull/543)
+- [Namespace helper classes under WickedPdf namespace](https://github.com/mileszs/wicked_pdf/pull/538)
+- [Changes to asset finding to support Rails 5](https://github.com/mileszs/wicked_pdf/pull/561)
+
+## [1.0.6] - 2016-04-04
+### Changed
+- Revert shellescaping of options. The fix was causing more issues than it solved (like "[page] of [topage]" being escaped, and thus not parsed by `wkhtmltopdf`). See #514 for details.
+
+## [1.0.5] - 2016-03-28
+### Changed
+- Numerous RuboCop style violation fixes, spelling errors, and test-setup issues from [indyrb.org](http://indyrb.org/) hack night. Thank you all for your contributions!
+
+### Fixed
+- Shellescape options. A stray quote in `header` or `footer` would cause PDF to fail to generate, and this should close down many potential attack vectors if you allow user-supplied values to be passed into `wicked_pdf` render options.
+
+## [1.0.4] - 2016-01-26
+### Changed
+- Check that logger responds to info before calling it. It was possible to have a `logger` method defined as a controller helper that would override `Rails.logger`.
+
+### Fixed
+- [Issue with Sprockets 3.0](https://github.com/mileszs/wicked_pdf/issues/476) where an asset referenced in a stylesheet not existing would raise an exception `read_asset` on nil.
+
+## [1.0.3] - 2015-12-02
+### Changed
+- Revert default DPI. Some installs of `wkhtmltopdf` would experience major slowdowns or crashes with it set to 72. It is suggested that a DPI of 75 may be better, but I'm holding off on making it a default without more information.
+
+## [1.0.2] - 2015-11-30
+### Changed
+- The default dpi is now 72. Previously the default would be whatever your `wkhtmltopdf` version specified as the default. This change [speeds up generation of documents that contain `border-radius` dramatically](https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1510)
+
+## [1.0.1] - 2015-11-19
+### Changed
+- Made minor RuboCop style tweaks.
+
+### Added
+- Added default [RuboCop](https://github.com/bbatsov/rubocop) config and run after test suite.
+
+### Fixed
+- Issue with `nil.basename` from asset helpers.
+
+## [1.0.0] - 2015-11-03
+### Changed
+- Accepted that `WickedPDF` cannot guarantee backwards compatibility with older versions of `wkthmltopdf`, and decided to publish a new version with the MAJOR number incremented, signaling that this may have breaking changes for some people, but providing a path forward for progress. This release number also signals that this is a mature (and relatively stable) project, and should be deemed ready for production (since it has been used in production since ~2009, and downloaded over a *million* times on [RubyGems.org](https://rubygems.org/gems/wicked_pdf)).
+- Stopped attempting to track with version number of `wkhtmltopdf` binary releases (`wkhtmltopdf` v9.x == `WickedPDF` v9.x)
+- Adopted [Semantic Versioning](http://semver.org/) for release numbering
+- Added a CHANGELOG (based on [keepachangelog.com](http://keepachangelog.com/))
+- Misc code tweaks as suggested by [RuboCop](https://github.com/bbatsov/rubocop)
+
+### Added
+- Check version of `wkhtmltopdf` before deciding to pass arguments with or without dashes
+- New arguments and options for the table of contents supported in newer versions of wkhtmltopf: `text_size_shrink`, `level_indentation`, `disable_dotted_lines`, `disable_toc_links`, `xsl_style_sheet`
+- Merge in global options to `pdf_from_html_file` and `pdf_from_string`
+- Add ability to generate pdf from a web resource: `pdf_from_url(url)`
+
+### Removed
+- Explicit dependency on [Rails](https://github.com/rails/rails), since parts of this library may be used without it.
+- Comment out the `:exe_path` option in the generated initalizer by default (since many systems won't have `wkthmltopdf` installed in that specific location)
+
+### Fixed
+- Issues with `file://` paths on Windows-based systems
+- Issues with parsed options/argument ordering on versions of `wkthmltopdf` > 0.9
+- Issues with middleware headers when running Rails app mounted in a subdirectory
+- Issues with options that have a `key: 'value'` syntax when passed to `wkthmltopdf`
+- Issue with `:temp_path` option being deleted from original options hash
+- Issue with header/footer `:content` being deleted after the first page
+- Issues with options being modified during processing (including global config options)
+- Issues with asset helpers recognizing assets specified without a protocol
+- Issues with `url()` references and embedded `data:base64` assests in stylesheets rendered with `wicked_pdf_stylesheet_link_tag`
+- Asset helpers no longer add a file extension if it already is specified with one
+
+# Compare Releases
+- [1.2.1...HEAD](https://github.com/mileszs/wicked_pdf/compare/1.2.1...HEAD)
+- [1.2.0...1.2.1](https://github.com/mileszs/wicked_pdf/compare/1.1.0...1.2.0)
+- [1.1.0...1.2.0](https://github.com/mileszs/wicked_pdf/compare/1.1.0...1.2.0)
+- [1.0.6...1.1.0](https://github.com/mileszs/wicked_pdf/compare/1.0.6...1.1.0)
+- [1.0.5...1.0.6](https://github.com/mileszs/wicked_pdf/compare/1.0.5...1.0.6)
+- [1.0.4...1.0.5](https://github.com/mileszs/wicked_pdf/compare/1.0.4...1.0.5)
+- [1.0.3...1.0.4](https://github.com/mileszs/wicked_pdf/compare/1.0.3...1.0.4)
+- [1.0.2...1.0.3](https://github.com/mileszs/wicked_pdf/compare/1.0.2...1.0.3)
+- [1.0.1...1.0.2](https://github.com/mileszs/wicked_pdf/compare/1.0.1...1.0.2)
+- [1.0.0...1.0.1](https://github.com/mileszs/wicked_pdf/compare/1.0.0...1.0.1)
+- [0.11.0...1.0.0](https://github.com/mileszs/wicked_pdf/compare/0.11.0...1.0.0)
+- [0.10.2...0.11.0](https://github.com/mileszs/wicked_pdf/compare/0.10.2...0.11.0)
+- [0.10.1...0.10.2](https://github.com/mileszs/wicked_pdf/compare/0.10.1...0.10.2)
+- [0.10.0...0.10.1](https://github.com/mileszs/wicked_pdf/compare/0.10.0...0.10.1)
+- [0.9.10...0.10.0](https://github.com/mileszs/wicked_pdf/compare/0.9.10...0.10.0)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Miles Z. Sterrett
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,446 @@
+# Wicked PDF [![Gem Version](https://badge.fury.io/rb/adzap-wicked_pdf.svg)](http://badge.fury.io/rb/adzap-wicked_pdf) [![Build Status](https://secure.travis-ci.org/adzap/wicked_pdf.svg)](http://travis-ci.org/adzap/wicked_pdf) 
+
+_This is a fork of the [original](https://github.com/milesz/wicked_pdf) to redesign the internals for a much lighter footprint on your app and offer greater extensibility_
+
+## A PDF generation plugin for Ruby on Rails
+
+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 versions 2.3 through 2.6; Rails 4.2 through 5.2_
+
+### Installation
+
+Add this to your Gemfile and run `bundle install`:
+
+```ruby
+gem 'adzap-wicked_pdf'
+```
+
+Then create the initializer with
+
+    rails generate wicked_pdf
+
+Because `wicked_pdf` is a wrapper for  [wkhtmltopdf](http://wkhtmltopdf.org/), you'll need to install that, too.
+
+The simplest way to install all of the binaries on most Linux or OSX systems is through the gem [wkhtmltopdf-binary](https://github.com/zakird/wkhtmltopdf_binary_gem). Builds for other systems are available [here](https://wkhtmltopdf.org/downloads.html)
+To install that gem, add this:
+
+```ruby
+gem 'wkhtmltopdf-binary'
+```
+
+To your Gemfile and run `bundle install`.
+
+This gem currently installs version 0.12.x of `wkhtmltopdf`. Some of the options listed below are specific 0.9 or below, and others are for 0.12 and up.
+
+You can see what flags are supported for the current version in [wkhtmltopdf's auto-generated manual](https://wkhtmltopdf.org/usage/wkhtmltopdf.txt)
+
+If your wkhtmltopdf executable is not on your webserver's path, you can configure it in an initializer:
+
+```ruby
+WickedPdf.config = {
+  exe_path: '/usr/local/bin/wkhtmltopdf'
+}
+```
+
+For more information about `wkhtmltopdf`, see the project's [homepage](http://wkhtmltopdf.org/).
+
+### Basic Usage
+```ruby
+class ThingsController < ApplicationController
+  def show
+    respond_to do |format|
+      format.html
+      format.pdf do
+        render pdf: "file_name"   # Excluding ".pdf" extension.
+      end
+    end
+  end
+end
+```
+### Usage Conditions - Important!
+
+The wkhtmltopdf binary is run outside of your Rails application; therefore, your normal layouts will not work. If you plan to use any CSS, JavaScript, or image files, you must modify your layout so that you provide an absolute reference to these files. The best option for Rails without the asset pipeline is to use the `wicked_pdf_stylesheet_link_tag`, `wicked_pdf_image_tag`, and `wicked_pdf_javascript_include_tag` helpers or to go straight to a CDN (Content Delivery Network) for popular libraries such as jQuery.
+
+#### wicked_pdf helpers
+```html
+<!doctype html>
+<html>
+  <head>
+    <meta charset='utf-8' />
+    <%= wicked_pdf_stylesheet_link_tag "pdf" -%>
+    <%= wicked_pdf_javascript_include_tag "number_pages" %>
+  </head>
+  <body onload='number_pages'>
+    <div id="header">
+      <%= wicked_pdf_image_tag 'mysite.jpg' %>
+    </div>
+    <div id="content">
+      <%= yield %>
+    </div>
+  </body>
+</html>
+```
+
+Using wicked_pdf_helpers with asset pipeline raises `Asset names passed to helpers should not include the "/assets/" prefix.` error. To work around this, you can use `wicked_pdf_asset_base64` with the normal Rails helpers, but be aware that this will base64 encode your content and inline it in the page. This is very quick for small assets, but large ones can take a long time.
+
+```html
+<!doctype html>
+<html>
+  <head>
+    <meta charset='utf-8' />
+    <%= stylesheet_link_tag wicked_pdf_asset_base64("pdf") %>
+    <%= javascript_include_tag wicked_pdf_asset_base64("number_pages") %>
+
+  </head>
+  <body onload='number_pages'>
+    <div id="header">
+      <%= image_tag wicked_pdf_asset_base64('mysite.jpg') %>
+    </div>
+    <div id="content">
+      <%= yield %>
+    </div>
+  </body>
+</html>
+```
+
+#### Asset pipeline usage
+
+It is best to precompile assets used in PDF views. This will help avoid issues when it comes to deploying, as Rails serves asset files differently between development and production (`config.assets.compile = false`), which can make it look like your PDFs work in development, but fail to load assets in production.
+
+    config.assets.precompile += ['blueprint/screen.css', 'pdf.css', 'jquery.ui.datepicker.js', 'pdf.js', ...etc...]
+
+#### CDN reference
+
+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>
+    <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" %>
+```
+
+### Advanced Usage with all available options
+```ruby
+class ThingsController < ApplicationController
+  def show
+    respond_to do |format|
+      format.html
+      format.pdf do
+        render pdf:                            'file_name',
+               disposition:                    'attachment',                 # default 'inline'
+               template:                       'things/show',
+               file:                           "#{Rails.root}/files/foo.erb",
+               inline:                         '<!doctype html><html><head></head><body>INLINE HTML</body></html>',
+               layout:                         'pdf',                        # for a pdf.pdf.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
+               default_protocol:               'http',
+               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,
+               window_status:                  'TEXT',                     # wait to render until some JS sets window.status to the given string
+               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,
+               background:                     false,                     # background needs to be true to enable background colors to render
+               no_background:                  true,
+               viewport_size:                  'TEXT',                    # available only with use_xserver or patched QT
+               extra:                          '',                        # directly inserted into the command to wkhtmltopdf
+               raise_on_all_errors:            nil,                       # raise error for any stderr output.  Such as missing media, image assets
+               outline: {   outline:           true,
+                            outline_depth:     LEVEL },
+               margin:  {   top:               SIZE,                     # default 10 (mm)
+                            bottom:            SIZE,
+                            left:              SIZE,
+                            right:             SIZE },
+               header:  {   html: {            template: 'users/header',          # use :template OR :url
+                                               layout:   'pdf_plain',             # optional, use 'pdf_plain' for a pdf_plain.html.pdf.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',         # use :template OR :url
+                                      layout:  'pdf_plain.html',        # optional, use 'pdf_plain' for a pdf_plain.html.pdf.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
+               progress: proc { |output| puts output } # proc called when console output changes
+      end
+    end
+  end
+end
+```
+By default, it will render without a layout (layout: false) and the template for the current controller and action.
+
+#### wkhtmltopdf Binary Options
+
+Some of the options above are being passed to `wkhtmltopdf` binary. They can be used to control the options used in Webkit rendering before generating the PDF.
+
+Examples of those options are:
+
+```ruby
+print_media_type: true        # Passes `--print-media-type`
+no_background: true           # Passes `--no-background`
+```
+
+You can see the complete list of options under "Global Options" in wkhtmltopdf usage [docs](http://wkhtmltopdf.org/usage/wkhtmltopdf.txt).
+
+### Super Advanced Usage ###
+
+If you need to just create a pdf and not display it:
+```ruby
+# create a pdf from a string
+pdf = WickedPdf.new.pdf_from_string('<h1>Hello There!</h1>')
+
+# create a pdf file from a html file without converting it to string
+# 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/adzap/wicked_pdf')
+
+# create a pdf from string using templates, layouts and content option for header or footer
+pdf = WickedPdf.new.pdf_from_string(
+  render_to_string('templates/pdf', layout: 'pdfs/layout_pdf.html'),
+  footer: {
+    content: render_to_string(
+  		'templates/footer',
+  		layout: 'pdfs/layout_pdf.html'
+  	)
+  }
+)
+
+# It is possible to use footer/header templates without a layout, in that case you need to provide a valid HTML document
+pdf = WickedPdf.new.pdf_from_string(
+  render_to_string('templates/full_pdf_template'),
+  header: {
+    content: render_to_string('templates/full_header_template')
+  }
+)
+
+# or from your controller, using views & templates and all wicked_pdf options as normal
+pdf = render_to_string pdf: "some_file_name", template: "templates/pdf", encoding: "UTF-8"
+
+# then save to a file
+save_path = Rails.root.join('pdfs','filename.pdf')
+File.open(save_path, 'wb') do |file|
+  file << pdf
+end
+
+# you can also track progress on your PDF generation, such as when using it from within a Resque job
+class PdfJob
+  def perform
+    blk = proc { |output|
+      match = output.match(/\[.+\] Page (?<current_page>\d+) of (?<total_pages>\d+)/)
+      if match
+        current_page = match[:current_page].to_i
+        total_pages = match[:total_pages].to_i
+        message = "Generated #{current_page} of #{total_pages} pages"
+        at current_page, total_pages, message
+      end
+    }
+    WickedPdf.new.pdf_from_string(html, progress: blk)
+  end
+end
+```
+If you need to display utf encoded characters, add this to your pdf views or layouts:
+```html
+<meta charset="utf-8" />
+```
+If you need to return a PDF in a controller with Rails in API mode:
+```ruby
+pdf_html = ActionController::Base.new.render_to_string(template: 'controller_name/action_name', layout: 'pdf')
+pdf = WickedPdf.new.pdf_from_string(pdf_html)
+send_data pdf, filename: 'file.pdf'
+```
+### Page Breaks
+
+You can control page breaks with CSS.
+
+Add a few styles like this to your stylesheet or page:
+```css
+div.alwaysbreak { page-break-before: always; }
+div.nobreak:before { clear:both; }
+div.nobreak { page-break-inside: avoid; }
+```
+
+### Page Numbering
+
+A bit of javascript can help you number your pages. Create a template or header/footer file with this:
+```html
+<html>
+  <head>
+    <script>
+      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]] = decodeURIComponent(z[1]);}
+        var x=['frompage','topage','page','webpage','section','subsection','subsubsection'];
+        for(var i in x) {
+          var y = document.getElementsByClassName(x[i]);
+          for(var j=0; j<y.length; ++j) y[j].textContent = vars[x[i]];
+        }
+      }
+    </script>
+  </head>
+  <body onload="number_pages()">
+    Page <span class="page"></span> of <span class="topage"></span>
+  </body>
+</html>
+```
+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]' }
+```
+### Configuration
+
+You can put your default configuration, applied to all pdf's at "wicked_pdf.rb" initializer.
+
+### Rack Middleware
+
+If you would like to have WickedPdf automatically generate PDF views for all (or nearly all) pages by appending .pdf to the URL, add the following to your Rails app:
+```ruby
+# in application.rb (Rails 4+)
+require 'wicked_pdf'
+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] ]
+```
+If you use the standard `render pdf: 'some_pdf'` in your app, you will want to exclude those actions from the middleware.
+
+
+### Include in an email as an attachment
+
+To include a rendered pdf file in an email you can do the following:
+
+```ruby
+attachments['attachment.pdf'] = WickedPdf.new.pdf_from_string(
+  render_to_string('link_to_view.pdf.erb', layout: 'pdf')
+)
+```
+
+This will render the pdf to a string and include it in the email. This is very slow so make sure you schedule your email delivery in a job.
+
+### Further Reading
+
+Mike Ackerman's post [How To Create PDFs in Rails](https://www.viget.com/articles/how-to-create-pdfs-in-rails)
+
+Andreas Happe's post [Generating PDFs from Ruby on Rails](http://www.snikt.net/blog/2012/04/26/wicked-pdf/)
+
+JESii's post [WickedPDF, wkhtmltopdf, and Heroku...a tricky combination](http://www.nubyrubyrailstales.com/2013/06/wickedpdf-wkhtmltopdf-and-herokua.html)
+
+Berislav Babic's post [Send PDF attachments from Rails with WickedPdf and ActionMailer](http://berislavbabic.com/send-pdf-attachments-from-rails-with-wickedpdf-and-actionmailer/)
+
+StackOverflow [questions with the tag "wicked-pdf"](http://stackoverflow.com/questions/tagged/wicked-pdf)
+
+### Debugging
+
+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.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
+
+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.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 example), others images with right paths **may not** be displayed in the output PDF as well (it seems to be an issue with wkhtmltopdf).
+
+wkhtmltopdf may render at different resolutions on different platforms. For example, Linux prints at 75 dpi (native for WebKit) while on Windows it's at the desktop's DPI (which is normally 96 dpi). [Use `:zoom => 0.78125`](https://github.com/wkhtmltopdf/wkhtmltopdf/issues/2184) (75/96) to match Linux rendering to Windows.
+
+### 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.
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the test suite and check the output (`rake`)
+4. Add tests for your feature or fix (please)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+### Awesome Peoples
+
+Also, thanks to [unixmonkey](https://github.com/Unixmonkey), [galdomedia](http://github.com/galdomedia), [jcrisp](http://github.com/jcrisp), [lleirborras](http://github.com/lleirborras), [tiennou](http://github.com/tiennou), and everyone else for all their hard work and patience with my delays in merging in their enhancements.