This repository was archived by the owner on Apr 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathindex.html
418 lines (389 loc) · 20.7 KB
/
index.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
<!DOCTYPE html>
<head>
<meta charset='utf8'>
<link href='css/monokai.css' media='screen' rel='stylesheet'>
<link href='css/styles.css' media='screen' rel='stylesheet'>
<title>Supermodel.js | Minimal Model Tracking for Backbone</title>
</head>
<body>
<div class="fixed-top">
<div class="page-container">
<a class="small btn pull-left icon-github-sign mrs" href="//github.com/pathable/supermodel" target="_blank">Github</a>
<a class="small btn pull-left icon-download-alt mrs" href="//github.com/pathable/supermodel/zipball/master">Zip</a>
<a class="small btn pull-left icon-download-alt mrs" href="//github.com/pathable/supermodel/tarball/master">Tar</a>
<div class="h3 light text-right prl">Supermodel is sponsored by <a href="//github.com/pathable" target="_blank"><img class="height-2" src="pathable.png" alt="Pathable, Inc."></a></div>
</div>
</div>
<div class='page-container main-content pbl'>
<div class='fluid-grid-2 secondary-bg pal shadow-outer'>
<div class='fluid-1 text-center'>
<div class="mrm">
<img class='block' src='logo.png'>
</div>
<div class='h2 ptm pbm mrl'>Minimal model tracking for <a href="http://backbonejs.org">Backbone</a>.</div>
<div class='small quiet mrl'>Note: The development of this software is ongoing. A similar version has been used in production at <a href="http://pathable.com">Pathable</a> for quite some time but your mileage may vary.</div>
<div class="ptl">
<a class="btn" href="http://github.com/pathable/supermodel" target="_blank">
<div class="light small quiet">Fork on</div>
<span class="h3"><i class="icon-github-sign"></i>Github</span>
</a>
<a class="btn" href="http://github.com/pathable/supermodel/zipball/master">
<div class="light small quiet">Download</div>
<span class="h3"><i class="icon-download-alt"></i>Zip File</span>
</a>
<a class="btn" href="http://github.com/pathable/supermodel/tarball/master">
<div class="light small quiet">Download</div>
<span class="h3"><i class="icon-download-alt"></i>Tar File</span>
</a>
</div>
<div class="ptl text-center">
<a class="btn" href="./supermodel.js">
<div class="light small quiet">Development - 0.0.4</div>
<span class="h3"><i class="icon-download-alt"></i>supermodel.js</span>
</a>
<a class="btn" href="./supermodel.min.js">
<div class="light small quiet">Production - 0.0.4</div>
<span class="h3"><i class="icon-download-alt"></i>supermodel.min.js</span>
</a>
</div>
</div><div class="fluid-1">
<pre class="mll hero colorize language-javascript"><code>Post.has().many('comments', {
collection: Comments,
inverse: 'post'
});
Comment.has().one('post', {
model: Post,
inverse: 'comments'
});
var post = Post.create({
id: 1,
comments: [{id: 2}, {id: 3}, {id: 4}]
});
post.comments().length; // 3
var comment = Comment.create({id: 5, post_id: 1});
post.comments().length; // 4
comment.post() === post; // true :D</code></pre>
</div>
</div>
<div class="mixed-row pal primary-bg shadow-outer bbl bbr">
<div class="fixed prl">
<div class='width-20'>
<ul class='nav-list no-list width-20 pts pbs'>
<li class="nav-list-item mbm">
<a class='strong nav-list-link' href='#source'>Source</a>
</li>
<li class="nav-list-item mbm">
<a class='strong nav-list-link' href='#change-log'>Change Log</a>
</li>
<li class="nav-list-item">
<a class='strong nav-list-link' href='#model'>Model</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#model.create'>Model.create</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#model.all'>Model.all</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#model.reset'>Model.reset</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#model.parent'>Model.parent</a>
</li>
<li class="nav-list-item mbm">
<a class='nav-list-link' href='#parse'>parse</a>
</li>
<li class="nav-list-item">
<a class='strong nav-list-link' href='#associations'>Associations</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#has'>has</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#owner'>owner</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#one'>one</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#many'>many</a>
</li>
<li class="nav-list-item">
<a class='nav-list-link' href='#through'>through</a>
</li>
</ul>
</div>
</div>
<div class="fluid">
<section>
<a class='h1' name='source'>Source</a>
<p>The source for Supermodel is <a href="http://github.com/pathable/supermodel">hosted on github</a>. Please give it a read before trying anything serious as it will greatly improve the utility you gain from the library. <a href="./docs/supermodel.html">The annotated source</a> is also provided for easier reading. Supermodel is available for use under the <a href="https://github.com/pathable/supermodel/blob/master/LICENSE">MIT software license</a>.</p>
<p>Supermodel depends on <a href='http://backbonejs.org'>Backbone</a> >= 0.9.2 and <a href='http://underscorejs.org'>Underscore</a> >= 1.3.3.</p>
</section>
<section>
<a class='h1' name='change-log'>Change Log</a>
<h3>0.0.4</h3>
<ul>
<li><p><b>Model.parent</b> - Supermodel will no longer use <code>__super__</code> to infer model relationships. Instead, they should be declared with <a href='#model.parent'><code>Model.parent</code></a></p></li>
</ul>
</section>
<section>
<a class='h1' name='model'>Model</a>
<p>
<code>Supermodel.Model</code>
<span>is an extension of</span>
<code>Backbone.Model</code>
<span>that handles the tracking and creation of individual models.</span>
</p>
<p>In large applications there are often multiple model objects representing the same server object. This can cause synchronization problems and cause the display of stale data. For instance:</p>
<pre class='colorize language-javascript'><code>var user = new User({id: 5, admin: true});
// ...
var duplicate = new User({id: 5, admin: false});
user.get('admin'); // true :(</code></pre>
<p>If the server is updated while these models are being fetched the two instances may have conflicting attributes. To circumvent this, Supermodel tracks models in the <code>all</code> property of the constructor (which is itself a collection) and returns existing models instead of creating new ones when possible.</p>
<pre class='colorize language-javascript'><code>var user = User.create({id: 5, admin: true});
var duplicate = User.create({id: 5, admin: false});
// ...
duplicate === user; // true
user.get('admin'); // false :D</code></pre>
</section>
<section>
<a class='h3' name='model.create'>Model.create</a>
<p>In order to track models, Supermodel needs to check for their existence before returning a new model. This is the job of <code>Model.create</code>.</p>
<pre class='colorize language-javascript'><code>var User = Supermodel.Model.extend();
var user = User.create();</code></pre>
<p>When using an existing model, it's assumed that the attributes provided are newer than the existing attributes and they are updated.</p>
<pre class='colorize language-javascript'><code>var user = User.create({id: 5, name: 'bradley'});
var duplicate = User.create({id: 5, name: 'brad'});
user.get('name'); // brad</code></pre>
</section>
<section>
<p>To declare a collection for a <code>Supermodel.Model</code> you'll need to use a factory function rather than simply setting the model. This is so that collections can also use <code>Model.create</code> and benefit from tracking.</p>
<pre class='colorize language-javascript'><code>var Users = Backbone.Collection.extend({
model: function(attrs, options) {
return User.create(attrs, options);
}
});</code></pre>
<p class="em">Note: You must use a factory function that calls <code>create</code> with the model constructor as context since <code>Backbone.Collection</code> will not do this for you.</p>
</section>
<section>
<a class='h3' name='model.all'>Model.all</a>
<p>Each model is stored in a collection on the constructor for tracking and event propagation. This collection can be retrieved by calling <code>Model.all()</code>. These are rather handy for tracking all events for models of a given type.</p>
<pre class='colorize language-javascript'><code>var User = Supermodel.Model.extend();
var user = User.create({id: 3});
User.all().get(3) === user; // true</code></pre>
<p>These also work for child constructors.</p>
<pre class='colorize language-javascript'><code>var Admin = User.extend();
var admin = Admin.create({id: 2});
Admin.all().get(2) === admin; // true
User.all().get(2) === admin; // true</code></pre>
<p>A few things to keep in mind about inheritance with <code>all</code> collections:</p>
<ul>
<li>All models with a common ancestor in their prototype chain (excluding <code>Supermodel.Model</code>) are assumed to have unique ids.</li>
<li>Models should always be created with the most specialized constructor possible. A model's super model can be deduced from the prototype chain, but its sub model cannot.</li>
</ul>
<p>Whenever possible Supermodel attempts to prevent duplicate models but it's still possible to corrupt the <code>all</code> collection. For instance, creating a new model without an <code>id</code> and then setting <code>id</code> to an existing models value will cause problems. However, this is no different than regular everyday backbone.</p>
<pre class='colorize language-javascript'><code>var user = User.create({id: 5});
var impostor = User.create();
impostor.set({id: 5});
User.all().get(5) === impostor; // true</code></pre>
<p>It's generally best to not set ids explicitly but only rely on server data for this.</p>
<p class="em">Note: <code>all</code> collections are not intended to be modified. Doing so is not
supported and can have negative consequences for model tracking.</p>
</section>
<section>
<a class='h3' name='model.reset'>Model.reset</a>
<p><code>Supermodel.Model.reset</code> is used to remove associations and tracked models so they can be garbage collected. This is <a href="https://github.com/pathable/supermodel/tree/master/test">most useful for testing</a> and is not generally needed in application code.</p>
<pre class='colorize language-javascript'><code>var user = User.create({id: 3});
User.reset();
User.all().get(3); // null</code></pre>
</section>
<section>
<a class='h3' name='model.parent'>Model.parent</a>
<p>The parent constructor, used to indicate that Supermodel should track inherited instances. Constructors are otherwise treated as stand alone models, regardless of prototype chain.</p>
<pre class='colorize language-javascript'><code>var Admin = User.extend({}, {
parent: User
});</code></pre>
</section>
<section>
<a class='h3' name='parse'>Model.prototoype.parse</a>
<p>In order to prevent conflicts between associations and their corresponding attributes, nested data is used and removed with <code>model.parse</code>. Parsing is also done on new models during initialization.</p>
<p>Nested data can be provided through the <code>source</code> property in a model's attributes.</p>
<pre class='colorize language-javascript'><code>var post = new Post({
id: 1,
comments: [
{id: 2, body: '…'},
{id: 3, body: '…'}
]
});</code></pre>
<p>Associations can also be specified through <code>id</code> properties.</p>
<pre class='colorize language-javascript'><code>var comment = new Comment({
id: 4,
body: '…',
post_id: 1
});</code></pre>
</section>
<section>
<a class='h1' name='associations'>Associations</a>
<p>When initializing models or changing their attributes, there is often plenty of information to wire up associations between models. For instance, in the following example it's clear that the membership belongs to the user and vice versa.</p>
<pre class='colorize language-javascript'><code>var user = new User({id: 5});
var membership = new Membership({id: 2, user_id: 5});</code></pre>
<p>However, these things must be set manually in practice.</p>
<pre class='colorize language-javascript'><code>membership.user === user; // false :(
user.memberships.contains(membership); // false :(</code></pre>
<p>The problem is finding the correct model and ensuring it's the canonical representation of that model. <code>Supermodel.Model</code> already handles these things for us so all that's left is to wire up specific associations.</p>
<pre class='colorize language-javascript'><code>User.has().many('memberships', {
collection: Memberships,
inverse: 'user'
});
Membership.has().one('user', {
model: User,
inverse: 'memberships'
});
var user = User.create({id: 5});
var membership = Membership.create({id: 2, user_id: 5});
membership.user() === user; // true \o/
user.memberships().contains(membership); // true \o/</code></pre>
<p>When models are created or changed, they're inspected for appropriate attributes and the associated properties are set. When a model becomes associated or dissociated with another model an <code>'associate:<name>'</code> or <code>'dissociate:<name>'</code> event is triggered, respectively.</p>
<p>Association properties are retrieved using a getter function. This allows optimizations such as lazy-loading through collections. Other associations may be lazy-loaded in the future as well.</p>
</section>
<section>
<a class='h3' name='has'>has</a>
<p>Associations are specified using <code>Model.has()</code>. This prevents naming collisions and provides a convenient extension point outside of <code>Model</code> itself.</p>
</section>
<section>
<a class='h3' name='owner'>owner</a>
<p>A reference to the model that owns an associated collection. This is useful when specifying a collection url that's relative to its owner.</p>
<pre class='colorize language-javascript'><code>Post.has().many('comments', {
inverse: 'post',
collection: Comments.extend({
url: function() {
return '/posts/' + this.owner.id + '/comments';
}
})
});
</code></pre>
</section>
<section>
<a class='h3' name='one'>one</a>
<p><code>Constructor.has().one(name, options)</code></p>
<p><span class="b i">Instances of Constructor</span> should contain a reference to one model, stored in the property specified by <span class="b i">store</span> and retrieved using the function specified by <span class="b i">name</span>.</p>
<pre class='colorize language-javascript'><code>User.has().one('settings', {
model: Settings,
inverse: 'user'
});
Settings.has().one('user', {
model: User,
inverse: 'settings'
});
var user = User.create({id: 2});
var settings = Settings.create({user_id: 2});
settings.user() === user; // true
user.settings() === settings; // true</code></pre>
</section>
<section>
<a class='h3'>Options</a>
<ul>
<li><em>model</em> - The constructor to use when creating the associated model.</li>
<li><em>inverse</em> - The name of the inverse association, for notifying the associated model of <code>'associate'</code> and <code>'dissociate'</code> events.</li>
<li><em>id</em> - The attribute where the id of the associated model is stored.</li>
<li><em>source</em> - The attribute where the associated model's attributes are stored.</li>
<li><em>store</em> - The property where the model should be stored. Defaults to '_' + <span class="i b">name</span>.</li>
</ul>
</section>
<section>
<a class='h3' name='many'>many</a>
<p><code>Constructor.has().many(name, options)</code></p>
<p>Instances of <span class="b i">Constructor</span> should contain a collection with many models, retrieved with a function stored at <span class="b i">store</span> and retrieved with the function stored at <span class="b i">name</span>.</p>
<pre class='colorize language-javascript'><code>User.has().many('memberships', {
collection: Memberships,
inverse: 'user'
});
Membership.has().one('user', {
model: User,
inverse: 'memberships'
});
var user = User.create({id: 5});
var membership = Membership.create({id: 2, user_id: 5});
membership.user() === user; // true :D
user.memberships().contains(membership); // true :D</code></pre>
</section>
<section>
<a class='h3'>options</a>
<ul>
<li>collection - The constructor to use when creating the associated collection.</li>
<li>inverse - The name of the inverse association, for notifying the associated model of <code>'associate'</code> and <code>'dissociate'</code> events.</li>
<li>source - The attribute where the associated models' attributes are stored.</li>
<li>store - The property where the collection should be stored. Defaults to '_' + <span class="b i">name</span>.</li>
<li>through - The name of the through collection.</li>
</ul>
</section>
<section>
<a class='h3' name="through">through</a>
<p>The functionality of <code>many</code> is changed significantly when a <code>through</code> option is
specified. It's intended to track many-to-many associations through other
collections. For example:</p>
<pre class='colorize language-javascript'><code>User.has()
.many('memberships', {
collection: Memberships,
inverse: 'user'
})
.many('groups', {
source: 'group',
collection: Groups,
through: 'memberships'
});
Membership.has()
.one('user', {
model: User,
inverse: 'memberships'
})
.one('group', {
model: Group,
inverse: 'memberships'
});
Group.has()
.many('memberships', {
collection: Memberships,
inverse: 'group'
})
.many('users', {
source: 'user',
collection: Users,
through: 'memberships'
});
var user = User.create({id: 3});
var group = Group.create({id: 6});
var membership = Membership.create({user_id: 3, group_id: 6});
membership.user() === user; // true
membership.group() === user; // true
user.memberships().contains(membership); // true
group.memberships().contains(membership); // true
user.groups().contains(group); // true
group.users().contains(user); // true</code></pre>
</section>
</div>
</div>
</div>
</div>
<script src="./test/vendor/jquery.js"></script>
<script src="./test/vendor/underscore.js"></script>
<script src="./test/vendor/backbone.js"></script>
<script src="./supermodel.js"></script>
<script src="./js/highlight.pack.js"></script>
<script>
jQuery(function($) {
var $navList = $('.nav-list').css({top: '46px'});
var $window = $(window);
var $buttons = $('.fixed-top .btn');
$('.colorize').each(function() {
hljs.highlightBlock(this);
});
$window.on('scroll', function() {
var scrolled = $window.scrollTop() - $navList.parent().offset().top >= -46;
$navList.css({position: scrolled ? 'fixed' : 'static'});
$buttons.css({opacity: scrolled ? '1' : '0'});
});
});
</script>
</body>