vanilla_nested 1.0.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42bb398c9c058f38333cb4c3af17957fb5477da3
-  data.tar.gz: bae3d4d29d855c18f9f676e7a3aeed0b58b67e5b
+SHA256:
+  metadata.gz: 8b6d8ed9c309bf72014920bec0254c922804f9077967492047139cb3aabc54f3
+  data.tar.gz: 890d67164554668f8054724329cb9bfe56884e73ab44a864ef3b8283c011cae9
 SHA512:
-  metadata.gz: 8a45642b3b74560d5cbfa90178f37c9eac5daf890ed2e0f25915e57b2bccdc5f4006d3106d04dfac2370e95d3d5ca9c444b8c50266a105698aa4a8901484b535
-  data.tar.gz: 5a476ebc770c15df32a6bd3579534acf7f3d7f4bed4f54ba9d278c63d2af6d679a373e0b0feccb33a8361428cec62cd36dbaeb81d4fa7a91204b08a375e50755
+  metadata.gz: c6df5288710235fce651f21a7d03aff41c9d7d529bbb1f0626677bdfe3bf8f670b1277fde0b942c8978a7240de1ecd0586f96d218e6c63f4a27eb63325539964
+  data.tar.gz: f2b7ec1060c226133354d30cb0643620bf12251657771357429f21a3069c76390085715eeb7fcc381ae4ca016ec0d6a632f0573eb1ec5f7df7bac6f1fa835296

data/app/assets/javascripts/vanilla_nested.js

@@ -1,10 +1,16 @@
 (function(){
+  // Get the html from the data attribute and insert the new fields on the container
+  // "event" is the click event of the link created by the rails helper
   window.addVanillaNestedFields = function(event) {
     event.preventDefault();
-    const element = event.target;
+
+    let element = event.target;
+    if (!element.classList.contains('vanilla-nested-add'))
+      element = element.closest('.vanilla-nested-add')
+
     const data = element.dataset;
-    const newHtml = data.html.replace(/_idx_placeholder_/g, Date.now());
     const container = document.querySelector(data.containerSelector);
+    const newHtml = data.html.replace(/_idx_placeholder_/g, Date.now());
 
     let inserted;
     switch (data.methodForInsert) {
@@ -17,12 +23,30 @@
         inserted = container.firstElementChild;
         break;
     }
+
     _dispatchEvent(container, 'vanilla-nested:fields-added', element, {added: inserted})
+
+    let removeLink = inserted.querySelector('.vanilla-nested-remove');
+    if (removeLink)
+      removeLink.addEventListener('click', removeVanillaNestedFields, true);
+
+    // dispatch an event if we reached the limit configured on the model
+    if (data.limit) {
+      let nestedElements = container.children.length;
+      if (nestedElements >= data.limit)
+        _dispatchEvent(container, 'vanilla-nested:fields-limit-reached', element)
+    }
   }
 
+  // Removes the fields or hides them until the undo timer times out
+  // "event" is the click event of the link created by the rails helper
   window.removeVanillaNestedFields = function(event) {
     event.preventDefault();
-    const element = event.target;
+
+    let element = event.target;
+    if (!element.classList.contains('vanilla-nested-remove'))
+      element = element.closest('.vanilla-nested-remove')
+
     const data = element.dataset;
     let wrapper = element.parentElement;
     if (sel = data.fieldsWrapperSelector) wrapper = element.closest(sel);
@@ -38,14 +62,21 @@
     wrapper.querySelector('[name$="[_destroy]"]').value = '1';
   }
 
+  // Hides an element, mainly the wrapper of a group of fields
+  // "wrapper" is the wrapper of the link to remove fields
   function hideWrapper(wrapper) {
     wrapper.style.display = 'none';
   }
 
+  // Unhides the children given a fields wrapper
+  // "wrapper" is the wrapper of the link to remove fields
   function unhideFields(wrapper) {
     [...wrapper.children].forEach(child => child.style.display = 'initial');
   }
 
+  // Hides an element and adds an "undo" link to unhide it
+  // "wrapper" is the wrapper to hide
+  // "element" is the link to remove the wrapper
   function hideFieldsWithUndo(wrapper, element) {
     [...wrapper.children].forEach(child => child.style.display = 'none');
 
@@ -76,8 +107,6 @@
     let timer = setTimeout(_onTimerCompleted, ms);
   }
 
-
-
   function _dispatchEvent(element, eventName, triggeredBy, details) {
     if (!details) details = {};
     details.triggeredBy = triggeredBy;
@@ -97,4 +126,25 @@
 
     return undo;
   }
+
+  function initVanillaNested() {
+    document.querySelectorAll('.vanilla-nested-add').forEach(el => {
+      el.addEventListener('click', addVanillaNestedFields, true);
+    })
+
+    document.querySelectorAll('.vanilla-nested-remove').forEach(el => {
+      el.addEventListener('click', removeVanillaNestedFields, true);
+    })
+  }
+
+  document.addEventListener('DOMContentLoaded', function(){
+    initVanillaNested();
+  })
+
+  // Don't run turbolinks event callback for first load, we already do it with DOMContentLoaded
+  const notEmpty = (obj) => Object.keys(obj).length;
+
+  document.addEventListener('turbolinks:load', function(e){
+    if (notEmpty(e.data.timing)) initVanillaNested();
+  })
 })()

