cocooned 1.3.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff5fc052a1bf37f18e1f22b550f35bf876e0cc09c4c7d4ebef3667c7afde67a
-  data.tar.gz: 55202ea14bda345f2ed5f20fc95ebb0de1bfa7831e9f70ba92b2a092c7ca210b
+  metadata.gz: 92137d75843c047e0aa1ffe5f385217e4ead03225356dc69d205320f948baa06
+  data.tar.gz: 4ad82cd191b91ed1d6f313fac56a66b6824bc0c2a0f11056247048d33988d92a
 SHA512:
-  metadata.gz: ed672de23fce13326d63cb1e943689ea8f4df8be8873111daecb9a25df954ee06a47592a6b28399c95120e6079337c26125838b42a868395e0d5639d08461569
-  data.tar.gz: 23b8d0ab6bdfda55e974f322bec4a0a39a9fd089f9bfbfa343144ccdc76639560286a4212ac3018e0ee10a567d70b8f363be5c3c3578e5000440de41a2464e04
+  metadata.gz: 02d0e6ea881b5459fa00cb87b8dcba12947805a6bc5a428f0660106dc9d7b0495e18937c50f5fc8fd15d27f994aa0ca5dfe830bfbb22051fbbf7d3a54795041b
+  data.tar.gz: b8a0a3a01e109ab0654fcb3b2aaaf8c166a6292f9ea90459ad88b0fe510ce6aac471f134e169395b9882c43bab79df9bc7cca04bcda13996e0d0f678da02c754

data/History.md

@@ -1,5 +1,35 @@
 # Change History / Release Notes
 
