wicked_pdf 0.7.2 → 0.7.3

data/README.md

@@ -2,7 +2,7 @@
 
 ## A PDF generation plugin for Ruby on Rails
 
-Wicked PDF uses the shell utility [wkhtmltopdf](http://code.google.com/p/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.
+Wicked PDF uses the shell utility [wkhtmltopdf](http://code.google.com/p/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, then let Wicked take care of the hard stuff.
 
 _Wicked PDF has been verified to work on Ruby 1.8.7 and 1.9.2; Rails 2 and Rails 3_
 
@@ -18,6 +18,11 @@ Next:
 
     script/plugin install git://github.com/mileszs/wicked_pdf.git
     script/generate wicked_pdf
+
+or add this to your Gemfile:
+
+    gem 'wicked_pdf'
+
 ### Basic Usage
 
     class ThingsController < ApplicationController
@@ -40,7 +45,7 @@ Next:
           format.pdf do
             render :pdf                            => 'file_name',
                    :template                       => 'things/show.pdf.erb',
-                   :layout                         => 'pdf.html',                   # use 'pdf.html' for a pfd.html.erb file
+                   :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
                    :orientation                    => 'Landscape',                  # default Portrait
@@ -55,6 +60,8 @@ Next:
                    :dpi                            => 'dpi',
                    :encoding                       => 'TEXT',
                    :user_style_sheet               => 'URL',
+                   :cookie                         => ['_session_id SESSION_ID'], # could be an array or a single string in a 'name value' format
+                   :post                           => ['query QUERY_PARAM'],    # could be an array or a single string in a 'name value' format
                    :redirect_delay                 => NUMBER,
                    :zoom                           => FLOAT,
                    :page_offset                    => NUMBER,
@@ -74,7 +81,8 @@ Next:
                                :bottom             => SIZE,
                                :left               => SIZE,
                                :right              => SIZE},
-                   :header => {:html => { :template => 'users/header.pdf.erb', # use :template OR :url
+                   :header => {:html => { :template => 'users/header.pdf.erb',  # use :template OR :url
+                                          :layout   => 'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
                                           :url      => 'www.example.com',
                                           :locals   => { :foo => @bar }},
                                :center             => 'TEXT',
@@ -85,6 +93,7 @@ Next:
                                :spacing            => REAL,
                                :line               => true},
                    :footer => {:html => { :template => 'shared/footer.pdf.erb', # use :template OR :url
+                                          :layout   => 'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
                                           :url      => 'www.example.com',
                                           :locals   => { :foo => @bar }},
                                :center             => 'TEXT',
@@ -146,7 +155,7 @@ If you need to display utf encoded characters, add this to your pdf views or lay
 
 ### Styles
 
-You must define absolute path's to CSS files, images, and javascripts; the best option is to use the *wicked_pdf_stylesheet_link_tag*, *wicked_pdf_image_tag*, and *wicked_pdf_javascript_include_tag* helpers.
+You must define absolute paths to CSS files, images, and javascripts; the best option is to use the *wicked_pdf_stylesheet_link_tag*, *wicked_pdf_image_tag*, and *wicked_pdf_javascript_include_tag* helpers.
 
     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ -168,7 +177,7 @@ You must define absolute path's to CSS files, images, and javascripts; the best
 
 ### Page Numbering
 
-A bit of javascript can help you number your pages, create a template or header/footer file with this:
+A bit of javascript can help you number your pages. Create a template or header/footer file with this:
 
     <html>
       <head>
@@ -202,7 +211,9 @@ 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://snikt.net/index.php/2010/03/03/generating-pdfs-from-ruby-on-rails)
+Andreas Happe's post [Generating PDFs from Ruby on Rails](http://starseeders.net/generating-pdfs-from-ruby-on-rails/)
+
+StackOverflow [questions with the tag "wicked-pdf"](http://stackoverflow.com/questions/tagged/wicked-pdf)
 
 ### Debugging
 

data/lib/pdf_helper.rb

@@ -78,7 +78,8 @@ module PdfHelper
         if options[hf] && options[hf][:html] && options[hf][:html][:template]
           @hf_tempfiles = [] if ! defined?(@hf_tempfiles)
           @hf_tempfiles.push( tf=WickedPdfTempfile.new("wicked_#{hf}_pdf.html") )
-          tf.write render_to_string(:template => options[hf][:html][:template], :layout => options[:layout], :locals => options[hf][:html][:locals])
+          options[hf][:html][:layout] ||=  options[:layout]
+          tf.write render_to_string(:template => options[hf][:html][:template], :layout => options[hf][:html][:layout], :locals => options[hf][:html][:locals])
           tf.flush
           options[hf][:html].delete(:template)
           options[hf][:html][:url] = "file://#{tf.path}"

data/lib/wicked_pdf.rb

@@ -3,8 +3,10 @@
 
 require 'logger'
 require 'digest/md5'
-require 'open3'
+require 'rbconfig'
+require Config::CONFIG['target_os'] == 'mingw32' ? 'win32/open3' : 'open3'
 require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/object/blank'
 
 require 'wicked_pdf_railtie'
 require 'wicked_pdf_tempfile'
@@ -16,15 +18,15 @@ class WickedPdf
   def initialize(wkhtmltopdf_binary_path = nil)
     @exe_path = wkhtmltopdf_binary_path
     @exe_path ||= WickedPdf.config[:exe_path] unless WickedPdf.config.empty?
-    @exe_path ||= `which wkhtmltopdf`.chomp
+    @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)
   end
 
   def pdf_from_string(string, options={})
-    command = "#{@exe_path} #{parse_options(options)} -q - - " # -q for no errors on stdout
-    p "*"*15 + command + "*"*15 unless defined?(Rails) and Rails.env != 'development'
+    command = "\"#{@exe_path}\" #{parse_options(options)} #{'-q ' unless on_windows?}- - " # -q for no errors on stdout
+    print_command(command) if in_development_mode?
     pdf, err = Open3.popen3(command) do |stdin, stdout, stderr|
       stdin.binmode
       stdout.binmode
@@ -41,6 +43,19 @@ class WickedPdf
 
   private
 
+    def in_development_mode?
+      (defined?(Rails) && Rails.env == 'development') ||
+        (RAILS_ENV && RAILS_ENV == 'development')
+    end
+
+    def on_windows?
+      Config::CONFIG['target_os'] == 'mingw32'
+    end
+
+    def print_command(cmd)
+      p "*"*15 + cmd + "*"*15
+    end
+
     def parse_options(options)
       [
         parse_header_footer(:header => options.delete(:header),
@@ -64,10 +79,14 @@ class WickedPdf
     end
 
     def make_option(name, value, type=:string)
+      if value.respond_to? :each
+        return value.collect { |v| make_option(name, v, type) }.join('')
+      end
       "--#{name.gsub('_', '-')} " + case type
         when :boolean then ""
         when :numeric then value.to_s
-        else "'#{value}'"
+        when :name_value then value.to_s
+        else "\"#{value}\""
       end + " "
     end
 
@@ -92,8 +111,9 @@ class WickedPdf
     end
 
     def parse_toc(options)
+      r = '--toc ' unless options.nil?
       unless options.blank?
-        r = make_options(options, [ :font_name, :header_text], "toc")
+        r += make_options(options, [ :font_name, :header_text], "toc")
         r +=make_options(options, [ :depth,
                                     :header_fs,
                                     :l1_font_size,
@@ -114,6 +134,7 @@ class WickedPdf
                                     :disable_links,
                                     :disable_back_links], "toc", :boolean)
       end
+      return r
     end
 
     def parse_outline(options)
@@ -140,6 +161,8 @@ class WickedPdf
                                     :dpi,
                                     :encoding,
                                     :user_style_sheet])
+        r +=make_options(options, [ :cookie,
+                                    :post], "", :name_value)
         r +=make_options(options, [ :redirect_delay,
                                     :zoom,
                                     :page_offset], "", :numeric)

data/lib/wicked_pdf_helper.rb

@@ -7,14 +7,35 @@ module WickedPdfHelper
   end
 
   def wicked_pdf_image_tag(img, options={})
-    image_tag "file://#{Rails.root.join('public', 'images', img)}", options
+    image_tag "file:///#{Rails.root.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:///#{Rails.root.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
   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>"
+      }.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
+    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
+    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
+    end
+  end
 end

data/lib/wicked_pdf_railtie.rb

@@ -2,6 +2,7 @@ require 'pdf_helper'
 require 'wicked_pdf_helper'
 
 if defined?(Rails)
+
   if Rails::VERSION::MAJOR == 2
 
     unless ActionController::Base.instance_methods.include? "render_with_wicked_pdf"
@@ -10,17 +11,24 @@ if defined?(Rails)
     unless ActionView::Base.instance_methods.include? "wicked_pdf_stylesheet_link_tag"
       ActionView::Base.send :include, WickedPdfHelper
     end
-    Mime::Type.register 'application/pdf', :pdf
-
+    
   else
 
     class WickedRailtie < Rails::Railtie
       initializer "wicked_pdf.register" do |app|
         ActionController::Base.send :include, PdfHelper
-        ActionView::Base.send :include, WickedPdfHelper
-        Mime::Type.register 'application/pdf', :pdf
+        if Rails::VERSION::MINOR > 0
+          ActionView::Base.send :include, WickedPdfHelper::Assets
+        else
+          ActionView::Base.send :include, WickedPdfHelper
+        end
       end
     end
 
   end
+  
+  if Mime::Type.lookup_by_extension(:pdf).nil?
+    Mime::Type.register('application/pdf', :pdf)
+  end
+  
 end

data/test/wicked_pdf_helper_test.rb

@@ -1,4 +1,5 @@
 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

data/test/wicked_pdf_test.rb

@@ -64,7 +64,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
 
@@ -75,7 +75,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
@@ -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-#{o.to_s.gsub('_', '-')} \"toc\"",
                     wp.get_parsed_options(:toc => {o => "toc"}).strip
     end
 
@@ -123,7 +123,14 @@ class WickedPdfTest < ActiveSupport::TestCase
     [ :orientation, :page_size, :proxy, :username, :password, :cover, :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|
+      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}" }
+      assert_equal "#{nv_formatter.call(1)} #{nv_formatter.call(2)}", wp.get_parsed_options(o => ['par1 val1', 'par2 val2']).strip
     end
 
     [:redirect_delay, :zoom, :page_offset].each do |o|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wicked_pdf
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Miles Z. Sterret
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 -04:00
+date: 2012-02-22 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: PDF generator (from HTML) plugin for Ruby on Rails