Ferrum Pdf 项目使用教程

1. 项目目录结构及介绍

Ferrum Pdf 是一个为 Rails 应用程序生成 PDF 和屏幕截图的库，使用 Ferrum 和无头 Chrome。以下是项目的目录结构及各部分的作用：

• bin/：包含可执行脚本。
• lib/：包含项目的核心代码。
• test/：包含项目的测试代码。
• .gitignore：指定 Git 忽略的文件和目录。
• .rubocop.yml：配置 RuboCop 代码风格检查工具。
• CHANGELOG.md：记录项目的历史变更。
• FLY_HOSTING_GUIDE.md：提供有关在 Fly 应用服务器上托管项目的指南。
• Gemfile：定义项目依赖的 Ruby 库。
• Gemfile.lock：记录项目依赖的具体版本。
• MIT-LICENSE：项目使用的 MIT 许可证文件。
• README.md：项目的自述文件，包含项目的描述、安装和使用说明。
• Rakefile：定义项目的 Rake 任务。
• ferrum_pdf.gemspec：定义 Ruby 包的元数据和打包指令。

2. 项目的启动文件介绍

在 Rails 项目中使用 Ferrum Pdf 前，需要将其添加到项目的 Gemfile 中：

gem 'ferrum_pdf'

然后执行 bundle install 命令安装依赖。

Ferrum Pdf 提供了两个主要的辅助方法来在 Rails 控制器中生成 PDF 和屏幕截图：

• render_pdf：用于生成 PDF 文档。
• render_screenshot：用于生成屏幕截图。

3. 项目的配置文件介绍

Ferrum Pdf 的配置主要通过传递参数给 render_pdf 和 render_screenshot 方法来实现。以下是一些常用的配置选项：

• html：要渲染的 HTML 内容。
• url：要渲染的网页地址。
• host：用于设置相对路径的主机地址。
• protocol：用于处理相对协议路径的协议。
• pdf_options：包括页面大小、方向、边距等 PDF 相关的选项。
• screenshot_options：包括截图格式、质量、是否全页、选择器等截图相关的选项。

例如，以下是一个生成 PDF 的配置示例：

pdf = FerrumPdf.render_pdf(
  html: content,
  pdf_options: {
    landscape: false,
    scale: 1,
    format: nil,
    paper_width: 8.5,
    paper_height: 11,
    margin_top: 0.4,
    margin_bottom: 0.4,
    margin_left: 0.4,
    margin_right: 0.4,
    display_header_footer: true,
    print_background: false,
    header_template: FerrumPdf::DEFAULT_HEADER_TEMPLATE,
    footer_template: FerrumPdf::DEFAULT_FOOTER_TEMPLATE
  }
)

使用这些配置选项，你可以根据具体需求定制生成的 PDF 和屏幕截图。