Rails template handler for PDF library Prawn
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
LICENSE
README.md
init.rb

README.md

Prawn-handler

A Rails template handler for PDF library Prawn.

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 <repo>

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.