RubyGems - pdfkit - Versions diffs - 0.8.2 → 0.8.7.1 - Mend

pdfkit 0.8.2 → 0.8.7.1

Potentially problematic release.

This version of pdfkit might be problematic. Click here for more details.

Files changed (27) hide show

checksums.yaml +5 -5
data/.github/workflows/release-drafter.yml +19 -0
data/.github/workflows/stale.yml +19 -0
data/.github/workflows/test.yml +59 -0
data/.ruby-version +1 -1
data/.travis.yml +42 -8
data/CHANGELOG.md +58 -0
data/Gemfile +1 -1
data/README.md +36 -10
data/lib/pdfkit/configuration.rb +38 -3
data/lib/pdfkit/html_preprocessor.rb +25 -0
data/lib/pdfkit/middleware.rb +53 -43
data/lib/pdfkit/os.rb +21 -0
data/lib/pdfkit/pdfkit.rb +50 -105
data/lib/pdfkit/source.rb +8 -3
data/lib/pdfkit/version.rb +3 -1
data/lib/pdfkit/wkhtmltopdf.rb +82 -0
data/lib/pdfkit.rb +6 -0
data/pdfkit.gemspec +9 -7
data/spec/configuration_spec.rb +85 -12
data/spec/html_preprocessor_spec.rb +71 -0
data/spec/middleware_spec.rb +237 -104
data/spec/os_spec.rb +67 -0
data/spec/pdfkit_spec.rb +47 -6
data/spec/source_spec.rb +32 -0
data/spec/spec_helper.rb +5 -1
metadata +45 -48

data/spec/pdfkit_spec.rb CHANGED Viewed

@@ -1,4 +1,6 @@
 #encoding: UTF-8
+# frozen_string_literal: true
 require 'spec_helper'
 describe PDFKit do
@@ -23,6 +25,13 @@ describe PDFKit do
       expect(pdfkit.source.to_s).to eq(file_path)
     end
+    it "accepts a Tempfile as the source" 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}/)
+    end
     # Options
     ## options keys
     it "drops options without values" do
@@ -232,12 +241,12 @@ describe PDFKit do
     it "read the source from stdin if it is html" do
       pdfkit = PDFKit.new('html')
-      expect(pdfkit.command).to match /- -$/
+      expect(pdfkit.command).to match(/- -$/)
     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" -$/
+      expect(pdfkit.command).to match(/"http:\/\/google.com" -$/)
     end
     it "does not break Windows paths" do
@@ -249,13 +258,19 @@ describe PDFKit do
     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} -$/
+      expect(pdfkit.command).to match(/#{file_path} -$/)
+    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+ -$/)
     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}$/
+      expect(pdfkit.command(file_path)).to match(/#{file_path}$/)
     end
     it "detects special pdfkit meta tags" do
@@ -384,9 +399,27 @@ describe PDFKit do
       end
     end
+    it "does not use xvfb-run wrapper by default" do
+      pdfkit = PDFKit.new('html')
+      expect(pdfkit.command).not_to include 'xvfb-run'
+    end
+    it "uses xvfb-run wrapper when option of using xvfb is configured" do
+      PDFKit.configure do |config|
+        config.use_xvfb = true
+      end
+      pdfkit = PDFKit.new('html')
+      expect(pdfkit.command).to include 'xvfb-run'
+      PDFKit.configure do |config|
+        config.use_xvfb = false
+      end
+    end
     context "on windows" do
       before do
-        allow_any_instance_of(PDFKit).to receive(:host_is_windows?).and_return(true)
+        allow(PDFKit::OS).to receive(:host_is_windows?).and_return(true)
       end
       it "escapes special windows characters" do
@@ -470,6 +503,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')
@@ -481,7 +522,7 @@ describe PDFKit do
     #NOTICE: This test is failed if use wkhtmltopdf-binary (0.9.9.1)
     it "throws an error if it is unable to connect" do
       pdfkit = PDFKit.new("http://google.com/this-should-not-be-found/404.html")
-      expect { pdfkit.to_pdf }.to raise_error /exitstatus=1/
+      expect { pdfkit.to_pdf }.to raise_error PDFKit::ImproperWkhtmltopdfExitStatus, /exitstatus=1/
     end
     it "does not throw an error if it is unable to connect", pending: 'this test works for wkhtmltopdf-binary (0.9.9.1)' do

data/spec/source_spec.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require 'spec_helper'
 describe PDFKit::Source do
@@ -12,6 +14,11 @@ describe PDFKit::Source do
       expect(source).not_to be_url
     end
+    it "returns false if passed a tempfile" do
+      source = PDFKit::Source.new(::Tempfile.new(__FILE__))
+      expect(source).not_to be_url
+    end
     it "returns false if passed HTML" do
       source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
       expect(source).not_to be_url
@@ -29,6 +36,11 @@ describe PDFKit::Source do
       expect(source).to be_file
     end
+    it "returns true if passed a tempfile" do
+      source = PDFKit::Source.new(::Tempfile.new(__FILE__))
+      expect(source).to be_file
+    end
     it "returns false if passed a url like string" do
       source = PDFKit::Source.new('http://google.com')
       expect(source).not_to be_file
@@ -51,6 +63,11 @@ describe PDFKit::Source do
       expect(source).not_to be_html
     end
+    it "returns false if passed a tempfile" do
+      source = PDFKit::Source.new(::Tempfile.new(__FILE__))
+      expect(source).not_to be_html
+    end
     it "returns false if passed a url like string" do
       source = PDFKit::Source.new('http://google.com')
       expect(source).not_to be_html
@@ -63,6 +80,11 @@ describe PDFKit::Source do
       expect(source.to_input_for_command).to eq "\"https://www.google.com/search?q='cat%3Cdev/zero%3E/dev/null'\""
     end
+    it "URI escapes source URI only escape part of it" do
+      source = PDFKit::Source.new("https://www.google.com/search?q='%20 sleep 5'")
+      expect(source.to_input_for_command).to eq "\"https://www.google.com/search?q='%2520%20sleep%205'\""
+    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'\""
@@ -77,6 +99,11 @@ describe PDFKit::Source do
       source = PDFKit::Source.new(::File.new(__FILE__))
       expect(source.to_input_for_command).to match 'spec/source_spec.rb'
     end
+    it "returns the file path for tempfile sources" do
+      source = PDFKit::Source.new(file = ::Tempfile.new(__FILE__))
+      expect(source.to_input_for_command).to match file.path
+    end
   end
   describe "#to_s" do
@@ -90,6 +117,11 @@ describe PDFKit::Source do
       expect(source.to_s).to eq(__FILE__)
     end
+    it "returns a path if passed a tempfile" do
+      source = PDFKit::Source.new(file = ::Tempfile.new(__FILE__))
+      expect(source.to_s).to eq(file.path)
+    end
     it "returns the url if passed a url like string" do
       source = PDFKit::Source.new('http://google.com')
       expect(source.to_s).to eq('http://google.com')

data/spec/spec_helper.rb CHANGED Viewed

@@ -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,13 +8,15 @@ 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

metadata CHANGED Viewed

@@ -1,112 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: pdfkit
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.7.1
 platform: ruby
 authors:
 - Jared Pace
 - Relevance
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: 4.1.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: 4.1.11
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.6
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        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
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Uses wkhtmltopdf to create PDFs using HTML
@@ -116,12 +102,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".document"
+- ".github/workflows/release-drafter.yml"
+- ".github/workflows/stale.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -130,40 +119,46 @@ files:
 - Rakefile
 - lib/pdfkit.rb
 - lib/pdfkit/configuration.rb
+- lib/pdfkit/html_preprocessor.rb
 - lib/pdfkit/middleware.rb
+- lib/pdfkit/os.rb
 - lib/pdfkit/pdfkit.rb
 - lib/pdfkit/source.rb
 - lib/pdfkit/version.rb
+- lib/pdfkit/wkhtmltopdf.rb
 - pdfkit.gemspec
 - spec/configuration_spec.rb
 - spec/fixtures/example.css
 - spec/fixtures/example.html
 - spec/fixtures/example_with_hex_symbol.css
+- spec/html_preprocessor_spec.rb
 - spec/middleware_spec.rb
+- spec/os_spec.rb
 - spec/pdfkit_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pdfkit/pdfkit
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 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:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubyforge_project: pdfkit
-rubygems_version: 2.4.6
-signing_key:
+requirements:
+- wkhtmltopdf
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: HTML+CSS -> PDF
 test_files:
@@ -171,7 +166,9 @@ test_files:
 - spec/fixtures/example.css
 - spec/fixtures/example.html
 - spec/fixtures/example_with_hex_symbol.css
+- spec/html_preprocessor_spec.rb
 - spec/middleware_spec.rb
+- spec/os_spec.rb
 - spec/pdfkit_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb