GitHub - Mileszs - Wicked - PDF - PDF Generator (From HTML) Plugin For Ruby On Rails

12/4/2016
GitHub - mileszs/wicked_pdf: PDF generator (from HTML) plugin for Ruby on Rails
Personal Open source Business Explore
Pricing Blog Support
mileszs / wicked_pdf
Code
Issues 115
Watch 46
Pull requests 10
Projects 0
Wiki
Sign in
This repository Search
Pulse
Star 2,161
Sign up
Fork 401
Graphs
PDF generator (from HTML) plugin for Ruby on Rails http://mileszs.com/blog/2009/06/17/wi

629 commits
Branch: master
3 branches
34 releases
109 contributors
New pull request
Find file
unixmonkey committed on GitHub Merge pull request #585 from benortiz/patch1
gemfiles
generators/wicked_pdf
lib
test
.gitignore
.rubocop.yml
.rubocop_todo.yml
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
init.rb
wicked_pdf.gemspec
MIT
Add Rails 5 to Travis matrix.

Comment out exe_path in generator by default
Updates wkhtmltopdf homepage url.
Remove conditional for Rails > 3 to check if necessary anymore.
Ignore dummy app in repository
Add Rubocop configuration and fix some trivial style things
Update class/module max length.
Add Rails 5 to Travis matrix.
Update VERSION to 1.1.0.
Prefer singlequoted strings when interpolation not necessary
Rename MITLICENCE to LICENSE.txt
default_protocol in list of available config
Appease the RuboCop.
Removed code that was already included in railties
Only require RuboCop on Ruby 2+
Clone or download
Latest commit cef5e69 on Oct 30
3 months ago
a year ago
2 months ago
3 months ago
2 years ago
a year ago
6 months ago
3 months ago
3 months ago
2 years ago
3 years ago
a month ago
4 months ago
4 years ago
4 months ago
README.md
Wicked PDF
gemversion
1.1.0
A PDF generation plugin for Ruby on Rails

Wicked PDF uses the shell utility 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 PDF take care of the hard stuff.
Wicked PDF has been verified to work on Ruby versions 1.8.7 through 2.3; Rails 2 through 5.0
Installation
Add this to your Gemfile and run bundle install:

https://github.com/mileszs/wicked_pdf
1/8
12/4/2016
gem 'wicked_pdf'
Then create the initializer with

rails generate wicked_pdf
You may also need to add

Mime::Type.register "application/pdf", :pdf
to config/initializers/mime_types.rb in older versions of Rails.

Because wicked_pdf is a wrapper for wkhtmltopdf, you'll need to install that, too.
The simplest way to install all of the binaries (Linux, OSX, Windows) is through the gem wkhtmltopdfbinary. To install
that, add a second gem
gem 'wkhtmltopdf-binary'
To your Gemfile and run bundle install.

This wrapper may trail in versions, at the moment it wraps the 0.9 version of wkhtmltopdf while there is 0.12 version
available. Some of the advanced options listed below are not available with 0.9.
If your wkhtmltopdf executable is not on your webserver's path, you can configure it in an initializer:
WickedPdf.config = {
exe_path: '/usr/local/bin/wkhtmltopdf'
}
For more information about wkhtmltopdf, see the project's homepage.
Basic Usage
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
2/8
12/4/2016
<!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.
<!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>
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.
<!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" %>
Asset pipeline usage

The way to handle this for the asset pipeline on Heroku is to include these files in your asset precompile list, as
follows:
config.assets.precompile += ['blueprint/screen.css', 'pdf.css', 'jquery.ui.datepicker.js', 'pdf.js', ...etc...]
Advanced Usage with all available options

