pdfkit 0.8.4.3.2 → 0.8.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9763236251a08873c269bb76fa8cbc81e64111a9bd94ea7a167c0e96ad1e0dc
-  data.tar.gz: ab65d5b9648ec671a22191cf7eca7b14d6c4b07917e45adf479046360f7adfd7
+  metadata.gz: d5a276883efaa6bba1349d1077bee9ed23e466e48006d7b87a8e6c6ffbbd83bb
+  data.tar.gz: 33632dc0ae3a917efe7a4d227ea3f1ef52a2901f125b5102f687d8058c32a135
 SHA512:
-  metadata.gz: 8ce66b221fce28fb3be395a199fdb4fc3c660a1702302c4b453bc40f39033cadc41fff9ea8a5f0e612f12a1040fbdad31e738823c6d9cf3ea2456a9ebf55b999
-  data.tar.gz: 73827642f8a0d5a87745eb9d853f9a9a9e0d62ea7ab9f31e552be71cba2c4ce7b340da992ab0eabd145a0fbb6395a30d953396fc1bf25f7410db5df9572eb6e1
+  metadata.gz: 8694cd8411e17b0a960a5a931f84960031a935bfdb2f6fc43b6b460c8434644694e0b8dd764fb151cb722b947c9775c9540bd2b5935a0bbb5021705bbe7f8b52
+  data.tar.gz: 55fdc04026f173baa10fc1f349323b243f6ef9d17142a9ab196cdc4302c2444e7a72dcf1ba68c31c3a953ab1559add63c257a1c5c1012e9a3216765ae386457e

data/.github/workflows/release-drafter.yml

@@ -12,8 +12,8 @@ jobs:
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
       - uses: release-drafter/release-drafter@v5
-        with:
+        # 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_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.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

data/.ruby-version

@@ -1 +1 @@
-2.6.4
+2.6.9

data/.travis.yml

@@ -1,10 +1,40 @@
 language: ruby
 
 rvm:
-- 2.3
-- 2.4
 - 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

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+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

data/Gemfile

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

data/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
@@ -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})
@@ -167,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
 

data/lib/pdfkit/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PDFKit
   class Configuration
     attr_accessor :meta_tag_prefix, :root_url
@@ -26,7 +28,7 @@ class PDFKit
 
     def default_wkhtmltopdf
       return @default_command_path if @default_command_path
-      if defined?(Bundler::GemfileError) && File.exists?('Gemfile')
+      if defined?(Bundler::GemfileError) && File.exist?('Gemfile')
         @default_command_path = `bundle exec which wkhtmltopdf`.chomp.lines.last
       end
       @default_command_path = `which wkhtmltopdf`.chomp if @default_command_path.nil? || @default_command_path.empty?
@@ -43,7 +45,7 @@ class PDFKit
     end
 
     def executable
-      using_xvfb? ? "xvfb-run #{wkhtmltopdf}" : wkhtmltopdf
+      using_xvfb? ? ['xvfb-run', wkhtmltopdf] : wkhtmltopdf
     end
 
     def using_xvfb?

data/lib/pdfkit/html_preprocessor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PDFKit
   module HTMLPreprocessor
 

data/lib/pdfkit/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PDFKit
   class Middleware
     def initialize(app, options = {}, conditions = {})
@@ -20,7 +22,8 @@ class PDFKit
       status, headers, response = @app.call(env)
 
       begin
-        if rendering_pdf? && headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
+        content_type_header = headers.has_key?('Content-Type') ? 'Content-Type' : 'content-type'
+        if rendering_pdf? && headers[content_type_header] =~ /text\/html|application\/xhtml\+xml/
           body = response.respond_to?(:body) ? response.body : response.join
           body = body.join if body.is_a?(Array)
 
@@ -42,13 +45,13 @@ class PDFKit
 
           unless @caching
             # Do not cache PDFs
-            headers.delete('ETag')
-            headers.delete('Cache-Control')
+            headers.delete('etag')
+            headers.delete('cache-control')
           end
 
-          headers['Content-Length'] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
-          headers['Content-Type']   = 'application/pdf'
-          headers['Content-Disposition'] ||= @conditions[:disposition] || 'inline'
+          headers['content-length'] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
+          headers[content_type_header]   = 'application/pdf'
+          headers['content-disposition'] ||= @conditions[:disposition] || 'inline'
         end
       rescue StandardError => e
         status = 500

data/lib/pdfkit/os.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rbconfig'
 
 class PDFKit

data/lib/pdfkit/pdfkit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 require 'tempfile'
 
@@ -6,8 +8,8 @@ class PDFKit
 
   class NoExecutableError < Error
     def initialize
-      msg  = "No wkhtmltopdf executable found at #{PDFKit.configuration.wkhtmltopdf}\n"
-      msg << ">> Please install wkhtmltopdf - https://github.com/pdfkit/PDFKit/wiki/Installing-WKHTMLTOPDF"
+      msg = "No wkhtmltopdf executable found at #{PDFKit.configuration.wkhtmltopdf}\n" \
+            ">> Please install wkhtmltopdf - https://github.com/pdfkit/PDFKit/wiki/Installing-WKHTMLTOPDF"
       super(msg)
     end
   end
@@ -40,20 +42,15 @@ class PDFKit
     @renderer = WkHTMLtoPDF.new options
     @renderer.normalize_options
 
-    raise NoExecutableError unless File.exists?(PDFKit.configuration.wkhtmltopdf)
+    raise NoExecutableError unless File.exist?(PDFKit.configuration.wkhtmltopdf)
   end
 
   def command(path = nil)
-    args = @renderer.options_for_command
-    shell_escaped_command = [executable, OS::shell_escape_for_os(args)].join ' '
-
-    # In order to allow for URL parameters (e.g. https://www.google.com/search?q=pdfkit) we do
-    # not escape the source. The user is responsible for ensuring that no vulnerabilities exist
-    # in the source. Please see https://github.com/pdfkit/pdfkit/issues/164.
-    input_for_command = @source.to_input_for_command
-    output_for_command = path ? Shellwords.shellescape(path) : '-'
-
-    "#{shell_escaped_command} #{input_for_command} #{output_for_command}"
+    args = [*executable]
+    args.concat(@renderer.options_for_command)
+    args << @source.to_input_for_command
+    args << (path ? path.to_s : '-')
+    args
   end
 
   def options
@@ -114,7 +111,9 @@ class PDFKit
   end
 
   def style_tag_for(stylesheet)
-    "<style>#{File.read(stylesheet)}</style>"
+    style = "<style>#{File.read(stylesheet)}</style>"
+    style = style.html_safe if style.respond_to?(:html_safe)
+    style
   end
 
   def preprocess_html
@@ -129,7 +128,9 @@ class PDFKit
 
     stylesheets.each do |stylesheet|
       if @source.to_s.match(/<\/head>/)
-        @source = Source.new(@source.to_s.gsub(/(<\/head>)/) {|s| style_tag_for(stylesheet) + s })
+        @source = Source.new(@source.to_s.gsub(/(<\/head>)/) {|s|
+          style_tag_for(stylesheet) + (s.respond_to?(:html_safe) ? s.html_safe : s)
+        })
       else
         @source.to_s.insert(0, style_tag_for(stylesheet))
       end

data/lib/pdfkit/source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 require 'uri'
 
@@ -7,6 +9,8 @@ class PDFKit
 
     def initialize(url_file_or_html)
       @source = url_file_or_html
+      # @source is assumed to be modifiable, so make sure it is.
+      @source = @source.dup if @source.is_a?(String) && @source.frozen?
     end
 
     def url?
@@ -25,7 +29,7 @@ class PDFKit
       if file?
         @source.path
       elsif url?
-        %{"#{shell_safe_url}"}
+        escaped_url
       else
         SOURCE_FROM_STDIN
       end
@@ -37,12 +41,12 @@ class PDFKit
 
     private
 
-    def shell_safe_url
-      url_needs_escaping? ? URI::escape(@source) : @source
+    def escaped_url
+      url_needs_escaping? ? URI::DEFAULT_PARSER.escape(@source) : @source
     end
 
     def url_needs_escaping?
