/
index.html
518 lines (424 loc) · 39.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
<!DOCTYPE html>
<!--[if lt IE 7]><html class="no-js lt-ie9 lt-ie8 lt-ie7" lang="en"><![endif]-->
<!--[if IE 7]><html class="no-js lt-ie9 lt-ie8" lang="en"><![endif]-->
<!--[if IE 8]><html class="no-js lt-ie9" lang="en"><![endif]-->
<!--[if gt IE 8]<!-->
<html class="no-js" lang="zh">
<!--<![endif]-->
<head>
<meta charset="UTF-8">
<title>
A Practical Guide to Use Spine.JS in Real World App
- 风车官方博客 | 高效团队协作工具
</title>
<meta name="description" content="记录风车的产品更新和团队思考">
<meta name="keywords" content=" ["SpineJS", "JavaScript MVC", "JavaScript", "Spine"]
">
<meta name="author" content="The Fengche.co Team">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta http-equiv="cleartype" content="on">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" type="image/png" sizes="57x57" href="/apple-touch-icon-57x57-precomposed.png">
<link rel="apple-touch-icon-precomposed" type="image/png" sizes="72x72" href="/apple-touch-icon-72x72-precomposed.png">
<link rel="apple-touch-icon-precomposed" type="image/png" sizes="114x114" href="/apple-touch-icon-114x114-precomposed.png">
<link rel="apple-touch-icon-precomposed" type="image/png" href="/apple-touch-icon-precomposed.png">
<link rel="apple-touch-icon" type="image/png" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="16x16" href="/favicon.png">
<link rel="shortcut icon" sizes="16x16" href="/favicon.ico">
<link rel="alternate" type="application/rss+xml" title="Fengche.co Blog Feed" href="/feed.xml" />
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="/stylesheets/application.css?1392193221" media="screen" rel="stylesheet" type="text/css" />
<script src="/javascripts/application.js?1392188988" type="text/javascript"></script>
<script type="text/javascript" async="" src="http://www.google-analytics.com/ga.js"></script>
<script type="text/javascript">var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-4054156-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();</script>
</head>
<body class="a-practical-guide-to-use-spinejs-in-real-worl a-practical-guide-to-use-spinejs-in-real-worl_index">
<header class="navbar navbar-fixed-top" role="banner">
<div class="container">
<a class="btn btn-navbar" data-target=".nav-collapse" data-toggle="collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="https://fengcheco.com/" tabindex="-1">Fengche.co</a>
<nav class="nav-collapse collapse" role="navigation">
<ul class="nav pull-right">
<li><a href="https://fengcheco.com">首页</a></li>
<li><a href="https://fengcheco.com/tour">了解产品</a></li>
<li><a href="https://fengcheco.com/pricing">价格方案</a></li>
<li><a class="login" data-target="#login-modal" data-toggle="modal" href="https://fengcheco.com/login" role="button" type="button">登录</a></li>
<li class="action"><a class="signup" href="https://fengcheco.com/signup">免费注册</a></li>
</ul>
</nav>
</div>
</header>
<section class="hero wrap-blue">
<div class="container header">
<h1 class="blog-name">「风车协作」官方博客</h1>
<p> 好好做产品,做好产品 </p>
</div>
</section>
<section class="main">
<div class="container">
<article class="post single">
<header>
<h2 class="title">
<a href="/a-practical-guide-to-use-spinejs-in-real-worl">A Practical Guide to Use Spine.JS in Real World App</a>
</h2>
</header>
<aside>
<ul class="meta">
<li class="author-photo">
<a href="http://yedingding.com">
<img alt="" width="120" height="120" src="/images/dingding-ye.png?1379005285" />
</a>
</li>
<li class="author">
by 叶玎玎
</li>
<li class="date">
Aug 20, 2012
</li>
<li class="tags">
<a href="/tags/spinejs">SpineJS</a>
<a href="/tags/javascript-mvc">JavaScript MVC</a>
<a href="/tags/javascript">JavaScript</a>
<a href="/tags/spine">Spine</a>
</li>
<li class="back-link">
<a href="/">‹ 返回博客主页</a>
</li>
</ul>
</aside>
<div class="content">
<p>To give users the best possible fluid experience, we designed <a href="https://fengche.co">Pragmatic.ly</a> and complied with the <a href="http://en.wikipedia.org/wiki/Single-page_application">single page application</a> standard. We believe that could make users focus on building product rather than spending time on project management itself. A wide range of technology solutions are available to make a single page application. Current trends suggest moving core application from server to client side and keeping server load at minimum for better performance by pure data APIs. <a href="https://fengche.co">Pragmatic.ly</a> took on the challange to cater to this need by developing server side in Rails, Spine.js at client side.</p>
<h3>Why Spine.JS</h3>
<p>There are many different JavaScript MVC frameworks such as <a href="http://backbonejs.org/">Backbone.js</a>, <a href="http://spinejs.com/">Spine.js</a>, <a href="http://knockoutjs.com/">Knockout.js</a>, <a href="http://emberjs.com/">Ember.js</a>, etc. There are too many choices and when I started Pragmatic.ly, I was struggling with the problem of which one I should pick up. Instead of wasting time on choosing I did a quick review by comparing the documents and then decided to choose Spine.js to start with. With months of development so far, I’m glad that Spine.js works pretty well and below are the great benefits I have found in using Spine.js.</p>
<ul>
<li><em>Simple and lightweight</em>. It’s easy to dive into the core and extend as you need to.</li>
<li><em>MVC pattern at its core</em>. It’s very similar to the Rails counterparts. So I’m very comfortable with it from the first day.</li>
<li><em>Rails integration</em>. It can’t be easier to use Rails as the backend data API in Spine.js app. And the <a href="https://github.com/maccman/spine-rails">spine-rails</a> gem is another great addition.</li>
<li><a href="http://alexmaccaw.com/posts/async_ui"><em>Asynchronous UI</em></a>. Ideally UIs never block and it will automatically update the data in backend. This brings the fast and very responsive user interface.</li>
</ul>
<p>If you want to get a brief review among different frameworks, check out <a href="http://codebrief.com/2012/01/the-top-10-javascript-mvc-frameworks-reviewed/">this article</a> written by Gordon L. Hemption.</p>
<h3>How we use Spine.js in Pragmatic.ly</h3>
<p>We use spine-rails to generate the Spine.app structure, very similar to Rails app structure.</p>
<pre class="highlight shell">├── app
│ ├── controllers
│ │ ├── center
│ │ │ ├── filter_controller.js.coffee
│ │ │ └── tickets_controller.js.coffee
│ │ ├── center_content_controller.coffee
│ │ ├── comments_controller.js.coffee
│ │ ├── header
│ │ │ └── project_nav_controller.js.coffee
│ │ ├── header_controller.coffee
│ │ ├── iterations_controller.coffee
│ │ ├── left_sidebar_controller.coffee
│ │ ├── projects_controller.coffee
│ │ ├── right_sidebar_controller.coffee
│ │ ├── sidebars
│ │ │ ├── left_iteration.js.coffee
│ │ │ ├── left_people.js.coffee
│ │ │ ├── right_activities.js.coffee
│ │ │ └── right_detail_section.js.coffee
│ │ ├── tickets_controller.coffee
│ │ └── users_controller.js.coffee
│ ├── index.js.coffee
│ ├── lib
│ │ ├── constants.js.coffee
│ │ ├── eco-helpers.js
│ │ └── view.js.coffee
│ ├── models
│ │ ├── comment.js.coffee
│ │ ├── iteration.js.coffee
│ │ ├── project.js.coffee
│ │ ├── ticket.js.coffee
│ │ └── user.js.coffee
│ └── views
│ ├── comments
│ │ ├── audit.jst.eco
│ │ ├── form.jst.eco
│ │ └── plain.jst.eco
│ ├── iterations
│ │ ├── section.jst.eco
│ │ └── show.jst.eco
│ ├── projects
│ │ ├── edit.jst.eco
│ │ ├── form.jst.eco
│ │ ├── new.jst.eco
│ │ └── switch.jst.eco
│ ├── tickets
│ │ ├── section.jst.eco
│ │ ├── show.jst.eco
│ │ └── toolbar.jst.eco
│ └── users
│ ├── people.jst.eco
│ └── show.jst.eco
├── application.js
├── bootstrap.js.coffee
└── dashboard.js.coffee
</pre>
<p>So basically it’s controllers, models and views.</p>
<h3>Controllers</h3>
<p>There are two kinds of Controllers in Pragmatic.ly. In Spine, Controllers are considered the glue of an application, adding and responding to DOM events, rendering templates and ensuring that views and models are kept in sync. For example,</p>
<pre class="highlight coffeescript"><span class="k">class</span> <span class="nx">App</span><span class="p">.</span><span class="na">LeftIterationController</span> <span class="k">extends</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Controller</span>
<span class="na">el</span><span class="o">:</span> <span class="s">'.sidebar #iterations'</span>
<span class="na">elements</span><span class="o">:</span>
<span class="s">'ul.list'</span><span class="o">:</span> <span class="s">'list'</span>
<span class="na">constructor</span><span class="o">:</span> <span class="o">-></span>
<span class="k">super</span>
<span class="nx">App</span><span class="p">.</span><span class="na">Iteration</span><span class="p">.</span><span class="na">bind</span> <span class="s">'create'</span><span class="p">,</span> <span class="vi">@</span><span class="na">addIteration</span>
<span class="nx">App</span><span class="p">.</span><span class="na">Iteration</span><span class="p">.</span><span class="na">bind</span> <span class="s">'refresh'</span><span class="p">,</span> <span class="vi">@</span><span class="na">refreshIterations</span>
<span class="na">release</span><span class="o">:</span> <span class="o">-></span>
<span class="k">super</span>
<span class="nx">App</span><span class="p">.</span><span class="na">Iteration</span><span class="p">.</span><span class="na">unbind</span> <span class="s">'create'</span><span class="p">,</span> <span class="vi">@</span><span class="na">addIteration</span>
<span class="nx">App</span><span class="p">.</span><span class="na">Iteration</span><span class="p">.</span><span class="na">unbind</span> <span class="s">'refresh'</span><span class="p">,</span> <span class="vi">@</span><span class="na">refreshIterations</span>
<span class="na">addIteration</span><span class="o">:</span> <span class="p">(</span><span class="nx">iteration</span><span class="p">)</span> <span class="o">=></span>
<span class="nx">iteration</span><span class="p">.</span><span class="na">unbind</span><span class="p">()</span>
<span class="nx">view</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">App</span><span class="p">.</span><span class="na">IterationItem</span><span class="p">(</span><span class="na">item</span><span class="o">:</span> <span class="nx">iteration</span><span class="p">)</span>
<span class="vi">@</span><span class="na">list</span><span class="p">.</span><span class="na">append</span><span class="p">(</span><span class="nx">view</span><span class="p">.</span><span class="na">render</span><span class="p">().</span><span class="na">el</span><span class="p">)</span>
<span class="na">refreshIterations</span><span class="o">:</span> <span class="p">(</span><span class="nx">iterations</span><span class="p">)</span> <span class="o">=></span>
<span class="vi">@</span><span class="na">addIteration</span> <span class="nx">iteration</span> <span class="k">for</span> <span class="nx">iteration</span> <span class="k">in</span> <span class="nx">iterations</span>
</pre>
<p>We split the page into multiple blocks and each block is a Spine Controller. Talking the above example, LeftIterationsController is the Controller to manage the iterations list in the left sidebar.</p>
<p>Then what’s the other kind? The answer is Routes! We extract the routes to the dedicated controllers now. It will setup the routes and respond to the navigation event. Then it will prepare the data and trigger the event to let another controller handle it to render templates. For example,</p>
<pre class="highlight coffeescript"><span class="k">class</span> <span class="nx">App</span><span class="p">.</span><span class="na">TicketsController</span> <span class="k">extends</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Controller</span>
<span class="na">constructor</span><span class="o">:</span> <span class="o">-></span>
<span class="k">super</span>
<span class="vi">@</span><span class="na">routes</span>
<span class="s">"/tickets"</span><span class="o">:</span> <span class="vi">@</span><span class="na">index</span>
<span class="s">"/tickets/:id"</span> <span class="o">:</span> <span class="p">(</span><span class="nx">params</span><span class="p">)</span> <span class="o">-></span>
<span class="vi">@</span><span class="na">show</span><span class="p">(</span><span class="nx">params</span><span class="p">.</span><span class="na">id</span><span class="p">)</span>
<span class="na">index</span><span class="o">:</span> <span class="o">-></span>
<span class="nx">tickets</span> <span class="o">=</span> <span class="nx">App</span><span class="p">.</span><span class="na">Ticket</span><span class="p">.</span><span class="na">all</span><span class="p">()</span>
<span class="nx">App</span><span class="p">.</span><span class="na">Ticket</span><span class="p">.</span><span class="na">trigger</span> <span class="s">"tickets:index"</span><span class="p">,</span> <span class="nx">tickets</span>
<span class="na">show</span><span class="o">:</span> <span class="p">(</span><span class="nx">id</span><span class="p">)</span> <span class="o">-></span>
<span class="nx">ticket</span> <span class="o">=</span> <span class="nx">App</span><span class="p">.</span><span class="na">Ticket</span><span class="p">.</span><span class="na">find</span><span class="p">(</span><span class="nx">id</span><span class="p">)</span>
<span class="nx">$</span><span class="p">.</span><span class="na">publish</span> <span class="s">'ticket:switch'</span><span class="p">,</span> <span class="nx">ticket</span>
</pre>
<h3>Models</h3>
<p>Models manage data for the application. It’s very similar to Rails models. I just want to mention one thing though - as we moved the logic from server side to client side, there was no need to translate 1:1 on the client side. Instead, encapsulate the data into model which is suitable for the page based on the user.</p>
<pre class="highlight coffeescript"><span class="k">class</span> <span class="nx">App</span><span class="p">.</span><span class="na">Project</span> <span class="k">extends</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span>
<span class="vi">@</span><span class="na">configure</span> <span class="s">'Project'</span><span class="p">,</span> <span class="s">'id'</span><span class="p">,</span> <span class="s">'name'</span><span class="p">,</span> <span class="s">'description'</span><span class="p">,</span> <span class="s">'owner_id'</span><span class="p">,</span> <span class="s">'uid'</span>
<span class="vi">@</span><span class="na">extend</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span><span class="p">.</span><span class="na">Ajax</span>
<span class="vi">@</span><span class="na">extend</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span><span class="p">.</span><span class="na">Dirty</span>
<span class="na">validate</span><span class="o">:</span> <span class="o">-></span>
<span class="s">'name required'</span> <span class="nx">unless</span> <span class="vi">@</span><span class="na">name</span>
<span class="na">inviteUser</span><span class="o">:</span> <span class="p">(</span><span class="nx">email</span><span class="p">)</span> <span class="o">-></span>
<span class="nx">App</span><span class="p">.</span><span class="na">Invitation</span><span class="p">.</span><span class="na">create</span><span class="p">(</span><span class="na">project_id</span><span class="o">:</span> <span class="vi">@</span><span class="na">id</span><span class="p">,</span> <span class="na">email</span><span class="o">:</span> <span class="nx">email</span><span class="p">)</span>
</pre>
<h3>Views</h3>
<p>Views are about building and maintaining the DOM elements. Views in Spine are very simple and don’t have the built-in UI binding. So most of the time you should let Controller observe the Model and get notified when the model changes, then update the view accordingly.</p>
<p>By doing all the view rendering client-side, you should use JavaScript templating solution to define templates for views as markup containing tempalte variables. There are a number of good candidates, such as Mustache, jQuery.tmpl and Eco.</p>
<p>I use Eco in Pragmatic.ly. The Erb-like syntax and CoffeeScript support is a big triumph. However, you should know that every eco template generates the same helpers which will increase the file size. You can use this <a href="https://gist.github.com/sishen/2360781">gist</a> to avoid the problem which will register the global helpers and inject into the Eco templates.</p>
<pre class="highlight ruby"><span class="c1"># Put this file in lib/</span>
<span class="nb">require</span> <span class="s1">'sprockets/eco_template'</span>
<span class="k">class</span> <span class="nc">CleanEcoTemplate</span> <span class="o"><</span> <span class="no">Sprockets</span><span class="o">::</span><span class="no">EcoTemplate</span>
<span class="no">FROM</span> <span class="o">=</span> <span class="s2">" (function() {"</span>
<span class="no">TO</span> <span class="o">=</span> <span class="s2">"}).call(__obj);"</span>
<span class="k">def</span> <span class="nf">evaluate</span><span class="p">(</span><span class="n">scope</span><span class="p">,</span> <span class="n">locals</span><span class="p">,</span> <span class="o">&</span><span class="n">block</span><span class="p">)</span>
<span class="n">content</span> <span class="o">=</span> <span class="no">Eco</span><span class="p">.</span><span class="nf">compile</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="n">from</span> <span class="o">=</span> <span class="n">content</span><span class="p">.</span><span class="nf">index</span><span class="p">(</span><span class="no">FROM</span><span class="p">)</span>
<span class="n">to</span> <span class="o">=</span> <span class="n">content</span><span class="p">.</span><span class="nf">rindex</span><span class="p">(</span><span class="no">TO</span><span class="p">)</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">content</span><span class="o">[</span><span class="n">from</span><span class="p">.</span><span class="nf">.</span><span class="p">.</span><span class="nf">to</span><span class="o">]</span> <span class="o">+</span> <span class="no">TO</span>
<span class="o"><<-</span><span class="no">JS</span><span class="sh">
function(__obj) {
if (!__obj) __obj = {};
var __helpers = window.ecoHelpers;
var __out = [];
var __sanitize = __helpers.sanitize;
var __capture = __helpers.captureFor(__obj, __out);
var __rememberSafe = __obj.safe;
var __rememberEscape = __obj.escape;
__obj.safe = __helpers.safe;
__obj.escape = __helpers.escape;
</span><span class="si">#{</span><span class="n">content</span><span class="si">}</span><span class="sh">
__obj.safe = __rememberSafe;
__obj.escape = __rememberEscape;
return __out.join('');
};
</span><span class="no"> JS</span>
<span class="k">end</span>
<span class="k">end</span>
</pre><pre class="highlight ruby"><span class="c1"># Put this file in config/initializers</span>
<span class="nb">require</span> <span class="s1">'clean_eco_template'</span>
<span class="no">Rails</span><span class="p">.</span><span class="nf">application</span><span class="p">.</span><span class="nf">assets</span><span class="p">.</span><span class="nf">register_engine</span> <span class="s1">'.eco'</span><span class="p">,</span> <span class="no">CleanEcoTemplate</span>
</pre><pre class="highlight javascript"><span class="err">#</span> <span class="nx">Must</span> <span class="nx">include</span> <span class="nx">eco</span><span class="o">-</span><span class="nx">helpers</span><span class="p">.</span><span class="nx">js</span> <span class="nx">before</span> <span class="nx">eco</span> <span class="nx">files</span>
<span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">global</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">ecoHelpers</span> <span class="o">=</span> <span class="p">{</span>
<span class="na">sanitize</span><span class="p">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">value</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">value</span> <span class="o">&&</span> <span class="nx">value</span><span class="p">.</span><span class="nx">ecoSafe</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">value</span><span class="p">;</span>
<span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">value</span> <span class="o">!==</span> <span class="s1">'undefined'</span> <span class="o">&&</span> <span class="nx">value</span> <span class="o">!=</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">ecoHelpers</span><span class="p">.</span><span class="nx">escape</span><span class="p">(</span><span class="nx">value</span><span class="p">);</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">return</span> <span class="s1">''</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="na">safe</span><span class="p">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">value</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">value</span> <span class="o">&&</span> <span class="nx">value</span><span class="p">.</span><span class="nx">ecoSafe</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">value</span><span class="p">;</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="k">typeof</span> <span class="nx">value</span> <span class="o">!==</span> <span class="s1">'undefined'</span> <span class="o">&&</span> <span class="nx">value</span> <span class="o">!=</span> <span class="kc">null</span><span class="p">))</span> <span class="nx">value</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">result</span> <span class="o">=</span> <span class="k">new</span> <span class="nb">String</span><span class="p">(</span><span class="nx">value</span><span class="p">);</span>
<span class="nx">result</span><span class="p">.</span><span class="nx">ecoSafe</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="k">return</span> <span class="nx">result</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="na">escape</span><span class="p">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">value</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">(</span><span class="s1">''</span> <span class="o">+</span> <span class="nx">value</span><span class="p">)</span>
<span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/&/g</span><span class="p">,</span> <span class="s1">'&amp;'</span><span class="p">)</span>
<span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/</g</span><span class="p">,</span> <span class="s1">'&lt;'</span><span class="p">)</span>
<span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/>/g</span><span class="p">,</span> <span class="s1">'&gt;'</span><span class="p">)</span>
<span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/"/g</span><span class="p">,</span> <span class="s1">'&quot;'</span><span class="p">);</span>
<span class="p">},</span>
<span class="na">captureFor</span><span class="p">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">obj</span><span class="p">,</span> <span class="nx">out</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">length</span> <span class="o">=</span> <span class="nx">out</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span>
<span class="nx">callback</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="nx">obj</span><span class="p">);</span>
<span class="k">return</span> <span class="nx">ecoHelpers</span><span class="p">.</span><span class="nx">safe</span><span class="p">(</span><span class="nx">out</span><span class="p">.</span><span class="nx">splice</span><span class="p">(</span><span class="nx">length</span><span class="p">,</span> <span class="nx">out</span><span class="p">.</span><span class="nx">length</span> <span class="o">-</span> <span class="nx">length</span><span class="p">).</span><span class="nx">join</span><span class="p">(</span><span class="s1">''</span><span class="p">));</span>
<span class="p">});</span>
<span class="p">}</span>
<span class="p">};</span>
<span class="nx">global</span><span class="p">.</span><span class="nx">ecoHelpers</span> <span class="o">=</span> <span class="nx">ecoHelpers</span><span class="p">;</span>
<span class="p">})(</span><span class="nb">window</span><span class="p">);</span>
</pre>
<h3>Problems</h3>
<p>So that’s how we use Spine.js to power Pragmatic.ly. It works very well but still have some limitations.</p>
<ul>
<li><p>By default, you can only monitor the whole Model change event and update the view accordingly. For example, even the username is not changed, you still have to update the views containing that data. There is a “change:field” event in Backbone.js which allow you only to update the view when that field of data changed. I like that. So I made a plugin to support that. Check the Gist out.</p>
<pre class="highlight coffeescript"><span class="nx">Spine</span> <span class="o">?=</span> <span class="nx">require</span><span class="p">(</span><span class="s">'spine'</span><span class="p">)</span>
<span class="nx">Include</span> <span class="o">=</span>
<span class="na">savePrevious</span><span class="o">:</span> <span class="o">-></span>
<span class="vi">@</span><span class="na">constructor</span><span class="p">.</span><span class="na">records</span><span class="p">[</span><span class="vi">@</span><span class="na">id</span><span class="p">].</span><span class="na">previousAttributes</span> <span class="o">=</span> <span class="vi">@</span><span class="na">attributes</span><span class="p">()</span>
<span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span><span class="p">.</span><span class="na">Dirty</span> <span class="o">=</span>
<span class="na">extended</span><span class="o">:</span> <span class="o">-></span>
<span class="vi">@</span><span class="na">bind</span> <span class="s">'refresh'</span><span class="p">,</span> <span class="o">-></span>
<span class="vi">@</span><span class="na">each</span> <span class="p">(</span><span class="nx">record</span><span class="p">)</span> <span class="o">-></span> <span class="nx">record</span><span class="p">.</span><span class="na">savePrevious</span><span class="p">()</span>
<span class="vi">@</span><span class="na">bind</span> <span class="s">'save'</span><span class="p">,</span> <span class="p">(</span><span class="nx">record</span><span class="p">)</span> <span class="o">-></span>
<span class="k">if</span> <span class="nx">record</span><span class="p">.</span><span class="na">previousAttributes</span><span class="o">?</span>
<span class="k">for</span> <span class="nx">key</span> <span class="k">in</span> <span class="nx">record</span><span class="p">.</span><span class="na">constructor</span><span class="p">.</span><span class="na">attributes</span> <span class="k">when</span> <span class="nx">key</span> <span class="k">of</span> <span class="nx">record</span>
<span class="k">if</span> <span class="nx">record</span><span class="p">[</span><span class="nx">key</span><span class="p">]</span> <span class="o">isnt</span> <span class="nx">record</span><span class="p">.</span><span class="na">previousAttributes</span><span class="p">[</span><span class="nx">key</span><span class="p">]</span>
<span class="nx">record</span><span class="p">.</span><span class="na">trigger</span><span class="p">(</span><span class="s">'change:'</span><span class="o">+</span><span class="nx">key</span><span class="p">,</span> <span class="nx">record</span><span class="p">[</span><span class="nx">key</span><span class="p">])</span>
<span class="nx">record</span><span class="p">.</span><span class="na">savePrevious</span><span class="p">()</span>
<span class="vi">@</span><span class="na">include</span> <span class="nx">Include</span>
</pre>
<p>So the model object can bind the event “change:#{field} to trigger event when the field value is changed.</p>
<p>By default it’s off and if need this feature, the model should extend Spine.Model.Dirty.</p>
<p>A sample case.</p>
<pre class="highlight coffeescript"><span class="k">class</span> <span class="nx">User</span> <span class="k">extends</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span>
<span class="vi">@</span><span class="na">extend</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span><span class="p">.</span><span class="na">Dirty</span>
<span class="nx">end</span>
</pre></li>
<li><p>The Ajax plugin in Spine.js plays very nice with backend REST APIs, such as Rails. For example, creating the model will trigger a "CREATE /collections” event to the server and updating the model will trigger a “PUT /collections/id” event, seemlessly. However, nested resources in Rails is very common but Spine lacks to support that. Either you have to trigger requests to top-level URL or setup the request yourself. I have done a dirty hack to support scoping. It’s dirty but works.</p>
<pre class="highlight coffeescript"> <span class="k">class</span> <span class="nx">App</span><span class="p">.</span><span class="na">Ticket</span> <span class="k">extends</span> <span class="nx">Spine</span><span class="p">.</span><span class="na">Model</span>
<span class="vi">@</span><span class="na">configure</span> <span class="s">'Ticket'</span><span class="p">,</span> <span class="s">"id"</span><span class="p">,</span> <span class="s">"project_id"</span>
<span class="vi">@</span><span class="na">scope</span><span class="o">:</span> <span class="o">-></span>
<span class="s">"projects/</span><span class="si">#{</span><span class="nx">current</span><span class="p">.</span><span class="na">project_id</span><span class="si">}</span><span class="s">"</span>
<span class="na">scope</span><span class="o">:</span> <span class="o">-></span>
<span class="s">"projects/</span><span class="si">#{</span><span class="vi">@</span><span class="na">project_id</span><span class="si">}</span><span class="s">"</span>
</pre></li>
<li><p>Asynchronous UI is cool and works for 98% situations. But in a real world app you have to deal with errors like bugs or network failures. Spine doesn’t have the default error handling for this situation and leave all work to you. It’s fine but you should know that for that 2% situation, you have to spend lots of time to avoid the impact.</p></li>
</ul>
<h3>Test</h3>
<p>I would like to cover how Test works in Pragmatic.ly in another post. To give a quick overview, we use <a href="http://pivotal.github.com/jasmine/">Jasmine</a> for JS test and <a href="http://siliconforks.com/jscoverage/">JSCoverage</a> for measuring code coverage. Nice pair!</p>
<p><br/></p>
<h3>About Pragmatic.ly</h3>
<p><a href="https://fengche.co">Pragmatic.ly</a> is a lean collaborative project management tool aiming to help small teams make better products easier. It’s the ideal and elegant project management tool for tech startups.</p>
<p>Now that you’ve read so far, you should follow me <a href="https://twitter.com/yedingding">@yedingding</a>!</p>
</div>
</article>
<div id="disqus_thread"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'pragmaticlyblog'; // required: replace example with your forum shortname
var disqus_identifier = 'a-practical-guide-to-use-spine-js-in-real-world-app';
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="//disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
</div>
</section>
<footer class="site-footer" role="contentinfo">
<div class="container">
<div class="row">
<div class="span2 offset2">
<nav>
<h5>网站相关</h5>
<ul>
<li><a href="https://fengcheco.com/">首页</a></li>
<li><a href="https://fengcheco.com/tour">了解产品</a></li>
<li><a href="https://fengcheco.com/pricing">价格方案</a></li>
<li><a href="https://fengcheco.com/privacy">隐私政策</a></li>
<li><a href="https://fengcheco.com/terms">服务条款</a></li>
</ul>
</nav>
</div>
<div class="span2">
<nav>
<h5>服务支持</h5>
<ul>
<!--<li><a href="/help">帮助中心</a></li>-->
<li><a href="https://fengcheco.com/get-started">新手帮助</a></li>
<li><a href="mailto:support@fengche.co">联系我们</a></li>
</ul>
</nav>
</div>
<div class="span2">
<nav>
<h5>联系合作</h5>
<ul>
<li><a href="https://fengcheco.com/about">关于我们</a></li>
<li><a href="mailto:press@fengche.co">合作伙伴</a></li>
<li><a href="mailto:press@fengche.co">媒体报道</a></li>
</ul>
</nav>
</div>
<div class="span2">
<nav>
<h5>关注我们</h5>
<ul>
<li><a href="https://fengcheco.com/blog">官方博客</a></li>
<li><a class="social-weibo" href="http://weibo.com/fengcheco" target="_blank">微博</a></li>
<li>QQ群: 162278625</li>
<li><a class="social-facebook" href="https://facebook.com/fengcheco" target="_blank">Facebook</a></li>
<li><a class="social-twitter" href="https://twitter.com/#!/fengcheco" target="_blank">Twitter</a></li>
</ul>
</nav>
</div>
</div>
<div class="copyright">
<p>© 2012-2014 Fengche.co (former Pragmatic.ly)</p>
</div>
</div>
</footer>
<!-- begin olark code -->
<script data-cfasync="false" type='text/javascript'>/*{literal}<![CDATA[*/
window.olark||(function(c){var f=window,d=document,l=f.location.protocol=="https:"?"https:":"http:",z=c.name,r="load";var nt=function(){f[z]=function(){(a.s=a.s||[]).push(arguments)};var a=f[z]._={},q=c.methods.length;while(q--){(function(n){f[z][n]=function(){f[z]("call",n,arguments)}})(c.methods[q])}a.l=c.loader;a.i=nt;a.p={0:+new Date};a.P=function(u){a.p[u]=new Date-a.p[0]};function s(){a.P(r);f[z](r)}f.addEventListener?f.addEventListener(r,s,false):f.attachEvent("on"+r,s);var ld=function(){function p(hd){hd="head";return["<",hd,"></",hd,"><",i,' onl' + 'oad="var d=',g,";d.getElementsByTagName('head')[0].",j,"(d.",h,"('script')).",k,"='",l,"//",a.l,"'",'"',"></",i,">"].join("")}var i="body",m=d[i];if(!m){return setTimeout(ld,100)}a.P(1);var j="appendChild",h="createElement",k="src",n=d[h]("div"),v=n[j](d[h](z)),b=d[h]("iframe"),g="document",e="domain",o;n.style.display="none";m.insertBefore(n,m.firstChild).id=z;b.frameBorder="0";b.id=z+"-loader";if(/MSIE[ ]+6/.test(navigator.userAgent)){b.src="javascript:false"}b.allowTransparency="true";v[j](b);try{b.contentWindow[g].open()}catch(w){c[e]=d[e];o="javascript:var d="+g+".open();d.domain='"+d.domain+"';";b[k]=o+"void(0);"}try{var t=b.contentWindow[g];t.write(p());t.close()}catch(x){b[k]=o+'d.write("'+p().replace(/"/g,String.fromCharCode(92)+'"')+'");d.close();'}a.P(2)};ld()};nt()})({loader: "static.olark.com/jsclient/loader0.js",name:"olark",methods:["configure","extend","declare","identify"]});
/* custom configuration goes here (www.olark.com/documentation) */
olark.identify('8594-504-10-6122');/*]]>{/literal}*/
</script>
<noscript><a
href="https://www.olark.com/site/8594-504-10-6122/contact"
title="Contact us" target="_blank">Questions? Feedback?</a>
powered by <a href="http://www.olark.com?welcome" title="Olark
live chat software">Olark live chat software</a></noscript>
<!-- end olark code -->
</body>
</html>