Bring up to speed with base

.github/workflows/release-drafter.yml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # with:
+          # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+          # config-name: my-config.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "0 0 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue has been marked as stale and will be automatically closed.'
+        stale-pr-message: 'This pull request has been marked as stale and will be automatically closed.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

.github/workflows/test.yml

@@ -0,0 +1,71 @@
+name: Test workflow
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+        rails:
+          - '~> 4.1'
+          - '~> 5.2'
+          - '~> 6.0.0'
+          - '~> 6.1'
+          - '~> 7.0.0'
+        exclude:
+          - ruby: '2.5'
+            rails: '~> 7.0.0'
+          - ruby: '2.6'
+            rails: '~> 7.0.0'
+          - ruby: '2.7'
+            rails: '~> 4.1'
+          - ruby: '3.0'
+            rails: '~> 4.1'
+          - ruby: '3.0'
+            rails: '~> 5.2'
+          - ruby: '3.1'
+            rails: '~> 4.1'
+          - ruby: '3.1'
+            rails: '~> 5.2'
+          - ruby: '3.1'
+            rails: '~> 6.0.0'
+    runs-on: ${{ matrix.os }}
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      # rubygems-update's latest is no longer compatible with ruby 2.5, so conditionally run ruby-setup setting the
+      # rubygem version the most recent valid version for 2.5:
+      # https://rubygems.org/gems/rubygems-update/versions/3.3.26
+      if: ${{ matrix.ruby == '2.5' }}
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        rubygems: 3.3.26
+        bundler: latest
+        bundler-cache: true
+    - uses: ruby/setup-ruby@v1
+      # otherwise, we can use rubygems latest
+      if: ${{ matrix.ruby != '2.5' }}
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        rubygems: latest
+        bundler: latest
+        bundler-cache: true
+
+    - name: Setup wkhtmltopdf
+      run: |
+        sudo apt-get install -y xfonts-base xfonts-75dpi
+        wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6-1/wkhtmltox_0.12.6-1.bionic_amd64.deb
+        sudo dpkg -i wkhtmltox_0.12.6-1.bionic_amd64.deb
+
+    - name: Run tests
+      run: bundle exec rake

.ruby-version

@@ -1 +1 @@
-ruby-2.0.0
+2.6.9

.travis.yml

@@ -1,16 +1,46 @@
+language: ruby
+
 rvm:
-- 1.9.2
-- 1.9.3
-- 2.0
-- 2.1
+- 2.5
+- 2.6
+- 2.7
+- 3.0
+- 3.1
+
+env:
+  matrix:
+    - RAILS_VERSION="~> 4.1"
+    - RAILS_VERSION="~> 5.2"
+    - RAILS_VERSION="~> 6.0.0"
+    - RAILS_VERSION="~> 6.1"
+    - RAILS_VERSION="~> 7.0.0"
+
+jobs:
+  exclude:
+  - rvm: 2.5
+    env: RAILS_VERSION="~> 7.0.0"
+  - rvm: 2.6
+    env: RAILS_VERSION="~> 7.0.0"
+  - rvm: 2.7
+    env: RAILS_VERSION="~> 4.1"
+  - rvm: 3.0
+    env: RAILS_VERSION="~> 4.1"
+  - rvm: 3.0
+    env: RAILS_VERSION="~> 5.2"
+  - rvm: 3.1
+    env: RAILS_VERSION="~> 4.1"
+  - rvm: 3.1
+    env: RAILS_VERSION="~> 5.2"
+  - rvm: 3.1
+    env: RAILS_VERSION="~> 6.0.0"
+
+cache: bundler
 
 before_install:
   - gem update --system
   - gem update bundler
 
 before_script:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
   - "sudo apt-get -qq -y install fontconfig libxrender1"
-  - "wget http://download.gna.org/wkhtmltopdf/0.12/0.12.1/wkhtmltox-0.12.1_linux-precise-amd64.deb"
-  - "sudo dpkg -i wkhtmltox-0.12.1_linux-precise-amd64.deb"
+  - "wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.xenial_amd64.deb"
+  - "sudo apt-get install ./wkhtmltox_0.12.5-1.xenial_amd64.deb"

CHANGELOG.md

@@ -1,3 +1,72 @@
+2023-02-27
+=================
+  * Bump to 0.8.7.3
+  * Allow passing a `Pathname` object to the `path` argument by @yujideveloper in https://github.com/pdfkit/pdfkit/pull/522
+  * Update repeatable options by @mguidetti in https://github.com/pdfkit/pdfkit/pull/524
+
+2022-10-18
+=================
+  * Bump to 0.8.7.2
+  * Call IO.popen with an Array of command arguments (#519)
+
+2022-10-17
+=================
+  * Bump to 0.8.7.1
+  * Support non-lower-case Content-Type header provided by app (#516)
+
+2022-10-02
+=================
+  * Bump to 0.8.7
+  * Lowercase the header names for rack 3 changes (#511)
+  * Partially escaped URLs should be escaped (#509)
+
+2022-04-11
+=================
+  * Bump to 0.8.6
+  * Update ruby and rails versions
+
+2021-01-23
+=================
+  * Bump to 0.8.5
+  * Make `PDFKit::VERSION` public (#484) 
+  * Fix to render stylesheets as html safe string on Rails 6 (#483)
+      * Adds support for Rails 6
+
+2020-08-16
+=================
+  * Bump to 0.8.4.3.2
+  * Reduce scope of middleware exception handling (#476)
+
+2020-07-05
+=================
+  * Bump to 0.8.4.3.1
+  * Don't override request level Content-Disposition header if it exists (#466)
+  * Update rake (#471)
+  * Add missing require statements for tempfile (#467)
+  * Only grab last line of bundle exec which output (#464)
+  * Return 500 status when an exception is caught in middleware (#469)
+  * Update Travis CI URL for wkhtmltopf (#473)
+
+2020-04-01
+=================
+  * Bump to 0.8.4.2
+  * Improve path detection feedback (#460)
+  * Fix typos (#444)
+  * Update readme (#439)
+
+2019-02-22
+=================
+  * Bump to 0.8.4.1
+  * Make PDFkit threadsafe (#377)
+  * Update activesupport (#434)
+
+2019-02-21
+=================
+  * Bump to 0.8.4
+  * Removed support for Ruby < 2.2
+  * Xvfb support (#277)
+  * Remove 'config.protocol' from the README (#389)
+
 2015-08-26
 =================
   * Bump to 0.8.2

Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 group :test do
-  gem 'activesupport', '~> 3.0'
+  gem 'activesupport', ENV['RAILS_VERSION'] || '~> 4.1'
   gem 'simplecov', require: false
 end
 

README.md

@@ -2,6 +2,11 @@
 
 Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the back-end which renders HTML using Webkit.
 
+## Supported versions
+
+- Ruby 2.5, 2.6, 2.7, 3.0, 3.1
+- Rails 4.2, 5.2, 6.0, 6.1, 7.0
+
 ## Install
 
 ### PDFKit
@@ -14,7 +19,7 @@ gem install pdfkit
 
     <https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF>
 
-2.  Try using the `wkhtmltopdf-binary` gem (mac + linux i386)
+2.  Try using the `wkhtmltopdf-binary-edge` gem (mac + linux i386)
 ```
 gem install wkhtmltopdf-binary
 ```
@@ -34,7 +39,7 @@ pdf = kit.to_pdf
 file = kit.to_file('/path/to/save/pdf')
 
 # PDFKit.new can optionally accept a URL or a File.
-# Stylesheets can not be added when source is provided as a URL of File.
+# Stylesheets can not be added when source is provided as a URL or File.
 kit = PDFKit.new('http://google.com')
 kit = PDFKit.new(File.new('/path/to/html'))
 
@@ -58,7 +63,7 @@ PDFKit.new(html, protocol: 'https').to_file
 ```
 
 ### Using cookies in scraping
-If you want to pass a cookie to cookie to pdfkit to scrape a website, you can
+If you want to pass a cookie to pdfkit to scrape a website, you can
 pass it in a hash:
 ```ruby
 kit = PDFKit.new(url, cookie: {cookie_name: :cookie_value})
@@ -76,7 +81,6 @@ PDFKit.configure do |config|
   }
   # Use only if your external hostname is unavailable on the server.
   config.root_url = "http://localhost"
-  config.protocol = 'http'
   config.verbose = false
 end
 ```
@@ -117,6 +121,13 @@ config.middleware.use PDFKit::Middleware, {}, :except => [%r[^/prawn], %r[^/secr
 # conditions can be strings (either one or an array)
 config.middleware.use PDFKit::Middleware, {}, :except => ['/secret']
 ```
+**With conditions to force download**
+```ruby
+# force download with attachment disposition
+config.middleware.use PDFKit::Middleware, {}, :disposition => 'attachment'
+# conditions can force a filename
+config.middleware.use PDFKit::Middleware, {}, :disposition => 'attachment; filename=report.pdf'
+```
 **Saving the generated .pdf to disk**
 
 Setting the `PDFKit-save-pdf` header will cause PDFKit to write the generated .pdf to the file indicated by the value of the header.
@@ -126,7 +137,7 @@ For example:
 headers['PDFKit-save-pdf'] = 'path/to/saved.pdf'
 ```
 
-Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent back to the client.  If the path is not writable/non-existant the write will fail silently.  The `PDFKit-save-pdf` header is never sent back to the client.
+Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent back to the client.  If the path is not writable/non-existent the write will fail silently.  The `PDFKit-save-pdf` header is never sent back to the client.
 
 ## Troubleshooting
 
@@ -141,13 +152,13 @@ Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent
    around this issue you may want to run a server with multiple workers
    like Passenger or try to embed your resources within your HTML to
    avoid extra HTTP requests.
-   
+
    Example solution (rails / bundler), add unicorn to the development
    group in your Gemfile `gem 'unicorn'` then run `bundle`. Next, add a
    file `config/unicorn.conf` with
-   
+
         worker_processes 3
-   
+
    Then to run the app `unicorn_rails -c config/unicorn.conf` (from rails_root)
 
 *  **Resources aren't included in the PDF:** Images, CSS, or JavaScript
@@ -161,7 +172,7 @@ Will cause the .pdf to be saved to `path/to/saved.pdf` in addition to being sent
    asset host.
 
 *  **Mangled output in the browser:** Be sure that your HTTP response
-   headers specify "Content-Type: application/pdf"
+   headers specify "content-type: application/pdf"
 
 ## Note on Patches/Pull Requests
 

lib/pdfkit.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'pdfkit/source'
 require 'pdfkit/pdfkit'
 require 'pdfkit/middleware'
 require 'pdfkit/html_preprocessor'
 require 'pdfkit/os'
 require 'pdfkit/configuration'
 require 'pdfkit/wkhtmltopdf'
+require 'pdfkit/version'