| 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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789 |
1
1
1
1
1
1
1
1
1
1
2
33
16
2
3
3
2
2
16
16
1
1
219
32
32
32
32
10
10
10
1
1
1
2
2
1
1
1
2
2
1
1
1
13
13
31
53
53
31
12
12
10
12
12
19
19
18
18
18
31
13
32
32
32
41
32
32
1
94
94
87
87
7
94
94
94
3
91
91
91
1
43
43
15
94
96
4
92
28
76
92
147
105
105
105
1
1
1
7
5
3
2
2
1
5
1
1
1
1
1
1
34
34
50
1
34
1
1
10
10
10
10
10
1
10
10
65
65
65
132
64
64
45
8
8
45
45
45
45
45
1
44
44
44
2
45
45
45
8
8
3
8
5
8
8
8
8
8
8
8
8
8
8
84
8
33
32
32
11
11
21
21
21
8
12
12
12
8
84
8
11
11
11
11
11
11
11
78
78
11
1
1
64
64
63
1
1
172
172
172
172
1
49
105
105
17
17
17
17
17
17
17
17
17
2
2
2
17
18
10
5
5
5
5
5
10
5
5
5
5
10
8
8
8
11
6
6
6
6
5
17
17
88
26
88
19
19
19
69
88
29
39
10
10
10
10
29
1
39
12
12
12
12
12
27
18
21
21
8
8
13
1
139
276
5
1
4
5
5
271
3
271
55
55
5
55
55
17
2
16
14
14
2
38
216
139
1
6
3
2
2
2
2
2
1
3
3
3
3
3
3
3
1
49
49
105
17
88
26
26
62
49
| ###
# HumbleJS
# ========
#
# ODM for MongoDB.
#
###
_ = require 'underscore'
util = require 'util'
moment = require 'moment'
mongojs = require 'mongojs'
# Allow this stuff to work with fibrousity
try
Future = require('fibrousity').Future
Object.defineProperty exports, 'fibers_enabled', enumerable: true, get: ->
# This is the only way I could think of to test whether we're currently in
# a Fiber or not, without actual access to the Fiber module
try
process.nextTick.future().wait()
catch err
if err.message == "Can't wait without a fiber"
return false
throw err
true
catch
Future = {}
exports.fibers_enabled = fibers_enabled = false
# This allows you to control whether queries are automatically mapped
exports.auto_map_queries = true
###
# The database class
###
class Database
constructor: (args...) ->
db = mongojs.apply mongojs, args
Object.defineProperty this, 'collection', get: -> (args...) ->
db.collection.apply db, args
callable = (name) ->
# Extra fancy shortcut for getting the DB instance directly
Iif not name?
return db
# Super fancy shortcut for getting a collection
db.collection name
callable.__proto__ = this
return callable
document: (args..., mapping) ->
collection = @collection.apply @collection, args
return new Document collection, mapping
exports.Database = Database
###
# The document class
###
class Document
constructor: (collection, mapping) ->
Object.defineProperty this, 'collection', get: -> collection
# Ensure we always have a mapping, even if it's empty
mapping ?= {}
# Closure over the document class
_document = this
# Create a prototype for the Document instances that already has all
# the mapped attribute getters and setters
@instanceProto = {}
Object.defineProperties @instanceProto,
# We store the schema for later
__schema: value: mapping
# Convenience methods
save: get: -> (args...) ->
args.unshift this
_document.save.apply _document, args
insert: get: -> (args...) ->
args.unshift this
_document.insert.apply _document, args
update: get: -> (args...) ->
if not this._id?
throw new Error "Cannot update without '_id' field"
args.unshift _id: this._id
_document.update.apply _document, args
remove: get: -> (args...) ->
if not this._id?
throw new Error "Cannot remove without '_id' field"
args.unshift _id: this._id
_document.remove.apply _document, args
forJson: get: -> () ->
_forJson = (json)->
for name, value of @
do (name, value) ->
# If it's an object, it's either an embedded mapping or a default
# value schema, which would be an arary
if _.isObject value
# Handle arrays, which are default values in the schema
if _.isArray value
[key, value] = value
if key not of json
# We reverse the order of name, key for this call since
# it's the inverse mapping of a normal document
value = _getDefault json, key, name, value
# We don't want to override the assignment, but we do want to
# ensure it's present
json[name] = value if key not of json and not _.isArray json
return
# We provide a default object, if it's not set in the key
_json = json[name] ? {}
# Make sure if there was a value set that's not an object that
# we don't continue to try to provide defaults into it
return if not _.isObject _json
# Recursively search for defaults within embedded documents
_forJson.call value, _json
# Set the recursively generated defaults back to the json if
# they actually exist
json[name] = _json unless _.isEmpty _json
return
# Return the JSON ready structure
json
_forJson.call @__schema, _transform @, @__inverse_schema, {}
# Recursively map the document class and prototype
_map @, mapping, @instanceProto
# Memoize the inverse mapping
Object.defineProperty @instanceProto, '__inverse_schema',
value: _invertSchema @instanceProto.__schema
# This makes the class returned also callable for syntactic sugar's sake
callable = (doc) =>
@new doc
callable.__proto__ = @
return callable
# Document wrapper method factory
_wrap = (method) ->
get: -> (query, args..., cb) ->
if exports.auto_map_queries and method isnt 'insert'
# Map queries, which should be the first argument
query = @_ query
# If we have arguments, the second argument is going to be a projection
# or update
if args.length and method isnt 'findAndModify'
args[0] = @_ args[0]
# If the callback isn't a function, but has a value (e.g. is an object)
# it could be a projection or update object, so we want to add it back to
# the args
Iif cb not instanceof Function and cb?
# Check if it's an object, e.g. a projection or update, and it's the
# second argument
if exports.auto_map_queries and (cb is Object cb) and (not args.length)
cb = @_ cb
args.push cb
cb = null
# Place the query or doc/docs to be saved or inserted back at the head of
# the arguments
args.unshift query
# If there's no callback specified, return a cursor instead
if method is 'find' and cb not instanceof Function
return new Cursor @, @collection.find.apply @collection, args
Iif exports.fibers_enabled and cb not instanceof Function
# Hey, we're in fibers mode, alrighty!
future = new Future()
args.push future.resolver()
try
@collection[method].apply @collection, args
catch err
# Throw synchronous errors via the future
future.throw err
# Get the returned value
doc = future.wait()
# If a document was returned, we define mappings on it
if util.isArray doc
doc = (@wrap d for d in doc)
else if doc isnt null
doc = @wrap doc
return doc
else
# This is regular callback mode
# Wrap these callbacks since they return docs
args.push @cb cb
@collection[method].apply @collection, args
Object.defineProperties @prototype,
###
# Return a new document instance.
#
# This is the same as doing ``new MyDocument()``.
###
new: value: (doc) ->
doc ?= {}
@wrap doc
###
# MongoJS method wrappers
###
find: _wrap 'find'
findOne: _wrap 'findOne'
findAndModify: _wrap 'findAndModify'
insert: _wrap 'insert'
update: _wrap 'update'
count: _wrap 'count'
remove: _wrap 'remove'
# MongoJS methods that don't return documents
save: get: -> @collection.save.bind @collection
###
# Helper for wrapping documents in a callback.
###
cb: value: (cb) ->
# This our callback wrapper that will munge the document
(err, doc) =>
# No doc or callback? Just get out
if not doc or not cb
return cb? err, doc
# If a document was returned, we define mappings on it
if util.isArray doc
doc = (@wrap d for d in doc)
else
doc = @wrap doc
# We use existence here to make sure we don't try to call non-functions
cb? err, doc
###
# Wrap an individual document
###
wrap: value: (doc) ->
_proxy doc, @instanceProto
###
# Transform keys in a query document into their mapped counterpart
###
_: value: (doc) ->
schema = @instanceProto.__schema
dest = {}
_transform doc, schema, dest
exports.Document = Document
###
# Cursor which wraps MongoJS cursors ensuring we get document mappings.
###
# TODO: shakefu test cursor chaining to ensure that it continues to wrap the
# cursor
class Cursor
constructor: (@document, @cursor) ->
# Wrapper method factory
_wrap = (method) ->
get: -> (args..., cb) ->
# If we don't have a callback, then we are chaining the cursor
if cb not instanceof Function
return new Cursor @document, @cursor[method].apply @cursor, args
# Otherwise we wrap the callback to return Document instances
args.push @document.cb cb
@cursor[method].apply @cursor, args
# Used for methods which return documents, not cursors
_wrap_doc = (method) ->
get: -> (args..., cb) ->
Eif not exports.fibers_enabled or cb instanceof Function
# If we don't have a callback, then we are trying to chain the cursor,
# which should throw an error for these methods, but we let the
# underlying implementation do that for us
Iif cb not instanceof Function
return new Cursor @document, @cursor[method].apply @cursor, args
# Otherwise we wrap the callback to return Document instances
args.push @document.cb cb
@cursor[method].apply @cursor, args
else
future = new Future()
args.push future.resolver()
try
@cursor[method].apply @cursor, args
catch err
# Throw synchronous errors via the future
future.throw err
# Get the returned value
doc = future.wait()
# If a document was returned, we define mappings on it
if util.isArray doc
doc = (@document.wrap d for d in doc)
else if doc isnt null and method isnt 'explain'
doc = @document.wrap doc
doc
Object.defineProperties @prototype,
batchSize: _wrap 'batchSize'
count: _wrap_doc 'count'
explain: _wrap_doc 'explain'
forEach: _wrap 'forEach'
limit: _wrap 'limit'
map: _wrap_doc 'map'
next: _wrap_doc 'next'
skip: _wrap 'skip'
sort: _wrap 'sort'
toArray: _wrap_doc 'toArray'
rewind: _wrap 'rewind'
destroy: _wrap 'destroy'
###
# Embedded documents
###
class EmbeddedDocument
constructor: (key, mapping) ->
Object.defineProperties @,
key: value: key
mapping: value: mapping
isEmbed: value: true
for key, value of mapping
@[key] = value
# This is a thin wrapper around EmbeddedDocument so we don't need to use the
# new keyword when instantiating document schemas
Embed = (key, mapping) ->
new EmbeddedDocument key, mapping
exports.Embed = Embed
###
# Sparse reports
###
class SparseReport extends Document
@MINUTE: 'minute'
@HOUR: 'hour'
@DAY: 'day'
@WEEK: 'week'
@MONTH: 'month'
@YEAR: 'year'
constructor: (collection, mapping, @options) ->
# Provide defaults to the attribute mapping for being lazy
mapping = _.defaults mapping,
total: 'total'
all: 'all'
events: 'events'
timestamp: 'timestamp'
# Initialize the document superclass
super collection, mapping
# Provide default options
@options ?= {}
@options = _.defaults @options,
sum: true
id_mark: '#'
# Make sparse report instances creatable with the new keyword
callable = (doc) =>
@new doc
callable.__proto__ = @
return callable
# Helper for getting a unix timestamp
getTimestamp: (timestamp) ->
timestamp ?= new Date()
timestamp = @getPeriod timestamp
timestamp = timestamp.unix()
# Helper for getting the current start of `timestamp`'s period
getPeriod: (timestamp) ->
moment.utc(timestamp).startOf @options.period
# Helper for creating the _id string used by the docs
getId: (identifier, timestamp) ->
timestamp = @getTimestamp timestamp
"#{identifier}#{@options.id_mark}#{_pad timestamp, 15}"
###
# Record events
###
record: (identifier, events, timestamp, callback) ->
# The timestamp is optional
if _.isFunction timestamp
callback = timestamp
timestamp = undefined
# Get the ID string and period start timestamp
_id = @getId identifier, timestamp
timestamp = @getPeriod(timestamp).toDate()
# Build our update increment clause
update = {}
# Keep a total count
update[@total] = 1
if _.isNumber(events)
# If events was provided as a number, then we use that for the total
update[@total] = events
else
# Otherwise, we traverse the evense object to build our update keys
for key of events
update[@events + '.' + key] = events[key]
# If a given event key has a higher total, we use that one, rather than
# summing the total of all the subkeys - this may be a behavior we want
# to make optional or change later
if events[key] > update[@total]
update[@total] = events[key]
# Set our period timestamp on the document
updateTimestamp = {}
updateTimestamp[@timestamp] = timestamp
# Create or update the document
@findAndModify
query: _id: _id
update:
$set: updateTimestamp
$inc: update
new: true
upsert: true
callback
###
# Return a report for `identifier` between `start` and `end` dates
###
get: (identifier, start, end, callback) ->
_this = @
# Handle optional arguments
if _.isFunction start
[start, callback] = [undefined, start]
if _.isFunction end
[end, callback] = [undefined, end]
# Get our start and ending date if not provided
start ?= new Date()
end ?= new Date()
# And our start and ending IDs
startId = @getId identifier, start
endId = @getId identifier, end
# Query for our documents
@find
_id:
$gte: startId
$lte: endId
(err, docs) ->
Ireturn callback(err, docs) if err
# The returned document includes the total count, the count per period
# and the count for each event subkey
compiled =
total: 0
all: []
events: {}
# Create a hash for compiling the totals for each period, and
# initialize it to zeroes
periods = _this.dateRange start, end
all = {}
for period in periods
all[period.getTime()] = 0
# Helper method for going through the report docs
compiler = (comp, doc) ->
for key of doc
val = doc[key]
if _.isNumber val
comp[key] ?= 0
comp[key] += val
else Eif _.isObject val
comp[key] ?= {}
compiler comp[key], val
else
# It shouldn't be anything other than a number
throw new Error "Expected number, got #{typeof val}"
# Go through all the documents found and aggregate their numbers
for doc in docs
compiled.total += doc.total ? 0
all[doc.timestamp.getTime()] = doc.total ? 0
compiler compiled.events, doc.events
# Go through the totals for each period and put them onto the all
# array. This might be inefficient for very large queries, and might
# rely on the JS engine preserving the correct key order, but it works
for period of all
compiled.all.push all[period]
callback err, compiled
###
# Return a range of period dates between `start` and `end`, inclusive.
###
dateRange: (start, end) ->
start = @getPeriod start
end = @getPeriod end
range = []
range.push start.toDate()
current = moment(start)
current.add 1, @options.period
while current.isBefore(end) or current.isSame(end)
range.push moment(current).toDate()
current.add 1, @options.period
return range
exports.SparseReport = SparseReport
###
# Helper to pad a number with leading zeros as a string.
###
_pad = (num, size) ->
Ireturn num unless num.toString().length < size
if num >= 0
return (Math.pow(10, size) + Math.floor(num)).toString().substring(1)
return '-'+(Math.pow(10, size-1) + Math.floor(0-num)).toString().substring(1)
###
# Helper to proxy an object prototype for instances
###
_proxy = (obj, proto) ->
# Create a proxy object so that assignments don't affect the prototype
proxy = {}
proxy.__proto__ = proto
# Swap the obj's prototype for our proxy
obj.__proto__ = proxy
obj
###
# Helper to recursively map properties on and build instance prototypes
###
_map = (obj, mapping, proto, parent_key) ->
for name, key of mapping
do (name, key) ->
if key.isEmbed
embed = key
key = embed.key
# We have to wrap the string key in a String object so we can add more
# objerties to it
embed_key = if parent_key then parent_key + '.' + key else key
embed_key = new String embed_key
# Define the mapped property
Object.defineProperty obj, name,
value: embed_key
enumerable: true
# Create the object we use for the embed prototypes
embed_proto = {}
# If we it's an embedded array, we need a different prototype
array_proto = {}
array_proto.__proto__ = Array.prototype
# Add a .new() method to embedded arrays to allow creation of new
# mapped embedded documents conveniently
Object.defineProperty array_proto, 'new', value: ->
new_obj = {}
@.push new_obj
return _proxy new_obj, embed_proto
# Define the property on the instance prototype
Object.defineProperty proto, name,
get: ->
# If the value exists in the doc, just return it
if key of @
if name is key
# We have to swap the prototype out here to prevent recursively
# calling the get descriptor
@.__proto__ = Object.prototype
existing = @[key]
@.__proto__ = proto
# The existing value may be undefined if it was an attribute
# whose name matched its key, and in that case we create a new
# key with an empty object
E@[key] = existing = {} if not existing?
else
existing = @[key]
if util.isArray existing
# If we have an array, we need to map all the embedded
# documents in that array
for item in existing
_proxy item, embed_proto
# As well as add the 'new' method to the array itself
existing = _proxy existing, array_proto
else
existing = _proxy existing, embed_proto
return existing
# Embeds don't support defaults right now, but if they did, that
# code would go right here
# For embedded items we have to save back a new object that we can
# hold subproperties on
value = {}
@[key] = value
return _proxy value, embed_proto
set: (value) ->
if name is key
# Avoiding infinite recursion by temporarily swapping out the
# prototype for a plain object.
@.__proto__ = Object.prototype
@[key] = value
@.__proto__ = proto
return @[key]
@[key] = value
# Save the submapping onto the Embed prototype
Object.defineProperty embed_proto, '___schema', value: embed.mapping
# Recursively map embedded keys
_map embed_key, embed.mapping, embed_proto, embed_key
else
if util.isArray key
# Split the key into the key and default value
[key, value] = key
# Add the property to the object we're maping
if parent_key
class_key = new String parent_key + '.' + key
Object.defineProperty obj, name,
value: class_key
enumerable: true
Object.defineProperty obj[name], 'key', value: key
else
Object.defineProperty obj, name,
value: key
enumerable: true
# Define the property on the instance prototype
Object.defineProperty proto, name,
configurable: true
get: ->
_getDefault @, name, key, value
set: (value) ->
if name is key
# Same as above, in the get: method, we're avoiding infinite
# recursion by temporarily swapping out the prototype for a plain
# object.
@.__proto__ = Object.prototype
@[key] = value
@.__proto__ = proto
return @[key]
@[key] = value
###
# Helper to get a default value
###
_getDefault = (doc, name, key, value) ->
if name is key
# This is a nasty, gnarly hack that removes the descriptor behavior defined
# on the prototype temporarily so we can try to access the value. Without
# this hack, this causes infinite recursion as the descriptor calls itself.
proto = doc.__proto__
doc.__proto__ = Object.prototype
Iif key of doc
val = doc[key]
doc.__proto__ = proto
Ireturn val if val
# If the value exists in the doc, just return it
else if key of doc
return doc[key]
# Store callable defaults onto the doc
val = value?()
if val isnt undefined
doc[key] = val
return val
# Return either the calc'd/stored default, or the raw default
return value
###
# Helper to map a document or query to a key set
###
_transform = (doc, schema, dest) ->
for name, value of doc
if name[0] == '$'
# If we have a special key, we pretty much skip transforming it and
# attempt to continue transforming subdocs
if util.isArray value
dest[name] = []
else
dest[name] = {}
_transform value, schema, dest[name]
continue
if '.' in name
# If the name is a dot-notation key, then we try to transform the parts
name = _transformDotted name, schema
if name of schema
# If we have a name in the schema, then we we need to transform it, and
# possibly handle embedded and arrays
key = schema[name]
# Handle keys which have default values
if util.isArray key
key = key[0]
key_name = if key.isEmbed then key.key else key
if key.isEmbed
# If it's embedded, we have to check if it's an array, or recursively
# map the embedded document
if util.isArray value
# Recursively map all the subdocs in the array
dest[key_name] = (_transform v, key, {} for v in value)
else
# Not an array? Check if it's an object or primitive
if value is Object value
dest[key_name] = {}
_transform value, key, dest[key_name]
else
# Must be a primitive
dest[key_name] = value
else
# Not an embedded doc, so we just transform the key
dest[key_name] = value
else
# This isn't a mapped property, so we just add it back
dest[name] = value
dest
###
# Helper to map dotted notation property names to key names
###
_transformDotted = (name, schema) ->
if '.' not in name
# If there's no more dots, we just attempt to transform the name
if name of schema
key = schema[name]
Eif util.isArray key
[key, default_value] = key
key = Iif key.isEmbed then key.key else key
return key
else
return name
# If we're here, there's more dots to map
dot = name.indexOf '.'
parts = name.slice dot + 1
name = name.slice 0, dot
# This could be redone with a stack instead of recursively, but I'd be
# surprised if anyone embeds more than 1-2 levels within a doc, so meh
Eif name of schema
key = schema[name]
key = Eif key.isEmbed then key.key else key
return key + '.' + _transformDotted parts, schema[name]
else
return name + '.' + parts
###
# Helper to invert object keys
###
_invertSchema = (schema) ->
inverse = {}
for key, value of schema
if value.isEmbed
inverse[value.key] = Embed key, _invertSchema value.mapping
else if util.isArray value
[value, default_value] = value
inverse[value] = key
else
inverse[value] = key
inverse
|