dynamic_fieldsets 0.1.18 → 0.1.19

data/CHANGELOG

@@ -1,7 +1,16 @@
 == unreleased changes
 
+== 0.1.19
+* Added auto clearing for selects boxes when they're hidden by their dependency actions
+* js show watcher now hides unused questions
+* fixed nested dependencies hiding on form page
+
+== 0.1.18
+* Removed inter-fieldset dependencies
+* made it so fieldset child associations can only be made with 'children' of the same fieldset (frontend)
+
 == 0.1.17
-* Handling for nested fieldsets dependencies and for 'parallele' fieldset dependencies
+* Handling for nested fieldsets dependencies and for 'parallel' fieldset dependencies
 * Wrote a js watcher for the show page, since previous solution is limited to a single fieldset. 
 * Fixed problems that came up for AND and OR dependencies during more complex testing.
 

data/VERSION

@@ -1 +1 @@
-0.1.18
+0.1.19

data/app/helpers/dynamic_fieldsets_helper.rb

@@ -148,10 +148,12 @@ module DynamicFieldsetsHelper
   def javascript_renderer(fsa, form_type)
     unless fsa.id == nil
       rendered_javascript = "<script type='text/javascript'> 
+        var current_fsa = #{fsa.id};
         if ( typeof dynamic_fieldsets_dependencies == 'undefined' ){
-          var dynamic_fieldsets_dependencies = #{fsa.dependency_child_hash.to_json}; 
+          var dynamic_fieldsets_dependencies = {};
+          dynamic_fieldsets_dependencies[current_fsa] = #{fsa.dependency_child_hash.to_json}; 
         } else {
-          $.extend(dynamic_fieldsets_dependencies, #{fsa.dependency_child_hash.to_json}); 
+          dynamic_fieldsets_dependencies[current_fsa] = #{fsa.dependency_child_hash.to_json}; 
         }</script>"
       
       if form_type == "form"

data/app/views/dynamic_fieldsets/fieldset_children/_dependency_fields.html.erb

@@ -1,5 +1,5 @@
 <tr>
-  <td><%= f.select :fieldset_child_id, options_for_select(@fieldset_child.fieldset.fieldset_children.select { |x| x.child_type == "DynamicFieldsets::Field" && x.child.type != "DynamicFieldsets::InstructionField" }.collect { |c| [c.child.name, c.id]}, obj.fieldset_child_id)%></td>
+  <td><%= f.select :fieldset_child_id, options_for_select(@fieldset_child.fieldset.fieldset_children.select { |x| x != @fieldset_child && x.child_type == "DynamicFieldsets::Field" && x.child.type != "DynamicFieldsets::InstructionField" }.collect { |c| [c.child.name, c.id]}, obj.fieldset_child_id)%></td>
   <td><%= f.select :relationship, DynamicFieldsets::Dependency::RELATIONSHIP_LIST %></td>
   <td><%= f.text_field :value %></td>
   <td>

data/app/views/dynamic_fieldsets/shared/_form_javascript_watcher.html.erb

@@ -1,7 +1,6 @@
 <script type='text/javascript'>
 
-// The only inputs we care about are visible... not hidden
-var all_inputs = $(":input:not(:hidden)[id^=fsa]").add("p[id^='fsa']").add("textarea[id^='fsa']");
+var all_inputs = $(":input[id^=fsa-]").add("p[id^=fsa-]").add("textarea[id^=fsa-]");
 
 //Return the fieldset child id for the input
 //This uniquely associated the fieldset child with the fieldset associator
@@ -100,46 +99,45 @@ function get_field_type(field) {
 //
 // the dependency information is stored in dynamic_fieldsets_dependencies
 all_inputs.change( function() {
-    field = $(this);
-    var type = get_field_type(field);
-    var fieldset_child_id = get_fieldset_child_id(field, type);
-    
-    var user_inputs = {};
-    $.each(all_inputs, function(index, input){
-      var each_type = get_field_type($(input));
-      var each_fieldset_child_id = get_fieldset_child_id($(input), each_type);
+  var field = $(this);
+  var type = get_field_type(field);
+  var fieldset_child_id = get_fieldset_child_id(field, type);
+  var fieldset_associator_id = get_fieldset_associator_id(field);
+  
+  var user_inputs = {};
+  $.each(all_inputs, function(index, input){
+    var each_type = get_field_type($(input));
+    var input_id = $(input).attr('id');
+    if (each_type == 'checkbox' || each_type == 'radio'){
+      user_inputs[$(input).parent().parent().attr('id')] = get_input_value($(input), each_type);
+    } else{ 
+      user_inputs[input_id] = get_input_value($(input), each_type);
+    }
+  });
 
-      //checking if field is used has multiple associators to make a unique entry for each in user_inputs
-      if (each_fieldset_child_id in dynamic_fieldsets_dependencies) {
-        $.each(dynamic_fieldsets_dependencies[each_fieldset_child_id], function(index2, group) {
-          var each_fsa = $(input).attr('id').split("_")[0].split('-')[1]
-          user_inputs[each_fsa+"-"+each_fieldset_child_id] = get_input_value($(input), each_type);
-        });
-      } 
+  var dependencies_by_fsa = dynamic_fieldsets_dependencies[fieldset_associator_id];
+  if (fieldset_child_id in dependencies_by_fsa) {
+    $.each(dependencies_by_fsa[fieldset_child_id], function(index, group)  {
+      update_dependency_group_for_fieldset_child(fieldset_child_id, fieldset_associator_id, group, user_inputs);
     });
-
-    if (fieldset_child_id in dynamic_fieldsets_dependencies) {
-      $.each(dynamic_fieldsets_dependencies[fieldset_child_id], function(index, group)  {
-        var current_fsa = field.attr('id').split("_")[0].split('-')[1]
-        update_dependency_group_for_fieldset_child(fieldset_child_id, current_fsa, group, user_inputs);
-      });
-    } 
+  } 
 });
 
 // checks the clauses for a dependency group and runs the action
+// fieldset_child_id: field being currently evaluated
+// fsa_id: fsa it corresponds to
 // group: the dependency group
-// user_input: the input from the form
-function update_dependency_group_for_fieldset_child(fieldset_child_id, current_fsa, group, user_inputs)  {
+// user_inputs: array of inputs from all fields on page
+function update_dependency_group_for_fieldset_child(fieldset_child_id, fsa_id, group, user_inputs)  {
   var action = group['action'];
   var group_fsc_id = group['fieldset_child_id'];
-  var group_field_id = group['field_id'];
-  group_field = '<%= DynamicFieldsets.config.form_fieldset_associator_prefix %>' + current_fsa + '_' + '<%=DynamicFieldsets.config.form_field_prefix %>' + group_fsc_id;
-  dependency_action(all_dependency_clauses_true(fieldset_child_id, current_fsa, group, user_inputs), action, group_field);
+  var group_field = '<%= DynamicFieldsets.config.form_fieldset_associator_prefix %>' + fsa_id + '_' + '<%=DynamicFieldsets.config.form_field_prefix %>' + group_fsc_id;
+  dependency_action(all_dependency_clauses_true(fieldset_child_id, fsa_id, group, user_inputs), action, group_field);
 }
 
-//all dependencies clauses are ANDed
-//the first one that is false makes this return false
-//only return true if all return true
+// all dependencies clauses are ANDed
+// the first one that is false makes this return false
+// only return true if all return true
 function all_dependency_clauses_true(fieldset_child_id, fieldset_associator, group, user_inputs)  {
   for(var key in group["clause"])  {
     var clause = group["clause"][key];
@@ -150,16 +148,16 @@ function all_dependency_clauses_true(fieldset_child_id, fieldset_associator, gro
   return true;
 }
 
-//The dependencies are ORed together
-//So as soon as one returns true, return true
-//Only return false if all are false
-//It looks to see what dependencies inside the clause should actually be tested (AU 08-07-13)
-//  If dependency doesn't match current field, it looks up the correct stored input to compare
+// The dependencies are ORed together
+// So as soon as one returns true, return true
+// Only return false if all are false
+// It looks to see what dependencies inside the clause should actually be tested (AU 08-07-13)
+// If dependency doesn't match current field, it looks up the correct stored input to compare
 function at_least_one_dependency_true(clause, user_inputs, fieldset_associator)  {
   for(var key in clause)  {
     var dependency = clause[key];
     var fieldset_child_id = dependency["fieldset_child_id"];
-    if( evaluate_dependency(user_inputs[fieldset_associator+"-"+fieldset_child_id], dependency["relationship"], dependency["value"]) ){
+    if( evaluate_dependency(user_inputs["fsa-"+fieldset_associator+"_field-"+fieldset_child_id], dependency["relationship"], dependency["value"]) ){
       return true;
     } 
   }
@@ -227,11 +225,11 @@ function dependency_action(success_flag, action, group_field) {
   }
 };
 
-//clears fields that are being hidden
+// clears fields that are being hidden
 function clear_unused_field(group_field) {
   var fields = $('[id$='+group_field+'] :input');
   fields.each( function(index, field) { 
-    type = get_field_type($(field));
+    var type = get_field_type($(field));
     switch(type)
     {
       case 'text':
@@ -244,15 +242,18 @@ function clear_unused_field(group_field) {
         } 
       case 'select':
       case 'multi-select':
+        $(field).prop("selectedIndex",0);
     }
   });
 };
 
-//looks through dependency hash to find dependent fields that may need to be hidden (AU 08-07-13)
+// looks through dependency hash to find dependent fields that may need to be hidden (AU 08-07-13)
 function nested_dependencies(success_flag, action, group_field) {
+  var fsa = group_field.split("_")[0].split("-")[1];
   var dependent_on = group_field.split("-").pop();
-  for( var key in dynamic_fieldsets_dependencies ) {
-    var child = dynamic_fieldsets_dependencies[key];
+  var dependencies_by_fieldset = dynamic_fieldsets_dependencies[fsa];
+  for( var key in dependencies_by_fieldset ) {
+    var child = dependencies_by_fieldset[key];
     for( var keyg in child ) {
       var group_search = child[keyg];
       for( var keyc in group_search["clause"] ) {
@@ -261,11 +262,8 @@ function nested_dependencies(success_flag, action, group_field) {
           var dependency = clause[keyd];
           //select dependent by comparing who the dependency belongs to
           if ( dependency["fieldset_child_id"] == dependent_on ) {
-            var fsa = group_field.split("_")[0];
-            var field = group_field.split("_")[1];
-            var dependent_id = field.replace(dependent_on, group_search["fieldset_child_id"]);
-            var full_dep_id = fsa+"_"+dependent_id;
-            dependency_action(success_flag, action, [full_dep_id]);
+            var dependent_id = group_field.replace(dependent_on, group_search["fieldset_child_id"]);
+            dependency_action(success_flag, action, dependent_id);
           }
         }
       }

data/app/views/dynamic_fieldsets/shared/_show_javascript_watcher.html.erb

@@ -1,67 +1,80 @@
 <script type='text/javascript'>
 
 function hide_fields(){
-  var all_divs = $("div :not(:hidden)[id^=fsa]").add("p[id^='fsa']");
+  var all_divs = $("div :not(:hidden)[id^=fsa-"+current_fsa+"]").add("p[id^='fsa-"+current_fsa+"']");
   var values = {};
   $.each(all_divs, function(index, div){
     var div_id = $(div).attr('id');
-    var fieldset_child_id = div_id.substring(div_id.length-1);
-    var fsa_id = div_id.split("_")[0].split("-")[1];
 
     if($(div).is("p")){
-      values[fieldset_child_id] = div.innerHTML;
+      values[div_id] = div.innerHTML;
     } else {
-      if($(div).attr('type') == 'single'){
-        values[fieldset_child_id] = $(div).find('span').find('span').text();
+      if($(div).attr('type') == "single"){  
+        values[div_id] = $(div).find('span').find('span').text();
       } else {
-        values[fieldset_child_id] = $(div).find('li').map(function(index, li){
-          return $(div).find('span').find('span').text();
+        values[div_id] = $(div).find('li').map( function(index,li){
+          return $(li).find('span').text();
         });
       }
     }
+  });
 
-    var dependency_group = dynamic_fieldsets_dependencies[fieldset_child_id];
-    if((typeof dependency_group) != "undefined"){
+  $.each(all_divs, function(index, div){
+    var div_id = $(div).attr('id');
+    var fieldset_child_id = div_id.split("_")[1].split("-")[1];
+    var dependency_group = dynamic_fieldsets_dependencies[current_fsa][fieldset_child_id];
+    if( typeof dependency_group != "undefined" ){
       $.each(dependency_group, function(index, group){
-        var fieldset_associator_ids = group['fieldset_associators'];
-        evaluate_dependencies(fieldset_child_id, group, values, fieldset_associator_ids);
-      }) 
+        process_dependencies(div_id, group, values);
+      });
     }
   });
 }
 
-function evaluate_dependencies(fieldset_child_id, group, values, fieldset_associator_ids)  {
+// checks dependency clauses in a dependency group and determines what action to take
+// current_div: the div we are currently processing
+// group: the dependency group passed from dynamic_fieldsets_dependencies
+// values: the values stored for each field indexed by div id attributes
+function process_dependencies(current_div, group, values)  {
   var action = group['action'];
   var group_fsc_id = group['fieldset_child_id'];
-  var group_field_id = group['field_id'];
-  var group_fields = [];
-  $.each(fieldset_associator_ids, function(index, fsa_id) {
-    group_fields[index] = '<%= DynamicFieldsets.config.form_fieldset_associator_prefix %>' + fsa_id + '_' + '<%=DynamicFieldsets.config.form_field_prefix %>' + group_fsc_id;
-  });
-  dependency_action(all_dependency_clauses_true(fieldset_child_id, group, values), action, group_fields, 0 );
+  var div_id = '<%= DynamicFieldsets.config.form_fieldset_associator_prefix %>' + current_fsa + '_' + '<%=DynamicFieldsets.config.form_field_prefix %>' + group_fsc_id;
+  var fieldset_associator_id = div_id.split("_")[0].split("-")[1];
+  dependency_action(current_div, all_dependency_clauses_true(fieldset_associator_id, group, values), action, div_id);
 }
 
-function all_dependency_clauses_true(fieldset_child_id, group, values)  {
+// all dependencies are in AND relations so all must be true 
+function all_dependency_clauses_true(fsa_id, group, values)  {
   for(var key in group["clause"])  {
     var clause = group["clause"][key];
-    if(!at_least_one_dependency_true(clause, values))  {
+    if(!at_least_one_dependency_true(fsa_id, clause, values))  {
       return false;
     }
   }
   return true;
 }
 
-function at_least_one_dependency_true(clause, values)  {
+// all dependencies within clause are in OR relationship, 
+// only one needs to be true, to return true for the clause
+function at_least_one_dependency_true(fsa_id, clause, values)  {
   for(var key in clause)  {
     var dependency = clause[key];
-    var fieldset_child_id = dependency["fieldset_child_id"];
-    if( evaluate_dependency(values[fieldset_child_id], dependency["relationship"], dependency["value"]) ){
+    var fsc_id = dependency["fieldset_child_id"];
+    var full_field = '<%= DynamicFieldsets.config.form_fieldset_associator_prefix %>' + fsa_id + '_' + '<%=DynamicFieldsets.config.form_field_prefix %>' + fsc_id;
+    // does not bother to evaluate the values on fields that have been previosuly hidden
+    // CHANGE if there is a question that has dependents above it in order
+    //        a different way of skipping evaluation of hidden fields will be needed
+    if( evaluate_dependency(values[full_field], dependency["relationship"], dependency["value"]) 
+      && $('#'+full_field).attr('style') != 'display: none;'){
       return true;
     }
   }
   return false;
 }
 
+// looks at field values collected from divs and compares them to the values set to trigger dependencies
+// relationship: how the given value must match expected values
+// returns true if user_value and stored_value match correctly
 function evaluate_dependency(user_value, relationship, stored_value) {
 	switch(relationship)
 	{
@@ -82,47 +95,54 @@ function evaluate_dependency(user_value, relationship, stored_value) {
 	}
 };
 
-function dependency_action(success_flag, action, group_fields, counter) {
-  $.each(group_fields, function(index, group_field){
-    if (success_flag){
-      switch(action)
-      {
-        case 'show':
-          $('[id$=' + group_field +']').show();
-        case 'enable':
-          $('#' + group_field + ' :input').removeAttr('disabled');
-      }
-    
-    } else {
-      switch(action)
-      {
-        case 'show':
-          $('[id$=' + group_field +']').hide();
-        case 'enable':
-          $('#' + group_field + ' :input').attr('disabled', true);
-      }
-      
-      //save from infinite recursion, only goes as deep as there are dependency groups
-      if( counter < Object.keys(dynamic_fieldsets_dependencies).length ) {
-        nested_dependencies(success_flag, action, group_field, counter);
-      }	
+// enacts selected action on objects according to dependency
+//
+// current_div: div whose values are being read
+// success_flag: whether the values was as expected in the dependency
+// div_id: div on which action will be made according to dependency to current_div
+//
+// this function calls nested_dependencies whenever a field is hidden to hide any others dependent on it
+function dependency_action(current_div, success_flag, action, div_id) {
+  if (success_flag){
+    switch(action)
+    {
+      case 'show':
+        $('[id$=' + div_id +']').show();
+      case 'enable':
+        $('#' + div_id + ' :input').removeAttr('disabled');
     }
-  });
+  } else {
+    switch(action)
+    {
+      case 'show':
+        $('[id$=' + div_id +']').hide();
+      case 'enable':
+        $('#' + div_id + ' :input').attr('disabled', true);
+    }
+    nested_dependencies(success_flag, action, div_id);
+  }
 };
 
-function nested_dependencies(success_flag, action, group_field, counter) {
-  var dependent_on = group_field.split("-").pop();
-  for( var key in dynamic_fieldsets_dependencies ) {
-    var child = dynamic_fieldsets_dependencies[key]
+// looks through dependency hash to find dependent fields that should be hidden when current one is
+//
+// div_id: the div that was just hidden during the previous dependency evaluation
+//
+// this function ends up either making a call to hide another field through dependency_action
+// or does nothing when the div it's evaluating has no dependents
+function nested_dependencies(success_flag, action, div_id) {
+  var dependent_on = div_id.split("-").pop();
+  for( var key in dynamic_fieldsets_dependencies[current_fsa] ) {
+    var child = dynamic_fieldsets_dependencies[current_fsa][key]
     for( var keyg in child ) {
       var group_search = child[keyg];
       for( var keyc in group_search["clause"] ) {
         var clause = group_search["clause"][keyc];
         for( var keyd in clause ) {
           var dependency = clause[keyd];
+          //select dependent by comparing who the dependency belongs to
           if ( dependency["fieldset_child_id"] == dependent_on ) {
-            var dependent_id = group_field.replace(dependent_on, group_search["fieldset_child_id"])
-            dependency_action(success_flag, action, [dependent_id], counter+1);
+            var dependent_id = div_id.replace(dependent_on, group_search["fieldset_child_id"])
+            dependency_action(div_id, success_flag, action, dependent_id);
           }
         }
       }

data/dynamic_fieldsets.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "dynamic_fieldsets"
-  s.version = "0.1.18"
+  s.version = "0.1.19"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremiah Hemphill", "Ethan Pemble", "John Carter"]
-  s.date = "2013-09-20"
+  s.date = "2013-10-22"
   s.description = "Dynamic fieldsets for rails controllers"
   s.email = "jeremiah@cloudspace.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_fieldsets
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -523,7 +523,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1294392816585476854
+      hash: -3951729081308817073
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: