ferrum_pdf：生成 PDFs 和屏幕截图的 Ruby 工具

ferrum_pdf：生成 PDFs 和屏幕截图的 Ruby 工具

ferrum_pdf A PDF generator for Rails using Ferrum & headless Chrome 项目地址: https://gitcode.com/gh_mirrors/fe/ferrum_pdf

在现代 web 应用开发中，生成高质量的 PDF 文档和屏幕截图变得尤为重要。ferrum_pdf 是一个利用 Ferrum 和 headless Chrome 的 Ruby 库，可以轻松地在 Rails 应用中实现这些功能。

项目介绍

ferrum_pdf 是一个开源项目，旨在为 Rails 开发者提供一种简便的方式来生成 PDF 文件和屏幕截图。它基于 Ferrum 库，后者是一个无头浏览器环境，允许开发者通过 Chrome DevTools 协议控制 Chrome。ferrum_pdf 的核心功能是通过 headless Chrome 渲染 HTML 内容，生成 PDF 文档或屏幕截图。

项目技术分析

ferrum_pdf 的核心是 Ferrum 库，它封装了 Chrome DevTools 协议，允许开发者通过代码控制浏览器的行为。在生成 PDF 和屏幕截图时，ferrum_pdf 提供了多种配置选项，如页面大小、边距、背景颜色等，以满足不同场景的需求。

该项目的技术优势包括：

• 易用性：通过简单的 API 调用即可生成 PDF 和屏幕截图。
• 灵活性：提供了丰富的配置选项，允许开发者自定义输出结果。
• 兼容性：支持 HTML 内容和 URL，使得不同来源的内容都可以轻松转换。

项目技术应用场景

ferrum_pdf 的应用场景广泛，以下是一些典型的使用案例：

1. 电子商务：生成订单确认书、发票和其他商务文档。
2. 在线教育：将课程内容导出为 PDF，方便学生下载和打印。
3. 内容管理系统：允许用户将文章、博客等内容导出为 PDF。
4. 企业报表：生成销售报告、财务报表等企业内部文档。

项目特点

ferrum_pdf 具有以下显著特点：

• 无头浏览器支持：利用 headless Chrome，提供更加灵活和强大的渲染能力。
• 多种输出格式：支持 PDF 和屏幕截图，满足不同用户需求。
• 丰富的配置选项：提供多种配置参数，如页面大小、边距、背景颜色等，确保输出结果的准确性。
• 易于集成：可以作为 Rails 项目的依赖添加，无缝集成到现有的应用中。

以下是 ferror_pdf 的具体使用方法：

PDF 生成

在 Rails 控制器中使用 render_pdf 辅助方法可以轻松生成 PDF：

def show
  respond_to do |format|
    format.html
    format.pdf {
      pdf = render_pdf()
      send_data pdf, disposition: :inline, filename: "example.pdf"
    }
  end
end

此外，还可以自定义模板和布局：

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

屏幕截图生成

同样，在 Rails 控制器中使用 render_screenshot 辅助方法可以生成屏幕截图：

def show
  respond_to do |format|
    format.html
    format.png {
      screenshot = render_screenshot()
      send_data screenshot, disposition: :inline, filename: "example.png"
    }
  end
end

自定义屏幕截图的选项包括格式、质量和是否全页等：

render_screenshot(
  screenshot_options: {
    format: "png", # 或 "jpeg"
    quality: nil, # 对于 jpeg 有效
    full: true, # 是否需要全页截图
    selector: nil, # CSS 选择器，可选
    area: nil, # 截图区域，可选
    scale: nil, # 缩放比例
    background_color: nil # 背景颜色
  }
)

通过以上介绍，可以看出 ferrum_pdf 是一个功能强大且易于使用的工具，可以帮助开发者快速实现 PDF 和屏幕截图的生成。无论是电子商务、在线教育还是企业应用，ferrum_pdf 都能提供高效的支持。如果您在寻找一个可靠的 PDF 和屏幕截图生成解决方案，ferrum_pdf 将是一个不错的选择。

ferrum_pdf A PDF generator for Rails using Ferrum & headless Chrome 项目地址: https://gitcode.com/gh_mirrors/fe/ferrum_pdf