rondo_form 0.2.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f953e44cde6292d12ee7bd3042659c45de36770dfd6f81a4590452f309faa45
-  data.tar.gz: 5462a299afe097966aefbf5588ac8079dd35655e9cbd0389ddce5ef4d8978ba3
+  metadata.gz: bc37cc28bcea758383fa57af673206440f3d71413763fbc3bea157de11686787
+  data.tar.gz: 8d7e14c2d455fd0397aed863fc050bb70293a5045810c6ea4fbd16297faad9ef
 SHA512:
-  metadata.gz: 8df5386a9afa39d992f3914e5f9ef7358aa2ca8fe41573e7ad56f7d87701f3c1c4d1202315d88fa1c581acf398148aa36c871f7b8c8855c54e17e040277e2175
-  data.tar.gz: 45e36511f96135582e1041153c3431600376943291138000023d0bd0de0965b7b0c0c024c679eb95f8e7d421504f66303ee4d324d6b1fe1f7d8ad6d2ebac9b3d
+  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

@@ -10,22 +10,76 @@ Install the gem and add to the application's Gemfile by executing:
 
 Or inside the Gemfile add the following
 
-    $ gem 'rondo_form', '~> 0.2.5'
+    $ gem 'rondo_form', '~> 0.2.6'
 
 Run the installation task:
 
-    $ rails g rondo_form:install 
+    $ rails g rondo_form:install
 
 ## Usage
 
-For example, we have `Project` model, which has `has_many` relationship with `Task` model:
+For example, you have `Project` model, which has `has_many` relationship with `Task` model:
+
 ```
 rails g scaffold Project name:string description:string
 rails g model Task description:string done:boolean project:belongs_to
 ```
 
+You need to add `accepts_nested_attributes_for` to `Project` model:
+
+```
+class Project < ApplicationRecord
+  has_many :tasks, dependent: :destroy
+  accepts_nested_attributes_for :tasks, reject_if: :all_blank, allow_destroy: true
+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`.
+The example below illustrates the way to use it.
+
 In your `projects/_form` partial:
+
 ``` erb
 <%= simple_form_for(@project) do |f| %>
 
@@ -50,23 +104,38 @@ In your `projects/_form` partial:
     <%= f.button :submit %>
   </div>
 <% end %>
-
 ```
 
 In your `_task_fields` partial:
+
 ``` erb
 <div class="task-field">
   <%= f.input :description %>
   <%= f.input :done, as: :boolean %>
   <%= link_to_remove_association "Remove Task", f %>
 </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-nested-rondo-target="fieldContain"` must be added to an element that wraps all nested fields, the new field will be appended to this element.
 - `data-nested-rondo-field-class-value` is used to detect the element that needs to be removed. Its value must match the class name of an element that wraps the partial. If you do not declare it, it will default remove the closest parent element.
+- The partial added when clicking `link_to_add_association` is named for the association name with the `_fields` suffix. In this example, the partial is named `task_fields`. You can change the partial name by passing the `partial_name` option to `link_to_add_association`.
+
+View details implement for this sample at [rondo_form_demo_turbo_8](https://github.com/hungle00/turbo_8_demos/tree/rondo_form)
 
 ## Contributing
 

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.5"
+  VERSION = "1.0.0"
 end

data/lib/rondo_form/view_helpers.rb

@@ -11,7 +11,7 @@ module RondoForm
     # - *f* : the form this link should be placed in
     # - *html_options*:  html options to be passed to link_to (see <tt>link_to</tt>)
     # - *&block*:        the output of the block will be show in the link, see <tt>link_to</tt>
-    
+
     def link_to_remove_association(*args, &block)
       if block_given?
         f            = args.first
@@ -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,16 +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)
+          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)
+    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(association.to_s.singularize + "_fields", :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.5
+  version: 1.0.0
 platform: ruby
 authors:
 - hungle00
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-20 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.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Cocoon, but with Stimulus JS