cocoon 1.2.0 → 1.2.1

data/History.md

@@ -1,5 +1,20 @@
 # Change History / Release Notes
 
+## Version 1.2.1
+
+* added a `:form_name` parameter (fixes #153) which allows to use a self-chosen
+  parameter in the nested views. Up until now `f` was assumed (and enforced).
+* improvement of creation of the objects on the association (thanks to Dirk von Grünigen). This
+  alleviates the need for the `:force_non_association_create` option in most cases.
+  That option is for now still kept.
+* after validation errors, already deleted (but not saved) nested elements, will remain deleted
+  (e.g. the state is remembered, and they remain hidden, and will be correctly deleted on next
+  succesfull save) (fixes #136).
+
+## Version 1.2.0
+
+* support for rails 4.0
+
 ## Version 1.1.2
 
 * pull #118 (thanks @ahmozkya): remove the deprecated `.live` function, and use `.on` instead.

data/README.markdown

@@ -1,6 +1,6 @@
 # cocoon
 
-[![Build Status](https://travis-ci.org/nathanvda/cocoon.png)](https://travis-ci.org/nathanvda/cocoon)
+[![Build Status](https://travis-ci.org/nathanvda/cocoon.png?branch=master)](https://travis-ci.org/nathanvda/cocoon)
 
 Cocoon makes it easier to handle nested forms.
 
@@ -25,8 +25,9 @@ Inside your `Gemfile` add the following:
 gem "cocoon"
 ```
 
+> Please note that for rails 4 you will need at least v1.2.0 or later.
 
-### Rails 3.1+
+### Rails 3.1+/Rails 4
 
 Add the following to `application.js` so it compiles to the asset pipeline:
 
@@ -79,6 +80,24 @@ Now we want a project form where we can add and remove tasks dynamically.
 To do this, we need the fields for a new or existing `task` to be defined in a partial
 named `_task_fields.html`.
 
+### Strong Parameters Gotcha
+
+To destroy nested models, rails uses a virtual attribute called `_destroy`.
+When `_destroy` is set, the nested model will be deleted.
+
+When using strong parameters (default in rails 4), you need to explicitly
+add `:_destroy` to the list of permitted parameters.
+
+E.g. in your `ProjectsController`:
+
+```ruby
+  def project_params
+    params.require(:project).permit(:name, :description, tasks_attributes: [:id, :description, :done, :_destroy])
+  end
+```
+
+
+
 ## Examples
 
 ### Formtastic
@@ -202,6 +221,7 @@ This should be called within the form builder.
                        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)
+  - `form_name` : the name of the form parameter in your nested partial. By default this is `f`.
 
 Optionally, you can omit the name and supply a block that is captured to render the link body (if you want to do something more complicated).
 
@@ -281,12 +301,15 @@ E.g.
 #### :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.
+a new nested object.
+
+This used to have a side-effect: for each call of `link_to_add_association` a new element was added to the association.
+This is no longer the case.
 
-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.
+For backward compatibility we keep this option for now. Or if for some specific reason you would
+really need an object to be _not_ created on the association.
 
-To resolve this, specify that `:force_non_association_create` should be `true`:
+Example use:
 
 ```haml
 = link_to_add_association('add something', @form_obj, :comments,
@@ -295,8 +318,6 @@ To resolve this, specify that `:force_non_association_create` should be `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
 
 This function will add a link to your markup that, when clicked, dynamically removes the surrounding partial form.
@@ -323,7 +344,7 @@ On insertion or removal the following events are triggered:
 To listen to the events in your JavaScript:
 
 ```javascript
-  $('#container').bind('cocoon:before-insert', function(e, insertedItem) {
+  $('#container').on('cocoon:before-insert', function(e, insertedItem) {
     // ... do something
   });
 ```
@@ -348,32 +369,32 @@ The callbacks can be added as follows:
 ```javascript
 $(document).ready(function() {
     $('#owner')
-      .bind('cocoon:before-insert', function() {
+      .on('cocoon:before-insert', function() {
         $("#owner_from_list").hide();
         $("#owner a.add_fields").hide();
       })
-      .bind('cocoon:after-insert', function() {
+      .on('cocoon:after-insert', function() {
         /* ... do something ... */
       })
-      .bind("cocoon:before-remove", function() {
+      .on("cocoon:before-remove", function() {
         $("#owner_from_list").show();
         $("#owner a.add_fields").show();
       })
-      .bind("cocoon:after-remove", function() {
+      .on("cocoon:after-remove", 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) {
+      .on('cocoon:before-insert', function(e,task_to_be_added) {
         task_to_be_added.fadeIn('slow');
       })
-      .bind('cocoon:after-insert', function(e, added_task) {
+      .on('cocoon:after-insert', function(e, added_task) {
         // e.g. set the background of inserted task
         added_task.css("background","red");
       })
-      .bind('cocoon:before-remove', function(e, task) {
+      .on('cocoon:before-remove', function(e, task) {
         // allow some time for the animation to complete
         $(this).data('remove-timeout', 1000);
         task.fadeOut('slow');

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.2.1

data/app/assets/javascripts/cocoon.js

@@ -7,14 +7,13 @@
     content.replace(reg_exp, with_str);
   }
 
-
   $(document).on('click', '.add_fields', function(e) {
     e.preventDefault();
     var $this                 = $(this),
         assoc                 = $this.data('association'),
         assocs                = $this.data('associations'),
         content               = $this.data('association-insertion-template'),
-        insertionMethod       = $this.data('association-insertion-method') || $this.data('association-insertion-position') || 'before';
+        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 + '\\](.*?\\s)', 'g'),
@@ -34,7 +33,7 @@
 
     if (insertionNode){
       if (insertionTraversal){
-        insertionNode = $this[insertionTraversal](insertionNode)
+        insertionNode = $this[insertionTraversal](insertionNode);
       } else {
         insertionNode = insertionNode == "this" ? $this : $(insertionNode);
       }
@@ -54,7 +53,6 @@
     insertionNode.trigger('cocoon:after-insert', [contentNode]);
   });
 
-
   $(document).on('click', '.remove_fields.dynamic, .remove_fields.existing', function(e) {
     var $this = $(this);
     var node_to_delete = $this.closest(".nested-fields");
@@ -64,7 +62,6 @@
 
     trigger_node.trigger('cocoon:before-remove', [node_to_delete]);
 
-
     var timeout = trigger_node.data('remove-timeout') || 0;
 
     setTimeout(function() {
@@ -78,4 +75,6 @@
     }, timeout);
   });
 
+  $('.remove_fields.existing.destroyed').closest('.nested-fields').hide();
+
 })(jQuery);

data/cocoon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cocoon"
-  s.version = "1.2.0"
+  s.version = "1.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Van der Auwera"]
-  s.date = "2013-07-10"
+  s.date = "2013-09-25"
   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

@@ -25,18 +25,23 @@ module Cocoon
         html_options = args[2] || {}
 
         is_dynamic = f.object.new_record?
-        html_options[:class] = [html_options[:class], "remove_fields #{is_dynamic ? 'dynamic' : 'existing'}"].compact.join(' ')
-        hidden_field_tag("#{f.object_name}[_destroy]") + link_to(name, '#', html_options)
+
+        classes = []
+        classes << "remove_fields"
+        classes << (is_dynamic ? 'dynamic' : 'existing')
+        classes << 'destroyed' if f.object.marked_for_destruction?
+        html_options[:class] = [html_options[:class], classes.join(' ')].compact.join(' ')
+        hidden_field_tag("#{f.object_name}[_destroy]", f.object._destroy) + link_to(name, '#', html_options)
       end
     end
 
     # :nodoc:
-    def render_association(association, f, new_object, render_options={}, custom_partial=nil)
+    def render_association(association, f, new_object, form_name, render_options={}, custom_partial=nil)
       partial = get_partial_path(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|
-        partial_options = {:f => builder, :dynamic => true}.merge(locals)
+        partial_options = {form_name.to_sym => builder, :dynamic => true}.merge(locals)
         render(partial, partial_options)
       end
     end
@@ -50,8 +55,9 @@ 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!!!*
+    #          - *:wrap_object*    : a proc that will allow to wrap your object, especially suited when using
+    #                                decorators, or if you want special initialisation   
+    #          - *:form_name*      : the parameter for the form in the nested form partial. Default `f`.
     # - *&block*:        see <tt>link_to</tt>
 
     def link_to_add_association(*args, &block)
@@ -71,6 +77,7 @@ module Cocoon
         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
+        form_parameter_name = html_options.delete(:form_name) || 'f'
 
         html_options[:class] = [html_options[:class], "add_fields"].compact.join(' ')
         html_options[:'data-association'] = association.to_s.singularize
@@ -79,7 +86,7 @@ module Cocoon
         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
+        html_options[:'data-association-insertion-template'] = CGI.escapeHTML(render_association(association, f, new_object, form_parameter_name, render_options, override_partial)).html_safe
 
         link_to(name, '#', html_options )
       end
@@ -111,12 +118,18 @@ module Cocoon
       if instance.class.name == "Mongoid::Relations::Metadata" || force_non_association_create
         create_object_with_conditions(instance)
       else
+        assoc_obj = nil
+
         # assume ActiveRecord or compatible
         if instance.collection?
-          f.object.send(association).build
+          assoc_obj = f.object.send(association).build
+          f.object.send(association).delete(assoc_obj)
         else
-          f.object.send("build_#{association}")
+          assoc_obj = f.object.send("build_#{association}")
+          f.object.send(association).delete
         end
+
+        assoc_obj
       end
     end
 

data/spec/cocoon_spec.rb

@@ -44,7 +44,7 @@ describe Cocoon do
       context "and explicitly specifying the wanted partial" do
         before do
           @tester.unstub(:render_association)
-          @tester.should_receive(:render_association).with(anything(), anything(), anything(), anything(), "shared/partial").and_return('partiallll')
+          @tester.should_receive(:render_association).with(anything(), anything(), anything(), "f", anything(), "shared/partial").and_return('partiallll')
           @html = @tester.link_to_add_association('add something', @form_obj, :comments, :partial => "shared/partial")
         end
 
@@ -53,7 +53,7 @@ describe Cocoon do
 
       it "gives an opportunity to wrap/decorate created objects" do
         @tester.unstub(:render_association)
-        @tester.should_receive(:render_association).with(anything(), anything(), kind_of(CommentDecorator), anything(), anything()).and_return('partiallll')
+        @tester.should_receive(:render_association).with(anything(), anything(), kind_of(CommentDecorator), "f", anything(), anything()).and_return('partiallll')
         @tester.link_to_add_association('add something', @form_obj, :comments, :wrap_object => Proc.new {|comment| CommentDecorator.new(comment) })
       end
 
@@ -128,7 +128,7 @@ describe Cocoon do
       context "and explicitly specifying the wanted partial" do
         before do
           @tester.unstub(:render_association)
-          @tester.should_receive(:render_association).with(anything(), anything(), anything(), anything(), "shared/partial").and_return('partiallll')
+          @tester.should_receive(:render_association).with(anything(), anything(), anything(), "f", anything(), "shared/partial").and_return('partiallll')
           @html = @tester.link_to_add_association( @form_obj, :comments, :class => 'floppy disk', :partial => "shared/partial") do
             "some long name"
           end
@@ -163,7 +163,7 @@ describe Cocoon do
     context "with extra render-options for rendering the child relation" do
       context "uses the correct plural" do
         before do
-          @tester.should_receive(:render_association).with(:people, @form_obj, anything, {:wrapper => 'inline'}, nil)
+          @tester.should_receive(:render_association).with(:people, @form_obj, anything, "f", {:wrapper => 'inline'}, nil)
           @html = @tester.link_to_add_association('add something', @form_obj, :people, :render_options => {:wrapper => 'inline'})
         end
         it_behaves_like "a correctly rendered add link", {association: 'person', associations: 'people' }
@@ -193,6 +193,17 @@ describe Cocoon do
       end
     end
 
+    context "overruling the form parameter name" do
+      context "when given a form_name it passes it correctly to the partials" do
+        before 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", {:people_form => nil, :dynamic=>true}).and_return ("partiallll")
+          @html = @tester.link_to_add_association('add something', @form_obj, :people, :form_name => 'people_form')
+        end
+        it_behaves_like "a correctly rendered add link", {template: 'partiallll', association: 'person', associations: 'people' }
+      end
+    end
 
 
     context "when using formtastic" do
@@ -241,6 +252,7 @@ describe Cocoon do
           removed = doc.at('input')
           removed.attribute('id').value.should == "Post__destroy"
           removed.attribute('name').value.should == "Post[_destroy]"
+          removed.attribute('value').value.should == "false"
         end
 
         it_behaves_like "a correctly rendered remove link", {}
@@ -255,6 +267,27 @@ describe Cocoon do
 
     end
 
+    # this is needed when due to some validation error, objects that
+    # were already marked for destruction need to remain hidden
+    context "for a object marked for destruction" do
+      before do
+        @post_marked_for_destruction = Post.new
+        @post_marked_for_destruction.mark_for_destruction
+        @form_obj_destroyed = double(:object => @post_marked_for_destruction, :object_name => @post_marked_for_destruction.class.name)
+        @html = @tester.link_to_remove_association('remove something', @form_obj_destroyed)
+      end
+
+      it "is rendered inside a input element" do
+        doc = Nokogiri::HTML(@html)
+        removed = doc.at('input')
+        removed.attribute('id').value.should == "Post__destroy"
+        removed.attribute('name').value.should == "Post[_destroy]"
+        removed.attribute('value').value.should == "true"
+      end
+
+      it_behaves_like "a correctly rendered remove link", {class: 'remove_fields dynamic destroyed'}
+    end
+
     context "with a block" do
       context "the block gives the name" do
         before do
@@ -287,11 +320,15 @@ describe Cocoon do
       end
       result = @tester.create_object(@form_obj, :admin_comments)
       result.author.should == "Admin"
+      @form_obj.object.admin_comments.should be_empty
     end
 
     it "creates correct association for belongs_to associations" do
-      result = @tester.create_object(double(:object => Comment.new), :post)
+      comment  = Comment.new
+      form_obj = double(:object => Comment.new)
+      result   = @tester.create_object(form_obj, :post)
       result.should be_a Post
+      comment.post.should be_nil
     end
 
     it "raises an error if cannot reflect on association" do

data/spec/dummy/config/environments/development.rb

@@ -6,8 +6,7 @@ Dummy::Application.configure do
   # since you don't have to restart the webserver when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  config.eager_load = false
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true

data/spec/dummy/config/environments/production.rb

@@ -4,6 +4,7 @@ Dummy::Application.configure do
   # The production environment is meant for finished, "live" apps.
   # Code is not reloaded between requests
   config.cache_classes = true
+  config.eager_load = true
 
   # Full error reports are disabled and caching is turned on
   config.consider_all_requests_local       = false

data/spec/dummy/config/environments/test.rb

@@ -6,9 +6,7 @@ Dummy::Application.configure do
   # your test database is "scratch space" for the test suite and is wiped
   # and recreated between test runs.  Don't rely on the data there!
   config.cache_classes = true
-
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  config.eager_load = false
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoon
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -270,7 +270,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 171754953178404834
+      hash: -3336163965730752832
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: