cocoon 1.0.14 → 1.0.15

data/Gemfile.lock

@@ -1,97 +1,114 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.8)
-      actionpack (= 3.0.8)
-      mail (~> 2.2.19)
-    actionpack (3.0.8)
-      activemodel (= 3.0.8)
-      activesupport (= 3.0.8)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.8)
-      activesupport (= 3.0.8)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.8)
-      activemodel (= 3.0.8)
-      activesupport (= 3.0.8)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.8)
-      activemodel (= 3.0.8)
-      activesupport (= 3.0.8)
-    activesupport (3.0.8)
-    arel (2.0.10)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    generator_spec (0.8.3)
-      rails (~> 3.0)
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
+      mail (~> 2.3.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    generator_spec (0.8.4)
+      rails (>= 3.0, < 4.0)
       rspec-rails
     git (1.2.5)
-    i18n (0.5.0)
+    hike (1.2.1)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json_pure (1.5.2)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    json (1.6.3)
+    json_pure (1.6.3)
+    mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.1)
-    rack (1.2.3)
-    rack-mount (0.6.14)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-test (0.5.7)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.8)
-      actionmailer (= 3.0.8)
-      actionpack (= 3.0.8)
-      activerecord (= 3.0.8)
-      activeresource (= 3.0.8)
-      activesupport (= 3.0.8)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
       bundler (~> 1.0)
-      railties (= 3.0.8)
-    railties (3.0.8)
-      actionpack (= 3.0.8)
-      activesupport (= 3.0.8)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    rspec-rails (2.6.1)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
       actionpack (~> 3.0)
       activesupport (~> 3.0)
       railties (~> 3.0)
-      rspec (~> 2.6.0)
-    simplecov (0.4.2)
-      simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.5)
-    sqlite3 (1.3.3)
+      rspec (~> 2.7.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
     thor (0.14.6)
-    treetop (1.4.9)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.28)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby

data/History.md

@@ -1,5 +1,12 @@
 # Change History / Release Notes
 
+## Version 1.0.15
+
+* added `data-association-insertion-method` that gives more control over where to insert the new nested fields.
+  It takes a jquery method as parameter that inserts the new data. `before`, `after`, `append`, `prepend`, etc. Default: `before`.
+* `data-association-insertion-position` is still available and acts as an alias. Probably this will be deprecated in the future.
+
+
 ## Version 1.0.14
 
 * When playing with `simple_form` and `twitter-bootstrap`, I noticed it is crucial that I call the correct nested-fields function.
@@ -29,6 +36,7 @@ If you are using rails < 3.1, you should run
 
 to install the new `cocoon.js` to your `public/javascripts` folder.
 
+
 ## Version 1.0.11
 
 

data/README.markdown

@@ -22,29 +22,39 @@ I have a sample project where I demonstrate the use of cocoon with formtastic.
 
 Inside your `Gemfile` add the following:
 
-    gem "cocoon"
+````ruby
+gem "cocoon"
+````
 
 ### Rails 3.1
 
 Add the following to `application.js` so it compiles to the
 asset_pipeline
 
-`//= require cocoon`
+````ruby
+//= require cocoon
+````
 
 ### Rails 3.x
 
 If you are using Rails 3.0.x, you need to run the installation task (since rails 3.1 this is no longer needed):
 
-    rails g cocoon:install
+````ruby
+rails g cocoon:install
+````
 
 This will install the needed javascript file.
 Inside your `application.html.haml` you will need to add below the default javascripts:
 
-    = javascript_include_tag :cocoon
+````haml
+= javascript_include_tag :cocoon
+````
 
 or using erb, you write
 
-    <%= javascript_include_tag :cocoon %>
+````ruby
+<%= javascript_include_tag :cocoon %>
+````
 
 That is all you need to do to start using it!
 
@@ -52,22 +62,28 @@ That is all you need to do to start using it!
 
 Suppose you have a model `Project`:
 
-    rails g scaffold Project name:string description:string
+````ruby
+rails g scaffold Project name:string description:string
+````
 
 and a project has many `tasks`:
 
-    rails g model Task description:string done:boolean project_id:integer
+````ruby
+rails g model Task description:string done:boolean project_id:integer
+````
 
 Edit the models to code the relation:
 
-    class Project < ActiveRecord::Base
-      has_many :tasks
-      accepts_nested_attributes_for :tasks
-    end
+````ruby
+class Project < ActiveRecord::Base
+  has_many :tasks
+  accepts_nested_attributes_for :tasks, :reject_if => :all_blank, :allow_destroy => true
+end
 
-    class Task < ActiveRecord::Base
-      belongs_to :project
-    end
+class Task < ActiveRecord::Base
+  belongs_to :project
+end
+````
 
 What we want to achieve is to get a form where we can add and remove the tasks dynamically.
 What we need for this, is that the fields for a new/existing `task` are defined in a partial
