wicked_pdf 0.9.4 → 0.9.5

data/README.md

@@ -27,9 +27,11 @@ or add this to your Gemfile:
 
     gem 'wicked_pdf'
     
-You may also need to add 
-    Mime::Type.register "application/pdf", :pdf
-to config/initializers/mime_types.rb
+You may also need to add
+```ruby
+Mime::Type.register "application/pdf", :pdf
+```
+to `config/initializers/mime_types.rb`
 
 ### Basic Usage
 

data/lib/pdf_helper.rb

@@ -38,7 +38,7 @@ module PdfHelper
   private
 
     def log_pdf_creation
-      logger.info '*'*15 + 'WICKED' + '*'*15
+      logger.info '*'*15 + 'WICKED' + '*'*15 unless logger.nil?
     end
 
     def set_basic_auth(options={})
@@ -91,7 +91,6 @@ module PdfHelper
           render_opts.merge!({:file => options[hf][:html][:file]}) if options[:file]
           tf.write render_to_string(render_opts)
           tf.flush
-          options[hf][:html].delete(:template)
           options[hf][:html][:url] = "file:///#{tf.path}"
         end
       end

data/lib/wicked_pdf.rb

@@ -19,6 +19,7 @@ require 'wicked_pdf_tempfile'
 require 'wicked_pdf_middleware'
 
 class WickedPdf
+  DEFAULT_BINARY_VERSION = Gem::Version.new('0.9.9')
   EXE_NAME = "wkhtmltopdf"
   @@config = {}
   cattr_accessor :config
@@ -28,11 +29,25 @@ class WickedPdf
     raise "Location of #{EXE_NAME} unknown" if @exe_path.empty?
     raise "Bad #{EXE_NAME}'s path" unless File.exists?(@exe_path)
     raise "#{EXE_NAME} is not executable" unless File.executable?(@exe_path)
+
+    @binary_version = DEFAULT_BINARY_VERSION
+  end
+
+  def retreive_binary_version
+    begin
+      stdin, stdout, stderr = Open3.popen3(@exe_path + ' -V')
+      @binary_version = parse_version(stdout.gets(nil))
+    rescue StandardError      
+    end
   end
 
   def pdf_from_string(string, 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 = WickedPdfTempfile.new("wicked_pdf.html", temp_path)
     string_file.write(string)
     string_file.close
     generated_pdf_file = WickedPdfTempfile.new("wicked_pdf_generated_file.pdf", temp_path)
@@ -44,10 +59,13 @@ class WickedPdf
     generated_pdf_file.rewind
     generated_pdf_file.binmode
     pdf = generated_pdf_file.read
-    raise "PDF could not be generated!" if pdf and pdf.rstrip.length == 0
+    raise "PDF could not be generated!\n Command Error: #{err}" if pdf and pdf.rstrip.length == 0
     pdf
   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
   end
 
   private
@@ -57,6 +75,10 @@ class WickedPdf
       RAILS_ENV == 'development' if defined?(RAILS_ENV)
     end
 
+    def get_binary_version
+      @binary_version
+    end
+
     def on_windows?
       RbConfig::CONFIG['target_os'] == 'mingw32'
     end
@@ -65,6 +87,15 @@ class WickedPdf
       p "*"*15 + cmd + "*"*15
     end
 
+    def parse_version(version_info)
+      match_data = /wkhtmltopdf\s*(\d*\.\d*\.\d*\w*)/.match(version_info)      
+      if (match_data && (2 == match_data.length))        
+        Gem::Version.new(match_data[1])
+      else
+        DEFAULT_BINARY_VERSION
+      end
+    end
+
     def parse_options(options)
       [
         parse_extra(options),

data/lib/wicked_pdf_helper.rb

@@ -56,9 +56,12 @@ module WickedPdfHelper
 
     private
 
+    # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
+    URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+
     def asset_pathname(source)
       if Rails.configuration.assets.compile == false
-        if ActionController::Base.asset_host
+        if asset_path(source) =~ URI_REGEXP
           # asset_path returns an absolute URL using asset_host if asset_host is set
           asset_path(source)
         else
@@ -71,7 +74,7 @@ module WickedPdfHelper
 
     def read_asset(source)
       if Rails.configuration.assets.compile == false
-        if ActionController::Base.asset_host
+        if asset_path(source) =~ URI_REGEXP
           require 'open-uri'
           open(asset_pathname(source), 'r:UTF-8') {|f| f.read }
         else

data/lib/wicked_pdf_middleware.rb

@@ -3,7 +3,7 @@ class WickedPdf
 
     def initialize(app, options = {}, conditions = {})
       @app        = app
-      @options    = options
+      @options    = (WickedPdf.config || {}).merge(options)
       @conditions = conditions
     end
 
@@ -18,7 +18,8 @@ class WickedPdf
         body = response.respond_to?(:body) ? response.body : response.join
         body = body.join if body.is_a?(Array)
 
-        body = WickedPdf.new.pdf_from_string(translate_paths(body, env))
+        body = WickedPdf.new(@options[:wkhtmltopdf]).pdf_from_string(translate_paths(body, env), @options)
+
         response = [body]
 
         # Do not cache PDFs
@@ -27,6 +28,10 @@ class WickedPdf
 
         headers["Content-Length"]         = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
         headers["Content-Type"]           = "application/pdf"
+        if @options.fetch(:disposition, '') == 'attachment'
+          headers["Content-Disposition"]       = 'attachment'
+          headers["Content-Transfer-Encoding"] = 'binary'
+        end
       end
 
       [status, headers, response]
@@ -87,4 +92,4 @@ class WickedPdf
     end
 
   end
-end
+end

data/lib/wicked_pdf_version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '0.9.4'
+  VERSION = '0.9.5'
 end

data/test/functional/pdf_helper_test.rb

@@ -21,7 +21,6 @@ class PdfHelperTest < ActionController::TestCase
     test "should prerender header and footer :template options" do
       options = @ac.send( :prerender_header_and_footer,
                           :header => {:html => { :template => 'hf.html.erb'}});
-      assert !options[:header][:html].has_key?(:template)
       assert_match /^file:\/\/\/.*wicked_header_pdf.*\.html/, options[:header][:html][:url]
     end
   end

data/test/test_helper.rb

@@ -3,9 +3,9 @@ ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 if Rails::VERSION::MAJOR == 2
-	require "test_help"
+  require "test_help"
 else
-	require "rails/test_help"
+  require "rails/test_help"
 end
 
 require "wicked_pdf"

data/test/unit/wicked_pdf_test.rb

@@ -11,6 +11,9 @@ class WickedPdf
 end
 
 class WickedPdfTest < ActiveSupport::TestCase
+  def setup
+    @wp = WickedPdf.new
+  end
 
   test "should generate PDF from html document" do
     wp = WickedPdf.new
@@ -153,4 +156,27 @@ class WickedPdfTest < ActiveSupport::TestCase
       assert_equal "--#{o.to_s.gsub('_', '-')}", wp.get_parsed_options(o => true).strip
     end
   end
+
+  test "should extract old wkhtmltopdf version" do
+    version_info_sample = "Name:\n  wkhtmltopdf 0.9.9\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
+    assert_equal WickedPdf::DEFAULT_BINARY_VERSION, @wp.send(:parse_version, version_info_sample)
+  end
+
+  test "should extract new wkhtmltopdf version" do
+    version_info_sample = "Name:\n  wkhtmltopdf 0.11.0 rc2\n\nLicense:\n  Copyright (C) 2010 wkhtmltopdf/wkhtmltoimage Authors.\n\n\n\n  License LGPLv3+: GNU Lesser General Public License version 3 or later\n  <http://gnu.org/licenses/lgpl.html>. This is free software: you are free to\n  change and redistribute it. There is NO WARRANTY, to the extent permitted by\n  law.\n\nAuthors:\n  Written by Jan Habermann, Christian Sciberras and Jakob Truelsen. Patches by\n  Mehdi Abbad, Lyes Amazouz, Pascal Bach, Emmanuel Bouthenot, Benoit Garret and\n  Mario Silva."
+    assert_equal Gem::Version.new('0.11.0'), @wp.send(:parse_version, version_info_sample)
+  end
+
+  test "should extract wkhtmltopdf version with nondigit symbols" do
+    version_info_sample = "Name:\n  wkhtmltopdf 0.10.4b\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
+    assert_equal Gem::Version.new('0.10.4b'), @wp.send(:parse_version, version_info_sample)
+  end
+
+  test "should fallback to default version on parse error" do
+    assert_equal WickedPdf::DEFAULT_BINARY_VERSION, @wp.send(:parse_version, '')
+  end
+
+  test "should set Default version on initialize" do
+    assert_equal WickedPdf::DEFAULT_BINARY_VERSION, @wp.send(:get_binary_version)
+  end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: wicked_pdf
 version: !ruby/object:Gem::Version 
-  hash: 51
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 9
-  - 4
-  version: 0.9.4
+  - 5
+  version: 0.9.5
 platform: ruby
 authors: 
 - Miles Z. Sterret
@@ -15,17 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-17 00:00:00 Z
+date: 2013-04-12 00:00:00 -04:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -35,11 +33,9 @@ dependencies:
   name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -49,11 +45,9 @@ dependencies:
   name: sqlite3
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -122,6 +116,7 @@ files:
 - test/functional/wicked_pdf_helper_test.rb
 - test/test_helper.rb
 - test/unit/wicked_pdf_test.rb
+has_rdoc: true
 homepage: https://github.com/mileszs/wicked_pdf
 licenses: []
 
@@ -131,27 +126,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: PDF generator (from HTML) gem for Ruby on Rails