vanilla_nested 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42bb398c9c058f38333cb4c3af17957fb5477da3
-  data.tar.gz: bae3d4d29d855c18f9f676e7a3aeed0b58b67e5b
+  metadata.gz: d53bc9016018c8253312d3a74d267c8a3e2e953e
+  data.tar.gz: 2c96fb414de1b65ecf49ab9e7e546eda0878d623
 SHA512:
-  metadata.gz: 8a45642b3b74560d5cbfa90178f37c9eac5daf890ed2e0f25915e57b2bccdc5f4006d3106d04dfac2370e95d3d5ca9c444b8c50266a105698aa4a8901484b535
-  data.tar.gz: 5a476ebc770c15df32a6bd3579534acf7f3d7f4bed4f54ba9d278c63d2af6d679a373e0b0feccb33a8361428cec62cd36dbaeb81d4fa7a91204b08a375e50755
+  metadata.gz: 7af84e0fa64113f033fca6bed7e423d4f02f50e5e3e5e1f45fb207c25d2a6b38de425aa2721a34fc902376b0c342436fa6760ceddaf95c55af2313bf60f27643
+  data.tar.gz: b505d4899dc73b090bf8fb880caf7c43166f89a97367ec8bc49961529fc974e2d71251106b6309453f119252f5da421499c927de89deba38f45869e0a24fbf14

data/app/assets/javascripts/vanilla_nested.js

@@ -1,6 +1,9 @@
 (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;
     const data = element.dataset;
     const newHtml = data.html.replace(/_idx_placeholder_/g, Date.now());
@@ -17,11 +20,15 @@
         inserted = container.firstElementChild;
         break;
     }
+
     _dispatchEvent(container, 'vanilla-nested:fields-added', element, {added: inserted})
   }
 
+  // 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;
     const data = element.dataset;
     let wrapper = element.parentElement;
@@ -38,14 +45,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 +90,6 @@
     let timer = setTimeout(_onTimerCompleted, ms);
   }
 
-
-
   function _dispatchEvent(element, eventName, triggeredBy, details) {
     if (!details) details = {};
     details.triggeredBy = triggeredBy;

data/lib/vanilla_nested/view_helpers.rb

@@ -1,29 +1,59 @@
+# frozen_string_literal: true
+
 module VanillaNested
   module ViewHelpers
+    # @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
+    # @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)
       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
+      data = {
+        'container-selector': container_selector,
+        'html': html,
+        'method-for-insert': method_for_insert
+      }
+
+      link_to '#', class: classes, onclick: 'addVanillaNestedFields(event)', data: data do
         link_text || "Add #{association_class.model_name}"
       end
     end
 
+    # @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
+    # @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: '')
+      data = {
+        'fields-wrapper-selector': fields_wrapper_selector,
+        'undo-timeout': undo_link_timeout,
+        'undo-text': undo_link_text,
+        'undo-link-classes': undo_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 link_to(link_text, '#', class: 'vanilla-nested-remove', onclick: 'removeVanillaNestedFields(event)', data: data)
       end
     end
   end

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vanilla_nested
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ariel Juodziukynas <arieljuod@gmail.com>