wicked_pdf 0.7.9 → 0.8.0

data/README.md

@@ -1,4 +1,4 @@
-# Wicked PDF
+# Wicked PDF [![Build Status](https://secure.travis-ci.org/mileszs/wicked_pdf.png)](http://travis-ci.org/mileszs/wicked_pdf)
 
 ## A PDF generation plugin for Ruby on Rails
 
@@ -9,6 +9,10 @@ _Wicked PDF has been verified to work on Ruby 1.8.7 and 1.9.2; Rails 2 and Rails
 ### Installation
 
 First, be sure to install [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/).
+If your wkhtmltopdf executable is not on your webserver's path, configure it in an initializer:
+    WickedPdf.config = {
+      :exe_path => '/usr/local/bin/wkhtmltopdf'
+    }
 Note that versions before 0.9.0 [have problems](http://code.google.com/p/wkhtmltopdf/issues/detail?id=82&q=vodnik) on some machines with reading/writing to streams.
 This plugin relies on streams to communicate with wkhtmltopdf.
 
@@ -22,6 +26,10 @@ Next:
 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
 
 ### Basic Usage
 
@@ -69,7 +77,7 @@ or add this to your Gemfile:
                    :book                           => true,
                    :default_header                 => true,
                    :disable_javascript             => false,
-                   :greyscale                      => true,
+                   :grayscale                      => true,
                    :lowquality                     => true,
                    :enable_plugins                 => true,
                    :disable_internal_links         => true,
@@ -220,7 +228,7 @@ You can put your default configuration, applied to all pdf's at "wicked_pdf.rb"
 
 ### Further Reading
 
-Andreas Happe's post [Generating PDFs from Ruby on Rails](http://starseeders.net/generating-pdfs-from-ruby-on-rails/)
+Andreas Happe's post [Generating PDFs from Ruby on Rails](http://www.snikt.net/blog/2012/04/26/wicked-pdf/)
 
 StackOverflow [questions with the tag "wicked-pdf"](http://stackoverflow.com/questions/tagged/wicked-pdf)
 

data/lib/pdf_helper.rb

@@ -3,6 +3,10 @@ module PdfHelper
   require 'wicked_pdf_tempfile'
 
   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

data/lib/wicked_pdf.rb

@@ -6,22 +6,26 @@ require 'digest/md5'
 require 'rbconfig'
 require RbConfig::CONFIG['target_os'] == 'mingw32' && !(RUBY_VERSION =~ /1.9/) ? 'win32/open3' : 'open3'
 require 'active_support/core_ext/class/attribute_accessors'
-require 'active_support/core_ext/object/blank'
+
+begin
+  require 'active_support/core_ext/object/blank'
+rescue LoadError
+  require 'active_support/core_ext/blank'
+end
 
 require 'wicked_pdf_railtie'
 require 'wicked_pdf_tempfile'
 
 class WickedPdf
+  EXE_NAME = "wkhtmltopdf"
   @@config = {}
   cattr_accessor :config
 
   def initialize(wkhtmltopdf_binary_path = nil)
-    @exe_path = wkhtmltopdf_binary_path
-    @exe_path ||= WickedPdf.config[:exe_path] unless WickedPdf.config.empty?
-    @exe_path ||= (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
-    raise "Location of wkhtmltopdf unknown" if @exe_path.empty?
-    raise "Bad wkhtmltopdf's path" unless File.exists?(@exe_path)
-    raise "Wkhtmltopdf is not executable" unless File.executable?(@exe_path)
+    @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 "#{EXE_NAME} is not executable" unless File.executable?(@exe_path)
   end
 
   def pdf_from_string(string, options={})
@@ -44,8 +48,8 @@ class WickedPdf
   private
 
     def in_development_mode?
-      (defined?(Rails) && Rails.env == 'development') ||
-        (defined?(RAILS_ENV) && RAILS_ENV == 'development')
+      return Rails.env == 'development' if defined?(Rails)
+      RAILS_ENV == 'development' if defined?(RAILS_ENV)
     end
 
     def on_windows?
@@ -196,4 +200,15 @@ class WickedPdf
       end
     end
 
+    def find_wkhtmltopdf_binary_path
+      possible_locations = (ENV['PATH'].split(':')+%w[/usr/bin /usr/local/bin ~/bin]).uniq
+      exe_path ||= WickedPdf.config[:exe_path] unless WickedPdf.config.empty?
+      exe_path ||= begin
+        (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+      rescue Exception => e
+        nil
+      end
+      exe_path ||= possible_locations.map{|l| File.expand_path("#{l}/#{EXE_NAME}") }.find{|location| File.exists? location}
+      exe_path || ''
+    end
 end

data/lib/wicked_pdf_helper.rb

@@ -1,41 +1,76 @@
 module WickedPdfHelper
+  def self.root_path
+    String === Rails.root ? Pathname.new(Rails.root) : Rails.root
+  end
+
   def wicked_pdf_stylesheet_link_tag(*sources)
-    css_dir = Rails.root.join('public','stylesheets')
-    sources.collect { |source|
+    css_dir = WickedPdfHelper.root_path.join('public', 'stylesheets')
+    css_text = sources.collect { |source|
       "<style type='text/css'>#{File.read(css_dir.join(source+'.css'))}</style>"
-    }.join("\n").html_safe
+    }.join("\n")
+    css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
   end
 
   def wicked_pdf_image_tag(img, options={})
-    image_tag "file:///#{Rails.root.join('public', 'images', img)}", options
+    image_tag "file://#{WickedPdfHelper.root_path.join('public', 'images', img)}", options
   end
 
   def wicked_pdf_javascript_src_tag(jsfile, options={})
-    javascript_src_tag "file:///#{Rails.root.join('public','javascripts',jsfile)}", options
+    javascript_src_tag "file://#{WickedPdfHelper.root_path.join('public', 'javascripts', jsfile)}", options
   end
 
   def wicked_pdf_javascript_include_tag(*sources)
-    sources.collect{ |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n").html_safe
+    js_text = sources.collect{ |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n")
+    js_text.respond_to?(:html_safe) ? js_text.html_safe : js_text
   end
+
   module Assets
     def wicked_pdf_stylesheet_link_tag(*sources)
       sources.collect { |source|
-        "<style type='text/css'>#{Rails.application.assets.find_asset(source+".css")}</style>"
+        "<style type='text/css'>#{read_asset(source+".css")}</style>"
       }.join("\n").html_safe
     end
 
     def wicked_pdf_image_tag(img, options={})
-      asset = Rails.application.assets.find_asset(img)
-      image_tag "file:///#{asset.pathname.to_s}", options
+      image_tag "file://#{asset_pathname(img).to_s}", options
     end
 
     def wicked_pdf_javascript_src_tag(jsfile, options={})
-      asset = Rails.application.assets.find_asset(jsfile)
-      javascript_include_tag "file:///#{asset.pathname.to_s}", options
+      javascript_include_tag "file://#{asset_pathname(jsfile).to_s}", options
     end
 
     def wicked_pdf_javascript_include_tag(*sources)
-      sources.collect{ |source| "<script type='text/javascript'>#{Rails.application.assets.find_asset(source+".js")}</script>" }.join("\n").html_safe
+      sources.collect { |source|
+        "<script type='text/javascript'>#{read_asset(source+".js")}</script>"
+      }.join("\n").html_safe
+    end
+
+    private
+
+    def asset_pathname(source)
+      if Rails.configuration.assets.compile == false
+        if ActionController::Base.asset_host
+          # asset_path returns an absolute URL using asset_host if asset_host is set
+          asset_path(source)
+        else
+          File.join(Rails.public_path, asset_path(source))
+        end
+      else
+        Rails.application.assets.find_asset(source).pathname
+      end
+    end
+
+    def read_asset(source)
+      if Rails.configuration.assets.compile == false
+        if ActionController::Base.asset_host
+          require 'open-uri'
+          open(asset_pathname(source)) {|f| f.read }
+        else
+          IO.read(asset_pathname(source))
+        end
+      else
+        Rails.application.assets.find_asset(source).to_s
+      end
     end
   end
 end

data/test/pdf_helper_test.rb

@@ -17,10 +17,12 @@ class PdfHelperTest < ActionController::TestCase
     @ac=nil
   end
 
-  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]
+  if Rails::VERSION::MAJOR == 2
+    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
 end

data/test/wicked_pdf_helper_test.rb

@@ -2,23 +2,25 @@ require 'test_helper'
 require 'action_view/test_case'
 
 class WickedPdfHelperTest < ActionView::TestCase
-  test 'wicked_pdf_stylesheet_link_tag should inline the stylesheets passed in' do
-    assert_equal "<style type='text/css'>/* Wicked styles */\n</style>",
-                 wicked_pdf_stylesheet_link_tag('../../vendor/plugins/wicked_pdf/test/fixtures/wicked')
-  end
+  if Rails::VERSION::MAJOR == 2
+    test 'wicked_pdf_stylesheet_link_tag should inline the stylesheets passed in' do
+      assert_equal "<style type='text/css'>/* Wicked styles */\n</style>",
+                   wicked_pdf_stylesheet_link_tag('../../vendor/plugins/wicked_pdf/test/fixtures/wicked')
+    end
 
-  test 'wicked_pdf_image_tag should return the same as image_tag when passed a full path' do
-    assert_equal image_tag("file://#{Rails.root.join('public','images','pdf')}"),
-                 wicked_pdf_image_tag('pdf')
-  end
+    test 'wicked_pdf_image_tag should return the same as image_tag when passed a full path' do
+      assert_equal image_tag("file://#{Rails.root.join('public','images','pdf')}"),
+                   wicked_pdf_image_tag('pdf')
+    end
 
-  test 'wicked_pdf_javascript_src_tag should return the same as javascript_src_tag when passed a full path' do
-    assert_equal javascript_src_tag("file://#{Rails.root.join('public','javascripts','pdf')}", {}),
-                 wicked_pdf_javascript_src_tag('pdf')
-  end
+    test 'wicked_pdf_javascript_src_tag should return the same as javascript_src_tag when passed a full path' do
+      assert_equal javascript_src_tag("file://#{Rails.root.join('public','javascripts','pdf')}", {}),
+                   wicked_pdf_javascript_src_tag('pdf')
+    end
 
-  test 'wicked_pdf_include_tag should return many wicked_pdf_javascript_src_tags' do
-    assert_equal [wicked_pdf_javascript_src_tag('foo'), wicked_pdf_javascript_src_tag('bar')].join("\n"),
-                 wicked_pdf_javascript_include_tag('foo', 'bar')
+    test 'wicked_pdf_include_tag should return many wicked_pdf_javascript_src_tags' do
+      assert_equal [wicked_pdf_javascript_src_tag('foo'), wicked_pdf_javascript_src_tag('bar')].join("\n"),
+                   wicked_pdf_javascript_include_tag('foo', 'bar')
+    end
   end
 end

data/test/wicked_pdf_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-WickedPdf.config = { :exe_path => '/usr/local/bin/wkhtmltopdf' }
+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
@@ -84,7 +84,7 @@ class WickedPdfTest < ActiveSupport::TestCase
     wp = WickedPdf.new
 
     [:font_name, :header_text].each do |o|
-      assert_equal  "--toc-#{o.to_s.gsub('_', '-')} \"toc\"",
+      assert_equal  "--toc --toc-#{o.to_s.gsub('_', '-')} \"toc\"",
                     wp.get_parsed_options(:toc => {o => "toc"}).strip
     end
 
@@ -92,12 +92,12 @@ class WickedPdfTest < ActiveSupport::TestCase
       :l5_font_size, :l6_font_size, :l7_font_size, :l1_indentation, :l2_indentation,
       :l3_indentation, :l4_indentation, :l5_indentation, :l6_indentation, :l7_indentation
     ].each do |o|
-      assert_equal  "--toc-#{o.to_s.gsub('_', '-')} 5",
+      assert_equal  "--toc --toc-#{o.to_s.gsub('_', '-')} 5",
                     wp.get_parsed_options(:toc => {o => 5}).strip
     end
 
     [:no_dots, :disable_links, :disable_back_links].each do |o|
-      assert_equal  "--toc-#{o.to_s.gsub('_', '-')}",
+      assert_equal  "--toc --toc-#{o.to_s.gsub('_', '-')}",
                     wp.get_parsed_options(:toc => {o => true}).strip
     end
   end
@@ -129,7 +129,7 @@ class WickedPdfTest < ActiveSupport::TestCase
     [:cookie, :post].each do |o|
       assert_equal "--#{o.to_s.gsub('_', '-')} name value", wp.get_parsed_options(o => "name value").strip
 
-      nv_formatter = ->(number){ "--#{o.to_s.gsub('_', '-')} par#{number} val#{number}" }
+      nv_formatter = Proc.new{|number| "--#{o.to_s.gsub('_', '-')} par#{number} val#{number}" }
       assert_equal "#{nv_formatter.call(1)} #{nv_formatter.call(2)}", wp.get_parsed_options(o => ['par1 val1', 'par2 val2']).strip
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wicked_pdf
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 9
-  version: 0.7.9
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Miles Z. Sterret
@@ -15,9 +15,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-30 00:00:00 Z
-dependencies: []
-
+date: 2012-11-14 00:00:00 Z
+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"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: |
   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,
@@ -45,7 +72,7 @@ files:
 - test/test_helper.rb
 - test/wicked_pdf_helper_test.rb
 - test/wicked_pdf_test.rb
-homepage: http://github.com/mileszs/wicked_pdf
+homepage: https://github.com/mileszs/wicked_pdf
 licenses: []
 
 post_install_message: