rondo_form 0.2.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 423cebe9e27a08956f9271b683f8c0088a41f4948ad4bca55173f1b332b3cae4
-  data.tar.gz: 7d070bc07b55acc9f776931248f470e168a61e37d4c166eeb56fee0ef219c160
+  metadata.gz: bc37cc28bcea758383fa57af673206440f3d71413763fbc3bea157de11686787
+  data.tar.gz: 8d7e14c2d455fd0397aed863fc050bb70293a5045810c6ea4fbd16297faad9ef
 SHA512:
-  metadata.gz: 14e2bdf013942175ee60caa28aef367b3895f2955a155c486d21bf1e9efc59ccc41bc91b7e9f0d5d50fd3c521fb5cb1ff421283e1bb414284613be8fa9e7bae1
-  data.tar.gz: da491eafe4dacfb0e2d57350ed5f1d8030b4db9aeba61df1cf20849c2bb04256e141e7a99466330b2512cee9b121aa9e941cd7629b69f4c14b840b61d0f50499
+  metadata.gz: 84788ef35f96668f52aefcbd5bc9428bd655b23fb172c5e21fc46d93af5a8393d531e1afc56e22c6ae038bf8b8ca89def4c9b0e652fcfde8027da68a8317f0e7
+  data.tar.gz: f2729cc3cda456f0a12ab1536cfed97c6c44ed53e6bef1bd7e1a052bd045c08a03c13ba4fb89399f36cd53050c1ad8e0fff50833ee35f5652416ebb758928006

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0
+## Breaking Changes
+- Add `render_options` as parameter to `link_to_add_association` [#10](https://github.com/hungle00/rondo_form/pull/10)
+- Rename `partial_name` to `partial` to match Rails helper [#10](https://github.com/hungle00/rondo_form/pull/10)
+
+## All Changes
+- Add documentation of the view helpers to the README [#10](https://github.com/hungle00/rondo_form/pull/10)

data/README.md

@@ -34,6 +34,45 @@ class Project < ApplicationRecord
 end
 ```
 
+## View helpers
+
+### `link_to_add_association(name, form_builder, render_options, html_options, &block)`
+
+### Signatures
+```ruby
+link_to_add_association(name, form_builder, render_options, html_options)
+# Link text is passed in as name
+
+link_to_add_association(form_builder, render_options, html_options, &block)
+# Link text is passed in as a block
+```
+
+### Options
+- `render_options: hash containing options for Rails' render helper` - This is passed to the Rails `render` helper to
+provide the options that are desired when rendering your association fields. If no special requirements are needed,
+can be passed as `nil` or and empty hash `{}`.
+
+- `html_options: hash containing options for Rails' link_to helper` - This is passed to the Rails `link_to` helper to
+provide the options that are desired when rendering your association fields. If no special requirements are needed,
+can be passed as `nil` or and empty hash `{}`.
+
+### `link_to_remove_association(name, form_builder, html_options, &block)`
+
+### Signatures
+```ruby
+link_to_remove_association(name, form_builder, html_options)
+# Link text is passed in as name
+
+link_to_remove_association(form_builder, html_options, &block)
+# Link text is passed in as a block
+```
+
+### Options
+
+- `html_options: hash containing options for Rails' link_to helper` - This is passed to the Rails `link_to` helper to
+provide the options that are desired when rendering your association fields. If no special requirements are needed,
+can be passed as `nil` or and empty hash `{}`.
+
 ### Sample with SimpleForm
 
 The RondoForm gem adds two helper functions: `link_to_add_association` and `link_to_remove_association`.
@@ -77,6 +116,18 @@ In your `_task_fields` partial:
 </div>
 ```
 
+### Controller
+
+Using projects example, in your controller ProjectsController, your params method should look like:
+``` ruby
+def project_params
+  params.require(:project).permit(:name, :description, tasks_attributes: [:description, :done, :_destroy, :id])
+end
+```
+
+params `:_destroy` allow to delete tasks and `:id` allow to update tasks on update action
+
+
 _Convention_:
 
 - For convention, I named Stimulus controller `nested-rondo`. But you can change the name of Javascript file and the value of `data-controller` to match your purpose.

data/lib/generators/rondo_form/templates/nested_rondo_controller.js

@@ -14,7 +14,7 @@ export default class extends Controller {
   removeField(e) {
     e.preventDefault();
     const wrapperField = this.hasFieldClassValue ? e.target.closest("." + this.fieldClassValue) : e.target.parentNode;
-    
+
     if(e.target.matches('.dynamic')) {
       wrapperField.remove();
     } else {
@@ -23,17 +23,23 @@ export default class extends Controller {
     }
   }
 
-  buildNewAssociation(element) {
-    const assoc = element.target.dataset.association;
-    const assocs = element.target.dataset.associations;
+  buildNewAssociation(event) {
+    let element = event.target;
+    while (element) {
+      if (element.hasAttribute('data-association') || element.hasAttribute('data-associations'))
+        break
+      element = element.parentElement;
+    }
+    const assoc = element.dataset.association;
+    const assocs = element.dataset.associations;
     const content  = this.templateTarget.innerHTML;
-    
+
     let regexpBraced = new RegExp('\\[new_' + assoc + '\\](.*?\\s)', 'g');
     let newId  = new Date().getTime();
     let newContent = content.replace(regexpBraced, '[' + newId + ']$1');
 
     if (newContent == content) {
-      // assoc can be singular or plural 
+      // assoc can be singular or plural
       regexpBraced = new RegExp('\\[new_' + assocs + '\\](.*?\\s)', 'g');
       newContent = content.replace(regexpBraced, '[' + newId + ']$1');
     }

data/lib/rondo_form/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RondoForm
-  VERSION = "0.2.6"
+  VERSION = "1.0.0"
 end

data/lib/rondo_form/view_helpers.rb

@@ -31,19 +31,24 @@ module RondoForm
 
     # shows a link that will allow to dynamically add a new associated object.
     #
-    # - *name* :         the text to show in the link
-    # - *f* :            the form this should come in
-    # - *association* :  the associated objects, e.g. :tasks, this should be the name of the <tt>has_many</tt> relation.
-    # - *html_options*:  html options to be passed to <tt>link_to</tt> (see <tt>link_to</tt>)
-    # - *&block*:        see <tt>link_to</tt>
+    # - *name* :               the text to show in the link
+    # - *f* :                  the form this should come in
+    # - *association* :        the associated objects, e.g. :tasks, this should be the name of the <tt>has_many</tt> relation.
+    # - *render_options*:      options to be passed to <tt>render</tt>
+    #   - partial: 'file_name'
+    #   - locals: { hash_of: 'local variables for rendered partial' }
+    # - *html_options*:     html options to be passed to <tt>link_to</tt> (see <tt>link_to</tt>)
+    # - *&block*:              see <tt>link_to</tt>
 
     def link_to_add_association(*args, &block)
       if block_given?
-        f, association, html_options = *args
+        f, association, render_options, html_options = *args
+        render_options ||= {}
         html_options ||= {}
-        link_to_add_association(capture(&block), f, association, html_options)
+        link_to_add_association(capture(&block), f, association, render_options, html_options)
       else
-        name, f, association, html_options = *args
+        name, f, association, render_options, html_options = *args
+        render_options ||= {}
         html_options ||= {}
 
         html_options[:class] = [html_options[:class], "add_fields"].compact.join(' ')
@@ -54,17 +59,19 @@ module RondoForm
         new_object = f.object.class.reflect_on_association(association).klass.new
         model_name = new_object.class.name.underscore
         hidden_div = content_tag("template", id: "#{model_name}_fields_template", data: {'nested-rondo_target': 'template'}) do
-          render_association(association, f, new_object, html_options)
+          render_association(association, f, new_object, render_options)
         end
         hidden_div.html_safe + link_to(name, '', html_options )
       end
     end
 
     # :nodoc:
-    def render_association(association, f, new_object, html_options)
-      partial_name = html_options[:partial_name] || association.to_s.singularize + "_fields"
+    def render_association(association, f, new_object, render_options)
+      locals = render_options.delete(:locals) || {}
+      render_options[:partial] = "#{association.to_s.singularize}_fields" unless render_options[:partial]
       f.fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
-        render(partial_name, :f => builder, :dynamic => true)
+        locals.store(:f, builder)
+        render(render_options[:partial], locals)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rondo_form
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 1.0.0
 platform: ruby
 authors:
 - hungle00
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -72,6 +72,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Cocoon, but with Stimulus JS