wicked_pdf 0.9.0 → 0.9.1

data/README.md

@@ -54,6 +54,7 @@ to config/initializers/mime_types.rb
             render :pdf                            => 'file_name',
                    :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
@@ -156,7 +157,7 @@ If you need to just create a pdf and not display it:
     WickedPdf.new.pdf_from_string(
         render_to_string(:pdf => "pdf_file.pdf", :template => 'templates/pdf.html.erb', :layout => 'pdfs/layout_pdf'), 
         :footer => {:content => render_to_string({:template => 'templates/pdf_footer.html.erb', :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"
 		
@@ -226,6 +227,22 @@ If you do not have explicit page breaks (and therefore do not have any "page" cl
 
 You can put your default configuration, applied to all pdf's at "wicked_pdf.rb" initializer.
 
+### Rack Middleware
+
+If you would like to have WickedPdf automatically generate PDF views for all (or nearly all) pages by appending .pdf to the URL, add the following to your Rails app:
+
+    # in application.rb (Rails3) or environment.rb (Rails2)
+    require 'wicked_pdf'
+    config.middleware.use WickedPdf::Middleware
+
+If you want to turn on or off the middleware for certain urls, use the `:only` or `:except` conditions like so:
+
+    # conditions can be plain strings or regular expressions, and you can supply only one or an array
+    config.middleware.use WickedPdf::Middleware, {}, :only => '/invoice'
+    config.middleware.use WickedPdf::Middleware, {}, :except => [ %r[^/admin], '/secret', %r[^/people/\d] ]
+
+If you use the standard `render :pdf => 'some_pdf'` in your app, you will want to exclude those actions from the middleware.
+
 ### Further Reading
 
 Andreas Happe's post [Generating PDFs from Ruby on Rails](http://www.snikt.net/blog/2012/04/26/wicked-pdf/)

data/lib/pdf_helper.rb

@@ -55,7 +55,7 @@ module PdfHelper
     end
 
     def make_pdf(options = {})
-      html_string = render_to_string(:template => options[:template], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers])
+      html_string = render_to_string(:template => options[:template], :file => options[:file], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers])
       options = prerender_header_and_footer(options)
       w = WickedPdf.new(options[:wkhtmltopdf])
       w.pdf_from_string(html_string, options)
@@ -67,7 +67,7 @@ module PdfHelper
       options[:template]    ||= File.join(controller_path, action_name)
       options[:disposition] ||= "inline"
       if options[:show_as_html]
-        render :template => options[:template], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers], :content_type => "text/html"
+        render :template => options[:template], :file => options[:file], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers], :content_type => "text/html"
       else
         pdf_content = make_pdf(options)
         File.open(options[:save_to_file], 'wb') {|file| file << pdf_content } if options[:save_to_file]
@@ -83,7 +83,7 @@ module PdfHelper
           @hf_tempfiles = [] if ! defined?(@hf_tempfiles)
           @hf_tempfiles.push( tf=WickedPdfTempfile.new("wicked_#{hf}_pdf.html") )
           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], :formats => options[hf][:html][:formats], :handlers => options[hf][:html][:handlers])
+          tf.write render_to_string(:template => options[hf][:html][:template], :file => options[hf][:html][:file], :layout => options[hf][:html][:layout], :locals => options[hf][:html][:locals], :formats => options[hf][:html][:formats], :handlers => options[hf][:html][:handlers])
           tf.flush
           options[hf][:html].delete(:template)
           options[hf][:html][:url] = "file:///#{tf.path}"

data/lib/wicked_pdf.rb

@@ -15,6 +15,7 @@ end
 
 require 'wicked_pdf_railtie'
 require 'wicked_pdf_tempfile'
+require 'wicked_pdf_middleware'
 
 class WickedPdf
   EXE_NAME = "wkhtmltopdf"
@@ -32,7 +33,7 @@ class WickedPdf
     string_file = WickedPdfTempfile.new("wicked_pdf.html")
     string_file.write(string)
     string_file.close
-    
+
     generated_pdf_file = WickedPdfTempfile.new("wicked_pdf_generated_file.pdf")
     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?

data/lib/wicked_pdf_helper.rb

@@ -53,7 +53,7 @@ module WickedPdfHelper
           # 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))
+          File.join(Rails.public_path, asset_path(source).sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
         end
       else
         Rails.application.assets.find_asset(source).pathname

data/lib/wicked_pdf_middleware.rb

@@ -0,0 +1,90 @@
+class WickedPdf
+  class Middleware
+
+    def initialize(app, options = {}, conditions = {})
+      @app        = app
+      @options    = options
+      @conditions = conditions
+    end
+
+    def call(env)
+      @request    = Rack::Request.new(env)
+      @render_pdf = false
+
+      set_request_to_render_as_pdf(env) if render_as_pdf?
+      status, headers, response = @app.call(env)
+
+      if rendering_pdf? && headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
+        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))
+        response = [body]
+
+        # Do not cache PDFs
+        headers.delete('ETag')
+        headers.delete('Cache-Control')
+
+        headers["Content-Length"]         = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
+        headers["Content-Type"]           = "application/pdf"
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    # Change relative paths to absolute
+    def translate_paths(body, env)
+      # Host with protocol
+      root = WickedPdf.config[:root_url] || "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}/"
+
+      body.gsub(/(href|src)=(['"])\/([^\"']*|[^"']*)['"]/, '\1=\2' + root + '\3\2')
+    end
+
+    def rendering_pdf?
+      @render_pdf
+    end
+
+    def render_as_pdf?
+      request_path_is_pdf = @request.path.match(%r{\.pdf$})
+
+      if request_path_is_pdf && @conditions[:only]
+        rules = [@conditions[:only]].flatten
+        rules.any? do |pattern|
+          if pattern.is_a?(Regexp)
+            @request.path =~ pattern
+          else
+            @request.path[0, pattern.length] == pattern
+          end
+        end
+      elsif request_path_is_pdf && @conditions[:except]
+        rules = [@conditions[:except]].flatten
+        rules.map do |pattern|
+          if pattern.is_a?(Regexp)
+            return false if @request.path =~ pattern
+          else
+            return false if @request.path[0, pattern.length] == pattern
+          end
+        end
+
+        return true
+      else
+        request_path_is_pdf
+      end
+    end
+
+    def set_request_to_render_as_pdf(env)
+      @render_pdf = true
+      path = @request.path.sub(%r{\.pdf$}, '')
+      %w[PATH_INFO REQUEST_URI].each { |e| env[e] = path }
+      env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
+      env["Rack-Middleware-WickedPdf"] = "true"
+    end
+
+    def concat(accepts, type)
+      (accepts || '').split(',').unshift(type).compact.join(',')
+    end
+
+  end
+end

metadata

@@ -1,63 +1,62 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wicked_pdf
-version: !ruby/object:Gem::Version 
-  hash: 59
+version: !ruby/object:Gem::Version
+  version: 0.9.1
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
 platform: ruby
-authors: 
+authors:
 - Miles Z. Sterret
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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
@@ -65,6 +64,7 @@ files:
 - lib/pdf_helper.rb
 - lib/wicked_pdf.rb
 - lib/wicked_pdf_helper.rb
+- lib/wicked_pdf_middleware.rb
 - lib/wicked_pdf_railtie.rb
 - lib/wicked_pdf_tempfile.rb
 - test/fixtures/document_with_long_line.html
@@ -77,36 +77,26 @@ files:
 - generators/wicked_pdf/wicked_pdf_generator.rb
 homepage: https://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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: PDF generator (from HTML) plugin for Ruby on Rails
 test_files: []
-