to_xls 插件技术文档

本文档将为您详细介绍如何安装、使用以及调用 to_xls 插件，帮助您轻松地将 ActiveRecord 集合（数组）导出为 Excel 文件。

1. 安装指南

要安装 to_xls 插件，您需要执行以下命令：

./script/plugin install git://github.com/arydjmal/to_xls.git

2. 项目使用说明

to_xls 插件的使用非常简单。以下是一些基本用法示例：

@users = User.all

# 导出所有字段和默认标题
@users.to_xls

# 仅导出指定字段
@users.to_xls(:only => [:last_name, :role])

# 不导出标题
@users.to_xls(:headers => false)

# 排除指定字段
@users.to_xls(:except => [:last_name, :role])

# 调用对象方法
@users.to_xls(:methods => :admin?)

3. 项目API使用文档

以下是 to_xls 方法的一些可用选项：

• :only：导出指定的字段列表。
• :except：排除指定的字段列表。
• :headers：是否导出标题行，默认为 true。
• :methods：调用对象的指定方法。

4. 项目安装方式

to_xls 插件的安装方式已在“安装指南”部分详细介绍。请参考上文执行相应的安装命令。

在您的 Rails 项目中，确保在 config/initializers/mime_types.rb 文件中注册自定义的 MIME 类型：

Mime::Type.register "application/vnd.ms-excel", :xls

然后，在需要导出 Excel 文件的控制器中，添加 format.xls 行：

class UserController < ApplicationController

  def index
    @users = User.all

    respond_to do |format|
      format.html
      format.xml { render :xml => @users }
      format.xls { send_data @users.to_xls }
    end
  end

  def show...
  def new...
  def edit...
  def create...
  def update...
  def destroy...

end

请注意，to_xls 插件无法在单个 ActiveRecord 对象上使用，例如 User.first.to_xls 将会报错。

版权所有（c）2009 Ary Djmal，遵循 MIT 许可发布。