prawn_rails 0.0.3 → 0.0.4

data/README.rdoc

@@ -1,8 +1,8 @@
-= Prawn Rails
+= Prawn::Rails
 
-Prawn Rails provides a simple way of creating PDF views in Rails 3 using the prawn library.
+Prawn::Rails provides a simple way of creating PDF views in Rails 3 using the prawn library.
 
-To use Prawn Rails simply add the line
+To use Prawn::Rails simply add the line
 
     gem 'prawn_rails'
 
@@ -18,7 +18,7 @@ which will be used whenever the user requests a page with a 'pdf' extension
 
 == Usage
 
-prawn_rails is designed to provide only a very thin wrapper around Prawn itself.  A prawn_rails view should consist of only a call to the function prawn_document and a block.  This will create an instance of Prawn::Document and yield it to the block.
+Prawn::Rails is designed to provide only a very thin wrapper around Prawn itself.  A Prawn::Rails view should consist of only a call to the function prawn_document and a block.  This will create an instance of Prawn::Document and yield it to the block.
 For a simple pdf view try:
 
 views/.../simple.pdf.prawn
@@ -47,7 +47,9 @@ views/.../index.pdf.prawn
 
 This will produce a pdf with Jane, John, and Jack all written on seperate lines.
 
-Notice we passed a hash into prawn_document.  Any parameters placed in this hash will be passed to the constructor of Prawn::Document, with one exception.  The renderer option will be removed before creating the document and can be used to override the class to be used for rendering with a subclass of Prawn::Document like so:
+Notice we passed a hash into prawn_document.  Any parameters placed in this hash will be passed to the constructor of Prawn::Document, with a few exceptions. The :renderer, :force_download, and :filename options will not be passed on, but instead will be used as described below.
+
+The :renderer option will be removed before creating the document and can be used to override the class to be used for rendering with a subclass of Prawn::Document like so:
 
 views/.../override.pdf.prawn
 
@@ -69,13 +71,35 @@ application_helper.rb
 
 This would generate a canned report with just the lines Foo and Bar.
 
+The :force_download option does makes the browser display a 'save as' dialog rather than attempting to display the content in browser (this is achieved by setting the Content-Dispoition header).
+Note: due to problems with the Acrobat Reader plugin, this defaults to true if the :filename option is used.
+
+views/.../saveas.pdf.prawn
+
+  prawn_document(:force_download=>true) do |pdf|
+    pdf.text "Hello World"
+  end
+
+The above will cause a 'save as' dialog to appear, even in browsers with a PDF plugin.
+
+Finally is the :filename option.  This allows you to override the default filename to something other than the name of the action.
+Note: You should include the .pdf extension in the filename.  Prawn::Rails will not do this for you.
+
+views/.../filename.pdf.prawn
+
+  prawn_document(:filename=>'Hello.pdf') do |pdf|
+    pdf.text "Hello World"
+  end
+
+This will result in the user being promted to download a file named 'Hello.pdf'.
+
 == Gotchas
 
 The one major gotcha at this point is that layouts do not work.  Do not attempt to make an app/views/layouts/application.pdf.prawn.  All your pdf views will quit.  This is something I hope to fix in a later release.  In the meantime I recommend using custom classes like the one above to achieve a similair effect.
 
 == Examples
 
-For examples see: http://github.com/Volundr/prawn_rails_demo
+For examples see: http://prawn-rails-demo.heroku.com
 
 
 Copyright (c) 2010 Walton Hoops, released under the MIT license

data/Rakefile

@@ -13,7 +13,7 @@ PKG_FILES = FileList[
 
 spec = Gem::Specification.new do |s|
   s.name = "prawn_rails"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
   s.author = "Walton Hoops"
   s.email = "me@waltonhoops.com"
   s.homepage = "http://github.com/Volundr/prawn-rails"

data/lib/prawn_rails.rb

@@ -8,12 +8,23 @@ module Prawn
     module PrawnHelper
       
       def prawn_document(opts={})
+        download = opts.delete(:force_download)
+        filename = opts.delete(:filename)
         pdf = (opts.delete(:renderer) || Prawn::Document).new(opts)
         yield pdf if block_given?
         
+        disposition(download, filename) if (download || filename)
+        
         pdf
       end
       
+      def disposition(download, filename)
+        download = true if (filename && download == nil)
+        disposition = download ? "attachment;" : "inline;"
+        disposition += " filename=#{filename}" if filename
+        headers["Content-Disposition"]=disposition
+      end
+      
     end
     
     class TemplateHandler < ActionView::Template::Handler

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: prawn_rails
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Walton Hoops
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-23 00:00:00 -06:00
+date: 2010-11-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency