wicked_pdf 2.6.3 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efc167edf11352423548ba65167d53beb2e8e60691fb788df361d19c636e7f45
-  data.tar.gz: e4c6e40dbbb8ba3867e3fbfa1aadbd151c87355f898dbad629f58a2e39f8a4c4
+  metadata.gz: 120e7e1b14e3e17ac6bc407dd6c7d27438543e87a979d684bab919440ebd7879
+  data.tar.gz: f9340f26589900f6f30c19f5631ca2104b48685b9ac102c3bdc2e9d168c0c847
 SHA512:
-  metadata.gz: 345c533e38faa42be7700d76e6ff761583c1856f30bf12c55fbff410c77d224f5ed0f7698006316e3565d656a9e4db5cef1936f5ec718957e3652cce85e35b03
-  data.tar.gz: 00b0cb2ee4c76840d71d984f39987dc04ea23a854d2f38c01b3f21f18ecb7f60c980f477e3eb94a8c1b2b79cda43cb050f521d0003d9306b31cebd8b273dd5ea
+  metadata.gz: f26972b5aa38ac4785ffddd283e787ec49361ae1891d66b8bfe92d3e9b196d4215a03cec3ffced97ec5269f0316f53f0a24374c26a1df255898a01241b85ce57
+  data.tar.gz: 0d00bcb4d776acb3a469dfb55e0994ca22eab620694b92f7433a4a93aa91a07653848bef7bd3eaff709d861fdf6bf1260cd8ad048be9e671f8f26d78f37d0300

data/.github/workflows/ci.yml

@@ -28,29 +28,29 @@ jobs:
           - gemfile: "6.1"
             ruby-version: 2.7
           - gemfile: "6.1"
-            ruby-version: 3.0
+            ruby-version: '3.0'
           - gemfile: "7.0"
             ruby-version: 3.1
+          - gemfile: "7.0"
+            ruby-version: 3.2
 
     env:
-      BUNDLE_GEMFILE: /home/runner/work/wicked_pdf/wicked_pdf/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
       WKHTMLTOPDF_BIN: /usr/bin/wkhtmltopdf
 
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Install Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
+      - uses: actions/checkout@v3
 
       - name: Install OS dependencies
         run: |
           sudo apt-get update -y -qq
           sudo apt-get install -y wkhtmltopdf
 
-      - name: Install gem dependencies
-        run: bundle install
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
 
       - name: Run tests with Ruby ${{ matrix.ruby-version }} and Rails ${{ matrix.gemfile }}
         run: bundle exec rake

data/.rubocop.yml

@@ -2,10 +2,12 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   NewCops: disable
+  SuggestExtensions: false
   TargetRubyVersion: 2.6
   Exclude:
     - 'gemfiles/bin/*'
     - 'test/dummy/**/*'
+    - 'vendor/**/*'
 
 Metrics/PerceivedComplexity:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,45 +1,39 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-10-09 14:16:04 +0200 using RuboCop version 0.68.1.
+# on 2023-01-24 11:24:49 UTC using RuboCop version 1.44.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 11
-Metrics/AbcSize:
-  Max: 45
-
 # Offense count: 2
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 250
+  Max: 203
 
 # Offense count: 7
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 13
 
 # Offense count: 17
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 40
+  Max: 34
 
-# Offense count: 2
-# Configuration parameters: CountComments.
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 147
+  Max: 104
 
-# Offense count: 6
-Metrics/PerceivedComplexity:
-  Max: 13
-
-# Offense count: 2
+# Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/wicked_pdf/middleware.rb'
-    - 'lib/wicked_pdf/pdf_helper.rb'
 
 # Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowOnConstant, AllowOnSelfClass.
 Style/CaseEquality:
   Exclude:
     - 'lib/wicked_pdf/wicked_pdf_helper.rb'
@@ -49,66 +43,63 @@ Style/ClassVars:
   Exclude:
     - 'lib/wicked_pdf.rb'
 
-# Offense count: 10
+# Offense count: 13
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'generators/wicked_pdf/wicked_pdf_generator.rb'
     - 'lib/wicked_pdf.rb'
+    - 'lib/wicked_pdf/binary.rb'
     - 'lib/wicked_pdf/middleware.rb'
+    - 'lib/wicked_pdf/option_parser.rb'
     - 'lib/wicked_pdf/pdf_helper.rb'
     - 'lib/wicked_pdf/progress.rb'
     - 'lib/wicked_pdf/railtie.rb'
-    - 'lib/wicked_pdf/binary.rb'
-    - 'lib/wicked_pdf/option_parser.rb'
     - 'lib/wicked_pdf/tempfile.rb'
     - 'lib/wicked_pdf/wicked_pdf_helper.rb'
     - 'lib/wicked_pdf/wicked_pdf_helper/assets.rb'
 
 # Offense count: 2
-# Cop supports --auto-correct.
+# This cop supports safe autocorrection (--autocorrect).
 Style/ExpandPathArguments:
   Exclude:
     - 'test/test_helper.rb'
     - 'wicked_pdf.gemspec'
 
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never, either, consistent
 Style/HashSyntax:
   Exclude:
-    - 'gemfiles/4.0.gemfile'
-    - 'gemfiles/4.1.gemfile'
-    - 'gemfiles/4.2.gemfile'
     - 'gemfiles/5.0.gemfile'
     - 'gemfiles/5.1.gemfile'
     - 'gemfiles/5.2.gemfile'
     - 'gemfiles/6.0.gemfile'
-    - 'gemfiles/rails_edge.gemfile'
 
 # Offense count: 2
-# Cop supports --auto-correct.
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: literals, strict
 Style/MutableConstant:
   Exclude:
     - 'lib/wicked_pdf/wicked_pdf_helper/assets.rb'
 
-# Offense count: 6
-# Cop supports --auto-correct.
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
     - 'lib/wicked_pdf/middleware.rb'
     - 'lib/wicked_pdf/wicked_pdf_helper/assets.rb'
-    - 'test/unit/wicked_pdf_test.rb'
 
-# Offense count: 111
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 18
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 563

data/CHANGELOG.md

@@ -5,6 +5,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [master branch] - Unreleased
 ### Breaking Changes
 
+## [2.7.0]
+### New Features
+- [Support Shakapacker 7](https://github.com/mileszs/wicked_pdf/pull/1067)
+- [Add option `delete_temporary_files` to keep the temporary files generated by `pdf_from_string` method](https://github.com/mileszs/wicked_pdf/pull/1068)
+- [Add support for --allow flag](https://github.com/mileszs/wicked_pdf/pull/1030)
+
+## Fixes
+- [Add require for `stringio`, which is no longer loaded by default in Ruby 3.1+](https://github.com/mileszs/wicked_pdf/pull/1062)
+- [Fix CI build.](https://github.com/mileszs/wicked_pdf/pull/1055)
+- [Fix Header/footer temporary file is removed before `wkhtmltopdf` is called](https://github.com/mileszs/wicked_pdf/pull/1039)
+- [Bump rubocop to 1.46](https://github.com/mileszs/wicked_pdf/pull/1051)
+- [Add Ruby 3.2 to the test matrix](https://github.com/mileszs/wicked_pdf/pull/1046)
+
 ## [2.6.3]
 ### Fixes
 - [Fix typo of #possible_binary_locations](https://github.com/mileszs/wicked_pdf/pull/1025)

data/README.md

@@ -191,6 +191,7 @@ class ThingsController < ApplicationController
                # 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
+               allow:                          ["#{Rails.root}/public"],  # could be an array or a single string
 
                disable_smart_shrinking:        true,
                use_xserver:                    true,
@@ -258,7 +259,8 @@ class ThingsController < ApplicationController
                             disable_toc_links: true,
                             disable_back_links:true,
                             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
+               progress: proc { |output| puts output }, # proc called when console output changes
+               delete_temporary_files: true             # explicitly delete temporary files, default false
       end
     end
   end
@@ -293,14 +295,14 @@ pdf = WickedPdf.new.pdf_from_html_file('/your/absolute/path/here')
 # create a pdf from a URL
 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
+# 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', layout: 'pdfs/layout_pdf.html'),
   footer: {
     content: render_to_string(
-  		'templates/footer',
-  		layout: 'pdfs/layout_pdf.html'
-  	)
+      'templates/footer',
+      layout: 'pdfs/layout_pdf.html'
+    )
   }
 )
 

data/gemfiles/6.1.gemfile

@@ -7,6 +7,5 @@ gem 'webpacker'
 gem 'rdoc'
 gem 'sprockets', '~>3.0'
 gem 'sqlite3', '~> 1.4'
-gem 'rubocop', '1.11.0'
 
 gemspec :path => '../'

data/gemfiles/7.0.gemfile

@@ -7,6 +7,5 @@ gem 'sprockets-rails'
 gem 'rdoc'
 gem 'sprockets', '~>3.0'
 gem 'sqlite3', '~> 1.4'
-gem 'rubocop', '1.11.0'
 
 gemspec :path => '../'

data/lib/wicked_pdf/option_parser.rb

@@ -2,7 +2,7 @@ class WickedPdf
   class OptionParser
     BINARY_VERSION_WITHOUT_DASHES = Gem::Version.new('0.12.0')
 
-    attr_reader :binary_version
+    attr_reader :binary_version, :hf_tempfiles
 
     def initialize(binary_version = WickedPdf::DEFAULT_BINARY_VERSION)
       @binary_version = binary_version
@@ -61,7 +61,7 @@ class WickedPdf
           r += make_options(opt_hf, [:line], hf.to_s, :boolean)
           if options[hf] && options[hf][:content]
             @hf_tempfiles = [] unless defined?(@hf_tempfiles)
-            @hf_tempfiles.push(tf = WickedPdf::Tempfile.new("wicked_#{hf}_pdf.html"))
+            @hf_tempfiles.push(tf = File.new(Dir::Tmpname.create(["wicked_#{hf}_pdf", '.html']) {}, 'w'))
             tf.write options[hf][:content]
             tf.flush
             options[hf][:html] = {}
@@ -168,7 +168,8 @@ class WickedPdf
                                       encoding
                                       user_style_sheet
                                       viewport_size
-                                      window_status])
+                                      window_status
+                                      allow])
         r += make_options(options, %i[cookie
                                       post], '', :name_value)
         r += make_options(options, %i[redirect_delay

data/lib/wicked_pdf/tempfile.rb

@@ -1,4 +1,5 @@
 require 'tempfile'
+require 'stringio'
 
 class WickedPdf
   class Tempfile < ::Tempfile

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '2.6.3'.freeze
+  VERSION = '2.7.0'.freeze
 end

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'delegate'
+require 'stringio'
 
 class WickedPdf
   module WickedPdfHelper
@@ -230,12 +231,11 @@ class WickedPdf
       end
 
       def webpacker_version
-        return unless defined?(Webpacker)
-
-        # If webpacker is used, need to check for version
-        require 'webpacker/version'
-
-        Webpacker::VERSION
+        if defined?(Shakapacker)
+          Shakapacker::VERSION
+        elsif defined?(Webpacker)
+          Webpacker::VERSION
+        end
       end
     end
   end

data/lib/wicked_pdf.rb

@@ -43,16 +43,20 @@ class WickedPdf
     string_file.write_in_chunks(string)
     pdf_from_html_file(string_file.path, options)
   ensure
-    string_file.close if string_file
+    if options[:delete_temporary_files] && string_file
+      string_file.close!
+    elsif string_file
+      string_file.close
+    end
   end
 
-  def pdf_from_url(url, options = {})
+  def pdf_from_url(url, options = {}) # rubocop:disable Metrics/CyclomaticComplexity
     # merge in global config options
     options.merge!(WickedPdf.config) { |_key, option, _config| option }
     generated_pdf_file = WickedPdf::Tempfile.new('wicked_pdf_generated_file.pdf', options[:temp_path])
     command = [@binary.path]
     command.unshift(@binary.xvfb_run_path) if options[:use_xvfb]
-    command += parse_options(options)
+    command += option_parser.parse(options)
     command << url
     command << generated_pdf_file.path.to_s
 
@@ -61,9 +65,8 @@ class WickedPdf
     if track_progress?(options)
       invoke_with_progress(command, options)
     else
-      err = Open3.popen3(*command) do |_stdin, _stdout, stderr|
-        stderr.read
-      end
+      _out, err, status = Open3.capture3(*command)
+      err = [status.to_s, err].join("\n") if !err.empty? || !status.success?
     end
     if options[:return_file]
       return_file = options.delete(:return_file)
@@ -79,6 +82,7 @@ class WickedPdf
   rescue StandardError => e
     raise "Failed to execute:\n#{command}\nError: #{e}"
   ensure
+    clean_temp_files
     generated_pdf_file.close! if generated_pdf_file && !return_file
   end
 
@@ -98,7 +102,13 @@ class WickedPdf
     Rails.logger.debug '[wicked_pdf]: ' + cmd
   end
 
-  def parse_options(options)
-    OptionParser.new(binary_version).parse(options)
+  def option_parser
+    @option_parser ||= OptionParser.new(binary_version)
+  end
+
+  def clean_temp_files
+    return unless option_parser.hf_tempfiles.present?
+
+    option_parser.hf_tempfiles.each { |file| File.delete(file) }
   end
 end

data/test/unit/wicked_pdf_option_parser_test.rb

@@ -76,6 +76,11 @@ class WickedPdfOptionParserTest < ActiveSupport::TestCase
       assert_equal "--#{o.to_s.tr('_', '-')} opts", parse_options(o => 'opts').strip
     end
 
+    %i[allow].each do |o|
+      assert_equal "--#{o.to_s.tr('_', '-')} opts", parse_options(o => 'opts').strip
+      assert_equal "--#{o.to_s.tr('_', '-')} opts1 --#{o.to_s.tr('_', '-')} opts2", parse_options(o => %w[opts1 opts2]).strip
+    end
+
     %i[cookie post].each do |o|
       assert_equal "--#{o.to_s.tr('_', '-')} name value", parse_options(o => 'name value').strip
 
@@ -90,7 +95,7 @@ class WickedPdfOptionParserTest < ActiveSupport::TestCase
     %i[
       book default_header disable_javascript grayscale lowquality
       enable_plugins disable_internal_links disable_external_links
-      print_media_type disable_smart_shrinking use_xserver no_background
+      print_media_type disable_smart_shrinking use_xserver no_background disable_local_file_access
     ].each do |o|
       assert_equal "--#{o.to_s.tr('_', '-')}", parse_options(o => true).strip
     end

data/wicked_pdf.gemspec

@@ -34,7 +34,7 @@ DESC
   spec.add_development_dependency 'mocha', '= 1.3'
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop', '~> 1.24'
+  spec.add_development_dependency 'rubocop', '~> 1.46'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'test-unit'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.7.0
 platform: ruby
 authors:
 - Miles Z. Sterrett
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.46'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.46'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - wkhtmltopdf
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: PDF generator (from HTML) gem for Ruby on Rails