Seed Fu 项目技术文档

1. 安装指南

1.1 使用 Gemfile 安装

对于 Rails 3.1 及以上版本，只需在 Gemfile 中添加以下内容：

gem 'seed-fu', '~> 2.3'

然后运行 bundle install 进行安装。

1.2 其他版本支持

• Rails 3.0：请使用 gem 'seed-fu', '~> 2.0.0'。
• Rails 2.3：请使用 gem 'seed-fu', '~> 1.2.0'。

1.3 独立使用

Seed Fu 依赖于 Active Record，但不需要与完整的 Rails 应用一起使用。只需加载并 require seed-fu gem 即可。

2. 项目的使用说明

2.1 基本示例

在 db/fixtures/users.rb 中定义种子数据：

User.seed do |s|
  s.id    = 1
  s.login = "jon"
  s.email = "[e-mail]"
  s.name  = "Jon"
end

User.seed do |s|
  s.id    = 2
  s.login = "emily"
  s.email = "[e-mail]"
  s.name  = "Emily"
end

然后通过以下命令加载数据：

$ rake db:seed_fu

2.2 约束条件

使用约束条件来标识种子数据，以便在必要时进行更新。例如：

Point.seed(:x, :y) do |s|
  s.x = 4
  s.y = 7
  s.name = "Home"
end

如果名称发生变化，Seed Fu 会根据 :x 和 :y 约束找到现有记录并更新其属性。

2.3 种子文件位置

默认情况下，种子文件位于以下位置：

• Rails 应用中：#{Rails.root}/db/fixtures 和 #{Rails.root}/db/fixtures/#{Rails.env}
• 非 Rails 应用中：./db/fixtures

可以通过修改 SeedFu.fixture_paths 数组来更改默认路径。

2.4 简洁语法

当需要加载大量记录时，可以使用简洁语法：

User.seed(:id,
  { :id => 1, :login => "jon",   :email => "[e-mail]",   :name => "Jon"   },
  { :id => 2, :login => "emily", :email => "[e-mail]", :name => "Emily" }
)

3. 项目API使用文档

3.1 基本API

• User.seed：用于插入或更新种子数据。
• User.seed_once：仅插入种子数据，不进行更新。

3.2 高级API

• SeedFu.fixture_paths：用于设置种子文件的默认路径。
• SeedFu.quiet = true：禁用 Seed Fu 的输出。

4. 项目安装方式

4.1 通过 Rake 任务加载种子数据

使用以下命令加载种子数据：

$ rake db:seed_fu

可以通过以下选项指定种子文件路径和过滤器：

• FIXTURE_PATH=path/to/fixtures：指定种子文件路径。
• FILTER=users,articles：仅加载匹配的种子文件。

4.2 在代码中加载种子数据

可以通过以下代码在应用中加载种子数据：

SeedFu.seed(fixture_paths, filter)

4.3 处理大种子文件

• 压缩种子文件：使用 gzip 压缩种子文件，Seed Fu 可以读取 .rb.gz 文件。
• 分段加载：在种子文件中添加 # BREAK EVAL 行，避免将整个文件加载到内存中。
• 过滤加载：使用 FILTER 环境变量加载单个种子文件。

4.4 生成种子文件

可以使用 SeedFu::Writer 生成种子文件，例如将 CSV 文件转换为种子文件。

4.5 Capistrano 部署

Seed Fu 提供了 Capistrano 部署脚本，只需在 config/deploy.rb 中添加以下内容：

require 'seed-fu/capistrano'

# 在 update_code 后触发任务
after 'deploy:update_code', 'db:seed_fu'

对于 Capistrano 3，请使用以下配置：

require 'seed-fu/capistrano3'

# 在 publishing 前触发任务
before 'deploy:publishing', 'db:seed_fu'

5. 总结

Seed Fu 是一个功能强大的工具，用于在数据库中插入和维护种子数据。通过本技术文档，您可以了解如何安装、使用和配置 Seed Fu，以便更好地管理您的种子数据。