This repository has been archived by the owner on Jun 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
model.html
570 lines (362 loc) · 18.6 KB
/
model.html
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
<!DOCTYPE html>
<html>
<head>
<title>model.coffee</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page">
<a class="source" href="chaplin.html">
chaplin.coffee
</a>
<a class="source" href="application.html">
application.coffee
</a>
<a class="source" href="composer.html">
composer.coffee
</a>
<a class="source" href="controller.html">
controller.coffee
</a>
<a class="source" href="dispatcher.html">
dispatcher.coffee
</a>
<a class="source" href="composition.html">
composition.coffee
</a>
<a class="source" href="event_broker.html">
event_broker.coffee
</a>
<a class="source" href="history.html">
history.coffee
</a>
<a class="source" href="route.html">
route.coffee
</a>
<a class="source" href="router.html">
router.coffee
</a>
<a class="source" href="support.html">
support.coffee
</a>
<a class="source" href="sync_machine.html">
sync_machine.coffee
</a>
<a class="source" href="utils.html">
utils.coffee
</a>
<a class="source" href="mediator.html">
mediator.coffee
</a>
<a class="source" href="collection.html">
collection.coffee
</a>
<a class="source" href="model.html">
model.coffee
</a>
<a class="source" href="collection_view.html">
collection_view.coffee
</a>
<a class="source" href="layout.html">
layout.coffee
</a>
<a class="source" href="view.html">
view.coffee
</a>
</div>
</li>
</ul>
<ul class="sections">
<li id="title">
<div class="annotation">
<h1>model.coffee</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
</div>
<div class="content"><div class='highlight'><pre><span class="string">'use strict'</span>
_ = <span class="built_in">require</span> <span class="string">'underscore'</span>
Backbone = <span class="built_in">require</span> <span class="string">'backbone'</span>
utils = <span class="built_in">require</span> <span class="string">'chaplin/lib/utils'</span>
EventBroker = <span class="built_in">require</span> <span class="string">'chaplin/lib/event_broker'</span></pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<p>Private helper function for serializing attributes recursively,
creating objects which delegate to the original attributes
in order to protect them from changes.</p>
</div>
<div class="content"><div class='highlight'><pre><span class="function"><span class="title">serializeAttributes</span> = <span class="params">(model, attributes, modelStack)</span> -></span></pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
<p>Create a delegator object.</p>
</div>
<div class="content"><div class='highlight'><pre> delegator = utils.beget attributes</pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-4">¶</a>
</div>
<p>Add model to stack.</p>
</div>
<div class="content"><div class='highlight'><pre> modelStack ?= {}
modelStack[model.cid] = <span class="literal">true</span></pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-5">¶</a>
</div>
<p>Map model/collection to their attributes. Create a property
on the delegator that shadows the original attribute.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">for</span> key, value <span class="keyword">of</span> attributes</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-6">¶</a>
</div>
<p>Handle models.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">if</span> value <span class="keyword">instanceof</span> Backbone.Model
delegator[key] = serializeModelAttributes value, model, modelStack</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-7">¶</a>
</div>
<p>Handle collections.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">else</span> <span class="keyword">if</span> value <span class="keyword">instanceof</span> Backbone.Collection
serializedModels = []
<span class="keyword">for</span> otherModel <span class="keyword">in</span> value.models
serializedModels.push(
serializeModelAttributes(otherModel, model, modelStack)
)
delegator[key] = serializedModels</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-8">¶</a>
</div>
<p>Remove model from stack.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">delete</span> modelStack[model.cid]</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-9">¶</a>
</div>
<p>Return the delegator.</p>
</div>
<div class="content"><div class='highlight'><pre> delegator</pre></div></div>
</li>
<li id="section-10">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-10">¶</a>
</div>
<p>Serialize the attributes of a given model
in the context of a given tree.</p>
</div>
<div class="content"><div class='highlight'><pre><span class="function"><span class="title">serializeModelAttributes</span> = <span class="params">(model, currentModel, modelStack)</span> -></span></pre></div></div>
</li>
<li id="section-11">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-11">¶</a>
</div>
<p>Nullify circular references.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">return</span> <span class="literal">null</span> <span class="keyword">if</span> model <span class="keyword">is</span> currentModel <span class="keyword">or</span> model.cid <span class="keyword">of</span> modelStack</pre></div></div>
</li>
<li id="section-12">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-12">¶</a>
</div>
<p>Serialize recursively.</p>
</div>
<div class="content"><div class='highlight'><pre> attributes = <span class="keyword">if</span> <span class="keyword">typeof</span> model.getAttributes <span class="keyword">is</span> <span class="string">'function'</span></pre></div></div>
</li>
<li id="section-13">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-13">¶</a>
</div>
<p>Chaplin models.</p>
</div>
<div class="content"><div class='highlight'><pre> model.getAttributes()
<span class="keyword">else</span></pre></div></div>
</li>
<li id="section-14">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-14">¶</a>
</div>
<p>Backbone models.</p>
</div>
<div class="content"><div class='highlight'><pre> model.attributes
serializeAttributes model, attributes, modelStack</pre></div></div>
</li>
<li id="section-15">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-15">¶</a>
</div>
<p>Abstraction that adds some useful functionality to backbone model.</p>
</div>
<div class="content"><div class='highlight'><pre>module.<span class="built_in">exports</span> = <span class="class"><span class="keyword">class</span> <span class="title">Model</span> <span class="keyword">extends</span> <span class="title">Backbone</span>.<span class="title">Model</span></span></pre></div></div>
</li>
<li id="section-16">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-16">¶</a>
</div>
<p>Mixin an EventBroker.</p>
</div>
<div class="content"><div class='highlight'><pre> _.extend <span class="property">@prototype</span>, EventBroker</pre></div></div>
</li>
<li id="section-17">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-17">¶</a>
</div>
<p>This method is used to get the attributes for the view template
and might be overwritten by decorators which cannot create a
proper <code>attributes</code> getter due to ECMAScript 3 limits.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">getAttributes</span>:<span class="function"> -></span>
<span class="property">@attributes</span></pre></div></div>
</li>
<li id="section-18">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-18">¶</a>
</div>
<p>Return an object which delegates to the attributes
(i.e. an object which has the attributes as prototype)
so primitive values might be added and altered safely.
Map models to their attributes, recursively.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">serialize</span>:<span class="function"> -></span>
serializeAttributes <span class="keyword">this</span>, <span class="property">@getAttributes</span>()</pre></div></div>
</li>
<li id="section-19">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-19">¶</a>
</div>
<h2 id="disposal">Disposal</h2>
</div>
</li>
<li id="section-20">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-20">¶</a>
</div>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">disposed</span>: <span class="literal">false</span>
<span class="attribute">dispose</span>:<span class="function"> -></span>
<span class="keyword">return</span> <span class="keyword">if</span> <span class="property">@disposed</span></pre></div></div>
</li>
<li id="section-21">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-21">¶</a>
</div>
<p>Fire an event to notify associated collections and views.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@trigger</span> <span class="string">'dispose'</span>, <span class="keyword">this</span></pre></div></div>
</li>
<li id="section-22">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-22">¶</a>
</div>
<p>Unbind all global event handlers.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@unsubscribeAllEvents</span>()</pre></div></div>
</li>
<li id="section-23">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-23">¶</a>
</div>
<p>Unbind all referenced handlers.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@stopListening</span>()</pre></div></div>
</li>
<li id="section-24">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-24">¶</a>
</div>
<p>Remove all event handlers on this module.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@off</span>()</pre></div></div>
</li>
<li id="section-25">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-25">¶</a>
</div>
<p>Remove the collection reference, internal attribute hashes
and event handlers.</p>
</div>
<div class="content"><div class='highlight'><pre> properties = [
<span class="string">'collection'</span>,
<span class="string">'attributes'</span>, <span class="string">'changed'</span>
<span class="string">'_escapedAttributes'</span>, <span class="string">'_previousAttributes'</span>,
<span class="string">'_silent'</span>, <span class="string">'_pending'</span>,
<span class="string">'_callbacks'</span>
]
<span class="keyword">delete</span> <span class="keyword">this</span>[prop] <span class="keyword">for</span> prop <span class="keyword">in</span> properties</pre></div></div>
</li>
<li id="section-26">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-26">¶</a>
</div>
<p>Finished.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@disposed</span> = <span class="literal">true</span></pre></div></div>
</li>
<li id="section-27">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-27">¶</a>
</div>
<p>You’re frozen when your heart’s not open.</p>
</div>
<div class="content"><div class='highlight'><pre> Object.freeze? <span class="keyword">this</span></pre></div></div>
</li>
</ul>
</div>
</body>
</html>