wicked_pdf 2.0.2 → 2.8.2

data/Rakefile

@@ -5,7 +5,7 @@ require 'rails/version'
 require 'bundler/gem_tasks'
 
 desc 'Default: run unit tests.'
-task :default => [:setup_and_run_tests, :rubocop]
+task :default => %i[setup_and_run_tests rubocop]
 
 desc 'Test the wicked_pdf plugin.'
 Rake::TestTask.new(:test) do |t|
@@ -17,16 +17,13 @@ end
 
 desc 'Run RuboCop'
 task :rubocop do
-  next unless RUBY_VERSION >= '2.0.0'
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
 end
 
 desc 'Setup and run all tests'
 task :setup_and_run_tests do
-  unless File.exist?('test/dummy/config/environment.rb')
-    Rake::Task[:dummy_generate].invoke
-  end
+  Rake::Task[:dummy_generate].invoke unless File.exist?('test/dummy/config/environment.rb')
   Rake::Task[:test].invoke
 end
 
@@ -34,11 +31,7 @@ desc 'Generate dummy application for test cases'
 task :dummy_generate do
   Rake::Task[:dummy_remove].invoke
   puts 'Creating dummy application to run tests'
-  if Rails::VERSION::MAJOR > 2
-    system('rails new test/dummy --database=sqlite3')
-  else
-    system('rails test/dummy')
-  end
+  system('rails new test/dummy --database=sqlite3')
   system('touch test/dummy/db/schema.rb')
   FileUtils.cp 'test/fixtures/database.yml', 'test/dummy/config/'
   FileUtils.rm_r Dir.glob('test/dummy/test/*')

data/gemfiles/5.0.gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
+gem 'rails', '~> 5.0.0'
 gem 'rdoc'
-gem 'sqlite3', '~> 1.3.6'
 gem 'sprockets', '~>3.0' # v4 strips newlines from assets causing tests to fail
-gem 'rails', '~> 5.0.0'
+gem 'sqlite3', '~> 1.3.6'
 
 gemspec path: '../'

data/gemfiles/5.1.gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
+gem 'rails', '~> 5.1.0'
 gem 'rdoc'
-gem 'sqlite3', '~> 1.3.6'
 gem 'sprockets', '~>3.0' # v4 strips newlines from assets causing tests to fail
-gem 'rails', '~> 5.1.0'
+gem 'sqlite3', '~> 1.3.6'
 
 gemspec path: '../'

data/gemfiles/5.2.gemfile

@@ -1,10 +1,9 @@
 source 'https://rubygems.org'
 
-gem 'rdoc'
+gem 'bootsnap' # required to run `rake test` in Rails 5.2
 gem 'rails', '~> 5.2'
-gem 'sqlite3', '~> 1.3.6'
+gem 'rdoc'
 gem 'sprockets', '~>3.0' # v4 strips newlines from assets causing tests to fail
-gem 'bootsnap' # required to run `rake test` in Rails 5.2
-gem 'mocha', '= 1.3' # newer versions blow up
+gem 'sqlite3', '~> 1.3.6'
 
 gemspec path: '../'

data/gemfiles/6.0.gemfile

@@ -1,11 +1,10 @@
 source 'https://rubygems.org'
 
+gem 'bootsnap' # required to run `rake test` in Rails 6.0
 gem 'bundler', '~>2'
-gem 'rdoc'
 gem 'rails', '~>6.0.1'
-gem 'sqlite3', '~> 1.4'
+gem 'rdoc'
 gem 'sprockets', '~>3.0'
-gem 'bootsnap' # required to run `rake test` in Rails 6.0
-gem 'mocha', '= 1.3' # newer versions blow up
+gem 'sqlite3', '~> 1.4'
 
 gemspec path: '../'

data/gemfiles/6.1.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'bootsnap' # required to run `rake test` in Rails 6.1
+gem 'bundler', '~>2'
+gem 'rails', '~>6.1.0'
+gem 'webpacker'
+gem 'rdoc'
+gem 'sprockets', '~>3.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec :path => '../'

data/gemfiles/7.0.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'bootsnap' # required to run `rake test` in Rails 7.0
+gem 'bundler', '~>2'
+gem 'rails', '~>7.0.0'
+gem 'sprockets-rails'
+gem 'rdoc'
+gem 'sprockets', '~>3.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec :path => '../'

data/generators/wicked_pdf/templates/wicked_pdf.rb

@@ -8,14 +8,23 @@
 #
 # https://github.com/mileszs/wicked_pdf/blob/master/README.md
 
-WickedPdf.config = {
+WickedPdf.configure do |config|
   # Path to the wkhtmltopdf executable: This usually isn't needed if using
   # one of the wkhtmltopdf-binary family of gems.
-  # exe_path: '/usr/local/bin/wkhtmltopdf',
+  # config.exe_path = '/usr/local/bin/wkhtmltopdf'
   #   or
-  # exe_path: Gem.bin_path('wkhtmltopdf-binary', 'wkhtmltopdf')
+  # config.exe_path = Gem.bin_path('wkhtmltopdf-binary', 'wkhtmltopdf')
+
+  # Needed for wkhtmltopdf 0.12.6+ to use many wicked_pdf asset helpers
+  # config.enable_local_file_access = true
 
   # Layout file to be used for all PDFs
   # (but can be overridden in `render :pdf` calls)
-  # layout: 'pdf.html',
-}
+  # config.layout = 'pdf.html'
+
+  # Using wkhtmltopdf without an X server can be achieved by enabling the
+  # 'use_xvfb' flag. This will wrap all wkhtmltopdf commands around the
+  # 'xvfb-run' command, in order to simulate an X server.
+  #
+  # config.use_xvfb = true
+end

data/lib/wicked_pdf/binary.rb

@@ -0,0 +1,65 @@
+class WickedPdf
+  class Binary
+    EXE_NAME = 'wkhtmltopdf'.freeze
+
+    attr_reader :path, :default_version
+
+    def initialize(binary_path, default_version = WickedPdf::DEFAULT_BINARY_VERSION)
+      @path = binary_path || find_binary_path
+      @default_version = default_version
+
+      raise "Location of #{EXE_NAME} unknown" if @path.empty?
+      raise "Bad #{EXE_NAME}'s path: #{@path}" unless File.exist?(@path)
+      raise "#{EXE_NAME} is not executable" unless File.executable?(@path)
+    end
+
+    def version
+      @version ||= retrieve_binary_version
+    end
+
+    def parse_version_string(version_info)
+      match_data = /wkhtmltopdf\s*(\d*\.\d*\.\d*\w*)/.match(version_info)
+      if match_data && (match_data.length == 2)
+        Gem::Version.new(match_data[1])
+      else
+        default_version
+      end
+    end
+
+    def xvfb_run_path
+      path = possible_binary_locations.map { |l| File.expand_path("#{l}/xvfb-run") }.find { |location| File.exist?(location) }
+      raise StandardError, 'Could not find binary xvfb-run on the system.' unless path
+
+      path
+    end
+
+    private
+
+    def retrieve_binary_version
+      _stdin, stdout, _stderr = Open3.popen3(@path + ' -V')
+      parse_version_string(stdout.gets(nil))
+    rescue StandardError
+      default_version
+    end
+
+    def find_binary_path
+      exe_path ||= WickedPdf.config[:exe_path] unless WickedPdf.config.empty?
+      exe_path ||= possible_which_path
+      exe_path ||= possible_binary_locations.map { |l| File.expand_path("#{l}/#{EXE_NAME}") }.find { |location| File.exist?(location) }
+      exe_path || ''
+    end
+
+    def possible_which_path
+      detected_path = (defined?(Bundler) ? Bundler.which('wkhtmltopdf') : `which wkhtmltopdf`).chomp
+      detected_path.present? && detected_path
+    rescue StandardError
+      nil
+    end
+
+    def possible_binary_locations
+      possible_locations = (ENV['PATH'].split(':') + %w[/usr/bin /usr/local/bin]).uniq
+      possible_locations += %w[~/bin] if ENV.key?('HOME')
+      possible_locations
+    end
+  end
+end

data/lib/wicked_pdf/option_parser.rb

@@ -0,0 +1,230 @@
+class WickedPdf
+  class OptionParser
+    BINARY_VERSION_WITHOUT_DASHES = Gem::Version.new('0.12.0')
+
+    attr_reader :binary_version, :hf_tempfiles
+
+    def initialize(binary_version = WickedPdf::DEFAULT_BINARY_VERSION)
+      @binary_version = binary_version
+    end
+
+    def parse(options)
+      [
+        parse_extra(options),
+        parse_others(options),
+        parse_global(options),
+        parse_outline(options.delete(:outline)),
+        parse_header_footer(:header => options.delete(:header),
+                            :footer => options.delete(:footer),
+                            :layout => options[:layout]),
+        parse_cover(options.delete(:cover)),
+        parse_toc(options.delete(:toc)),
+        parse_basic_auth(options)
+      ].flatten
+    end
+
+    def valid_option(name)
+      if binary_version < BINARY_VERSION_WITHOUT_DASHES
+        "--#{name}"
+      else
+        name
+      end
+    end
+
+    private
+
+    def parse_extra(options)
+      return [] if options[:extra].nil?
+      return options[:extra].split if options[:extra].respond_to?(:split)
+
+      options[:extra]
+    end
+
+    def parse_basic_auth(options)
+      if options[:basic_auth]
+        user, passwd = Base64.decode64(options[:basic_auth]).split(':')
+        ['--username', user, '--password', passwd]
+      else
+        []
+      end
+    end
+
+    def parse_header_footer(options)
+      r = []
+      unless options.blank?
+        %i[header footer].collect do |hf|
+          next if options[hf].blank?
+
+          opt_hf = options[hf]
+          r += make_options(opt_hf, %i[center font_name left right], hf.to_s)
+          r += make_options(opt_hf, %i[font_size spacing], hf.to_s, :numeric)
+          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 = File.new(Dir::Tmpname.create(["wicked_#{hf}_pdf", '.html']) {}, 'w'))
+            tf.write options[hf][:content]
+            tf.flush
+            options[hf][:html] = {}
+            options[hf][:html][:url] = "file:///#{tf.path}"
+          end
+          unless opt_hf[:html].blank?
+            r += make_option("#{hf}-html", opt_hf[:html][:url]) unless opt_hf[:html][:url].blank?
+          end
+        end
+      end
+      r
+    end
+
+    def parse_cover(argument)
+      arg = argument.to_s
+      return [] if arg.blank?
+
+      # Filesystem path or URL - hand off to wkhtmltopdf
+      if argument.is_a?(Pathname) || (arg[0, 4] == 'http')
+        [valid_option('cover'), arg]
+      else # HTML content
+        @hf_tempfiles ||= []
+        @hf_tempfiles << tf = WickedPdf::Tempfile.new('wicked_cover_pdf.html')
+        tf.write arg
+        tf.flush
+        [valid_option('cover'), tf.path]
+      end
+    end
+
+    def parse_toc(options)
+      return [] if options.nil?
+
+      r = [valid_option('toc')]
+      unless options.blank?
+        r += make_options(options, %i[font_name header_text], 'toc')
+        r += make_options(options, [:xsl_style_sheet])
+        r += make_options(options, %i[depth
+                                      header_fs
+                                      text_size_shrink
+                                      l1_font_size
+                                      l2_font_size
+                                      l3_font_size
+                                      l4_font_size
+                                      l5_font_size
+                                      l6_font_size
+                                      l7_font_size
+                                      level_indentation
+                                      l1_indentation
+                                      l2_indentation
+                                      l3_indentation
+                                      l4_indentation
+                                      l5_indentation
+                                      l6_indentation
+                                      l7_indentation], 'toc', :numeric)
+        r += make_options(options, %i[no_dots
+                                      disable_links
+                                      disable_back_links], 'toc', :boolean)
+        r += make_options(options, %i[disable_dotted_lines
+                                      disable_toc_links], nil, :boolean)
+      end
+      r
+    end
+
+    def parse_outline(options)
+      r = []
+      unless options.blank?
+        r = make_options(options, [:outline], '', :boolean)
+        r += make_options(options, [:outline_depth], '', :numeric)
+      end
+      r
+    end
+
+    def parse_margins(options)
+      make_options(options, %i[top bottom left right], 'margin', :numeric)
+    end
+
+    def parse_global(options)
+      r = []
+      unless options.blank?
+        r += make_options(options, %i[orientation
+                                      dpi
+                                      page_size
+                                      page_width
+                                      title
+                                      log_level])
+        r += make_options(options, %i[lowquality
+                                      grayscale
+                                      no_pdf_compression
+                                      quiet], '', :boolean)
+        r += make_options(options, %i[image_dpi
+                                      image_quality
+                                      page_height], '', :numeric)
+        r += parse_margins(options.delete(:margin))
+      end
+      r
+    end
+
+    def parse_others(options)
+      r = []
+      unless options.blank?
+        r += make_options(options, %i[proxy
+                                      username
+                                      password
+                                      encoding
+                                      user_style_sheet
+                                      viewport_size
+                                      window_status
+                                      allow])
+        r += make_options(options, %i[cookie
+                                      post], '', :name_value)
+        r += make_options(options, %i[redirect_delay
+                                      zoom
+                                      page_offset
+                                      javascript_delay], '', :numeric)
+        r += make_options(options, %i[book
+                                      default_header
+                                      disable_javascript
+                                      enable_plugins
+                                      disable_internal_links
+                                      disable_external_links
+                                      keep_relative_links
+                                      print_media_type
+                                      disable_local_file_access
+                                      enable_local_file_access
+                                      disable_smart_shrinking
+                                      use_xserver
+                                      no_background
+                                      images
+                                      no_images
+                                      no_stop_slow_scripts], '', :boolean)
+      end
+      r
+    end
+
+    def make_options(options, names, prefix = '', type = :string)
+      return [] if options.nil?
+
+      names.collect do |o|
+        if options[o].blank?
+          []
+        else
+          make_option("#{prefix.blank? ? '' : prefix + '-'}#{o}",
+                      options[o],
+                      type)
+        end
+      end
+    end
+
+    def make_option(name, value, type = :string)
+      return value.collect { |v| make_option(name, v, type) } if value.is_a?(Array)
+
+      if type == :name_value
+        parts = value.to_s.split(' ')
+        ["--#{name.tr('_', '-')}", *parts]
+      elsif type == :boolean
+        if value
+          ["--#{name.tr('_', '-')}"]
+        else
+          []
+        end
+      else
+        ["--#{name.tr('_', '-')}", value.to_s]
+      end
+    end
+  end
+end

data/lib/wicked_pdf/pdf_helper.rb

@@ -1,21 +1,5 @@
 class WickedPdf
   module PdfHelper
-    def self.included(base)
-      # Protect from trying to augment modules that appear
-      # as the result of adding other gems.
-      return if base != ActionController::Base
-
-      base.class_eval do
-        alias_method_chain :render, :wicked_pdf
-        alias_method_chain :render_to_string, :wicked_pdf
-        if respond_to?(:after_action)
-          after_action :clean_temp_files
-        else
-          after_filter :clean_temp_files
-        end
-      end
-    end
-
     def self.prepended(base)
       # Protect from trying to augment modules that appear
       # as the result of adding other gems.
@@ -26,52 +10,52 @@ class WickedPdf
       end
     end
 
-    def render(options = nil, *args, &block)
-      render_with_wicked_pdf(options, *args, &block)
-    end
-
-    def render_to_string(options = nil, *args, &block)
-      render_to_string_with_wicked_pdf(options, *args, &block)
-    end
-
-    def render_with_wicked_pdf(options = nil, *args, &block)
+    def render(*args)
+      options = args.first
       if options.is_a?(Hash) && options.key?(:pdf)
-        options[:basic_auth] = set_basic_auth(options)
-        make_and_send_pdf(options.delete(:pdf), (WickedPdf.config || {}).merge(options))
-      elsif respond_to?(:render_without_wicked_pdf)
-        # support alias_method_chain (module included)
-        render_without_wicked_pdf(options, *args, &block)
+        render_with_wicked_pdf(options)
       else
-        # support inheritance (module prepended)
-        method(:render).super_method.call(options, *args, &block)
+        super
       end
     end
 
-    def render_to_string_with_wicked_pdf(options = nil, *args, &block)
+    def render_to_string(*args)
+      options = args.first
       if options.is_a?(Hash) && options.key?(:pdf)
-        options[:basic_auth] = set_basic_auth(options)
-        options.delete :pdf
-        make_pdf((WickedPdf.config || {}).merge(options))
-      elsif respond_to?(:render_to_string_without_wicked_pdf)
-        # support alias_method_chain (module included)
-        render_to_string_without_wicked_pdf(options, *args, &block)
+        render_to_string_with_wicked_pdf(options)
       else
-        # support inheritance (module prepended)
-        method(:render_to_string).super_method.call(options, *args, &block)
+        super
       end
     end
 
+    def render_with_wicked_pdf(options)
+      raise ArgumentError, 'missing keyword: pdf' unless options.is_a?(Hash) && options.key?(:pdf)
+
+      options[:basic_auth] = set_basic_auth(options)
+      make_and_send_pdf(options.delete(:pdf), (WickedPdf.config || {}).merge(options))
+    end
+
+    def render_to_string_with_wicked_pdf(options)
+      raise ArgumentError, 'missing keyword: pdf' unless options.is_a?(Hash) && options.key?(:pdf)
+
+      options[:basic_auth] = set_basic_auth(options)
+      options.delete :pdf
+      make_pdf((WickedPdf.config || {}).merge(options))
+    end
+
     private
 
     def set_basic_auth(options = {})
       options[:basic_auth] ||= WickedPdf.config.fetch(:basic_auth) { false }
       return unless options[:basic_auth] && request.env['HTTP_AUTHORIZATION']
