[Forms] Add specs, doc for CompositeController

Add spec and in-line documentation for CompositeController,
introduced to support integration of forms with the Create
menu, WTD-593.
This commit is contained in:
Victor Woeltjen 2014-12-03 16:19:01 -08:00
parent 218f732dc2
commit 75f4daa5c3
3 changed files with 59 additions and 1 deletions

View File

@ -5,18 +5,39 @@ define(
function () {
"use strict";
/**
* The CompositeController supports the "composite" control type,
* which provides an array of other controls. It is used specifically
* to support validation when a particular row is not marked as
* required; in this case, empty input should be allowed, but partial
* input (where some but not all of the composite controls have been
* filled in) should be disallowed. This is enforced in the template
* by an ng-required directive, but that is supported by the
* isNonEmpty check that this controller provides.
* @constructor
*/
function CompositeController() {
// Check if an element is defined; the map step of isNonEmpty
function isDefined(element) {
return typeof element !== 'undefined';
}
// Boolean or; the reduce step of isNonEmpty
function or(a, b) {
return a || b;
}
return {
/**
* Check if an array contains anything other than
* undefined elements.
* @param {Array} value the array to check
* @returns {boolean} true if any non-undefined
* element is in the array
*/
isNonEmpty: function (value) {
return (value || []).map(isDefined).reduce(or, false);
return Array.isArray(value) &&
value.map(isDefined).reduce(or, false);
}
};
}

View File

@ -0,0 +1,36 @@
/*global define,describe,it,expect,beforeEach,waitsFor,jasmine*/
define(
["../../src/controllers/CompositeController"],
function (CompositeController) {
"use strict";
describe("The composite controller", function () {
var controller;
beforeEach(function () {
controller = new CompositeController();
});
it("detects non-empty arrays", function () {
expect(controller.isNonEmpty(["a", "b", undefined]))
.toBeTruthy();
expect(controller.isNonEmpty([3]))
.toBeTruthy();
});
it("detects empty arrays", function () {
expect(controller.isNonEmpty([undefined, undefined, undefined]))
.toBeFalsy();
expect(controller.isNonEmpty([]))
.toBeFalsy();
});
it("ignores non-arrays", function () {
expect(controller.isNonEmpty("this is not an array"))
.toBeFalsy();
});
});
}
);

View File

@ -1,5 +1,6 @@
[
"MCTControl",
"MCTForm",
"controllers/CompositeController",
"controllers/DateTimeController"
]