[Entanglement] Separate out location

Separate out location property from the CreationService,
instead handle in the entanglement bundle; this is
consistent with changes for identity management (attaching
a creator to newly-created domain object models).
for nasa/openmctweb#92
This commit is contained in:
Victor Woeltjen 2015-09-01 10:57:56 -07:00
parent e3eda5112c
commit b39753d0a6
6 changed files with 138 additions and 17 deletions

View File

@ -55,6 +55,10 @@ define(
* space an object is created within (as it is possible to
* have multiple persistence spaces attached.)
*
* Note that the model passed in for object creation may be
* modified to attach additional initial properties associated
* with domain object creation.
*
* @param {object} model the model for the newly-created
* domain object
* @param {DomainObject} parent the domain object which
@ -67,12 +71,6 @@ define(
var persistence = parent.getCapability("persistence"),
self = this;
// Store the location of an object relative to it's parent.
function addLocationToModel(modelId, model, parent) {
model.location = parent.getId();
return model;
}
// Persist the new domain object's model; it will be fully
// constituted as a domain object when loaded back, as all
// domain object models are.
@ -135,7 +133,6 @@ define(
// 2. Create a model with that ID in the persistence space
// 3. Add that ID to
return self.$q.when(uuid()).then(function (id) {
model = addLocationToModel(id, model, parent);
return doPersist(persistence.getSpace(), id, model);
}).then(function (id) {
return addToComposition(id, parent, persistence);

View File

@ -201,16 +201,6 @@ define(
expect(mockLog.error).toHaveBeenCalled();
});
it("stores location on new domainObjects", function () {
var model = { name: "my model" },
objectPromise = creationService.createObject(
model,
mockParentObject
);
expect(model.location).toBe('parentId');
});
});
}
);

View File

@ -33,6 +33,11 @@
}
],
"components": [
{
"type": "decorator",
"provides": "creationService",
"implementation": "services/LocatingCreationDecorator.js"
}
],
"controllers": [
],

View File

@ -0,0 +1,49 @@
/*****************************************************************************
* Open MCT Web, Copyright (c) 2014-2015, United States Government
* as represented by the Administrator of the National Aeronautics and Space
* Administration. All rights reserved.
*
* Open MCT Web 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 Web 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.
*****************************************************************************/
/*global define */
define(
function () {
"use strict";
/**
* Adds a `location` property to newly-created domain objects.
* @constructor
* @augments {platform/commonUI/browse.CreationService}
* @memberof platform/entanglement
*/
function LocatingCreationDecorator(creationService) {
this.creationService = creationService;
}
LocatingCreationDecorator.prototype.createObject = function (model, parent) {
if (parent && parent.getId) {
model.location = parent.getId();
}
return this.creationService.createObject(model, parent);
};
return LocatingCreationDecorator;
}
);

View File

@ -0,0 +1,79 @@
/*****************************************************************************
* Open MCT Web, Copyright (c) 2014-2015, United States Government
* as represented by the Administrator of the National Aeronautics and Space
* Administration. All rights reserved.
*
* Open MCT Web 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 Web 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.
*****************************************************************************/
/*global define,describe,beforeEach,it,jasmine,expect */
define(
[
'../../src/services/LocatingCreationDecorator'
],
function (LocatingCreationDecorator) {
"use strict";
describe("LocatingCreationDecorator", function () {
var mockCreationService,
mockPromise,
mockParent,
decorator;
beforeEach(function () {
mockCreationService = jasmine.createSpyObj(
'creationService',
['createObject']
);
mockPromise = jasmine.createSpyObj(
'promise',
['then']
);
mockParent = jasmine.createSpyObj(
'domainObject',
['getCapability', 'getId', 'getModel', 'hasCapability', 'useCapability']
);
mockCreationService.createObject.andReturn(mockPromise);
mockParent.getId.andReturn('test-id');
decorator = new LocatingCreationDecorator(mockCreationService);
});
it("delegates to its decorated service", function () {
expect(decorator.createObject(
{ someKey: "some value" },
mockParent
)).toEqual(mockPromise); // promise returned by decoratee
});
it("adds a location property", function () {
decorator.createObject(
{ someKey: "some value" },
mockParent
);
expect(mockCreationService.createObject).toHaveBeenCalledWith(
{
someKey: "some value",
location: "test-id" // Parent's identifier
},
mockParent
);
});
});
}
);

View File

@ -4,5 +4,6 @@
"services/LinkService",
"services/MoveService",
"services/LocationService",
"services/LocatingCreationDecorator",
"capabilities/LocationCapability"
]