-      URI::decode(@source) == @source
+      URI::DEFAULT_PARSER.escape(URI::DEFAULT_PARSER.unescape(@source)) != @source
     end
   end
 end

data/lib/pdfkit/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PDFKit
-  VERSION = '0.8.4.3.2'
+  VERSION = '0.8.7.3'
 end

data/lib/pdfkit/wkhtmltopdf.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class PDFKit
   class WkHTMLtoPDF
     attr_reader :options
-    # Pulled from:
-    # https://github.com/wkhtmltopdf/wkhtmltopdf/blob/ebf9b6cfc4c58a31349fb94c568b254fac37b3d3/README_WKHTMLTOIMAGE#L27
-    REPEATABLE_OPTIONS = %w[--allow --cookie --custom-header --post --post-file --run-script]
-    SPECIAL_OPTIONS = %w[cover toc]
+    # Pulled from: 
+    # https://github.com/wkhtmltopdf/wkhtmltopdf/blob/6a57c1449797d6cb915921fb747f3ac36199241f/docs/usage/wkhtmltopdf.txt#L104
+    REPEATABLE_OPTIONS = %w[--allow --bypass-proxy-for --cookie --custom-header --post --post-file --run-script --replace].freeze
+    SPECIAL_OPTIONS = %w[cover toc].freeze
 
     def initialize(options)
       @options = options
@@ -62,7 +64,7 @@ class PDFKit
       when Array
         value.flatten.collect{|x| x.to_s}
       else
-        (OS::host_is_windows? && value.to_s.index(' ')) ? "'#{ value.to_s }'" : value.to_s
+        value.to_s
       end
     end
   

data/lib/pdfkit.rb

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

data/pdfkit.gemspec

@@ -18,13 +18,15 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = ">= 2.5"
+
   s.requirements << "wkhtmltopdf"
 
   # Development Dependencies
   s.add_development_dependency(%q<activesupport>, [">= 4.1.11"])
   s.add_development_dependency(%q<mocha>, [">= 0.9.10"])
   s.add_development_dependency(%q<rack-test>, [">= 0.5.6"])
-  s.add_development_dependency(%q<rake>, ["~>12.3.3"])
-  s.add_development_dependency(%q<rdoc>, ["~> 4.0.1"])
+  s.add_development_dependency(%q<rake>, [">= 12.3.3"])
+  s.add_development_dependency(%q<rdoc>, [">= 4.0.1"])
   s.add_development_dependency(%q<rspec>, ["~> 3.0"])
 end

data/spec/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe PDFKit::Configuration do

data/spec/html_preprocessor_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe PDFKit::HTMLPreprocessor do

data/spec/middleware_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 def app; Rack::Lint.new(@app); end
@@ -17,7 +19,7 @@ end
 
 describe PDFKit::Middleware do
   let(:headers) do
-    {'Content-Type' => "text/html"}
+    {'content-type' => "text/html"}
   end
 
   describe "#call" do
@@ -53,36 +55,36 @@ describe PDFKit::Middleware do
     describe "caching" do
       let(:headers) do
         {
-          'Content-Type' => "text/html",
-          'ETag' => 'foo',
-          'Cache-Control' => 'max-age=2592000, public'
+          'content-type' => "text/html",
+          'etag' => 'foo',
+          'cache-control' => 'max-age=2592000, public'
         }
       end
 
       context "by default" do
         before { mock_app }
 
-        it "deletes ETag" do
+        it "deletes etag" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["ETag"]).to be_nil
+          expect(last_response.headers["etag"]).to be_nil
         end
-        it "deletes Cache-Control" do
+        it "deletes cache-control" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["Cache-Control"]).to be_nil
+          expect(last_response.headers["cache-control"]).to be_nil
         end
       end
 
       context "when on" do
         before { mock_app({}, :caching => true) }
 
-        it "preserves ETag" do
+        it "preserves etag" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["ETag"]).not_to be_nil
+          expect(last_response.headers["etag"]).not_to be_nil
         end
 
-        it "preserves Cache-Control" do
+        it "preserves cache-control" do
           get 'http://www.example.org/public/test.pdf'
