wicked_pdf 1.1.0 → 2.0.1

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -1,4 +1,6 @@
-require 'open-uri'
+require 'net/http'
+# If webpacker is used, need to check for version
+require 'webpacker/version' if defined?(Webpacker)
 
 class WickedPdf
   module WickedPdfHelper
@@ -27,6 +29,32 @@ class WickedPdf
         end.html_safe
       end
 
+      def wicked_pdf_stylesheet_pack_tag(*sources)
+        return unless defined?(Webpacker)
+        if running_in_development?
+          stylesheet_pack_tag(*sources)
+        else
+          css_text = sources.collect do |source|
+            source = WickedPdfHelper.add_extension(source, 'css')
+            wicked_pdf_stylesheet_link_tag(webpacker_source_url(source))
+          end.join("\n")
+          css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+        end
+      end
+
+      def wicked_pdf_javascript_pack_tag(*sources)
+        return unless defined?(Webpacker)
+
+        if running_in_development?
+          javascript_pack_tag(*sources)
+        else
+          sources.collect do |source|
+            source = WickedPdfHelper.add_extension(source, 'js')
+            "<script type='text/javascript'>#{read_asset(webpacker_source_url(source))}</script>"
+          end.join("\n").html_safe
+        end
+      end
+
       def wicked_pdf_image_tag(img, options = {})
         image_tag wicked_pdf_asset_path(img), options
       end
@@ -68,15 +96,20 @@ class WickedPdf
           end
         else
           asset = find_asset(source)
-          asset ? asset.pathname : File.join(Rails.public_path, source)
+          if asset
+            # older versions need pathname, Sprockets 4 supports only filename
+            asset.respond_to?(:filename) ? asset.filename : asset.pathname
+          else
+            File.join(Rails.public_path, source)
+          end
         end
       end
 
       def find_asset(path)
         if Rails.application.assets.respond_to?(:find_asset)
-          Rails.application.assets.find_asset(path)
+          Rails.application.assets.find_asset(path, :base_path => Rails.application.root.to_s)
         else
-          Sprockets::Railtie.build_environment(Rails.application).find_asset(path)
+          Sprockets::Railtie.build_environment(Rails.application).find_asset(path, :base_path => Rails.application.root.to_s)
         end
       end
 
@@ -93,7 +126,8 @@ class WickedPdf
       end
 
       def precompiled_or_absolute_asset?(source)
-        Rails.configuration.assets.compile == false ||
+        !Rails.configuration.respond_to?(:assets) ||
+          Rails.configuration.assets.compile == false ||
           source.to_s[0] == '/' ||
           source.to_s.match(/\Ahttps?\:\/\//)
       end
@@ -112,8 +146,7 @@ class WickedPdf
       end
 
       def read_from_uri(uri)
-        encoding = ':UTF-8' if RUBY_VERSION > '1.8'
-        asset = open(uri, "r#{encoding}", &:read)
+        asset = Net::HTTP.get(URI(uri))
         asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
         asset
       end
@@ -125,6 +158,28 @@ class WickedPdf
       rescue Zlib::GzipFile::Error
         nil
       end
+
+      def webpacker_source_url(source)
+        return unless defined?(Webpacker) && defined?(Webpacker::VERSION)
+        # In Webpacker 3.2.0 asset_pack_url is introduced
+        if Webpacker::VERSION >= '3.2.0'
+          asset_pack_url(source)
+        else
+          source_path = asset_pack_path(source)
+          # Remove last slash from root path
+          root_url[0...-1] + source_path
+        end
+      end
+
+      def running_in_development?
+        return unless defined?(Webpacker)
+        # :dev_server method was added in webpacker 3.0.0
+        if Webpacker.respond_to?(:dev_server)
+          Webpacker.dev_server.running?
+        else
+          Rails.env.development? || Rails.env.test?
+        end
+      end
     end
   end
 end

data/lib/wicked_pdf/wicked_pdf_helper.rb

@@ -23,8 +23,9 @@ class WickedPdf
 
     def wicked_pdf_javascript_src_tag(jsfile, options = {})
       jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
+      type = ::Mime.respond_to?(:[]) ? ::Mime[:js] : ::Mime::JS # ::Mime[:js] cannot be used in Rails 2.3.
       src = "file:///#{WickedPdfHelper.root_path.join('public', 'javascripts', jsfile)}"
-      content_tag('script', '', { 'type' => Mime::JS, 'src' => path_to_javascript(src) }.merge(options))
+      content_tag('script', '', { 'type' => type, 'src' => path_to_javascript(src) }.merge(options))
     end
 
     def wicked_pdf_javascript_include_tag(*sources)

data/lib/wicked_pdf.rb

@@ -1,32 +1,19 @@
 # wkhtml2pdf Ruby interface
-# http://code.google.com/p/wkhtmltopdf/
+# http://wkhtmltopdf.org/
 
 require 'logger'
 require 'digest/md5'
 require 'rbconfig'
+require 'open3'
 
-if (RbConfig::CONFIG['target_os'] =~ /mswin|mingw/) && (RUBY_VERSION < '1.9')
-  require 'win32/open3'
-else
-  require 'open3'
-end
-
-begin
-  require 'active_support/core_ext/module/attribute_accessors'
-rescue LoadError
-  require 'active_support/core_ext/class/attribute_accessors'
-end
-
-begin
-  require 'active_support/core_ext/object/blank'
-rescue LoadError
-  require 'active_support/core_ext/blank'
-end
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
 
 require 'wicked_pdf/version'
 require 'wicked_pdf/railtie'
 require 'wicked_pdf/tempfile'
 require 'wicked_pdf/middleware'
+require 'wicked_pdf/progress'
 
 class WickedPdf
   DEFAULT_BINARY_VERSION = Gem::Version.new('0.9.9')
@@ -36,6 +23,8 @@ class WickedPdf
   cattr_accessor :config
   attr_accessor :binary_version
 
+  include Progress
+
   def initialize(wkhtmltopdf_binary_path = nil)
     @exe_path = wkhtmltopdf_binary_path || find_wkhtmltopdf_binary_path
     raise "Location of #{EXE_NAME} unknown" if @exe_path.empty?
@@ -68,15 +57,18 @@ class WickedPdf
     options.merge!(WickedPdf.config) { |_key, option, _config| option }
     generated_pdf_file = WickedPdfTempfile.new('wicked_pdf_generated_file.pdf', options[:temp_path])
     command = [@exe_path]
-    command << '-q' unless on_windows? # suppress errors on stdout
     command += parse_options(options)
     command << url
     command << generated_pdf_file.path.to_s
 
     print_command(command.inspect) if in_development_mode?
 
-    err = Open3.popen3(*command) do |_stdin, _stdout, stderr|
-      stderr.read
+    if track_progress?(options)
+      invoke_with_progress(command, options)
+    else
+      err = Open3.popen3(*command) do |_stdin, _stdout, stderr|
+        stderr.read
+      end
     end
     if options[:return_file]
       return_file = options.delete(:return_file)
@@ -85,9 +77,10 @@ class WickedPdf
     generated_pdf_file.rewind
     generated_pdf_file.binmode
     pdf = generated_pdf_file.read
+    raise "Error generating PDF\n Command Error: #{err}" if options[:raise_on_all_errors] && !err.empty?
     raise "PDF could not be generated!\n Command Error: #{err}" if pdf && pdf.rstrip.empty?
     pdf
-  rescue => e
+  rescue StandardError => e
     raise "Failed to execute:\n#{command}\nError: #{e}"
   ensure
     generated_pdf_file.close! if generated_pdf_file && !return_file
@@ -96,7 +89,7 @@ class WickedPdf
   private
 
   def in_development_mode?
-    return Rails.env == 'development' if defined?(Rails)
+    return Rails.env == 'development' if defined?(Rails.env)
     RAILS_ENV == 'development' if defined?(RAILS_ENV)
   end
 
@@ -105,19 +98,19 @@ class WickedPdf
   end
 
   def print_command(cmd)
-    p '*' * 15 + cmd + '*' * 15
+    Rails.logger.debug '[wicked_pdf]: ' + cmd
   end
 
   def retrieve_binary_version
     _stdin, stdout, _stderr = Open3.popen3(@exe_path + ' -V')
     @binary_version = parse_version(stdout.gets(nil))
-  rescue
+  rescue StandardError
     DEFAULT_BINARY_VERSION
   end
 
   def parse_version(version_info)
     match_data = /wkhtmltopdf\s*(\d*\.\d*\.\d*\w*)/.match(version_info)
-    if match_data && (2 == match_data.length)
+    if match_data && (match_data.length == 2)
       Gem::Version.new(match_data[1])
     else
       DEFAULT_BINARY_VERSION
@@ -195,24 +188,26 @@ class WickedPdf
 
   def parse_header_footer(options)
     r = []
-    [:header, :footer].collect do |hf|
-      next if options[hf].blank?
-      opt_hf = options[hf]
-      r += make_options(opt_hf, [:center, :font_name, :left, :right], hf.to_s)
-      r += make_options(opt_hf, [: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 = WickedPdfTempfile.new("wicked_#{hf}_pdf.html"))
-        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?
+    unless options.blank?
+      [:header, :footer].collect do |hf|
+        next if options[hf].blank?
+        opt_hf = options[hf]
+        r += make_options(opt_hf, [:center, :font_name, :left, :right], hf.to_s)
+        r += make_options(opt_hf, [: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 = WickedPdfTempfile.new("wicked_#{hf}_pdf.html"))
+          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 unless options.blank?
+    end
     r
   end
 
@@ -284,10 +279,12 @@ class WickedPdf
                                   :dpi,
                                   :page_size,
                                   :page_width,
-                                  :title])
+                                  :title,
+                                  :log_level])
       r += make_options(options, [:lowquality,
                                   :grayscale,
-                                  :no_pdf_compression], '', :boolean)
+                                  :no_pdf_compression,
+                                  :quiet], '', :boolean)
       r += make_options(options, [:image_dpi,
                                   :image_quality,
                                   :page_height], '', :numeric)
@@ -322,18 +319,21 @@ class WickedPdf
                                   :disable_smart_shrinking,
                                   :use_xserver,
                                   :no_background,
+                                  :images,
+                                  :no_images,
                                   :no_stop_slow_scripts], '', :boolean)
     end
     r
   end
 
   def find_wkhtmltopdf_binary_path
-    possible_locations = (ENV['PATH'].split(':') + %w(/usr/bin /usr/local/bin ~/bin)).uniq
+    possible_locations = (ENV['PATH'].split(':') + %w[/usr/bin /usr/local/bin]).uniq
+    possible_locations += %w[~/bin] if ENV.key?('HOME')
     exe_path ||= WickedPdf.config[:exe_path] unless WickedPdf.config.empty?
     exe_path ||= begin
-      detected_path = (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+      detected_path = (defined?(Bundler) ? Bundler.which('wkhtmltopdf') : `which wkhtmltopdf`).chomp
       detected_path.present? && detected_path
-    rescue
+    rescue StandardError
       nil
     end
     exe_path ||= possible_locations.map { |l| File.expand_path("#{l}/#{EXE_NAME}") }.find { |location| File.exist?(location) }

data/test/fixtures/database.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  timeout: 500

data/test/fixtures/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link wicked.js
+//= link wicked.css

data/test/functional/pdf_helper_test.rb

@@ -5,10 +5,32 @@ module ActionController
     def render_to_string(opts = {})
       opts.to_s
     end
+
+    def self.alias_method_chain(_target, _feature); end
+  end
+end
+
+module ActionControllerMock
+  class Base
+    def render(_)
+      [:base]
+    end
+
+    def render_to_string; end
+
+    def self.after_action(_); end
   end
 end
 
 class PdfHelperTest < ActionController::TestCase
+  module SomePatch
+    def render(_)
+      super.tap do |s|
+        s << :patched
+      end
+    end
+  end
+
   def setup
     @ac = ActionController::Base.new
   end
@@ -22,4 +44,53 @@ class PdfHelperTest < ActionController::TestCase
                        :header => { :html => { :template => 'hf.html.erb' } })
     assert_match %r{^file:\/\/\/.*wicked_header_pdf.*\.html}, options[:header][:html][:url]
   end
+
+  test 'should not interfere with already prepended patches' do
+    # Emulate railtie
+    if Rails::VERSION::MAJOR >= 5
+      # this spec tests the following:
+      # if another gem prepends a render method to ActionController::Base
+      # before wicked_pdf does, does calling render trigger an infinite loop?
+      # this spec fails with 6392bea1fe3a41682dfd7c20fd9c179b5a758f59 because PdfHelper
+      # aliases the render method prepended by the other gem to render_without_pdf, then
+      # base_evals its own definition of render, which calls render_with_pdf -> render_without_pdf.
+      # If the other gem uses the prepend inhertinance pattern (calling super instead of aliasing),
+      # when it calls super it calls the base_eval'd version of render instead of going up the
+      # inheritance chain, causing an infinite loop.
+
+      # This fiddling with consts is required to get around the fact that PdfHelper checks
+      # that it is being prepended to ActionController::Base
+      OriginalBase = ActionController::Base
+      ActionController.send(:remove_const, :Base)
+      ActionController.const_set(:Base, ActionControllerMock::Base)
+
+      # Emulate another gem being loaded before wicked
+      ActionController::Base.prepend(SomePatch)
+      ActionController::Base.prepend(::WickedPdf::PdfHelper)
+
+      begin
+        # test that wicked's render method is actually called
+        ac = ActionController::Base.new
+        ac.expects(:render_with_wicked_pdf)
+        ac.render(:cats)
+
+        # test that calling render does not trigger infinite loop
+        ac = ActionController::Base.new
+        assert_equal [:base, :patched], ac.render(:cats)
+      rescue SystemStackError
+        assert_equal true, false # force spec failure
+      ensure
+        ActionController.send(:remove_const, :Base)
+        ActionController.const_set(:Base, OriginalBase)
+      end
+    end
+  end
+
+  test 'should call after_action instead of after_filter when able' do
+    ActionController::Base.expects(:after_filter).with(:clean_temp_files).never
+    ActionController::Base.expects(:after_action).with(:clean_temp_files).once
+    ActionController::Base.class_eval do
+      include ::WickedPdf::PdfHelper
+    end
+  end
 end

data/test/test_helper.rb

@@ -5,13 +5,8 @@ require File.expand_path('../dummy/config/environment.rb', __FILE__)
 
 require 'test/unit'
 require 'mocha'
-
-if Rails::VERSION::MAJOR == 2
-  require 'test_help'
-else
-  require 'rails/test_help'
-  require 'mocha/test_unit'
-end
+require 'rails/test_help'
+require 'mocha/test_unit'
 
 require 'wicked_pdf'
 
@@ -24,7 +19,15 @@ if (assets_dir = Rails.root.join('app/assets')) && File.directory?(assets_dir)
   File.open(destination, 'w') { |f| f.write(source) }
 
   # Copy JS file
-  destination = assets_dir.join('javascripts/wicked.js')
+  js_dir = assets_dir.join('javascripts')
+  Dir.mkdir(js_dir) unless File.directory?(js_dir)
+  destination = js_dir.join('wicked.js')
   source = File.read('test/fixtures/wicked.js')
   File.open(destination, 'w') { |f| f.write(source) }
+
+  config_dir = assets_dir.join('config')
+  Dir.mkdir(config_dir) unless File.directory?(config_dir)
+  source = File.read('test/fixtures/manifest.js')
+  destination = config_dir.join('manifest.js')
+  File.open(destination, 'w') { |f| f.write(source) }
 end

data/test/unit/wicked_pdf_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-
 WickedPdf.config = { :exe_path => ENV['WKHTMLTOPDF_BIN'] || '/usr/local/bin/wkhtmltopdf' }
 HTML_DOCUMENT = '<html><body>Hello World</body></html>'.freeze
 
@@ -7,7 +6,10 @@ HTML_DOCUMENT = '<html><body>Hello World</body></html>'.freeze
 # Also, smash the returned array of options into a single string for
 # convenience in testing below.
 class WickedPdf
+  undef :binary_version
+  undef :binary_version=
   attr_accessor :binary_version
+
   def get_parsed_options(opts)
     parse_options(opts).join(' ')
   end
@@ -131,6 +133,11 @@ class WickedPdfTest < ActiveSupport::TestCase
     assert_equal '--outline-depth 5', @wp.get_parsed_options(:outline => { :outline_depth => 5 }).strip
   end
 
+  test 'should parse no_images option' do
+    assert_equal '--no-images', @wp.get_parsed_options(:no_images => true).strip
+    assert_equal '--images', @wp.get_parsed_options(:images => true).strip
+  end
+
   test 'should parse margins options' do
     [:top, :bottom, :left, :right].each do |o|
       assert_equal "--margin-#{o} 12", @wp.get_parsed_options(:margin => { o => '12' }).strip
@@ -200,7 +207,7 @@ class WickedPdfTest < ActiveSupport::TestCase
   test 'should not use double dash options for version without dashes' do
     @wp.binary_version = WickedPdf::BINARY_VERSION_WITHOUT_DASHES
 
-    %w(toc cover).each do |name|
+    %w[toc cover].each do |name|
       assert_equal @wp.get_valid_option(name), name
     end
   end
@@ -208,7 +215,7 @@ class WickedPdfTest < ActiveSupport::TestCase
   test 'should use double dash options for version with dashes' do
     @wp.binary_version = Gem::Version.new('0.11.0')
 
-    %w(toc cover).each do |name|
+    %w[toc cover].each do |name|
       assert_equal @wp.get_valid_option(name), "--#{name}"
     end
   end
@@ -218,4 +225,16 @@ class WickedPdfTest < ActiveSupport::TestCase
     cover_option = @wp.get_valid_option('cover')
     assert_equal @wp.get_parsed_options(options), "--disable-javascript --header-center 3 #{cover_option} http://example.org"
   end
+
+  test 'should output progress when creating pdfs on compatible hosts' do
+    wp = WickedPdf.new
+    output = []
+    options = { :progress => proc { |o| output << o } }
+    wp.pdf_from_string HTML_DOCUMENT, options
+    if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/
+      assert_empty output
+    else
+      assert(output.collect { |l| !l.match(/Loading/).nil? }.include?(true)) # should output something like "Loading pages (1/5)"
+    end
+  end
 end

data/test/unit/wkhtmltopdf_location_test.rb

@@ -0,0 +1,50 @@
+
+
+class WkhtmltopdfLocationTest < ActiveSupport::TestCase
+  setup do
+    @saved_config = WickedPdf.config
+    WickedPdf.config = {}
+  end
+
+  teardown do
+    WickedPdf.config = @saved_config
+  end
+
+  test 'should correctly locate wkhtmltopdf without bundler' do
+    bundler_module = Bundler
+    Object.send(:remove_const, :Bundler)
+
+    assert_nothing_raised do
+      WickedPdf.new
+    end
+
+    Object.const_set(:Bundler, bundler_module)
+  end
+
+  test 'should correctly locate wkhtmltopdf with bundler' do
+    assert_nothing_raised do
+      WickedPdf.new
+    end
+  end
+
+  class LocationNonWritableTest < ActiveSupport::TestCase
+    setup do
+      @saved_config = WickedPdf.config
+      WickedPdf.config = {}
+
+      @old_home = ENV['HOME']
+      ENV['HOME'] = '/not/a/writable/directory'
+    end
+
+    teardown do
+      WickedPdf.config = @saved_config
+      ENV['HOME'] = @old_home
+    end
+
+    test 'should correctly locate wkhtmltopdf with bundler while HOME is set to a non-writable directory' do
+      assert_nothing_raised do
+        WickedPdf.new
+      end
+    end
+  end
+end

data/wicked_pdf.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wicked_pdf/version'
@@ -7,28 +7,36 @@ require 'English'
 Gem::Specification.new do |spec|
   spec.name          = 'wicked_pdf'
   spec.version       = WickedPdf::VERSION
-  spec.authors       = ['Miles Z. Sterrett']
-  spec.email         = 'miles.sterrett@gmail.com'
+  spec.authors       = ['Miles Z. Sterrett', 'David Jones']
+  spec.email         = ['miles.sterrett@gmail.com', 'unixmonkey1@gmail.com']
   spec.summary       = 'PDF generator (from HTML) gem for Ruby on Rails'
   spec.homepage      = 'https://github.com/mileszs/wicked_pdf'
   spec.license       = 'MIT'
   spec.date          = Time.now.strftime('%Y-%m-%d')
-  spec.description   = <<desc
-Wicked PDF uses the shell utility wkhtmltopdf to serve a PDF file to a user from HTML.
-In other words, rather than dealing with a PDF generation DSL of some sort,
-you simply write an HTML view as you would normally, and let Wicked take care of the hard stuff.
-desc
+  spec.description   = <<DESC.gsub(/^\s+/, '')
+    Wicked PDF uses the shell utility wkhtmltopdf to serve a PDF file to a user from HTML.
+    In other words, rather than dealing with a PDF generation DSL of some sort,
+    you simply write an HTML view as you would normally, and let Wicked take care of the hard stuff.
+DESC
+  spec.metadata =    {
+    'changelog_uri' => 'https://github.com/mileszs/wicked_pdf/blob/master/CHANGELOG.md'
+  }
 
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.2')
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.requirements << 'wkhtmltopdf'
+
+  spec.add_dependency 'activesupport'
+
   spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop' if RUBY_VERSION >= '2.0.0'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rubocop', '~> 0.68.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'mocha', '= 1.3'
   spec.add_development_dependency 'test-unit'
 end