Nested Form 项目技术文档

1. 安装指南

1.1 添加 Gem

首先，将 nested_form 添加到你的 Gemfile 中：

gem "nested_form"

然后运行 bundle 命令来安装这个 Gem。

1.2 添加到 Asset Pipeline

如果你使用的是 Rails 3.1 或更高版本，并且启用了 Asset Pipeline，你需要在 application.js 文件中添加以下内容：

//= require jquery_nested_form

1.3 非 Asset Pipeline 设置

如果你没有使用 Asset Pipeline，可以通过运行以下生成器来创建 JavaScript 文件：

rails g nested_form:install

然后在你的布局文件中包含生成的 JavaScript 文件：

<%= javascript_include_tag :defaults, "nested_form" %>

2. 项目的使用说明

2.1 模型设置

假设你有一个 Project 模型，并且它 has_many :tasks。为了使用 nested_form，你需要在 Project 模型中添加 accepts_nested_attributes_for :tasks。如果你希望允许嵌套对象被删除，可以添加 :allow_destroy => true 选项。

class Project < ActiveRecord::Base
  has_many :tasks
  accepts_nested_attributes_for :tasks, allow_destroy: true
end

2.2 表单设置

使用 nested_form_for 助手方法来启用嵌套表单：

<%= nested_form_for @project do |f| %>
  <%= f.fields_for :tasks do |task_form| %>
    <%= task_form.text_field :name %>
    <%= task_form.link_to_remove "Remove this task" %>
  <% end %>
  <p><%= f.link_to_add "Add a task", :tasks %></p>
<% end %>

2.3 部分视图

为了保持代码的整洁，你可以将嵌套字段移到一个部分视图中。如果你不给 fields_for 提供块，它将寻找一个部分视图并使用它：

<%= f.fields_for :tasks %>

在这种情况下，它将寻找一个名为 task_fields 的部分视图，并将表单构建器作为 f 变量传递给它。

3. 项目API使用文档

3.1 强参数

对于 Rails 4 或使用 strong_parameters gem 的用户，以下是一个示例：

params.require(:project).permit(:name, tasks_attributes: [:id, :name, :_destroy])

• :id 用于确保不会创建大量任务。
• :_destroy 必须存在，以便我们可以删除任务。

3.2 JavaScript 事件

有时你可能希望在元素被添加或删除后执行一些额外的操作。为此，可以在 nested:fieldAdded 或 nested:fieldRemoved 事件上绑定事件处理程序。

jQuery 示例

$(document).on('nested:fieldAdded', function(event){
  var field = event.field;
  var dateField = field.find('.date');
  dateField.datepicker();
})

Prototype 示例

document.observe('nested:fieldAdded', function(event){
  var field = event.memo.field;
  var dateField = field.down('.date');
  dateField.datepicker();
})

4. 项目安装方式

4.1 通过 Gemfile 安装

将 nested_form 添加到 Gemfile 中，然后运行 bundle install 来安装。

4.2 手动安装

如果你不使用 Bundler，可以直接从 GitHub 克隆项目并手动安装：

git clone https://github.com/ryanb/nested_form.git
cd nested_form
rake install

通过以上步骤，你可以成功安装并使用 nested_form 来管理 Rails 项目中的嵌套表单。