forked from addyosmani/backbone-fundamentals
/
index.html
4331 lines (3812 loc) · 439 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
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
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title>Developing Backbone.js Applications - </title>
<style type="text/css">
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; }
code > span.dt { color: #902000; }
code > span.dv { color: #40a070; }
code > span.bn { color: #40a070; }
code > span.fl { color: #40a070; }
code > span.ch { color: #4070a0; }
code > span.st { color: #4070a0; }
code > span.co { color: #60a0b0; font-style: italic; }
code > span.ot { color: #007020; }
code > span.al { color: #ff0000; font-weight: bold; }
code > span.fu { color: #06287e; }
code > span.er { color: #ff0000; font-weight: bold; }
</style>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body>
<p>
<h1>Developing Backbone.js Applications</h1>
<h3>By Addy Osmani <a href="http://twitter.com/addyosmani">@addyosmani</a></h3>
</p>
<div style="width:500px">
<iframe src="http://markdotto.github.com/github-buttons/github-btn.html?user=addyosmani&repo=backbone-fundamentals&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
<iframe allowtransparency="true" frameborder="0" scrolling="no" src="http://platform.twitter.com/widgets/tweet_button.1333103182.html#_=1333404284780&count=horizontal&id=twitter-widget-0&lang=en&original_referer=http%3A%2F%2Faddyosmani.github.com%2Fbackbone-fundamentals%2F&size=m&text=Developing%20Backbone.js%20Applications&url=https%3A%2F%2Fgithub.com%2Faddyosmani%2Fbackbone-fundamentals&via=addy_osmani" class="twitter-share-button twitter-count-horizontal" style="width: 107px; height: 20px; " title="Twitter Tweet Button"></iframe>
<script id="twitter-wjs" src="//platform.twitter.com/widgets.js"></script><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
<p> <br></p>
</div>
<h2 id="prelude">Prelude</h2>
<p>Welcome to my (in-progress) book about the <a href="http://documentcloud.github.com/backbone/">Backbone.js</a> framework for structuring JavaScript applications. It's released under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">license</a> meaning you can both grab a copy of the book for free or help to further <a href="https://github.com/addyosmani/backbone-fundamentals/">improve</a> it.</p>
<p>I'm very pleased to announce that this book will be out in physical form in a few months time via <a href="http://oreilly.com">O'Reilly Media</a>. Readers will have the option of purchasing the latest version in either print or a number of digital formats then or can grab a recent version from this repository.</p>
<p>Corrections to existing material are always welcome and I hope that together we can provide the community with an up-to-date resource that is of help. My extended thanks go out to <a href="https://github.com/jashkenas">Jeremy Ashkenas</a> for creating Backbone.js and <a href="https://github.com/addyosmani/backbone-fundamentals/contributors">these</a> members of the community for their assistance tweaking this project.</p>
<p>I hope you find this book helpful!</p>
<h2 id="table-of-contents">Table Of Contents</h2>
<ul>
<li><h4><a href="#introduction">Introduction</a></h4></li>
<li><h4><a href="#fundamentals">Fundamentals</a></h4>
<ul>
<li><a href="#mvc-mvp">MVC, MVP & Backbone.js</a></li>
</ul></li>
<li><h4><a href="#thebasics">The Basics</a></h4>
<ul>
<li><a href="#thebasics-models">Models</a></li>
<li><a href="#thebasics-views">Views</a></li>
<li><a href="#thebasics-collections">Collections</a></li>
<li><a href="#thebasics-routers">Routers</a></li>
<li><a href="#thebasics-namespacing">Namespacing</a></li>
<li><a href="#thebasics-additional-tips">Additional tips</a></li>
</ul></li>
<li><h4><a href="#restfulapps">RESTful Applications</a></h4>
<ul>
<li><a href="#restful">Building RESTful applications with Backbone</a></li>
<li><a href="#stack1">Building Backbone apps with Node.js, Express, Mongoose and MongoDB</a></li>
<li><a href="#stack2">Building Backbone apps with Ruby, Sinatra, Haml and MongoDB</a></li>
<li><a href="#pagination">Paginating Backbone.js Requests & Collections</a></li>
</ul></li>
<li><h4><a href="#advanced">Advanced</a></h4>
<ul>
<li><a href="#modularjs">Modular JavaScript</a></li>
<li><a href="#organizingmodules">Organizing modules with RequireJS and AMD</a></li>
<li><a href="#externaltemplates">Keeping your templates external with the RequireJS text plugin</a></li>
<li><a href="#optimizingrequirejs">Optimizing Backbone apps for production with the RequireJS Optimizer</a></li>
<li><a href="#practicalrequirejs">Practical: Building a modular Backbone app with AMD & RequireJS</a></li>
<li><a href="#decouplingbackbone">Decoupling Backbone with the Mediator and Facade patterns</a></li>
<li>Backbone & jQuery Mobile</li>
<li>Practical: Building A Modular Mobile App With Backbone & jQuery Mobile</li>
</ul></li>
<li><h4><a href="#testing">Unit Testing</a></h4>
<ul>
<li><a href="#unittestingjasmine">Unit Testing Backbone Applications With Jasmine</a></li>
<li>Introduction</li>
<li>Jasmine
<ul>
<li>Suites, Specs And Spies</li>
<li>TDD With Backbone</li>
<li><a href="#testing-jasmine-models">Testing Models</a></li>
<li><a href="#testing-jasmine-collections">Testing Collections</a></li>
<li><a href="#testing-jasmine-views">Testing Views</a></li>
</ul></li>
<li><a href="#unittestingqunit">Unit Testing Backbone Applications With QUnit And SinonJS</a></li>
<li>Introduction</li>
<li>QUnit
<ul>
<li>Assertions</li>
<li>Adding structure to assertions</li>
<li>Assertion examples</li>
<li>Fixtures</li>
<li>Asynchronous code</li>
</ul></li>
<li>SinonJS
<ul>
<li>Stubs</li>
<li>Mocks</li>
</ul></li>
<li>Practical
<ul>
<li>Testing Models</li>
<li>Testing Collections</li>
<li>Testing Views</li>
<li>Testing Events</li>
</ul></li>
</ul></li>
<li><h4><a href="#resources">Resources</a></h4></li>
</ul>
<h2 id="introduction"><a name="introduction">Introduction</a></h2>
<p>As JavaScript developers, we are at an interesting point in time where not only do we have mature solutions to help organize the JavaScript powering our applications based on a separation of concerns, but developers looking to build non-trivial projects are almost spoiled for choice for frameworks that can help structure their applications.</p>
<p>Maturity in software (framework) development isn't simply about how long a framework has been around. It's about how solid the framework is and more importantly how well it's evolved to fill its role. Has it become more effective at solving common problems? Does it continue to improve as developers build larger and more complex applications with it?</p>
<p>In this book, I will be covering the popular Backbone.js, which I consider the best of the current family of JavaScript architectural frameworks.</p>
<p>Topics will include MVC theory and how to build applications using Backbone's models, views, collections and routers. I'll also be taking you through advanced topics like modular development with Backbone.js and AMD (via RequireJS), how to build applications using modern software stacks (like Node and Express), how to solve the routing problems with Backbone and jQuery Mobile, tips about scaffolding tools, and a lot more.</p>
<p>If this is your first time looking at Backbone.js and you're still unsure whether or not to give it a try, why not take a look at how <a href="http://github.com/addyosmani/todomvc">a Todo application</a> can be implemented in Backbone and several other popular Javascript frameworks before reading further?</p>
<p>The goal of this book is to create an authoritative and centralized repository of information that can help those developing real-world apps with Backbone. If you come across a section or topic which you think could be improved or expanded on, please feel free to submit a pull-request. It won't take long and you'll be helping other developers avoid problems you've run into before.</p>
<h2 id="fundamentals"><a name="fundamentals">Fundamentals</a></h2>
<p>In this section we are going to cover the context into which a framework like Backbone.js fits. Let's begin our journey into understanding Backbone better with a look at code architecture.</p>
<h3 id="mvc-mvp-backbone.js"><a name="mvc-mvp">MVC, MVP & Backbone.js</a></h3>
<p>Before exploring any JavaScript frameworks that assist in structuring applications, it can be useful to gain a basic understanding of architectural design patterns. Design patterns are proven solutions to common development problems and can suggest structural approaches to help guide developers in adding some organization to their applications.</p>
<p>Patterns are useful because they're a set of practices that build upon the collective experience of skilled developers who have repeatedly solved similar problems. Although developers 10 or 20 years ago may not have been using the same programming languages when implementing patterns in their projects, there are many lessons we can learn from their efforts.</p>
<p>In this section, we're going to review two popular patterns - MVC and MVP. We'll be exploring in greater detail how Backbone.js implements these patterns shortly to better appreciate where it fits in.</p>
<h2 id="mvc">MVC</h2>
<p>MVC (Model-View-Controller) is an architectural design pattern that encourages improved application organization through a separation of concerns. It enforces the isolation of business data (Models) from user interfaces (Views), with a third component (Controllers) traditionally present to manage logic, user-input and the coordination of models and views. The pattern was originally designed by <a href="http://en.wikipedia.org/wiki/Trygve_Reenskaug">Trygve Reenskaug</a> while working on Smalltalk-80 (1979), where it was initially called Model-View-Controller-Editor. MVC was described in depth in <a href="http://www.amazon.co.uk/Design-patterns-elements-reusable-object-oriented/dp/0201633612">“Design Patterns: Elements of Reusable Object-Oriented Software”</a> (The "GoF" or “Gang of Four” book) in 1994, which played a role in popularizing its use.</p>
<h3 id="smalltalk-80-mvc">Smalltalk-80 MVC</h3>
<p>It's important to understand what the original MVC pattern was aiming to solve as it has changed quite heavily since the days of its origin. Back in the 70's, graphical user-interfaces were few and far between. An approach known as <a href="http://martinfowler.com/eaaDev/uiArchs.html">Separated Presentation</a> began to be used as a means to make a clear division between domain objects which modeled concepts in the real world (e.g a photo, a person) and the presentation objects which were rendered to the user's screen.</p>
<p>The Smalltalk-80 implementation of MVC took this concept further and had an objective of separating out the application logic from the user interface. The idea was that decoupling these parts of the application would also allow the reuse of models for other interfaces in the application. There are some interesting points worth noting about Smalltalk-80's MVC architecture:</p>
<ul>
<li>A Domain element was known as a Model and were ignorant of the user-interface (Views and Controllers)</li>
<li>Presentation was taken care of by the View and the Controller, but there wasn't just a single view and controller. A View-Controller pair was required for each element being displayed on the screen and so there was no true separation between them</li>
<li>The Controller's role in this pair was handling user input (such as key-presses and click events), doing something sensible with them.</li>
<li>The Observer pattern was relied upon for updating the View whenever the Model changed</li>
</ul>
<p>Developers are sometimes surprised when they learn that the Observer pattern (nowadays commonly implemented as a Publish/Subscribe system) was included as a part of MVC's architecture decades ago. In Smalltalk-80's MVC, the View and Controller both observe the Model: anytime the Model changes, the Views react. A simple example of this is an application backed by stock market data - for the application to show real-time information, any change to the data in its Models should result in the View being refreshed instantly.</p>
<p>Martin Fowler has done an excellent job of writing about the <a href="http://martinfowler.com/eaaDev/uiArchs.html">origins</a> of MVC over the years and if you are interested in further historical information about Smalltalk-80's MVC, I recommend reading his work.</p>
<h2 id="mvc-as-we-know-it">MVC As We Know It</h2>
<p>We've reviewed the 70's, but let us now return to the here and now. The MVC pattern has been applied to a diverse range of programming languages. For example, the popular Ruby on Rails is an implementation of a web application framework based on MVC for the Ruby language. JavaScript now has a number of MVC frameworks, including Ember.js, JavaScriptMVC, and of course Backbone.js. Given the importance of avoiding "spaghetti" code, a term which describes code that is very difficult to read or maintain due to its lack of structure, let's look at what the MVC pattern enables the Javascript developer to do.</p>
<p>MVC is composed of three core components:</p>
<h3 id="models">Models</h3>
<p>Models manage the data for an application. They are concerned with neither the user-interface nor presentation layers, but instead represent structured data that an application may require. When a model changes (e.g when it is updated), it will typically notify its observers (e.g views, a concept we will cover shortly) that a change has occurred so that they may react accordingly.</p>
<p>To understand models better, let us imagine we have a JavaScript photo gallery application. In a photo gallery, a photo would merit its own model, as it represents a unique kind of domain-specific data. The Photo model may represent attributes such as a caption, image source and additional meta-data. A specific photo would be stored in an instance of a model. Here's an example of a simple Photo model implemented with Backbone.js:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="co">// Default attributes for the photo</span>
<span class="dt">defaults</span>: {
<span class="co">// Ensure that each photo created has an `src`.</span>
<span class="dt">src</span>: <span class="st">"placeholder.jpg"</span>,
<span class="dt">caption</span>: <span class="st">"A default image"</span>,
<span class="dt">viewed</span>: <span class="kw">false</span>
},
<span class="dt">initialize</span>: <span class="kw">function</span>() {
}
});</code></pre>
<p>The built-in capabilities of models vary across frameworks, however it's common for them to support validation of attributes, where attributes represent the properties of the model, such as a model identifier. When using models in real-world applications we generally also need a way of persisting models. Persistence allows us to edit and update models with the knowledge that their most recent states will be saved somewhere, for example in a web browser's localStorage data-store or synchronized with a database.</p>
<p>A model may also have multiple views observing it. Imagine our Photo model contained meta-data such as the longitude and latitude where the photo was taken, a list of people present in the photo, and a list of tags. A developer could create a single view that displayed all these attributes, or might create three separate views to display each attribute. The important detail is that the Photo model doesn't care how these views are organized, it simply announces updates to its data as necessary. We'll come back to Views in more detail later.</p>
<p>It is not uncommon for modern MVC/MV* frameworks to provide a means to group models together. In Backbone, these groups are called "Collections". Managing models in groups allows us to write application logic based on notifications from the group, should any model it contains change. This avoids the need to manually observe individual model instances.</p>
<p>Here's how we might group Photo models into a simplified Backbone Collection:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoGallery = <span class="kw">Backbone.Collection</span>.<span class="fu">extend</span>({
<span class="co">// Reference to this collection's model.</span>
<span class="dt">model</span>: Photo,
<span class="co">// Filter down the list of all photos that have been viewed</span>
<span class="dt">viewed</span>: <span class="kw">function</span>() {
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">filter</span>(<span class="kw">function</span>(photo){ <span class="kw">return</span> <span class="kw">photo</span>.<span class="fu">get</span>(<span class="ch">'viewed'</span>); });
},
<span class="co">// Filter down the list to only photos that have not yet been viewed</span>
<span class="dt">unviewed</span>: <span class="kw">function</span>() {
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">without</span>.<span class="fu">apply</span>(<span class="kw">this</span>, <span class="kw">this</span>.<span class="fu">viewed</span>());
}
});</code></pre>
<p>If you read older texts on MVC, you may come across a description of models as also managing application 'state'. In JavaScript applications "state" has a specific meaning, typically referring to the current "state" of a view or sub-view on a user's screen at a fixed time. State is a topic which is regularly discussed when looking at Single-page applications, where the concept of state needs to be simulated.</p>
<h3 id="views">Views</h3>
<p>Views are a visual representation of models that present a filtered view of their current state. A view typically observes a model and is notified when the model changes, allowing the view to update itself accordingly. Design pattern literature commonly refers to views as 'dumb', given that their knowledge of models and controllers in an application is limited.</p>
<p>Users interact with views, which usually means reading and editing model data. For example, in our photo gallery application example, model viewing might happen in a user interface with a big image, a caption, and a list of tags. Model editing could be done through an "edit" view where a user who has selected a specific photo could edit its caption, tags, or other metadata in a form.</p>
<p>In MVC, the actual task of updating the Model falls to Controllers, which we'll be covering shortly.</p>
<p>Let's explore Views a little further using a simple JavaScript example. Below we can see a function that creates a single Photo view, consuming both a model instance and a controller instance.</p>
<p>We define a <code>render()</code> utility within our view which is responsible for rendering the contents of the <code>photoModel</code> using a JavaScript templating engine (<a href="http://underscorejs.org" title="Underscore.js">Underscore</a> templating) and updating the contents of our view, referenced by <code>photoEl</code>.</p>
<p>The <code>photoModel</code> then adds our <code>render()</code> callback as one of its subscribers, so that through the Observer pattern it can trigger the view to update when the model changes.</p>
<p>You may wonder where user interaction comes into play here. When users click on any elements within the view, it's not the view's responsibility to know what to do next. A Controller makes this decision. In our sample implementation, this is achieved by adding an event listener to <code>photoEl</code> which will delegate handling the click behavior back to the controller, passing the model information along with it in case it's needed.</p>
<p>The benefit of this architecture is that each component plays its own separate role in making the application function as needed.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> buildPhotoView = <span class="kw">function</span>( photoModel, photoController ){
<span class="kw">var</span> base = <span class="kw">document</span>.<span class="fu">createElement</span>(<span class="ch">'div'</span>),
photoEl = <span class="kw">document</span>.<span class="fu">createElement</span>(<span class="ch">'div'</span>);
<span class="kw">base</span>.<span class="fu">appendChild</span>(photoEl);
<span class="kw">var</span> render= <span class="kw">function</span>(){
<span class="co">// We use a templating library such as Underscore</span>
<span class="co">// templating which generates the HTML for our </span>
<span class="co">// photo entry</span>
<span class="kw">photoEl</span>.<span class="fu">innerHTML</span> = <span class="kw">_</span>.<span class="fu">template</span>(<span class="ch">'photoTemplate'</span>, {<span class="dt">src</span>: <span class="kw">photoModel</span>.<span class="fu">getSrc</span>()});
}
<span class="kw">photoModel</span>.<span class="fu">addSubscriber</span>( render );
<span class="kw">photoEl</span>.<span class="fu">addEventListener</span>(<span class="ch">'click'</span>, <span class="kw">function</span>(){
<span class="kw">photoController</span>.<span class="fu">handleEvent</span>(<span class="ch">'click'</span>, photoModel );
});
<span class="kw">var</span> show = <span class="kw">function</span>(){
<span class="kw">photoEl.style</span>.<span class="fu">display</span> = <span class="ch">''</span>;
}
<span class="kw">var</span> hide = <span class="kw">function</span>(){
<span class="kw">photoEl.style</span>.<span class="fu">display</span> = <span class="ch">'none'</span>;
}
<span class="kw">return</span>{
<span class="dt">showView</span>: show,
<span class="dt">hideView</span>: hide
}
}</code></pre>
<p><strong>Templating</strong></p>
<p>In the context of JavaScript frameworks that support MVC/MV*, it is worth looking more closely at JavaScript templating and its relationship to Views.</p>
<p>It has long been considered bad practice (and computationally expensive) to manually create large blocks of HTML markup in-memory through string concatenation. Developers using this technique often find themselves iterating through their data, wrapping it in nested divs and using outdated techniques such as <code>document.write</code> to inject the 'template' into the DOM. This approach often means keeping scripted markup inline with standard markup, which can quickly become difficult to read and maintain, especially when building large applications.</p>
<p>JavaScript templating libraries (such as Handlebars.js or Mustache) are often used to define templates for views as HTML markup containing template variables. These template blocks can be either stored externally or within script tags with a custom type (e.g 'text/template'). Variables are delimited using a variable syntax (e.g {{name}}). Javascript template libraries typically accept data in JSON, and the grunt work of populating templates with data is taken care of by the framework itself. This has a several benefits, particularly when opting to store templates externally as this can let applications load templates dynamically on an as-needed basis.</p>
<p>Let's compare two examples of HTML templates. One is implemented using the popular Handlebars.js library, and the other uses Underscore's 'microtemplates'.</p>
<p><strong>Handlebars.js:</strong></p>
<pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><li</span><span class="ot"> class=</span><span class="st">"photo"</span><span class="kw">></span>
<span class="kw"><h2></span>{{caption}}<span class="kw"></h2></span>
<span class="kw"><img</span><span class="ot"> class=</span><span class="st">"source"</span><span class="ot"> src=</span><span class="st">"{{src}}"</span><span class="kw">/></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"meta-data"</span><span class="kw">></span>
{{metadata}}
<span class="kw"></div></span>
<span class="kw"></li></span></code></pre>
<p><strong>Underscore.js Microtemplates:</strong></p>
<pre class="sourceCode html"><code class="sourceCode html"><span class="kw"><li</span><span class="ot"> class=</span><span class="st">"photo"</span><span class="kw">></span>
<span class="kw"><h2></span><span class="er"><</span>%= caption %><span class="kw"></h2></span>
<span class="kw"><img</span><span class="ot"> class=</span><span class="st">"source"</span><span class="ot"> src=</span><span class="st">"</span><span class="er"><</span><span class="st">%= src %>"</span><span class="kw">/></span>
<span class="kw"><div</span><span class="ot"> class=</span><span class="st">"meta-data"</span><span class="kw">></span>
<span class="er"><</span>%= metadata %>
<span class="kw"></div></span>
<span class="kw"></li></span></code></pre>
<p>You may also use double curly brackets (i.e <code>{{}}</code>) (or any other tag you feel comfortable with) in Microtemplates. In the case of curly brackets, this can be done by setting the Underscore <code>templateSettings</code> attribute as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">_</span>.<span class="fu">templateSettings</span> = { <span class="dt">interpolate </span>: <span class="ot">/</span><span class="fl">\{\{(</span><span class="ot">.</span><span class="fl">+?)\}\}</span><span class="ot">/g</span> };</code></pre>
<p><strong>A note on navigation and state</strong></p>
<p>It is also worth noting that in classical web development, navigating between independent views required the use of a page refresh. In single-page JavaScript applications, however, once data is fetched from a server via Ajax, it can be dynamically rendered in a new view within the same page. Since this doesn't automatically update the URL, the role of navigation thus falls to a "router", which assists in managing application state (e.g allowing users to bookmark a particular view they have navigated to). As routers are however neither a part of MVC nor present in every MVC-like framework, I will not be going into them in greater detail in this section.</p>
<h3 id="controllers">Controllers</h3>
<p>Controllers are an intermediary between models and views which are classically responsible for two tasks: they both update the view when the model changes and update the model when the user manipulates the view.</p>
<p>In our photo gallery application, a controller would be responsible for handling changes the user made to the edit view for a particular photo, updating a specific photo model when a user has finished editing.</p>
<p>It's with controllers that most JavaScript MVC frameworks depart from this interpretation of the MVC pattern. The reasons for this vary, but in my opinion, Javascript framework authors likely initially looked at server-side interpretations of MVC (such as Ruby on Rails), realized that that approach didn't translate 1:1 on the client-side, and so re-interpreted the C in MVC to solve their state management problem. This was a clever approach, but it can make it hard for developers coming to MVC for the first time to understand both the classical MVC pattern and the "proper" role of controllers in other non-Javascript frameworks.</p>
<p>So does Backbone.js have Controllers? Not really. Backbone's Views typically contain "controller" logic, and Routers (discussed below) are used to help manage application state, but neither are true Controllers according to classical MVC.</p>
<p>In this respect, contrary to what might be mentioned in the official documentation or in blog posts, Backbone is neither a truly MVC/MVP nor MVVM framework. It's in fact better to see it a member of the MV* family which approaches architecture in its own way. There is of course nothing wrong with this, but it is important to distinguish between classical MVC and MV* should you be relying on discussions of MVC to help with your Backbone projects.</p>
<h3 id="controllers-in-spine.js-vs-backbone.js">Controllers in Spine.js vs Backbone.js</h3>
<p><strong>Spine.js</strong></p>
<p>We now know that controllers are traditionally responsible for updating the view when the model changes (and similarly the model when the user updates the view). Since Backbone doesn't have its <strong>own</strong> explicit controllers, it's useful to review the controller from another MVC framework to appreciate the difference in implementations. Let's take a look at <a href="http://spinejs.com/">Spine.js</a>:</p>
<p>In this example, we're going to have a controller called <code>PhotosController</code> which will be in charge of individual photos in the application. It will ensure that when the view updates (e.g a user edited the photo meta-data) the corresponding model does too.</p>
<p>(Note: We won't be delving heavily into Spine.js beyond this example, but it's worth looking at it to learn more about Javascript frameworks in general.)</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">// Controllers in Spine are created by inheriting from Spine.Controller</span>
<span class="kw">var</span> PhotosController = <span class="kw">Spine.Controller</span>.<span class="fu">sub</span>({
<span class="dt">init</span>: <span class="kw">function</span>(){
<span class="kw">this</span>.<span class="fu">item</span>.<span class="fu">bind</span>(<span class="st">"update"</span>, <span class="kw">this</span>.<span class="fu">proxy</span>(<span class="kw">this</span>.<span class="fu">render</span>));
<span class="kw">this</span>.<span class="fu">item</span>.<span class="fu">bind</span>(<span class="st">"destroy"</span>, <span class="kw">this</span>.<span class="fu">proxy</span>(<span class="kw">this</span>.<span class="fu">remove</span>));
},
<span class="dt">render</span>: <span class="kw">function</span>(){
<span class="co">// Handle templating</span>
<span class="kw">this</span>.<span class="fu">replace</span>($(<span class="st">"#photoTemplate"</span>).<span class="fu">tmpl</span>(<span class="kw">this</span>.<span class="fu">item</span>));
<span class="kw">return</span> <span class="kw">this</span>;
},
<span class="dt">remove</span>: <span class="kw">function</span>(){
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">remove</span>();
<span class="kw">this</span>.<span class="fu">release</span>();
}
});</code></pre>
<p>In Spine, controllers are considered the glue for an application, adding and responding to DOM events, rendering templates and ensuring that views and models are kept in sync (which makes sense in the context of what we know to be a controller).</p>
<p>What we're doing in the above example is setting up listeners in the <code>update</code> and <code>destroy</code> events using <code>render()</code> and <code>remove()</code>. When a photo entry gets updated, we re-render the view to reflect the changes to the meta-data. Similarly, if the photo gets deleted from the gallery, we remove it from the view. In case you were wondering about the <code>tmpl()</code> function in the code snippet: in the <code>render()</code> function, we're using this to render a JavaScript template called #photoTemplate which simply returns an HTML string used to replace the controller's current element.</p>
<p>What this provides us with is a very lightweight, simple way to manage changes between the model and the view.</p>
<p><strong>Backbone.js</strong></p>
<p>Later on in this section we're going to revisit the differences between Backbone and traditional MVC, but for now let's focus on controllers.</p>
<p>In Backbone, controller logic is shared between Backbone.View and Backbone.Router. Earlier releases of Backbone contained something called Backbone.Controller, but it was renamed to Router to clarify its role.</p>
<p>A Router's main purpose is to translate URL requests into application states. When a user browses to the URL www.example.com/photos/42, a Router could be used to show the photo with that ID, and to define what application behavior should be run in response to that request. Routers <em>can</em> contain traditional controller responsibilities, such as binding the events between models and views, or rendering parts of the page. However, Backbone contributor Tim Branyen has pointed out that it's possible to get away without needing Backbone.Router at all for this, so a way to think about it using the Router paradigm is probably:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoRouter = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({
<span class="dt">routes</span>: { <span class="st">"photos/:id"</span>: <span class="st">"route"</span> },
<span class="dt">route</span>: <span class="kw">function</span>(id) {
<span class="kw">var</span> item = <span class="kw">photoCollection</span>.<span class="fu">get</span>(id);
<span class="kw">var</span> view = <span class="kw">new</span> PhotoView({ <span class="dt">model</span>: item });
<span class="kw">something</span>.<span class="fu">html</span>( <span class="kw">view</span>.<span class="fu">render</span>().<span class="fu">el</span> );
}
}):</code></pre>
<h2 id="what-does-mvc-give-us">What does MVC give us?</h2>
<p>To summarize, the separation of concerns in MVC facilitates modularization of an application's functionality and enables:</p>
<ul>
<li>Easier overall maintenance. When updates need to be made to the application it is clear whether the changes are data-centric, meaning changes to models and possibly controllers, or merely visual, meaning changes to views.<br /></li>
<li>Decoupling models and views means that it's straight-forward to write unit tests for business logic<br /></li>
<li>Duplication of low-level model and controller code is eliminated across the application</li>
<li>Depending on the size of the application and separation of roles, this modularity allows developers responsible for core logic and developers working on the user-interfaces to work simultaneously</li>
</ul>
<h3 id="delving-deeper">Delving deeper</h3>
<p>Right now, you likely have a basic understanding of what the MVC pattern provides, but for the curious, we'll explore it a little further.</p>
<p>The GoF (Gang of Four) do not refer to MVC as a design pattern, but rather consider it a "set of classes to build a user interface". In their view, it's actually a variation of three other classical design patterns: the Observer (Pub/Sub), Strategy and Composite patterns. Depending on how MVC has been implemented in a framework, it may also use the Factory and Decorator patterns. I've covered some of these patterns in my other free book, JavaScript Design Patterns For Beginners if you would like to read into them further.</p>
<p>As we've discussed, models represent application data, while views handle what the user is presented on screen. As such, MVC relies on Pub/Sub for some of its core communication (something that surprisingly isn't covered in many articles about the MVC pattern). When a model is changed it "publishes" to the rest of the application that it has been updated. The "subscriber"--generally a Controller--then updates the view accordingly. The observer-viewer nature of this relationship is what facilitates multiple views being attached to the same model.</p>
<p>For developers interested in knowing more about the decoupled nature of MVC (once again, depending on the implementation), one of the goals of the pattern is to help define one-to-many relationships between a topic and its observers. When a topic changes, its observers are updated. Views and controllers have a slightly different relationship. Controllers facilitate views to respond to different user input and are an example of the Strategy pattern.</p>
<h3 id="summary">Summary</h3>
<p>Having reviewed the classical MVC pattern, you should now understand how it allows developers to cleanly separate concerns in an application. You should also now appreciate how JavaScript MVC frameworks may differ in their interpretation of MVC, and how they share some of the fundamental concepts of the original pattern.</p>
<p>When reviewing a new JavaScript MVC/MV* framework, remember - it can be useful to step back and consider how it's opted to approach Models, Views, Controllers or other alternatives, as this can better help you grok how the framework expects to be used.</p>
<h2 id="mvp">MVP</h2>
<p>Model-view-presenter (MVP) is a derivative of the MVC design pattern which focuses on improving presentation logic. It originated at a company named <a href="http://en.wikipedia.org/wiki/Taligent">Taligent</a> in the early 1990s while they were working on a model for a C++ CommonPoint environment. Whilst both MVC and MVP target the separation of concerns across multiple components, there are some fundamental differences between them.</p>
<p>For the purposes of this summary we will focus on the version of MVP most suitable for web-based architectures.</p>
<h3 id="models-views-presenters">Models, Views & Presenters</h3>
<p>The P in MVP stands for presenter. It's a component which contains the user-interface business logic for the view. Unlike MVC, invocations from the view are delegated to the presenter, which are decoupled from the view and instead talk to it through an interface. This allows for all kinds of useful things such as being able to mock views in unit tests.</p>
<p>The most common implementation of MVP is one which uses a Passive View (a view which is for all intents and purposes "dumb"), containing little to no logic. MVP models are almost identical to MVC models and handle application data. The presenter acts as a mediator which talks to both the view and model, however both of these are isolated from each other. They effectively bind models to views, a responsibility held by Controllers in MVC. Presenters are at the heart of the MVP pattern and as you can guess, incorporate the presentation logic behind views.</p>
<p>Solicited by a view, presenters perform any work to do with user requests and pass data back to them. In this respect, they retrieve data, manipulate it and determine how the data should be displayed in the view. In some implementations, the presenter also interacts with a service layer to persist data (models). Models may trigger events but it's the presenter's role to subscribe to them so that it can update the view. In this passive architecture, we have no concept of direct data binding. Views expose setters which presenters can use to set data.</p>
<p>The benefit of this change from MVC is that it increases the testability of your application and provides a more clean separation between the view and the model. This isn't however without its costs as the lack of data binding support in the pattern can often mean having to take care of this task separately.</p>
<p>Although a common implementation of a <a href="http://martinfowler.com/eaaDev/PassiveScreen.html">Passive View</a> is for the view to implement an interface, there are variations on it, including the use of events which can decouple the View from the Presenter a little more. As we don't have the interface construct in JavaScript, we're using it more as more a protocol than an explicit interface here. It's technically still an API and it's probably fair for us to refer to it as an interface from that perspective.</p>
<p>There is also a <a href="http://martinfowler.com/eaaDev/SupervisingPresenter.html">Supervising Controller</a> variation of MVP, which is closer to the MVC and <a href="http://en.wikipedia.org/wiki/Model_View_ViewModel">MVVM</a> patterns as it provides data-binding from the Model directly from the View. Key-value observing (KVO) plugins (such as Derick Bailey's Backbone.ModelBinding plugin) introduce this idea of a Supervising Controller to Backbone.</p>
<h2 id="mvp-or-mvc">MVP or MVC?</h2>
<p>MVP is generally used most often in enterprise-level applications where it's necessary to reuse as much presentation logic as possible. Applications with very complex views and a great deal of user interaction may find that MVC doesn't quite fit the bill here as solving this problem may mean heavily relying on multiple controllers. In MVP, all of this complex logic can be encapsulated in a presenter, which can simplify maintenance greatly.</p>
<p>As MVP views are defined through an interface and the interface is technically the only point of contact between the system and the view (other than a presenter), this pattern also allows developers to write presentation logic without needing to wait for designers to produce layouts and graphics for the application.</p>
<p>Depending on the implementation, MVP may be more easy to automatically unit test than MVC. The reason often cited for this is that the presenter can be used as a complete mock of the user-interface and so it can be unit tested independent of other components. In my experience this really depends on the languages you are implementing MVP in (there's quite a difference between opting for MVP for a JavaScript project over one for say, ASP.NET).</p>
<p>At the end of the day, the underlying concerns you may have with MVC will likely hold true for MVP given that the differences between them are mainly semantic. As long as you are cleanly separating concerns into models, views and controllers (or presenters) you should be achieving most of the same benefits regardless of the pattern you opt for.</p>
<h2 id="mvc-mvp-and-backbone.js">MVC, MVP and Backbone.js</h2>
<p>There are very few, if any architectural JavaScript frameworks that claim to implement the MVC or MVP patterns in their classical form as many JavaScript developers don't view MVC and MVP as being mutually exclusive (we are actually more likely to see MVP strictly implemented when looking at web frameworks such as ASP.NET or GWT). This is because it's possible to have additional presenter/view logic in your application and yet still consider it a flavor of MVC.</p>
<p>Backbone contributor <a href="http://ireneros.com/">Irene Ros</a> subscribes to this way of thinking as when she separates Backbone views out into their own distinct components, she needs something to actually assemble them for her. This could either be a controller route (such as a <code>Backbone.Router</code>, covered later in the book) or a callback in response to data being fetched.</p>
<p>That said, some developers do however feel that Backbone.js better fits the description of MVP than it does MVC . Their view is that:</p>
<ul>
<li>The presenter in MVP better describes the <code>Backbone.View</code> (the layer between View templates and the data bound to it) than a controller does</li>
<li>The model fits <code>Backbone.Model</code> (it isn't that different from the classical MVC "Model")<br /></li>
<li>The views best represent templates (e.g Handlebars/Mustache markup templates)</li>
</ul>
<p>A response to this could be that the view can also just be a View (as per MVC) because Backbone is flexible enough to let it be used for multiple purposes. The V in MVC and the P in MVP can both be accomplished by <code>Backbone.View</code> because they're able to achieve two purposes: both rendering atomic components and assembling those components rendered by other views.</p>
<p>We've also seen that in Backbone the responsibility of a controller is shared with both the Backbone.View and Backbone.Router and in the following example we can actually see that aspects of that are certainly true.</p>
<p>Here, our Backbone <code>PhotoView</code> uses the Observer pattern to 'subscribe' to changes to a View's model in the line <code>this.model.on('change',...)</code>. It also handles templating in the <code>render()</code> method, but unlike some other implementations, user interaction is also handled in the View (see <code>events</code>).</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">//... is a list tag.</span>
<span class="dt">tagName</span>: <span class="st">"li"</span>,
<span class="co">// Pass the contents of the photo template through a templating</span>
<span class="co">// function, cache it for a single photo</span>
<span class="dt">template</span>: <span class="kw">_</span>.<span class="fu">template</span>($(<span class="ch">'#photo-template'</span>).<span class="fu">html</span>()),
<span class="co">// The DOM events specific to an item.</span>
<span class="dt">events</span>: {
<span class="st">"click img"</span> : <span class="st">"toggleViewed"</span>
},
<span class="co">// The PhotoView listens for changes to its model, re-rendering. Since there's</span>
<span class="co">// a one-to-one correspondence between a **Photo** and a **PhotoView** in this</span>
<span class="co">// app, we set a direct reference on the model for convenience.</span>
<span class="dt">initialize</span>: <span class="kw">function</span>() {
<span class="kw">_</span>.<span class="fu">bindAll</span>(<span class="kw">this</span>, <span class="ch">'render'</span>);
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>(<span class="ch">'change'</span>, <span class="kw">this</span>.<span class="fu">render</span>);
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>(<span class="ch">'destroy'</span>, <span class="kw">this</span>.<span class="fu">remove</span>);
},
<span class="co">// Re-render the photo entry</span>
<span class="dt">render</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">html</span>(<span class="kw">this</span>.<span class="fu">template</span>(<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toJSON</span>()));
<span class="kw">return</span> <span class="kw">this</span>;
},
<span class="co">// Toggle the `"viewed"` state of the model.</span>
<span class="dt">toggleViewed</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">viewed</span>();
}
});</code></pre>
<p>Another (quite different) opinion is that Backbone more closely resembles <a href="http://martinfowler.com/eaaDev/uiArchs.html#ModelViewController">Smalltalk-80 MVC</a>, which we went through earlier.</p>
<p>As regular Backbone user Derick Bailey has <a href="http://lostechies.com/derickbailey/2011/12/23/backbone-js-is-not-an-mvc-framework/">written</a>, it's ultimately best not to force Backbone to fit any specific design patterns. Design patterns should be considered flexible guides to how applications may be structured and in this respect, Backbone doesn't fit either MVC nor MVP perfectly. Instead, it borrows some of the best concepts from multiple architectural patterns and creates a flexible framework that just works well. Call it <strong>the Backbone way</strong>, MV* or whatever helps reference its flavor of application architecture.</p>
<p>It <em>is</em> however worth understanding where and why these concepts originated, so I hope that my explanations of MVC and MVP have been of help. Most structural JavaScript frameworks will adopt their own take on classical patterns, either intentionally or by accident, but the important thing is that they help us develop applications which are organized, clean and can be easily maintained.</p>
<h2 id="fast-facts">Fast facts</h2>
<h3 id="backbone.js">Backbone.js</h3>
<ul>
<li>Core components: Model, View, Collection, Router. Enforces its own flavor of MV*</li>
<li>Good documentation, with more improvements on the way</li>
<li>Used by large companies such as SoundCloud and Foursquare to build non-trivial applications</li>
<li>Event-driven communication between views and models. As we'll see, it's relatively straight-forward to add event listeners to any attribute in a model, giving developers fine-grained control over what changes in the view</li>
<li>Supports data bindings through manual events or a separate Key-value observing (KVO) library</li>
<li>Great support for RESTful interfaces out of the box, so models can be easily tied to a backend</li>
<li>Extensive eventing system. It's <a href="http://lostechies.com/derickbailey/2011/07/19/references-routing-and-the-event-aggregator-coordinating-views-in-backbone-js/">trivial</a> to add support for pub/sub in Backbone</li>
<li>Prototypes are instantiated with the <code>new</code> keyword, which some developers prefer</li>
<li>Agnostic about templating frameworks, however Underscore's micro-templating is available by default. Backbone works well with libraries like Handlebars</li>
<li>Doesn't support deeply nested models, though there are Backbone plugins such as <a href="https://github.com/PaulUithol/Backbone-relational">this</a> which can help<br /></li>
<li>Clear and flexible conventions for structuring applications. Backbone doesn't force usage of all of its components and can work with only those needed.</li>
</ul>
<h2 id="the-basics">## <a name="thebasics">The Basics</a></h2>
<h3 id="what-is-backbone">What is Backbone?</h3>
<p>Backbone.js is one of a number of JavaScript frameworks for creating MVC-like web applications. On the front-end, it's my architectural framework of choice as it's both mature, relatively lightweight and can be easily tested using third-party toolkits such as Jasmine or QUnit. Other MVC frameworks you may be familiar with include Ember.js (SproutCore 2.0), Spine, YUILibrary and JavaScriptMVC.</p>
<p>Backbone is maintained by a number of contributors, most notably: Jeremy Ashkenas, creator of CoffeeScript, Docco and Underscore.js. As Jeremy is a believer in detailed documentation, there's a level of comfort in knowing you're unlikely to run into issues which are either not explained in the official docs or which can't be nailed down with some assistance from the #documentcloud IRC channel. I strongly recommend using the latter if you find yourself getting stuck.</p>
<h3 id="why-should-you-consider-using-it">Why should you consider using it?</h3>
<p>Backbone's main benefits, regardless of your target platform or device, include helping:</p>
<ul>
<li>Organize the structure to your application</li>
<li>Simplify server-side persistence</li>
<li>Decouple the DOM from your page's data</li>
<li>Model data, views and routers in a succinct manner</li>
<li>Provide DOM, model and collection synchronization</li>
</ul>
<h2 id="the-basics-1">The Basics</h2>
<p>In this section, you'll learn the essentials of Backbone's models, views, collections and routers, as well as about using namespacing to organize your code. This isn't meant as a replacement for the official documentation, but it will help you understand many of the core concepts behind Backbone before you start building applications with it.</p>
<ul>
<li>Models</li>
<li>Collections</li>
<li>Routers</li>
<li>Views</li>
<li>Namespacing</li>
</ul>
<h3 id="models-1"><a name="thebasics-models" id="thebasics-models">Models</a></h3>
<p>Backbone models contain interactive data for an application as well as the logic around this data. For example, we can use a model to represent the concept of a photo object including its attributes like tags, titles and a location.</p>
<p>Models can be created by extending <code>Backbone.Model</code> as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">defaults</span>: {
<span class="dt">src</span>: <span class="ch">'placeholder.jpg'</span>,
<span class="dt">title</span>: <span class="ch">'an image placeholder'</span>,
<span class="dt">coordinates</span>: [<span class="dv">0</span>,<span class="dv">0</span>]
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">this</span>.<span class="fu">on</span>(<span class="st">"change:src"</span>, <span class="kw">function</span>(){
<span class="kw">var</span> src = <span class="kw">this</span>.<span class="fu">get</span>(<span class="st">"src"</span>);
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">'Image source updated to '</span> + src);
});
},
<span class="dt">changeSrc</span>: <span class="kw">function</span>( source ){
<span class="kw">this</span>.<span class="fu">set</span>({ <span class="dt">src</span>: source });
}
});
<span class="kw">var</span> somePhoto = <span class="kw">new</span> Photo({ <span class="dt">src</span>: <span class="st">"test.jpg"</span>, <span class="dt">title</span>:<span class="st">"testing"</span>});
<span class="kw">somePhoto</span>.<span class="fu">changeSrc</span>(<span class="st">"magic.jpg"</span>); <span class="co">// which triggers "change:src" and logs an update message to the console.</span></code></pre>
<h4 id="initialization">Initialization</h4>
<p>The <code>initialize()</code> method is called when a new instance of a model is created. Its use is optional, however you'll see why it's good practice to use it below.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">'this model has been initialized'</span>);
}
});
<span class="co">// We can then create our own instance of a photo as follows:</span>
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo();</code></pre>
<h4 id="getters-setters">Getters & Setters</h4>
<p><strong>Model.get()</strong></p>
<p><code>Model.get()</code> provides easy access to a model's attributes. Attributes which are passed through to the model on instantiation are instantly available for retrieval.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">title</span>: <span class="st">"My awesome photo"</span>,
<span class="dt">src</span>:<span class="st">"boston.jpg"</span>,
<span class="dt">location</span>: <span class="st">"Boston"</span>,
<span class="dt">tags</span>:[<span class="ch">'the big game'</span>, <span class="ch">'vacation'</span>]}),
title = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"title"</span>), <span class="co">//My awesome photo</span>
location = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"location"</span>), <span class="co">//Boston</span>
tags = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"tags"</span>), <span class="co">// ['the big game','vacation']</span>
photoSrc = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"src"</span>); <span class="co">//boston.jpg</span></code></pre>
<p>Alternatively, if you wish to directly access all of the attributes in a model's instance directly, you can achieve this as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myAttributes = <span class="kw">myPhoto</span>.<span class="fu">attributes</span>;
<span class="kw">console</span>.<span class="fu">log</span>(myAttributes);</code></pre>
<p>It is best practice to use <code>Model.set()</code> or direct instantiation to set the values of a model's attributes.</p>
<p>Accessing <code>Model.attributes</code> directly is generally discouraged. Instead, should you need to read or clone data, <code>Model.toJSON()</code> is recommended for this purpose. If you would like to access or copy a model's attributes for purposes such as JSON stringification (e.g. for serialization prior to being passed to a view), this can be achieved using Model.toJSON(). Remember that this will return an object and JSON.stringify() should be used to get a string representation of the data:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myAttributes = <span class="kw">myPhoto</span>.<span class="fu">toJSON</span>();
<span class="kw">console</span>.<span class="fu">log</span>(<span class="kw">JSON</span>.<span class="fu">stringify</span>(myattributes));
<span class="co">/* this returns: </span>
<span class="co"> { title: "My awesome photo", </span>
<span class="co"> src:"boston.jpg", </span>
<span class="co"> location: "Boston", </span>
<span class="co"> tags:['the big game', 'vacation']}</span>
<span class="co">*/</span></code></pre>
<h4 id="model.set">Model.set()</h4>
<p><code>Model.set()</code> allows us to pass attributes into an instance of our model. Attributes can either be set during initialization or at any time afterwards. It's important to avoid trying to set a Model's attributes directly (for example, <code>Model.caption = 'A new caption'</code>). Backbone uses Model.set() to know when to broadcast that a model's data has changed.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">'this model has been initialized'</span>);
}
});
<span class="co">// Setting the value of attributes via instantiation</span>
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">title</span>: <span class="ch">'My awesome photo'</span>, <span class="dt">location</span>: <span class="ch">'Boston'</span> });
<span class="kw">var</span> myPhoto2 = <span class="kw">new</span> Photo();
<span class="co">// Setting the value of attributes through Model.set()</span>
<span class="kw">myPhoto2</span>.<span class="fu">set</span>({ <span class="dt">title</span>:<span class="ch">'Vacation in Florida'</span>, <span class="dt">location</span>: <span class="ch">'Florida'</span> });</code></pre>
<p><strong>Default values</strong></p>
<p>There are times when you want your model to have a set of default values (e.g. in a scenario where a complete set of data isn't provided by the user). This can be set using a property called <code>defaults</code> in your model.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">defaults</span>: {
<span class="dt">title</span>: <span class="ch">'Another photo!'</span>,
<span class="dt">tags</span>: [<span class="ch">'untagged'</span>],
<span class="dt">location</span>: <span class="ch">'home'</span>,
<span class="dt">src</span>: <span class="ch">'placeholder.jpg'</span>
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
}
});
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">location</span>: <span class="st">"Boston"</span>,
<span class="dt">tags</span>:[<span class="ch">'the big game'</span>, <span class="ch">'vacation'</span>]}),
title = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"title"</span>), <span class="co">//Another photo!</span>
location = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"location"</span>), <span class="co">//Boston</span>
tags = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"tags"</span>), <span class="co">// ['the big game','vacation']</span>
photoSrc = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">"src"</span>); <span class="co">//placeholder.jpg</span></code></pre>
<p><strong>Listening for changes to your model</strong></p>
<p>Any and all of the attributes in a Backbone model can have listeners bound to them which detect when their values change. Listeners can be added to the <code>initialize()</code> function:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">this</span>.<span class="fu">on</span>(<span class="ch">'change'</span>, <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">'values for this model have changed'</span>);
});</code></pre>
<p>In the following example, we log a message whenever a specific attribute (the title of our Photo model) is altered.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">defaults</span>: {
<span class="dt">title</span>: <span class="ch">'Another photo!'</span>,
<span class="dt">tags</span>: [<span class="ch">'untagged'</span>],
<span class="dt">location</span>: <span class="ch">'home'</span>,
<span class="dt">src</span>: <span class="ch">'placeholder.jpg'</span>
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">'this model has been initialized'</span>);
<span class="kw">this</span>.<span class="fu">on</span>(<span class="st">"change:title"</span>, <span class="kw">function</span>(){
<span class="kw">var</span> title = <span class="kw">this</span>.<span class="fu">get</span>(<span class="st">"title"</span>);
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"My title has been changed to.. "</span> + title);
});
},
<span class="dt">setTitle</span>: <span class="kw">function</span>(newTitle){
<span class="kw">this</span>.<span class="fu">set</span>({ <span class="dt">title</span>: newTitle });
}
});
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">title</span>:<span class="st">"Fishing at the lake"</span>, <span class="dt">src</span>:<span class="st">"fishing.jpg"</span>});
<span class="kw">myPhoto</span>.<span class="fu">setTitle</span>(<span class="ch">'Fishing at sea'</span>);
<span class="co">//logs 'My title has been changed to.. Fishing at sea'</span></code></pre>
<p><strong>Validation</strong></p>
<p>Backbone supports model validation through <code>Model.validate()</code>, which allows checking the attribute values for a model prior to them being set.</p>
<p>Validation functions can be as simple or complex as necessary. If the attributes provided are valid, nothing should be returned from <code>.validate()</code>. If they are invalid, a custom error can be returned instead.</p>
<p>A basic example for validation can be seen below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">validate</span>: <span class="kw">function</span>(attribs){
<span class="kw">if</span>(<span class="kw">attribs</span>.<span class="fu">src</span> === undefined){
<span class="kw">return</span> <span class="st">"Remember to set a source for your image!"</span>;
}
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">'this model has been initialized'</span>);
<span class="kw">this</span>.<span class="fu">on</span>(<span class="st">"error"</span>, <span class="kw">function</span>(model, error){
<span class="kw">console</span>.<span class="fu">log</span>(error);
});
}
});
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo();
<span class="kw">myPhoto</span>.<span class="fu">set</span>({ <span class="dt">title</span>: <span class="st">"On the beach"</span> });
<span class="co">//logs Remember to set a source for your image!</span></code></pre>
<p><strong>Note</strong>: Backbone passes the <code>attributes</code> object by shallow copy to the <code>validate</code> function using the Underscore <code>_.extend</code> method. This means that it is not possible to change any <code>Number</code>, <code>String</code> or <code>Boolean</code> attribute by reference in the way that one might expect a JavaScript object to behave. As shallow copy doesn't copy objects by implicitly copying them, but rather, by reference, one can change the attributes on those objects.</p>
<p>An example of this (by @fivetanley) is available <a href="http://jsfiddle.net/2NdDY/7/">here</a>.</p>
<h3 id="views-1"><a name="thebasics-views" id="thebasics-views">Views</a></h3>
<p>Views in Backbone don't contain the markup for your application, but rather they are there to support models by defining the logic for how they should be represented to the user. This is usually achieved using JavaScript templating (e.g. Mustache, jQuery-tmpl, etc.). A view's <code>render()</code> function can be bound to a model's <code>change()</code> event, allowing the view to always be up to date without requiring a full page refresh.</p>
<h4 id="creating-new-views">Creating new views</h4>
<p>Similar to the previous sections, creating a new view is relatively straight-forward. To create a new View, simply extend <code>Backbone.View</code>. I'll explain this code in detail below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoSearch = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="dt">el</span>: $(<span class="ch">'#results'</span>),
<span class="dt">render</span>: <span class="kw">function</span>( event ){
<span class="kw">var</span> compiled_template = <span class="kw">_</span>.<span class="fu">template</span>( $(<span class="st">"#results-template"</span>).<span class="fu">html</span>() );
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">html</span>( compiled_template(<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toJSON</span>()) );
<span class="kw">return</span> <span class="kw">this</span>; <span class="co">//recommended as this enables calls to be chained.</span>
},
<span class="dt">events</span>: {
<span class="st">"submit #searchForm"</span>: <span class="st">"search"</span>,
<span class="st">"click .reset"</span>: <span class="st">"reset"</span>,
<span class="st">"click .advanced"</span>: <span class="st">"switchContext"</span>
},
<span class="dt">search</span>: <span class="kw">function</span>( event ){
<span class="co">//executed when a form '#searchForm' has been submitted</span>
},
<span class="dt">reset</span>: <span class="kw">function</span>( event ){
<span class="co">//executed when an element with class "reset" has been clicked.</span>
},
<span class="dt">switchContext</span>: <span class="kw">function</span>( event ){
<span class="co">//executed when an element with class "advanced" has been clicked.</span>
}
});</code></pre>
<h4 id="what-is-el">What is <code>el</code>?</h4>
<p><code>el</code> is basically a reference to a DOM element and all views must have one. It allows for all of the contents of a view to be inserted into the DOM at once, which makes for faster rendering because the browser performs the minimum required reflows and repaints.</p>
<p>There are two ways to attach a DOM element to a view: the element already exists in the page or a new element is created for the view and added manually by the developer. If the element already exists in the page, you can set <code>el</code> as either a CSS selector that matches the element or a simple reference to the DOM element.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="dt">el</span>: <span class="ch">'#footer'</span>,
<span class="co">// OR</span>
<span class="dt">el</span>: <span class="kw">document</span>.<span class="fu">getElementById</span>( <span class="ch">'footer'</span> )</code></pre>
<p>If you want to create a new element for your view, set any combination of the following view's properties: <code>tagName</code>, <code>id</code> and <code>className</code>. A new element will be created for you by the framework and a reference to it will be available at the <code>el</code> property.</p>
<pre><code>tagName: 'p', // required, but defaults to 'div' if not set
className: 'container', // optional, you can assign multiple classes to this property like so 'container homepage'
id: 'header', // optional</code></pre>
<p>The above code creates the <code>DOMElement</code> below but doesn't append it to the DOM.</p>
<pre><code><p id="header" class="container"></p></code></pre>
<p><strong>Understanding <code>render()</code></strong></p>
<p><code>render()</code> is an optional function that defines the logic for rendering a template. We'll use Underscore's micro-templating in these examples, but remember you can use other templating frameworks if you prefer.</p>
<p>The <code>_.template</code> method in Underscore compiles JavaScript templates into functions which can be evaluated for rendering. In the above view, I'm passing the markup from a template with id <code>results-template</code> to <code>_.template()</code> to be compiled. Next, I set the html of the <code>el</code> DOM element to the output of processing a JSON version of the model associated with the view through the compiled template.</p>
<p>Presto! This populates the template, giving you a data-complete set of markup in just a few short lines of code.</p>
<p><strong>The <code>events</code> attribute</strong></p>
<p>The Backbone <code>events</code> attribute allows us to attach event listeners to either custom selectors, or directly to <code>el</code> if no selector is provided. An event takes the form <code>{"eventName selector": "callbackFunction"}</code> and a number of event-types are supported, including <code>click</code>, <code>submit</code>, <code>mouseover</code>, <code>dblclick</code> and more.</p>
<p>What isn't instantly obvious is that under the bonnet, Backbone uses jQuery's <code>.delegate()</code> to provide instant support for event delegation but goes a little further, extending it so that <code>this</code> always refers to the current view object. The only thing to really keep in mind is that any string callback supplied to the events attribute must have a corresponding function with the same name within the scope of your view.</p>
<h3 id="collections"><a name="thebasics-collections" id="thebasics-collections">Collections</a></h3>
<p>Collections are sets of Models and are created by extending <code>Backbone.Collection</code>.</p>
<p>Normally, when creating a collection you'll also want to pass through a property specifying the model that your collection will contain, as well as any instance properties required.</p>
<p>In the following example, we create a PhotoCollection that will contain our Photo models:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoCollection = <span class="kw">Backbone.Collection</span>.<span class="fu">extend</span>({
<span class="dt">model</span>: Photo
});</code></pre>
<p><strong>Getters and Setters</strong></p>
<p>There are a few different ways to retrieve a model from a collection. The most straight-forward is to use <code>Collection.get()</code> which accepts a single id as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> skiingEpicness = <span class="kw">PhotoCollection</span>.<span class="fu">get</span>(<span class="dv">2</span>);</code></pre>
<p>Sometimes you may also want to get a model based on its client id. The client id is a property that Backbone automatically assigns models that have not yet been saved. You can get a model's client id from its <code>.cid</code> property.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> mySkiingCrash = <span class="kw">PhotoCollection</span>.<span class="fu">getByCid</span>(<span class="dv">456</span>);</code></pre>
<p>Backbone Collections don't have setters as such, but do support adding new models via <code>.add()</code> and removing models via <code>.remove()</code>.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> a = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Model</span>({ <span class="dt">title</span>: <span class="ch">'my vacation'</span>}),
b = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Model</span>({ <span class="dt">title</span>: <span class="ch">'my holiday'</span>});
<span class="kw">var</span> photoCollection = <span class="kw">new</span> PhotoCollection([a,b]);
<span class="kw">photoCollection</span>.<span class="fu">remove</span>([a,b]);</code></pre>
<p><strong>Listening for events</strong></p>
<p>As collections represent a group of items, we're also able to listen for <code>add</code> and <code>remove</code> events for when new models are added or removed from the collection. Here's an example:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoCollection = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Collection</span>();
<span class="kw">PhotoCollection</span>.<span class="fu">on</span>(<span class="st">"add"</span>, <span class="kw">function</span>(photo) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"I liked "</span> + <span class="kw">photo</span>.<span class="fu">get</span>(<span class="st">"title"</span>) + <span class="ch">' its this one, right? '</span> + <span class="kw">photo</span>.<span class="fu">get</span>(<span class="st">"src"</span>));
});
<span class="kw">PhotoCollection</span>.<span class="fu">add</span>([
{<span class="dt">title</span>: <span class="st">"My trip to Bali"</span>, <span class="dt">src</span>: <span class="st">"bali-trip.jpg"</span>},
{<span class="dt">title</span>: <span class="st">"The flight home"</span>, <span class="dt">src</span>: <span class="st">"long-flight-oofta.jpg"</span>},
{<span class="dt">title</span>: <span class="st">"Uploading pix"</span>, <span class="dt">src</span>: <span class="st">"too-many-pics.jpg"</span>}
]);</code></pre>
<p>In addition, we're able to bind a <code>change</code> event to listen for changes to models in the collection.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">PhotoCollection</span>.<span class="fu">on</span>(<span class="st">"change:title"</span>, <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"there have been updates made to this collection's titles"</span>);
});</code></pre>
<p><strong>Fetching models from the server</strong></p>
<p><code>Collections.fetch()</code> retrieves a default set of models from the server in the form of a JSON array. When this data returns, the current collection's contents will be replaced with the contents of the array.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoCollection = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Collection</span>;
<span class="kw">PhotoCollection</span>.<span class="fu">url</span> = <span class="ch">'/photos'</span>;
<span class="kw">PhotoCollection</span>.<span class="fu">fetch</span>();</code></pre>
<p>Under the covers, <code>Backbone.sync</code> is the function called every time Backbone tries to read or save models to the server. It uses jQuery or Zepto's ajax implementations to make these RESTful requests, however this can be overridden as per your needs.</p>
<p>In the above example if we wanted to log an event when <code>.sync()</code> was called, we could do this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Backbone</span>.<span class="fu">sync</span> = <span class="kw">function</span>(method, model) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"I've been passed "</span> + method + <span class="st">" with "</span> + <span class="kw">JSON</span>.<span class="fu">stringify</span>(model));
};</code></pre>
<p><strong>Resetting/Refreshing Collections</strong></p>
<p>Rather than adding or removing models individually, you might occasionally wish to update an entire collection at once. <code>Collection.reset()</code> allows us to replace an entire collection with new models as follows:</p>
<p><code>javascript PhotoCollection.reset([ {title: "My trip to Scotland", src: "scotland-trip.jpg"}, {title: "The flight from Scotland", src: "long-flight.jpg"}, {title: "Latest snap of lock-ness", src: "lockness.jpg"}]);</code> Note that using <code>Collection.reset()</code> doesn't fire any <code>add</code> or <code>remove</code> events. A <code>reset</code> event is fired instead.</p>
<h3 id="underscore-utility-functions">Underscore utility functions</h3>
<p>As Backbone requires Underscore as a hard dependency, we're able to use many of the utilities it has to offer to aid with our application development. Here's an example of how Underscore's <code>sortBy()</code> method can be used to sort a collection of photos based on a particular attribute.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> sortedByAlphabet = <span class="kw">PhotoCollection</span>.<span class="fu">sortBy</span>(<span class="kw">function</span> (photo) {
<span class="kw">return</span> <span class="kw">photo</span>.<span class="fu">get</span>(<span class="st">"title"</span>).<span class="fu">toLowerCase</span>();
});</code></pre>
<p>The complete list of what Underscore can do is beyond the scope of this guide, but can be found in its official <a href="http://documentcloud.github.com/underscore/">docs</a>.</p>
<h3 id="routers"><a name="thebasics-routers" id="thebasics-routers">Routers</a></h3>
<p>In Backbone, routers are used to help manage application state and for connecting URLs to application events. This is achieved using hash-tags with URL fragments, or using the browser's pushState and History API. Some examples of routes may be seen below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="dt">http</span>:<span class="co">//unicorns.com/#whatsup</span>
<span class="dt">http</span>:<span class="co">//unicorns.com/#search/seasonal-horns/page2</span></code></pre>
<p>Note: An application will usually have at least one route mapping a URL route to a function that determines what happens when a user reaches that particular route. This relationship is defined as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="st">"route"</span> : <span class="st">"mappedFunction"</span></code></pre>
<p>Let us now define our first controller by extending <code>Backbone.Router</code>. For the purposes of this guide, we're going to continue pretending we're creating a photo gallery application that requires a GalleryRouter.</p>
<p>Note the inline comments in the code example below as they continue the rest of the lesson on routers.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> GalleryRouter = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({
<span class="co">/* define the route and function maps for this router */</span>
<span class="dt">routes</span>: {
<span class="st">"about"</span> : <span class="st">"showAbout"</span>,
<span class="co">/*Sample usage: http://unicorns.com/#about*/</span>
<span class="st">"photos/:id"</span> : <span class="st">"getPhoto"</span>,
<span class="co">/*This is an example of using a ":param" variable which allows us to match </span>
<span class="co"> any of the components between two URL slashes*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#photos/5*/</span>
<span class="st">"search/:query"</span> : <span class="st">"searchPhotos"</span>,
<span class="co">/*We can also define multiple routes that are bound to the same map function,</span>
<span class="co"> in this case searchPhotos(). Note below how we're optionally passing in a </span>
<span class="co"> reference to a page number if one is supplied*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#search/lolcats*/</span>
<span class="st">"search/:query/p:page"</span> : <span class="st">"searchPhotos"</span>,
<span class="co">/*As we can see, URLs may contain as many ":param"s as we wish*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#search/lolcats/p1*/</span>
<span class="st">"photos/:id/download/*imagePath"</span> : <span class="st">"downloadPhoto"</span>,
<span class="co">/*This is an example of using a *splat. splats are able to match any number of </span>
<span class="co"> URL components and can be combined with ":param"s*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#photos/5/download/files/lolcat-car.jpg*/</span>
<span class="co">/*If you wish to use splats for anything beyond default routing, it's probably a good </span>
<span class="co"> idea to leave them at the end of a URL otherwise you may need to apply regular</span>
<span class="co"> expression parsing on your fragment*/</span>
<span class="st">"*other"</span> : <span class="st">"defaultRoute"</span>
<span class="co">/*This is a default route that also uses a *splat. Consider the</span>
<span class="co"> default route a wildcard for URLs that are either not matched or where</span>
<span class="co"> the user has incorrectly typed in a route path manually*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#anything*/</span>
},
<span class="dt">showAbout</span>: <span class="kw">function</span>(){
},
<span class="dt">getPhoto</span>: <span class="kw">function</span>(id){
<span class="co">/* </span>
<span class="co"> Note that the id matched in the above route will be passed to this function</span>
<span class="co"> */</span>
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"You are trying to reach photo "</span> + id);
},
<span class="dt">searchPhotos</span>: <span class="kw">function</span>(query, page){
<span class="kw">var</span> page_number = page || <span class="dv">1</span>;
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"Page number: "</span> + page_number + <span class="st">" of the results for "</span> + query);
},
<span class="dt">downloadPhoto</span>: <span class="kw">function</span>(id, path){
},
<span class="dt">defaultRoute</span>: <span class="kw">function</span>(other){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"Invalid. You attempted to reach:"</span> + other);
}
});
<span class="co">/* Now that we have a router setup, remember to instantiate it*/</span>
<span class="kw">var</span> myGalleryRouter = <span class="kw">new</span> GalleryRouter();</code></pre>
<p>As of Backbone 0.5+, it's possible to opt-in for HTML5 pushState support via <code>window.history.pushState</code>. This permits you to define routes such as http://www.scriptjunkie.com/just/an/example. This will be supported with automatic degradation when a user's browser doesn't support pushState. For the purposes of this tutorial, we'll use the hashtag method.</p>
<h4 id="backbone.history">Backbone.history</h4>
<p>Next, we need to initialize <code>Backbone.history</code> as it handles <code>hashchange</code> events in our application. This will automatically handle routes that have been defined and trigger callbacks when they've been accessed.</p>
<p>The <code>Backbone.history.start()</code> method will simply tell Backbone that it's OK to begin monitoring all <code>hashchange</code> events as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Backbone.history</span>.<span class="fu">start</span>();
<span class="kw">Router</span>.<span class="fu">navigate</span>();</code></pre>
<p>As an aside, if you would like to save application state to the URL at a particular point you can use the <code>.navigate()</code> method to achieve this. It simply updates your URL fragment without the need to trigger the <code>hashchange</code> event:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">/*Lets imagine we would like a specific fragment for when a user zooms into a photo*/</span>
<span class="dt">zoomPhoto</span>: <span class="kw">function</span>(factor){
<span class="kw">this</span>.<span class="fu">zoom</span>(factor); <span class="co">//imagine this zooms into the image</span>
<span class="kw">this</span>.<span class="fu">navigate</span>(<span class="st">"zoom/"</span> + factor); <span class="co">//updates the fragment for us, but doesn't trigger the route</span>
}</code></pre>
<p>It is also possible for <code>Router.navigate()</code> to trigger the route as well as updating the URL fragment.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="dt">zoomPhoto</span>: <span class="kw">function</span>(factor){
<span class="kw">this</span>.<span class="fu">zoom</span>(factor); <span class="co">//imagine this zooms into the image</span>
<span class="kw">this</span>.<span class="fu">navigate</span>(<span class="st">"zoom/"</span> + factor, <span class="kw">true</span>); <span class="co">//updates the fragment for us and triggers the route</span>
}</code></pre>
<h3 id="namespacing"><a name="thebasics-namespacing" id="thebasics-namespacing">Namespacing</a></h3>
<p>When learning how to use Backbone, an important and commonly overlooked area by tutorials is namespacing. If you already have experience with namespacing in JavaScript, the following section will provide some advice on how to specifically apply concepts you know to Backbone, however I will also be covering explanations for beginners to ensure everyone is on the same page.</p>
<h4 id="what-is-namespacing">What is namespacing?</h4>
<p>The basic idea around namespacing is to avoid collisions with other objects or variables in the global namespace. They're important as it's best to safeguard your code from breaking in the event of another script on the page using the same variable names as you are. As a good 'citizen' of the global namespace, it's also imperative that you do your best to similarly not prevent other developer's scripts executing due to the same issues.</p>
<p>JavaScript doesn't really have built-in support for namespaces like other languages, however it does have closures which can be used to achieve a similar effect.</p>
<p>In this section we'll be taking a look shortly at some examples of how you can namespace your models, views, routers and other components specifically. The patterns we'll be examining are:</p>
<ul>
<li>Single global variables</li>
<li>Object Literals</li>
<li>Nested namespacing</li>
</ul>
<p><strong>Single global variables</strong></p>
<p>One popular pattern for namespacing in JavaScript is opting for a single global variable as your primary object of reference. A skeleton implementation of this where we return an object with functions and properties can be found below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myApplication = (<span class="kw">function</span>(){
<span class="kw">function</span>(){
<span class="co">// ...</span>
},
<span class="kw">return</span> {
<span class="co">// ...</span>
}
})();</code></pre>
<p>You've probably seen this technique before. A Backbone-specific example might look like this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myViews = (<span class="kw">function</span>(){
<span class="kw">return</span> {
<span class="dt">PhotoView</span>: <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({ .. }),
<span class="dt">GalleryView</span>: <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({ .. }),
<span class="dt">AboutView</span>: <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({ .. });
<span class="co">//etc.</span>
};
})();</code></pre>
<p>Here we can return a set of views, but the same technique could return an entire collection of models, views and routers depending on how you decide to structure your application. Although this works for certain situations, the biggest challenge with the single global variable pattern is ensuring that no one else has used the same global variable name as you have in the page.</p>
<p>One solution to this problem, as mentioned by Peter Michaux, is to use prefix namespacing. It's a simple concept at heart, but the idea is you select a common prefix name (in this example, <code>myApplication_</code>) and then define any methods, variables or other objects after the prefix.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myApplication_photoView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({}),
myApplication_galleryView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({});</code></pre>
<p>This is effective from the perspective of trying to lower the chances of a particular variable existing in the global scope, but remember that a uniquely named object can have the same effect. This aside, the biggest issue with the pattern is that it can result in a large number of global objects once your application starts to grow.</p>
<p>For more on Peter's views about the single global variable pattern, read his <a href="http://michaux.ca/articles/javascript-namespacing">excellent post on them</a>.</p>
<p>Note: There are several other variations on the single global variable pattern out in the wild, however having reviewed quite a few, I felt the prefixing approach applied best to Backbone.</p>
<p><strong>Object Literals</strong></p>
<p>Object Literals have the advantage of not polluting the global namespace but assist in organizing code and parameters logically. They're beneficial if you wish to create easily readable structures that can be expanded to support deep nesting. Unlike simple global variables, Object Literals often also take into account tests for the existence of a variable by the same name, which helps reduce the chances of collision.</p>
<p>This example demonstrates two ways you can check to see if a namespace already exists before defining it. I commonly use Option 2.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">/*Doesn't check for existence of myApplication*/</span>
<span class="kw">var</span> myApplication = {};
<span class="co">/*</span>
<span class="co">Does check for existence. If already defined, we use that instance.</span>
<span class="co">Option 1: if(!myApplication) myApplication = {};</span>
<span class="co">Option 2: var myApplication = myApplication || {};</span>
<span class="co">We can then populate our object literal to support models, views and collections (or any data, really):</span>
<span class="co">*/</span>
<span class="kw">var</span> myApplication = {
<span class="dt">models </span>: {},
<span class="dt">views </span>: {
<span class="dt">pages </span>: {}
},
<span class="dt">collections </span>: {}
};</code></pre>
<p>One can also opt for adding properties directly to the namespace (such as your views, in the following example):</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myGalleryViews = myGalleryViews || {};
<span class="kw">myGalleryViews</span>.<span class="fu">photoView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({});
<span class="kw">myGalleryViews</span>.<span class="fu">galleryView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({});</code></pre>
<p>The benefit of this pattern is that you're able to easily encapsulate all of your models, views, routers etc. in a way that clearly separates them and provides a solid foundation for extending your code.</p>
<p>This pattern has a number of benefits. It's often a good idea to decouple the default configuration for your application into a single area that can be easily modified without the need to search through your entire codebase just to alter it. Here's an example of a hypothetical object literal that stores application configuration settings:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myConfig = {
<span class="dt">language</span>: <span class="ch">'english'</span>,
<span class="dt">defaults</span>: {
<span class="dt">enableGeolocation</span>: <span class="kw">true</span>,
<span class="dt">enableSharing</span>: <span class="kw">false</span>,
<span class="dt">maxPhotos</span>: <span class="dv">20</span>
},
<span class="dt">theme</span>: {
<span class="dt">skin</span>: <span class="ch">'a'</span>,
<span class="dt">toolbars</span>: {
<span class="dt">index</span>: <span class="ch">'ui-navigation-toolbar'</span>,
<span class="dt">pages</span>: <span class="ch">'ui-custom-toolbar'</span>
}
}
}</code></pre>
<p>Note that there are really only minor syntactical differences between the Object Literal pattern and a standard JSON data set. If for any reason you wish to use JSON for storing your configurations instead (e.g. for simpler storage when sending to the back-end), feel free to.</p>
<p>For more on the Object Literal pattern, I recommend reading Rebecca Murphey's <a href="http://rmurphey.com/blog/2009/10/15/using-objects-to-organize-your-code">excellent article on the topic</a>.</p>
<p><strong>Nested namespacing</strong></p>
<p>An extension of the Object Literal pattern is nested namespacing. It's another common pattern used that offers a lower risk of collision due to the fact that even if a top-level namespace already exists, it's unlikely the same nested children do. For example, Yahoo's YUI uses the nested object namespacing pattern extensively:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">YAHOO.util.Dom</span>.<span class="fu">getElementsByClassName</span>(<span class="ch">'test'</span>);</code></pre>
<p>Yahoo's YUI uses the nested object namespacing pattern regularly and even DocumentCloud (the creators of Backbone) use the nested namespacing pattern in their main applications. A sample implementation of nested namespacing with Backbone may look like this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> galleryApp = galleryApp || {};
<span class="co">// perform similar check for nested children</span>
<span class="kw">galleryApp</span>.<span class="fu">routers</span> = <span class="kw">galleryApp</span>.<span class="fu">routers</span> || {};
<span class="kw">galleryApp</span>.<span class="fu">model</span> = <span class="kw">galleryApp</span>.<span class="fu">model</span> || {};
<span class="kw">galleryApp.model</span>.<span class="fu">special</span> = <span class="kw">galleryApp.model</span>.<span class="fu">special</span> || {};
<span class="co">// routers</span>
<span class="kw">galleryApp.routers</span>.<span class="fu">Workspace</span> = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({});
<span class="kw">galleryApp.routers</span>.<span class="fu">PhotoSearch</span> = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({});
<span class="co">// models</span>
<span class="kw">galleryApp.model</span>.<span class="fu">Photo</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({});
<span class="kw">galleryApp.model</span>.<span class="fu">Comment</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({});
<span class="co">// special models</span>
<span class="kw">galleryApp.model.special</span>.<span class="fu">Admin</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({});</code></pre>
<p>This is readable, clearly organized, and is a relatively safe way of namespacing your Backbone application. The only real caveat however is that it requires your browser's JavaScript engine to first locate the galleryApp object, then dig down until it gets to the function you're calling. However, developers such as Juriy Zaytsev (kangax) have tested and found the performance differences between single object namespacing vs the 'nested' approach to be quite negligible.</p>
<p><strong>Recommendation</strong></p>
<p>Reviewing the namespace patterns above, the option that I prefer when writing Backbone applications is nested object namespacing with the object literal pattern.</p>
<p>Single global variables may work fine for applications that are relatively trivial. However, larger codebases requiring both namespaces and deep sub-namespaces require a succinct solution that's both readable and scalable. I feel this pattern achieves both of these objectives and is a good choice for most Backbone development.</p>
<h3 id="additional-tips"><a name="thebasics-additional-tips" id="thebasics-additional-tips">Additional Tips</a></h3>
<h4 id="automated-backbone-scaffolding">Automated Backbone Scaffolding</h4>
<p>Scaffolding can assist in expediting how quickly you can begin a new application by creating the basic files required for a project automatically. If you enjoy the idea of automated MVC scaffolding using Backbone, I'm happy to recommend checking out a tool called <a href="https://github.com/brunch/brunch">Brunch</a>.</p>
<p>It works very well with Backbone, Underscore, jQuery and CoffeeScript and is even used by companies such as Red Bull and Jim Beam. You may have to update any third party dependencies (e.g. latest jQuery or Zepto) when using it, but other than that it should be fairly stable to use right out of the box.</p>
<p>Brunch can be installed via the nodejs package manager and is easy to get started with. If you happen to use Vim or Textmate as your editor of choice, you'll be happy to know that there are Brunch bundles available for both.</p>
<h4 id="is-there-a-limit-to-the-number-of-routers-i-should-be-using">Is there a limit to the number of routers I should be using?</h4>
<p>Andrew de Andrade has pointed out that DocumentCloud themselves usually only use a single router in most of their applications. You're very likely to not require more than one or two routers in your own projects as the majority of your application routing can be kept organized in a single controller without it getting unwieldy.</p>
<h4 id="is-backbone-too-small-for-my-applications-needs">Is Backbone too small for my application's needs?</h4>
<p>If you find yourself unsure of whether or not your application is too large to use Backbone, I recommend reading <a href="http://addyosmani.com/blog/jqcon-largescalejs-2012/">my post</a> on building large-scale jQuery & JavaScript applications or reviewing my slides on client-side MVC architecture options. In both, I cover alternative solutions and my thoughts on the suitability of current MVC solutions for scaled application development.</p>
<p>Backbone can be used for building both trivial and complex applications as demonstrated by the many examples Ashkenas has been referencing in the Backbone documentation. As with any MVC framework however, it's important to dedicate time towards planning out what models and views your application really needs. Diving straight into development without doing this can result in either spaghetti code or a large refactor later on and it's best to avoid this where possible.</p>
<p>At the end of the day, the key to building large applications is not to build large applications in the first place. If you find that Backbone doesn't cut it for your requirements, I strongly recommend checking out JavaScriptMVC, SproutCore, or Ember.js as they offer a little more than Backbone out of the box. Dojo and Dojo Mobile may also be of interest as these have also been used to build significantly complex apps by other developers.</p>
<h2 id="restful-applications">## <a name="restfulapps">RESTful Applications</a></h2>
<h2 id="building-restful-applications-with-backbone"><a name="restful">Building RESTful applications with Backbone</a></h2>
<p>In this section of the book, we're going to take a look at developing RESTful applications using Backbone.js and modern technology stacks. When the data for your back-end is exposed through a purely RESTful API, tasks such as retrieving (GET), creating (POST), updating (PUT) and deleting (DELETE) models are made easy through Backbone's Model API. This API is so intuitive in fact that switching from storing records in a local data-store (e.g localStorage) to a database/noSQL data-store is a lot simpler than you may think.</p>
<h2 id="stack-1-building-a-backbone-app-with-node.js-express-mongoose-and-mongodb"><a name="stack1">Stack 1: Building A Backbone App With Node.js, Express, Mongoose and MongoDB</a></h2>
<p>The first stack we'll be looking at is:</p>
<ul>
<li><a href="nodejs.org">Node.js</a></li>
<li><a href="http://expressjs.com/">Express</a></li>
<li><a href="http://mongoosejs.com/">Mongoose</a></li>
<li>and <a href="http://www.mongodb.org/">MongoDB</a></li>
</ul>
<p>with <a href="http://jade-lang.com/">Jade</a> used optionally as a view/templating engine.</p>
<h3 id="reviewing-the-stack">Reviewing the stack</h3>
<p>As you may know, node.js is an event-driven platform (built on the <a href="http://code.google.com/apis/v8/design.html">V8</a> runtime), designed for writing fast, scalable network applications. It's reasonably lightweight, efficient and great for real-time applications that are data-intensive.</p>
<p>Express is a small web-development framework written with node.js, based on <a href="http://www.sinatrarb.com/">Sinatra</a>. It supports a number of useful features such as intuitive views, robust routing and a focus on high performance.</p>
<p>Next on the list are MongoDB and Mongoose. MongoDB is an open-source, document-oriented database store designed with scalability and agility in mind. As a <a href="http://en.wikipedia.org/wiki/NoSQL">noSQL</a> database, rather than storing data in tables and rows (something we're very used to doing with relational databases), with MongoDB we instead store JSON-like documents using dynamic schemas. One of the goals of Mongo is to try bridging the gap between key-value stores (speed, scalability) and <a href="http://en.wikipedia.org/wiki/Relational_database">relational</a> databases (rich functionality).</p>
<p>Mongoose is a JavaScript library that simplifies how we interact with Mongo. Like Express, it's designed to work within the node.js environment and tries to solve some of the complexities with asynchronous data storage by offering a more user-friendly API. It also adds chaining features into the mix, allowing for a slightly more expressive way of dealing with our data.</p>
<p>Jade is a template engine influenced by Haml (which we'll be looking at later). It's implemented with JavaScript (and also runs under node). In addition to supporting Express out of the box, it boasts a number of useful features including support for mixins, includes, caching, template inheritance and much more. Whilst abstractions like Jade certainly aren't for everyone, our practical will cover working both with and without it.</p>
<h3 id="practical">Practical</h3>
<p>For this practical, we're going to once again look at extending the popular Backbone Todo application. Rather than relying on localStorage for data persistence, we're going to switch to storing Todos in a MongoDB document-store instead. The code for this practical can be found in <code>practicals\stacks\option2</code></p>
<p><strong>app.js</strong></p>
<p>(See <a href="https://github.com/addyosmani/backbone-boilerplates/blob/master/option2/app.js">here</a> for the source)</p>
<p>We must first include the node dependencies required by our application. These are Express, Mongoose and Path (a module containing utilities for dealing with file paths).</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> application_root = __dirname,
express = require(<span class="st">"express"</span>),
path = require(<span class="st">"path"</span>),
mongoose = require(<span class="ch">'mongoose'</span>);</code></pre>
<p>Next, create a new Express server. <code>express.createServer()</code> is a simple way of creating an instance of express.HTTPServer, which we'll be using to pass in our routes.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> app = <span class="kw">express</span>.<span class="fu">createServer</span>();</code></pre>
<p>After this, connect Mongoose up to a database (in our case, localhost should suffice). Should you require the ability to pass in authentication information, here's a sample containing all of the supported URL parameters: <code>mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]</code></p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">mongoose</span>.<span class="fu">connect</span>(<span class="ch">'mongodb://localhost/my_database'</span>);</code></pre>
<p>A Mongoose model for any Todo item can now be easily defined by passing a schema instance to <code>mongoose.model</code>. In our case the schema covers a Todo item's <code>text</code> content, its <code>done</code> state and <code>order</code> position in the overall Todo list.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Todo = <span class="kw">mongoose</span>.<span class="fu">model</span>(<span class="ch">'Todo'</span>, <span class="kw">new</span> <span class="kw">mongoose</span>.<span class="fu">Schema</span>({
<span class="dt">text</span>: <span class="kw">String</span>,
<span class="dt">done</span>: <span class="kw">Boolean</span>,
<span class="dt">order</span>: <span class="fu">Number</span>
}));</code></pre>
<p>The <code>configure()</code> methods allows us to setup what we need for the current environment with our Express server. Note that lower down in the configuration are two view/view related lines. The last one explicitly sets the viewing/templating engine to be used as Jade <code>app.set('view engine', 'jade')</code>. We can avoid these if we wish to use plain HTML/JS for our templates instead.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">configure</span>(<span class="kw">function</span>(){
<span class="co">// the bodyParser middleware parses JSON request bodies</span>
<span class="kw">app</span>.<span class="fu">use</span>(<span class="kw">express</span>.<span class="fu">bodyParser</span>());
<span class="kw">app</span>.<span class="fu">use</span>(<span class="kw">express</span>.<span class="fu">methodOverride</span>());
<span class="kw">app</span>.<span class="fu">use</span>(<span class="kw">app</span>.<span class="fu">router</span>);
<span class="kw">app</span>.<span class="fu">use</span>(<span class="kw">express</span>.<span class="fu">static</span>(<span class="kw">path</span>.<span class="fu">join</span>(application_root, <span class="st">"public"</span>)));
<span class="kw">app</span>.<span class="fu">use</span>(<span class="kw">express</span>.<span class="fu">errorHandler</span>({ <span class="dt">dumpExceptions</span>: <span class="kw">true</span>, <span class="dt">showStack</span>: <span class="kw">true</span> }));
<span class="kw">app</span>.<span class="fu">set</span>(<span class="ch">'views'</span>, <span class="kw">path</span>.<span class="fu">join</span>(application_root, <span class="st">"views"</span>));
<span class="kw">app</span>.<span class="fu">set</span>(<span class="ch">'view engine'</span>, <span class="ch">'jade'</span>)
});</code></pre>
<p>Should you prefer to switch out Jade for an alternative view engine, this can be done fairly trivially. See the section under 'Templating' here: https://github.com/joyent/node/wiki/modules. For example, to switch to EJS, you would simply write <code>app.set('view engine', 'ejs')</code></p>
<p>Express makes use of common HTTP verbs (get, put, post etc.) to provide easy to use, expressive routing API based on CRUD (Create, Read, Update and Delete). Below for example, we can define what happens when the browser requests the root '/'. As a trivial route in this application, it doesn't do anything particularly exciting, however getters typically read or retrieve data.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">get</span>(<span class="ch">'/'</span>, <span class="kw">function</span>(req, res){
<span class="kw">res</span>.<span class="fu">send</span>(<span class="ch">'Hello World'</span>);
});</code></pre>
<p>Onto something a little more useful and in our next route, navigating to '/todo' will actually render our Jade view 'todo.jade', as seen in the callback. Additional configuration values can be passed as the second parameter, such as the custom title specified below.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">get</span>(<span class="ch">'/todo'</span>, <span class="kw">function</span>(req, res){
<span class="kw">res</span>.<span class="fu">render</span>(<span class="ch">'todo'</span>, {<span class="dt">title</span>: <span class="st">"Our sample application"</span>});
});</code></pre>
<p>Next, we can see the first of our '/api/' routes.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">get</span>(<span class="ch">'/api/todos'</span>, <span class="kw">function</span>(req, res){
<span class="kw">return</span> <span class="kw">Todo</span>.<span class="fu">find</span>(<span class="kw">function</span>(err, todos) {
<span class="kw">return</span> <span class="kw">res</span>.<span class="fu">send</span>(todos);
});
});</code></pre>
<p>The callback to our next route supports querying for todos based on a specific ID. The route string itself (once compiled) will be converted from '/api/todos/:id' to a regular expression. As you might have guessed, this is a hint that routes can also be regular expression literals if we wished to do something more complex.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">get</span>(<span class="ch">'/api/todos/:id'</span>, <span class="kw">function</span>(req, res){
<span class="kw">return</span> <span class="kw">Todo</span>.<span class="fu">findById</span>(<span class="kw">req.params</span>.<span class="fu">id</span>, <span class="kw">function</span>(err, todo) {
<span class="kw">if</span> (!err) {
<span class="kw">return</span> <span class="kw">res</span>.<span class="fu">send</span>(todo);
}
});
});</code></pre>
<p>Similarly, we want to support updating todos based on a specific ID as well. The following allows us to query a todo by ID and then update the values of its three attributes (text, done, order) easily.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">put</span>(<span class="ch">'/api/todos/:id'</span>, <span class="kw">function</span>(req, res){
<span class="kw">return</span> <span class="kw">Todo</span>.<span class="fu">findById</span>(<span class="kw">req.params</span>.<span class="fu">id</span>, <span class="kw">function</span>(err, todo) {
<span class="kw">todo</span>.<span class="fu">text</span> = <span class="kw">req.body</span>.<span class="fu">text</span>;
<span class="kw">todo</span>.<span class="fu">done</span> = <span class="kw">req.body</span>.<span class="fu">done</span>;
<span class="kw">todo</span>.<span class="fu">order</span> = <span class="kw">req.body</span>.<span class="fu">order</span>;
<span class="kw">return</span> <span class="kw">todo</span>.<span class="fu">save</span>(<span class="kw">function</span>(err) {
<span class="kw">if</span> (!err) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"updated"</span>);
}
<span class="kw">return</span> <span class="kw">res</span>.<span class="fu">send</span>(todo);
});
});
});</code></pre>
<p>We've so far covered requesting todos and updating them, but a core part of the application requires us to insert (or add) new todos to our data-store. Below we can create new <code>Todo</code> models and simply save them.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">post</span>(<span class="ch">'/api/todos'</span>, <span class="kw">function</span>(req, res){
<span class="kw">var</span> todo;
todo = <span class="kw">new</span> Todo({
<span class="dt">text</span>: <span class="kw">req.body</span>.<span class="fu">text</span>,
<span class="dt">done</span>: <span class="kw">req.body</span>.<span class="fu">done</span>,
<span class="dt">order</span>: <span class="kw">req.body</span>.<span class="fu">order</span>
});
<span class="kw">todo</span>.<span class="fu">save</span>(<span class="kw">function</span>(err) {
<span class="kw">if</span> (!err) {
<span class="kw">return</span> <span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"created"</span>);
}
});
<span class="kw">return</span> <span class="kw">res</span>.<span class="fu">send</span>(todo);
});</code></pre>
<p>We of course also want to support deleting todos (e.g if a todo has been 'cleared', it should be deleted). This also works based on a specific todo ID.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">delete</span>(<span class="ch">'/api/todos/:id'</span>, <span class="kw">function</span>(req, res){
<span class="kw">return</span> <span class="kw">Todo</span>.<span class="fu">findById</span>(<span class="kw">req.params</span>.<span class="fu">id</span>, <span class="kw">function</span>(err, todo) {
<span class="kw">return</span> <span class="kw">todo</span>.<span class="fu">remove</span>(<span class="kw">function</span>(err) {
<span class="kw">if</span> (!err) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">"removed"</span>);
<span class="kw">return</span> <span class="kw">res</span>.<span class="fu">send</span>(<span class="ch">''</span>)
}
});
});
});</code></pre>
<p>Finally, this last line is to ensure we're only listening on the port app.js is running.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">app</span>.<span class="fu">listen</span>(<span class="dv">3000</span>);</code></pre>
<p><strong>script.js - updating our Backbone.js app</strong></p>
<p>In the <code>/public/js</code> folder of options 1 (HTML templates) and 2 (Jade) for the practical, you'll find a version of the Backbone Todo app originally by Jerome Gravel-Niquet. Let's pay attention to <a href="https://github.com/addyosmani/backbone-boilerplates/blob/master/option2/public/js/script.js">script.js</a>. In order to change the application to work with our new back-end, we'll need to make some very minor changes to this.</p>
<p>Reviewing <code>window.TodoList</code> (a Backbone Collection), you'll notice that it has a property called <code>localStorage</code>, which uses the Backbone <a href="https://github.com/jeromegn/Backbone.localStorage">localStorage</a> adapter in order to facilitate storing data using the browser's localStorage features.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">window</span>.<span class="fu">TodoList</span> = <span class="kw">Backbone.Collection</span>.<span class="fu">extend</span>({
<span class="co">// Reference to this collection's model.</span>
<span class="dt">model</span>: Todo,
<span class="co">// Save all of the todo items under the `"todos"` namespace.</span>
<span class="co">// Typically, this should be a unique name within your application</span>
<span class="dt">localStorage</span>: <span class="kw">new</span> Store(<span class="st">"todos"</span>),</code></pre>
<p>In order to switch it over to our RESTful backend, we're going to make use of the <code>url</code> property or function on a collection to reference its location on the server. Models inside of a collection then use <code>url</code> to construct URLs of their own. As all of the CRUD for our RESTful API works on the base route '/api/todos', this is the value we set <code>url</code> to.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"> <span class="co">// localStorage: new Store("todos"),</span>
<span class="dt">url</span>: <span class="ch">'/api/todos'</span>,</code></pre>
<p>This is the only change necessary to our existing Backbone application in order to get things working. Pretty easy, right?</p>
<p><strong>todo.jade</strong></p>
<p>The Jade templates for our application cover declarative markup for both the index (layout.jade) of the application and the main Todo container (todo.jade). It also covers the script-tag templates used for rendering each new Todo item that's added.</p>
<pre class="sourceCode html"><code class="sourceCode html">// Todo App Interface
#todoapp