PrawnCocktailRails

Ruby on Rails integration for PrawnCocktail.

Usage

PrawnCocktailRails adds a send_pdf method to your controllers:

class InvoicesController < ApplicationController
  def show
    invoice = Invoice.find(params[:id])
    document = InvoiceDocument.new(invoice)
    send_pdf document
  end
end

The default disposition is "attachment", meaning it should be downloaded rather than opened inline in the browser.

You can change disposition to "inline" with send_pdf(document, disposition: "inline").

PrawnCocktailRails configures PrawnCocktail to look for its views in app/views/documents.

It also adds app/documents/helpers to the Rails autoload path so you can put your PrawnCocktail helpers there.

We suggest putting your documents in app/documents.

And that's it. The rest is all PrawnCocktail.

Installation

Add this line to your application's Gemfile:

gem 'prawn_cocktail_rails'

And then execute:

bundle

As this library depends on prawn_cocktail, you only need to list this one to get both.

Mime types

You may need to register the pdf mimetype in config/initializers/mime_types.rb, for older versions of rails.

Mime::Type.register "application/pdf", :pdf

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.