Merge pull request #362 from nasa/open346

[Entanglement] Add "Set Primary Location" action

platform/entanglement/bundle.json

@@ -39,6 +39,15 @@
                 "glyph": "\u00F4",
                 "category": "contextual",
                 "implementation": "actions/GoToOriginalAction.js"
+            },
+            {
+                "key": "locate",
+                "name": "Set Primary Location",
+                "description": "Set a domain object's primary location.",
+                "glyph": "",
+                "category": "contextual",
+                "implementation": "actions/SetPrimaryLocationAction.js"
+
             }
         ],
         "components": [

platform/entanglement/src/actions/SetPrimaryLocationAction.js

@@ -0,0 +1,60 @@
+/*****************************************************************************
+ * 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";
+
+        /**
+         * Implements the "Set Primary Location" action, which sets a
+         * location property for objects to match their contextual
+         * location.
+         *
+         * @implements {Action}
+         * @constructor
+         * @private
+         * @memberof platform/entanglement
+         * @param {ActionContext} context the context in which the action
+         *        will be performed
+         */
+        function SetPrimaryLocationAction(context) {
+            this.domainObject = context.domainObject;
+        }
+
+        SetPrimaryLocationAction.prototype.perform = function () {
+            var location = this.domainObject.getCapability('location');
+            return location.setPrimaryLocation(
+                location.getContextualLocation()
+            );
+        };
+
+        SetPrimaryLocationAction.appliesTo = function (context) {
+            var domainObject = context.domainObject;
+            return domainObject && domainObject.hasCapability("location")
+                && (domainObject.getModel().location === undefined);
+        };
+
+        return SetPrimaryLocationAction;
+    }
+);
+

platform/entanglement/test/actions/SetPrimaryLocationActionSpec.js

@@ -0,0 +1,80 @@
+/*****************************************************************************
+ * 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/actions/SetPrimaryLocationAction',
+        '../DomainObjectFactory'
+    ],
+    function (SetPrimaryLocation, domainObjectFactory) {
+        'use strict';
+
+        describe("The 'set primary location' action", function () {
+            var testContext,
+                testModel,
+                testId,
+                mockLocationCapability,
+                mockContextCapability;
+
+            beforeEach(function () {
+                testId = "some-id";
+                testModel = { name: "some name" };
+
+                mockLocationCapability = jasmine.createSpyObj(
+                    'location',
+                    [ 'setPrimaryLocation', 'getContextualLocation' ]
+                );
+
+                mockLocationCapability.getContextualLocation.andReturn(testId);
+
+                testContext = {
+                    domainObject: domainObjectFactory({
+                        capabilities: {
+                            location: mockLocationCapability
+                        },
+                        model: testModel
+                    })
+                };
+            });
+
+            it("is applicable to objects with no location specified", function () {
+                expect(SetPrimaryLocation.appliesTo(testContext))
+                    .toBe(true);
+                testContext.domainObject.getModel.andReturn({
+                    location: "something",
+                    name: "some name"
+                });
+                expect(SetPrimaryLocation.appliesTo(testContext))
+                    .toBe(false);
+            });
+
+            it("sets the location contextually when performed", function () {
+                new SetPrimaryLocation(testContext).perform();
+                expect(mockLocationCapability.setPrimaryLocation)
+                    .toHaveBeenCalledWith(testId);
+            });
+
+        });
+    }
+);

platform/entanglement/test/suite.json

@@ -4,6 +4,7 @@
     "actions/GoToOriginalAction",
     "actions/LinkAction",
     "actions/MoveAction",
+    "actions/SetPrimaryLocationAction",
     "policies/CrossSpacePolicy",
     "services/CopyService",
     "services/LinkService",