+## Version 2.0.0 (Not released yet)
+
+* Remove dependency to jQuery
+
+## Version 1.4.0
+
+### Breaking changes
+
+* Drop support for Rails < 5.0 and Ruby < 2.5
+* Pass the original browser event to all event handlers _via_ e.originalEvent. (See [jQuery Event object](https://api.jquery.com/category/events/event-object/)).
+
+### New features
+
+* Add support for @hotwired/turbo
+  
+### Bug fixes and other changes
+
+* Prevent side effects on options passed to view helpers.
+* Use form builder to add the hidden `_destroy` field instead of `hidden_field`.
+* Update deprecation warnings to postpone compatibility drop with the original `cocoon` to 3.0 (instead of 2.0)
+
+## Version 1.3.2
+
+* Compatibility with Mongoid 7+
+
+## Version 1.3.1
+
+* Use UMD pattern to load the Cocooned module
+* Now publish packages on both rubygems.org and npmjs.com
+
 ## Version 1.3.0
 
 ### Breaking changes

data/README.md

@@ -4,26 +4,21 @@
 
 Cocooned makes it easier to handle nested forms in a Rails project.
 
-Cocooned is form builder-agnostic: it works with standard Rails (>= 4.0, < 6.0), [Formtastic](https://github.com/justinfrench/formtastic) or [SimpleForm](https://github.com/plataformatec/simple_form).
+Cocooned is form builder-agnostic: it works with standard Rails (>= 5.0, < 7.0) form helpers, [Formtastic](https://github.com/justinfrench/formtastic) or [SimpleForm](https://github.com/plataformatec/simple_form).
 
 ## Some Background
 
-Cocooned is a fork of [Cocoon](https://github.com/nathanvda/cocoon) by [Nathan Van der Auwera](https://github.com/nathanvda).
+Cocooned is a fork of [Cocoon](https://github.com/nathanvda/cocoon) by [Nathan Van der Auwera](https://github.com/nathanvda). He and all Cocoon contributors did a great job to maintain it for years. Many thanks to them!
 
-He and all Cocoon contributors did a great job to maintain it for years. Many thanks to them!
+However, the project seems to have only received minimal fixes since 2018 and many pull requests, even simple ones, have been on hold for a long time. In 2019, as I needed a more than what Cocoon provided at this time, I had the choice to either maintain an extension or to fork it and integrate everything that was waiting and more.
 
-But last time I checked, the project seemed to not have been actively maintained for a long time and many pull requests, even simple ones, were on hold. As I needed a more than what Cocoon provided at this time, I had the choice to either maintain an extension or to fork it and integrate everything that was waiting and more.
+Cocooned is almost a complete rewrite of Cocoon, with more functionnalities, a more fluent API (I hope) and integration with modern toolchains (including webpacker).
 
-Cocooned is almost a complete rewrite of Cocoon, with more functionnalities and (I hope) a more fluent API.
+**For now, Cocooned is completely compatible with Cocoon and can be used as a drop-in replacement** as long as we talk about Ruby code. Just change the name of the gem in your Gemfile and you're done. It will work the same (but will add a bunch of deprecation warning to your logs).
 
-**For now, Cocooned is completely compatible with Cocoon and can be used as a drop-in replacement.**  
-Just change the name of the gem in your Gemfile and you're done. It will work the same (but will add a bunch of deprecation warning to your logs).
+**This compatibility layer with the original Cocoon API will be dropped in Cocooned 3.0.**
 
-**The compatibility layer with the original Cocoon API will be dropped in Cocooned 2.0.**
-
-## Prerequisites
-
-Cocooned depends on jQuery, Ruby (>= 2.2) and Rails (>= 4.0, < 6.0).
+On the JavaScript side, Cocoon 1.2.13 introduced the original browser event as a third parameter to all event handlers. Meanwhile, Cocooned already started to use this positional parameter to pass the Cocooned object instance (since 1.3.0). To get access to the original event, [you'll have to change your handlers and use `event.originalEvent`](#javascript-callbacks).
 
 ## Installation
 
@@ -33,7 +28,11 @@ Inside your `Gemfile` add the following:
 gem "cocooned"
 ```
 
-You must also require `cocooned` in your `application.js` and `application.css`, so it compiles with the asset pipeline.
+### Load Cocooned styles and scripts
+
+If you use Sprockets, you have to require `cocooned` in your `application.js` and `application.css`, so it compiles with the asset pipeline.
+
+If you use Yarn to manage your non-Ruby dependencies and/or Webpack to build your assets, you can install the [`@notus.sh/cocooned` companion package](https://www.npmjs.com/package/@notus.sh/cocooned).
 
 ## Usage
 
@@ -68,28 +67,34 @@ E.g. in your `ListsController`:
   end
 ```
 
-### Basic form
+### Has One Gotcha
+
+If you have a `has_one` association, then you (probably) need to set `force_non_association_create: true` on `link_to_add_association` or the associated object will be destroyed every time the edit form is rendered (which is probably not what you expect).
 
-_Please note examples in this section are written with the [`haml` templating language](http://haml.info/)._
+See the [original merge request](https://github.com/nathanvda/cocoon/pull/247) for more details.
+
+### Basic form
 
 [Rails natively supports nested forms](https://guides.rubyonrails.org/form_helpers.html#nested-forms) but does not support adding or removing nested items.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |f|
-  = f.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |f| %>
+  <%= f.input :name %>
   
-  %h3 Items
-  = f.fields_for :tasks do |item_form|
-    / This block is repeated for every task in @list.items
-    = item_form.label :description
-    = item_form.text_field :description
-    = item_form.check_box :done
-    
-  = f.submit "Save"
+  <h3>Items</h3>
+  <%= f.fields_for :tasks do |item_form| %>
+    <% # This block is repeated for every task in @list.items %>
+    <%= item_form.label :description %>
+    <%= item_form.text_field :description %>
+    <%= item_form.check_box :done %>
+  <% end %>
+  
+  <%= f.submit "Save" %>
+<% end %>
 ```
 
-To enable Cocooned on this first, we need to:
+To enable Cocooned on this form, we need to:
 
 1. Move the nested form to a partial
 2. Add a way to add a new item to the collection
@@ -102,78 +107,91 @@ Let's do it.
 
 We now have two files:
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  = form.fields_for :items do |item_form|
-    = render 'item_fields', f: item_form
+  <h3>Items</h3>
+  <%= form.fields_for :items do |item_form|
+    <%= render 'item_fields', f: item_form %>
+  <% end %>
     
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
-```haml
-/ `app/views/lists/_item_fields.html.haml`
-= f.label :description
-= f.text_field :description
-= f.check_box :done
+```erb
+<% # `app/views/lists/_item_fields.html.erb` %>
+<%= f.label :description %>
+<%= f.text_field :description %>
+<%= f.check_box :done %>
 ```
 
 #### 2. Add a way to add a new item to the collection
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  #items
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+  <h3>Items</h3>
+  <div id="items">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
   
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
 By default, a new item will be inserted just before the immediate parent of the 'Add an item' link. You can have a look at the documentation of `cocooned_add_item_link` for more information about how to change that but we'll keep it simple for now.
 
 #### 3. Add a way to remove an item from the collection
 
-```haml
-/ `app/views/lists/_item_fields.html.haml`
-.cocooned-item
-  = f.label :description
-  = f.text_field :description
-  = f.check_box :done
-  = cocooned_remove_item_link 'Remove', f
+```erb
+<% # `app/views/lists/_item_fields.html.erb` %>
+<div class="cocooned-item">
+  <%= f.label :description %>
+  <%= f.text_field :description %>
+  <%= f.check_box :done %>
+  <%= cocooned_remove_item_link 'Remove', f %>
+</div>
 ```
 
-The `.cocooned-item` class is required for the `cocooned_remove_item_link` to work correctly.
+The `cocooned-item` class is required for the `cocooned_remove_item_link` to work correctly.
 
 #### 4. Initialize Cocooned to handle this form
 
 Cocooned will detect on page load forms it should handle and initialize itself.
 This detection is based on the presence of a `data-cocooned-options` attribute on the nested forms container.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  #items{ :data => { cocooned_options: {}.to_json } }
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+  <h3>Items</h3>
+  <div id="items" data-cocooned-options="<%= {}.to_json %>">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
   
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+</div>
 ``` 
 
-And we're done!
+You're done!
 
 ### Wait, what's the point of `data-cocooned-options` if it's to be empty?
 
@@ -188,52 +206,63 @@ For now, Cocooned supports two plugins:
 
 The limit plugin is autoloaded when needed and does not require anything more than you specifiying the maximum number of items allowed in the association.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  #items{ :data => { cocooned_options: { limit: 12 }.to_json } }
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+  <h3>Items</h3>
+  <div id="items" data-cocooned-options="<%= { limit: 12 }.to_json %>">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
   
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
 #### The reorderable plugin
 
 The reorderable plugin is autoloaded when activated and does not support any particular options.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
-  
-  %h3 Items
-  #items{ :data => { cocooned_options: { reorderable: true }.to_json } }
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+```erb
+<% # `app/views/lists/_form.html.haml` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  = form.submit "Save"
+  <h3>Items</h3>
+  <div id="items" data-cocooned-options="<%= { reorderable: true }.to_json %>">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
+    
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
 However, you need to edit your nested partial to add the links that allow your users to move an item up or down in the collection and to add a `position` field.
 
-```haml
-/ `app/views/lists/_item_fields.html.haml`
-.cocooned-item
-  = f.label :description
-  = f.text_field :description
-  = f.check_box :done
-  = f.hidden_field :position
-  = cocooned_move_item_up_link 'Up', f
-  = cocooned_move_item_down_link 'Down', f
-  = cocooned_remove_item_link 'Remove', f
+```erb
+<% # `app/views/lists/_item_fields.html.erb` %>
+<div class="cocooned-item">
+  <%= f.label :description %>
+  <%= f.text_field :description %>
+  <%= f.check_box :done %>
+  <%= f.hidden_field :position %>
+  <%= cocooned_move_item_up_link 'Up', f %>
+  <%= cocooned_move_item_down_link 'Down', f %>
+  <%= cocooned_remove_item_link 'Remove', f %>
+</div>
 ```
 
 Also, remember the strong parameters gotcha we mentioned earlier.
@@ -284,6 +313,7 @@ The event `event` is an instance of `jQuery.Event` and carry some additional dat
 * `event.node`, the nested item that will be added, removed or moved, as a jQuery object. This is null for `cocooned:limit-reached` and `cocooned:*-reindex` events
 * `event.nodes`, the nested items that will be or just have been reindexed on `cocooned:*-reindex` events, as a jQuery object. Null otherwise. 
 * `event.cocooned`, the Cocooned javascript object instance handling the nested association.
+* `event.originalEvent`, the original (browser) event.
 
 The `node` argument is the same jQuery object as `event.node`.
 The `cocooned` argument is the same as `event.cocooned`.

data/Rakefile

@@ -20,6 +20,8 @@ RuboCop::RakeTask.new do |task|
 end
 
 # JavaScript
+# rubocop:disable Rails/RakeEnvironment
+# eslint related tasks does not need to load Rails environment
 eslint_args = ['--no-eslintrc', '--config config/linters/js.json']
 eslint_path = ['app/assets/**/*.js', 'spec/javascripts/**/*.js', 'spec/dummy/app/assets/**/*.js']
 
@@ -34,6 +36,7 @@ desc 'Run eslint'
 task :eslint do
   system("yarnpkg run eslint #{eslint_args.join(' ')} #{eslint_path.join(' ')}")
 end
+# rubocop:enable Rails/RakeEnvironment
 
 # Both
 namespace :linters do
@@ -69,6 +72,8 @@ npm_files = {
 }
 
 namespace :npm do
+  # rubocop:disable Rails/RakeEnvironment
+  # npm related tasks does not need to load Rails environment
   npm_files.each do |dest, src|
     file dest => src do
       cp src, dest
@@ -79,6 +84,7 @@ namespace :npm do
     contributors = []
     spec.authors.each_with_index do |name, i|
       next if spec.email[i].nil?
+
       contributors << {
         name: name.dup.force_encoding('UTF-8'),
         email: spec.email[i].dup.force_encoding('UTF-8')
@@ -100,6 +106,7 @@ namespace :npm do
   task release: %i[build] do
     system("npm publish ./pkg/#{npm_scope}-#{spec.name}-#{spec.version}.tgz --access public")
   end
+  # rubocop:enable Rails/RakeEnvironment
 end
 
 desc 'Build packages and push them to their respective repository'

data/app/assets/javascripts/cocoon.js

@@ -2,7 +2,7 @@
 //= require 'cocooned'
 
 // Compatibility with the original Cocoon
-// TODO: Remove in 2.0
+// TODO: Remove in 3.0
 function initCocoon () {
   $(Cocooned.prototype.selector('add')).each(function (_i, addLink) {
     var container = Cocooned.prototype.findContainer(addLink);

data/app/assets/javascripts/cocooned.js

@@ -1,5 +1,7 @@
 /* globals define */
 
+// Use Universal Module Definition pattern to load Cocooned
+// See https://github.com/umdjs/umd/blob/master/templates/returnExportsGlobal.js
 (function (root, factory) {
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
@@ -18,24 +20,34 @@
 }(typeof self !== 'undefined' ? self : this, function ($) {
   var Cocooned = function (container, options) {
     this.container = $(container);
-    this.options = $.extend({}, this.defaultOptions(), (options || {}));
+    var opts = $.extend({}, this.defaultOptions(), (options || {}));
 
     // Autoload plugins
-    for (var moduleName in Cocooned.Plugins) {
-      if (Cocooned.Plugins.hasOwnProperty(moduleName)) {
-        var module = Cocooned.Plugins[moduleName];
-        var optionName = moduleName.charAt(0).toLowerCase() + moduleName.slice(1);
-
-        if (this.options[optionName]) {
-          for (var method in module) {
-            if (module.hasOwnProperty(method) && typeof module[method] === 'function') {
-              this[method] = module[method];
+    for (var pluginName in Cocooned.Plugins) {
+      if (Cocooned.Plugins.hasOwnProperty(pluginName)) {
+        var plugin = Cocooned.Plugins[pluginName];
+        var optionName = pluginName.charAt(0).toLowerCase() + pluginName.slice(1);
+
+        if (opts[optionName] !== false) {
+          if (plugin.hasOwnProperty('normalizeConfig') && typeof plugin['normalizeConfig'] === 'function') {
+            opts[optionName] = plugin.normalizeConfig(opts[optionName]);
+          }
+
+          for (var method in plugin) {
+            if (method === 'normalizeConfig') {
+              continue;
             }
+            if (!plugin.hasOwnProperty(method) || typeof plugin[method] !== 'function') {
+              continue;
+            }
+
+            this[method] = plugin[method];
           }
         }
       }
     }
 
+    this.options = opts;
     this.init();
   };
 
@@ -45,13 +57,13 @@
     elementsCounter: 0,
 
     // Compatibility with Cocoon
-    // TODO: Remove in 2.0 (Only Cocoon namespaces).
+    // TODO: Remove in 3.0 (Only Cocoon namespaces).
     namespaces: {
       events: ['cocooned', 'cocoon']
     },
 
     // Compatibility with Cocoon
-    // TODO: Remove in 2.0 (Only Cocoon class names).
+    // TODO: Remove in 3.0 (Only Cocoon class names).
     classes: {
       // Actions link
       add: ['cocooned-add', 'add_fields'],
@@ -208,7 +220,7 @@
       this.container.addClass(this.classes['container'].join(' '));
 
       $(function () { self.hideMarkedForDestruction(); });
-      $(document).on('page:load turbolinks:load', function () { self.hideMarkedForDestruction(); });
+      $(document).on('page:load turbolinks:load turbo:load', function () { self.hideMarkedForDestruction(); });
     },
 
     bindEvents: function () {
@@ -219,7 +231,9 @@
         this.namespacedNativeEvents('click'),
         function (e) {
           e.preventDefault();
-          self.add(this);
+          e.stopPropagation();
+
+          self.add(this, e);
         });
 
       // Bind remove links
@@ -229,7 +243,9 @@
         this.selector('remove', '#' + this.container.attr('id') + ' &'),
         function (e) {
           e.preventDefault();
-          self.remove(this);
+          e.stopPropagation();
+
+          self.remove(this, e);
         });
 
       // Bind options events
@@ -241,7 +257,7 @@
       });
     },
 
-    add: function (adder) {
+    add: function (adder, originalEvent) {
       var $adder = $(adder);
       var insertionMethod = this.getInsertionMethod($adder);
       var insertionNode = this.getInsertionNode($adder);
@@ -250,7 +266,7 @@
 
       for (var i = 0; i < count; i++) {
         var contentNode = this.buildContentNode(contentTemplate);
-        var eventData = { link: $adder, node: contentNode, cocooned: this };
+        var eventData = { link: $adder, node: contentNode, cocooned: this, originalEvent: originalEvent };
         var afterNode = (insertionMethod === 'replaceWith' ? contentNode : insertionNode);
 
         // Insertion can be prevented through a 'cocooned:before-insert' event handler
@@ -264,12 +280,12 @@
       }
     },
 
-    remove: function (remover) {
+    remove: function (remover, originalEvent) {
       var self = this;
       var $remover = $(remover);
       var nodeToDelete = this.findItem($remover);
       var triggerNode = nodeToDelete.parent();
-      var eventData = { link: $remover, node: nodeToDelete, cocooned: this };
+      var eventData = { link: $remover, node: nodeToDelete, cocooned: this, originalEvent: originalEvent };
 
       // Deletion can be prevented through a 'cocooned:before-remove' event handler
       if (!this.notify(triggerNode, 'before-remove', eventData)) {
@@ -314,7 +330,7 @@
         }
 
         e.stopPropagation();
-        var eventData = { link: e.link, node: e.node, cocooned: cocooned };
+        var eventData = { link: e.link, node: e.node, cocooned: cocooned, originalEvent: e };
         cocooned.notify(cocooned.container, 'limit-reached', eventData);
       });
     },
@@ -326,16 +342,24 @@
 
   Cocooned.Plugins.Reorderable = {
 
-    defaultOptionValue: true,
+    defaultOptionValue: false,
+    defaultConfig: { startAt: 1 },
+
+    normalizeConfig: function(config) {
+      if (typeof config === 'boolean' && config) {
+        return this.defaultConfig;
+      }
+      return config;
+    },
 
     bindReorderable: function () {
       var self = this;
 
       // Maintain indexes
       this.container
-        .on('cocooned:after-insert', function (e) { self.reindex(); })
-        .on('cocooned:after-remove', function (e) { self.reindex(); })
-        .on('cocooned:after-move', function (e) { self.reindex(); });
+        .on('cocooned:after-insert', function (e) { self.reindex(e); })
+        .on('cocooned:after-remove', function (e) { self.reindex(e); })
+        .on('cocooned:after-move', function (e) { self.reindex(e); });
 
       // Move items
       this.container.on(
@@ -343,22 +367,24 @@
         [this.selector('up'), this.selector('down')].join(', '),
         function (e) {
           e.preventDefault();
+          e.stopPropagation();
+
           var node = this;
           var up = self.classes['up'].some(function (klass) {
             return node.className.indexOf(klass) !== -1;
           });
-          self.move(this, up ? 'up' : 'down');
+          self.move(this, up ? 'up' : 'down', e);
         });
 
       // Ensure positions are unique before save
       this.container.closest('form').on(
         this.namespacedNativeEvents('submit'),
         function (e) {
-          self.reindex();
+          self.reindex(e);
         });
     },
 
-    move: function (moveLink, direction) {
+    move: function (moveLink, direction, originalEvent) {
       var self = this;
       var $mover = $(moveLink);
       var node = $mover.closest(this.selector('item'));
@@ -371,7 +397,7 @@
       }
 
       // Move can be prevented through a 'cocooned:before-move' event handler
-      var eventData = { link: $mover, node: node, cocooned: this };
+      var eventData = { link: $mover, node: node, cocooned: this, originalEvent: originalEvent };
       if (!self.notify(node, 'before-move', eventData)) {
         return false;
       }
@@ -391,17 +417,17 @@
       });
     },
 
-    reindex: function () {
-      var i = 0;
+    reindex: function (originalEvent) {
+      var i = this.options.reorderable.startAt;
       var nodes = this.getItems('&:visible');
-      var eventData = { link: null, nodes: nodes, cocooned: this };
+      var eventData = { link: null, nodes: nodes, cocooned: this, originalEvent: originalEvent };
 
       // Reindex can be prevented through a 'cocooned:before-reindex' event handler
       if (!this.notify(this.container, 'before-reindex', eventData)) {
         return false;
       }
 
-      nodes.each(function () { $('input[id$=_position]', this).val(++i); });
+      nodes.each(function () { $('input[id$=_position]', this).val(i++); });
       this.notify(this.container, 'after-reindex', eventData);
     },
 
@@ -433,7 +459,12 @@
         return;
       }
 
-      var cocooned = new Cocooned(container, options);
+      var opts = options;
+      if (typeof container.data('cocooned-options') !== 'undefined') {
+        opts = $.extend(opts, container.data('cocooned-options'));
+      }
+
+      var cocooned = new Cocooned(container, opts);
       container.data('cocooned', cocooned);
     });
   };
@@ -441,7 +472,7 @@
   // On-load initialization
   $(function () {
     $('*[data-cocooned-options]').each(function (i, el) {
-      $(el).cocooned($(el).data('cocooned-options'));
+      $(el).cocooned();
     });
   });
 

data/app/assets/stylesheets/cocoon.css

@@ -2,4 +2,4 @@
  *= require cocooned
  */
 
-/* TODO: Remove in 2.0 */
+/* TODO: Remove in 3.0 */

data/cocooned.gemspec

@@ -11,29 +11,32 @@ Gem::Specification.new do |spec|
   spec.authors      = ['Gaël-Ian Havard', 'Nathan Van der Auwera']
   spec.email        = ['gael-ian@notus.sh', 'nathan@dixis.com']
 
-  spec.summary      = 'Unobtrusive nested forms handling using jQuery.'
+  spec.summary      = 'Unobtrusive Rails nested forms handling, with or without jQuery.'
   spec.description  = 'Easier nested form. Supports standard Rails forms, Formtastic and SimpleForm.'
   spec.homepage     = 'http://github.com/notus-sh/cocooned'
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required.'
-  end
+  raise 'RubyGems 2.0 or newer is required.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.require_paths = ['lib']
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(config|gemfiles|npm|spec)/}) ||
       %w[.gitignore .rspec .travis.yml].include?(f) ||
       %w[Gemfile Gemfile.lock package.json yarn.lock].include?(f)
   end
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_dependency 'rails', '>= 4.0', '<= 6.0'
+  spec.add_dependency 'rails', '>= 5.0', '<= 7.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'jasmine', '~> 3.2'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.8.0'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0.0'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rails'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
 end

data/lib/cocooned/association_builder.rb

@@ -2,9 +2,7 @@
 
 module Cocooned
   class AssociationBuilder
-    attr_accessor :association
-    attr_accessor :form
-    attr_accessor :options
+    attr_accessor :association, :form, :options
 
     def initialize(form, association, options = {})
       self.form = form
@@ -54,11 +52,12 @@ module Cocooned
     def build_without_reflection
       methods = %W[build_#{plural_name} build_#{singular_name}].select { |m| form.object.respond_to?(m) }
       raise "Association #{association} doesn't exist on #{form.object.class}" unless methods.any?
+
       form.object.send(methods.first)
     end
 
     def should_use_conditions?
-      reflection.class.name == 'Mongoid::Relations::Metadata' || @options[:force_non_association_create]
+      reflection.class.name.starts_with?('Mongoid::') || @options[:force_non_association_create]
     end
 
     def build_with_conditions

data/lib/cocooned/helpers/cocoon_compatibility.rb

@@ -7,7 +7,7 @@ module Cocooned
     # Provide aliases to old Cocoon method for backward compatibility.
     # Cocoon methods are deprecated and will be removed in next major release.
     #
-    # TODO: Remove in 2.0
+    # TODO: Remove in 3.0
     module CocoonCompatibility
       extend Cocooned::Helpers::Deprecate
 

data/lib/cocooned/helpers/deprecate.rb

@@ -10,18 +10,18 @@ module Cocooned
     module Deprecate
       extend Gem::Deprecate
 
-      def deprecate_release_message(target_and_name, replacement, release = '2.0', location = nil)
+      module_function
+
+      def deprecate_release_message(target_and_name, replacement, release = '3.0', location = nil)
         [
           "NOTE: #{target_and_name} is deprecated",
           replacement == :none ? ' with no replacement' : "; use #{replacement} instead",
-          format('. It will dissapear in %s.', release),
+          format('. It will dissapear in %<release>s.', release: release),
           location.nil? ? '' : "\n#{target_and_name} called from #{location}"
         ].join.strip
       end
 
-      module_function :deprecate_release_message
-
-      def deprecate_release(name, replacement, release = '2.0')
+      def deprecate_release(name, replacement, release = '3.0')
         class_eval do
           old = "_deprecated_#{name}"
           alias_method old, name
@@ -42,8 +42,6 @@ module Cocooned
           end
         end
       end
-
-      module_function :deprecate_release
     end
   end
 end

data/lib/cocooned/helpers.rb

@@ -5,17 +5,17 @@ require 'cocooned/helpers/cocoon_compatibility'
 require 'cocooned/association_builder'
 
 module Cocooned
-  # TODO: Remove in 2.0 (Only Cocoon class names).
+  # TODO: Remove in 3.0 (Only Cocoon class names).
   HELPER_CLASSES = {
-    add:    ['cocooned-add', 'add_fields'],
-    remove: ['cocooned-remove', 'remove_fields'],
-    up:     ['cocooned-move-up'],
-    down:   ['cocooned-move-down']
+    add: %w[cocooned-add add_fields],
+    remove: %w[cocooned-remove remove_fields],
+    up: %w[cocooned-move-up],
+    down: %w[cocooned-move-down]
   }.freeze
 
-  module Helpers
+  module Helpers # rubocop:disable Metrics/ModuleLength
     # Create aliases to old Cocoon method name
-    # TODO: Remove in 2.0
+    # TODO: Remove in 3.0
     include Cocooned::Helpers::CocoonCompatibility
 
     # Output an action link to add an item in a nested form.
@@ -118,7 +118,7 @@ module Cocooned
       else
         name, form, association, html_options = *args
         html_options ||= {}
-        html_options = html_options.with_indifferent_access
+        html_options = html_options.dup.with_indifferent_access
 
         builder_options = cocooned_extract_builder_options!(html_options)
         render_options = cocooned_extract_render_options!(html_options)
@@ -167,12 +167,12 @@ module Cocooned
       association = form.object.class.to_s.tableize
       return cocooned_remove_item_link(cocooned_default_label(:remove, association), form, html_options) if name.nil?
 
-      html_options[:class] = [html_options[:class], Cocooned::HELPER_CLASSES[:remove]].flatten.compact
-      html_options[:class] << (form.object.new_record? ? 'dynamic' : 'existing')
-      html_options[:class] << 'destroyed' if form.object.marked_for_destruction?
+      link_options = html_options.dup
+      link_options[:class] = [html_options[:class], Cocooned::HELPER_CLASSES[:remove]].flatten.compact
+      link_options[:class] << (form.object.new_record? ? 'dynamic' : 'existing')
+      link_options[:class] << 'destroyed' if form.object.marked_for_destruction?
 
-      hidden_field_tag("#{form.object_name}[_destroy]", form.object._destroy) <<
-        link_to(name, '#', html_options)
+      form.hidden_field(:_destroy, value: form.object._destroy) << link_to(name, '#', link_options)
     end
 
     # Output an action link to move an item up.
@@ -220,12 +220,13 @@ module Cocooned
       return cocooned_move_item_link(direction, capture(&block), form, html_options) if block_given?
       return cocooned_move_item_link(direction, cocooned_default_label(direction), form, html_options) if name.nil?
 
-      html_options[:class] = [html_options[:class], Cocooned::HELPER_CLASSES[direction]].flatten.compact.join(' ')
-      link_to name, '#', html_options
+      link_options = html_options.dup
+      link_options[:class] = [html_options[:class], Cocooned::HELPER_CLASSES[direction]].flatten.compact.join(' ')
+      link_to name, '#', link_options
     end
 
     def cocooned_default_label(action, association = nil)
-      # TODO: Remove in 2.0
+      # TODO: Remove in 3.0
       if I18n.exists?(:cocoon)
         msg = Cocooned::Helpers::Deprecate.deprecate_release_message('the :cocoon i18n scope', ':cocooned')
         warn msg
@@ -239,9 +240,10 @@ module Cocooned
       I18n.translate(keys.take(1).first, default: keys.drop(1))
     end
 
-    def cocooned_render_association(builder, render_options = {})
+    def cocooned_render_association(builder, options = {})
+      render_options = options.dup
       locals = (render_options.delete(:locals) || {}).symbolize_keys
-      partial = render_options.delete(:partial) || builder.singular_name + '_fields'
+      partial = render_options.delete(:partial) || "#{builder.singular_name}_fields"
       form_name = render_options.delete(:form_name)
       form_options = (render_options.delete(:form_options) || {}).symbolize_keys
       form_options.reverse_merge!(child_index: "new_#{builder.association}")
@@ -250,7 +252,6 @@ module Cocooned
                         builder.association,
                         builder.build_object,
                         form_options) do |form_builder|
-
         partial_options = { form_name.to_sym => form_builder, :dynamic => true }.merge(locals)
         render(partial, partial_options)
       end
@@ -312,19 +313,21 @@ module Cocooned
       data.compact
     end
 
-    def cocooned_extract_single_data!(h, key)
+    def cocooned_extract_single_data!(hash, key)
       k = key.to_s
-      return h.delete(k) if h.key?(k)
+      return hash.delete(k) if hash.key?(k)
 
       # Compatibility alternatives
       # TODO: Remove in 2.0
-      return h.delete("association_#{k}") if h.key?("association_#{k}")
-      return h.delete("data_association_#{k}") if h.key?("data_association_#{k}")
-      return h.delete("data-association-#{k.tr('_', '-')}") if h.key?("data-association-#{k.tr('_', '-')}")
-      return nil unless h.key?(:data)
-      d = h[:data].with_indifferent_access
+      return hash.delete("association_#{k}") if hash.key?("association_#{k}")
+      return hash.delete("data_association_#{k}") if hash.key?("data_association_#{k}")
+      return hash.delete("data-association-#{k.tr('_', '-')}") if hash.key?("data-association-#{k.tr('_', '-')}")
+      return nil unless hash.key?(:data)
+
+      d = hash[:data].with_indifferent_access
       return d.delete("association_#{k}") if d.key?("association_#{k}")
       return d.delete("association-#{k.tr('_', '-')}") if d.key?("association-#{k.tr('_', '-')}")
+
       nil
     end
   end

data/lib/cocooned/railtie.rb

@@ -7,7 +7,7 @@ module Cocooned
   class Railtie < ::Rails::Engine
     initializer 'cocooned.initialize' do |_app|
       ActiveSupport.on_load :action_view do
-        ActionView::Base.send :include, Cocooned::Helpers
+        ActionView::Base.include Cocooned::Helpers
       end
     end
   end

data/lib/cocooned/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cocooned
-  VERSION = '1.3.1'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cocooned
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Gaël-Ian Havard
 - Nathan Van der Auwera
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,34 +17,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: jasmine
   requirement: !ruby/object:Gem::Requirement
@@ -79,28 +79,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easier nested form. Supports standard Rails forms, Formtastic and SimpleForm.
 email:
 - gael-ian@notus.sh
@@ -144,7 +200,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,16 +208,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Unobtrusive nested forms handling using jQuery.
+summary: Unobtrusive Rails nested forms handling, with or without jQuery.
 test_files: []