virtuals.js
6.07 KB
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
import _ from 'lodash';
import Promise from 'bluebird';
// Virtuals Plugin
// Allows getting/setting virtual (computed) properties on model instances.
// -----
module.exports = function (Bookshelf) {
const proto = Bookshelf.Model.prototype;
const Model = Bookshelf.Model.extend({
outputVirtuals: true,
// If virtual properties have been defined they will be created
// as simple getters on the model.
constructor: function (attributes, options) {
proto.constructor.apply(this, arguments);
const { virtuals } = this;
if (_.isObject(virtuals)) {
for (const virtualName in virtuals) {
let getter, setter;
if (virtuals[virtualName].get) {
getter = virtuals[virtualName].get;
setter = virtuals[virtualName].set
? virtuals[virtualName].set
: undefined;
} else {
getter = virtuals[virtualName];
}
Object.defineProperty(this, virtualName, {
enumerable: true,
get: getter,
set: setter
});
}
}
},
// Passing `{virtuals: true}` or `{virtuals: false}` in the `options`
// controls including virtuals on function-level and overrides the
// model-level setting
toJSON: function(options) {
let attrs = proto.toJSON.call(this, options);
if (options && options.omitNew && this.isNew()) {
return attrs;
}
if (!options || options.virtuals !== false) {
if ((options && options.virtuals === true) || this.outputVirtuals) {
attrs = _.extend(attrs, getVirtuals(this));
}
}
return attrs;
},
// Allow virtuals to be fetched like normal properties
get: function (attr) {
const { virtuals } = this;
if (_.isObject(virtuals) && virtuals[attr]) {
return getVirtual(this, attr);
}
return proto.get.apply(this, arguments);
},
// Allow virtuals to be set like normal properties
set: function(key, value, options) {
if (key == null) {
return this;
}
// Determine whether we're in the middle of a patch operation based on the
// existence of the `patchAttributes` object.
const isPatching = this.patchAttributes != null;
// Handle `{key: value}` style arguments.
if (_.isObject(key)) {
const nonVirtuals = _.omitBy(key, _.bind(setVirtual, this));
if (isPatching) {
_.extend(this.patchAttributes, nonVirtuals);
}
// Set the non-virtual attributes as normal.
return proto.set.call(this, nonVirtuals, options);
}
// Handle `"key", value` style arguments for virtual setter.
if (setVirtual.call(this, value, key)) {
return this;
}
// Handle `"key", value` style assignment call to be added to patching
// attributes if set("key", value, ...) called from inside a virtual setter.
if (isPatching) {
this.patchAttributes[key] = value;
}
return proto.set.apply(this, arguments);
},
// Override `save` to keep track of state while doing a `patch` operation.
save: function(key, value, options) {
let attrs;
// Handle both `"key", value` and `{key: value}` -style arguments.
if (key == null || typeof key === "object") {
attrs = key && _.clone(key) || {};
options = _.clone(value) || {};
} else {
(attrs = {})[key] = value;
options = options ? _.clone(options) : {};
}
// Determine whether which kind of save we will do, update or insert.
options.method = this.saveMethod(options);
// Check if we're going to do a patch, in which case deal with virtuals now.
if (options.method === 'update' && options.patch) {
// Extend the model state to collect side effects from the virtual setter
// callback. If `set` is called, this object will be updated in addition
// to the normal `attributes` object.
this.patchAttributes = {};
// Any setter could throw. We need to reject `save` if they do.
try {
// Check if any of the patch attributes are virtuals. If so call their
// setter. Any setter that calls `this.set` will be modifying
// `this.patchAttributes` instead of `this.attributes`.
_.each(attrs, (function (value, key) {
if (setVirtual.call(this, value, key)) {
// This was a virtual, so remove it from the attributes to be
// passed to `Model.save`.
delete attrs[key];
}
}).bind(this));
// Now add any changes that occurred during the update.
_.extend(attrs, this.patchAttributes);
} catch (e) {
return Promise.reject(e);
} finally {
// Delete the temporary object.
delete this.patchAttributes;
}
}
return proto.save.call(this, attrs, options);
}
});
// Underscore methods that we want to implement on the Model.
const modelMethods = ['keys', 'values', 'toPairs', 'invert', 'pick', 'omit'];
// Mix in each Lodash method as a proxy to `Model#attributes`.
_.each(modelMethods, function(method) {
Model.prototype[method] = function() {
return _[method](_.extend({}, this.attributes, getVirtuals(this)), ...arguments);
};
});
function getVirtual(model, virtualName) {
const { virtuals } = model;
if (_.isObject(virtuals) && virtuals[virtualName]) {
return virtuals[virtualName].get ? virtuals[virtualName].get.call(model)
: virtuals[virtualName].call(model);
}
}
function getVirtuals(model) {
const { virtuals } = model;
const attrs = {};
if (virtuals != null) {
for (const virtualName in virtuals) {
attrs[virtualName] = getVirtual(model, virtualName);
}
}
return attrs;
}
function setVirtual(value, key) {
const virtual = this.virtuals && this.virtuals[key];
if (virtual) {
if (virtual.set) {
virtual.set.call(this, value);
}
return true;
}
}
Bookshelf.Model = Model;
};