-
Notifications
You must be signed in to change notification settings - Fork 0
/
novemdoc.js
457 lines (386 loc) · 11.6 KB
/
novemdoc.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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
import flat from "flat";
import dot from "dot-object";
import _ from 'lodash';
import defaultsDeep from 'lodash/defaultsDeep.js';
import packageLogger from './pkgLogger.js';
const log = packageLogger.subLogger('ndoc');
log.init("Loading NovemDoc...");
const DEBUG=true;
/**
Novem Document standards.
NovemDoc wraps a nested hash (pute object) structure, ready to serialize
with no conversion of a core data structure.
this.dict
The primary purpose is to wrap a JSON serializable object allowing the dictionary to be
used as a representation of the class. It:
1. allows setting and getting and pushing elements with dot notation
2. allows transformation processing (flatenning, diffs, storage, query)
3. decomposition, recomposition
4. document type system
## Current Version
Chaned to ES6 module, mongo behavior removed to NDocRecipe system.
*/
export class NovemDoc
{
constructor (arg1, arg2)
{
/* argument forms:
(0) (): create empty document
(1) (string, object): doctype first, and other settings separate
(2) (object): doctype in settings.
Settings:
{
doctype: string document type
// only one should be set
json: <json string>,
dict: <json serializable object>,
dotSchema: <FUTURE table of dot notation list>
}
*/
let initarg;
let doctype;
if (typeof(arg1) === "string")
{
doctype = arg1;
initarg = arg2;
}
else
{
initarg = arg1;
}
if (!initarg) {
initarg = {dict:{}};
}
if (doctype) {
// if the user passes in doctype, that overwrites whatever
// might already be in the dictionary options.
initarg.doctype = doctype;
}
// argument adaptation
if (initarg._ndoc)
{ // this means the initarg IS a previous doc body
this.dict = initarg;
}
else if (initarg.dict || initarg.data)
{ // this is a regular opts argument with basic
// json-serialiazable js obj
this.dict = initarg.dict ? initarg.dict : initarg.data;
}
else if (initarg.json)
{ // this is a regular opts argument to pass in
// actual JSON (string)
this.dict = JSON.parse(initarg.json);
}
// initialization has had chance to build dict, make sure
if (!this.dict) this.dict = {};
if (initarg.doctype)
{
//this.set("_ndoc.doctype", initarg.doctype);
this.doctype = initarg.doctype;
}
if (this.doctype == undefined)
{
this.doctype == "untyped";
}
this.mongodb = null;
}
//
// STATIC
//
static from_dict(obj)
{
const retval = new this({dict:obj});
if (this.modelDoctype) {
retval.doctype = this.modelDoctype;
}
return retval;
}
static from_thing(obj)
{ /* Create from dict or pass back NovemDoc.
Is convienience gate for function that
wants a NovemDoc but accept dicts.
*/
if (obj instanceof NovemDoc) {
return obj;
}
// else take this as a dict
return this.from_dict(obj);
}
// utility to get properties from objects without wrapping with a doc
static getprop(key, dict)
{
return dot.pick(key, dict);
}
// utility to set properties from objects without wrapping with a doc
static setprop(key, val, dict)
{
dot.set(key, val, dict);
}
static clean_empty(dict) {
if (_.isEmpty(dict)) return null;
const cleaned = _.transform(dict, function(result, value, key, object) {
if (_.isObject(value)) {
if (_.isEmpty(value)) {
delete object[key];
} else {
const cleanValue = NovemDoc.clean_empty(value);
if (!cleanValue || (_.isObject(cleanValue) && _.isEmpty(cleanValue))) {
delete object[key];
}
}
}
// console.log(`nd252: transform
// key=${JSON.stringify(key)}
// value=${JSON.stringify(value)}
// result=${JSON.stringify(result)}
// object=${JSON.stringify(object)}`
// );
return true;
}, dict);
return _.isEmpty(cleaned) ? null : cleaned;
}
//////
//
// PROPERTIES
//
//////
get doctype() {
return this.get("_ndoc.doctype");
}
set doctype(val)
{
this.set("_ndoc.doctype", val);
}
// @@Future: have getter/setter for dict to, e.g., enforce readonly or trigger
// subscription event, which is in particular also not implemented yet.
//
//
// Special member functions for internal use
//
//
// GENERAL MEMBER FUNCTIONS
//
applyDeep(applicationDict) {
// @@WHY: not doing this
// defaultsDeep(applicationDict, this.dict);
// this.dict = applicationDict;
// We want to support object decomposition where existing
// sub-objects might be held by other parts of the process
// for separate work. Recomposition is not required in general
// and is left for the application. Instead...
// 1. we want to flatten, NovemDict does that, might
// want to have a static method for this.
const appDoc = NovemDoc.from_thing(applicationDict);
// 2. flatten applicationDict
const appFlat = appDoc.flatten();
// 3. apply the key/vals to current dict
// NOTE: dotobject can do this.
_.forEach(appFlat, (value, key) => {
// display removed
// cont blankOut = (key.indexOf("pass")>=0)
// || (key.indexOf("key")>=0)
// || (key.indexOf("secret")>=0)
// const displayVal = (key.indexOf("pass")>=0) ? "xxxxxxxx" : value;
// log.debug(`applying (${this.doctype}): ${key} = ${displayVal}`)
this.set(key, value);
});
// 4. done
// can have passwored, SECRETS log.debug(`(nd193) this.dict after application:\n ${this.json(true)}`);
return this;
}
get data() {
return this.dict;
}
dataCopy() {
return _.cloneDeep(this.dict);
}
difference(object) {
/* @@REFACTOR Note:
This name is misleading because this essentially returns a copy
of things in "our" object have different values or don't exist in
the other (their) object. You could apply it to deep insert values
in the other.
*/
const base = this.dict;
if (object.dict) {
// duck typing as novemdoc
object = object.dict;
}
function changes(object, base) {
return _.transform(object, function(result, value, key) {
if (!_.isEqual(value, base[key])) {
result[key] = (_.isObject(value) && _.isObject(base[key])) ? changes(value, base[key]) : value;
}
});
}
return changes(object, base);
}
betterDiff(object) {
// @@NEED to design bestDiff soon
const base = this.dict;
if (object.dict) {
// duck typing as novemdoc
object = object.dict;
}
function changes(object, base) {
return _.transform(object, function(result, value, key) {
if (!_.isEqual(value, base[key])) {
result[key] = (_.isObject(value) && _.isObject(base[key])) ? changes(value, base[key]) : value;
if (!_.isObject(value)) result[`their_${key}`] = `${base[key]}`;
}
});
}
const sosoDiff = changes(object, base);
// const cleanDiff = sosoDiff; // for Developer Exercises
const cleanDiff = NovemDoc.clean_empty(sosoDiff);
return cleanDiff;
}
has_key(key)
{
// @@badnaming: _ means static
var val = dot.pick(key, this.dict);
return typeof(val) != "undefined";
}
keys()
{
return Object.keys(this.dict);
}
flatten()
{
return flat(this.dict);
}
json(pretty){
var retv = null;
if (pretty)
{
retv = JSON.stringify(this.dict, null, 4)
}
else
{
retv = JSON.stringify(this.dict);
}
return retv;
}
toJSON(arg) {
//console.log('nd190:', arg)
return this.json();
}
meta(key, value) {
// get/set meta data
const hasValue = arguments.length >= 2;
if (!hasValue) {
return this.get(`_ndoc.${key}`);
} else {
this.set(`_ndoc.${key}`, value);
}
}
setMeta(key, value)
{
key = `_ndoc.${key}`;
dot.set(key, value, this.dict);
}
getMeta(key, def)
{
key = `_ndoc.${key}`;
if (typeof(def) == "undefined")
{
def = null;
}
var rval = dot.pick(key, this.dict);
if (!rval) { rval = def }
return rval;
}
metaPush(key, value) {
this.push(`_ndoc.${key}`, value)
}
metaPop(key, def) {
return this.pop(`_ndoc.${key}`, def);
}
setFlat(key, value)
{
this.dict[key] = value;
}
set(key, value)
{
dot.set(key, value, this.dict);
}
getFlat(key, def) {
if (typeof(def)=="undefined")
{
def = null;
}
let rval = this.dict[key];
if (!rval) {rval = def}
return rval;
}
get(key, def)
{
if (typeof(def) == "undefined")
{
def = null;
}
var rval = dot.pick(key, this.dict);
if (!rval) { rval = def }
return rval;
}
push(key, value) {
let target = this.get(key);
if (target === null) {
target = [];
}
target.push(value);
}
pop(key, value) {
let target = this.get(key);
if (target === null) {
return null;
}
return target.pop();
}
remove (key)
{
if (DEBUG)
{
var oval = dot.pick(key, this.dict); // could remove with this
log.detail(`remove: ${key} was: ${oval}`);
}
dot.remove(key, this.dict);
}
toString(opts) {
return this.json(true);
}
toSource(opts) {
return this.json(true);
}
/////
//
// Documents Composition and Decomposition
//
getSubdoc(key, opts) {
/* opts:
addRecompose
*/
if (!opts) opts = {};
opts = _.defaultsDeep(opts, {
addRecompose: false,
addDoctype: true,
});
const subdict = this.get(key);
// check if object
const isObject = subdict instanceof Object;
const isArray = subdict instanceof Array;
if (!isObject || isArray) {
// no document to return
return null;
}
// wrap in novemdoc
const rdoc = new NovemDoc({dict:subdict});
// optionally add recomposition information
if (opts.addRecompose) {
rdoc.meta("subdoc.fromKey", key);
}
// return subdocument: note it's pointing directly into this document!
return rdoc;
}
}
export default NovemDoc;