/*****************************************************************************
 * 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';

        /**
         * Defines the `persistence` capability, used to trigger the
         * writing of changes to a domain object to an underlying
         * persistence store.
         *
         * @param {PersistenceService} persistenceService the underlying
         *        provider of persistence capabilities.
         * @param {string} SPACE the name of the persistence space to
         *        use (this is an arbitrary string, useful in principle
         *        for distinguishing different persistence stores from
         *        one another.)
         * @param {DomainObject} the domain object which shall expose
         *        this capability
         *
         * @memberof platform/core
         * @constructor
         */
        function PersistenceCapability(persistenceService, SPACE, domainObject) {
            // Cache modified timestamp
            var modified = domainObject.getModel().modified;

            // Update a domain object's model upon refresh
            function updateModel(model) {
                var modified = model.modified;
                return domainObject.useCapability("mutation", function () {
                    return model;
                }, modified);
            }

            // For refresh; update a domain object model, only if there
            // are no unsaved changes.
            function updatePersistenceTimestamp() {
                var modified = domainObject.getModel().modified;
                domainObject.useCapability("mutation", function (model) {
                    model.persisted = modified;
                }, modified);
            }

            // Utility function for creating promise-like objects which
            // resolve synchronously when possible
            function fastPromise(value) {
                return (value || {}).then ? value : {
                    then: function (callback) {
                        return fastPromise(callback(value));
                    }
                };
            }

            return {
                /**
                 * Persist any changes which have been made to this
                 * domain object's model.
                 * @returns {Promise} a promise which will be resolved
                 *          if persistence is successful, and rejected
                 *          if not.
                 * @memberof platform/core.PersistenceCapability#
                 */
                persist: function () {
                    updatePersistenceTimestamp();
                    return persistenceService.updateObject(
                        SPACE,
                        domainObject.getId(),
                        domainObject.getModel()
                    );
                },
                /**
                 * Update this domain object to match the latest from
                 * persistence.
                 * @returns {Promise} a promise which will be resolved
                 *          when the update is complete
                 * @memberof platform/core.PersistenceCapability#
                 */
                refresh: function () {
                    var model = domainObject.getModel();
                    // Only update if we don't have unsaved changes
                    return (model.modified === model.persisted) ?
                            persistenceService.readObject(
                                SPACE,
                                domainObject.getId()
                            ).then(updateModel) :
                            fastPromise(false);
                },
                /**
                 * Get the space in which this domain object is persisted;
                 * this is useful when, for example, decided which space a
                 * newly-created domain object should be persisted to (by
                 * default, this should be the space of its containing
                 * object.)
                 *
                 * @returns {string} the name of the space which should
                 *          be used to persist this object
                 * @memberof platform/core.PersistenceCapability#
                 */
                getSpace: function () {
                    return SPACE;
                }
            };
        }

        return PersistenceCapability;
    }
);