mir 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. data/.gitignore +1 -0
  2. data/doc/Mir.html +353 -0
  3. data/doc/Mir/Application.html +1067 -0
  4. data/doc/Mir/Config.html +660 -0
  5. data/doc/Mir/Disk.html +211 -0
  6. data/doc/Mir/Disk/Amazon.html +1563 -0
  7. data/doc/Mir/Disk/IncompleteTransmission.html +116 -0
  8. data/doc/Mir/Disk/MultiPartFile.html +586 -0
  9. data/doc/Mir/Disk/RemoteFileNotFound.html +116 -0
  10. data/doc/Mir/Index.html +785 -0
  11. data/doc/Mir/Models.html +108 -0
  12. data/doc/Mir/Models/AppSetting.html +370 -0
  13. data/doc/Mir/Models/Resource.html +1140 -0
  14. data/doc/Mir/Options.html +297 -0
  15. data/doc/Mir/UndefinedConfigValue.html +116 -0
  16. data/doc/Mir/Utils.html +582 -0
  17. data/doc/_index.html +263 -0
  18. data/doc/class_list.html +47 -0
  19. data/doc/css/common.css +1 -0
  20. data/doc/css/full_list.css +53 -0
  21. data/doc/css/style.css +320 -0
  22. data/doc/file.README.html +134 -0
  23. data/doc/file_list.html +49 -0
  24. data/doc/frames.html +13 -0
  25. data/doc/index.html +134 -0
  26. data/doc/js/app.js +205 -0
  27. data/doc/js/full_list.js +150 -0
  28. data/doc/js/jquery.js +16 -0
  29. data/doc/method_list.html +590 -0
  30. data/doc/top-level-namespace.html +103 -0
  31. data/lib/mir/application.rb +92 -82
  32. data/lib/mir/config.rb +8 -6
  33. data/lib/mir/disk.rb +1 -0
  34. data/lib/mir/disk/amazon.rb +33 -8
  35. data/lib/mir/index.rb +24 -7
  36. data/lib/mir/logger.rb +5 -0
  37. data/lib/mir/models/resource.rb +5 -3
  38. data/lib/mir/utils.rb +9 -3
  39. data/lib/mir/version.rb +1 -1
  40. metadata +30 -1
data/doc/Mir/Disk/RemoteFileNotFound.html ADDED
@@ -0,0 +1,116 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Exception: Mir::Disk::RemoteFileNotFound
8
+
9
+ &mdash; Documentation by YARD 0.7.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '../..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../../_index.html">Index (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Mir.html" title="Mir (module)">Mir</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Disk.html" title="Mir::Disk (module)">Disk</a></span></span>
38
+ &raquo;
39
+ <span class="title">RemoteFileNotFound</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Exception: Mir::Disk::RemoteFileNotFound
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">StandardError</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">StandardError</li>
75
+
76
+ <li class="next">Mir::Disk::RemoteFileNotFound</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/mir/disk.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ </div>
108
+
109
+ <div id="footer">
110
+ Generated on Fri Sep 23 18:24:38 2011 by
111
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
+ 0.7.2 (ruby-1.9.2).
113
+ </div>
114
+
115
+ </body>
116
+ </html>
data/doc/Mir/Index.html ADDED
@@ -0,0 +1,785 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Mir::Index
8
+
9
+ &mdash; Documentation by YARD 0.7.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (I)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Mir.html" title="Mir (module)">Mir</a></span></span>
38
+ &raquo;
39
+ <span class="title">Index</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Mir::Index
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Mir::Index</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">lib/mir/index.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+
96
+ <h2>Constant Summary</h2>
97
+
98
+ <dl class="constants">
99
+
100
+ <dt id="MIGRATIONS_PATH-constant" class="">MIGRATIONS_PATH =
101
+
102
+ </dt>
103
+ <dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>..</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>..</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>db</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>migrate</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre></dd>
104
+
105
+ </dl>
106
+
107
+
108
+
109
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
110
+ <ul class="summary">
111
+
112
+ <li class="public ">
113
+ <span class="summary_signature">
114
+
115
+ <a href="#sync_path-instance_method" title="#sync_path (instance method)">- (Object) <strong>sync_path</strong> </a>
116
+
117
+
118
+
119
+ </span>
120
+
121
+
122
+ <span class="note title readonly">readonly</span>
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'><p>
132
+ Returns the value of attribute sync_path.
133
+ </p>
134
+ </div></span>
135
+
136
+ </li>
137
+
138
+
139
+ </ul>
140
+
141
+
142
+
143
+
144
+
145
+ <h2>
146
+ Instance Method Summary
147
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
148
+ </h2>
149
+
150
+ <ul class="summary">
151
+
152
+ <li class="public ">
153
+ <span class="summary_signature">
154
+
155
+ <a href="#clean%21-instance_method" title="#clean! (instance method)">- (void) <strong>clean!</strong> </a>
156
+
157
+
158
+
159
+ </span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+ <span class="summary_desc"><div class='inline'><p>
169
+ Removes any files from the index that are no longer present locally.
170
+ </p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ <li class="public ">
177
+ <span class="summary_signature">
178
+
179
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Mir::Index) <strong>initialize</strong>(sync_path, connection_params) </a>
180
+
181
+
182
+
183
+ </span>
184
+
185
+ <span class="note title constructor">constructor</span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+ <span class="summary_desc"><div class='inline'><p>
195
+ Returns a databse object used to connect to the indexing database.
196
+ </p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#last_indexed_at-instance_method" title="#last_indexed_at (instance method)">- (DateTime) <strong>last_indexed_at</strong> </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ <span class="summary_desc"><div class='inline'><p>
219
+ The date at whish the backup path was last indexed.
220
+ </p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#orphans-instance_method" title="#orphans (instance method)">- (Array, Mir::Models::Resource) <strong>orphans</strong> </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+ <span class="summary_desc"><div class='inline'><p>
243
+ Returns any files not present since the last re-indexing.
244
+ </p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#setup-instance_method" title="#setup (instance method)">- (void) <strong>setup</strong>(options = {}) </a>
254
+
255
+
256
+
257
+ </span>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ <span class="summary_desc"><div class='inline'><p>
267
+ Creates necessary database and tables if this is the first time connecting.
268
+ </p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#update-instance_method" title="#update (instance method)">- (void) <strong>update</strong> </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ <span class="summary_desc"><div class='inline'><p>
291
+ Scans the synchronization path and evaluates whether a resource has changed
292
+ since the last index or is new and needs to be added to the index.
293
+ </p>
294
+ </div></span>
295
+
296
+ </li>
297
+
298
+
299
+ </ul>
300
+
301
+
302
+ <div id="constructor_details" class="method_details_list">
303
+ <h2>Constructor Details</h2>
304
+
305
+ <div class="method_details first">
306
+ <p class="signature first" id="initialize-instance_method">
307
+
308
+ - (<tt><span class='object_link'><a href="" title="Mir::Index (class)">Mir::Index</a></span></tt>) <strong>initialize</strong>(sync_path, connection_params)
309
+
310
+
311
+
312
+ </p><div class="docstring">
313
+ <div class="discussion">
314
+ <p>
315
+ Returns a databse object used to connect to the indexing database
316
+ </p>
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+ <h3>Parameters:</h3>
323
+ <ul class="param">
324
+
325
+ <li>
326
+
327
+ <span class='name'>sync_path</span>
328
+
329
+
330
+ <span class='type'>(<tt>String</tt>)</span>
331
+
332
+
333
+
334
+ &mdash;
335
+ <div class='inline'><p>
336
+ the absolute path of the directory to be synchronized
337
+ </p>
338
+ </div>
339
+
340
+ </li>
341
+
342
+ <li>
343
+
344
+ <span class='name'>connection_params</span>
345
+
346
+
347
+ <span class='type'>(<tt>Hash</tt>)</span>
348
+
349
+
350
+
351
+ &mdash;
352
+ <div class='inline'><p>
353
+ database configuration settings. See
354
+ ActiveRecord#Base::establish_connection
355
+ </p>
356
+ </div>
357
+
358
+ </li>
359
+
360
+ </ul>
361
+
362
+ </div><table class="source_code">
363
+ <tr>
364
+ <td>
365
+ <pre class="lines">
366
+
367
+
368
+ 19
369
+ 20
370
+ 21
371
+ 22</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 19</span>
375
+
376
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id sync_path'>sync_path</span><span class='comma'>,</span> <span class='id connection_params'>connection_params</span><span class='rparen'>)</span>
377
+ <span class='ivar'>@sync_path</span> <span class='op'>=</span> <span class='id sync_path'>sync_path</span>
378
+ <span class='ivar'>@connection_params</span> <span class='op'>=</span> <span class='id connection_params'>connection_params</span>
379
+ <span class='kw'>end</span></pre>
380
+ </td>
381
+ </tr>
382
+ </table>
383
+ </div>
384
+
385
+ </div>
386
+
387
+ <div id="instance_attr_details" class="attr_details">
388
+ <h2>Instance Attribute Details</h2>
389
+
390
+
391
+ <span id=""></span>
392
+ <span id="sync_path-instance_method"></span>
393
+ <div class="method_details first">
394
+ <p class="signature first" id="sync_path-instance_method">
395
+
396
+ - (<tt>Object</tt>) <strong>sync_path</strong> <span class="extras">(readonly)</span>
397
+
398
+
399
+
400
+ </p><div class="docstring">
401
+ <div class="discussion">
402
+ <p>
403
+ Returns the value of attribute sync_path
404
+ </p>
405
+
406
+
407
+ </div>
408
+ </div>
409
+ <div class="tags">
410
+
411
+ </div><table class="source_code">
412
+ <tr>
413
+ <td>
414
+ <pre class="lines">
415
+
416
+
417
+ 24
418
+ 25
419
+ 26</pre>
420
+ </td>
421
+ <td>
422
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 24</span>
423
+
424
+ <span class='kw'>def</span> <span class='id sync_path'>sync_path</span>
425
+ <span class='ivar'>@sync_path</span>
426
+ <span class='kw'>end</span></pre>
427
+ </td>
428
+ </tr>
429
+ </table>
430
+ </div>
431
+
432
+ </div>
433
+
434
+
435
+ <div id="instance_method_details" class="method_details_list">
436
+ <h2>Instance Method Details</h2>
437
+
438
+
439
+ <div class="method_details first">
440
+ <p class="signature first" id="clean!-instance_method">
441
+
442
+ - (<tt>void</tt>) <strong>clean!</strong>
443
+
444
+
445
+
446
+ </p><div class="docstring">
447
+ <div class="discussion">
448
+ <p class="note returns_void">This method returns an undefined value.</p><p>
449
+ Removes any files from the index that are no longer present locally
450
+ </p>
451
+
452
+
453
+ </div>
454
+ </div>
455
+ <div class="tags">
456
+
457
+ </div><table class="source_code">
458
+ <tr>
459
+ <td>
460
+ <pre class="lines">
461
+
462
+
463
+ 92
464
+ 93
465
+ 94</pre>
466
+ </td>
467
+ <td>
468
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 92</span>
469
+
470
+ <span class='kw'>def</span> <span class='id clean!'>clean!</span>
471
+ <span class='const'>Models</span><span class='op'>::</span><span class='const'>Resource</span><span class='period'>.</span><span class='id delete_all_except'>delete_all_except</span><span class='lparen'>(</span><span class='id last_indexed_at'>last_indexed_at</span><span class='rparen'>)</span>
472
+ <span class='kw'>end</span></pre>
473
+ </td>
474
+ </tr>
475
+ </table>
476
+ </div>
477
+
478
+ <div class="method_details ">
479
+ <p class="signature " id="last_indexed_at-instance_method">
480
+
481
+ - (<tt>DateTime</tt>) <strong>last_indexed_at</strong>
482
+
483
+
484
+
485
+ </p><div class="docstring">
486
+ <div class="discussion">
487
+ <p>
488
+ The date at whish the backup path was last indexed
489
+ </p>
490
+
491
+
492
+ </div>
493
+ </div>
494
+ <div class="tags">
495
+ <h3>Returns:</h3>
496
+ <ul class="return">
497
+
498
+ <li>
499
+
500
+
501
+ <span class='type'>(<tt>DateTime</tt>)</span>
502
+
503
+
504
+
505
+ </li>
506
+
507
+ </ul>
508
+
509
+ </div><table class="source_code">
510
+ <tr>
511
+ <td>
512
+ <pre class="lines">
513
+
514
+
515
+ 84
516
+ 85
517
+ 86</pre>
518
+ </td>
519
+ <td>
520
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 84</span>
521
+
522
+ <span class='kw'>def</span> <span class='id last_indexed_at'>last_indexed_at</span>
523
+ <span class='ivar'>@last_indexed_at</span> <span class='op'>||=</span> <span class='const'>Models</span><span class='op'>::</span><span class='const'>AppSetting</span><span class='period'>.</span><span class='id last_indexed_at'>last_indexed_at</span>
524
+ <span class='kw'>end</span></pre>
525
+ </td>
526
+ </tr>
527
+ </table>
528
+ </div>
529
+
530
+ <div class="method_details ">
531
+ <p class="signature " id="orphans-instance_method">
532
+
533
+ - (<tt>Array</tt>, <tt><span class='object_link'><a href="Models/Resource.html" title="Mir::Models::Resource (class)">Mir::Models::Resource</a></span></tt>) <strong>orphans</strong>
534
+
535
+
536
+
537
+ </p><div class="docstring">
538
+ <div class="discussion">
539
+ <p>
540
+ Returns any files not present since the last re-indexing. This is useful
541
+ for finding files that have been deleted post-index.
542
+ </p>
543
+
544
+
545
+ </div>
546
+ </div>
547
+ <div class="tags">
548
+ <h3>Returns:</h3>
549
+ <ul class="return">
550
+
551
+ <li>
552
+
553
+
554
+ <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="Models/Resource.html" title="Mir::Models::Resource (class)">Mir::Models::Resource</a></span></tt>)</span>
555
+
556
+
557
+
558
+ </li>
559
+
560
+ </ul>
561
+
562
+ </div><table class="source_code">
563
+ <tr>
564
+ <td>
565
+ <pre class="lines">
566
+
567
+
568
+ 77
569
+ 78
570
+ 79</pre>
571
+ </td>
572
+ <td>
573
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 77</span>
574
+
575
+ <span class='kw'>def</span> <span class='id orphans'>orphans</span>
576
+ <span class='const'>Models</span><span class='op'>::</span><span class='const'>Resource</span><span class='period'>.</span><span class='id not_indexed_on'>not_indexed_on</span><span class='lparen'>(</span><span class='id last_indexed_at'>last_indexed_at</span><span class='rparen'>)</span>
577
+ <span class='kw'>end</span></pre>
578
+ </td>
579
+ </tr>
580
+ </table>
581
+ </div>
582
+
583
+ <div class="method_details ">
584
+ <p class="signature " id="setup-instance_method">
585
+
586
+ - (<tt>void</tt>) <strong>setup</strong>(options = {})
587
+
588
+
589
+
590
+ </p><div class="docstring">
591
+ <div class="discussion">
592
+ <p class="note returns_void">This method returns an undefined value.</p><p>
593
+ Creates necessary database and tables if this is the first time connecting
594
+ </p>
595
+
596
+
597
+ </div>
598
+ </div>
599
+ <div class="tags">
600
+ <h3>Parameters:</h3>
601
+ <ul class="param">
602
+
603
+ <li>
604
+
605
+ <span class='name'>options</span>
606
+
607
+
608
+ <span class='type'>(<tt>Hash</tt>)</span>
609
+
610
+
611
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
612
+
613
+
614
+ &mdash;
615
+ <div class='inline'><p>
616
+ a customizable set of options
617
+ </p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+
624
+
625
+
626
+
627
+ <h3>Options Hash (<tt>options</tt>):</h3>
628
+ <ul class="option">
629
+
630
+ <li>
631
+ <span class="name">:verbose</span>
632
+ <span class="type">(<tt>Boolean</tt>)</span>
633
+ <span class="default">
634
+
635
+ </span>
636
+ &mdash; <div class='inline'><p>
637
+ Enable on ActiveRecord reporting
638
+ </p>
639
+ </div>
640
+ </tr>
641
+
642
+ <li>
643
+ <span class="name">:force_flush</span>
644
+ <span class="type">(<tt>Boolean</tt>)</span>
645
+ <span class="default">
646
+
647
+ </span>
648
+ &mdash; <div class='inline'><p>
649
+ Rebuild index no matter what
650
+ </p>
651
+ </div>
652
+ </tr>
653
+
654
+ </ul>
655
+
656
+
657
+ </div><table class="source_code">
658
+ <tr>
659
+ <td>
660
+ <pre class="lines">
661
+
662
+
663
+ 32
664
+ 33
665
+ 34
666
+ 35
667
+ 36
668
+ 37
669
+ 38
670
+ 39
671
+ 40
672
+ 41
673
+ 42
674
+ 43
675
+ 44
676
+ 45</pre>
677
+ </td>
678
+ <td>
679
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 32</span>
680
+
681
+ <span class='kw'>def</span> <span class='id setup'>setup</span><span class='lparen'>(</span><span class='id options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
682
+ <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_flush</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
683
+ <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
684
+ <span class='ivar'>@connection</span> <span class='op'>=</span> <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id establish_connection'>establish_connection</span><span class='lparen'>(</span><span class='ivar'>@connection_params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id connection'>connection</span>
685
+ <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id timestamped_migrations'>timestamped_migrations</span> <span class='op'>=</span> <span class='kw'>false</span>
686
+
687
+ <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span>
688
+ <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id logger'>logger</span> <span class='op'>=</span> <span class='const'>Mir</span><span class='period'>.</span><span class='id logger'>logger</span>
689
+ <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Migration</span><span class='period'>.</span><span class='id verbose'>verbose</span> <span class='op'>=</span> <span class='kw'>true</span>
690
+ <span class='kw'>end</span>
691
+
692
+ <span class='id load_tables'>load_tables</span>
693
+ <span class='id rebuild'>rebuild</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id tables_created?'>tables_created?</span> <span class='kw'>or</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_flush</span><span class='rbracket'>]</span>
694
+ <span class='kw'>end</span></pre>
695
+ </td>
696
+ </tr>
697
+ </table>
698
+ </div>
699
+
700
+ <div class="method_details ">
701
+ <p class="signature " id="update-instance_method">
702
+
703
+ - (<tt>void</tt>) <strong>update</strong>
704
+
705
+
706
+
707
+ </p><div class="docstring">
708
+ <div class="discussion">
709
+ <p class="note returns_void">This method returns an undefined value.</p><p>
710
+ Scans the synchronization path and evaluates whether a resource has changed
711
+ since the last index or is new and needs to be added to the index.
712
+ </p>
713
+
714
+
715
+ </div>
716
+ </div>
717
+ <div class="tags">
718
+
719
+ </div><table class="source_code">
720
+ <tr>
721
+ <td>
722
+ <pre class="lines">
723
+
724
+
725
+ 51
726
+ 52
727
+ 53
728
+ 54
729
+ 55
730
+ 56
731
+ 57
732
+ 58
733
+ 59
734
+ 60
735
+ 61
736
+ 62
737
+ 63
738
+ 64
739
+ 65
740
+ 66
741
+ 67
742
+ 68
743
+ 69
744
+ 70</pre>
745
+ </td>
746
+ <td>
747
+ <pre class="code"><span class="info file"># File 'lib/mir/index.rb', line 51</span>
748
+
749
+ <span class='kw'>def</span> <span class='id update'>update</span>
750
+ <span class='const'>Mir</span><span class='period'>.</span><span class='id logger'>logger</span><span class='period'>.</span><span class='id info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Updating backup index for '</span><span class='embexpr_beg'>#{</span><span class='id sync_path'>sync_path</span><span class='rbrace'>}</span><span class='tstring_content'>'</span><span class='tstring_end'>&quot;</span></span>
751
+ <span class='const'>Models</span><span class='op'>::</span><span class='const'>AppSetting</span><span class='period'>.</span><span class='id last_indexed_at'>last_indexed_at</span> <span class='op'>=</span> <span class='ivar'>@last_indexed_at</span> <span class='op'>=</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id now'>now</span>
752
+
753
+ <span class='const'>Dir</span><span class='period'>.</span><span class='id glob'>glob</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='id sync_path'>sync_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>**</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id f'>f</span><span class='op'>|</span>
754
+ <span class='id fname'>fname</span> <span class='op'>=</span> <span class='id relative_path'>relative_path</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span>
755
+ <span class='id file'>file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span>
756
+ <span class='id resource'>resource</span> <span class='op'>=</span> <span class='const'>Models</span><span class='op'>::</span><span class='const'>Resource</span><span class='period'>.</span><span class='id find_by_filename'>find_by_filename</span><span class='lparen'>(</span><span class='id fname'>fname</span><span class='rparen'>)</span>
757
+
758
+ <span class='kw'>if</span> <span class='id resource'>resource</span><span class='period'>.</span><span class='id nil?'>nil?</span>
759
+ <span class='const'>Mir</span><span class='period'>.</span><span class='id logger'>logger</span><span class='period'>.</span><span class='id debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Adding file to index </span><span class='embexpr_beg'>#{</span><span class='id fname'>fname</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
760
+ <span class='id resource'>resource</span> <span class='op'>=</span> <span class='const'>Models</span><span class='op'>::</span><span class='const'>Resource</span><span class='period'>.</span><span class='id create_from_file_and_name'>create_from_file_and_name</span><span class='lparen'>(</span><span class='id file'>file</span><span class='comma'>,</span> <span class='id fname'>fname</span><span class='rparen'>)</span>
761
+ <span class='kw'>elsif</span> <span class='op'>!</span><span class='id resource'>resource</span><span class='period'>.</span><span class='id synchronized?'>synchronized?</span><span class='lparen'>(</span><span class='id file'>file</span><span class='rparen'>)</span>
762
+ <span class='id resource'>resource</span><span class='period'>.</span><span class='id flag_for_update'>flag_for_update</span>
763
+ <span class='kw'>end</span>
764
+ <span class='id resource'>resource</span><span class='period'>.</span><span class='id update_attribute'>update_attribute</span><span class='lparen'>(</span><span class='symbol'>:last_indexed_at</span><span class='comma'>,</span> <span class='id last_indexed_at'>last_indexed_at</span><span class='rparen'>)</span>
765
+ <span class='kw'>end</span>
766
+
767
+ <span class='const'>Mir</span><span class='period'>.</span><span class='id logger'>logger</span><span class='period'>.</span><span class='id info'>info</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Index updated</span><span class='tstring_end'>&quot;</span></span>
768
+ <span class='kw'>end</span></pre>
769
+ </td>
770
+ </tr>
771
+ </table>
772
+ </div>
773
+
774
+ </div>
775
+
776
+ </div>
777
+
778
+ <div id="footer">
779
+ Generated on Fri Sep 23 18:24:38 2011 by
780
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
781
+ 0.7.2 (ruby-1.9.2).
782
+ </div>
783
+
784
+ </body>
785
+ </html>