Task
Task
'
30 | end
31 |
32 | it "should wrap nested fields with specified tag" do
33 | 2.times { @project.tasks.build }
34 | @builder.fields_for(:tasks, :wrapper_tag => 'tr') do
35 | "Task
Task
'
44 | end
45 |
46 | it "should add class to nested fields wrapper" do
47 | tasks = []
48 | 2.times { tasks << @project.tasks.new }
49 | @builder.fields_for(:tasks, tasks, :wrapper_class => 'task') do
50 | "Task"
51 | end.should == 'Task
Task
'
52 | end
53 |
54 | it "should add task fields to hidden div after form" do
55 | pending
56 | output = ""
57 | mock(@template).after_nested_form(:tasks) { |arg, block| output << block.call }
58 | @builder.fields_for(:tasks) { "Task" }
59 | @builder.link_to_add("Add", :tasks)
60 | output.should == ''
61 | end
62 | end
63 | end
64 | end
65 |
--------------------------------------------------------------------------------
/lib/nested_form/builder_mixin.rb:
--------------------------------------------------------------------------------
1 | module NestedForm
2 | module BuilderMixin
3 | # Adds a link to insert a new associated records. The first argument is the name of the link, the second is the name of the association.
4 | #
5 | # f.link_to_add("Add Task", :tasks)
6 | #
7 | # You can pass HTML options in a hash at the end and a block for the content.
8 | #
9 | # <%= f.link_to_add(:tasks, :class => "add_task", :href => new_task_path) do %>
10 | # Add Task
11 | # <% end %>
12 | #
13 | # See the README for more details on where to call this method.
14 | def link_to_add(*args, &block)
15 | options = args.extract_options!.symbolize_keys
16 | association = args.pop
17 | options[:class] = [options[:class], "add_nested_fields"].compact.join(" ")
18 | options["data-association"] = association
19 | args << (options.delete(:href) || "javascript:void(0)")
20 | args << options
21 | @fields ||= {}
22 | @template.after_nested_form(association) do
23 | model_object = object.class.reflect_on_association(association).klass.new
24 | blueprint = fields_for(association, model_object, :child_index => "new_#{association}", :wrapper_tag => @fields[association][:wrapper_tag], :wrapper_class => @fields[association][:wrapper_class], &@fields[association][:block])
25 | blueprint_options = { :type => 'text/html', :id => "#{association}_fields_blueprint" }
26 | @template.content_tag(:script, blueprint, blueprint_options)
27 | end
28 | @template.link_to(*args, &block)
29 | end
30 |
31 | # Adds a link to remove the associated record. The first argment is the name of the link.
32 | #
33 | # f.link_to_remove("Remove Task")
34 | #
35 | # You can pass HTML options in a hash at the end and a block for the content.
36 | #
37 | # <%= f.link_to_remove(:class => "remove_task", :href => "#") do %>
38 | # Remove Task
39 | # <% end %>
40 | #
41 | # See the README for more details on where to call this method.
42 | def link_to_remove(*args, &block)
43 | options = args.extract_options!.symbolize_keys
44 | options[:class] = [options[:class], "remove_nested_fields"].compact.join(" ")
45 | args << (options.delete(:href) || "javascript:void(0)")
46 | args << options
47 | (hidden_field(:_destroy) << @template.link_to(*args, &block)).html_safe
48 | end
49 |
50 | def fields_for_with_nested_attributes(association_name, *args)
51 | # TODO Test this better
52 | block = args.pop || Proc.new { |fields| @template.render(:partial => "#{association_name.to_s.singularize}_fields", :locals => {:f => fields}) }
53 |
54 | convert = false
55 | if Gem::Version.new(Rails::VERSION::STRING) < Gem::Version.new("3.1.0") # 3.0.x
56 | options = args[0].extract_options!
57 | convert = true
58 | else # >= 3.1.0
59 | options = args.extract_options!
60 | end
61 |
62 | options[:wrapper_tag] ||= 'div'
63 | options[:wrapper_class] = ' ' << options[:wrapper_class] if options[:wrapper_class]
64 |
65 | if convert
66 | args[0] << options
67 | else
68 | args << options
69 | end
70 |
71 | @fields ||= {}
72 | @fields[association_name] = { :block => block, :wrapper_tag => options[:wrapper_tag], :wrapper_class => options[:wrapper_class] }
73 | super(association_name, *(args << block))
74 | end
75 |
76 | def fields_for_nested_model(name, object, options, block)
77 | @template.content_tag(options[:wrapper_tag], super, :class => "fields#{options[:wrapper_class]}")
78 | end
79 | end
80 | end
81 |
--------------------------------------------------------------------------------
/README.rdoc:
--------------------------------------------------------------------------------
1 | = Nested Form
2 |
3 | {
}[http://travis-ci.org/fxposter/nested_form]
4 |
5 | This is a Rails gem for conveniently manage multiple nested models in a single form. It does so in an unobtrusive way through jQuery or Prototype.
6 |
7 | This gem only works with Rails 3. See the {rails2 branch}[https://github.com/ryanb/nested_form/tree/rails2] for a plugin to work in Rails 2.
8 |
9 | An example project showing how this works is available in the {complex-nested-forms/nested_form branch}[https://github.com/ryanb/complex-form-examples/tree/nested_form].
10 |
11 |
12 | === Enhanced jQuery javascript template
13 |
14 | Now you can override default behavior of inserting new subforms into your form (jQuery-only feature, sorry). For example:
15 |
16 | window.nestedFormEvents.insertFields = function(content, assoc, link) {
17 | return $(link).closest('form').find(assoc + '_fields').append($(content));
18 | }
19 |
20 |
21 | === Rails 3.1 support (with asset pipeline)
22 |
23 | There's a small fix for Rails 3.1 form handling.
24 | Also support of Rails 3.1 led me to huge refactor of specs setup (now using Helper specs from rspec-rails instead of custom implementation spec context).
25 |
26 | Formtastic is supported only with Rails 3.0, Rails 3.1 integration is not available now.
27 |
28 | Asset pipeline is supported. So you can use
29 |
30 | //= require jquery_nested_form
31 | // or
32 | //= require prototype_nested_form
33 |
34 |
35 | == Setup
36 |
37 | Add it to your Gemfile then run +bundle+ to install it.
38 |
39 | gem "nested_form"
40 |
41 | Next run the generator to create the JavaScript file. This will automatically detect if you are using jQuery or Prototype.
42 |
43 | rails g nested_form:install
44 |
45 | Running the generator will add a file at public/javascripts/nested_form.js which should be included after the jQuery or Prototype framework.
46 |
47 | <%= javascript_include_tag :defaults, "nested_form" %>
48 |
49 |
50 | == Usage
51 |
52 | Imagine you have a Project model that has_many :tasks. To be able to use this gem, you'll need to add accepts_nested_attributes_for :tasks to your Project model. If you don't have the accepts_nested_attributes_for :tasks you'll get a Missing Block Error.
53 |
54 | This will create a tasks_attributes= method, so you may need to add it to the attr_accessible array. (attr_accessible :tasks_attributes)
55 |
56 | Then use the +nested_form_for+ helper method to enable the nesting.
57 |
58 | <%= nested_form_for @project do |f| %>
59 |
60 | You will then be able to use +link_to_add+ and +link_to_remove+ helper methods on the form builder in combination with fields_for to dynamically add/remove nested records.
61 |
62 | <%= f.fields_for :tasks do |task_form| %>
63 | <%= task_form.text_field :name %>
64 | <%= task_form.link_to_remove "Remove this task" %>
65 | <% end %>
66 | <%= f.link_to_add "Add a task", :tasks %>
67 | 68 | By default fields_for inside nested_form_for will add wrapper for every nested object. Sometimes you need not the
, but the (if you insert rows into table). Now you can specify wrapping tag by providing :wrapper_tag => 'tr' option (by default it is 'div'):
69 |
70 |
71 | <%= f.fields_for :tasks, :wrapper_tag => 'tr' do |task_form| %>
72 |
79 | -s and this is not pretty good.
82 |
83 | Also, you can specify :wrapper_class, which will be added "fields" class in wrapper element:
84 |
85 | <%= f.fields_for :tasks, :wrapper_class => 'task' do |task_form| %>
86 | <%= task_form.text_field :name %>
87 | <%= task_form.link_to_remove "Remove this task" %>
88 | <% end %>
89 |
| 73 | <%= task_form.hidden_field :id %> 74 | <%= task_form.text_field :name %> 75 | <%= task_form.link_to_remove "Remove this task" %> 76 | | 77 | <% end %> 78 |
<%= f.link_to_add "Add a task", :tasks %>
80 | 81 | You should specify id field, cause form_for will insert it between<%= f.link_to_add "Add a task", :tasks %>
90 | 91 | 92 | == SimpleForm and Formtastic Support 93 | 94 | Use simple_nested_form_for or semantic_nested_form_for for SimpleForm and Formtastic support respectively. This is feature is not yet in a Gem release but is in the Git repo. 95 | 96 | 97 | == Partials 98 | 99 | It is often desirable to move the nested fields into a partial to keep things organized. If you don't supply a block to fields_for it will look for a partial and use that. 100 | 101 | <%= f.fields_for :tasks %> 102 | 103 | In this case it will look for a partial called "task_fields" and pass the form builder as an +f+ variable to it. 104 | 105 | 106 | == Events 107 | 108 | If you are using jQuery, nested:fieldAdded and nested:fieldRemoved events are triggered on the +form+ element after adding and removing fields. 109 | 110 | 111 | == Special Thanks 112 | 113 | This gem was originally based on the solution by Tim Riley in his {complex-form-examples fork}[https://github.com/timriley/complex-form-examples/tree/unobtrusive-jquery-deep-fix2]. 114 | 115 | Thank you Andrew Manshin for the Rails 3 transition, {Andrea Singh}[https://github.com/madebydna] for converting to a gem and {Peter Giacomo Lombardo}[https://github.com/pglombardo] for Prototype support. 116 | 117 | Andrea also wrote a great {blog post}[http://blog.madebydna.com/all/code/2010/10/07/dynamic-nested-froms-with-the-nested-form-gem.html] on the internal workings of this gem. 118 | 119 | Thanks {Pavel Forkert}[https://github.com/fxposter] for the SimpleForm and Formtastic support. 120 | --------------------------------------------------------------------------------