cool_nested_forms 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af501a2bfc55ecb63e39851038dfb7d0bba6614e
-  data.tar.gz: 594c8c6a3b576f6e836489ef47a53991e190d4b9
+  metadata.gz: 2e0dc8dc707e61117d10794ea7ff2889d6e7bdde
+  data.tar.gz: 5e4cd25d4a6269fdec390efb861641d34c268ca9
 SHA512:
-  metadata.gz: 5508c12b75229896af14311249e770ee2303e398e30d5b4c7101dc525a506f0ead853644e51a1d8560d705c4d1f50c996f8d41758d74aeeaab2a4280a51ad3ac
-  data.tar.gz: b2b35b327d07736004e495567c90b0fd35c7a13db4999f247b0ebdcb824f1ee3b48bf83ca3d3b9516f06a12e91ebebc1aa1849f3018d8237d9fa5c605a3cc523
+  metadata.gz: 989fc6d673aeaf2830fc2afa00dfcf90904ea08592feb1365763193c80b04333acda1a1f79684aa071e4f6aec37f92bb8f988d8617150f2b443eec529c289224
+  data.tar.gz: d68800719b9475ba36ad6cd3857746568659bfa44f6d8295388911adcc31c0bd0f1af9b2b805f7cc6417c1ffd9deba7c4de0e8c9acd54b7fa679718cc320b915

data/app/assets/javascripts/cool_nested_forms.js

@@ -1,36 +1,71 @@
 $(function(){
-  $(document).delegate('.add_child','click', function() {
+  $(document).on('click', '.cnf-add-entry', function() {
+    // initialize options
     var association = $(this).attr('data-association');
-    var template = $(this).attr('data-association-template');
-    var child_templates = $(this).attr('data-child-template').split(' ');
-    var target = $(this).attr('target');
-    var regexp = new RegExp('new_' + association, 'g');
-    var regexp2 = new RegExp('\\[tempid\\]', 'g');
-    var regexp_child_template = new RegExp('_tempid_', 'g');
-    var regexp_parent_new_field = new RegExp('new_' + association, 'g');
-    var new_id = new Date().getTime();
-    var Dest = (target == '') ? $(this).parent() : $('#'+target);
-    Dest.append(window[ template ].replace(regexp, new_id).replace(regexp2, new_id));
-    for(var index in child_templates)
-    {
-      child_template = child_templates[index];
-      if(child_template != "")
-      {
-        body = window[child_template];
-        child_script_tag = "<script> var " + child_template + " = '" + body + "'  </script>";
-        child_script_tag = child_script_tag.replace(regexp_child_template, "_" + new_id + "_")
-                            .replace(regexp_parent_new_field, new_id);
-        Dest.append(child_script_tag.replace(regexp_child_template, "_" + new_id + "_"));
+    var jsTemplateName = $(this).attr('data-js-template-name');
+    var childTemplates = $(this).attr('data-child-js-template-names').split(' ');
+    var target = $(this).attr('data-target');
+
+    // initialize regular expressions
+    var associationNewRegEx = new RegExp('new_' + association, 'g');
+    var tempIdRegEx = new RegExp('\\[tempid\\]', 'g');
+    var childTempIdRegEx = new RegExp('_tempid_', 'g');
+
+    // create a temporary id
+    var newId = new Date().getTime();
+
+    // select where to append the new element
+    var container = (target == '') ? $(this).parent() : $('#'+target);
+
+    // append the new emelent andreplace all temp_ids
+    container.append(window[ jsTemplateName ].replace(associationNewRegEx, newId).replace(tempIdRegEx, newId));
+
+    // parse any child templates
+    for(var index in childTemplates) {
+
+      childTemplate = childTemplates[index];
+
+      if(childTemplate != ""){
+        // get the template
+        body = window[childTemplate];
+        // generate the script tag
+        child_script_tag = "<script> var " + childTemplate + " = '" + body + "'  </script>";
+        // substitute all the temp ids
+        child_script_tag = child_script_tag.replace(childTempIdRegEx, "_" + newId + "_")
+                            .replace(associationNewRegEx, newId);
+        // append the child script tag to the target container
+        // this generates a new script tag associated to the element created
+        // before this loop
+        container.append(child_script_tag.replace(childTempIdRegEx, "_" + newId + "_"));
       }
     }
-    $(document).trigger('coolNestedForms.childAdded');
+    // trigger event coolNestedForms.entryAdded
+    $(document).trigger('coolNestedForms.entryAdded');
+    // false to avoid errors
     return false;
   });
-
-  $(document).delegate('.remove_child','click', function() {
-    $(this).parent().children('.removable')[0].value = 1;
-    $(this).parent().hide();
-    $(document).trigger('coolNestedForms.childRemoved');
+  $(document).on('click', '.cnf-remove-entry', function() {
+    // get the target attribute. this is the target entry container.
+    var target = $(this).attr('data-target');
+    // initialize the container
+    var container = "";
+    // target provided?
+    if(target == ""){
+      // default to the parent container
+      container = $(this).parent();
+    }
+    else {
+      // use the target provided
+      container = $('#' + target);
+    }
+    // update the hidden field that sets the record for removal
+    container.find('.cnf-removable')[0].value = 1;
+    // hide the container for user feedback
+    container.hide();
+    // trigger event coolNestedForms.entryRemoved
+    $(document).trigger('coolNestedForms.entryRemoved');
+    // false to avoid errors
     return false;
   });
+
 });

data/app/helpers/cool_nested_forms_helper.rb

@@ -1,45 +1,108 @@
 module CoolNestedFormsHelper
 
-    def new_fields_template(f,association,options={})
-      options[:object] ||= f.object.class.reflect_on_association(association).klass.new
-      options[:partial] ||= association.to_s.singularize
-      options[:template] ||= association.to_s
-      options[:child_template_options] ||= []
-      options[:f] ||= f
-
-      child_tmpl = ""
-      tmpl = content_tag(:div,:id =>"#{options[:template]}") do
-        tmpl = f.fields_for(association,options[:object], :child_index => "new_#{association}") do |b|
-          if options[:child_template_options].count > 0
-            options[:child_template_options].each do |child|
-              child_tmpl += new_fields_template(b,child[:association],child)
-            end
-            child_tmpl = child_tmpl.gsub( /\r?\n|\r/, ' ')
-          end
-          render(:partial=>options[:partial],:locals =>{:f => b})
-        end
+  ## new_entry_template ##
+  # arguments
+  # - builder: a FormBuilder Object obtained from form_with or form_for
+  # - association: a model class i.e. MyTask
+  # - options: hash of override options
+  #   - partial: name of the erb partial to use as a tempalte
+  #   - id: ID to be used in for the container
+  #   - plurilized: the plural version of the model name
+  #   - js_template_name: name for the javascript variable generated by this method ( useful when there are multiple nested associations)
+  #   - children: an array with childre association options for nested association of a nested association
+  def new_entry_template(builder,association, options = {})
+    # initialize options
+    options[:partial] ||= association.name.snakecase
+    options[:id] ||= "#{association.name.snakecase}_[tempid]"
+    options[:pluralized] ||= association.name.snakecase.pluralize
+    options[:js_template_name] ||= association.name.snakecase.pluralize
+    options[:children] ||= []
+
+    # children output
+    children_output = ''
+    # render the template using the form builder object and the association
+    output = builder.fields_for(options[:pluralized],association.new, :child_index => "new_#{options[:pluralized]}") do |assoc_builder|
+
+      # render each children
+      options[:children].each do |child|
+        children_output += new_entry_template(assoc_builder,child[:association],child)
       end
 
-      tmpl = tmpl.gsub( /\r?\n|\r/, ' ')
-      script = "<script> var #{options[:template]} = '#{tmpl.to_s}'; </script>"
-      script += child_tmpl
-      return script.html_safe
+      # render erb partial
+      render(:partial=>options[:partial],:locals =>{:builder => assoc_builder, :id => options[:id] })
     end
 
-    def add_child_button(name, association,target,association_template="",classes="",child_template="")
-      association_template = association if association_template.blank?
-      content_tag(:span,"<span>#{name}</span>".html_safe,
-        :class => "add_child #{classes}",
-        :style => "",
-        :"data-association" => association,
-        :"data-association-template" => association_template,
-        :"data-child-template" => child_template,
-        :id => "#{association_template}_button",
-        :target => target)
-    end
-    def remove_child_button(name, classes="", inner_html="<span>Remove</span>")
-      content_tag(:div,inner_html.html_safe,
-        :style => "",
-        :class => "remove_child #{classes}")
-    end
+    # remove any new line characters
+    output = output.gsub( /\r?\n|\r/, ' ')
+
+    # create the script tag that will be output to the page
+    script_tag = "<script> var #{options[:js_template_name]} = '#{output}'; </script>"
+
+    # add children_output
+    script_tag += children_output
+    # return the output as html safe
+    return script_tag.html_safe
+  end
+
+  ## new_entry_button ##
+  # arguments
+  # - name: A string to be displayed as the button text
+  # - association: a model class i.e. MyTask
+  # - target: a html tag ID where the button will be attached
+  # - options: hash of override options
+  #   - plurilized: the plural version of the model name
+  #   - js_template_name: name for the javascript variable generated by this method ( useful when there are multiple nested associations)
+  #   - class: a string with any css class names to be used for styling
+  #   - style: a string with any css styles
+  #   - child_js_template_names: an array with any children js template names.
+  #     every time a nested association that contains other nested associations is added,
+  #     a button to add a child entry is added to the new entry
+  #   - tag: override the returned tag
+  #   - tag_content: override the returned tag content
+  def new_entry_button(name, association, options = {})
+    options[:pluralized] ||= association.name.snakecase.pluralize
+    options[:js_template_name] ||= association.name.snakecase.pluralize
+    options[:class] ||= ""
+    options[:style] ||= ""
+    options[:child_js_template_names] ||= ""
+    options[:tag] ||= :span
+    options[:tag_content] ||= "<span>#{name}</span>"
+    options[:target] ||= association.name.snakecase.pluralize
+
+    return content_tag(options[:tag],
+      options[:tag_content].html_safe,
+      :class => "cnf-add-entry #{options[:class]}",
+      :style => options[:style],
+      "data-association" => options[:pluralized],
+      "data-js-template-name" => options[:js_template_name],
+      "data-child-js-template-names" => options[:child_js_template_names],
+      :id => "#{options[:js_template_name]}_button",
+      "data-target" => options[:target])
+  end
+
+  ## remove_entry_button
+  # arguments
+  # - name: A string to be displayed as the button text
+  # - target: a html tag ID that contains the element to be removed
+  # - options: hash of override options
+  #   - class: a string with any css class names to be used for styling
+  #   - style: a string with any css styles
+  #   - tag: override the returned tag
+  #   - tag_content: override the returned tag content
+  def remove_entry_button(name, association, options = {})
+    options[:class] ||= ''
+    options[:style] ||= ''
+    options[:tag] ||= :div
+    options[:tag_content] ||= "<span>#{name}</span>"
+    options[:target] ||= ""
+
+    return content_tag(
+      options[:tag],
+      options[:tag_content].html_safe,
+      :style => options[:style],
+      :class => "cnf-remove-entry #{options[:class]}",
+      "data-target" => options[:target]
+    )
+  end
+
 end

data/cool_nested_forms.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "app"]
 
-  spec.add_runtime_dependency 'rails', '~> 5.1'
+  spec.add_runtime_dependency 'rails', '>= 4.0'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/cool_nested_forms/version.rb

@@ -1,3 +1,3 @@
 module CoolNestedForms
-  VERSION = "1.0.2"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cool_nested_forms
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Carlos Roque
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement