wicked_pdf 1.1.0 → 2.8.0

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,17 +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
-        after_filter :clean_temp_files
-      end
-    end
-
     def self.prepended(base)
       # Protect from trying to augment modules that appear
       # as the result of adding other gems.
@@ -19,56 +7,55 @@ class WickedPdf
 
       base.class_eval do
         after_action :clean_temp_files
-
-        alias_method :render_without_wicked_pdf, :render
-        alias_method :render_to_string_without_wicked_pdf, :render_to_string
-
-        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
       end
     end
 
-    def render_with_wicked_pdf(options = nil, *args, &block)
+    def render(*args)
+      options = args.first
       if options.is_a?(Hash) && options.key?(:pdf)
-        log_pdf_creation
-        options[:basic_auth] = set_basic_auth(options)
-        make_and_send_pdf(options.delete(:pdf), (WickedPdf.config || {}).merge(options))
+        render_with_wicked_pdf(options)
       else
-        render_without_wicked_pdf(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)
-        log_pdf_creation
-        options[:basic_auth] = set_basic_auth(options)
-        options.delete :pdf
-        make_pdf((WickedPdf.config || {}).merge(options))
+        render_to_string_with_wicked_pdf(options)
       else
-        render_to_string_without_wicked_pdf(options, *args, &block)
+        super
       end
     end
 
-    private
+    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)
 
-    def log_pdf_creation
-      logger.info '*' * 15 + 'WICKED' + '*' * 15 if logger && logger.respond_to?(:info)
+      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 = {})
@@ -76,8 +63,10 @@ class WickedPdf
         :template => options[:template],
         :layout => options[:layout],
         :formats => options[:formats],
-        :handlers => options[:handlers]
+        :handlers => options[:handlers],
+        :assigns => options[:assigns]
       }
+      render_opts[:inline] = options[:inline] if options[:inline]
       render_opts[:locals] = options[:locals] if options[:locals]
       render_opts[:file] = options[:file] if options[:file]
       html_string = render_to_string(render_opts)
@@ -97,8 +86,10 @@ class WickedPdf
           :layout => options[:layout],
           :formats => options[:formats],
           :handlers => options[:handlers],
+          :assigns => options[:assigns],
           :content_type => 'text/html'
         }
+        render_opts[:inline] = options[:inline] if options[:inline]
         render_opts[:locals] = options[:locals] if options[:locals]
         render_opts[:file] = options[:file] if options[:file]
         render(render_opts)
@@ -112,16 +103,18 @@ 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],
           :layout => options[hf][:html][:layout],
           :formats => options[hf][:html][:formats],
-          :handlers => options[hf][:html][:handlers]
+          :handlers => options[hf][:html][:handlers],
+          :assigns => options[hf][:html][:assigns]
         }
         render_opts[:locals] = options[hf][:html][:locals] if options[hf][:html][:locals]
         render_opts[:file] = options[hf][:html][:file] if options[:file]

data/lib/wicked_pdf/progress.rb

@@ -0,0 +1,33 @@
+class WickedPdf
+  module Progress
+    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? || RUBY_ENGINE == 'truffleruby')
+    end
+
+    def invoke_with_progress(command, options)
+      output = []
+      begin
+        PTY.spawn(command.join(' ')) do |stdout, _stdin, pid|
+          begin
+            stdout.sync
+            stdout.each_line("\r") do |line|
+              output << line.chomp
+              options[:progress].call(line) if options[:progress]
+            end
+          rescue Errno::EIO # rubocop:disable Lint/HandleExceptions
+            # child process is terminated, this is expected behaviour
+          ensure
+            ::Process.wait pid
+          end
+        end
+      rescue PTY::ChildExited
+        puts 'The child process exited!'
+      end
+      err = output.join('\n')
+      raise "#{command} failed (exitstatus 0). Output was: #{err}" unless $CHILD_STATUS && $CHILD_STATUS.exitstatus.zero?
+    end
+  end
+end

data/lib/wicked_pdf/railtie.rb

@@ -3,53 +3,15 @@ require 'wicked_pdf/wicked_pdf_helper'
 require 'wicked_pdf/wicked_pdf_helper/assets'
 
 class WickedPdf
-  if defined?(Rails)
-
-    if Rails::VERSION::MAJOR >= 5
-
-      class WickedRailtie < Rails::Railtie
-        initializer 'wicked_pdf.register' do |_app|
-          ActionController::Base.send :prepend, PdfHelper
-          ActionView::Base.send :include, WickedPdfHelper::Assets
-        end
-      end
-
-    elsif Rails::VERSION::MAJOR == 4
-
-      class WickedRailtie < Rails::Railtie
-        initializer 'wicked_pdf.register' do |_app|
-          ActionController::Base.send :include, PdfHelper
-          ActionView::Base.send :include, WickedPdfHelper::Assets
-        end
-      end
-
-    elsif Rails::VERSION::MAJOR == 3
-
-      class WickedRailtie < Rails::Railtie
-        initializer 'wicked_pdf.register' do |_app|
-          ActionController::Base.send :include, PdfHelper
-          if Rails::VERSION::MINOR > 0 && Rails.configuration.assets.enabled
-            ActionView::Base.send :include, WickedPdfHelper::Assets
-          else
-            ActionView::Base.send :include, WickedPdfHelper
-          end
-        end
-      end
-
-    elsif Rails::VERSION::MAJOR == 2
-
-      unless ActionController::Base.instance_methods.include? 'render_with_wicked_pdf'
-        ActionController::Base.send :include, PdfHelper
+  if defined?(Rails.env)
+    class WickedRailtie < Rails::Railtie
+      initializer 'wicked_pdf.register', :after => 'remotipart.controller_helper' do |_app|
+        ActiveSupport.on_load(:action_controller) { ActionController::Base.send :prepend, PdfHelper }
+        ActiveSupport.on_load(:action_view) { include WickedPdfHelper::Assets }
       end
-      unless ActionView::Base.instance_methods.include? 'wicked_pdf_stylesheet_link_tag'
-        ActionView::Base.send :include, WickedPdfHelper
-      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
+      output_string = ''
+      output_string << read(chunk_size) until eof?
+      output_string
+    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 = '1.1.0'.freeze
+  VERSION = '2.8.0'.freeze
 end