3/8
12/4/2016
class ThingsController < ApplicationController
def show
respond_to do |format|
format.html
format.pdf do
render pdf:
disposition:
template:
file:
layout:
wkhtmltopdf:
show_as_html:
orientation:
page_size:
page_height:
page_width:
save_to_file:
save_only:
default_protocol:
proxy:
basic_auth:
username:
password:
title:
cover:
dpi:
encoding:
user_style_sheet:
cookie:
post:
redirect_delay:
javascript_delay:
window_status:
image_quality:
no_pdf_compression:
zoom:
page_offset:
book:
default_header:
disable_javascript:
grayscale:
lowquality:
enable_plugins:
disable_internal_links:
disable_external_links:
print_media_type:
disable_smart_shrinking:
use_xserver:
background:
no_background:
viewport_size:
extra:
outline: {
outline:
outline_depth:
margin: {
top:
bottom:
left:
right:
header: {
html: {
center:
font_name:
font_size:
left:
right:
spacing:
line:
content:
'file_name',
'attachment',
# default 'inline'
'things/show',
"#{Rails.root}/files/foo.erb"
'pdf',
# for a pdf.html.erb file
'/usr/local/bin/wkhtmltopdf', # path to binary
params.key?('debug'),
# allow debugging based on url param
'Landscape',
# default Portrait
'A4, Letter, ...',
# default A4
NUMBER,
NUMBER,
Rails.root.join('pdfs', "#{filename}.pdf"),
false,
# depends on :save_to_file being set first
'http',
'TEXT',
false
# when true username & password are automati
'TEXT',
'TEXT',
'Alternate Title',
# otherwise first page title is used
'URL, Pathname, or raw HTML string',
'dpi',
'TEXT',
'URL',
['_session_id SESSION_ID'], # could be an array or a single string in a 'n
['query QUERY_PARAM'],
# could be an array or a single string in a 'n
NUMBER,
NUMBER,
'TEXT',
# wait to render until some JS sets window.sta
NUMBER,
true,
FLOAT,
NUMBER,
true,
true,
false,
true,
true,
true,
true,
true,
true,
true,
true,
false,
# backround needs to be true to enable backgrou
true,
'TEXT',
# available only with use_xserver or patched QT
'',
# directly inserted into the command to wkhtmlt
true,
LEVEL },
SIZE,
# default 10 (mm)
SIZE,
SIZE,
SIZE },
template: 'users/header',
# use :template OR :url
layout:
'pdf_plain',
# optional, use 'pdf_plain' for a pdf_p
url:
'www.example.com',
locals:
{ foo: @bar }},
'TEXT',
'NAME',
SIZE,
'TEXT',
'TEXT',
REAL,
true,
'HTML CONTENT ALREADY RENDERED'}, # optionally you can pass plain html alr
4/8
12/4/2016
footer:
toc:
html: {
template:'shared/footer',
# use :template OR :url
layout: 'pdf_plain.html',
# optional, use 'pdf_plain' for a pdf_plain.html.
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 alr
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 content
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:
print_media_type: true
no_background: true
# Passes `--print-media-type`
# Passes `--no-background`
You can see the complete list of options under "Global Options" in wkhtmltopdf usage docs.
Super Advanced Usage
If you need to just create a pdf and not display it:

# 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
5/8
12/4/2016
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
pdf = WickedPdf.new.pdf_from_string(
render_to_string('templates/pdf', 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", 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
If you need to display utf encoded characters, add this to your pdf views or layouts:
<meta charset="utf-8" />
Page Breaks
You can control page breaks with CSS.

Add a few styles like this to your stylesheet or page:
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>
<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 autofilled at render time.
6/8
12/4/2016
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]":
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:
# in application.rb (Rails3) or environment.rb (Rails2)
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:
# 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.
Further Reading
Mike Ackerman's post How To Create PDFs in Rails

Andreas Happe's post Generating PDFs from Ruby on Rails
JESii's post WickedPDF, wkhtmltopdf, and Heroku...a tricky combination
Berislav Babic's post Send PDF attachments from Rails with WickedPdf and ActionMailer
StackOverflow questions with the tag "wickedpdf"
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
crossdomain safety feature will kick in, and not render them. To get around this, you can load your assets like so in
your templates:
<%= 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).
7/8
12/4/2016
Inspiration
You may have noticed: this plugin is heavily inspired by the PrinceXML plugin princely. PrinceXML's cost was
prohibitive for me. So, with a little help from some friends (thanks 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, galdomedia, jcrisp, lleirborras, tiennou, and everyone else for all their hard work and
patience with my delays in merging in their enhancements.
2016 GitHub, Inc. Terms Privacy Security Status Help
Contact GitHub API Training Shop Blog About
8/8

GitHub - Mileszs - Wicked - PDF - PDF Generator (From HTML) Plugin For Ruby On Rails

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

GitHub - Mileszs - Wicked - PDF - PDF Generator (From HTML) Plugin For Ruby On Rails

Transféré par

Droits d'auteur :

Formats disponibles

12/4/2016

Personal Open source Business Explore

Pricing Blog Support

This repository Search

PDF generator (from HTML) plugin for Ruby on Rails http://mileszs.com/blog/2009/06/17/wi

New pull request

unixmonkey committed on GitHub Merge pull request #585 from benortiz/patch1

Add Rails 5 to Travis matrix.

Latest commit cef5e69 on Oct 30

A PDF generation plugin for Ruby on Rails

Add this to your Gemfile and run bundle install:

Then create the initializer with

You may also need to add

to config/initializers/mime_types.rb in older versions of Rails.

To your Gemfile and run bundle install.

For more information about wkhtmltopdf, see the project's homepage.

Usage Conditions Important!

Asset pipeline usage

Advanced Usage with all available options

Super Advanced Usage

If you need to just create a pdf and not display it:

You can control page breaks with CSS.

Mike Ackerman's post How To Create PDFs in Rails

2016 GitHub, Inc. Terms Privacy Security Status Help

Contact GitHub API Training Shop Blog About

Vous aimerez peut-être aussi