data/lib/vanilla_nested.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'vanilla_nested/view_helpers'
 
 module VanillaNested
   class Engine < ::Rails::Engine
-    initializer "vanilla_nested.initialize" do |app|
+    initializer 'vanilla_nested.initialize' do |_app|
       ActiveSupport.on_load :action_view do
         ActionView::Base.send :include, VanillaNested::ViewHelpers
       end
     end
   end
-end
+end

data/lib/vanilla_nested/view_helpers.rb

@@ -1,29 +1,76 @@
+# frozen_string_literal: true
+
 module VanillaNested
   module ViewHelpers
-    def link_to_add_nested(form, association, container_selector, link_text: nil, link_classes: '', insert_method: :append, partial: nil, partial_form_variable: :form)
+    # @param form [FormBuild] builder on a "form_for" block
+    # @param association [Symbol] name of the association
+    # @param container_selector [String] selector of the element to inser the fields
+    # @param link_text [String, nil] text to use for the link tag
+    # @param link_classes [String] space separated classes for the link tag
+    # @param insert_method [:append, :prepend] tells javascript if the new fields should be appended or prepended to the container
+    # @param partial_form_variable [String, Symbol] name of the variable that represents the form builder inside the fields partial
+    # @param link_content [Block] block of code for the link content
+    # @return [String] link tag
+    def link_to_add_nested(form, association, container_selector, link_text: nil, link_classes: '', insert_method: :append, partial: nil, partial_form_variable: :form, &link_content)
       association_class = form.object.class.reflections[association.to_s].klass
       object = association_class.new
 
-      partial_name = partial ? partial : "#{association_class.name.downcase}_fields"
+      partial_name = partial || "#{association_class.name.underscore}_fields"
 
       html = capture do
-        form.fields_for association, object, child_index: "_idx_placeholder_" do |ff|
-          render partial: partial_name, locals: {partial_form_variable => ff}
+        form.fields_for association, object, child_index: '_idx_placeholder_' do |ff|
+          render partial: partial_name, locals: { partial_form_variable => ff }
         end
       end
 
-      methodForInsert = [:append, :prepend].include?(insert_method.to_sym) ? insert_method : :append
+      method_for_insert = %i[append prepend].include?(insert_method.to_sym) ? insert_method : :append
 
       classes = "vanilla-nested-add #{link_classes}"
-      link_to '#', class: classes, onclick: 'addVanillaNestedFields(event)', data: {'container-selector': container_selector, html: html, 'method-for-insert': methodForInsert} do
-        link_text || "Add #{association_class.model_name}"
+      data = {
+        'container-selector': container_selector,
+        'html': html,
+        'method-for-insert': method_for_insert
+      }
+
+      nested_options = form.object.class.nested_attributes_options[association.to_sym]
+      data['limit'] = nested_options[:limit] if nested_options[:limit]
+
+      if block_given?
+        link_to '#', class: classes, data: data, &link_content
+      else
+        text = link_text || "Add #{association_class.model_name}"
+        link_to text, '#', class: classes, data: data
       end
     end
 
-    def link_to_remove_nested(form, link_text: 'X', fields_wrapper_selector: nil, undo_link_timeout: nil, undo_link_text: 'Undo', undo_link_classes: '')
+    # @param form [FormBuilder] builder on a "form_for" block
+    # @param link_text [String, nil] text for the link, defaults to 'X'
+    # @param fields_wrapper_selector [String] selector for the wrapper of the fields, must be an ancestor
+    # @param undo_link_timeout [Integer] time until undo timeouts
+    # @param undo_link_text [String] text to show as "undo"
+    # @param undo_link_classes [String] space separated list of classes for the "undo" link
+    # @param ulink_classes [String] space separated list of classes for the "x" link
+    # @param link_content [Block] block of code for the link content
+    # @return [String] hidden field and link tag
+    def link_to_remove_nested(form, link_text: 'X', fields_wrapper_selector: nil, undo_link_timeout: nil, undo_link_text: 'Undo', undo_link_classes: '', link_classes: '', &link_content)
+      data = {
+        'fields-wrapper-selector': fields_wrapper_selector,
+        'undo-timeout': undo_link_timeout,
+        'undo-text': undo_link_text,
+        'undo-link-classes': undo_link_classes
+      }
+
+      classes = "vanilla-nested-remove #{link_classes}"
+
       capture do
         concat form.hidden_field(:_destroy, value: 0)
-        concat link_to(link_text, '#', class: 'vanilla-nested-remove', onclick: 'removeVanillaNestedFields(event)', data: {'fields-wrapper-selector': fields_wrapper_selector, 'undo-timeout': undo_link_timeout, 'undo-text': undo_link_text, 'undo-link-classes': undo_link_classes})
+        concat(
+          if block_given?
+            link_to('#', class: classes, data: data, &link_content)
+          else
+            link_to(link_text.html_safe, '#', class: classes, data: data)
+          end
+        )
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vanilla_nested
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.5
 platform: ruby
 authors:
 - Ariel Juodziukynas <arieljuod@gmail.com>
@@ -21,7 +21,7 @@ files:
 - lib/vanilla_nested/view_helpers.rb
 homepage: https://github.com/arielj/vanilla-nested
 licenses:
-- GPL-3.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -38,8 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Dynamic nested forms using vanilla javascript