cocooned 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b263ee9e9f62225ffda1bf6023baf4b2f26643ca3951bffe3789c251a3da267
-  data.tar.gz: b390024eaa76fd227ac9e32b292aaf75987e9a3f42200069e51d02440cdd9ea9
+  metadata.gz: 109827f9ebd10c0449258165b0a5d02e6bbd6ae4626f7ad02e6433f7bdf885bb
+  data.tar.gz: c79261d7aebc07c5d8516bbdddd0bdf7334af260c1b253eb2b6c52d56184416b
 SHA512:
-  metadata.gz: 35f0aecab1c7b427c52b99cf8d1665ac3a06a5d8bcb980a33d2577e18bdef322897ea080da60a05d7218b90977c53cc919cc14e967c314247c0ff4cd76f83d8e
-  data.tar.gz: ff5d977c74da72179fa80cc2b62ad65bd709f7cce6734ebbd4f82123ac7f3349c6a865f030f035a5d32af6dc9f1522142a0705b1f7b610f6d7bd064bbbaf85fd
+  metadata.gz: 904197ab102c253ceee532f9ff777b063d560228a11b0ead34af44510148a7fd5f23ba02947f314a787161e02da83d6ecf76b77ce3df9abc2e32bc5a18322161
+  data.tar.gz: 87fab14e1918bb4315819327d2b4460e5a7046e6f6d3364504c82b544c3a792bf73273afb97a1dc82a6c877f29e5e341eff44e57f537927b4983f1b53b68a4f7

data/CHANGELOG.md

