pdfkit 0.8.4.1 → 0.8.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5beb396f2168a0c0ca91ee77bba2af22421d445ea05bbb5f57f687957b75e1
-  data.tar.gz: 96505e77627a3655edfd2c91c5ad190faea49fa7df184d456d838fa3ec620b08
+  metadata.gz: d07f9293cf2555d6bf3f44fce50ff185524fd202073fcd00fe0e6b2fb094963d
+  data.tar.gz: ede68296b5314d8572b002945360e0c2cb90d95f57440f8a6213d9054a436dcc
 SHA512:
-  metadata.gz: b07cf202025b2f252250d76be4b293c2cb3a0ec1b89666d5aec74dafa377e675190074f7dd2e2eba7ea2d6744e1f31be75ecf632827ce27dc209fbf9f137e564
-  data.tar.gz: 86c5e37ed66290882d4e7e0c7d7c7fb2b378068e9d1b28a4837acbc6268ee0da60819c5efdafc2c1ad0940adf30cbd084219fd3413efb1f9b4feefb5105dc55f
+  metadata.gz: 2447695954315c580730d87c1f0ed2353228ca3e564a5692fef67d4d2d2fc244e6f2442e1b69c433f35b92c685acc35cd3764c111dcaa69f773cd67e77d725e7
+  data.tar.gz: b106bb8ead667a62cca3f4790ea0c074301ea02ab693e7b39a5b7006ddc314700a95eed42507c007010c8134c40665024d32a421e664541aff8a0d6bd9ddd4db

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

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.4

data/.travis.yml

@@ -1,16 +1,16 @@
+language: ruby
+
 rvm:
-- 2.2
 - 2.3
 - 2.4
 - 2.5
+- 2.6
 
 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 https://downloads.wkhtmltopdf.org/0.12/0.12.5/wkhtmltox_0.12.5-1.trusty_amd64.deb"
-  - "sudo apt-get install ./wkhtmltox_0.12.5-1.trusty_amd64.deb"
+  - "wget https://downloads.wkhtmltopdf.org/0.12/0.12.5/wkhtmltox_0.12.5-1.xenial_amd64.deb"
+  - "sudo apt-get install ./wkhtmltox_0.12.5-1.xenial_amd64.deb"

data/CHANGELOG.md

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

data/README.md

@@ -14,7 +14,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 +34,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'))
 
@@ -116,6 +116,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, {}, :dispositon => 'attachment'
+# conditions can force a filename
+config.middleware.use PDFKit::Middleware, {}, :dispositon => '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.
@@ -125,7 +132,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
 
@@ -140,13 +147,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

data/lib/pdfkit/configuration.rb

@@ -1,7 +1,8 @@
 class PDFKit
   class Configuration
-    attr_accessor :meta_tag_prefix, :default_options, :root_url
+    attr_accessor :meta_tag_prefix, :root_url
     attr_writer :use_xvfb, :verbose
+    attr_reader :default_options
 
     def initialize
       @verbose         = false
@@ -24,14 +25,19 @@ class PDFKit
     end
 
     def default_wkhtmltopdf
-      @default_command_path ||= (defined?(Bundler::GemfileError) && File.exists?('Gemfile') ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+      return @default_command_path if @default_command_path
+      if defined?(Bundler::GemfileError) && File.exists?('Gemfile')
+        @default_command_path = `bundle exec which wkhtmltopdf`.chomp
+      end
+      @default_command_path = `which wkhtmltopdf`.chomp if @default_command_path.nil? || @default_command_path.empty?
+      @default_command_path
     end
 
     def wkhtmltopdf=(path)
       if File.exist?(path)
         @wkhtmltopdf = path
       else
-        warn "No executable found at #{path}. Will fall back to #{default_wkhtmltopdf}" unless File.exist?(path)
+        warn "No executable found at #{path}. Will fall back to #{default_wkhtmltopdf}"
         @wkhtmltopdf = default_wkhtmltopdf
       end
     end
@@ -51,6 +57,10 @@ class PDFKit
     def verbose?
       @verbose
     end
+
+    def default_options=(options)
+      @default_options.merge!(options)
+    end
   end
 
   class << self

data/lib/pdfkit/middleware.rb

@@ -47,6 +47,7 @@ class PDFKit
 
         headers['Content-Length'] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
         headers['Content-Type']   = 'application/pdf'
+        headers['Content-Disposition'] = @conditions[:disposition] || 'inline'
       end
 
       [status, headers, response]

data/lib/pdfkit/pdfkit.rb

@@ -1,7 +1,9 @@
 require 'shellwords'
 
 class PDFKit
-  class NoExecutableError < StandardError
+  class Error < StandardError; end
+
+  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"
@@ -9,12 +11,18 @@ class PDFKit
     end
   end
 
-  class ImproperSourceError < StandardError
+  class ImproperSourceError < Error
     def initialize(msg)
       super("Improper Source: #{msg}")
     end
   end
 
+  class ImproperWkhtmltopdfExitStatus < Error
+    def initialize(invoke)
+      super("Command failed (exitstatus=#{$?.exitstatus}): #{invoke}")
+    end
+  end
+
   attr_accessor :source, :stylesheets
   attr_reader :renderer
 
@@ -31,7 +39,7 @@ class PDFKit
     @renderer = WkHTMLtoPDF.new options
     @renderer.normalize_options
 
-    raise NoExecutableError.new unless File.exists?(PDFKit.configuration.wkhtmltopdf)
+    raise NoExecutableError unless File.exists?(PDFKit.configuration.wkhtmltopdf)
   end
 
   def command(path = nil)
@@ -70,7 +78,7 @@ class PDFKit
 
     # $? is thread safe per
     # http://stackoverflow.com/questions/2164887/thread-safe-external-process-in-ruby-plus-checking-exitstatus
-    raise "command failed (exitstatus=#{$?.exitstatus}): #{invoke}" if empty_result?(path, result) or !successful?($?)
+    raise ImproperWkhtmltopdfExitStatus, invoke if empty_result?(path, result) || !successful?($?)
     return result
   end
 
@@ -83,7 +91,7 @@ class PDFKit
 
   def find_options_in_meta(content)
     # Read file if content is a File
-    content = content.read if content.is_a?(File)
+    content = content.read if content.is_a?(File) || content.is_a?(Tempfile)
 
     found = {}
     content.scan(/<meta [^>]*>/) do |meta|
@@ -116,7 +124,7 @@ class PDFKit
   end
 
   def append_stylesheets
-    raise ImproperSourceError.new('Stylesheets may only be added to an HTML source') if stylesheets.any? && !@source.html?
+    raise ImproperSourceError, 'Stylesheets may only be added to an HTML source' if stylesheets.any? && !@source.html?
 
     stylesheets.each do |stylesheet|
       if @source.to_s.match(/<\/head>/)

data/lib/pdfkit/source.rb

@@ -13,7 +13,7 @@ class PDFKit
     end
 
     def file?
-      @is_file ||= @source.kind_of?(File)
+      @is_file ||= @source.kind_of?(File) || @source.kind_of?(Tempfile)
     end
 
     def html?

data/lib/pdfkit/version.rb

@@ -1,3 +1,3 @@
 class PDFKit
-  VERSION = '0.8.4.1'
+  VERSION = '0.8.4.2'
 end

data/pdfkit.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |s|
   s.description = "Uses wkhtmltopdf to create PDFs using HTML"
   s.license     = "MIT"
 
-  s.rubyforge_project = "pdfkit"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/spec/configuration_spec.rb

@@ -3,11 +3,48 @@ require 'spec_helper'
 describe PDFKit::Configuration do
   subject { PDFKit::Configuration.new }
   describe "#wkhtmltopdf" do
+    context "when explicitly configured" do
+      it "uses configured value and don't detect" do
+        expect(subject).not_to receive(:default_wkhtmltopdf)
+        subject.wkhtmltopdf = "./Gemfile" # Need a file which exists
+        expect(subject.wkhtmltopdf).to eq("./Gemfile")
+      end
+
+      it "falls back to detected binary if configured path doesn't exists" do
+        expect(subject).to receive(:default_wkhtmltopdf).twice.and_return("/bin/fallback")
+        expect(subject).to receive(:warn).with(/No executable found/)
+        subject.wkhtmltopdf = "./missing-file" # Need a file which doesn't exist
+        expect(subject.wkhtmltopdf).to eq("/bin/fallback")
+      end
+    end
+
     context "when not explicitly configured" do
-      it "detects the existance of bundler" do
-        # Test assumes bundler is installed in your test environment
-        expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return('c:\windows\path.exe')
-        subject.wkhtmltopdf
+      context "when running inside bundler" do
+        # Simulate the presence of bundler even if it's not here
+        before { stub_const("Bundler::GemfileError", Class) }
+
+        it "detects the existance of bundler" do
+          expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return("c:\\windows\\path.exe\n")
+          expect(subject.wkhtmltopdf).to eq('c:\windows\path.exe')
+        end
+
+        it "falls back if bundler path fails" do
+          # This happens when there is a wrong (buggy) version of bundler for example
+          expect(subject).to receive(:`).with('bundle exec which wkhtmltopdf').and_return("")
+          expect(subject).to receive(:`).with('which wkhtmltopdf').and_return("c:\\windows\\path.exe\n")
+          expect(subject.wkhtmltopdf).to eq('c:\windows\path.exe')
+        end
+      end
+
+      context "when running without bundler" do
+        # Simulate the absence of bundler even if it's there
+        before { hide_const("Bundler::GemfileError") }
+
+        it "detects the existance of bundler" do
+          expect(subject).not_to receive(:`).with('bundle exec which wkhtmltopdf')
+          expect(subject).to receive(:`).with('which wkhtmltopdf').and_return('c:\windows\path.exe')
+          expect(subject.wkhtmltopdf).to eq('c:\windows\path.exe')
+        end
       end
     end
   end
@@ -40,6 +77,13 @@ describe PDFKit::Configuration do
       expect(subject.default_options[:quiet]).to eql false
       expect(subject.default_options[:is_awesome]).to eql true
     end
+
+    it "merges additional options with existing defaults" do
+      subject.default_options = { quiet: false, is_awesome: true }
+      expect(subject.default_options[:quiet]).to eql false
+      expect(subject.default_options[:is_awesome]).to eql true
+      expect(subject.default_options[:disable_smart_shrinking]).to eql false
+    end
   end
 
   describe "#root_url" do

data/spec/middleware_spec.rb

@@ -341,6 +341,44 @@ describe PDFKit::Middleware do
           end
         end
       end
+
+      describe ":disposition" do
+        describe "inline or blank" do
+          context "default" do
+            specify do
+              mock_app
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("inline")
+            end
+          end
+
+          context "inline" do
+            specify do
+              mock_app({}, { :disposition => 'inline'  })
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("inline")
+            end
+          end
+        end
+
+        describe "attachment" do
+          context "attachment" do
+            specify do
+              mock_app({}, { :disposition => 'attachment'  })
+              get 'http://www.example.org/public/test.pdf'
+              expect(last_response.headers["Content-Disposition"]).to eq("attachment")
+            end
+          end
+
+          context "attachment with filename" 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")
+            end
+          end
+        end
+      end
     end
 
     describe "remove .pdf from PATH_INFO and REQUEST_URI" do

data/spec/pdfkit_spec.rb

@@ -23,6 +23,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
@@ -252,6 +259,12 @@ describe PDFKit do
       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")
@@ -499,7 +512,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

@@ -12,6 +12,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 +34,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 +61,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
@@ -77,6 +92,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 +110,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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfkit
 version: !ruby/object:Gem::Version
-  version: 0.8.4.1
+  version: 0.8.4.2
 platform: ruby
 authors:
 - Jared Pace
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -154,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - wkhtmltopdf
-rubyforge_project: pdfkit
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: HTML+CSS -> PDF