-          expect(last_response.headers["Cache-Control"]).not_to be_nil
+          expect(last_response.headers["cache-control"]).not_to be_nil
         end
       end
     end
@@ -97,7 +99,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -105,7 +107,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -117,7 +119,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -125,7 +127,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -139,7 +141,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -147,7 +149,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -159,7 +161,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -167,7 +169,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -185,7 +187,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -193,7 +195,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -205,7 +207,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -213,7 +215,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -227,7 +229,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -235,7 +237,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -247,7 +249,7 @@ describe PDFKit::Middleware do
             context "matching" do
               specify do
                 get 'http://www.example.org/public/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+                expect(last_response.headers["content-type"]).to eq("application/pdf")
                 expect(last_response.body.bytesize).to eq(PDFKit.new("Hello world!").to_pdf.bytesize)
               end
             end
@@ -255,7 +257,7 @@ describe PDFKit::Middleware do
             context "not matching" do
               specify do
                 get 'http://www.example.org/secret/test.pdf'
-                expect(last_response.headers["Content-Type"]).to eq("text/html")
+                expect(last_response.headers["content-type"]).to eq("text/html")
                 expect(last_response.body).to eq("Hello world!")
               end
             end
@@ -267,8 +269,8 @@ describe PDFKit::Middleware do
       describe "saving generated pdf to disk" do
         before do
           #make sure tests don't find an old test_save.pdf
-          File.delete('spec/test_save.pdf') if File.exists?('spec/test_save.pdf')
-          expect(File.exists?('spec/test_save.pdf')).to eq(false)
+          File.delete('spec/test_save.pdf') if File.exist?('spec/test_save.pdf')
+          expect(File.exist?('spec/test_save.pdf')).to eq(false)
         end
 
         context "when header PDFKit-save-pdf is present" do
@@ -276,7 +278,7 @@ describe PDFKit::Middleware do
             headers = { 'PDFKit-save-pdf' => 'spec/test_save.pdf' }
             mock_app({}, {only: '/public'}, headers)
             get 'http://www.example.org/public/test_save.pdf'
-            expect(File.exists?('spec/test_save.pdf')).to eq(true)
+            expect(File.exist?('spec/test_save.pdf')).to eq(true)
           end
 
           it "does not raise when target directory does not exist" do
@@ -292,7 +294,7 @@ describe PDFKit::Middleware do
           it "does not saved the .pdf to disk" do
             mock_app({}, {only: '/public'}, {} )
             get 'http://www.example.org/public/test_save.pdf'
-            expect(File.exists?('spec/test_save.pdf')).to eq(false)
+            expect(File.exist?('spec/test_save.pdf')).to eq(false)
           end
         end
       end
@@ -346,14 +348,14 @@ describe PDFKit::Middleware do
         describe "doesn't overwrite existing value" do
           let(:headers) do
             super().merge({
-              'Content-Disposition' => 'attachment; filename=report-20200101.pdf'
+              'content-disposition' => 'attachment; filename=report-20200101.pdf'
             })
           end
 
           specify do
             mock_app({}, { :disposition => 'inline' })
             get 'http://www.example.org/public/test.pdf'
-            expect(last_response.headers["Content-Disposition"]).to eq('attachment; filename=report-20200101.pdf')
+            expect(last_response.headers["content-disposition"]).to eq('attachment; filename=report-20200101.pdf')
           end
         end
 
@@ -362,7 +364,7 @@ describe PDFKit::Middleware do
             specify do
               mock_app
               get 'http://www.example.org/public/test.pdf'
-              expect(last_response.headers["Content-Disposition"]).to eq("inline")
+              expect(last_response.headers["content-disposition"]).to eq("inline")
             end
           end
 
@@ -370,7 +372,7 @@ describe PDFKit::Middleware do
             specify do
               mock_app({}, { :disposition => 'inline'  })
               get 'http://www.example.org/public/test.pdf'
-              expect(last_response.headers["Content-Disposition"]).to eq("inline")
+              expect(last_response.headers["content-disposition"]).to eq("inline")
             end
           end
         end
@@ -380,7 +382,7 @@ describe PDFKit::Middleware do
             specify do
               mock_app({}, { :disposition => 'attachment'  })
               get 'http://www.example.org/public/test.pdf'
-              expect(last_response.headers["Content-Disposition"]).to eq("attachment")
+              expect(last_response.headers["content-disposition"]).to eq("attachment")
             end
           end
 
@@ -388,7 +390,7 @@ describe PDFKit::Middleware do
             specify do
               mock_app({}, { :disposition => 'attachment; filename=report.pdf'  })
               get 'http://www.example.org/public/test.pdf'
-              expect(last_response.headers["Content-Disposition"]).to eq("attachment; filename=report.pdf")
+              expect(last_response.headers["content-disposition"]).to eq("attachment; filename=report.pdf")
             end
           end
         end
@@ -420,6 +422,29 @@ describe PDFKit::Middleware do
       end
     end
 
+    describe "content type header" do
+      before { mock_app }
+
+      context "lower case" do
+        specify "header gets correctly updated" do
+          get 'http://www.example.org/public/test.pdf'
+          expect(last_response.headers["content-type"]).to eq("application/pdf")
+        end
+      end
+
+      context "mixed case" do
+        let(:headers) do
+          {'Content-Type' => "text/html"}
+        end
+
+        specify "header gets correctly updated" do
+          pending("this test only applies to rack 2.x and is rejected by rack 3.x") if Rack.release >= "3.0.0"
+          get 'http://www.example.org/public/test.pdf'
+          expect(last_response.headers["Content-Type"]).to eq("application/pdf")
+        end
+      end
+    end
+
     describe "remove .pdf from PATH_INFO and REQUEST_URI" do
       before { mock_app }
 
@@ -444,7 +469,7 @@ describe PDFKit::Middleware do
           main_app = lambda { |env|
             @env = env
             @env['SCRIPT_NAME'] = '/example.org'
-            headers = {'Content-Type' => "text/html"}
+            headers = {'content-type' => "text/html"}
             [200, headers, @body || ['Hello world!']]
           }
 

data/spec/os_spec.rb

@@ -1,4 +1,6 @@
 #encoding: UTF-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'rbconfig'
 

data/spec/pdfkit_spec.rb

@@ -1,4 +1,6 @@
 #encoding: UTF-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe PDFKit do
@@ -27,7 +29,7 @@ describe PDFKit do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       pdfkit = PDFKit.new(Tempfile.new(file_path))
       expect(pdfkit.source).to be_file
