mirror of
https://github.com/nasa/openmct.git
synced 2025-05-28 21:24:20 +00:00
[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:
parent
218f732dc2
commit
75f4daa5c3
@ -5,18 +5,39 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"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() {
|
function CompositeController() {
|
||||||
|
// Check if an element is defined; the map step of isNonEmpty
|
||||||
function isDefined(element) {
|
function isDefined(element) {
|
||||||
return typeof element !== 'undefined';
|
return typeof element !== 'undefined';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Boolean or; the reduce step of isNonEmpty
|
||||||
function or(a, b) {
|
function or(a, b) {
|
||||||
return a || b;
|
return a || b;
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
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) {
|
isNonEmpty: function (value) {
|
||||||
return (value || []).map(isDefined).reduce(or, false);
|
return Array.isArray(value) &&
|
||||||
|
value.map(isDefined).reduce(or, false);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
36
platform/forms/test/controllers/CompositeControllerSpec.js
Normal file
36
platform/forms/test/controllers/CompositeControllerSpec.js
Normal 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();
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
||||||
|
}
|
||||||
|
);
|
@ -1,5 +1,6 @@
|
|||||||
[
|
[
|
||||||
"MCTControl",
|
"MCTControl",
|
||||||
"MCTForm",
|
"MCTForm",
|
||||||
|
"controllers/CompositeController",
|
||||||
"controllers/DateTimeController"
|
"controllers/DateTimeController"
|
||||||
]
|
]
|
Loading…
x
Reference in New Issue
Block a user