-
-
Notifications
You must be signed in to change notification settings - Fork 114
/
attributes.js
406 lines (337 loc) · 12.2 KB
/
attributes.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
import { assert } from '@ember/debug';
import { copy } from 'ember-copy';
import { typeOf } from '@ember/utils';
import { isArray } from '@ember/array';
import { get, setProperties, computed } from '@ember/object';
import StatefulArray from './array/stateful';
import FragmentArray from './array/fragment';
import {
fragmentDidDirty,
fragmentDidReset
} from './states';
import {
internalModelFor,
setFragmentOwner,
setFragmentData,
createFragment,
isFragment
} from './fragment';
import isInstanceOfType from './util/instance-of-type';
/**
@module ember-data-model-fragments
*/
// Create a unique type string for the combination of fragment property type,
// transform type (or fragment model), and polymorphic type key
function metaTypeFor(name, type, options) {
let metaType = `-mf-${name}`;
if (type) {
metaType += `$${type}`;
}
if (options && options.polymorphic) {
let typeKey = options.typeKey || 'type';
metaType += `$${typeKey}`;
}
return metaType;
}
/**
`MF.fragment` defines an attribute on a `DS.Model` or `MF.Fragment`. Much
like `DS.belongsTo`, it creates a property that returns a single fragment of
the given type.
It takes an optional hash as a second parameter, currently supported options
are:
- `defaultValue`: An object literal or a function to be called to set the
attribute to a default value if none is supplied. Values are deep copied
before being used. Note that default values will be passed through the
fragment's serializer when creating the fragment. Defaults to `null`.
- `polymorphic`: Whether or not the fragments in the array can be child
classes of the given type.
- `typeKey`: If `polymorphic` is true, the property to use as the fragment
type in the normalized data. Defaults to `type`.
Example
```javascript
App.Person = DS.Model.extend({
name: MF.fragment('name', { defaultValue: {} })
});
App.Name = MF.Fragment.extend({
first: DS.attr('string'),
last: DS.attr('string')
});
```
@namespace MF
@method fragment
@param {String} type the fragment type
@param {Object} options a hash of options
@return {Attribute}
*/
function fragment(declaredModelName, options) {
options = options || {};
let metaType = metaTypeFor('fragment', declaredModelName, options);
function setupFragment(store, record, key) {
let internalModel = internalModelFor(record);
let data = getWithDefault(internalModel, key, options, 'object');
let fragment = internalModel._recordData.getFragment(key);
// Regardless of whether being called as a setter or getter, the fragment
// may not be initialized yet, in which case the data will contain a
// raw response or a stashed away fragment
// If we already have a processed fragment in _data and our current fragment is
// null simply reuse the one from data. We can be in this state after a rollback
// for example
if (!fragment && isFragment(data)) {
fragment = data;
// Else initialize the fragment
} else if (data && data !== fragment) {
if (fragment) {
// It's important to update internal model data to fragment before calling
// setFragmentData since updating the fragment can trigger calls to
// notifyPropertyChange which can in turn call setupFragment again, creating
// an infinite recursion loop. Since it's a reference anyway doing the
// assignation sooner has no side effect
internalModel._recordData._data[key] = fragment;
setFragmentData(fragment, data);
} else {
fragment = createFragment(store, declaredModelName, record, key, options, data);
internalModel._recordData._data[key] = fragment;
}
} else {
// Handle the adapter setting the fragment to null
fragment = data;
}
return fragment;
}
function setFragmentValue(record, key, fragment, value) {
let store = record.store;
let internalModel = internalModelFor(record);
assert(`You can only assign \`null\`, an object literal or a '${declaredModelName}' fragment instance to this property`, value === null || typeOf(value) === 'object' || isInstanceOfType(store.modelFor(declaredModelName), value));
if (!value) {
fragment = null;
} else if (isFragment(value)) {
// A fragment instance was given, so just replace the existing value
fragment = setFragmentOwner(value, record, key);
} else if (!fragment) {
// A property hash was given but the property was null, so create a new
// fragment with the data
fragment = createFragment(store, declaredModelName, record, key, options, value);
} else {
// The fragment already exists and a property hash is given, so just set
// its values and let the state machine take care of the dirtiness
setProperties(fragment, value);
return fragment;
}
if (internalModel._recordData._data[key] !== fragment) {
fragmentDidDirty(record, key, fragment);
} else {
fragmentDidReset(record, key);
}
return fragment;
}
return fragmentProperty(metaType, options, setupFragment, setFragmentValue);
}
/**
`MF.fragmentArray` defines an attribute on a `DS.Model` or `MF.Fragment`.
Much like `DS.hasMany`, it creates a property that returns an array of
fragments of the given type. The array is aware of its original state and so
has a `hasDirtyAttributes` property and a `rollback` method.
It takes an optional hash as a second parameter, currently supported options
are:
- `defaultValue`: An array literal or a function to be called to set the
attribute to a default value if none is supplied. Values are deep copied
before being used. Note that default values will be passed through the
fragment's serializer when creating the fragment. Defaults to an empty
array.
- `polymorphic`: Whether or not the fragments in the array can be child
classes of the given type.
- `typeKey`: If `polymorphic` is true, the property to use as the fragment
type in the normalized data. Defaults to `type`.
Example
```javascript
App.Person = DS.Model.extend({
addresses: MF.fragmentArray('address')
});
App.Address = MF.Fragment.extend({
street: DS.attr('string'),
city: DS.attr('string'),
region: DS.attr('string'),
country: DS.attr('string')
});
```
@namespace MF
@method fragmentArray
@param {String} type the fragment type (optional)
@param {Object} options a hash of options
@return {Attribute}
*/
function fragmentArray(modelName, options) {
options || (options = {});
let metaType = metaTypeFor('fragment-array', modelName, options);
return fragmentArrayProperty(metaType, options, function createFragmentArray(record, key) {
return FragmentArray.create({
type: modelName,
options: options,
name: key,
owner: record
});
});
}
/**
`MF.array` defines an attribute on a `DS.Model` or `MF.Fragment`. It creates a
property that returns an array of values of the given primitive type. The
array is aware of its original state and so has a `hasDirtyAttributes`
property and a `rollback` method.
It takes an optional hash as a second parameter, currently supported options
are:
- `defaultValue`: An array literal or a function to be called to set the
attribute to a default value if none is supplied. Values are deep copied
before being used. Note that default values will be passed through the
fragment's serializer when creating the fragment.
Example
```javascript
App.Person = DS.Model.extend({
aliases: MF.array('string')
});
```
@namespace MF
@method array
@param {String} type the type of value contained in the array
@param {Object} options a hash of options
@return {Attribute}
*/
function array(type, options) {
if (typeof type === 'object') {
options = type;
type = undefined;
} else {
options || (options = {});
}
let metaType = metaTypeFor('array', type);
return fragmentArrayProperty(metaType, options, function createStatefulArray(record, key) {
return StatefulArray.create({
options: options,
name: key,
owner: record
});
});
}
function fragmentProperty(type, options, setupFragment, setFragmentValue) {
options = options || {};
let meta = {
type: type,
isAttribute: true,
isFragment: true,
options: options
};
return computed({
get(key) {
let internalModel = internalModelFor(this);
let fragment = setupFragment(this.store, this, key);
return internalModel._recordData.setFragment(key, fragment);
},
set(key, value) {
let internalModel = internalModelFor(this);
let fragment = setupFragment(this.store, this, key);
fragment = setFragmentValue(this, key, fragment, value);
return internalModel._recordData.setFragment(key, fragment);
}
}).meta(meta);
}
function fragmentArrayProperty(metaType, options, createArray) {
function setupFragmentArray(store, record, key) {
let internalModel = internalModelFor(record);
let data = getWithDefault(internalModel, key, options, 'array');
let fragments = internalModel._recordData.getFragment(key) || null;
// If we already have a processed fragment in _data and our current fragment is
// null simply reuse the one from data. We can be in this state after a rollback
// for example
if (data instanceof StatefulArray && !fragments) {
fragments = data;
// Create a fragment array and initialize with data
} else if (data && data !== fragments) {
fragments || (fragments = createArray(record, key));
internalModel._recordData._data[key] = fragments;
fragments.setupData(data);
} else {
// Handle the adapter setting the fragment array to null
fragments = data;
}
return fragments;
}
function setFragmentValue(record, key, fragments, value) {
let internalModel = internalModelFor(record);
if (isArray(value)) {
fragments || (fragments = createArray(record, key));
fragments.setObjects(value);
} else if (value === null) {
fragments = null;
} else {
assert('A fragment array property can only be assigned an array or null');
}
if (internalModel._recordData._data[key] !== fragments || (fragments && get(fragments, 'hasDirtyAttributes'))) {
fragmentDidDirty(record, key, fragments);
} else {
fragmentDidReset(record, key);
}
return fragments;
}
return fragmentProperty(metaType, options, setupFragmentArray, setFragmentValue);
}
/**
`MF.fragmentOwner` defines a read-only attribute on a `MF.Fragment`
instance. The attribute returns a reference to the fragment's owner
record.
Example
```javascript
App.Person = DS.Model.extend({
name: MF.fragment('name')
});
App.Name = MF.Fragment.extend({
first: DS.attr('string'),
last: DS.attr('string'),
person: MF.fragmentOwner()
});
```
@namespace MF
@method fragmentOwner
@return {Attribute}
*/
function fragmentOwner() {
return computed(function() {
assert('Fragment owner properties can only be used on fragments.', isFragment(this));
return internalModelFor(this)._recordData.getOwner();
}).meta({
isFragmentOwner: true
}).readOnly();
}
// The default value of a fragment is either an array or an object,
// which should automatically get deep copied
function getDefaultValue(record, options, type) {
let value;
if (typeof options.defaultValue === 'function') {
value = options.defaultValue();
} else if ('defaultValue' in options) {
value = options.defaultValue;
} else if (type === 'array') {
value = [];
} else {
return null;
}
assert(`The fragment's default value must be an ${type}`, (typeOf(value) == type) || (value === null));
// No need to copy value if it was a function
if (typeof options.defaultValue === 'function') {
return value;
}
// Create a deep copy of the resulting value to avoid shared reference errors
return copy(value, true);
}
// Returns the value of the property or the default propery
function getWithDefault(internalModel, key, options, type) {
if (key in internalModel._recordData._data) {
return internalModel._recordData._data[key];
} else {
return getDefaultValue(internalModel, options, type);
}
}
export {
fragment,
fragmentArray,
array,
fragmentOwner
};