wicked_pdf 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41040ae8bc94e95e177f1b1a4c84232e45b5eb6b
-  data.tar.gz: 04a72a2aabb318708b6e3c691e349df3524160a9
+  metadata.gz: 54d0ec248323c907fe336b0dea9afff757737f6d
+  data.tar.gz: 35626a59f71132ef14fb866f453e23998e1c1982
 SHA512:
-  metadata.gz: ba7dded6264c5122179c27ca5195cf32836beefbe5768bf2471884281b4f524fece1d128cb6a72c991176c7525ae7ed4e6eada261d5f5b20634f5f05ec3708d3
-  data.tar.gz: 90a90533caf7543c88f4b444da0fb2b4c8d7bdd33ea26f7bae134785cc079b6b6c8157bc13aebb52df70c1da6c0d1a8e3f32ce4d128cf22a9b9163c120cad6ae
+  metadata.gz: 41d0c2d5e21c6b1086c425e0e4ebe65f09421694f054435b0d97d9d10622dd493a6dc89c606bbbe6afe9a6261a7639d1545efeb7a0faae1d157518c8e6654886
+  data.tar.gz: 38cf8a6e92c561713effa3e3f28259a19b8252f9d9810b46f9ee6c31801f895ffbe229748ad10dc81bd215c2db79b78aba8896fbdb81a735d0813c30d83ac077

data/README.md

@@ -30,7 +30,7 @@ Note that versions before 0.9.0 [have problems](http://code.google.com/p/wkhtmlt
 This plugin relies on streams to communicate with wkhtmltopdf.
 
 For more information about wkhtmltopdf, see the project's [homepage](http://code.google.com/p/wkhtmltopdf/) and
-[github repo](https://github.com/antialize/wkhtmltopdf). There's also some documentation for a recent, stable version 
+[github repo](https://github.com/antialize/wkhtmltopdf). There's also some documentation for a recent, stable version
 on the author's website, [here](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf-0.9.9-doc.html).
 
 Next:
@@ -43,7 +43,7 @@ or add this to your Gemfile:
 ```ruby
 gem 'wicked_pdf'
 ```
-    
+
 You may also need to add
 ```ruby
 Mime::Type.register "application/pdf", :pdf
@@ -111,12 +111,12 @@ class ThingsController < ApplicationController
       format.html
       format.pdf do
         render :pdf                            => 'file_name',
-               :disposition	                   => 'attachment',                 # default 'inline'                   
+               :disposition	                   => 'attachment',                 # default 'inline'
                :template                       => 'things/show.pdf.erb',
                :file                           => "#{Rails.root}/files/foo.erb"
                :layout                         => 'pdf.html',                   # use 'pdf.html' for a pdf.html.erb file
                :wkhtmltopdf                    => '/usr/local/bin/wkhtmltopdf', # path to binary
-               :show_as_html                   => params[:debug].present?,      # allow debuging based on url param
+               :show_as_html                   => params[:debug].present?,      # allow debugging based on url param
                :orientation                    => 'Landscape',                  # default Portrait
                :page_size                      => 'A4, Letter, ...',            # default A4
                :save_to_file                   => Rails.root.join('pdfs', "#{filename}.pdf"),
@@ -149,6 +149,7 @@ class ThingsController < ApplicationController
                :disable_smart_shrinking        => true,
                :use_xserver                    => true,
                :no_background                  => true,
+               :viewport_size                  => 'TEXT'                    # available only with use_xserver or patched QT
                :extra                          => ''                        # directly inserted into the command to wkhtmltopdf
                :margin => {:top                => SIZE,                     # default 10 (mm)
                            :bottom             => SIZE,
@@ -215,6 +216,10 @@ If you need to just create a pdf and not display it:
 # create a pdf from a string
 pdf = WickedPdf.new.pdf_from_string('<h1>Hello There!</h1>')
 
+# create a pdf file from a html file without converting it to string
+# Path must be absolute path
+pdf = WickedPdf.new.pdf_from_html_file('/your/absolute/path/here')
+
 # create a pdf from string using templates, layouts and content option for header or footer
 WickedPdf.new.pdf_from_string(
   render_to_string('templates/pdf.html.erb', :layout => 'pdfs/layout_pdf'),
@@ -222,10 +227,10 @@ WickedPdf.new.pdf_from_string(
     :content => render_to_string(:layout => 'pdfs/layout_pdf')
   }
 )
-  
+
 # or from your controller, using views & templates and all wicked_pdf options as normal
 pdf = render_to_string :pdf => "some_file_name"
-		
+
 # then save to a file
 save_path = Rails.root.join('pdfs','filename.pdf')
 File.open(save_path, 'wb') do |file|

data/lib/wicked_pdf.rb

@@ -37,7 +37,7 @@ class WickedPdf
   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?
-    raise "Bad #{EXE_NAME}'s path" unless File.exists?(@exe_path)
+    raise "Bad #{EXE_NAME}'s path: #{@exe_path}" unless File.exists?(@exe_path)
     raise "#{EXE_NAME} is not executable" unless File.executable?(@exe_path)
 
     @binary_version = DEFAULT_BINARY_VERSION
@@ -51,20 +51,22 @@ class WickedPdf
     end
   end
 
-  def pdf_from_string(string, options={})
+  def pdf_from_html_file(filepath, options={})
     if WickedPdf.config[:retreive_version]
       retreive_binary_version
     end
 
     temp_path = options.delete(:temp_path)
-    string_file = WickedPdfTempfile.new("wicked_pdf.html", temp_path)
-    string_file.binmode
-    string_file.write(string)
-    string_file.close
     generated_pdf_file = WickedPdfTempfile.new("wicked_pdf_generated_file.pdf", temp_path)
-    command = "\"#{@exe_path}\" #{'-q ' unless on_windows?}#{parse_options(options)} \"file:///#{string_file.path}\" \"#{generated_pdf_file.path}\" " # -q for no errors on stdout
-    print_command(command) if in_development_mode?
-    err = Open3.popen3(command) do |stdin, stdout, stderr|
+    command = [@exe_path]
+    command << '-q' unless on_windows? # suppress errors on stdout
+    command += parse_options(options)
+    command << "file://#{filepath}"
+    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
     end
     if return_file = options.delete(:return_file)
@@ -78,10 +80,24 @@ class WickedPdf
   rescue Exception => e
     raise "Failed to execute:\n#{command}\nError: #{e}"
   ensure
-    string_file.close! if string_file
     generated_pdf_file.close! if generated_pdf_file && !return_file
   end
 
+  def pdf_from_string(string, options={})
+    temp_path = options.delete(:temp_path)
+    string_file = WickedPdfTempfile.new("wicked_pdf.html", temp_path)
+    string_file.binmode
+    string_file.write(string)
+    string_file.close
+
+    pdf = pdf_from_html_file(string_file.path, options)
+    pdf
+  rescue Exception => e
+    raise "Error: #{e}"
+  ensure
+    string_file.close! if string_file
+  end
+
   private
 
     def in_development_mode?
@@ -122,40 +138,50 @@ class WickedPdf
         parse_margins(options.delete(:margin)),
         parse_others(options),
         parse_basic_auth(options)
-      ].join(' ')
+      ].flatten
     end
 
     def parse_extra(options)
-      options[:extra].nil? ? '' : options[:extra]
+      return [] if options[:extra].nil?
+      return options[:extra].split if options[:extra].respond_to?(:split)
+      return options[:extra]
     end
 
     def parse_basic_auth(options)
       if options[:basic_auth]
         user, passwd = Base64.decode64(options[:basic_auth]).split(":")
-        "--username '#{user}' --password '#{passwd}'"
+        ["--username", user, "--password", passwd]
       else
-        ""
+        []
       end
     end
 
     def make_option(name, value, type=:string)
       if value.is_a?(Array)
-        return value.collect { |v| make_option(name, v, type) }.join('')
+        return value.collect { |v| make_option(name, v, type) }
+      end
+      if type == :boolean
+        ["--#{name.gsub('_', '-')}"]
+      else
+        ["--#{name.gsub('_', '-')}", value.to_s]
       end
-      "--#{name.gsub('_', '-')} " + case type
-        when :boolean then ""
-        when :numeric then value.to_s
-        when :name_value then value.to_s
-        else "\"#{value}\""
-      end + " "
     end
 
     def make_options(options, names, prefix="", type=:string)
-      names.collect {|o| make_option("#{prefix.blank? ? "" : prefix + "-"}#{o.to_s}", options[o], type) unless options[o].blank?}.join
+      return [] if options.nil?
+      names.collect do |o| 
+        if options[o].blank?
+          []
+        else
+          make_option("#{prefix.blank? ? "" : prefix + "-"}#{o.to_s}", 
+                      options[o], 
+                      type)
+        end
+      end
     end
 
     def parse_header_footer(options)
-      r=""
+      r=[]
       [:header, :footer].collect do |hf|
         unless options[hf].blank?
           opt_hf = options[hf]
@@ -181,22 +207,22 @@ class WickedPdf
 
     def parse_cover(argument)
       arg = argument.to_s
-      return '' if arg.blank?
-      r = '--cover '
+      return [] if arg.blank?
       # Filesystem path or URL - hand off to wkhtmltopdf
       if argument.is_a?(Pathname) || (arg[0,4] == 'http')
-        r + arg
+        ['--cover', arg]
       else # HTML content
         @hf_tempfiles ||= []
         @hf_tempfiles << tf=WickedPdfTempfile.new("wicked_cover_pdf.html")
         tf.write arg
         tf.flush
-        r + tf.path
+        ['--cover', tf.path]
       end
     end
 
     def parse_toc(options)
-      r = '--toc ' unless options.nil?
+      return [] if options.nil?
+      r = ['--toc']
       unless options.blank?
         r += make_options(options, [ :font_name, :header_text], "toc")
         r +=make_options(options, [ :depth,
@@ -223,19 +249,22 @@ class WickedPdf
     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, [:top, :bottom, :left, :right], "margin", :numeric) unless options.blank?
+      make_options(options, [:top, :bottom, :left, :right], "margin", :numeric)
     end
 
     def parse_others(options)
+      r = []
       unless options.blank?
-        r = make_options(options, [ :orientation,
+        r += make_options(options, [ :orientation,
                                     :page_size,
                                     :page_width,
                                     :page_height,
@@ -244,7 +273,8 @@ class WickedPdf
                                     :password,
                                     :dpi,
                                     :encoding,
-                                    :user_style_sheet])
+                                    :user_style_sheet,
+                                    :viewport_size])
         r +=make_options(options, [ :cookie,
                                     :post], "", :name_value)
         r +=make_options(options, [ :redirect_delay,
@@ -266,6 +296,7 @@ class WickedPdf
                                     :no_background], "", :boolean)
         r +=make_options(options, [ :no_stop_slow_scripts ], "", nil)
       end
+      r
     end
 
     def find_wkhtmltopdf_binary_path

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '0.10.2'
+  VERSION = '0.11.0'
 end

data/test/unit/wicked_pdf_test.rb

@@ -3,10 +3,12 @@ require 'test_helper'
 WickedPdf.config = { :exe_path => ENV['WKHTMLTOPDF_BIN'] || '/usr/local/bin/wkhtmltopdf' }
 HTML_DOCUMENT = "<html><body>Hello World</body></html>"
 
-# Provide a public accessor to the normally-private parse_options function
+# Provide a public accessor to the normally-private parse_options function.
+# Also, smash the returned array of options into a single string for
+# convenience in testing below.
 class WickedPdf
   def get_parsed_options(opts)
-    parse_options(opts)
+    parse_options(opts).join(' ')
   end
 end
 
@@ -22,7 +24,7 @@ class WickedPdfTest < ActiveSupport::TestCase
     assert pdf.rstrip.end_with?("%%EOF")
     assert pdf.length > 100
   end
-  
+
   test "should generate PDF from html document with long lines" do
     wp = WickedPdf.new
     document_with_long_line_file = File.new("test/fixtures/document_with_long_line.html", "r")
@@ -32,6 +34,15 @@ class WickedPdfTest < ActiveSupport::TestCase
     assert pdf.length > 100
   end
 
+  test "should generate PDF from html existing HTML file without converting it to string" do
+    wp = WickedPdf.new
+    filepath = File.join(Dir.pwd, "test/fixtures/document_with_long_line.html")
+    pdf = wp.pdf_from_html_file(filepath)
+    assert pdf.start_with?("%PDF-1.4")
+    assert pdf.rstrip.end_with?("%%EOF")
+    assert pdf.length > 100
+  end
+
   test "should raise exception when no path to wkhtmltopdf" do
     assert_raise RuntimeError do
       WickedPdf.new " "
@@ -76,7 +87,7 @@ class WickedPdfTest < ActiveSupport::TestCase
 
     [:header, :footer].each do |hf|
       [:center, :font_name, :left, :right].each do |o|
-        assert_equal  "--#{hf.to_s}-#{o.to_s.gsub('_', '-')} \"header_footer\"",
+        assert_equal  "--#{hf.to_s}-#{o.to_s.gsub('_', '-')} header_footer",
                       wp.get_parsed_options(hf => {o => "header_footer"}).strip
       end
 
@@ -87,7 +98,7 @@ class WickedPdfTest < ActiveSupport::TestCase
 
       assert_equal  "--#{hf.to_s}-line",
                     wp.get_parsed_options(hf => {:line => true}).strip
-      assert_equal  "--#{hf.to_s}-html \"http://www.abc.com\"",
+      assert_equal  "--#{hf.to_s}-html http://www.abc.com",
                     wp.get_parsed_options(hf => {:html => {:url => 'http://www.abc.com'}}).strip
     end
   end
@@ -96,7 +107,7 @@ class WickedPdfTest < ActiveSupport::TestCase
     wp = WickedPdf.new
 
     [:font_name, :header_text].each do |o|
-      assert_equal  "--toc --toc-#{o.to_s.gsub('_', '-')} \"toc\"",
+      assert_equal  "--toc --toc-#{o.to_s.gsub('_', '-')} toc",
                     wp.get_parsed_options(:toc => {o => "toc"}).strip
     end
 
@@ -143,7 +154,7 @@ class WickedPdfTest < ActiveSupport::TestCase
     [ :orientation, :page_size, :proxy, :username, :password, :dpi,
       :encoding, :user_style_sheet
     ].each do |o|
-      assert_equal "--#{o.to_s.gsub('_', '-')} \"opts\"", wp.get_parsed_options(o => "opts").strip
+      assert_equal "--#{o.to_s.gsub('_', '-')} opts", wp.get_parsed_options(o => "opts").strip
     end
 
     [:cookie, :post].each do |o|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Miles Z. Sterrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails