-
Notifications
You must be signed in to change notification settings - Fork 0
/
fixtures.html
432 lines (348 loc) · 17.1 KB
/
fixtures.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title></title>
<!-- plugin styles -->
<link rel="stylesheet" type="text/css" href="stylesheets/highlight-github.css" />
<!-- guides styles -->
<link rel="stylesheet" type="text/css" href="stylesheets/reset.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/main.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="stylesheets/guides.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/overrides.style.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/overrides.print.css" media="print" />
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="//netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet">
<meta name="generator" content="DocPad v6.79.0" />
</head>
<body class="guide">
<header role="banner">
<div class="container">
<h1 id="logo">
<a href="http://www.sproutcore.com"><img src="images/header/logo.png" alt="SproutCore" /></a>
</h1>
<nav role="navigation">
<ul>
<li><a href="http://sproutcore.com/about/">About</a></li>
<li><a href="http://showcase.sproutcore.com">Showcase</a></li>
<li class="active"><a href="http://guides.sproutcore.com">Guides</a></li>
<li><a href="http://docs.sproutcore.com">Docs</a></li>
<li><a href="http://sproutcore.com/community/">Community</a></li>
<li><a href="http://blog.sproutcore.com">Blog</a></li>
</ul>
</nav>
</div>
</header>
<div id="feature">
<div class="wrapper">
<div class="feature_header">
<a href="/"><img src="images/graphics/guides.png"></a>
<h2><a href="/">SproutCore Guides</a></h2>
<p>These guides are designed to help you write and perfect your code.</p>
</div>
<div class="feature_sidebar">
<a href="index.html" id="guidesMenu">
Guides Index <span id="guidesArrow">▸</span>
</a>
<div id="guides" class="clearfix" style="display: none;">
<a href="index.html" class="guidesMenu">
Guides Index <span class="guidesArrow">▾</span>
</a>
<hr style="clear:both;">
<dl class='L'><dt>Start Here</dt>
<dd><a href='/getting_started.html'>Getting Started: Part 1</a></dd>
<dd><a href='/getting_started_2.html'>Getting Started: Part 2</a></dd>
<dd><a href='/getting_started_3.html'>Getting Started: Part 3</a></dd>
<dd><a href='/core_concepts_sc_object.html'>Classes and SC.Object</a></dd>
<dd><a href='/core_concepts_kvo.html'>Computed Properties, Observers and Bindings</a></dd><dt>Views</dt>
<dd><a href='/views.html'>Core View Concepts</a></dd><dt>Models</dt>
<dd><a href='/records.html'>SproutCore Records</a></dd>
<dd><a href='/fixtures.html'>Using Fixtures</a></dd><dt>Theming</dt>
<dd><a href='/chance.html'>Using Chance, SproutCore's CSS Framework</a></dd>
<dd><a href='/theming_app.html'>Theming Your App</a></dd></dl><dl class='R'><dt>Testing</dt>
<dd><a href='/adding_unit_test.html'>Adding a Unit Test</a></dd>
<dd><a href='/unit_test_framework.html'>Unit Testing</a></dd>
<dd><a href='/writing_unit_tests.html'>Writing Unit Tests</a></dd>
<dd><a href='/running_unit_tests.html'>Running Unit Tests</a></dd>
<dd><a href='/todos_tdd.html'>SproutCore Development Using TDD</a></dd><dt>Extras</dt>
<dd><a href='/build_tools.html'>SproutCore's Build Tools</a></dd>
<dd><a href='/run_loop.html'>The Run Loop</a></dd>
<dd><a href='/enumerables.html'>Enumerables</a></dd><dt>Contributing to SproutCore</dt>
<dd><a href='/style_guide.html'>Javascript Guidelines</a></dd>
<dd><a href='/commit_code.html'>Committer Guidelines</a></dd>
<dd><a href='/documentation_guidelines.html'>Documentation Guidelines</a></dd>
<dd><a href='/contribute.html'>Contributing Guides</a></dd><dt>Thanks</dt>
<dd><a href='/credits.html'>Credits</a></dd></dl>
</div>
</div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<div class='headerSection'>
<h2>Using Fixtures</h2>
<p>This guide covers the use of fixtures in your application. By referring to this guide, you will be able to:</p>
<ul>
<li>Understand the purpose of fixtures.</li>
<li>Write your own fixtures.</li>
<li>Set up relationships within fixtures.</li>
<li>Use the fixtures data source.</li>
</ul>
</div>
<h3 id='-The-Purpose-of-Fixtures-'>1 - The Purpose of Fixtures
</h3>
<p>Fixtures are a quick and easy way to preload your application with sample data
without having to write a custom data source. This is especially useful in the
early stages of development as it allows you to focus on the general structure
without having to be concerned with your application's backend.</p>
<h4 id='-How-Fixtures-Work-'>1.1 - How Fixtures Work
</h4>
<p>Fixtures are defined as an array of hashes with each hash containing the
attributes and values for each instance you wish to create.</p>
<p>A sample fixture looks something like:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>apps/app/fixtures/my_model.js</div></span>
App.MyModel.FIXTURES = [
{
guid: 1,
firstName: "Michael",
lastName: "Scott"
},
{
guid: 2,
firstName: "Dwight",
lastName: "Schrute"
}
];</code></div></pre>
<h4 id='-Defining-Fixtures-'>1.2 - Defining Fixtures
</h4>
<p>SproutCore looks for fixtures assigned specifically to a model (i.e. <tt>App.MyModel.FIXTURES</tt> on the above example). By convention, fixtures are defined
in the <tt>app/fixtures</tt> folder of your application (i.e. <tt>app/fixtures/my_model.js</tt>). By default fixtures are not included in production builds.</p>
<h3 id='-Writing-Your-Own-Fixtures-'>2 - Writing Your Own Fixtures
</h3>
<p>Writing fixtures is relatively straightforward. Each item representing a record gets its own hash in the format of <tt>propertyName: value</tt>. If your
model looks like:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>apps/app/models/article.js</div></span>
App.Article = SC.Record.extend({
title: SC.Record.attr(String),
body: SC.Record.attr(String)
});</code></div></pre>
<p>Your fixture will look like:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>apps/app/fixtures/article.js</div></span>
App.Article.FIXTURES = [
{
guid: 1,
title: "Writing a SproutCore app",
body: "Writing a SproutCore app is fun and exciting!"
},
{
guid: 2,
title: "Working with Fixtures",
body: "Using fixtures can make it easier to get your app started." }
];</code></div></pre>
<p>It is also possible to specify attributes that are not explicity defined in your model, though explicit declaration is encouraged.</p>
<div class='warning'><p> You must specify a value for the <tt>primaryKey</tt> in your fixtures.
</p></div>
<h4 id='-Defining-Relationships-'>2.1 - Defining Relationships
</h4>
<p>Since relationships are only specified with the foreign key it is quite easy to set them up in your fixtures. If you have model declaration, like the
following, where an employee belongs to a company and a company has many employees:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>apps/app/models/employee.js</div></span>
App.Employee = SC.Record.extend({
firstName: SC.Record.attr(String),
lastName: SC.Record.attr(String),
company: SC.Record.toOne("App.Company", {
inverse: "employees",
isMaster: NO
})
});
App.Company = SC.Record.extend({
name: SC.Record.attr(String),
employees: SC.Record.toMany("App.Employee", {
inverse: "company",
isMaster: YES
})
});</code></div></pre>
<p>You would set up your fixtures like:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>apps/app/fixtures/employee.js</div></span>
App.Employee.FIXTURES = [
{
guid: 1,
firstName: "John",
lastName: "Smith",
company: 1 // SomeCompany, Inc.
},
{
guid: 2,
firstName: "Sally",
lastName: "Washington",
company: 1 // SomeCompany, Inc.
},
{
guid: 3,
firstName: "Bernard",
lastName: "Peterson",
company: 2 // AnotherCompany, Inc.
}
];
App.Company.FIXTURES = [
{ guid: 1, name: "SomeComany, Inc.", employees: [1,2] },
{ guid: 2, name: "AnotherCompany, Inc.", employees: [3] }
];</code></div></pre>
<p>When the fixtures are loaded into your application the relationships automatically take over and point to the appropriate records.</p>
<div class='warning'><p> Unlike a traditional relational database it is necessary to specify both sides of the relationship.
</p></div>
<div class='info'><p> When defining the 'many' side of the fixture record, be certain to include the [ ] around a single value because SproutCore is expecting an array
of values.
</p></div>
<h4 id='-Defining-Non-String-Values-'>2.2 - Defining Non-String Values
</h4>
<p>The above examples have referred mostly to string values in the fixture. As most data is either passed into the application via
<a href="http://www.json.org">JSON</a> or <a href="http://www.w3.org/XML/">XML</a>, <tt>SC.Record</tt> is capable of transforming data from a string into the appropriate object
type. See <tt>SC.RecordAttribute.registerTransform</tt> for more information.</p>
<h3 id='-Hooking-Up-Your-Fixtures-'>3 - Hooking Up Your Fixtures
</h3>
<p>SproutCore comes with a built-in data source for your fixtures. To use the fixtures data source you merely need to set the following in your
application's <tt>core.js</tt>.</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>in apps/app/core.js</div></span>
App = SC.Application.create({
store: SC.Store.create().from(SC.Record.fixtures)
});</code></div></pre>
<p>You can extend the built-in fixture data source to simulate real world performance (important in managing user expectations).</p>
<pre class="highlighted"><div class="code_container"><code class="hljs bash">$ sc-gen data-source App.AppsFixturesDataSource SC.FixturesDataSource</code></div></pre>
<p>Delete the boilerplate code in the fixture data source so your code looks like:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>apps/app/data_sources/apps_fixtures.js</div></span>
App.AppsFixturesDataSource = SC.FixturesDataSource.extend({
simulateRemoteResponse: YES,
latency: 500 // 500 ms latency
});</code></div></pre>
<p>This simulates a remote response with 500 milliseconds round trip latency. Tweak the value to match the performance of your network and servers.</p>
<p>Next, point your store to the new fixtures data source.</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined"><span class='comment'><div class='filename'>in apps/app/core.js</div></span>
App = SC.Application.create({
store: SC.Store.create().from('App.AppsFixturesDataSource')
});</code></div></pre>
<div class='info'><p> Notice the quotes around the data source name? <tt>App.AppsFixturesDataSource</tt> doesn't exist until its instantiated during the loading process.
</p></div>
<p>And that's it! Your fixtures should now be available to your data store!</p>
<h3 id='-Changelog-'>4 - Changelog
</h3>
<ul>
<li>January 11, 2011: initial version by <a href="credits.html#wagenet">Peter Wagenet</a></li>
<li>March 2, 2011: added filenames and fixed code formatting by <a href="credits.html#topherfangio">Topher Fangio</a></li>
<li>July 17, 2011: minor changes by <a href="credits.html#westoque">William Estoque</a></li>
<li>October 23, 2013: converted to Markdown format for DocPad guides by <a href="credits.html#topherfangio">Topher Fangio</a></li>
<li>January 17, 2019: removed reference to sc-gen by <a href="credits.html#mauritslamers">Maurits Lamers</a></li>
</ul>
</div>
<!-- TODO: re-add index_items //-->
<div id="subCol">
<h3 class="chapter"><img src="images/graphics/chapters.png" alt="">Chapters</h3>
<ol class='chapters'>
<li>
<a href='#-The-Purpose-of-Fixtures-'><p> The Purpose of Fixtures
</p></a>
<ul>
<li><a href='#-How-Fixtures-Work-'><p> How Fixtures Work
</p></a></li>
<li><a href='#-Defining-Fixtures-'><p> Defining Fixtures
</p></a></li>
</ul>
</li>
<li>
<a href='#-Writing-Your-Own-Fixtures-'><p> Writing Your Own Fixtures
</p></a>
<ul>
<li><a href='#-Defining-Relationships-'><p> Defining Relationships
</p></a></li>
<li><a href='#-Defining-Non-String-Values-'><p> Defining Non-String Values
</p></a></li>
</ul>
</li>
<li>
<a href='#-Hooking-Up-Your-Fixtures-'><p> Hooking Up Your Fixtures
</p></a>
<ul>
</ul>
</li>
<li>
<a href='#-Changelog-'><p> Changelog
</p></a>
<ul>
</ul>
</li>
</ol>
</div>
</div>
</div>
<hr class="hide" />
<footer>
<div class="container">
<div class="col">
<a href="index.html"><img src="images/footer/sc_logo_medium.png" alt="SproutCore" /></a>
<p id="license">
SproutCore framework is under MIT License.
</p>
</div>
<nav class="col">
<h1>Site Navigation</h1>
<ul>
<li><a href="http://www.sproutcore.com/about/">About</a></li>
<li><a href="http://docs.sproutcore.com">Docs</a></li>
<li><a href="http://blog.sproutcore.com">Blog</a></li>
<li><a href="http://www.sproutcore.com/install/?redirect=1">Download</a></li>
<li><a href="http://www.sproutcore.com/community/">Community</a></li>
<li><a href="https://github.com/sproutcore/sproutcore">GitHub</a></li>
<li><a href="mailto:community@sproutcore.com">Contact Us</a></li>
<li><a href="http://guides.sproutcore.com">Guides</a></li>
</ul>
<a href="http://www.w3.org/html/logo/"><img src="images/footer/html5_tech.png" alt="HTML5 Powered" /></a>
</nav>
<div class="col">
<h1>Get in Touch, Stay Informed</h1>
<ul class="social">
<li><a href="http://twitter.com/sproutcore"><img src="images/footer/twitter.png" alt="Twitter" /></a></li>
<li><a href="http://www.facebook.com/sproutcore"><img src="images/footer/facebook.png" alt="Facebook" /></a></li>
<li><a href="http://groups.google.com/group/sproutcore"><img src="images/footer/google.png" alt="Google Groups" /></a></li>
<li><a href="http://groups.google.com/group/sproutcore">Subscribe To Mailing List</a></li>
</ul>
<a href="http://eepurl.com/dK1-Y" target="_blank" id="newsletter" class="button secondary">Sign Up For Our Newsletter!</a>
<!-- Commented out until we have mailchimp API integration.
<h2>Subscribe To Newsletter</h2>
<div id="subscribe">
<form>
<input type="text" name="email" />
<button name="subscribe">Sign-Up</button>
<div class="processing"><img src="/img/spinner.gif"></div>
<div class="error"></div>
</form>
</div>
-->
</div>
<a href="#feature" class="top">Back To Top</a>
</div>
</footer>
<script type='text/javascript' src='/javascripts/jquery.min.js'></script>
<script type='text/javascript'>
/*
* Make the guides link clickable
*/
function guideMenu(e){
if (document.getElementById('guides').style.display == "none") {
document.getElementById('guides').style.display = "block";
document.getElementById('guidesArrow').innerHTML = "▾";
$('body').click(function(e){ guideMenu(e); });
} else {
document.getElementById('guides').style.display = "none";
document.getElementById('guidesArrow').innerHTML = "▸";
$('body').unbind('click');
}
return false;
}
$('#guidesMenu, .guidesMenu').click(guideMenu);
</script>
</body>
</html>