-      expect(pdfkit.source.to_s).to match /^#{Dir.tmpdir}/
+      expect(pdfkit.source.to_s).to match(/^#{Dir.tmpdir}/)
     end
 
     # Options
@@ -43,8 +45,8 @@ describe PDFKit do
     end
 
     it "transforms complex keys into command-line arguments" do
-      pdfkit = PDFKit.new('html', :replace => {'value' => 'something else'} )
-      expect(pdfkit.options).to have_key('--replace')
+      pdfkit = PDFKit.new('html', :header_left => {'value' => 'something else'} )
+      expect(pdfkit.options).to have_key('--header-left')
     end
 
     it "drops options with false or falsey values" do
@@ -70,8 +72,8 @@ describe PDFKit do
     end
 
     it "parses hash option values into an array" do
-      pdfkit = PDFKit.new('html', :replace => {'value' => 'something else'} )
-      expect(pdfkit.options['--replace']).to eql ['value', 'something else']
+      pdfkit = PDFKit.new('html', :header_left => {'value' => 'something else'} )
+      expect(pdfkit.options['--header-left']).to eql ['value', 'something else']
     end
 
     it "flattens hash options into the key" do
@@ -82,8 +84,8 @@ describe PDFKit do
     end
 
     it "parses array option values into a string" do
-      pdfkit = PDFKit.new('html', :replace => ['value', 'something else'] )
-      expect(pdfkit.options['--replace']).to eql ['value', 'something else']
+      pdfkit = PDFKit.new('html', :header_left => ['value', 'something else'] )
+      expect(pdfkit.options['--header-left']).to eql ['value', 'something else']
     end
 
     it "flattens array options" do
@@ -173,22 +175,36 @@ describe PDFKit do
     it "constructs the correct command" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter', :toc_l1_font_size => 12, :replace => {'foo' => 'bar'})
       command = pdfkit.command
-      expect(command).to include "wkhtmltopdf"
-      expect(command).to include "--page-size Letter"
-      expect(command).to include "--toc-l1-font-size 12"
-      expect(command).to include "--replace foo bar"
+      expect(command.first).to match(/wkhtmltopdf/)
+      expect(command).to contain %w[--page-size Letter]
+      expect(command).to contain %w[--toc-l1-font-size 12]
+      expect(command).to contain %w[--replace foo bar]
+    end
+
+    it "contains a specified by path argument" do
+      pdfkit = PDFKit.new('html')
+      command = pdfkit.command("/foo/bar")
+      expect(command.first).to match(/wkhtmltopdf/)
+      expect(command.last).to eq("/foo/bar")
+    end
+
+    it "contains a specified by path argument of Pathname" do
+      pdfkit = PDFKit.new('html')
+      command = pdfkit.command(Pathname.new("/foo/bar"))
+      expect(command.first).to match(/wkhtmltopdf/)
+      expect(command.last).to eq("/foo/bar")
     end
 
     it "sets up one cookie when hash has only one cookie" do
       pdfkit = PDFKit.new('html', cookie: {cookie_name: :cookie_value})
       command = pdfkit.command
-      expect(command).to include "--cookie cookie_name cookie_value"
+      expect(command).to contain %w[--cookie cookie_name cookie_value]
     end
 
-    it "does not break Windows paths" do
+    it "does not split Windows paths that contain spaces" do
       pdfkit = PDFKit.new('html')
       allow(PDFKit.configuration).to receive(:wkhtmltopdf).and_return 'c:/Program Files/wkhtmltopdf/wkhtmltopdf.exe'
-      expect(pdfkit.command).not_to include('Program\ Files')
+      expect(pdfkit.command).not_to contain(%w[c:/Program Files/wkhtmltopdf/wkhtmltopdf.exe])
     end
 
     it "does not shell escape source URLs" do
@@ -205,15 +221,15 @@ describe PDFKit do
     it "sets up multiple cookies when passed multiple cookies" do
       pdfkit = PDFKit.new('html', :cookie => {:cookie_name1 => :cookie_val1, :cookie_name2 => :cookie_val2})
       command = pdfkit.command
-      expect(command).to include "--cookie cookie_name1 cookie_val1"
-      expect(command).to include "--cookie cookie_name2 cookie_val2"
+      expect(command).to contain %w[--cookie cookie_name1 cookie_val1]
+      expect(command).to contain %w[--cookie cookie_name2 cookie_val2]
     end
 
     it "sets up multiple cookies when passed an array of tuples" do
       pdfkit = PDFKit.new('html', :cookie => [[:cookie_name1, :cookie_val1], [:cookie_name2, :cookie_val2]])
       command = pdfkit.command
-      expect(command).to include "--cookie cookie_name1 cookie_val1"
-      expect(command).to include "--cookie cookie_name2 cookie_val2"
+      expect(command).to contain %w[--cookie cookie_name1 cookie_val1]
+      expect(command).to contain %w[--cookie cookie_name2 cookie_val2]
     end
 
     it "will not include default options it is told to omit" do
@@ -227,48 +243,57 @@ describe PDFKit do
       expect(pdfkit.command).not_to include('--disable-smart-shrinking')
     end
 
-    it "encapsulates string arguments in quotes" do
+    it "must not split string arguments containing spaces" do
       pdfkit = PDFKit.new('html', :header_center => "foo [page]")
-      expect(pdfkit.command).to include "--header-center foo\\ \\[page\\]"
+      expect(pdfkit.command).to contain ['--header-center', 'foo [page]']
     end
 
-    it "sanitizes string arguments" do
+    it "paramatarizes string arguments" do
       pdfkit = PDFKit.new('html', :header_center => "$(ls)")
-      expect(pdfkit.command).to include "--header-center \\$\\(ls\\)"
+      expect(pdfkit.command).to contain %w[--header-center $(ls)]
     end
 
     it "read the source from stdin if it is html" do
       pdfkit = PDFKit.new('html')
-      expect(pdfkit.command).to match /- -$/
+      command = pdfkit.command
+      expect(command[-2]).to eq('-')
+      expect(command[-1]).to eq('-')
     end
 
     it "specifies the URL to the source if it is a url" do
       pdfkit = PDFKit.new('http://google.com')
-      expect(pdfkit.command).to match /"http:\/\/google.com" -$/
+      command = pdfkit.command
+      expect(command[-2]).to eq("http://google.com")
+      expect(command[-1]).to eq("-")
     end
 
     it "does not break Windows paths" do
       pdfkit = PDFKit.new('html')
       allow(PDFKit.configuration).to receive(:wkhtmltopdf).and_return 'c:/Program Files/wkhtmltopdf/wkhtmltopdf.exe'
-      expect(pdfkit.command).not_to include('Program\ Files')
+      expect(pdfkit.command).not_to contain ['Program', 'Files']
     end
 
     it "specifies the path to the source if it is a file" do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       pdfkit = PDFKit.new(File.new(file_path))
-      expect(pdfkit.command).to match /#{file_path} -$/
+      command = pdfkit.command
+      expect(command[-2]).to eq(file_path)
+      expect(command[-1]).to eq('-')
     end
 
     it "specifies the path to the source if it is a tempfile" do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       pdfkit = PDFKit.new(Tempfile.new(file_path))
-      expect(pdfkit.command).to match /#{Dir.tmpdir}\S+ -$/
+      command = pdfkit.command
+      expect(command[-2]).to start_with(Dir.tmpdir)
+      expect(command[-1]).to eq('-')
     end
 
     it "specifies the path for the ouput if a path is given" do
       file_path = "/path/to/output.pdf"
       pdfkit = PDFKit.new("html")
-      expect(pdfkit.command(file_path)).to match /#{file_path}$/
+      command = pdfkit.command(file_path)
+      expect(command.last).to eq(file_path)
     end
 
     it "detects special pdfkit meta tags" do
@@ -282,8 +307,8 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      expect(command).to include "--page-size Legal"
-      expect(command).to include "--orientation Landscape"
+      expect(command).to contain %w[--page-size Legal]
+      expect(command).to contain %w[--orientation Landscape]
     end
 
     it "detects cookies meta tag" do
@@ -297,7 +322,7 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      expect(command).to include "--cookie rails_session rails_session_value --cookie cookie_variable cookie_variable_value"
+      expect(command).to contain %w[--cookie rails_session rails_session_value --cookie cookie_variable cookie_variable_value]
     end
 
     it "detects disable_smart_shrinking meta tag" do
@@ -311,7 +336,7 @@ describe PDFKit do
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
       expect(command).to include "--disable-smart-shrinking"
-      expect(command).not_to include "--disable-smart-shrinking true"
+      expect(command).not_to contain %w[--disable-smart-shrinking true]
     end
 
     it "detects names with hyphens instead of underscores" do
@@ -340,8 +365,8 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      expect(command).to include "--page-size Legal"
-      expect(command).to include "--orientation Landscape"
+      expect(command).to contain %w[--page-size Legal]
+      expect(command).to contain %w[--orientation Landscape]
     end
 
     it "skips non-pdfkit meta tags" do
@@ -356,8 +381,8 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      expect(command).not_to include "--page-size Legal"
-      expect(command).to include "--orientation Landscape"
+      expect(command).not_to contain %w[--page-size Legal]
+      expect(command).to contain %w[--orientation Landscape]
     end
 
     it "does not use quiet when told to" do
@@ -420,14 +445,9 @@ describe PDFKit do
         allow(PDFKit::OS).to receive(:host_is_windows?).and_return(true)
       end
 
-      it "escapes special windows characters" do
-        pdf = PDFKit.new('html', :title => 'hello(world)')
-        expect(pdf.command).to include 'hello^(world^)'
-      end
-
       it "quotes spaces in options" do
         pdf = PDFKit.new('html', :title => 'hello world')
-        expect(pdf.command).to include "--title 'hello world'"
+        expect(pdf.command).to contain ['--title', "hello world"]
       end
     end
   end
@@ -501,6 +521,14 @@ describe PDFKit do
       expect(pdfkit.source.to_s).to include("<style>#{File.read(css)}</style></head>")
     end
 
+    it "can deal with ActiveSupport::SafeBuffer if the HTML doesn't have a head tag" do
+      pdfkit = PDFKit.new(ActiveSupport::SafeBuffer.new "<html><body>Hai!</body></html>")
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      expect(pdfkit.source.to_s).to include("<style>#{File.read(css)}</style>")
+    end
+
     it "escapes \\X in stylesheets" do
       pdfkit = PDFKit.new("<html><head></head><body>Hai!</body></html>")
       css = File.join(SPEC_ROOT,'fixtures','example_with_hex_symbol.css')

data/spec/source_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe PDFKit::Source do
@@ -73,14 +75,14 @@ describe PDFKit::Source do
   end
 
   describe "#to_input_for_command" do
-    it "URI escapes source URLs and encloses them in quotes to accomodate ampersands" do
-      source = PDFKit::Source.new("https://www.google.com/search?q='cat<dev/zero>/dev/null'")
-      expect(source.to_input_for_command).to eq "\"https://www.google.com/search?q='cat%3Cdev/zero%3E/dev/null'\""
+    it "URI escapes source URI" do
+      source = PDFKit::Source.new("https://www.google.com/search?q=foo bar")
+      expect(source.to_input_for_command).to eq "https://www.google.com/search?q=foo%20bar"
     end
 
     it "does not URI escape previously escaped source URLs" do
-      source = PDFKit::Source.new("https://www.google.com/search?q='cat%3Cdev/zero%3E/dev/null'")
-      expect(source.to_input_for_command).to eq "\"https://www.google.com/search?q='cat%3Cdev/zero%3E/dev/null'\""
+      source = PDFKit::Source.new("https://www.google.com/search?q=foo%20bar")
+      expect(source.to_input_for_command).to eq "https://www.google.com/search?q=foo%20bar"
     end
 
     it "returns a '-' for HTML strings to indicate that we send that content through STDIN" do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SPEC_ROOT = File.dirname(__FILE__)
 $LOAD_PATH.unshift(SPEC_ROOT)
 $LOAD_PATH.unshift(File.join(SPEC_ROOT, '..', 'lib'))
@@ -6,14 +8,26 @@ SimpleCov.start do
   add_filter 'spec/'
 end
 
+Warning[:deprecated] = true if defined?(Warning.[]=)
+
 require 'pdfkit'
 require 'rspec'
 require 'mocha'
 require 'rack'
 require 'rack/test'
 require 'active_support'
-require 'custom_wkhtmltopdf_path' if File.exists?(File.join(SPEC_ROOT, 'custom_wkhtmltopdf_path.rb'))
+require 'custom_wkhtmltopdf_path' if File.exist?(File.join(SPEC_ROOT, 'custom_wkhtmltopdf_path.rb'))
 
 RSpec.configure do |config|
   include Rack::Test::Methods
 end
+
+RSpec::Matchers.define :contain do |expected|
+  match do |actual|
+    (0..(actual.length - expected.length)).any? do |base_index|
+      expected.each_with_index.all? do |expected_element,index|
+        actual[base_index+index] == expected_element
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pdfkit
 version: !ruby/object:Gem::Version
-  version: 0.8.4.3.2
+  version: 0.8.7.3
 platform: ruby
 authors:
 - Jared Pace
 - Relevance
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,28 +57,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.1
 - !ruby/object:Gem::Dependency
@@ -105,6 +105,7 @@ files:
 - ".document"
 - ".github/workflows/release-drafter.yml"
 - ".github/workflows/stale.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -140,7 +141,7 @@ homepage: https://github.com/pdfkit/pdfkit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - wkhtmltopdf
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: HTML+CSS -> PDF
 test_files: