mattock 0.2.5 → 0.2.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. data/doc/Specifications +0 -37
  2. data/lib/mattock/cascading-definition.rb +36 -0
  3. data/lib/mattock/configurable.rb +46 -5
  4. data/lib/mattock/tasklib.rb +47 -1
  5. data/lib/mattock/yard_extensions.rb +10 -0
  6. metadata +3 -213
  7. data/doc/FileSandbox.html +0 -537
  8. data/doc/FileSandbox/HaveContents.html +0 -279
  9. data/doc/FileSandbox/Sandbox.html +0 -525
  10. data/doc/FileSandbox/SandboxFile.html +0 -622
  11. data/doc/Mattock.html +0 -137
  12. data/doc/Mattock/CascadingDefinition.html +0 -459
  13. data/doc/Mattock/CommandChain.html +0 -456
  14. data/doc/Mattock/CommandLine.html +0 -1312
  15. data/doc/Mattock/CommandLineExampleGroup.html +0 -282
  16. data/doc/Mattock/CommandLineExampleGroup/Matchers.html +0 -109
  17. data/doc/Mattock/CommandRunResult.html +0 -643
  18. data/doc/Mattock/CommandTask.html +0 -464
  19. data/doc/Mattock/Configurable.html +0 -609
  20. data/doc/Mattock/Configurable/ClassMethods.html +0 -754
  21. data/doc/Mattock/Configurable/Struct.html +0 -148
  22. data/doc/Mattock/FileCreationTask.html +0 -177
  23. data/doc/Mattock/FileTask.html +0 -177
  24. data/doc/Mattock/MockCommandResult.html +0 -445
  25. data/doc/Mattock/MultiTask.html +0 -177
  26. data/doc/Mattock/PipelineChain.html +0 -221
  27. data/doc/Mattock/PrereqChain.html +0 -221
  28. data/doc/Mattock/RakeExampleGroup.html +0 -292
  29. data/doc/Mattock/RakeExampleGroup/Matchers.html +0 -109
  30. data/doc/Mattock/RakeExampleGroup/TaskManager.html +0 -131
  31. data/doc/Mattock/RemoteCommandTask.html +0 -423
  32. data/doc/Mattock/ShellEscaped.html +0 -315
  33. data/doc/Mattock/Task.html +0 -181
  34. data/doc/Mattock/TaskLib.html +0 -755
  35. data/doc/Mattock/TaskMixin.html +0 -668
  36. data/doc/Mattock/TaskMixin/ClassMethods.html +0 -166
  37. data/doc/Mattock/TemplateHost.html +0 -320
  38. data/doc/Mattock/ValiseManager.html +0 -257
  39. data/doc/Mattock/WrappingChain.html +0 -221
  40. data/doc/Mattock/YARDExtensions.html +0 -110
  41. data/doc/Mattock/YARDExtensions/DefineHandler.html +0 -253
  42. data/doc/Mattock/YARDExtensions/NilFieldsHandler.html +0 -258
  43. data/doc/Mattock/YARDExtensions/RequiredFieldsHandler.html +0 -205
  44. data/doc/Mattock/YARDExtensions/SettingHandler.html +0 -529
  45. data/doc/Mattock/YARDExtensions/SettingsHandler.html +0 -207
  46. data/doc/RSpecTest.html +0 -233
  47. data/doc/Ungemmer.html +0 -282
  48. data/doc/_index.html +0 -435
  49. data/doc/class_list.html +0 -47
  50. data/doc/coverage/assets/0.5.3/app.js +0 -88
  51. data/doc/coverage/assets/0.5.3/fancybox/blank.gif +0 -0
  52. data/doc/coverage/assets/0.5.3/fancybox/fancy_close.png +0 -0
  53. data/doc/coverage/assets/0.5.3/fancybox/fancy_loading.png +0 -0
  54. data/doc/coverage/assets/0.5.3/fancybox/fancy_nav_left.png +0 -0
  55. data/doc/coverage/assets/0.5.3/fancybox/fancy_nav_right.png +0 -0
  56. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_e.png +0 -0
  57. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_n.png +0 -0
  58. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png +0 -0
  59. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png +0 -0
  60. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_s.png +0 -0
  61. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_se.png +0 -0
  62. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png +0 -0
  63. data/doc/coverage/assets/0.5.3/fancybox/fancy_shadow_w.png +0 -0
  64. data/doc/coverage/assets/0.5.3/fancybox/fancy_title_left.png +0 -0
  65. data/doc/coverage/assets/0.5.3/fancybox/fancy_title_main.png +0 -0
  66. data/doc/coverage/assets/0.5.3/fancybox/fancy_title_over.png +0 -0
  67. data/doc/coverage/assets/0.5.3/fancybox/fancy_title_right.png +0 -0
  68. data/doc/coverage/assets/0.5.3/fancybox/fancybox-x.png +0 -0
  69. data/doc/coverage/assets/0.5.3/fancybox/fancybox-y.png +0 -0
  70. data/doc/coverage/assets/0.5.3/fancybox/fancybox.png +0 -0
  71. data/doc/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css +0 -363
  72. data/doc/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js +0 -44
  73. data/doc/coverage/assets/0.5.3/favicon_green.png +0 -0
  74. data/doc/coverage/assets/0.5.3/favicon_red.png +0 -0
  75. data/doc/coverage/assets/0.5.3/favicon_yellow.png +0 -0
  76. data/doc/coverage/assets/0.5.3/highlight.css +0 -129
  77. data/doc/coverage/assets/0.5.3/highlight.pack.js +0 -1
  78. data/doc/coverage/assets/0.5.3/jquery-1.6.2.min.js +0 -18
  79. data/doc/coverage/assets/0.5.3/jquery.dataTables.min.js +0 -152
  80. data/doc/coverage/assets/0.5.3/jquery.timeago.js +0 -141
  81. data/doc/coverage/assets/0.5.3/jquery.url.js +0 -174
  82. data/doc/coverage/assets/0.5.3/loading.gif +0 -0
  83. data/doc/coverage/assets/0.5.3/magnify.png +0 -0
  84. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
  85. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
  86. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
  87. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
  88. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
  89. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
  90. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
  91. data/doc/coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
  92. data/doc/coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png +0 -0
  93. data/doc/coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
  94. data/doc/coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png +0 -0
  95. data/doc/coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png +0 -0
  96. data/doc/coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
  97. data/doc/coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css +0 -295
  98. data/doc/coverage/assets/0.5.3/stylesheet.css +0 -383
  99. data/doc/coverage/index.html +0 -5169
  100. data/doc/css/common.css +0 -1
  101. data/doc/css/full_list.css +0 -55
  102. data/doc/css/style.css +0 -322
  103. data/doc/file.README.html +0 -107
  104. data/doc/file_list.html +0 -49
  105. data/doc/frames.html +0 -13
  106. data/doc/index.html +0 -107
  107. data/doc/js/app.js +0 -205
  108. data/doc/js/full_list.js +0 -173
  109. data/doc/js/jquery.js +0 -16
  110. data/doc/method_list.html +0 -950
  111. data/doc/top-level-namespace.html +0 -107
@@ -1,609 +0,0 @@
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
- Module: Mattock::Configurable
8
-
9
- &mdash; Documentation by YARD 0.7.5
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 (C)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../Mattock.html" title="Mattock (module)">Mattock</a></span></span>
38
- &raquo;
39
- <span class="title">Configurable</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>Module: Mattock::Configurable
60
-
61
-
62
-
63
- </h1>
64
-
65
- <dl class="box">
66
-
67
-
68
-
69
- <dt class="r1">Extended by:</dt>
70
- <dd class="r1"><span class='object_link'><a href="Configurable/ClassMethods.html" title="Mattock::Configurable::ClassMethods (module)">ClassMethods</a></span></dd>
71
-
72
-
73
-
74
-
75
-
76
-
77
- <dt class="r2">Included in:</dt>
78
- <dd class="r2"><span class='object_link'><a href="CascadingDefinition.html" title="Mattock::CascadingDefinition (module)">CascadingDefinition</a></span>, <span class='object_link'><a href="Configurable/Struct.html" title="Mattock::Configurable::Struct (class)">Struct</a></span></dd>
79
-
80
-
81
-
82
- <dt class="r1 last">Defined in:</dt>
83
- <dd class="r1 last">lib/mattock/configurable.rb</dd>
84
-
85
- </dl>
86
- <div class="clear"></div>
87
-
88
-
89
- <h2>Defined Under Namespace</h2>
90
- <p class="children">
91
-
92
-
93
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="Configurable/ClassMethods.html" title="Mattock::Configurable::ClassMethods (module)">ClassMethods</a></span>
94
-
95
-
96
-
97
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="Configurable/Struct.html" title="Mattock::Configurable::Struct (class)">Struct</a></span>
98
-
99
-
100
- </p>
101
-
102
- <h2>Constant Summary</h2>
103
-
104
- <dl class="constants">
105
-
106
- <dt id="RequiredField-constant" class="">RequiredField =
107
-
108
- </dt>
109
- <dd><pre class="code"><span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></pre></dd>
110
-
111
- </dl>
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
- <h2>
123
- Instance Method Summary
124
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
125
- </h2>
126
-
127
- <ul class="summary">
128
-
129
- <li class="public ">
130
- <span class="summary_signature">
131
-
132
- <a href="#check_required-instance_method" title="#check_required (instance method)">- (Object) <strong>check_required</strong> </a>
133
-
134
-
135
-
136
- </span>
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
- <span class="summary_desc"><div class='inline'></div></span>
146
-
147
- </li>
148
-
149
-
150
- <li class="public ">
151
- <span class="summary_signature">
152
-
153
- <a href="#copy_settings_to-instance_method" title="#copy_settings_to (instance method)">- (Object) <strong>copy_settings_to</strong>(other) </a>
154
-
155
-
156
-
157
- </span>
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
- <span class="summary_desc"><div class='inline'></div></span>
167
-
168
- </li>
169
-
170
-
171
- <li class="public ">
172
- <span class="summary_signature">
173
-
174
- <a href="#nil_fields-instance_method" title="#nil_fields (instance method)">- (Object) <strong>nil_fields</strong>(*names) </a>
175
-
176
-
177
-
178
- (also: #nil_field)
179
-
180
- </span>
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
- <span class="summary_desc"><div class='inline'></div></span>
190
-
191
- </li>
192
-
193
-
194
- <li class="public ">
195
- <span class="summary_signature">
196
-
197
- <a href="#required_fields-instance_method" title="#required_fields (instance method)">- (Object) <strong>required_fields</strong>(*names) </a>
198
-
199
-
200
-
201
- (also: #required_field)
202
-
203
- </span>
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
- <span class="summary_desc"><div class='inline'></div></span>
213
-
214
- </li>
215
-
216
-
217
- <li class="public ">
218
- <span class="summary_signature">
219
-
220
- <a href="#setting-instance_method" title="#setting (instance method)">- (Object) <strong>setting</strong>(name, default_value = nil) </a>
221
-
222
-
223
-
224
- </span>
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
- <span class="summary_desc"><div class='inline'></div></span>
234
-
235
- </li>
236
-
237
-
238
- <li class="public ">
239
- <span class="summary_signature">
240
-
241
- <a href="#settings-instance_method" title="#settings (instance method)">- (Object) <strong>settings</strong>(hash) </a>
242
-
243
-
244
-
245
- </span>
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
- <span class="summary_desc"><div class='inline'></div></span>
255
-
256
- </li>
257
-
258
-
259
- <li class="public ">
260
- <span class="summary_signature">
261
-
262
- <a href="#setup_defaults-instance_method" title="#setup_defaults (instance method)">- (Object) <strong>setup_defaults</strong> </a>
263
-
264
-
265
-
266
- </span>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
- <span class="summary_desc"><div class='inline'></div></span>
276
-
277
- </li>
278
-
279
-
280
- <li class="public ">
281
- <span class="summary_signature">
282
-
283
- <a href="#unset%3F-instance_method" title="#unset? (instance method)">- (Boolean) <strong>unset?</strong>(value) </a>
284
-
285
-
286
-
287
- </span>
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
- <span class="summary_desc"><div class='inline'></div></span>
297
-
298
- </li>
299
-
300
-
301
- </ul>
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Configurable/ClassMethods.html" title="Mattock::Configurable::ClassMethods (module)">ClassMethods</a></span></h3>
313
- <p class="inherited"><span class='object_link'><a href="Configurable/ClassMethods.html#copy_settings-instance_method" title="Mattock::Configurable::ClassMethods#copy_settings (method)">copy_settings</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#default_values-instance_method" title="Mattock::Configurable::ClassMethods#default_values (method)">default_values</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#included-instance_method" title="Mattock::Configurable::ClassMethods#included (method)">included</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#missing_required_fields_on-instance_method" title="Mattock::Configurable::ClassMethods#missing_required_fields_on (method)">missing_required_fields_on</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#nested-instance_method" title="Mattock::Configurable::ClassMethods#nested (method)">nested</a></span>, <span class='object_link'><a href="Configurable/ClassMethods.html#set_defaults_on-instance_method" title="Mattock::Configurable::ClassMethods#set_defaults_on (method)">set_defaults_on</a></span></p>
314
-
315
-
316
- <div id="instance_method_details" class="method_details_list">
317
- <h2>Instance Method Details</h2>
318
-
319
-
320
- <div class="method_details first">
321
- <p class="signature first" id="check_required-instance_method">
322
-
323
- - (<tt>Object</tt>) <strong>check_required</strong>
324
-
325
-
326
-
327
- </p><table class="source_code">
328
- <tr>
329
- <td>
330
- <pre class="lines">
331
-
332
-
333
- 122
334
- 123
335
- 124
336
- 125
337
- 126
338
- 127
339
- 128</pre>
340
- </td>
341
- <td>
342
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 122</span>
343
-
344
- <span class='kw'>def</span> <span class='id identifier rubyid_check_required'>check_required</span>
345
- <span class='id identifier rubyid_missing'>missing</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_missing_required_fields_on'>missing_required_fields_on</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
346
- <span class='kw'>unless</span> <span class='id identifier rubyid_missing'>missing</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
347
- <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Required field</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_missing'>missing</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>1</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_missing'>missing</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='op'>|</span> <span class='id identifier rubyid_field'>field</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</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='rbrace'>}</span><span class='tstring_content'> unset on </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
348
- <span class='kw'>end</span>
349
- <span class='kw'>self</span>
350
- <span class='kw'>end</span></pre>
351
- </td>
352
- </tr>
353
- </table>
354
- </div>
355
-
356
- <div class="method_details ">
357
- <p class="signature " id="copy_settings_to-instance_method">
358
-
359
- - (<tt>Object</tt>) <strong>copy_settings_to</strong>(other)
360
-
361
-
362
-
363
- </p><table class="source_code">
364
- <tr>
365
- <td>
366
- <pre class="lines">
367
-
368
-
369
- 112
370
- 113
371
- 114
372
- 115</pre>
373
- </td>
374
- <td>
375
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 112</span>
376
-
377
- <span class='kw'>def</span> <span class='id identifier rubyid_copy_settings_to'>copy_settings_to</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
378
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_copy_settings'>copy_settings</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
379
- <span class='kw'>self</span>
380
- <span class='kw'>end</span></pre>
381
- </td>
382
- </tr>
383
- </table>
384
- </div>
385
-
386
- <div class="method_details ">
387
- <p class="signature " id="nil_fields-instance_method">
388
-
389
- - (<tt>Object</tt>) <strong>nil_fields</strong>(*names)
390
-
391
-
392
-
393
- <span class="aliases">Also known as:
394
- <span class="names"><span id='nil_field-instance_method'>nil_field</span></span>
395
- </span>
396
-
397
- </p><table class="source_code">
398
- <tr>
399
- <td>
400
- <pre class="lines">
401
-
402
-
403
- 152
404
- 153
405
- 154
406
- 155</pre>
407
- </td>
408
- <td>
409
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 152</span>
410
-
411
- <span class='kw'>def</span> <span class='id identifier rubyid_nil_fields'>nil_fields</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_names'>names</span><span class='rparen'>)</span>
412
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_nil_fields'>nil_fields</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_names'>names</span><span class='rparen'>)</span>
413
- <span class='kw'>self</span>
414
- <span class='kw'>end</span></pre>
415
- </td>
416
- </tr>
417
- </table>
418
- </div>
419
-
420
- <div class="method_details ">
421
- <p class="signature " id="required_fields-instance_method">
422
-
423
- - (<tt>Object</tt>) <strong>required_fields</strong>(*names)
424
-
425
-
426
-
427
- <span class="aliases">Also known as:
428
- <span class="names"><span id='required_field-instance_method'>required_field</span></span>
429
- </span>
430
-
431
- </p><table class="source_code">
432
- <tr>
433
- <td>
434
- <pre class="lines">
435
-
436
-
437
- 146
438
- 147
439
- 148
440
- 149</pre>
441
- </td>
442
- <td>
443
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 146</span>
444
-
445
- <span class='kw'>def</span> <span class='id identifier rubyid_required_fields'>required_fields</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_names'>names</span><span class='rparen'>)</span>
446
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_required_fields'>required_fields</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_names'>names</span><span class='rparen'>)</span>
447
- <span class='kw'>self</span>
448
- <span class='kw'>end</span></pre>
449
- </td>
450
- </tr>
451
- </table>
452
- </div>
453
-
454
- <div class="method_details ">
455
- <p class="signature " id="setting-instance_method">
456
-
457
- - (<tt>Object</tt>) <strong>setting</strong>(name, default_value = nil)
458
-
459
-
460
-
461
- </p><table class="source_code">
462
- <tr>
463
- <td>
464
- <pre class="lines">
465
-
466
-
467
- 134
468
- 135
469
- 136
470
- 137</pre>
471
- </td>
472
- <td>
473
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 134</span>
474
-
475
- <span class='kw'>def</span> <span class='id identifier rubyid_setting'>setting</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_default_value'>default_value</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
476
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_setting'>setting</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_default_value'>default_value</span><span class='rparen'>)</span>
477
- <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_default_value'>default_value</span><span class='rparen'>)</span>
478
- <span class='kw'>end</span></pre>
479
- </td>
480
- </tr>
481
- </table>
482
- </div>
483
-
484
- <div class="method_details ">
485
- <p class="signature " id="settings-instance_method">
486
-
487
- - (<tt>Object</tt>) <strong>settings</strong>(hash)
488
-
489
-
490
-
491
- </p><table class="source_code">
492
- <tr>
493
- <td>
494
- <pre class="lines">
495
-
496
-
497
- 139
498
- 140
499
- 141
500
- 142
501
- 143
502
- 144</pre>
503
- </td>
504
- <td>
505
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 139</span>
506
-
507
- <span class='kw'>def</span> <span class='id identifier rubyid_settings'>settings</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
508
- <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
509
- <span class='id identifier rubyid_setting'>setting</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
510
- <span class='kw'>end</span>
511
- <span class='kw'>return</span> <span class='kw'>self</span>
512
- <span class='kw'>end</span></pre>
513
- </td>
514
- </tr>
515
- </table>
516
- </div>
517
-
518
- <div class="method_details ">
519
- <p class="signature " id="setup_defaults-instance_method">
520
-
521
- - (<tt>Object</tt>) <strong>setup_defaults</strong>
522
-
523
-
524
-
525
- </p><table class="source_code">
526
- <tr>
527
- <td>
528
- <pre class="lines">
529
-
530
-
531
- 117
532
- 118
533
- 119
534
- 120</pre>
535
- </td>
536
- <td>
537
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 117</span>
538
-
539
- <span class='kw'>def</span> <span class='id identifier rubyid_setup_defaults'>setup_defaults</span>
540
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_set_defaults_on'>set_defaults_on</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
541
- <span class='kw'>self</span>
542
- <span class='kw'>end</span></pre>
543
- </td>
544
- </tr>
545
- </table>
546
- </div>
547
-
548
- <div class="method_details ">
549
- <p class="signature " id="unset?-instance_method">
550
-
551
- - (<tt>Boolean</tt>) <strong>unset?</strong>(value)
552
-
553
-
554
-
555
- </p><div class="docstring">
556
- <div class="discussion">
557
-
558
-
559
- </div>
560
- </div>
561
- <div class="tags">
562
-
563
- <h3>Returns:</h3>
564
- <ul class="return">
565
-
566
- <li>
567
-
568
-
569
- <span class='type'>(<tt>Boolean</tt>)</span>
570
-
571
-
572
-
573
- </li>
574
-
575
- </ul>
576
-
577
- </div><table class="source_code">
578
- <tr>
579
- <td>
580
- <pre class="lines">
581
-
582
-
583
- 130
584
- 131
585
- 132</pre>
586
- </td>
587
- <td>
588
- <pre class="code"><span class="info file"># File 'lib/mattock/configurable.rb', line 130</span>
589
-
590
- <span class='kw'>def</span> <span class='id identifier rubyid_unset?'>unset?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
591
- <span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='const'>RequiredField</span>
592
- <span class='kw'>end</span></pre>
593
- </td>
594
- </tr>
595
- </table>
596
- </div>
597
-
598
- </div>
599
-
600
- </div>
601
-
602
- <div id="footer">
603
- Generated on Tue Mar 6 02:47:28 2012 by
604
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
605
- 0.7.5 (ruby-1.9.2).
606
- </div>
607
-
608
- </body>
609
- </html>