@@ -79,25 +95,29 @@ We will show the sample usage with the different possible form-builders.
 
 Inside our `projects/_form` partial we then write:
 
-    - f.inputs do
-      = f.input :name
-      = f.input :description
-      %h3 Tasks
-      #tasks
-        = f.semantic_fields_for :tasks do |task|
-          = render 'task_fields', :f => task
-        .links
-          = link_to_add_association 'add task', f, :tasks
-      -f.buttons do
-        = f.submit 'Save'
+````haml
+- f.inputs do
+  = f.input :name
+  = f.input :description
+  %h3 Tasks
+  #tasks
+    = f.semantic_fields_for :tasks do |task|
+      = render 'task_fields', :f => task
+    .links
+      = link_to_add_association 'add task', f, :tasks
+  -f.buttons do
+    = f.submit 'Save'
+````
 
 and inside the `_task_fields` partial we write:
 
-    .nested-fields
-      = f.inputs do
-        = f.input :description
-        = f.input :done, :as => :boolean
-        = link_to_remove_association "remove task", f
+````haml
+.nested-fields
+  = f.inputs do
+    = f.input :description
+    = f.input :done, :as => :boolean
+    = link_to_remove_association "remove task", f
+````
 
 That is all there is to it!
 
@@ -129,9 +149,11 @@ 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 two extra options that allow to conrol the placement of the new link-data:
+  There are three extra options that allow to control the placement of the new link-data:
   - `data-association-insertion-node` : the jquery selector of the node
-  - `data-association-insertion-position` : insert the new data `before` or `after` the given 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.
 
 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).
 
@@ -153,55 +175,61 @@ Inside the `html_options` you can add an option `:render_options`, and the conta
 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:
 
-    = link_to_add_association 'add something', f, :something, :render_options => {:wrapper => 'inline' }
-
+````haml
+= link_to_add_association 'add something', f, :something, :render_options => {:wrapper => 'inline' }
+````
 
 ### Callbacks (upon insert and remove of items)
 
-There is an option to add a callback on insertion or removal. If in your view you have the following snippet to select an `onwer`
+There is an option to add a callback on insertion or removal. If in your view you have the following snippet to select an `owner`
 (we use slim for demonstration purposes)
 
-      #owner
-        #owner_from_list
-          = f.association :owner, :collection => Person.all(:order => 'name'), :prompt => 'Choose an existing owner'
-        = link_to_add_association 'add a new person as owner', f, :owner
+````haml
+#owner
+  #owner_from_list
+    = f.association :owner, :collection => Person.all(:order => 'name'), :prompt => 'Choose an existing owner'
+  = link_to_add_association 'add a new person as owner', f, :owner
+````
 
 This view part will either let you select an owner from the list of persons, or show the fields to add a new person as owner.
 
 
 The callbacks can be added as follows:
 
-    $(document).ready(function() {
-        $('#owner').bind('insertion-callback',
-             function() {
-               $("#owner_from_list").hide();
-               $("#owner a.add_fields").hide();
-             });
-        $('#owner').bind("removal-callback",
-             function() {
-               $("#owner_from_list").show();
-               $("#owner a.add_fields").show();
-             });
-    });
+````javascript
+$(document).ready(function() {
+    $('#owner').bind('insertion-callback',
+         function() {
+           $("#owner_from_list").hide();
+           $("#owner a.add_fields").hide();
+         });
+    $('#owner').bind("removal-callback",
+         function() {
+           $("#owner_from_list").show();
+           $("#owner a.add_fields").show();
+         });
+});
+````
 
 Do note that for the callbacks to work there has to be a surrounding container (div), where you can bind the callbacks to.
 
 ### 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 -location.
+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.
 
 For example:
 
-    $(document).ready(function() {
-        $("#owner a.add_fields").
-          data("association-insertion-position", 'before').
-          data("association-insertion-node", 'this');
-    });
-
+````javascript
+$(document).ready(function() {
+    $("#owner a.add_fields").
+      data("association-insertion-method", 'before').
+      data("association-insertion-node", 'this');
+});
+````
 
 The `association-insertion-node` will determine where to add it. You can choose any selector here, or specify this (default it is the parent-container).
 
-The `association-insertion-position` will determine where to add it in relation with the node. Only two options: `before` or `after`.
+The `association-insertion-method` will determine where to add it in relation with the node. Any jQuery DOM Manipulation method can be set but we recommend sticking to any of the following: `before`, `after`, `append`, `prepend`. It is unknown at this time what others would do.
 
 
 ### Partial
@@ -224,7 +252,7 @@ There is no limit to the amount of nesting, though.
 
 ## Todo
 
-* add more sample relations: has_many :through, belongs_to, ...
+* add more sample relations: `has_many :through`, `belongs_to`, ...
 * improve the tests (test the javascript too)(if anybody wants to lend a hand ...?)
 
 ## Copyright

data/VERSION

@@ -1 +1 @@
-1.0.14
+1.0.15

data/app/assets/javascripts/cocoon.js

@@ -11,56 +11,58 @@
 
   $('.add_fields').live('click', function(e) {
     e.preventDefault();
-    var assoc   = $(this).data('association'),
-        assocs  = $(this).data('associations'),
-        content = $(this).data('template'),
-        insertionPosition = $(this).data('association-insertion-position'),
-        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(),
-        newcontent_braced = '[' + new_id + ']',
+    var $this                 = $(this),
+        assoc                 = $this.data('association'),
+        assocs                = $this.data('associations'),
+        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(),
+        newcontent_braced     = '[' + new_id + ']',
         newcontent_underscord = '_' + new_id + '_',
-        new_content = content.replace(regexp_braced, '[' + new_id + ']');
+        new_content           = content.replace(regexp_braced, '[' + new_id + ']');
 
     if (new_content == content) {
-        regexp_braced = new RegExp('\\[new_' + assocs + '\\]', 'g');
+        regexp_braced     = new RegExp('\\[new_' + assocs + '\\]', 'g');
         regexp_underscord = new RegExp('_new_' + assocs + '_', 'g');
-        new_content = content.replace(regexp_braced, '[' + new_id + ']');
+        new_content       = content.replace(regexp_braced, '[' + new_id + ']');
     }
 
     new_content = new_content.replace(regexp_underscord, newcontent_underscord);
 
     if (insertionNode){
-      insertionNode = insertionNode == "this" ? $(this) : $(insertionNode);
+      insertionNode = insertionNode == "this" ? $this : $(insertionNode);
     } else {
-      insertionNode = $(this).parent();
+      insertionNode = $this.parent();
     }
 
     var contentNode = $(new_content);
 
-    if (insertionPosition == 'after'){
-      insertionNode.after(contentNode);
-    } else {
-      insertionNode.before(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);
 
-    $(this).parent().trigger('insertion-callback');
+    $this.parent().trigger('insertion-callback');
   });
 
   $('.remove_fields.dynamic').live('click', function(e) {
-    trigger_removal_callback($(this));
+    var $this = $(this);
+    trigger_removal_callback($this);
     e.preventDefault();
-    $(this).closest(".nested-fields").remove();
+    $this.closest(".nested-fields").remove();
   });
 
   $('.remove_fields.existing').live('click', function(e) {
-    trigger_removal_callback($(this));
+    var $this = $(this);
+    trigger_removal_callback($this);
     e.preventDefault();
-    $(this).prev("input[type=hidden]").val("1");
-    $(this).closest(".nested-fields").hide();
+    $this.prev("input[type=hidden]").val("1");
+    $this.closest(".nested-fields").hide();
   });
 
 })(jQuery);

data/cocoon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cocoon}
-  s.version = "1.0.14"
+  s.version = "1.0.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Van der Auwera"]
-  s.date = %q{2011-10-22}
+  s.date = %q{2011-12-08}
   s.description = %q{Unobtrusive nested forms handling, using jQuery. Use this and discover cocoon-heaven.}
   s.email = %q{nathan@dixis.com}
   s.extra_rdoc_files = [

data/spec/generators/install_generator_spec.rb

@@ -1,4 +1,7 @@
 require 'spec_helper'
+require 'rspec/mocks'
+require 'rspec/rails/mocks'
+
 require 'generator_spec/test_case'
 require 'generators/cocoon/install/install_generator'
 
@@ -9,18 +12,18 @@ describe Cocoon::Generators::InstallGenerator do
 
   context "in rails 3.0" do
     context "with no arguments" do
-      before(:all) do
+      before(:each) do
         ::Rails.stub(:version) { '3.0.8' }
         prepare_destination
         run_generator
       end
 
       it "stubs the version correctly" do
-        Rails.version[0..2].should == "3.0"
+        ::Rails.version[0..2].should == "3.0"
       end
 
       it "stubs the version correctly" do
-        test_version = (Rails.version[0..2].to_f >= 3.1)
+        test_version = (::Rails.version[0..2].to_f >= 3.1)
         test_version.should be_false
       end
 
@@ -32,7 +35,7 @@ describe Cocoon::Generators::InstallGenerator do
 
   context "in rails 3.1" do
     context "with no arguments" do
-      before(:all) do
+      before(:each) do
         ::Rails.stub(:version) { '3.1.0' }
         prepare_destination
         run_generator

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ end
 
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
 require "rspec/rails"
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cocoon
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 1
   - 0
-  - 14
-  version: 1.0.14
+  - 15
+  version: 1.0.15
 platform: ruby
 authors: 
 - Nathan Van der Auwera
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-22 00:00:00 +02:00
+date: 2011-12-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency