receipts Ruby gem

The details and line_items arrays support inline formatting using Prawn-compatible HTML-like tags:

• <b> (bold)
• <i> (italic)
• <u> (underline)
• <strikethrough>
• <sub> (subscript)
• <sup> (superscript)
• <font>
• <color>
• <link>

To serve a PDF in a Rails controller, use the .render method to get the raw PDF string and pass it to send_data. Set the type to application/pdf and choose a disposition (:inline to view in browser, :attachment to download).

class ChargesController < ApplicationController
  # ... setup code ...

  def show
    respond_to do |format| 
      format.pdf { send_pdf }
    end
  end

  private

  def send_pdf
    # @charge.receipt returns a Receipts::Receipt instance
    send_data @charge.receipt.render,
      filename: "#{@charge.created_at.strftime('%Y-%m-%d')}-receipt.pdf",
      type: "application/pdf",
      disposition: :inline
  end
end

Add gem 'receipts' to your Gemfile and run bundle, or install it directly via gem install receipts.

gem 'receipts'

$ bundle

The Receipts module serves as the primary entrypoint for the gem. It provides access to the following core document types via autoloading:

• Receipts::Receipt: For generating individual receipts.
• Receipts::Invoice: For generating invoices.
• Receipts::Statement: For generating account statements.
• Receipts::Base: The base class for document generation logic.

Set a global default font for all generated PDFs by defining Receipts.default_font in an initializer. The hash requires :bold and :normal keys pointing to valid font file paths.

Receipts.default_font = {
  bold: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic-Bold.ttf'),
  normal: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic.ttf'),
}

The header and render_billing_details methods use the company hash to populate the document.

Logo Handling If company[:logo] is provided, it is rendered at the top right. The load_image method supports:

• A URL (string starting with http).
• A local file path.
• An existing image object.

Billing Details render_billing_details displays company information and recipient information in a table. By default, it displays the company's :address, :phone, and :email. You can control which fields are shown by providing a :display array in the company hash.

Example Company Hash:

company = {
  name: "Acme Corp",
  logo: "https://example.com/logo.png",
  email: "contact@acme.com",
  address: "123 Main St",
  phone: "555-0123",
  display: [:address, :email] # Only show address and email
}

You can bypass the standard template by instantiating a Receipt object without options: Receipts::Receipt.new. Since every Receipts object inherits from Prawn::Document, you can use standard Prawn methods like .text or use Receipts-specific helpers at the current cursor position:

• render_line_items(line_items: [...])
• render_footer(text)

receipt = Receipts::Receipt.new # creates an empty PDF

receipt.text("hello world")

# Using helpers
receipt.text("Custom header")
receipt.render_line_items(line_items: [["my line items"]])
receipt.render_footer("This is a custom footer using the Receipts helper")

You can set a global default font configuration for all receipt, invoice, and statement generation. The configuration expects a hash containing paths to your font files for bold and normal styles. This is useful when using custom TTF or OTF fonts via the underlying Prawn engine.

Receipts.default_font = {
  bold: "path/to/bold-font.ttf",
  normal: "path/to/normal-font.ttf"
}

To fix layout issues where Prawn's width guessing fails, you can explicitly set column widths for the line_items table using the column_widths option. This follows Prawn's table configuration.

• Use a Hash for specific columns: {1 => 400, 3 => 50} (sets column 1 to 400 and column 3 to 50).
• Use an Array for all columns: [100, 200, 240].

# Example using a Hash for specific columns
column_widths: {1 => 400, 3 => 50}

# Example using an Array for all columns
column_widths: [100, 200, 240]