Merge pull request #186 from AtlasOfLivingAustralia/feature/issue177

Added support for key/value typed constraints #177

Author: salomon-j

grails-app/assets/javascripts/forms.js

@@ -666,26 +666,25 @@ function orEmptyArray(v) {
         };
 
     };
-
-    function applyIncludeExclude(metadata, outputModel, observable, initialConstraints) {
+    function applyIncludeExclude(metadata, outputModel, dataModelItem, initialConstraints) {
         var path = metadata.constraints.excludePath || metadata.constraints.includePath;
 
-        var currentValue = observable();
-        var selectedSoFar = [];
-        outputModel.eachValueForPath(path, function (val) {
-            if (_.isArray(val)) {
-                selectedSoFar = selectedSoFar.concat(val);
-            } else if (val != null) {
-                selectedSoFar.push(val);
-            }
-        });
+        var currentValue = dataModelItem();
+        var selectedSoFar = outputModel.getModelValuesForPath(path);
 
         if (metadata.constraints.excludePath) {
-            return _.filter(initialConstraints, function (value) {
+            var filteredConstraints = _.filter(initialConstraints, function (value) {
+                // Handle object valued constraints - however the functions are attached after the first call to
+                // the computed observable, so we need to guard against that.
+                value = _.isFunction(dataModelItem.constraintValue) ? dataModelItem.constraintValue(value) : value;
                 var isCurrentSelection = _.isArray(currentValue) ? currentValue.indexOf(value) >= 0 : value == currentValue;
-                return (isCurrentSelection || selectedSoFar.indexOf(value) < 0);
+                var include = (isCurrentSelection || selectedSoFar.indexOf(value) < 0);
+                return include;
             });
+            return filteredConstraints;
         } else {
+            // Note that the "includePath" option does not support object (key/value) typed constraints as
+            // it needs to collect values from other form selections which won't be object typed.
             var constraints = initialConstraints.concat(selectedSoFar);
             var currentSelection = _.isArray(currentValue) ? currentValue : [currentValue];
             for (var i = 0; i < currentSelection.length; i++) {
@@ -697,9 +696,7 @@ function orEmptyArray(v) {
 
             return constraints;
         }
-
     }
-
     /**
      * Implements the constraints specified on a single data model item using the "constraints" attribute in the metadata.
      * Also provides access to global configuration and context for components that need it.
@@ -775,7 +772,20 @@ function orEmptyArray(v) {
                 valueProperty = metadata.constraints.valueProperty || valueProperty;
                 textProperty = metadata.constraints.textProperty || textProperty;
             }
-
+            // These need to be defined before the computed constraint is defined to support correct evaluation
+            // of the excludePath function.
+            self.constraintValue = function (constraint) {
+                if (_.isObject(constraint)) {
+                    return constraint[valueProperty];
+                }
+                return constraint;
+            };
+            self.constraintText = function(constraint) {
+                if (_.isObject(constraint)) {
+                    return constraint[textProperty];
+                }
+                return constraint;
+            };
             self.constraints = [];
             var includeExcludeDefined = metadata.constraints.excludePath || metadata.constraints.includePath;
             // Support existing configuration style.
@@ -830,18 +840,8 @@ function orEmptyArray(v) {
                 }
             }
 
-            self.constraints.value = function (constraint) {
-                if (_.isObject(constraint)) {
-                    return constraint[valueProperty];
-                }
-                return constraint;
-            };
-            self.constraints.text = function (constraint) {
-                if (_.isObject(constraint)) {
-                    return constraint[textProperty];
-                }
-                return constraint;
-            };
+            self.constraints.value = self.constraintValue;
+            self.constraints.text = self.constraintText;
             self.constraints.label = function(value) {
 
                 if (!value && ko.isObservable(self))  {
@@ -1267,6 +1267,24 @@ function orEmptyArray(v) {
             self.iterateOverPath(pathAsArray, callback, self.data);
         }
 
+        /**
+         * Iterates over every instance of the DataModelItem defined by path and returns an array containing
+         * the values found at each item.
+         * @param path the path to the data model item of interest (e.g. list.nestedList.textValue1)
+         * @returns {*[]}
+         */
+        self.getModelValuesForPath = function(path) {
+            var values = [];
+            self.eachValueForPath(path, function (val) {
+                if (_.isArray(val)) {
+                    values = values.concat(val);
+                } else if (val != null) {
+                    values.push(val);
+                }
+            });
+            return values;
+        }
+
         /**
          * Recursively iterates over each element in the supplied pathAsArray, taking into
          * account when values are lists.

grails-app/controllers/au/org/ala/ecodata/forms/PreviewController.groovy

@@ -8,6 +8,8 @@ import org.grails.io.support.Resource
 
 class PreviewController {
 
+    static responseFormats = ['json', 'xml']
+
     private static String EXAMPLE_MODEL = 'example.json'
     private static String EXAMPLE_MODELS_PATH = '/example_models/'
     private static String EXAMPLE_DATA_PATH = '/example_data/'

src/test/js/spec/DataModelItemSpec.js

@@ -148,11 +148,9 @@ describe("DataModelItem Spec", function () {
 
         var invokedWithPath;
         var vals = ['1', '3'];
-        var customContext = _.extend({}, context, {outputModel: { eachValueForPath: function(path, callback) {
+        var customContext = _.extend({}, context, {outputModel: { getModelValuesForPath: function(path) {
                     invokedWithPath = path;
-                    for (var i=0; i<vals.length; i++) {
-                        callback(vals[i]);
-                    }
+                    return _.flatten(vals);
         }}});
 
         var dataItem = ko.observable().extend({metadata:{metadata:metadata, context:customContext, config:config}});
@@ -165,6 +163,12 @@ describe("DataModelItem Spec", function () {
         vals = [['1', '2'], ['3']];
         dataItem = ko.observableArray().extend({metadata:{metadata:metadata, context:customContext, config:config}});
         expect(dataItem.constraints()).toEqual(['4']);
+
+
+        vals = ['v1'];
+        metadata.constraints.default = [{text:'t1', id:'v1'}, {text:'t2', id:'v2'}];
+        dataItem = ko.observableArray().extend({metadata:{metadata:metadata, context:customContext, config:config}});
+        expect(dataItem.constraints()).toEqual([{text:'t2', id:'v2'}]);
     });
 
 
@@ -182,11 +186,10 @@ describe("DataModelItem Spec", function () {
 
         var invokedWithPath;
         var vals = ['1', '3'];
-        var customContext = _.extend({}, context, {outputModel: { eachValueForPath: function(path, callback) {
+        var customContext = _.extend({}, context, {outputModel: { getModelValuesForPath: function(path) {
                     invokedWithPath = path;
-                    for (var i=0; i<vals.length; i++) {
-                        callback(vals[i]);
-                    }
+                    console.log(_.flatten(vals));
+                   return _.flatten(vals);
                 }}});
 
         var dataItem = ko.observable().extend({metadata:{metadata:metadata, context:customContext, config:config}});