wicked_pdf 0.6.0 → 0.7.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 [name of plugin creator]
+Copyright (c) 2008 Miles Z. Sterret
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -12,7 +12,7 @@ First, be sure to install [wkhtmltopdf](http://code.google.com/p/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.
 
-More information about [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) could be found [here](http://madalgo.au.dk/~jakobt/wkhtmltopdf-0.9.0_beta2-doc.html).
+More information about [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) could be found [here](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf-0.9.9-doc.html).
 
 Next:
 
@@ -39,12 +39,14 @@ Next:
           format.html
           format.pdf do
             render :pdf                            => 'file_name',
-                   :template                       => 'things/show.pdf.erb',        
+                   :template                       => 'things/show.pdf.erb',
                    :layout                         => 'pdf.html',                   # use 'pdf.html' for a pfd.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
                    :page_size                      => 'A4, Letter, ...',            # default A4
+                   :save_to_file                   => Rails.root.join('pdfs', "#{filename}.pdf"),
+                   :save_only                      => false,                        # depends on :save_to_file being set first
                    :proxy                          => 'TEXT',
                    :username                       => 'TEXT',
                    :password                       => 'TEXT',
@@ -71,7 +73,9 @@ Next:
                                :bottom             => SIZE,
                                :left               => SIZE,
                                :right              => SIZE},
-                   :header => {:html => {:template => 'users/header.pdf.erb' OR :url => 'www.header.bbb'},
+                   :header => {:html => { :template => 'users/header.pdf.erb', # use :template OR :url
+                                          :url      => 'www.example.com',
+                                          :locals   => { :foo => @bar }},
                                :center             => 'TEXT',
                                :font_name          => 'NAME',
                                :font_size          => SIZE,
@@ -79,7 +83,9 @@ Next:
                                :right              => 'TEXT',
                                :spacing            => REAL,
                                :line               => true},
-                   :footer => {:html => {:template => 'public/header.pdf.erb' OR :url => 'www.header.bbb'},
+                   :footer => {:html => { :template => 'shared/footer.pdf.erb', # use :template OR :url
+                                          :url      => 'www.example.com',
+                                          :locals   => { :foo => @bar }},
                                :center             => 'TEXT',
                                :font_name          => 'NAME',
                                :font_size          => SIZE,
@@ -117,6 +123,26 @@ Next:
 
 By default, it will render without a layout (:layout => false) and the template for the current controller and action.
 
+### Super Advanced Usage ###
+
+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>')
+		
+    # 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|
+      file << pdf
+    end
+
+If you need to display utf encoded characters, add this to your pdf views or layouts:
+
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
 ### 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.
@@ -165,6 +191,10 @@ A bit of javascript can help you number your pages, create a template or header/
 
 Anything with a class listed in "var x" above will be auto-filled at render time.
 
+If you do not have explicit page breaks (and therefore do not have any "page" class), you can also use wkhtmltopdf's built in page number generation by setting one of the headers to "[page]":
+
+    render :pdf => 'filename', :header => { :right => '[page] of [topage]' }
+
 ### Configuration
 
 You can put your default configuration, applied to all pdf's at "wicked_pdf.rb" initializer.
@@ -191,4 +221,4 @@ You may have noticed: this plugin is heavily inspired by the PrinceXML plugin [p
 
 ### Awesome Peoples
 
-Also, thanks to [galdomedia](http://github.com/galdomedia) and [jcrisp](http://github.com/jcrisp) and [lleirborras](http://github.com/lleirborras), [tiennou](http://github.com/tiennou), and everyone else for all their hard work and patience with my delays in merging in their enhancements.
+Also, thanks to [unixmonkey](https://github.com/Unixmonkey), [galdomedia](http://github.com/galdomedia), [jcrisp](http://github.com/jcrisp), [lleirborras](http://github.com/lleirborras), [tiennou](http://github.com/tiennou), and everyone else for all their hard work and patience with my delays in merging in their enhancements.

data/lib/generators/wicked_pdf_generator.rb

@@ -0,0 +1,11 @@
+if defined?(Rails) && Rails::VERSION::MAJOR != 2
+
+  # Rails3 generator invoked with 'rails generate wicked_pdf'
+  class WickedPdfGenerator < Rails::Generators::Base
+    source_root(File.expand_path(File.dirname(__FILE__) + "/../../generators/wicked_pdf/templates"))
+    def copy_initializer
+      copy_file 'wicked_pdf.rb', 'config/initializers/wicked_pdf.rb'
+    end
+  end
+
+end

data/lib/pdf_helper.rb

@@ -1,35 +1,64 @@
 module PdfHelper
   require 'wicked_pdf'
+  require 'wicked_pdf_tempfile'
 
   def self.included(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 render_with_wicked_pdf(options = nil, *args, &block)
     if options.is_a?(Hash) && options.has_key?(:pdf)
-      logger.info '*'*15 + 'WICKED' + '*'*15
+      log_pdf_creation
+      options[:basic_auth] = set_basic_auth
       make_and_send_pdf(options.delete(:pdf), (WickedPdf.config || {}).merge(options))
     else
       render_without_wicked_pdf(options, *args, &block)
     end
   end
 
+  def render_to_string_with_wicked_pdf(options = nil, *args, &block)
+    if options.is_a?(Hash) && options.has_key?(:pdf)
+      log_pdf_creation
+      options[:basic_auth] = set_basic_auth
+      options.delete :pdf
+      make_pdf((WickedPdf.config || {}).merge(options))
+    else
+      render_to_string_without_wicked_pdf(options, *args, &block)
+    end
+  end
+
   private
+
+    def log_pdf_creation
+      logger.info '*'*15 + 'WICKED' + '*'*15
+    end
+
+    def set_basic_auth
+      request.env["HTTP_AUTHORIZATION"].split(" ").last if request.env["HTTP_AUTHORIZATION"]
+    end
+
+    def clean_temp_files
+      if defined?(@hf_tempfiles)
+        @hf_tempfiles.each { |tf| tf.close! }
+      end
+    end
+
     def make_pdf(options = {})
       html_string = render_to_string(:template => options[:template], :layout => options[:layout])
+      options = prerender_header_and_footer(options)
       w = WickedPdf.new(options[:wkhtmltopdf])
       w.pdf_from_string(html_string, options)
     end
 
-    def make_and_send_pdf(pdf_name, options = {})
+    def make_and_send_pdf(pdf_name, options={})
       options[:wkhtmltopdf] ||= nil
-      options[:layout] ||= false
-      options[:template] ||= File.join(controller_path, action_name)
+      options[:layout]      ||= false
+      options[:template]    ||= File.join(controller_path, action_name)
       options[:disposition] ||= "inline"
-
-      options = prerender_header_and_footer(options)
       if options[:show_as_html]
         render :template => options[:template], :layout => options[:layout], :content_type => "text/html"
       else
@@ -44,15 +73,14 @@ module PdfHelper
     def prerender_header_and_footer(options)
       [:header, :footer].each do |hf|
         if options[hf] && options[hf][:html] && options[hf][:html][:template]
-          WickedPdfTempfile.open("wicked_pdf.html") do |f|
-            f << render_to_string(:template => options[hf][:html][:template],
-                                  :layout => options[:layout])
-            options[hf][:html].delete(:template)
-            options[hf][:html][:url] = "file://#{f.path}"
-          end
+          @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])
+          tf.flush
+          options[hf][:html].delete(:template)
+          options[hf][:html][:url] = "file://#{tf.path}"
         end
       end
-
-      return options
+      options
     end
 end

data/lib/wicked_pdf.rb

@@ -7,6 +7,7 @@ require 'open3'
 require 'active_support/core_ext/class/attribute_accessors'
 
 require 'wicked_pdf_railtie'
+require 'wicked_pdf_tempfile'
 
 class WickedPdf
   @@config = {}
@@ -26,6 +27,9 @@ class WickedPdf
     p "*"*15 + command_for_stdin_stdout + "*"*15 unless defined?(Rails) and Rails.env != 'development'
     pdf, err = begin
       Open3.popen3(command_for_stdin_stdout) do |stdin, stdout, stderr|
+        stdin.binmode
+        stdout.binmode
+        stderr.binmode
         stdin.write(string)
         stdin.close
         [stdout.read, stderr.read]
@@ -38,108 +42,122 @@ class WickedPdf
   end
 
   private
-  def parse_options(options)
-    [
-      parse_header_footer(:header => options.delete(:header),
-                          :footer => options.delete(:footer),
-                          :layout => options[:layout]),
-      parse_toc(options.delete(:toc)),
-      parse_outline(options.delete(:outline)),
-      parse_margins(options.delete(:margin)),
-      parse_others(options),
-    ].join(' ')
-  end
 
-  def make_option(name, value, type=:string)
-    "--#{name.gsub('_', '-')} " + case type
-      when :boolean then ""
-      when :numeric then value.to_s
-      else "'#{value}'"
-    end + " "
-  end
+    def parse_options(options)
+      [
+        parse_header_footer(:header => options.delete(:header),
+                            :footer => options.delete(:footer),
+                            :layout => options[:layout]),
+        parse_toc(options.delete(:toc)),
+        parse_outline(options.delete(:outline)),
+        parse_margins(options.delete(:margin)),
+        parse_others(options),
+        parse_basic_auth(options)
+      ].join(' ')
+    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
-  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=""
-    [:header, :footer].collect do |hf|
-      unless options[hf].blank?
-        opt_hf = options[hf]
-        r += make_options(opt_hf, [:center, :font_name, :left, :right], "#{hf.to_s}")
-        r += make_options(opt_hf, [:font_size, :spacing], "#{hf.to_s}", :numeric)
-        r += make_options(opt_hf, [:line], "#{hf.to_s}", :boolean)
-        unless opt_hf[:html].blank?
-          r += make_option("#{hf.to_s}-html", opt_hf[:html][:url]) unless opt_hf[:html][:url].blank?
+    def make_option(name, value, type=:string)
+      "--#{name.gsub('_', '-')} " + case type
+        when :boolean then ""
+        when :numeric 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
+    end
+
+    def parse_header_footer(options)
+      r=""
+      [:header, :footer].collect do |hf|
+        unless options[hf].blank?
+          opt_hf = options[hf]
+          r += make_options(opt_hf, [:center, :font_name, :left, :right], "#{hf.to_s}")
+          r += make_options(opt_hf, [:font_size, :spacing], "#{hf.to_s}", :numeric)
+          r += make_options(opt_hf, [:line], "#{hf.to_s}", :boolean)
+          unless opt_hf[:html].blank?
+            r += make_option("#{hf.to_s}-html", opt_hf[:html][:url]) unless opt_hf[:html][:url].blank?
+          end
         end
-      end
-    end unless options.blank?
-    r
-  end
+      end unless options.blank?
+      r
+    end
 
-  def parse_toc(options)
-    unless options.blank?
-      r = make_options(options, [ :font_name, :header_text], "toc")
-      r +=make_options(options, [ :depth,
-                                  :header_fs,
-                                  :l1_font_size,
-                                  :l2_font_size,
-                                  :l3_font_size,
-                                  :l4_font_size,
-                                  :l5_font_size,
-                                  :l6_font_size,
-                                  :l7_font_size,
-                                  :l1_indentation,
-                                  :l2_indentation,
-                                  :l3_indentation,
-                                  :l4_indentation,
-                                  :l5_indentation,
-                                  :l6_indentation,
-                                  :l7_indentation], "toc", :numeric)
-      r +=make_options(options, [ :no_dots,
-                                  :disable_links,
-                                  :disable_back_links], "toc", :boolean)
+    def parse_toc(options)
+      unless options.blank?
+        r = make_options(options, [ :font_name, :header_text], "toc")
+        r +=make_options(options, [ :depth,
+                                    :header_fs,
+                                    :l1_font_size,
+                                    :l2_font_size,
+                                    :l3_font_size,
+                                    :l4_font_size,
+                                    :l5_font_size,
+                                    :l6_font_size,
+                                    :l7_font_size,
+                                    :l1_indentation,
+                                    :l2_indentation,
+                                    :l3_indentation,
+                                    :l4_indentation,
+                                    :l5_indentation,
+                                    :l6_indentation,
+                                    :l7_indentation], "toc", :numeric)
+        r +=make_options(options, [ :no_dots,
+                                    :disable_links,
+                                    :disable_back_links], "toc", :boolean)
+      end
     end
-  end
 
-  def parse_outline(options)
-    unless options.blank?
-      r = make_options(options, [:outline], "", :boolean)
-      r +=make_options(options, [:outline_depth], "", :numeric)
+    def parse_outline(options)
+      unless options.blank?
+        r = make_options(options, [:outline], "", :boolean)
+        r +=make_options(options, [:outline_depth], "", :numeric)
+      end
     end
-  end
 
-  def parse_margins(options)
-    make_options(options, [:top, :bottom, :left, :right], "margin", :numeric) unless options.blank?
-  end
+    def parse_margins(options)
+      make_options(options, [:top, :bottom, :left, :right], "margin", :numeric) unless options.blank?
+    end
 
-  def parse_others(options)
-    unless options.blank?
-      r = make_options(options, [ :orientation,
-                                  :page_size,
-                                  :proxy,
-                                  :username,
-                                  :password,
-                                  :cover,
-                                  :dpi,
-                                  :encoding,
-                                  :user_style_sheet])
-      r +=make_options(options, [ :redirect_delay,
-                                  :zoom,
-                                  :page_offset], "", :numeric)
-      r +=make_options(options, [ :book,
-                                  :default_header,
-                                  :disable_javascript,
-                                  :greyscale,
-                                  :lowquality,
-                                  :enable_plugins,
-                                  :disable_internal_links,
-                                  :disable_external_links,
-                                  :print_media_type,
-                                  :disable_smart_shrinking,
-                                  :use_xserver,
-                                  :no_background], "", :boolean)
+    def parse_others(options)
+      unless options.blank?
+        r = make_options(options, [ :orientation,
+                                    :page_size,
+                                    :page_width,
+                                    :page_height,
+                                    :proxy,
+                                    :username,
+                                    :password,
+                                    :cover,
+                                    :dpi,
+                                    :encoding,
+                                    :user_style_sheet])
+        r +=make_options(options, [ :redirect_delay,
+                                    :zoom,
+                                    :page_offset], "", :numeric)
+        r +=make_options(options, [ :book,
+                                    :default_header,
+                                    :disable_javascript,
+                                    :greyscale,
+                                    :lowquality,
+                                    :enable_plugins,
+                                    :disable_internal_links,
+                                    :disable_external_links,
+                                    :print_media_type,
+                                    :disable_smart_shrinking,
+                                    :use_xserver,
+                                    :no_background], "", :boolean)
+      end
     end
-  end
+
 end

data/lib/wicked_pdf_helper.rb

@@ -1,6 +1,9 @@
 module WickedPdfHelper
-  def wicked_pdf_stylesheet_link_tag(style)
-    stylesheet_link_tag style, "file://#{Rails.root.join('public','stylesheets',style)}"
+  def wicked_pdf_stylesheet_link_tag(*sources)
+    css_dir = Rails.root.join('public','stylesheets')
+    sources.collect { |source|
+      "<style type='text/css'>#{File.read(css_dir.join(source+'.css'))}</style>"
+    }.join("\n").html_safe
   end
 
   def wicked_pdf_image_tag(img, options={})

data/lib/wicked_pdf_railtie.rb

@@ -3,25 +3,24 @@ require 'wicked_pdf_helper'
 
 if defined?(Rails)
   if Rails::VERSION::MAJOR == 2
+
     unless ActionController::Base.instance_methods.include? "render_with_wicked_pdf"
       ActionController::Base.send :include, PdfHelper
     end
-  
     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
       end
     end
+
   end
-end
+end

data/lib/wicked_pdf_tempfile.rb

@@ -4,7 +4,7 @@ class WickedPdfTempfile < Tempfile
   # Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
   def make_tmpname(basename, n)
     extension = File.extname(basename)
-    sprintf("%s_%d_%d%s", File.basename(basename, extension), $$, n, extension)
+    sprintf("%s_%d_%d%s", File.basename(basename, extension), $$, n.to_i, extension)
   end
 end
- 
+

data/test/fixtures/wicked.css

@@ -0,0 +1 @@
+/* Wicked styles */

data/test/pdf_helper_test.rb

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

data/test/wicked_pdf_helper_test.rb

@@ -1,9 +1,9 @@
 require 'test_helper'
 
 class WickedPdfHelperTest < ActionView::TestCase
-  test 'wicked_pdf_stylesheet_link_tag should return the same as stylesheet_link_tag when passed a full path' do
-    assert_equal stylesheet_link_tag('pdf', "file://#{Rails.root.join('public','stylesheets','pdf')}"),
-                 wicked_pdf_stylesheet_link_tag('pdf')
+  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

metadata

@@ -1,39 +1,47 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: wicked_pdf
-version: !ruby/object:Gem::Version
-  version: 0.6.0
+version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
-authors:
+authors: 
 - Miles Z. Sterret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-25 00:00:00.000000000 +01:00
+
+date: 2011-05-10 00:00:00 -04:00
 default_executable: 
 dependencies: []
-description: ! 'Wicked PDF uses the shell utility wkhtmltopdf to serve a PDF file
-  to a user from HTML.
 
+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,
+  you simply write an HTML view as you would normally, and let Wicked take care of the hard stuff.
 
-  you simply write an HTML view as you would normally, and let Wicked take care of
-  the hard stuff.
-
-'
 email: miles.sterrett@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - README.md
 - Rakefile
 - MIT-LICENSE
+- lib/generators/wicked_pdf_generator.rb
 - lib/pdf_helper.rb
 - lib/wicked_pdf.rb
 - lib/wicked_pdf_helper.rb
 - lib/wicked_pdf_railtie.rb
 - lib/wicked_pdf_tempfile.rb
+- test/fixtures/wicked.css
 - test/pdf_helper_test.rb
 - test/test_helper.rb
 - test/wicked_pdf_helper_test.rb
@@ -41,26 +49,36 @@ files:
 has_rdoc: true
 homepage: http://github.com/mileszs/wicked_pdf
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: PDF generator (from HTML) plugin for Ruby on Rails
 test_files: []
+