nested_form 0.0.0 → 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,16 @@
+0.1.0 (March 26, 2011)
+
+* Prefix new records with "new_" so there's no possible conflict with existing records - issue #21
+
+* Add support for _fields partial if no block is passed in to fields_for
+
+* Use the $-jquery-function only inside the jQuery scope (thanks nhocki)
+
+* Triggers nested:fieldAdded and nested:fieldRemoved events (thanks pirelenito)
+
+* Fixed JavaScript bug for nested attributes in has_one association (thanks pirelenito)
+
+
+0.0.0 (February 17, 2011)
+
+* Initial release

data/README.rdoc

@@ -1,44 +1,38 @@
 = Nested Form
 
-A Rails gem to conveniently manage multiple nested models in a single form. It does so in an unobtrusive way through jQuery.
+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.
 
-To learn more about how this works under the hood: http://blog.madebydna.com/dynamic-nested-forms-in-rails-3-with-the-nest
+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.
 
 
-== Install
+== Setup
 
-Add it to your Gemfile
-  
-  gem "nested_form"
+Add it to your Gemfile then run +bundle+ to install it.
 
-Run
-  
-  bundle install
+  gem "nested_form"
 
-Run the generator
+Next run the generator to create the JavaScript file. This will automatically detect if you are using jQuery or Prototype.
 
-  rails generate nested_form:install
+  rails g nested_form:install
 
+Running the generator will add a file at <tt>public/javascripts/nested_form.js</tt> which should be included after the jQuery or Prototype framework.
 
-== Usage
+  <%= javascript_include_tag :defaults, "nested_form" %>
 
-Running the generator will add a file at public/javascripts/nested_form.js which should be included after the jQuery or Prototype framework.
 
-  <%= javascript_include_tag :defaults, "nested_form" %>
+== Usage
 
-You can then generate a nested form using the nested_form_for helper method.
+Use the +nested_form_for+ helper method to enable the nesting.
 
   <%= nested_form_for @project do |f| %>
 
-Use this form just like normal, including the +fields_for+ helper method for nesting models. The benefit of this plugin comes from the +link_to_add+ and +link_to_remove+ helper methods on the form builder.
+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.
 
   <%= f.fields_for :tasks do |task_form| %>
     <%= task_form.text_field :name %>
     <%= task_form.link_to_remove "Remove this task" %>
   <% end %>
-  <%= f.link_to_add "Add a task", :tasks %>
-
-This generates links which dynamically add and remove fields.
+  <p><%= f.link_to_add "Add a task", :tasks %></p>
 
 
 == Partials
@@ -50,8 +44,15 @@ It is often desirable to move the nested fields into a partial to keep things or
 In this case it will look for a partial called "task_fields" and pass the form builder as an f variable to it.
 
 
+== Events
+
+If you are using jQuery, <tt>nested:fieldAdded<tt> and <tt>nested:fieldRemoved</tt> events are triggered on the +form+ element after adding and removing fields.
+
+
 == Special Thanks
 
 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].
 
 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.
+
+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.

data/lib/generators/nested_form/install_generator.rb

@@ -4,7 +4,7 @@ module NestedForm
       def self.source_root
         File.dirname(__FILE__) + "/templates"
       end
-      
+
       def copy_jquery_file
         if File.exists?('public/javascripts/prototype.js')
           copy_file 'prototype_nested_form.js', 'public/javascripts/nested_form.js'

data/lib/generators/nested_form/templates/jquery_nested_form.js

@@ -1,46 +1,48 @@
-$(function() {
-$('form a.add_nested_fields').live('click', function() {
-  // Setup
-  var assoc   = $(this).attr('data-association');           // Name of child
-  var content = $('#' + assoc + '_fields_blueprint').html(); // Fields template
+jQuery(function($) {
+  $('form a.add_nested_fields').live('click', function() {
+    // Setup
+    var assoc   = $(this).attr('data-association');            // Name of child
+    var content = $('#' + assoc + '_fields_blueprint').html(); // Fields template
 
-  // Make the context correct by replacing new_<parents> with the generated ID
-  // of each of the parent objects
-  var context = ($(this).closest('.fields').find('input:first').attr('name') || '').replace(new RegExp('\[[a-z]+\]$'), '');
+    // Make the context correct by replacing new_<parents> with the generated ID
+    // of each of the parent objects
+    var context = ($(this).closest('.fields').find('input:first').attr('name') || '').replace(new RegExp('\[[a-z]+\]$'), '');
 
-  // context will be something like this for a brand new form:
-  // project[tasks_attributes][1255929127459][assignments_attributes][1255929128105]
-  // or for an edit form:
-  // project[tasks_attributes][0][assignments_attributes][1]
-  if(context) {
-    var parent_names = context.match(/[a-z_]+_attributes/g) || [];
-    var parent_ids   = context.match(/[0-9]+/g);
+    // context will be something like this for a brand new form:
+    // project[tasks_attributes][new_1255929127459][assignments_attributes][new_1255929128105]
+    // or for an edit form:
+    // project[tasks_attributes][0][assignments_attributes][1]
+    if(context) {
+      var parent_names = context.match(/[a-z_]+_attributes/g) || [];
+      var parent_ids   = context.match(/(new_)?[0-9]+/g) || [];
 
-    for(i = 0; i < parent_names.length; i++) {
-      if(parent_ids[i]) {
-        content = content.replace(
-          new RegExp('(\\[' + parent_names[i] + '\\])\\[.+?\\]', 'g'),
-          '$1[' + parent_ids[i] + ']'
-        )
+      for(i = 0; i < parent_names.length; i++) {
+        if(parent_ids[i]) {
+          content = content.replace(
+            new RegExp('(\\[' + parent_names[i] + '\\])\\[.+?\\]', 'g'),
+            '$1[' + parent_ids[i] + ']'
+          )
+        }
       }
     }
-  }
 
-  // Make a unique ID for the new child
-  var regexp  = new RegExp('new_' + assoc, 'g');
-  var new_id  = new Date().getTime();
-  content     = content.replace(regexp, new_id);
+    // Make a unique ID for the new child
+    var regexp  = new RegExp('new_' + assoc, 'g');
+    var new_id  = new Date().getTime();
+    content     = content.replace(regexp, "new_" + new_id);
 
-  $(this).before(content);
-  return false;
-});
+    $(this).before(content);
+    $(this).closest("form").trigger('nested:fieldAdded');
+    return false;
+  });
 
-$('form a.remove_nested_fields').live('click', function() {
-  var hidden_field = $(this).prev('input[type=hidden]')[0];
-  if(hidden_field) {
-    hidden_field.value = '1';
-  }
-  $(this).closest('.fields').hide();
-  return false;
+  $('form a.remove_nested_fields').live('click', function() {
+    var hidden_field = $(this).prev('input[type=hidden]')[0];
+    if(hidden_field) {
+      hidden_field.value = '1';
+    }
+    $(this).closest('.fields').hide();
+    $(this).closest("form").trigger('nested:fieldRemoved');
+    return false;
+  });
 });
-});

data/lib/generators/nested_form/templates/prototype_nested_form.js

@@ -9,12 +9,12 @@ document.observe('click', function(e, el) {
 	  var context = (el.getOffsetParent('.fields').firstDescendant().readAttribute('name') || '').replace(new RegExp('\[[a-z]+\]$'), '');
 
 	  // context will be something like this for a brand new form:
-	  // project[tasks_attributes][1255929127459][assignments_attributes][1255929128105]
+	  // project[tasks_attributes][new_1255929127459][assignments_attributes][new_1255929128105]
 	  // or for an edit form:
 	  // project[tasks_attributes][0][assignments_attributes][1]
 	  if(context) {
 	    var parent_names = context.match(/[a-z_]+_attributes/g) || [];
-	    var parent_ids   = context.match(/[0-9]+/g);
+	    var parent_ids   = context.match(/(new_)?[0-9]+/g) || [];
 
 	    for(i = 0; i < parent_names.length; i++) {
 	      if(parent_ids[i]) {
@@ -29,7 +29,7 @@ document.observe('click', function(e, el) {
 	  // Make a unique ID for the new child
 	  var regexp  = new RegExp('new_' + assoc, 'g');
 	  var new_id  = new Date().getTime();
-	  content     = content.replace(regexp, new_id);
+	  content     = content.replace(regexp, "new_" + new_id);
 
 	  el.insert({ before: content });
 	  return false;

data/lib/nested_form/builder.rb

@@ -16,13 +16,15 @@ module NestedForm
       hidden_field(:_destroy) + @template.link_to(name, "javascript:void(0)", :class => "remove_nested_fields")
     end
 
-    def fields_for_with_nested_attributes(association, args, block)
+    def fields_for_with_nested_attributes(association_name, args, block)
+      # TODO Test this better
+      block ||= Proc.new { |fields| @template.render(:partial => "#{association_name.to_s.singularize}_fields", :locals => {:f => fields}) }
       @fields ||= {}
-      @fields[association] = block
-      super
+      @fields[association_name] = block
+      super(association_name, args, block)
     end
 
-    def fields_for_nested_model(name, association, args, block)
+    def fields_for_nested_model(name, object, options, block)
       output = '<div class="fields">'.html_safe
       output << super
       output.safe_concat('</div>')

data/lib/nested_form/view_helper.rb

@@ -9,7 +9,7 @@ module NestedForm
       end
       output << fields.join(" ").html_safe
     end
-    
+
     def after_nested_form(association, &block)
       @associations ||= []
       @after_nested_form_callbacks ||= []

data/spec/spec_helper.rb

@@ -22,15 +22,15 @@ end
 
 class TablelessModel < ActiveRecord::Base
   def self.columns() @columns ||= []; end
- 
+
   def self.column(name, sql_type = nil, default = nil, null = true)
     columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
   end
-  
+
   def self.quoted_table_name
     name.pluralize.underscore
   end
-  
+
   def quoted_id
     "0"
   end

metadata

@@ -2,7 +2,7 @@
 name: nested_form
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ryan Bates
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 -08:00
+date: 2011-03-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - spec/nested_form/builder_spec.rb
 - spec/nested_form/view_helper_spec.rb
 - spec/spec_helper.rb
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE
 - Rakefile