cocoon 1.0.17 → 1.0.18

data/README.markdown

@@ -149,14 +149,41 @@ It takes four parameters:
 - f: referring to the containing form-object
 - association: the name of the association (plural) of which a new instance needs to be added (symbol or string).
 - html_options: extra html-options (see `link_to`)
-  There are three extra options that allow to control the placement of the new link-data:
+  There are some special options, the first three allow to control the placement of the new link-data:
   - `data-association-insertion-node` : the jquery selector of the node
   - `data-association-insertion-method` : jquery method that inserts the new data. `before`, `after`, `append`, `prepend`, etc. Default: `before`
   - `data-association-insertion-position` : old method specifying where to insert new data.
       - this setting still works but `data-association-insertion-method` takes precedence. may be removed in a future version.
+  - `partial`: explicitly declare the name of the partial that will be used
+  - `render_options` : options passed through to the form-builder function (e.g. `simple_fields_for`, `semantic_fields_for` or `fields_for`).
+                       If it contains a `:locals` option containing a hash, that is handed to the partial.
 
 Optionally you could also leave out the name and supply a block that is captured to give the name (if you want to do something more complicated).
 
+#### :render_options
+Inside the `html_options` you can add an option `:render_options`, and the containing hash will be handed down to the form-builder for the inserted
+form. E.g. especially when using `twitter-bootstrap` and `simple_form` together, the `simple_fields_for` needs the option `:wrapper => 'inline'` which can
+be handed down as follows:
+
+````haml
+= link_to_add_association 'add something', f, :something, :render_options => {:wrapper => 'inline' }
+````
+
+If you want to specify locals that needed to handed down to the partial, write
+
+````haml
+= link_to_add_association 'add something', f, :something, :render_options => {:locals => {:sherlock => 'Holmes' }}
+````
+
+
+#### :partial
+
+To overrule the default partial name, e.g. because it shared between multiple views, write
+
+````haml
+= link_to_add_association 'add something', f, :something, :partial => 'shared/something_fields'
+````
+
 
 ### link_to_remove_association
 
@@ -171,13 +198,6 @@ It takes three parameters:
 
 Optionally you could also leave out the name and supply a block that is captured to give the name (if you want to do something more complicated).
 
-Inside the `html_options` you can add an option `:render_options`, and the containing hash will be handed down to the form-builder for the inserted
-form. E.g. especially when using `twitter-bootstrap` and `simple_form` together, the `simple_fields_for` needs the option `:wrapper => 'inline'` which can
-be handed down as follows:
-
-````haml
-= link_to_add_association 'add something', f, :something, :render_options => {:wrapper => 'inline' }
-````
 
 ### Callbacks (upon insert and remove of items)
 
@@ -208,10 +228,15 @@ $(document).ready(function() {
            $("#owner_from_list").show();
            $("#owner a.add_fields").show();
          });
+    $('#owner').bind("after-removal-callback",
+         function() {
+           /* e.g. recalculate order of child items */
+         });
 });
 ````
 
 Do note that for the callbacks to work there has to be a surrounding container (div), where you can bind the callbacks to.
+Note that the default `removal-callback` is called _before_ removing the nested item.
 
 ### Control the Insertion behaviour
 
@@ -234,7 +259,12 @@ The `association-insertion-method` will determine where to add it in relation wi
 
 ### Partial
 
-The partial should be named `_<association-object_singular>_fields`, and should start with a container (e.g. `div`) of class `.nested-fields`.
+If no explicit partial-name is given, `cocoon` looks for a file named `_<association-object_singular>_fields`.
+To override the default partial-name use the option `:partial`.
+
+For the javascript to behave correctly, the partial should start with a container (e.g. `div`) of class `.nested-fields`.
+
+
 
 There is no limit to the amount of nesting, though.
 

data/VERSION

@@ -1 +1 @@
-1.0.17
+1.0.18

data/app/assets/javascripts/cocoon.js

@@ -6,7 +6,11 @@
   }
 
   function trigger_removal_callback(node) {
-    node.parent().parent().trigger('removal-callback');
+    node.trigger('removal-callback');
+  }
+
+  function trigger_after_removal_callback(node) {
+    node.trigger('after-removal-callback');
   }
 
   $('.add_fields').live('click', function(e) {
@@ -17,8 +21,6 @@
         content               = $this.data('template'),
         insertionMethod       = $this.data('association-insertion-method') || $this.data('association-insertion-position') || 'before';
         insertionNode         = $this.data('association-insertion-node'),
-        insertionCallback     = $this.data('insertion-callback'),
-        removalCallback       = $this.data('removal-callback'),
         regexp_braced         = new RegExp('\\[new_' + assoc + '\\]', 'g'),
         regexp_underscord     = new RegExp('_new_' + assoc + '_', 'g'),
         new_id                = new Date().getTime(),
@@ -52,17 +54,21 @@
 
   $('.remove_fields.dynamic').live('click', function(e) {
     var $this = $(this);
-    trigger_removal_callback($this);
+    var trigger_node = $this.closest(".nested-fields").parent();
+    trigger_removal_callback(trigger_node);
     e.preventDefault();
     $this.closest(".nested-fields").remove();
+    trigger_after_removal_callback(trigger_node);
   });
 
   $('.remove_fields.existing').live('click', function(e) {
     var $this = $(this);
-    trigger_removal_callback($this);
+    var trigger_node = $this.closest(".nested-fields").parent().parent();
+    trigger_removal_callback(trigger_node);
     e.preventDefault();
     $this.prev("input[type=hidden]").val("1");
     $this.closest(".nested-fields").hide();
+    trigger_after_removal_callback(trigger_node);
   });
 
 })(jQuery);

data/cocoon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cocoon"
-  s.version = "1.0.17"
+  s.version = "1.0.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Van der Auwera"]
-  s.date = "2012-03-16"
+  s.date = "2012-04-07"
   s.description = "Unobtrusive nested forms handling, using jQuery. Use this and discover cocoon-heaven."
   s.email = "nathan@dixis.com"
   s.extra_rdoc_files = [

data/lib/cocoon/view_helpers.rb

@@ -33,9 +33,11 @@ module Cocoon
     # :nodoc:
     def render_association(association, f, new_object, render_options={}, custom_partial=nil)
       partial = setup_partial(custom_partial, association)
+      locals =  render_options.delete(:locals)
       method_name = f.respond_to?(:semantic_fields_for) ? :semantic_fields_for : (f.respond_to?(:simple_fields_for) ? :simple_fields_for : :fields_for)
       f.send(method_name, association, new_object, {:child_index => "new_#{association}"}.merge(render_options)) do |builder|
-        render(partial, :f => builder, :dynamic => true)
+        partial_options = {:f => builder, :dynamic => true}.merge(locals)
+        render(partial, partial_options)
       end
     end
 
@@ -45,6 +47,9 @@ module Cocoon
     # - *f* :            the form this should come in (the formtastic form)
     # - *association* :  the associated objects, e.g. :tasks, this should be the name of the <tt>has_many</tt> relation.
     # - *html_options*:  html options to be passed to <tt>link_to</tt> (see <tt>link_to</tt>)
+    #          - *:render_options* : options passed to `simple_fields_for, semantic_fields_for or fields_for`
+    #              - *:locals*     : the locals hash in the :render_options is handed to the partial
+    #          - *:partial*        : explicitly override the default partial name
     # - *&block*:        see <tt>link_to</tt>
 
     def link_to_add_association(*args, &block)

data/spec/cocoon_spec.rb

@@ -54,6 +54,13 @@ describe Cocoon do
       end
     end
 
+    context "when using aliased association and class-name" do
+      it "uses the correct name" do
+        result = @tester.link_to_add_association('add something', @form_obj, :admin_comments)
+        result.to_s.should == '<a href="#" class="add_fields" data-association="admin_comment" data-associations="admin_comments" data-template="form&lt;tag&gt;">add something</a>'
+      end
+    end
+
     it "tttt" do
       @post.class.reflect_on_association(:people).klass.new.should be_a(Person)
     end
@@ -66,6 +73,18 @@ describe Cocoon do
       end
     end
 
+    context "with extra render-options to pass locals to the partial" do
+      it "uses the correct plural" do
+        @tester.unstub(:render_association)
+        @form_obj.should_receive(:fields_for) { | association, new_object, options_hash, &block| block.call }
+        @tester.should_receive(:render).with("person_fields", {:f=>nil, :dynamic=>true, :alfred=>"Judoka"}).and_return ("partiallll")
+        result = @tester.link_to_add_association('add something', @form_obj, :people, :render_options => {:wrapper => 'inline', :locals => {:alfred => 'Judoka'}})
+        result.to_s.should == '<a href="#" class="add_fields" data-association="person" data-associations="people" data-template="partiallll">add something</a>'
+      end
+    end
+
+
+
     context "when using formtastic" do
       before(:each) do
         @tester.unstub(:render_association)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cocoon
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 51
   prerelease: 
   segments: 
   - 1
   - 0
-  - 17
-  version: 1.0.17
+  - 18
+  version: 1.0.18
 platform: ruby
 authors: 
 - Nathan Van der Auwera
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-16 00:00:00 Z
+date: 2012-04-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement