433dee0314
* Updated Karma and Jasmine versions * Added DOMObserver class. Supports promise-based testing of DOM changes Update asynchronous test specs to use promises or done() instead of waitsFor/runs * Modified ActionCapability to duplicate context object properties as own properties for better object equality comparisons * Global find + replace to fix syntax issues * Fixed various issues caused by non-deterministic runtime order of tests in Jasmine 3. Fixed issues caused by changes to determination of object equality * Addressed review comments * Resolved merge conflicts with master * Fixed style errors * Use spy.calls.count() instead of manually tracking
121 lines
4.9 KiB
JavaScript
121 lines
4.9 KiB
JavaScript
/*****************************************************************************
|
|
* Open MCT, Copyright (c) 2014-2018, United States Government
|
|
* as represented by the Administrator of the National Aeronautics and Space
|
|
* Administration. All rights reserved.
|
|
*
|
|
* Open MCT is licensed under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
* http://www.apache.org/licenses/LICENSE-2.0.
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
* Open MCT includes source code licensed under additional open source
|
|
* licenses. See the Open Source Licenses file (LICENSES.md) included with
|
|
* this source code distribution or the Licensing information page available
|
|
* at runtime from the About dialog for additional information.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* Module defining ActionCapability. Created by vwoeltje on 11/10/14.
|
|
*/
|
|
define(
|
|
['lodash'],
|
|
function (_) {
|
|
|
|
/**
|
|
* The ActionCapability allows applicable Actions to be retrieved and
|
|
* performed for specific domain objects, e.g.:
|
|
*
|
|
* `domainObject.getCapability("action").perform("navigate");`
|
|
*
|
|
* ...will initiate a navigate action upon the domain object,
|
|
* if an action with key "navigate" is defined.
|
|
*
|
|
* @param {*} $q Angular's $q service, for promises
|
|
* @param {ActionService} actionService the service from
|
|
* which to retrieve actions.
|
|
* @param {DomainObject} domainObject the object upon
|
|
* which the action will be performed (also, the
|
|
* action which exposes the capability.)
|
|
*
|
|
* @memberof platform/core
|
|
* @constructor
|
|
*/
|
|
function ActionCapability($q, actionService, domainObject) {
|
|
this.$q = $q;
|
|
this.actionService = actionService;
|
|
this.domainObject = domainObject;
|
|
}
|
|
|
|
/**
|
|
* Perform an action. This will find and perform the
|
|
* first matching action available for the specified
|
|
* context or key.
|
|
*
|
|
* @param {ActionContext|string} context the context in which
|
|
* to perform the action; this is passed along to
|
|
* the action service to match against available
|
|
* actions. The "domainObject" field will automatically
|
|
* be populated with the domain object that exposed
|
|
* this capability. If given as a string, this will
|
|
* be taken as the "key" field to match against
|
|
* specific actions.
|
|
* @returns {Promise} the result of the action that was
|
|
* performed, or undefined if no matching action
|
|
* was found.
|
|
* @memberof platform/core.ActionCapability#
|
|
*/
|
|
ActionCapability.prototype.getActions = function (context) {
|
|
// Get all actions which are valid in this context;
|
|
// this simply redirects to the action service,
|
|
// but additionally adds a domainObject field.
|
|
var baseContext;
|
|
if (typeof context === 'string') {
|
|
baseContext = { key: context };
|
|
} else {
|
|
baseContext = context || {};
|
|
}
|
|
|
|
var actionContext = _.extend({}, baseContext);
|
|
actionContext.domainObject = this.domainObject;
|
|
|
|
return this.actionService.getActions(actionContext);
|
|
};
|
|
|
|
/**
|
|
* Get actions which are available for this domain object,
|
|
* in this context.
|
|
*
|
|
* @param {ActionContext|string} context the context in which
|
|
* to perform the action; this is passed along to
|
|
* the action service to match against available
|
|
* actions. The "domainObject" field will automatically
|
|
* be populated with the domain object that exposed
|
|
* this capability. If given as a string, this will
|
|
* be taken as the "key" field to match against
|
|
* specific actions.
|
|
* @returns {Action[]} an array of matching actions
|
|
* @memberof platform/core.ActionCapability#
|
|
*/
|
|
ActionCapability.prototype.perform = function (context) {
|
|
// Alias to getActions(context)[0].perform, with a
|
|
// check for empty arrays.
|
|
var actions = this.getActions(context);
|
|
|
|
return this.$q.when(
|
|
(actions && actions.length > 0) ?
|
|
actions[0].perform() :
|
|
undefined
|
|
);
|
|
};
|
|
|
|
|
|
return ActionCapability;
|
|
}
|
|
);
|