Ferrum Pdf 使用教程

Ferrum Pdf 使用教程

1. 项目介绍

Ferrum Pdf 是一个为 Rails 应用程序生成 PDF 文档的 gem。它使用 Ferrum 和无头 Chrome 来渲染 PDF，可以很容易地从 HTML 或 URL 创建高质量的 PDF 文件。这个项目适用于需要在 Rails 应用中生成报告、发票或其他 PDF 文档的场景。

2. 项目快速启动

首先，确保你的系统中已经安装了 Chrome 浏览器。

接着，在 Rails 项目中添加 Ferrum Pdf 作为依赖：

# Gemfile
gem 'ferrum_pdf'

然后执行 bundle 命令来安装 gem：

bundle install

在 Rails 控制器中，你可以使用 render_pdf 方法来渲染 PDF：

# app/controllers/example_controller.rb
class ExampleController < ApplicationController
  def show
    respond_to do |format|
      format.html
      format.pdf do
        pdf = render_pdf
        send_data pdf, disposition: 'inline', filename: 'example.pdf'
      end
    end
  end
end

你也可以自定义 PDF 的渲染选项，例如添加页眉和页脚：

pdf = render_pdf(
  layout: 'pdf',
  pdf_options: {
    display_header_footer: true,
    header_template: FerrumPdf::DEFAULT_HEADER_TEMPLATE,
    footer_template: FerrumPdf::DEFAULT_FOOTER_TEMPLATE
  }
)

3. 应用案例和最佳实践

生成带有页眉和页脚的 PDF

pdf = FerrumPdf.render_pdf(
  html: render_to_string('example.html.erb'),
  pdf_options: {
    display_header_footer: true,
    header_template: '<div>Header</div>',
    footer_template: '<div>Footer</div>'
  }
)

从 URL 生成 PDF

pdf = FerrumPdf.render_pdf(url: 'https://example.com')

使用基本认证从 URL 生成 PDF

pdf = FerrumPdf.render_pdf(
  url: 'https://example.com',
  authorize: { user: 'username', password: 'password' }
)

4. 典型生态项目

目前没有列出具体的相关生态项目，但是 Ferrum Pdf 可以与任何需要生成 PDF 的 Rails 应用程序配合使用。开发者可以根据具体需求，结合其他 gem 或工具来实现更多复杂的功能。