cocoon 1.1.0 → 1.1.1

data/History.md

@@ -1,5 +1,10 @@
 # Change History / Release Notes
 
+## Version 1.1.1
+
+* added the to be added/deleted element to the event, this allows to add animations/actions onto them
+* added extra option :wrap_object, allowing to use Decorators instead of the association object
+* added an option :force_non_association_create, that will allow to use `link_to_add_association` inside the fields-partial
 
 ## Version 1.1.0
 

data/README.markdown

@@ -216,6 +216,8 @@ It takes four parameters:
   - `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.
+  - `wrap_object` : a proc that will allow to wrap your object, especially useful if you are using decorators (e.g. draper). See example lower.
+  - `force_non_association_create`: if true, it will _not_ create the new object using the association (see lower)
 
 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).
 
@@ -245,6 +247,65 @@ To overrule the default partial name, e.g. because it shared between multiple vi
 = link_to_add_association 'add something', f, :something, :partial => 'shared/something_fields'
 ````
 
+#### :wrap_object
+
+If you are using decorators, the normal instantiation of the associated will not be enough, actually you want to generate the decorated object.
+
+A simple decorator would look like:
+
+```
+class CommentDecorator
+  def initialize(comment)
+    @comment = comment
+  end
+
+  def formatted_created_at
+    @comment.created_at.to_formatted_s(:short)
+  end
+
+  def method_missing(method_sym, *args)
+    if @comment.respond_to?(method_sym)
+      @comment.send(method_sym, *args)
+    else
+      super
+    end
+  end
+end
+```
+
+To use this, write
+
+```
+link_to_add_association('add something', @form_obj, :comments, :wrap_object => Proc.new {|comment| CommentDecorator.new(comment) })
+```
+
+Note that the `:wrap_object` expects an object that is _callable_, so any `Proc` will do. So you could as well use it to do some fancy extra initialisation (if needed).
+But note you will have to return the (nested) object you want used.
+E.g.
+
+
+```
+link_to_add_association('add something', @form_obj, :comments, 
+                        :wrap_object => Proc.new { |comment| comment.name = current_user.name; comment })
+```
+
+#### :force_non_association_create
+
+In normal cases we create a new nested object using the association relation itself. This is the cleanest way to create
+a new nested object. But this has a side-effect: for each call of `link_to_add_association` a new element is added to the association.
+
+In most cases this is not a problem, but if you want to render a `link_to_add_association` for each nested element this will result
+in an infinite loop.
+
+To resolve this, specify that `:force_non_association_create` should be `true`, as follows:
+
+```
+link_to_add_association('add something', @form_obj, :comments, :force_non_association_create => true)
+```
+
+By default `:force_non_association_create` is `false`.
+
+> A cleaner option would be to call a function that performs this initialisation and returns `self` at the end.
 
 ### link_to_remove_association
 
@@ -269,6 +330,16 @@ On insertion or removal the following events are triggered:
 * `cocoon:before-remove`: called before removing the nested child
 * `cocoon:after-remove`: called after removal
 
+To listen to the events, you to have the following code in your javascript:
+
+    $('#container').bind('cocoon:before-insert', function(e, inserted_item) {
+        // ... do something
+    });
+
+where `e` is the event and the second parameter is the inserted or removed item. This allows you to change markup, or
+add effects/animations (see example below).
+
+
 If in your view you have the following snippet to select an `owner`
 (we use slim for demonstration purposes)
 
@@ -304,12 +375,38 @@ $(document).ready(function() {
          function() {
            /* e.g. recalculate order of child items */
          });
+
+    // example showing manipulating the inserted/removed item
+
+    $('#tasks').bind('cocoon:before-insert', function(e,task_to_be_added) {
+        task_to_be_added.fadeIn('slow');
+    });
+
+    $('#tasks').bind('cocoon:after-insert', function(e, added_task) {
+        // e.g. set the background of inserted task
+        added_task.css("background","red");
+    });
+
+    $('#tasks').bind('cocoon:before-remove', function(e, task) {
+        // allow some time for the animation to complete
+        $(this).data('remove-timeout', 1000);
+        task.fadeOut('slow');
+    })
+
+
 });
 ````
 
 Do note that for the callbacks to work there has to be a surrounding container (div), where you can bind the callbacks to.
 
 
+When adding animations and effects to make the removal of items more interesting, you will also have to provide a timeout.
+This is accomplished by the following line:
+
+    $(this).data('remove-timeout', 1000);
+
+Note that you could also immediately add this to your view (on the `.nested-fields` container).
+
 ### Control the Insertion behaviour
 
 The default insertion location is at the back of the current container. But we have added two `data`-attributes that are read to determine the insertion-node and -method.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/app/assets/javascripts/cocoon.js

@@ -1,17 +1,12 @@
 (function($) {
 
+  var cocoon_element_counter = 0;
+
   function replace_in_content(content, regexp_str, with_str) {
     reg_exp = new RegExp(regexp_str);
     content.replace(reg_exp, with_str);
   }
 
-  function trigger_before_removal_callback(node) {
-    node.trigger('cocoon:before-remove');
-  }
-
-  function trigger_after_removal_callback(node) {
-    node.trigger('cocoon:after-remove');
-  }
 
   $('.add_fields').live('click', function(e) {
     e.preventDefault();
@@ -22,20 +17,20 @@
         insertionMethod       = $this.data('association-insertion-method') || $this.data('association-insertion-position') || 'before';
         insertionNode         = $this.data('association-insertion-node'),
         insertionTraversal    = $this.data('association-insertion-traversal'),
-        regexp_braced         = new RegExp('\\[new_' + assoc + '\\]', 'g'),
-        regexp_underscord     = new RegExp('_new_' + assoc + '_', 'g'),
-        new_id                = new Date().getTime(),
+        regexp_braced         = new RegExp('\\[new_' + assoc + '\\](.*?\\s)', 'g'),
+        regexp_underscord     = new RegExp('_new_' + assoc + '_(\\w*)', 'g'),
+        new_id                = new Date().getTime() + cocoon_element_counter++,
         newcontent_braced     = '[' + new_id + ']',
         newcontent_underscord = '_' + new_id + '_',
-        new_content           = content.replace(regexp_braced, '[' + new_id + ']');
+        new_content           = content.replace(regexp_braced, '[' + new_id + ']$1');
 
     if (new_content == content) {
-        regexp_braced     = new RegExp('\\[new_' + assocs + '\\]', 'g');
-        regexp_underscord = new RegExp('_new_' + assocs + '_', 'g');
-        new_content       = content.replace(regexp_braced, '[' + new_id + ']');
+        regexp_braced     = new RegExp('\\[new_' + assocs + '\\](.*?\\s)', 'g');
+        regexp_underscord = new RegExp('_new_' + assocs + '_(\\w*)', 'g');
+        new_content       = content.replace(regexp_braced, '[' + new_id + ']$1');
     }
 
-    new_content = new_content.replace(regexp_underscord, newcontent_underscord);
+    new_content = new_content.replace(regexp_underscord, newcontent_underscord + "$1");
 
     if (insertionNode){
       if (insertionTraversal){
@@ -49,33 +44,38 @@
 
     var contentNode = $(new_content);
 
-    insertionNode.trigger('cocoon:before-insert');
+    insertionNode.trigger('cocoon:before-insert', [contentNode]);
 
     // allow any of the jquery dom manipulation methods (after, before, append, prepend, etc)
     // to be called on the node.  allows the insertion node to be the parent of the inserted
     // code and doesn't force it to be a sibling like after/before does. default: 'before'
-    insertionNode[insertionMethod](contentNode);
+    var addedContent = insertionNode[insertionMethod](contentNode);
 
-    insertionNode.trigger('cocoon:after-insert');
+    insertionNode.trigger('cocoon:after-insert', [contentNode]);
   });
 
-  $('.remove_fields.dynamic').live('click', function(e) {
-    var $this = $(this);
-    var trigger_node = $this.closest(".nested-fields").parent();
-    trigger_before_removal_callback(trigger_node);
-    e.preventDefault();
-    $this.closest(".nested-fields").remove();
-    trigger_after_removal_callback(trigger_node);
-  });
 
-  $('.remove_fields.existing').live('click', function(e) {
+  $('.remove_fields.dynamic, .remove_fields.existing').live('click', function(e) {
     var $this = $(this);
-    var trigger_node = $this.closest(".nested-fields").parent().parent();
-    trigger_before_removal_callback(trigger_node);
+    var node_to_delete = $this.closest(".nested-fields");
+    var trigger_node = node_to_delete.parent();
+
     e.preventDefault();
-    $this.prev("input[type=hidden]").val("1");
-    $this.closest(".nested-fields").hide();
-    trigger_after_removal_callback(trigger_node);
+
+    trigger_node.trigger('cocoon:before-remove', [node_to_delete]);
+
+
+    var timeout = trigger_node.data('remove-timeout') || 0;
+
+    setTimeout(function() {
+      if ($this.hasClass('dynamic')) {
+          $this.closest(".nested-fields").remove();
+      } else {
+          $this.prev("input[type=hidden]").val("1");
+          $this.closest(".nested-fields").hide();
+      }
+      trigger_node.trigger('cocoon:after-remove', [node_to_delete]);
+    }, timeout);
   });
 
 })(jQuery);

data/cocoon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cocoon"
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Van der Auwera"]
-  s.date = "2012-10-08"
+  s.date = "2012-11-22"
   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

@@ -50,6 +50,8 @@ module Cocoon
     #          - *: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
+    #          - *:wrap_object     : !!! document more here !!!
+    #          - *!!!add some option to build in collection or not!!!*
     # - *&block*:        see <tt>link_to</tt>
 
     def link_to_add_association(*args, &block)
@@ -68,16 +70,14 @@ module Cocoon
         render_options ||= {}
         override_partial = html_options.delete(:partial)
         wrap_object = html_options.delete(:wrap_object)
+        force_non_association_create = html_options.delete(:force_non_association_create) || false
 
         html_options[:class] = [html_options[:class], "add_fields"].compact.join(' ')
         html_options[:'data-association'] = association.to_s.singularize
         html_options[:'data-associations'] = association.to_s.pluralize
 
-        if wrap_object.respond_to?(:call)
-          new_object = wrap_object.call(create_object(f, association))
-        else
-          new_object = create_object(f, association)
-        end
+        new_object = create_object(f, association, force_non_association_create)
+        new_object = wrap_object.call(new_object) if wrap_object.respond_to?(:call)
 
         html_options[:'data-association-insertion-template'] = CGI.escapeHTML(render_association(association, f, new_object, render_options, override_partial)).html_safe
 
@@ -89,10 +89,10 @@ module Cocoon
     # `` has_many :admin_comments, class_name: "Comment", conditions: { author: "Admin" }
     # will create new Comment with author "Admin"
 
-    def create_object(f, association)
+    def create_object(f, association, force_non_association_create=false)
       assoc = f.object.class.reflect_on_association(association)
 
-      assoc ? create_object_on_association(f, association, assoc) : create_object_on_non_association(f, association)
+      assoc ? create_object_on_association(f, association, assoc, force_non_association_create) : create_object_on_non_association(f, association)
     end
 
     def get_partial_path(partial, association)
@@ -107,13 +107,12 @@ module Cocoon
       raise "Association #{association} doesn't exist on #{f.object.class}"
     end
 
-    def create_object_on_association(f, association, instance)
-      if instance.class.name == "Mongoid::Relations::Metadata"
-        conditions = instance.respond_to?(:conditions) ? instance.conditions.flatten : []
-        instance.klass.new(*conditions)
+    def create_object_on_association(f, association, instance, force_non_association_create)
+      if instance.class.name == "Mongoid::Relations::Metadata" || force_non_association_create
+        create_object_with_conditions(instance)
       else
         # assume ActiveRecord or compatible
-        if  instance.collection?
+        if instance.collection?
           f.object.send(association).build
         else
           f.object.send("build_#{association}")
@@ -121,5 +120,10 @@ module Cocoon
       end
     end
 
+    def create_object_with_conditions(instance)
+      conditions = instance.respond_to?(:conditions) ? instance.conditions.flatten : []
+      instance.klass.new(*conditions)
+    end
+
   end
 end

data/spec/cocoon_spec.rb

@@ -10,11 +10,15 @@ describe Cocoon do
   it { should respond_to(:link_to_add_association) }
   it { should respond_to(:link_to_remove_association) }
 
+  before(:each) do
+    @tester = TestClass.new
+    @post = Post.new
+    @form_obj = stub(:object => @post, :object_name => @post.class.name)
+  end
+
+
   context "link_to_add_association" do
     before(:each) do
-      @tester = TestClass.new
-      @post = Post.new
-      @form_obj = stub(:object => @post)
       @tester.stub(:render_association).and_return('form<tag>')
     end
 
@@ -41,6 +45,25 @@ describe Cocoon do
         @tester.should_receive(:render_association).with(anything(), anything(), kind_of(CommentDecorator), anything(), anything()).and_return('partiallll')
         @tester.link_to_add_association('add something', @form_obj, :comments, :wrap_object => Proc.new {|comment| CommentDecorator.new(comment) })
       end
+
+      context "force non association create" do
+        it "default it uses the association" do
+          @tester.should_receive(:create_object).with(anything, :comments , false)
+          result = @tester.link_to_add_association('add something', @form_obj, :comments)
+          result.to_s.should == '<a href="#" class="add_fields" data-association-insertion-template="form&lt;tag&gt;" data-association="comment" data-associations="comments">add something</a>'
+        end
+        it "specifying false is the same as default: create object on association" do
+          @tester.should_receive(:create_object).with(anything, :comments , false)
+          result = @tester.link_to_add_association('add something', @form_obj, :comments, :force_non_association_create => false)
+          result.to_s.should == '<a href="#" class="add_fields" data-association-insertion-template="form&lt;tag&gt;" data-association="comment" data-associations="comments">add something</a>'
+        end
+        it "specifying true will not create objects on association but using the conditions" do
+          @tester.should_receive(:create_object).with(anything, :comments , true)
+          result = @tester.link_to_add_association('add something', @form_obj, :comments, :force_non_association_create => true)
+          result.to_s.should == '<a href="#" class="add_fields" data-association-insertion-template="form&lt;tag&gt;" data-association="comment" data-associations="comments">add something</a>'
+        end
+
+      end
     end
 
     context "with a block" do
@@ -146,12 +169,6 @@ describe Cocoon do
   end
 
   context "link_to_remove_association" do
-    before(:each) do
-      @tester = TestClass.new
-      @post = Post.new
-      @form_obj = stub(:object => @post, :object_name => @post.class.name)
-    end
-
     context "without a block" do
       it "accepts a name" do
         result = @tester.link_to_remove_association('remove something', @form_obj)
@@ -180,44 +197,50 @@ describe Cocoon do
         result.to_s.should == "<input id=\"Post__destroy\" name=\"Post[_destroy]\" type=\"hidden\" /><a href=\"#\" class=\"add_some_class remove_fields dynamic\" data-something=\"bla\">remove some long name</a>"
       end
     end
+  end
 
-    context "create_object" do
-      it "should create correct association with conditions" do
-        result = @tester.create_object(@form_obj, :admin_comments)
-        result.author.should == "Admin"
-      end
+  context "create_object" do
+    it "creates correct association with conditions" do
+      @tester.should_not_receive(:create_object_with_conditions)
+      result = @tester.create_object(@form_obj, :admin_comments)
+      result.author.should == "Admin"
+    end
 
-      it "should create correct association for belongs_to associations" do
-        result = @tester.create_object(stub(:object => Comment.new), :post)
-        result.should be_a Post
-      end
+    it "creates correct association for belongs_to associations" do
+      result = @tester.create_object(stub(:object => Comment.new), :post)
+      result.should be_a Post
+    end
 
-      it "should raise error if cannot reflect on association" do
-        expect { @tester.create_object(stub(:object => Comment.new), :not_existing) }.to raise_error /association/i
-      end
+    it "raises an error if cannot reflect on association" do
+      expect { @tester.create_object(stub(:object => Comment.new), :not_existing) }.to raise_error /association/i
+    end
 
-      it "should create an association if object responds to 'build_association' as singular" do
-        object = Comment.new
-        object.should_receive(:build_custom_item).and_return 'custom'
-        @tester.create_object(stub(:object => object), :custom_item).should == 'custom'
-      end
+    it "creates an association if object responds to 'build_association' as singular" do
+      object = Comment.new
+      object.should_receive(:build_custom_item).and_return 'custom'
+      @tester.create_object(stub(:object => object), :custom_item).should == 'custom'
+    end
 
-      it "should create an association if object responds to 'build_association' as plural" do
-        object = Comment.new
-        object.should_receive(:build_custom_item).and_return 'custom'
-        @tester.create_object(stub(:object => object), :custom_items).should == 'custom'
-      end
+    it "creates an association if object responds to 'build_association' as plural" do
+      object = Comment.new
+      object.should_receive(:build_custom_item).and_return 'custom'
+      @tester.create_object(stub(:object => object), :custom_items).should == 'custom'
     end
 
-    context "get_partial_path" do
-      it "generates the default partial name if no partial given" do
-        result = @tester.get_partial_path(nil, :admin_comments)
-        result.should == "admin_comment_fields"
-      end
-      it "uses the given partial name" do
-        result = @tester.get_partial_path("comment_fields", :admin_comments)
-        result.should == "comment_fields"
-      end
+    it "can create using only conditions not the association" do
+      @tester.should_receive(:create_object_with_conditions).and_return('flappie')
+      @tester.create_object(@form_obj, :comments, true).should == 'flappie'
+    end
+  end
+
+  context "get_partial_path" do
+    it "generates the default partial name if no partial given" do
+      result = @tester.get_partial_path(nil, :admin_comments)
+      result.should == "admin_comment_fields"
+    end
+    it "uses the given partial name" do
+      result = @tester.get_partial_path("comment_fields", :admin_comments)
+      result.should == "comment_fields"
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoon
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-08 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -248,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4012454906623253900
+      hash: -2830798901960136537
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: