wicked_pdf 1.0.6 → 2.6.3

data/README.md

@@ -1,10 +1,10 @@
-# 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)
+# Wicked PDF [![Gem Version](https://badge.fury.io/rb/wicked_pdf.svg)](http://badge.fury.io/rb/wicked_pdf) [![Build Status](https://github.com/mileszs/wicked_pdf/actions/workflows/ci.yml/badge.svg)](https://github.com/mileszs/wicked_pdf/actions/workflows/ci.yml) [![Code Climate](https://codeclimate.com/github/mileszs/wicked_pdf/badges/gpa.svg)](https://codeclimate.com/github/mileszs/wicked_pdf) [![Open Source Helpers](https://www.codetriage.com/mileszs/wicked_pdf/badges/users.svg)](https://www.codetriage.com/mileszs/wicked_pdf)
 
 ## 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 1.8.7 through 2.1; Rails 2 through 4.1_
+_Wicked PDF has been verified to work on Ruby versions 2.2 through 2.6; Rails 4 through 6.1_
 
 ### Installation
 
@@ -26,8 +26,8 @@ to `config/initializers/mime_types.rb` in older versions of Rails.
 
 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 (Linux, OSX, Windows) is through the gem [wkhtmltopdf-binary](https://github.com/steerio/wkhtmltopdf-binary).
-To install that, add a second gem
+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'
@@ -35,13 +35,16 @@ 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 is not available with 0.9.
+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'
+  exe_path: '/usr/local/bin/wkhtmltopdf',
+  enable_local_file_access: true
 }
 ```
 
@@ -62,7 +65,7 @@ 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.
+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
@@ -83,23 +86,57 @@ The wkhtmltopdf binary is run outside of your Rails application; therefore, your
   </body>
 </html>
 ```
-#### CDN reference
+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.
 
-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" %>
+<!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>
 ```
+
+#### Webpacker usage
+
+wicked_pdf supports webpack assets.
+
+- Use `wicked_pdf_stylesheet_pack_tag` for stylesheets
+- Use `wicked_pdf_javascript_pack_tag` for javascripts
+- Use `wicked_pdf_asset_pack_path` to access an asset directly, for example: `image_tag wicked_pdf_asset_pack_path("media/images/foobar.png")`
+
 #### 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:
+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
+
+_NOTE: Certain options are only supported in specific versions of wkhtmltopdf._
+
 ```ruby
 class ThingsController < ApplicationController
   def show
@@ -108,9 +145,11 @@ class ThingsController < ApplicationController
       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
+               template:                       'things/show',
+               locals:                         {foo: @bar},
+               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
@@ -119,6 +158,7 @@ class ThingsController < ApplicationController
                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',
@@ -132,6 +172,7 @@ class ThingsController < ApplicationController
                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,
@@ -144,21 +185,31 @@ class ThingsController < ApplicationController
                enable_plugins:                 true,
                disable_internal_links:         true,
                disable_external_links:         true,
+               keep_relative_links:            true,
                print_media_type:               true,
+
+               # define as true the key 'disable_local_file_access' or 'enable_local_file_access', not both
+               disable_local_file_access:      true,
+               enable_local_file_access:       false,                     # must be true when using wkhtmltopdf > 0.12.6
+
                disable_smart_shrinking:        true,
                use_xserver:                    true,
-               background:                     false,                     # backround needs to be true to enable background colors to render
+               background:                     false,                     # background needs to be true to enable background colors to render
                no_background:                  true,
+               no_stop_slow_scripts:           false,
                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
+               log_level:                      'info',                    # Available values: none, error, warn, or info - only available with wkhtmltopdf 0.12.5+
+               quiet:                          false,                     # `false` is same as `log_level: 'info'`, `true` is same as `log_level: 'none'`
                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
+               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',
@@ -169,8 +220,8 @@ class ThingsController < ApplicationController
                             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
+               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',
@@ -206,7 +257,8 @@ class ThingsController < ApplicationController
                             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
+                            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
@@ -214,6 +266,19 @@ 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:
@@ -230,25 +295,69 @@ 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.html.erb', layout: 'pdfs/layout_pdf'),
+  render_to_string('templates/pdf', layout: 'pdfs/layout_pdf.html'),
   footer: {
-    content: render_to_string(layout: 'pdfs/layout_pdf')
+    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.html.erb", encoding: "UTF-8"
+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:
@@ -291,7 +400,7 @@ If you would like to have WickedPdf automatically generate PDF views for all (or
 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:
+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'
@@ -299,14 +408,45 @@ config.middleware.use WickedPdf::Middleware, {}, except: [ %r[^/admin], '/secret
 ```
 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/)
+
+Corsego's 2021 post [Complete guide to generating PDFs with gem wicked_pdf](https://blog.corsego.com/gem-wicked-pdf)
+
+PDFTron's post [How to Generate PDFs With Ruby on Rails](https://www.pdftron.com/blog/rails/how-to-generate-pdf-with-ruby-on-rails/)
+
 StackOverflow [questions with the tag "wicked-pdf"](http://stackoverflow.com/questions/tagged/wicked-pdf)
 
+### Screencasts
+
+* SupeRails Screencast [EN]
+
+[![Ruby on Rails #17 generate, save, send PDFs with gem wicked_pdf](https://i3.ytimg.com/vi/tFvtwEmW-GE/hqdefault.jpg)](https://youtu.be/tFvtwEmW-GE)
+
+* codigofacilito Screencast [ES]
+
+[![Generar PDF con Ruby on Rails - Tutorial](https://i3.ytimg.com/vi/jeWM_gusmJc/hqdefault.jpg)](https://youtu.be/jeWM_gusmJc)
+
 ### 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.
@@ -317,12 +457,30 @@ 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') %>
+<%= 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).
+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.
+
+### Security considerations
+
+WickedPdf renders page content on the server by saving HTML and assets to temporary files on disk, then executing `wkhtmltopdf` to convert that HTML to a PDF file.
+
+It is highly recommended if you allow user-generated HTML/CSS/JS to be converted to PDF, you sanitize it first, or at least disallow requesting content from internal IP addresses and hostnames.
+
+For example, these could potentially leak internal AWS metadata:
+```html
+<iframe src="http://169.254.169.254/latest/meta-data/"></iframe>
+<object data="http://169.254.169.254/latest/meta-data/" type="text/html">
+```
+
+Thank you to Adam Gold from [Snyk](https://snyk.io) for reporting this.
+We are considering adding host allow & block lists and/or potentially HTML element sanitizing.
+Please open an issue or PR to help us out with this.
 
 ### Inspiration
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'rails/version'
 require 'bundler/gem_tasks'
 
 desc 'Default: run unit tests.'
-task :default => [:setup_and_run_tests, :rubocop]
+task :default => %i[setup_and_run_tests rubocop]
 
 desc 'Test the wicked_pdf plugin.'
 Rake::TestTask.new(:test) do |t|
@@ -17,16 +17,13 @@ end
 
 desc 'Run RuboCop'
 task :rubocop do
-  return unless RUBY_VERSION > '1.9.2'
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
 end
 
 desc 'Setup and run all tests'
 task :setup_and_run_tests do
-  unless File.exist?('test/dummy/config/environment.rb')
-    Rake::Task[:dummy_generate].invoke
-  end
+  Rake::Task[:dummy_generate].invoke unless File.exist?('test/dummy/config/environment.rb')
   Rake::Task[:test].invoke
 end
 
@@ -34,18 +31,24 @@ desc 'Generate dummy application for test cases'
 task :dummy_generate do
   Rake::Task[:dummy_remove].invoke
   puts 'Creating dummy application to run tests'
-  prefix = (Rails::VERSION::MAJOR == 2) ? '' : 'new '
-  system("rails #{prefix}test/dummy")
-  system("touch #{prefix}test/dummy/db/schema.rb")
+  system('rails new test/dummy --database=sqlite3')
+  system('touch test/dummy/db/schema.rb')
+  FileUtils.cp 'test/fixtures/database.yml', 'test/dummy/config/'
   FileUtils.rm_r Dir.glob('test/dummy/test/*')
+
+  # rails 6 needs this to be present before start:
+  FileUtils.mkdir_p('test/dummy/app/assets/config')
+  FileUtils.mkdir_p('test/dummy/app/assets/javascripts')
+  FileUtils.cp 'test/fixtures/manifest.js', 'test/dummy/app/assets/config/'
+  FileUtils.cp 'test/fixtures/wicked.js', 'test/dummy/app/assets/javascripts/'
 end
 
 desc 'Remove dummy application'
 task :dummy_remove do
-  FileUtils.rm_r Dir.glob('test/dummy/*')
+  FileUtils.rm_r Dir.glob('test/dummy/')
 end
 
-desc 'Generate documentation for the wicked_pdf plugin.'
+desc 'Generate documentation for the wicked_pdf gem.'
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'WickedPdf'

data/gemfiles/5.0.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+gem 'rdoc'
+gem 'sprockets', '~>3.0' # v4 strips newlines from assets causing tests to fail
+gem 'sqlite3', '~> 1.3.6'
+
+gemspec path: '../'

data/gemfiles/5.1.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+gem 'rdoc'
+gem 'sprockets', '~>3.0' # v4 strips newlines from assets causing tests to fail
+gem 'sqlite3', '~> 1.3.6'
+
+gemspec path: '../'

data/gemfiles/5.2.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'bootsnap' # required to run `rake test` in Rails 5.2
+gem 'rails', '~> 5.2'
+gem 'rdoc'
+gem 'sprockets', '~>3.0' # v4 strips newlines from assets causing tests to fail
+gem 'sqlite3', '~> 1.3.6'
+
+gemspec path: '../'

data/gemfiles/6.0.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'bootsnap' # required to run `rake test` in Rails 6.0
+gem 'bundler', '~>2'
+gem 'rails', '~>6.0.1'
+gem 'rdoc'
+gem 'sprockets', '~>3.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: '../'

data/gemfiles/6.1.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'bootsnap' # required to run `rake test` in Rails 6.1
+gem 'bundler', '~>2'
+gem 'rails', '~>6.1.0'
+gem 'webpacker'
+gem 'rdoc'
+gem 'sprockets', '~>3.0'
+gem 'sqlite3', '~> 1.4'
+gem 'rubocop', '1.11.0'
+
+gemspec :path => '../'

data/gemfiles/7.0.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'bootsnap' # required to run `rake test` in Rails 7.0
+gem 'bundler', '~>2'
+gem 'rails', '~>7.0.0'
+gem 'sprockets-rails'
+gem 'rdoc'
+gem 'sprockets', '~>3.0'
+gem 'sqlite3', '~> 1.4'
+gem 'rubocop', '1.11.0'
+
+gemspec :path => '../'

data/generators/wicked_pdf/templates/wicked_pdf.rb

@@ -15,7 +15,16 @@ WickedPdf.config = {
   #   or
   # exe_path: Gem.bin_path('wkhtmltopdf-binary', 'wkhtmltopdf')
 
+  # Needed for wkhtmltopdf 0.12.6+ to use many wicked_pdf asset helpers
+  # enable_local_file_access: true,
+
   # Layout file to be used for all PDFs
   # (but can be overridden in `render :pdf` calls)
   # layout: 'pdf.html',
+
+  # Using wkhtmltopdf without an X server can be achieved by enabling the
+  # 'use_xvfb' flag. This will wrap all wkhtmltopdf commands around the
+  # 'xvfb-run' command, in order to simulate an X server.
+  #
+  # use_xvfb: true,
 }

data/lib/generators/wicked_pdf_generator.rb

@@ -1,11 +1,7 @@
-if defined?(Rails) && Rails::VERSION::MAJOR != 2
-
-  # Rails3 generator invoked with 'rails generate wicked_pdf'
-  class WickedPdfGenerator < Rails::Generators::Base
-    source_root(File.expand_path(File.dirname(__FILE__) + '/../../generators/wicked_pdf/templates'))
-    def copy_initializer
-      copy_file 'wicked_pdf.rb', 'config/initializers/wicked_pdf.rb'
-    end
+# Rails generator invoked with 'rails generate wicked_pdf'
+class WickedPdfGenerator < Rails::Generators::Base
+  source_root(File.expand_path(File.dirname(__FILE__) + '/../../generators/wicked_pdf/templates'))
+  def copy_initializer
+    copy_file 'wicked_pdf.rb', 'config/initializers/wicked_pdf.rb'
   end
-
 end

data/lib/wicked_pdf/binary.rb

@@ -0,0 +1,65 @@
+class WickedPdf
+  class Binary
+    EXE_NAME = 'wkhtmltopdf'.freeze
+
+    attr_reader :path, :default_version
+
+    def initialize(binary_path, default_version = WickedPdf::DEFAULT_BINARY_VERSION)
+      @path = binary_path || find_binary_path
+      @default_version = default_version
+
+      raise "Location of #{EXE_NAME} unknown" if @path.empty?
+      raise "Bad #{EXE_NAME}'s path: #{@path}" unless File.exist?(@path)
+      raise "#{EXE_NAME} is not executable" unless File.executable?(@path)
+    end
+
+    def version
+      @version ||= retrieve_binary_version
+    end
+
+    def parse_version_string(version_info)
+      match_data = /wkhtmltopdf\s*(\d*\.\d*\.\d*\w*)/.match(version_info)
+      if match_data && (match_data.length == 2)
+        Gem::Version.new(match_data[1])
+      else
+        default_version
+      end
+    end
+
+    def xvfb_run_path
+      path = possible_binary_locations.map { |l| File.expand_path("#{l}/xvfb-run") }.find { |location| File.exist?(location) }
+      raise StandardError, 'Could not find binary xvfb-run on the system.' unless path
+
+      path
+    end
+
+    private
+
+    def retrieve_binary_version
+      _stdin, stdout, _stderr = Open3.popen3(@path + ' -V')
+      parse_version_string(stdout.gets(nil))
+    rescue StandardError
+      default_version
+    end
+
+    def find_binary_path
+      exe_path ||= WickedPdf.config[:exe_path] unless WickedPdf.config.empty?
+      exe_path ||= possible_which_path
+      exe_path ||= possible_binary_locations.map { |l| File.expand_path("#{l}/#{EXE_NAME}") }.find { |location| File.exist?(location) }
+      exe_path || ''
+    end
+
+    def possible_which_path
+      detected_path = (defined?(Bundler) ? Bundler.which('wkhtmltopdf') : `which wkhtmltopdf`).chomp
+      detected_path.present? && detected_path
+    rescue StandardError
+      nil
+    end
+
+    def possible_binary_locations
+      possible_locations = (ENV['PATH'].split(':') + %w[/usr/bin /usr/local/bin]).uniq
+      possible_locations += %w[~/bin] if ENV.key?('HOME')
+      possible_locations
+    end
+  end
+end

data/lib/wicked_pdf/middleware.rb

@@ -80,7 +80,7 @@ class WickedPdf
 
     def set_request_to_render_as_pdf(env)
       @render_pdf = true
-      %w(PATH_INFO REQUEST_URI).each { |e| env[e] = env[e].sub(%r{\.pdf\b}, '') }
+      %w[PATH_INFO REQUEST_URI].each { |e| env[e] = env[e].sub(%r{\.pdf\b}, '') }
       env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
       env['Rack-Middleware-WickedPdf'] = 'true'
     end