+
       request.env['HTTP_AUTHORIZATION'].split(' ').last
     end
 
     def clean_temp_files
       return unless defined?(@hf_tempfiles)
-      @hf_tempfiles.each(&:close!)
+
+      @hf_tempfiles.each(&:close)
     end
 
     def make_pdf(options = {})
@@ -119,10 +103,11 @@ class WickedPdf
     # Given an options hash, prerenders content for the header and footer sections
     # to temp files and return a new options hash including the URLs to these files.
     def prerender_header_and_footer(options)
-      [:header, :footer].each do |hf|
+      %i[header footer].each do |hf|
         next unless options[hf] && options[hf][:html] && options[hf][:html][:template]
+
         @hf_tempfiles = [] unless defined?(@hf_tempfiles)
-        @hf_tempfiles.push(tf = WickedPdfTempfile.new("wicked_#{hf}_pdf.html"))
+        @hf_tempfiles.push(tf = WickedPdf::Tempfile.new("wicked_#{hf}_pdf.html"))
         options[hf][:html][:layout] ||= options[:layout]
         render_opts = {
           :template => options[hf][:html][:template],

data/lib/wicked_pdf/progress.rb

@@ -1,10 +1,10 @@
 class WickedPdf
   module Progress
-    require 'pty' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw/ # no support for windows
+    require 'pty' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby' # no support for windows and truffleruby
     require 'English'
 
     def track_progress?(options)
-      options[:progress] && !on_windows?
+      options[:progress] && !(on_windows? || RUBY_ENGINE == 'truffleruby')
     end
 
     def invoke_with_progress(command, options)

data/lib/wicked_pdf/railtie.rb

@@ -6,21 +6,12 @@ class WickedPdf
   if defined?(Rails.env)
     class WickedRailtie < Rails::Railtie
       initializer 'wicked_pdf.register', :after => 'remotipart.controller_helper' do |_app|
-        ActiveSupport.on_load(:action_controller) do
-          if ActionController::Base.respond_to?(:prepend) &&
-             Object.method(:new).respond_to?(:super_method)
-            ActionController::Base.send :prepend, PdfHelper
-          else
-            ActionController::Base.send :include, PdfHelper
-          end
-          ActionView::Base.send :include, WickedPdfHelper::Assets
-        end
+        ActiveSupport.on_load(:action_controller) { ActionController::Base.send :prepend, PdfHelper }
+        ActiveSupport.on_load(:action_view) { include WickedPdfHelper::Assets }
       end
     end
 
-    if Mime::Type.lookup_by_extension(:pdf).nil?
-      Mime::Type.register('application/pdf', :pdf)
-    end
+    Mime::Type.register('application/pdf', :pdf) if Mime::Type.lookup_by_extension(:pdf).nil?
 
   end
 end

data/lib/wicked_pdf/tempfile.rb

@@ -1,13 +1,43 @@
 require 'tempfile'
+require 'stringio'
 
 class WickedPdf
-  class WickedPdfTempfile < Tempfile
-    # ensures the Tempfile's filename always keeps its extension
+  class Tempfile < ::Tempfile
     def initialize(filename, temp_dir = nil)
       temp_dir ||= Dir.tmpdir
       extension = File.extname(filename)
-      basename  = File.basename(filename, extension)
+      basename = File.basename(filename, extension)
       super([basename, extension], temp_dir)
     end
+
+    def write_in_chunks(input_string)
+      binmode
+      string_io = StringIO.new(input_string)
+      write(string_io.read(chunk_size)) until string_io.eof?
+      close
+      self
+    rescue Errno::EINVAL => e
+      raise e, file_too_large_message
+    end
+
+    def read_in_chunks
+      rewind
+      binmode
+      chunks = []
+      chunks << read(chunk_size) until eof?
+      chunks.join
+    rescue Errno::EINVAL => e
+      raise e, file_too_large_message
+    end
+
+    private
+
+    def chunk_size
+      1024 * 1024
+    end
+
+    def file_too_large_message
+      'The HTML file is too large! Try reducing the size or using the return_file option instead.'
+    end
   end
 end

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.8.2'.freeze
 end