Prawn::Rails 技术文档

本文档旨在帮助用户安装、使用及详细了解 Prawn::Rails 项目，以下为项目的技术细节。

1. 安装指南

首先，确保您的项目已经安装了 Rails 3。接下来，按照以下步骤进行安装：

1. 在您的项目 Gemfile 文件中添加以下行：

   gem 'prawn_rails'
   

2. 运行以下命令安装 gem：

   bundle install
   

安装完成后，您可以使用 Prawn::Rails 创建 PDF 视图。

2. 项目的使用说明

基本使用

Prawn::Rails 为 Prawn 库提供了一个非常薄的封装。一个 Prawn::Rails 视图应该仅包含一个调用 prawn_document 函数和一个代码块。这会创建一个 Prawn::Document 实例并将其传递给代码块。

创建一个简单的 PDF 视图，例如：

# views/.../simple.pdf.prawn
prawn_document() do |pdf|
  pdf.text "Hello World"
end

这将生成一个只包含文本 "Hello World" 的简单 PDF。

局部视图

虽然布局目前与 Prawn::Rails 不兼容，但局部视图可以正常使用。渲染局部视图的方式与普通视图类似。例如：

# views/.../partial.pdf.prawn
prawn_document do |pdf|
  render "frontpage", :pdf => pdf
  pdf.text "something else"
end

# views/.../_frontpage.pdf.prawn
pdf.text "frontpage action!!"
pdf.start_new_page

这将生成一个包含首页的 PDF。

实例变量

与普通 Rails 视图一样，控制器中赋值的实例变量在视图中可用。例如：

# home_controller.rb
class HomeController < ApplicationController
  def index
    @people=['Jane','John','Jack']
  end
end

# views/.../index.pdf.prawn
prawn_document(:page_layout => :landscape) do |pdf|
  @people.each {|person| pdf.text person}
end

这将生成一个包含 Jane、John 和 Jack 的 PDF。

渲染选项

请注意，我们向 prawn_document 传递了一个散列。散列中的任何参数都将传递给 Prawn::Document 的构造函数，但有一些例外。:renderer、:force_download 和 :filename 选项不会被传递，而是按以下描述使用。

:renderer 选项将在创建文档之前被移除，并可用于覆盖用于渲染的类，如下所示：

# views/.../override.pdf.prawn
prawn_document({:renderer => ApplicationHelper::Foo})

因此，对于上述视图，您可能有一个类似以下内容的 application_helper.rb 文件：

# application_helper.rb
module ApplicationHelper
  class Foo < Prawn::Document
    def initialize(opts={})
      super
      text "Foo"
      text "Bar"
    end
  end
end

这将生成一个包含行 Foo 和 Bar 的预设报告。

强制保存

:force_download 选项会使得浏览器显示 "另存为" 对话框，而不是尝试在浏览器中显示内容（这是通过设置 Content-Disposition 头部实现的）。 注意：如果使用了 :filename 选项，由于 Acrobat Reader 插件的兼容性问题，默认会设置为 true。

# views/.../saveas.pdf.prawn
prawn_document(:force_download=>true) do |pdf|
  pdf.text "Hello World"
end

上述代码会在带有 PDF 插件的浏览器中显示 "另存为" 对话框。

最后是 :filename 选项。这允许您覆盖默认的文件名，而不是使用动作的名称。 注意：您应该在文件名中包含 .pdf 扩展名。Prawn::Rails 不会为您添加。

# views/.../filename.pdf.prawn
prawn_document(:filename=>'Hello.pdf') do |pdf|
  pdf.text "Hello World"
end

这将使用户被提示下载名为 "Hello.pdf" 的文件。

3. 项目 API 使用文档

本项目主要使用 prawn_document 方法来创建 PDF 文档，具体使用方法请参考以下示例：

prawn_document() do |pdf|
  # 在此处添加您的 PDF 内容
end

您还可以通过传递散列来设置渲染选项，如 :page_layout、:renderer、:force_download 和 :filename。

4. 项目安装方式

项目安装方式已在 "安装指南" 部分中详细说明。请按照以下步骤安装：

1. 在 Gemfile 中添加 gem 'prawn_rails'。
2. 运行 bundle install。

以上即为 Prawn::Rails 项目的技术文档。希望对您有所帮助！