@@ -6,6 +6,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## Version 2.1.0 (2024-01-28)
+
+### Added
+
+* Add support for custom tag name to container helpers (#55, #56)  
+  `cocooned_container` and `cocooned_item` now support an optional tag name as their first argument (as `content_tag` do) when the default `<div/>` is not appropriate.  
+  **Warning:** This change is not supposed to break anything as helpers prototypes stays the same and no other positional argument where really expected before. However, depending on how you used these helpers with previous releases, you may encounter unexpected side effects.
+* Documentation about nested use cases and event initialization (#59)
+
+### Fixed
+
+* Replacements operated on a newly built item in some nested use cases (#52, #57)  
+  Replacements are now done recursively in nested templates if any exists. This should fix field naming in newly built items when multiple Cocooned instance are nested and correct naming of sub-items depends on generated names for their parent.
+
+### Changed
+
+* Update test matrix (#54)  
+  Add Ruby 3.3. Drop Ruby 2.6 and Ruby 2.7
+
 ## Version 2.0.4 (2023-11-23)
 
 ### Fixed

data/README.md

@@ -193,7 +193,7 @@ And your sub form as follow:
 + <% end %>
 ```
 
-The `cocooned_container` and `cocooned_item` helpers will set for you the HTML attributes the JavaScript part of Cocooned expect to find to hook on. They will forward any option supported by ActionView's `content_tag`.
+The `cocooned_container` and `cocooned_item` helpers will set for you the HTML attributes the JavaScript part of Cocooned expect to find to hook on. They will forward any option supported by ActionView's `content_tag` and accept a tag name as first argument if you don't want to use the default `<div>`.
 
 ### 3. Add a way to add a new item to the list
 
@@ -257,6 +257,10 @@ If you have a `has_one` association, then you (probably) need to set `force_non_
 
 See the [original merge request](https://github.com/nathanvda/cocoon/pull/247) for more details.
 
+#### Complex nested forms
+
+If you want to build complex forms with multiple levels of nesting, make sure you [initialize Cocooned event handlers correctly for dynamically added child items](https://github.com/notus-sh/cocooned/blob/main/npm/README.md#complex-nested-forms) or your form won't behave as you might expect.
+
 ## Plugins
 
 Cocooned comes with two built-in plugins:
@@ -306,10 +310,10 @@ Remember to add `:position` as a permitted parameter in your controller.
 
 Each helper provided by Cocooned with a name ending with `_link` has its `_button` equivalent, to generate a `<button type="button" />` instead of a `<a href="#" />`:
 
-- `cocooned_add_item_link` <=> `cocooned_add_item_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/master/lib/cocooned/helpers/tags/add.rb))
-- `cocooned_remove_item_link` <=> `cocooned_remove_item_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/master/lib/cocooned/helpers/tags/remove.rb))
-- `cocooned_move_item_up_link` <=> `cocooned_move_item_up_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/master/lib/cocooned/helpers/tags/up.rb))
-- `cocooned_move_item_down_link` <=> `cocooned_move_item_down_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/master/lib/cocooned/helpers/tags/down.rb))
+- `cocooned_add_item_link` <=> `cocooned_add_item_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/main/lib/cocooned/helpers/tags/add.rb))
+- `cocooned_remove_item_link` <=> `cocooned_remove_item_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/main/lib/cocooned/helpers/tags/remove.rb))
+- `cocooned_move_item_up_link` <=> `cocooned_move_item_up_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/main/lib/cocooned/helpers/tags/up.rb))
+- `cocooned_move_item_down_link` <=> `cocooned_move_item_down_button` ([Documentation](https://github.com/notus-sh/cocooned/blob/main/lib/cocooned/helpers/tags/down.rb))
 
 While all `_link` helpers accept and will politely forward any option supported by ActionView's `link_to`, `_button` helpers will do the same with options supported by ActionView's `button_tag`.
 
@@ -328,7 +332,7 @@ If no translation is found, the default label will be the humanized action name.
 
 ## Javascript
 
-For more documentation about the JavaScript bundled in the companion package, please refer to [its own documentation](https://github.com/notus-sh/cocooned/blob/master/npm/README.md).
+For more documentation about the JavaScript bundled in the companion package, please refer to [its own documentation](https://github.com/notus-sh/cocooned/blob/main/npm/README.md).
 
 ## Styling forms
 

data/app/assets/javascripts/cocooned.js

@@ -309,10 +309,7 @@
 
     build (id) {
       const node = this.#documentFragment.cloneNode(true);
-      this.#replacements.forEach(replacement => {
-        node.querySelectorAll(`*[${replacement.attribute}]`).forEach(node => replacement.apply(node, id));
-      });
-
+      this.#applyReplacements(node, id);
       return node
     }
 
@@ -320,6 +317,16 @@
     #association
     #documentFragment
     #replacements
+
+    #applyReplacements(node, id) {
+      this.#replacements.forEach(replacement => {
+        node.querySelectorAll(`*[${replacement.attribute}]`).forEach(node => replacement.apply(node, id));
+      });
+
+      node.querySelectorAll('template').forEach(template => {
+        this.#applyReplacements(template.content, id);
+      });
+    }
   }
 
   class Traverser {

data/cocooned.gemspec

@@ -43,9 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails', '>= 6.0', '<= 7.2'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'formtastic', '~> 4.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.11'
-  spec.add_development_dependency 'rspec-rails', '>= 5.0'
-  spec.add_development_dependency 'simple_form', '~> 5.1'
 end

data/lib/cocooned/association/builder.rb

@@ -39,7 +39,7 @@ module Cocooned
         model = if reflection.collection?
                   dummy.send(association).build
                 else
-                  dummy.send("build_#{association}")
+                  dummy.send(:"build_#{association}")
                 end
         model = model.dup if model.frozen?
         model

data/lib/cocooned/helpers/containers.rb

@@ -31,10 +31,11 @@ module Cocooned
       # will be forwarded.
       def cocooned_container(*args, &block)
         options = args.extract_options!.dup
+        name = args.shift || :div
         defaults = cocooned_wrapper_defaults(options, %w[cocooned-container], :'cocooned-container')
         defaults[:data][:cocooned_options] = options.extract!(:limit, :reorderable).to_json
 
-        content_tag(:div, *args, **options.deep_merge(defaults), &block)
+        content_tag(name, *args, **options.deep_merge(defaults), &block)
       end
 
       # Wrap content with the expected markup for a Cocooned item.
@@ -54,9 +55,10 @@ module Cocooned
       # be forwarded.
       def cocooned_item(*args, &block)
         options = args.extract_options!.dup
+        name = args.shift || :div
         defaults = cocooned_wrapper_defaults(options, %w[cocooned-item nested-fields], :'cocooned-item')
 
-        content_tag(:div, *args, **options.deep_merge(defaults), &block)
+        content_tag(name, *args, **options.deep_merge(defaults), &block)
       end
 
       protected

data/lib/cocooned/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocooned
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Gaël-Ian Havard
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,20 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: formtastic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,34 +73,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: simple_form
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 description: " Easier nested form in Rails with capabilities to add, remove, reorder
   or limit nested items. Works with standard Rails form builder, Formtastic or SimpleForm,
   and with or without jQuery. "
@@ -180,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Form builder agnostic handling of Rails nested forms