public
Description: Rails template handler for PDF library Prawn
Homepage: http://roman.flucti.com/alternative-prawn-handler-for-rails
Clone URL: git://github.com/Roman2K/prawn-handler.git
name age message
file LICENSE Fri Jan 30 06:25:32 -0800 2009 added license [Roman2K]
file README.mdown Sun Mar 15 13:19:35 -0700 2009 fixed a typo in the README [Roman2K]
file init.rb Fri Jan 30 08:15:42 -0800 2009 register the handler from init.rb as it makes m... [Roman2K]
directory lib/ Fri Jan 30 08:15:42 -0800 2009 register the handler from init.rb as it makes m... [Roman2K]
directory test/ Fri Jan 30 08:23:10 -0800 2009 added test for compatibility with ActionView [Roman2K]
README.mdown

Prawn-handler

A Rails template handler for PDF library Prawn. You can find a more detailed description in its introduction article.

There already exists prawnto but it's too bloated for my taste. Prawn-handler is lightweight, simple, and less of a hassle to use.

Installation

script/plugin install git://github.com/Roman2K/prawn-handler.git

Usage

  1. Declare the PDF MIME type in an initializer or environment.rb:

    Mime::Type.register "application/pdf", :pdf
    
  2. Name PDF view files like foo.pdf.prawn. Inside, use the pdf method to access a Prawn::Document object. In addition, this handler allows for lazy method calls: you don't have to specify the receiver explicitely, which cleans up the resulting view code.

    For example, the following code with formal calls:

    pdf.bounding_box [100, 600], :width => 200 do
      pdf.text "The rain in spain falls mainly on the plains " * 5
      pdf.stroke do
        pdf.line pdf.bounds.top_left,    pdf.bounds.top_right
        pdf.line pdf.bounds.bottom_left, pdf.bounds.bottom_right
      end
    end
    

    Is equivalent to this one with lazy calls:

    bounding_box [100, 600], :width => 200 do
      text "The rain in spain falls mainly on the plains " * 5
      stroke do
        line bounds.top_left,    bounds.top_right
        line bounds.bottom_left, bounds.bottom_right
      end
    end
    
    This is accomplished without instance_eval, so that access to instance variables set by the controller is retained.

Credits

Written by Roman Le Négrate (contact). Released under the MIT-license: see the LICENSE file.