src/cm/media/js/lib/yui/yui3-3.15.0/build/model-sync-local/model-sync-local.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 602 e16a97fb364a
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('model-sync-local', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/*
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
An extension which provides a sync implementation through locally stored
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
key value pairs, either through the HTML localStorage API or falling back
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
onto an in-memory cache, that can be mixed into a Model or ModelList subclass.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
@module app
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
@submodule model-sync-local
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
@since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
An extension which provides a sync implementation through locally stored
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
key value pairs, either through the HTML localStorage API or falling back
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
onto an in-memory cache, that can be mixed into a Model or ModelList subclass.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
A group of Models/ModelLists is serialized in localStorage by either its
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
class name, or a specified 'root' that is provided.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
    var User = Y.Base.create('user', Y.Model, [Y.ModelSync.Local], {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
        root: 'user'
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
    });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
    var Users = Y.Base.create('users', Y.ModelList, [Y.ModelSync.Local], {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
        model: User,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
    });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
@class ModelSync.Local
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
@extensionfor Model
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
@extensionfor ModelList
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
@since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
function LocalSync() {}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
Properties that shouldn't be turned into ad-hoc attributes when passed to a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
Model or ModelList constructor.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
@property _NON_ATTRS_CFG
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
@type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
@default ['root']
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
@static
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
@protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
@since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
LocalSync._NON_ATTRS_CFG = ['root'];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
Feature testing for `localStorage` availability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
Will return falsey for browsers with `localStorage`, but that don't
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
actually work, such as iOS Safari in private browsing mode.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
@property _hasLocalStorage
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
@type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
@private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
LocalSync._hasLocalStorage = (function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
    var LS   = Y.config.win.localStorage,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
        test = Y.guid();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
    try {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
        LS.setItem(test, test);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
        LS.removeItem(test);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
        return true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
    } catch (e) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
        return false;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
})(),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
Object of key/value pairs to fall back on when localStorage is not available.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
@property _data
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
@type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
@private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
LocalSync._data = LocalSync._data || {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
Cache to quickly access a specific object with a given ID.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
@property _store
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
@type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
@private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
**/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
LocalSync._store = LocalSync._store || {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
LocalSync.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
    // -- Public Methods -------------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
    Root used as the key inside of localStorage and/or the in-memory store.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
    @property root
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
    @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
    @default ""
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
    root: '',
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
    Shortcut for access to localStorage.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
    @property storage
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
    @type Storage
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
    @default null
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
    storage: null,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
    // -- Lifecycle Methods -----------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
    initializer: function (config) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
        var store, data;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
        config || (config = {});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
        if ('root' in config) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
            this.root = config.root || '';
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
        // This is checking to see if the sync layer is being applied to
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
        // a ModelList, and if so, is looking for a `root` property on its
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
        // Model's prototype instead.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
        if (!this.root && this.model && this.model.prototype.root) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
            this.root = this.model.prototype.root;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
        if (LocalSync._hasLocalStorage) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
            this.storage = Y.config.win.localStorage;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
            store = this.storage.getItem(this.root);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
        // Pull in existing data from localStorage, if possible.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
        // Otherwise, see if there's existing data on the local cache.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
        if (store) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
            LocalSync._store[this.root] = store.split('|') || [];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
            Y.Array.each(LocalSync._store[this.root], function (id) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
                LocalSync._data[id] = Y.JSON.parse(this.storage.getItem(id));
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
            }, this);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
            LocalSync._store[this.root] || (LocalSync._store[this.root] = []);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
    // -- Public Methods -----------------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
    Creates a synchronization layer with the localStorage API, if available.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
    Otherwise, falls back to a in-memory data store.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
    This method is called internally by load(), save(), and destroy().
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
    @method sync
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
    @param {String} action Sync action to perform. May be one of the following:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
      * **create**: Store a newly-created model for the first time.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
      * **read**  : Load an existing model.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
      * **update**: Update an existing model.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
      * **delete**: Delete an existing model.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
    @param {Object} [options] Sync options
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
    @param {Function} [callback] Called when the sync operation finishes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
      @param {Error|null} callback.err If an error occurred, this parameter will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
        contain the error. If the sync operation succeeded, _err_ will be
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
        falsey.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
      @param {Any} [callback.response] The response from our sync. This value will
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
        be passed to the parse() method, which is expected to parse it and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
        return an attribute hash.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
    sync: function (action, options, callback) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
        options || (options = {});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
        var response, errorInfo;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
        try {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
            switch (action) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
                case 'read':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
                    if (this._isYUIModelList) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
                        response = this._index(options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
                    } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
                        response = this._show(options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
                    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
                    break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
                case 'create':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
                    response = this._create(options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
                    break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
                case 'update':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
                    response = this._update(options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
                    break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
                case 'delete':
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
                    response = this._destroy(options);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
                    break;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
        } catch (error) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   200
            errorInfo = error.message;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   201
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   202
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   203
        if (response) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   204
            callback(null, response);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   205
        } else if (errorInfo) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   206
            callback(errorInfo);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   207
        } else {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   208
            callback("Data not found in LocalStorage");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   209
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   210
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   211
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   212
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   213
    Generate a random GUID for our Models. This can be overriden if you have
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   214
    another method of generating different IDs.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   215
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   216
    @method generateID
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   217
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   218
    @param {String} pre Optional GUID prefix
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   219
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   220
    generateID: function (pre) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   221
        return Y.guid(pre + '_');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   222
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   223
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   224
    // -- Protected Methods ----------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   225
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   226
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   227
    Sync method correlating to the "read" operation, for a Model List
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   228
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   229
    @method _index
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   230
    @return {Object[]} Array of objects found for that root key
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   231
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   232
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   233
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   234
    _index: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   235
        var store = LocalSync._store[this.root],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   236
            data  = Y.Array.map(store, function (id) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   237
                return LocalSync._data[id];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   238
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   239
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   240
        return data;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   241
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   242
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   243
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   244
    Sync method correlating to the "read" operation, for a Model
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   245
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   246
    @method _show
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   247
    @return {Object} Object found for that root key and model ID
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   248
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   249
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   250
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   251
    _show: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   252
        return LocalSync._data[this.get('id')] || null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   253
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   254
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   255
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   256
    Sync method correlating to the "create" operation
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   257
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   258
    @method _show
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   259
    @return {Object} The new object created.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   260
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   261
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   262
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   263
    _create: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   264
        var hash  = this.toJSON();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   265
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   266
        hash.id = this.generateID(this.root);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   267
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   268
        LocalSync._data[hash.id] = hash;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   269
        if (this.storage) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   270
            this.storage.setItem(hash.id, hash);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   271
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   272
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   273
        LocalSync._store[this.root].push(hash.id);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   274
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   275
        this._save();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   276
        return hash;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   277
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   278
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   279
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   280
    Sync method correlating to the "update" operation
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   281
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   282
    @method _update
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   283
    @return {Object} The updated object.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   284
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   285
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   286
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   287
    _update: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   288
        var hash = this.toJSON(),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   289
            id = this.get('id');
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   290
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   291
        LocalSync._data[id] = hash;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   292
        
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   293
        if (this.storage) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   294
            this.storage.setItem(id, hash);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   295
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   296
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   297
        if (Y.Array.indexOf(LocalSync._store[this.root], id) === -1) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   298
            LocalSync._store[this.root].push(id);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   299
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   300
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   301
        this._save();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   302
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   303
        return hash;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   304
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   305
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   306
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   307
    Sync method correlating to the "delete" operation.  Deletes the data
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   308
    from the in-memory object, and saves into localStorage if available.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   309
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   310
    @method _destroy
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   311
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   312
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   313
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   314
    _destroy: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   315
        var id = this.get('id'),
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   316
            storage = this.storage;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   317
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   318
        if (!LocalSync._data[id]) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   319
            return;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   320
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   321
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   322
        delete LocalSync._data[id];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   323
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   324
        if (storage) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   325
            storage.removeItem(id);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   326
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   327
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   328
        LocalSync._store[this.root] = Y.Array.filter(LocalSync._store[this.root], function (item) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   329
            return item.id != id;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   330
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   331
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   332
        this._save();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   333
        return this.toJSON();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   334
    },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   335
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   336
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   337
    Saves the current in-memory store into a localStorage key/value pair
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   338
    if localStorage is available; otherwise, does nothing.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   339
    
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   340
    @method _save
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   341
    @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   342
    @since 3.13.0
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   343
    **/
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   344
    _save: function () {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   345
        if (LocalSync._hasLocalStorage && this.storage) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   346
            this.storage.setItem(
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   347
                this.root,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   348
                LocalSync._store[this.root].join('|')
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   349
            );
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   350
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   351
    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   352
};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   353
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   354
// -- Namespace ---------------------------------------------------------------
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   355
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   356
Y.namespace('ModelSync').Local = LocalSync;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   357
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   358
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   359
}, '@VERSION@', {"requires": ["model", "json-stringify"]});