sprout 1.0.35.pre → 1.1.2.pre

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of sprout might be problematic. Click here for more details.

Files changed (234) hide show
  1. data/Gemfile +1 -1
  2. data/Gemfile.lock +0 -2
  3. data/README.textile +1 -1
  4. data/VERSION +1 -1
  5. data/lib/sprout/concern.rb +5 -7
  6. data/lib/sprout/daemon.rb +183 -143
  7. data/lib/sprout/executable/base.rb +564 -0
  8. data/lib/sprout/executable.rb +1 -550
  9. data/lib/sprout/generator/base.rb +2 -3
  10. data/lib/sprout/generator.rb +2 -1
  11. data/lib/sprout/generators/ruby/templates/ruby_base.rb +1 -2
  12. data/lib/sprout/library.rb +3 -3
  13. data/lib/sprout/output_buffer.rb +35 -0
  14. data/lib/sprout/process_runner.rb +68 -17
  15. data/lib/sprout/progress_bar.rb +5 -5
  16. data/lib/sprout/remote_file_target.rb +1 -1
  17. data/lib/sprout/system/base_system.rb +3 -3
  18. data/lib/sprout/system/unix_system.rb +1 -1
  19. data/lib/sprout/{test/sprout_test_case.rb → test_helper.rb} +214 -14
  20. data/lib/sprout/version.rb +1 -1
  21. data/lib/sprout.rb +133 -2
  22. data/rakefile.rb +2 -0
  23. data/test/fixtures/examples/echo_inputs.rb +1 -2
  24. data/test/fixtures/executable/fdb.rb +7 -9
  25. data/test/fixtures/executable/flex3sdk_gem/fdb +49 -18
  26. data/test/fixtures/executable/mxmlc.rb +1 -2
  27. data/test/fixtures/executable/subclass/executable_subclass.rb +0 -1
  28. data/test/fixtures/executable/subclass/executable_superclass.rb +1 -2
  29. data/test/fixtures/specification/flex4sdk.rb +35 -24
  30. data/test/unit/archive_unpacker_test.rb +1 -1
  31. data/test/unit/boolean_param_test.rb +1 -1
  32. data/test/unit/daemon_test.rb +35 -3
  33. data/test/unit/executable_option_parser_test.rb +2 -3
  34. data/test/unit/executable_param_test.rb +1 -1
  35. data/test/unit/executable_test.rb +8 -15
  36. data/test/unit/fake_other_executable.rb +1 -2
  37. data/test/unit/file_param_test.rb +1 -1
  38. data/test/unit/file_target_test.rb +1 -1
  39. data/test/unit/files_param_test.rb +1 -1
  40. data/test/unit/generator_generator_test.rb +1 -1
  41. data/test/unit/generator_test.rb +1 -1
  42. data/test/unit/library_generator_test.rb +1 -1
  43. data/test/unit/library_test.rb +1 -1
  44. data/test/unit/osx_system_test.rb +1 -1
  45. data/test/unit/path_param_test.rb +1 -1
  46. data/test/unit/paths_param_test.rb +1 -1
  47. data/test/unit/platform_test.rb +1 -1
  48. data/test/unit/process_runner_test.rb +1 -1
  49. data/test/unit/rdoc_parser_test.rb +1 -1
  50. data/test/unit/remote_file_loader_test.rb +1 -1
  51. data/test/unit/remote_file_target_test.rb +1 -1
  52. data/test/unit/ruby_feature_test.rb +1 -1
  53. data/test/unit/ruby_generator_test.rb +1 -1
  54. data/test/unit/specification_test.rb +8 -1
  55. data/test/unit/sprout_test.rb +2 -2
  56. data/test/unit/string_param_test.rb +1 -1
  57. data/test/unit/string_test.rb +1 -1
  58. data/test/unit/strings_param_test.rb +1 -1
  59. data/test/unit/test_helper.rb +33 -1
  60. data/test/unit/tool_generator_test.rb +1 -1
  61. data/test/unit/unix_system_test.rb +1 -1
  62. data/test/unit/user_test.rb +1 -1
  63. data/test/unit/vista_system_test.rb +1 -1
  64. data/test/unit/win_nix_system_test.rb +1 -1
  65. data/test/unit/win_system_test.rb +1 -1
  66. data/test-stderr.log +1 -0
  67. data/test-stdout.log +237 -0
  68. metadata +15 -190
  69. data/doc/Dir.html +0 -288
  70. data/doc/Rake/Task.html +0 -184
  71. data/doc/Sprout/ArchiveUnpacker.html +0 -1246
  72. data/doc/Sprout/Base/ClassMethods.html +0 -434
  73. data/doc/Sprout/Base.html +0 -126
  74. data/doc/Sprout/Concern.html +0 -353
  75. data/doc/Sprout/Daemon/ClassMethods.html +0 -244
  76. data/doc/Sprout/Daemon/InstanceMethods.html +0 -601
  77. data/doc/Sprout/Daemon.html +0 -166
  78. data/doc/Sprout/Errors/ArchiveUnpackerError.html +0 -125
  79. data/doc/Sprout/Errors/DestinationExistsError.html +0 -133
  80. data/doc/Sprout/Errors/DuplicateMemberError.html +0 -132
  81. data/doc/Sprout/Errors/ExecutableError.html +0 -125
  82. data/doc/Sprout/Errors/ExecutableRegistrationError.html +0 -132
  83. data/doc/Sprout/Errors/ExecutionError.html +0 -121
  84. data/doc/Sprout/Errors/GeneratorError.html +0 -125
  85. data/doc/Sprout/Errors/InvalidArgumentError.html +0 -132
  86. data/doc/Sprout/Errors/LoadError.html +0 -121
  87. data/doc/Sprout/Errors/MissingArgumentError.html +0 -132
  88. data/doc/Sprout/Errors/MissingExecutableError.html +0 -132
  89. data/doc/Sprout/Errors/MissingGeneratorError.html +0 -132
  90. data/doc/Sprout/Errors/MissingTemplateError.html +0 -132
  91. data/doc/Sprout/Errors/ProcessRunnerError.html +0 -121
  92. data/doc/Sprout/Errors/RemoteFileLoaderError.html +0 -110
  93. data/doc/Sprout/Errors/SproutError.html +0 -114
  94. data/doc/Sprout/Errors/UnknownArchiveType.html +0 -122
  95. data/doc/Sprout/Errors/UsageError.html +0 -121
  96. data/doc/Sprout/Errors/ValidationError.html +0 -121
  97. data/doc/Sprout/Errors/VersionRequirementNotMetError.html +0 -121
  98. data/doc/Sprout/Errors.html +0 -101
  99. data/doc/Sprout/Executable/Boolean.html +0 -483
  100. data/doc/Sprout/Executable/ClassMethods.html +0 -417
  101. data/doc/Sprout/Executable/CollectionParam.html +0 -483
  102. data/doc/Sprout/Executable/FileParam.html +0 -484
  103. data/doc/Sprout/Executable/Files.html +0 -292
  104. data/doc/Sprout/Executable/InstanceMethods.html +0 -2006
  105. data/doc/Sprout/Executable/Number.html +0 -141
  106. data/doc/Sprout/Executable/Param.html +0 -2818
  107. data/doc/Sprout/Executable/ParameterFactory.html +0 -232
  108. data/doc/Sprout/Executable/Path.html +0 -223
  109. data/doc/Sprout/Executable/Paths.html +0 -253
  110. data/doc/Sprout/Executable/StringParam.html +0 -213
  111. data/doc/Sprout/Executable/Strings.html +0 -167
  112. data/doc/Sprout/Executable/Url.html +0 -160
  113. data/doc/Sprout/Executable/Urls.html +0 -170
  114. data/doc/Sprout/Executable.html +0 -173
  115. data/doc/Sprout/FileTarget.html +0 -1109
  116. data/doc/Sprout/Generator/Base.html +0 -1626
  117. data/doc/Sprout/Generator/Command.html +0 -690
  118. data/doc/Sprout/Generator/DirectoryManifest.html +0 -476
  119. data/doc/Sprout/Generator/FileManifest.html +0 -572
  120. data/doc/Sprout/Generator/Manifest.html +0 -377
  121. data/doc/Sprout/Generator/TemplateManifest.html +0 -196
  122. data/doc/Sprout/Generator.html +0 -689
  123. data/doc/Sprout/GeneratorGenerator.html +0 -1018
  124. data/doc/Sprout/Library.html +0 -1141
  125. data/doc/Sprout/LibraryGenerator.html +0 -309
  126. data/doc/Sprout/Log.html +0 -496
  127. data/doc/Sprout/MXMLC.html +0 -6373
  128. data/doc/Sprout/Platform.html +0 -714
  129. data/doc/Sprout/ProcessRunner.html +0 -1352
  130. data/doc/Sprout/ProgressBar.html +0 -376
  131. data/doc/Sprout/ProgressBarImpl.html +0 -2119
  132. data/doc/Sprout/ProgressBarManager.html +0 -434
  133. data/doc/Sprout/ProgressBarOutputStream.html +0 -416
  134. data/doc/Sprout/RDocParser.html +0 -211
  135. data/doc/Sprout/RemoteFileLoader.html +0 -172
  136. data/doc/Sprout/RemoteFileTarget.html +0 -679
  137. data/doc/Sprout/ReversedProgressBar.html +0 -194
  138. data/doc/Sprout/RubyFeature/ClassMethods.html +0 -1065
  139. data/doc/Sprout/RubyFeature.html +0 -155
  140. data/doc/Sprout/RubyGenerator.html +0 -764
  141. data/doc/Sprout/Specification.html +0 -767
  142. data/doc/Sprout/System/BaseSystem.html +0 -1455
  143. data/doc/Sprout/System/JavaSystem.html +0 -122
  144. data/doc/Sprout/System/OSXSystem.html +0 -335
  145. data/doc/Sprout/System/ThreadMock.html +0 -193
  146. data/doc/Sprout/System/UnixSystem.html +0 -584
  147. data/doc/Sprout/System/VistaSystem.html +0 -251
  148. data/doc/Sprout/System/WinNixSystem.html +0 -325
  149. data/doc/Sprout/System/WinSystem.html +0 -571
  150. data/doc/Sprout/System.html +0 -191
  151. data/doc/Sprout/ToolGenerator.html +0 -931
  152. data/doc/Sprout/VERSION.html +0 -128
  153. data/doc/Sprout.html +0 -144
  154. data/doc/SproutTestCase.html +0 -1412
  155. data/doc/String.html +0 -286
  156. data/doc/_index.html +0 -1035
  157. data/doc/class_list.html +0 -36
  158. data/doc/css/common.css +0 -1
  159. data/doc/css/full_list.css +0 -53
  160. data/doc/css/style.css +0 -310
  161. data/doc/file.README.html +0 -96
  162. data/doc/file.archive_unpacker.html +0 -288
  163. data/doc/file.base.html +0 -208
  164. data/doc/file.base_system.html +0 -278
  165. data/doc/file.boolean.html +0 -135
  166. data/doc/file.collection_param.html +0 -139
  167. data/doc/file.command.html +0 -126
  168. data/doc/file.concern.html +0 -136
  169. data/doc/file.daemon.html +0 -309
  170. data/doc/file.dir.html +0 -76
  171. data/doc/file.directory_manifest.html +0 -122
  172. data/doc/file.errors.html +0 -147
  173. data/doc/file.executable.html +0 -638
  174. data/doc/file.file_manifest.html +0 -109
  175. data/doc/file.file_param.html +0 -120
  176. data/doc/file.file_target.html +0 -140
  177. data/doc/file.files.html +0 -85
  178. data/doc/file.generator.html +0 -296
  179. data/doc/file.generator_class.html +0 -72
  180. data/doc/file.generator_generator.html +0 -137
  181. data/doc/file.generator_test.html +0 -92
  182. data/doc/file.generator_test_helper.html +0 -67
  183. data/doc/file.java_system.html +0 -62
  184. data/doc/file.library.html +0 -291
  185. data/doc/file.library_generator.html +0 -74
  186. data/doc/file.log.html +0 -100
  187. data/doc/file.manifest.html +0 -67
  188. data/doc/file.mxmlc.html +0 -740
  189. data/doc/file.number.html +0 -67
  190. data/doc/file.osx_system.html +0 -79
  191. data/doc/file.param.html +0 -491
  192. data/doc/file.parameter_factory.html +0 -119
  193. data/doc/file.path.html +0 -81
  194. data/doc/file.paths.html +0 -80
  195. data/doc/file.platform.html +0 -124
  196. data/doc/file.process_runner.html +0 -224
  197. data/doc/file.progress_bar.html +0 -390
  198. data/doc/file.rdoc_parser.html +0 -145
  199. data/doc/file.remote_file_loader.html +0 -117
  200. data/doc/file.remote_file_target.html +0 -176
  201. data/doc/file.ruby_base.html +0 -64
  202. data/doc/file.ruby_feature.html +0 -244
  203. data/doc/file.ruby_generator.html +0 -118
  204. data/doc/file.ruby_input.html +0 -62
  205. data/doc/file.ruby_test_case.html +0 -78
  206. data/doc/file.ruby_test_helper.html +0 -61
  207. data/doc/file.specification.html +0 -248
  208. data/doc/file.sprout.html +0 -64
  209. data/doc/file.sprout_test_case.html +0 -280
  210. data/doc/file.string.html +0 -72
  211. data/doc/file.string_param.html +0 -76
  212. data/doc/file.strings.html +0 -71
  213. data/doc/file.system.html +0 -86
  214. data/doc/file.template_manifest.html +0 -67
  215. data/doc/file.tool.html +0 -92
  216. data/doc/file.tool_generator.html +0 -90
  217. data/doc/file.unix_system.html +0 -128
  218. data/doc/file.url.html +0 -71
  219. data/doc/file.urls.html +0 -70
  220. data/doc/file.version.html +0 -71
  221. data/doc/file.vista_system.html +0 -69
  222. data/doc/file.win_nix_system.html +0 -88
  223. data/doc/file.win_system.html +0 -129
  224. data/doc/file_list.html +0 -230
  225. data/doc/frames.html +0 -13
  226. data/doc/index.html +0 -96
  227. data/doc/js/app.js +0 -202
  228. data/doc/js/full_list.js +0 -149
  229. data/doc/js/jquery.js +0 -154
  230. data/doc/method_list.html +0 -3355
  231. data/doc/top-level-namespace.html +0 -192
  232. data/lib/sprout/base.rb +0 -121
  233. data/lib/sprout/log.rb +0 -46
  234. data/test/unit/sprout_test_helper.rb +0 -33
@@ -1,2006 +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 name="Content-Type" content="text/html; charset=utf-8" />
6
- <title>Module: Sprout::Executable::InstanceMethods</title>
7
- <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
- <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
-
10
- <script type="text/javascript" charset="utf-8">
11
- relpath = '../..';
12
- if (relpath != '') relpath += '/';
13
- </script>
14
- <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
15
- <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
16
-
17
- </head>
18
- <body>
19
- <script type="text/javascript" charset="utf-8">
20
- if (window.top.frames.main) document.body.className = 'frames';
21
- </script>
22
-
23
- <div id="header">
24
- <div id="menu">
25
-
26
- <a href="../../_index.html">Index (I)</a> &raquo;
27
- <span class='title'><span class='object_link'><a href="../../Sprout.html" title="Sprout (module)">Sprout</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Executable.html" title="Sprout::Executable (module)">Executable</a></span></span>
28
- &raquo;
29
- <span class="title">InstanceMethods</span>
30
-
31
-
32
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
- </div>
34
-
35
- <div id="search">
36
- <a id="class_list_link" href="#">Class List</a>
37
- <a id="method_list_link" href="#">Method List</a>
38
- <a id ="file_list_link" href="#">File List</a>
39
- </div>
40
-
41
- <div class="clear"></div>
42
- </div>
43
-
44
- <iframe id="search_frame"></iframe>
45
-
46
- <div id="content"><h1>Module: Sprout::Executable::InstanceMethods
47
-
48
-
49
-
50
- </h1>
51
-
52
- <dl class="box">
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
- <dt class="r1 last">Defined in:</dt>
62
- <dd class="r1 last">lib/sprout/executable.rb</dd>
63
-
64
- </dl>
65
- <div class="clear"></div>
66
-
67
-
68
-
69
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
70
- <ul class="summary">
71
-
72
- <li class="public ">
73
- <span class="summary_signature">
74
-
75
- <a href="#abort_on_failure-instance_method" title="#abort_on_failure (instance method)">- (Object) <strong>abort_on_failure</strong> </a>
76
-
77
-
78
-
79
- </span>
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
- <span class="summary_desc"><div class='inline'>
92
- <p>Configure the executable instance to output failure messages to stderr and
93
- abort with non-zero response.</p>
94
- </div></span>
95
-
96
- </li>
97
-
98
-
99
- <li class="public ">
100
- <span class="summary_signature">
101
-
102
- <a href="#default_prefix-instance_method" title="#default_prefix (instance method)">- (Object) <strong>default_prefix</strong> </a>
103
-
104
-
105
-
106
- </span>
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
- <span class="summary_desc"><div class='inline'>
119
- <p>The default command line prefix that should be used in front of parameter
120
- names.</p>
121
- </div></span>
122
-
123
- </li>
124
-
125
-
126
- <li class="public ">
127
- <span class="summary_signature">
128
-
129
- <a href="#default_short_prefix-instance_method" title="#default_short_prefix (instance method)">- (Object) <strong>default_short_prefix</strong> </a>
130
-
131
-
132
-
133
- </span>
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
- <span class="summary_desc"><div class='inline'>
146
- <p>The default command line prefix for short name parameters.</p>
147
- </div></span>
148
-
149
- </li>
150
-
151
-
152
- <li class="public ">
153
- <span class="summary_signature">
154
-
155
- <a href="#executable-instance_method" title="#executable (instance method)">- (Object) <strong>executable</strong> </a>
156
-
157
-
158
-
159
- </span>
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
- <span class="summary_desc"><div class='inline'>
172
- <p>The default Sprout executable that we will use for this executable.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- <li class="public ">
179
- <span class="summary_signature">
180
-
181
- <a href="#param_hash-instance_method" title="#param_hash (instance method)">- (Object) <strong>param_hash</strong> </a>
182
-
183
-
184
-
185
- </span>
186
-
187
-
188
- <span class="note title readonly">readonly</span>
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
- <span class="summary_desc"><div class='inline'>
198
- <p>Returns the value of attribute param_hash.</p>
199
- </div></span>
200
-
201
- </li>
202
-
203
-
204
- <li class="public ">
205
- <span class="summary_signature">
206
-
207
- <a href="#params-instance_method" title="#params (instance method)">- (Object) <strong>params</strong> </a>
208
-
209
-
210
-
211
- </span>
212
-
213
-
214
- <span class="note title readonly">readonly</span>
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
- <span class="summary_desc"><div class='inline'>
224
- <p>Returns the value of attribute params.</p>
225
- </div></span>
226
-
227
- </li>
228
-
229
-
230
- <li class="public ">
231
- <span class="summary_signature">
232
-
233
- <a href="#pkg_name-instance_method" title="#pkg_name (instance method)">- (Object) <strong>pkg_name</strong> </a>
234
-
235
-
236
-
237
- </span>
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
- <span class="summary_desc"><div class='inline'>
250
- <p>The default RubyGem that we will use when requesting our executable.</p>
251
- </div></span>
252
-
253
- </li>
254
-
255
-
256
- <li class="public ">
257
- <span class="summary_signature">
258
-
259
- <a href="#pkg_version-instance_method" title="#pkg_version (instance method)">- (Object) <strong>pkg_version</strong> </a>
260
-
261
-
262
-
263
- </span>
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
- <span class="summary_desc"><div class='inline'>
276
- <p>The default RubyGem version that we will use when requesting our
277
- executable.</p>
278
- </div></span>
279
-
280
- </li>
281
-
282
-
283
- <li class="public ">
284
- <span class="summary_signature">
285
-
286
- <a href="#prerequisites-instance_method" title="#prerequisites (instance method)">- (Object) <strong>prerequisites</strong> </a>
287
-
288
-
289
-
290
- </span>
291
-
292
-
293
- <span class="note title readonly">readonly</span>
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
- <span class="summary_desc"><div class='inline'>
303
- <p>Returns the value of attribute prerequisites.</p>
304
- </div></span>
305
-
306
- </li>
307
-
308
-
309
- <li class="public ">
310
- <span class="summary_signature">
311
-
312
- <a href="#rake_task_name-instance_method" title="#rake_task_name (instance method)">- (Object) <strong>rake_task_name</strong> </a>
313
-
314
-
315
-
316
- </span>
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
- <span class="summary_desc"><div class='inline'>
329
- <p>If the executable is configured as a Rake::Task, it will extract the
330
- Rake::Task[:name] property and apply it to this field.</p>
331
- </div></span>
332
-
333
- </li>
334
-
335
-
336
- </ul>
337
-
338
-
339
-
340
- <h2>
341
- Instance Method Summary
342
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
343
- </h2>
344
-
345
- <ul class="summary">
346
-
347
- <li class="protected ">
348
- <span class="summary_signature">
349
-
350
- <a href="#create_outer_task-instance_method" title="#create_outer_task (instance method)">- (Object) <strong>create_outer_task</strong>(*args) </a>
351
-
352
-
353
-
354
- </span>
355
-
356
-
357
- <span class="note title protected">protected</span>
358
-
359
-
360
-
361
-
362
-
363
- <span class="summary_desc"><div class='inline'>
364
- <p>Create the outer rake task.</p>
365
- </div></span>
366
-
367
- </li>
368
-
369
-
370
- <li class="public ">
371
- <span class="summary_signature">
372
-
373
- <a href="#default_file_expression-instance_method" title="#default_file_expression (instance method)">- (Object) <strong>default_file_expression</strong> </a>
374
-
375
-
376
-
377
- </span>
378
-
379
-
380
-
381
-
382
-
383
-
384
-
385
-
386
- <span class="summary_desc"><div class='inline'>
387
- <p>Called by Parameters like :path and :paths.</p>
388
- </div></span>
389
-
390
- </li>
391
-
392
-
393
- <li class="public ">
394
- <span class="summary_signature">
395
-
396
- <a href="#execute-instance_method" title="#execute (instance method)">- (Object) <strong>execute</strong> </a>
397
-
398
-
399
-
400
- </span>
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
- <span class="summary_desc"><div class='inline'>
410
- <p>Execute the feature after calling parse with command line arguments.</p>
411
- </div></span>
412
-
413
- </li>
414
-
415
-
416
- <li class="public ">
417
- <span class="summary_signature">
418
-
419
- <a href="#execute_delegate-instance_method" title="#execute_delegate (instance method)">- (Object) <strong>execute_delegate</strong> </a>
420
-
421
-
422
-
423
- </span>
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
- <span class="summary_desc"><div class='inline'>
433
- <p>Call the provided executable delegate.</p>
434
- </div></span>
435
-
436
- </li>
437
-
438
-
439
- <li class="public ">
440
- <span class="summary_signature">
441
-
442
- <a href="#from_hash-instance_method" title="#from_hash (instance method)">- (Object) <strong>from_hash</strong>(hash) </a>
443
-
444
-
445
-
446
- </span>
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
- <span class="summary_desc"><div class='inline'>
456
- <p>This will ignore unknown parameters, because our very first use case, is
457
- when generators call other generators and generator A might have different
458
- parameters than generator B.</p>
459
- </div></span>
460
-
461
- </li>
462
-
463
-
464
- <li class="public ">
465
- <span class="summary_signature">
466
-
467
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (InstanceMethods) <strong>initialize</strong> </a>
468
-
469
-
470
-
471
- </span>
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
- <span class="summary_desc"><div class='inline'>
481
- <p>A new instance of InstanceMethods.</p>
482
- </div></span>
483
-
484
- </li>
485
-
486
-
487
- <li class="protected ">
488
- <span class="summary_signature">
489
-
490
- <a href="#library_added-instance_method" title="#library_added (instance method)">- (Object) <strong>library_added</strong>(path_or_paths) </a>
491
-
492
-
493
-
494
- </span>
495
-
496
-
497
- <span class="note title protected">protected</span>
498
-
499
-
500
-
501
-
502
-
503
- <span class="summary_desc"><div class='inline'>
504
- <p>This method will generally be overridden by subclasses and they can do
505
- whatever customization is necessary for a particular library type.</p>
506
- </div></span>
507
-
508
- </li>
509
-
510
-
511
- <li class="public ">
512
- <span class="summary_signature">
513
-
514
- <a href="#parse%21-instance_method" title="#parse! (instance method)">- (Object) <strong>parse!</strong>(commandline_options) </a>
515
-
516
-
517
-
518
- </span>
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
- <span class="summary_desc"><div class='inline'></div></span>
528
-
529
- </li>
530
-
531
-
532
- <li class="protected ">
533
- <span class="summary_signature">
534
-
535
- <a href="#parse_extra_options%21-instance_method" title="#parse_extra_options! (instance method)">- (Object) <strong>parse_extra_options!</strong>(options) </a>
536
-
537
-
538
-
539
- </span>
540
-
541
-
542
- <span class="note title protected">protected</span>
543
-
544
-
545
-
546
-
547
-
548
- <span class="summary_desc"><div class='inline'></div></span>
549
-
550
- </li>
551
-
552
-
553
- <li class="protected ">
554
- <span class="summary_signature">
555
-
556
- <a href="#parse_rake_task_arg-instance_method" title="#parse_rake_task_arg (instance method)">- (Object) <strong>parse_rake_task_arg</strong>(arg) </a>
557
-
558
-
559
-
560
- </span>
561
-
562
-
563
- <span class="note title protected">protected</span>
564
-
565
-
566
-
567
-
568
-
569
- <span class="summary_desc"><div class='inline'></div></span>
570
-
571
- </li>
572
-
573
-
574
- <li class="public ">
575
- <span class="summary_signature">
576
-
577
- <a href="#prepare-instance_method" title="#prepare (instance method)">- (Object) <strong>prepare</strong> </a>
578
-
579
-
580
-
581
- </span>
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
- <span class="summary_desc"><div class='inline'></div></span>
591
-
592
- </li>
593
-
594
-
595
- <li class="protected ">
596
- <span class="summary_signature">
597
-
598
- <a href="#system_execute-instance_method" title="#system_execute (instance method)">- (Object) <strong>system_execute</strong>(binary, params) </a>
599
-
600
-
601
-
602
- </span>
603
-
604
-
605
- <span class="note title protected">protected</span>
606
-
607
-
608
-
609
-
610
-
611
- <span class="summary_desc"><div class='inline'></div></span>
612
-
613
- </li>
614
-
615
-
616
- <li class="public ">
617
- <span class="summary_signature">
618
-
619
- <a href="#to_hash-instance_method" title="#to_hash (instance method)">- (Object) <strong>to_hash</strong> </a>
620
-
621
-
622
-
623
- </span>
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
- <span class="summary_desc"><div class='inline'>
633
- <p>This will create a hash of ONLY values that are created using
634
- <tt>add_param</tt>, properties that are created with attr_accessor must be
635
- handled manually, or patches are welcome!.</p>
636
- </div></span>
637
-
638
- </li>
639
-
640
-
641
- <li class="public ">
642
- <span class="summary_signature">
643
-
644
- <a href="#to_help-instance_method" title="#to_help (instance method)">- (Object) <strong>to_help</strong> </a>
645
-
646
-
647
-
648
- </span>
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
- <span class="summary_desc"><div class='inline'></div></span>
658
-
659
- </li>
660
-
661
-
662
- <li class="public ">
663
- <span class="summary_signature">
664
-
665
- <a href="#to_rake-instance_method" title="#to_rake (instance method)">- (Object) <strong>to_rake</strong>(*args) {|_self| ... }</a>
666
-
667
-
668
-
669
- </span>
670
-
671
-
672
-
673
-
674
-
675
-
676
-
677
-
678
- <span class="summary_desc"><div class='inline'></div></span>
679
-
680
- </li>
681
-
682
-
683
- <li class="public ">
684
- <span class="summary_signature">
685
-
686
- <a href="#to_shell-instance_method" title="#to_shell (instance method)">- (Object) <strong>to_shell</strong> </a>
687
-
688
-
689
-
690
- </span>
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
- <span class="summary_desc"><div class='inline'>
700
- <p>Create a string that represents this configured executable for shell
701
- execution.</p>
702
- </div></span>
703
-
704
- </li>
705
-
706
-
707
- <li class="protected ">
708
- <span class="summary_signature">
709
-
710
- <a href="#update_rake_task_name_from_args-instance_method" title="#update_rake_task_name_from_args (instance method)">- (Object) <strong>update_rake_task_name_from_args</strong>(*args) </a>
711
-
712
-
713
-
714
- </span>
715
-
716
-
717
- <span class="note title protected">protected</span>
718
-
719
-
720
-
721
-
722
-
723
- <span class="summary_desc"><div class='inline'>
724
- <p>This method will add the current task to the Rake CLEAN collection.</p>
725
- </div></span>
726
-
727
- </li>
728
-
729
-
730
- </ul>
731
-
732
-
733
-
734
- <div id="instance_attr_details" class="attr_details">
735
- <h2>Instance Attribute Details</h2>
736
-
737
-
738
- <span id="abort_on_failure=-instance_method"></span>
739
- <span id="abort_on_failure-instance_method"></span>
740
- <div class="method_details first">
741
- <p class="signature first" id="abort_on_failure-instance_method">
742
-
743
- - (<tt>Object</tt>) <strong>abort_on_failure</strong>
744
-
745
-
746
-
747
- </p><div class="docstring">
748
- <div class="discussion">
749
-
750
- <p>Configure the executable instance to output failure messages to stderr and
751
- abort with non-zero response.</p>
752
-
753
-
754
- </div>
755
- </div>
756
- <div class="tags">
757
-
758
- </div><table class="source_code">
759
- <tr>
760
- <td>
761
- <pre class="lines">
762
-
763
-
764
- 240
765
- 241
766
- 242</pre>
767
- </td>
768
- <td>
769
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 240</span>
770
-
771
- <span class='kw'>def</span> <span class='id abort_on_failure'>abort_on_failure</span>
772
- <span class='ivar'>@abort_on_failure</span>
773
- <span class='kw'>end</span></pre>
774
- </td>
775
- </tr>
776
- </table>
777
- </div>
778
-
779
-
780
- <span id="default_prefix=-instance_method"></span>
781
- <span id="default_prefix-instance_method"></span>
782
- <div class="method_details ">
783
- <p class="signature " id="default_prefix-instance_method">
784
-
785
- - (<tt>Object</tt>) <strong>default_prefix</strong>
786
-
787
-
788
-
789
- </p><div class="docstring">
790
- <div class="discussion">
791
-
792
- <p>The default command line prefix that should be used in front of parameter
793
- names.</p>
794
-
795
- <p>The default value for this parameter is '--', but some command line
796
- applications (like MXMLC) prefer '-'.</p>
797
-
798
-
799
- </div>
800
- </div>
801
- <div class="tags">
802
-
803
- </div><table class="source_code">
804
- <tr>
805
- <td>
806
- <pre class="lines">
807
-
808
-
809
- 209
810
- 210
811
- 211</pre>
812
- </td>
813
- <td>
814
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 209</span>
815
-
816
- <span class='kw'>def</span> <span class='id default_prefix'>default_prefix</span>
817
- <span class='ivar'>@default_prefix</span>
818
- <span class='kw'>end</span></pre>
819
- </td>
820
- </tr>
821
- </table>
822
- </div>
823
-
824
-
825
- <span id="default_short_prefix=-instance_method"></span>
826
- <span id="default_short_prefix-instance_method"></span>
827
- <div class="method_details ">
828
- <p class="signature " id="default_short_prefix-instance_method">
829
-
830
- - (<tt>Object</tt>) <strong>default_short_prefix</strong>
831
-
832
-
833
-
834
- </p><div class="docstring">
835
- <div class="discussion">
836
-
837
- <p>The default command line prefix for short name parameters.</p>
838
-
839
- <p>This value defaults to '-', but can be changed to whatever a particular
840
- tool prefers.</p>
841
-
842
-
843
- </div>
844
- </div>
845
- <div class="tags">
846
-
847
- </div><table class="source_code">
848
- <tr>
849
- <td>
850
- <pre class="lines">
851
-
852
-
853
- 217
854
- 218
855
- 219</pre>
856
- </td>
857
- <td>
858
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 217</span>
859
-
860
- <span class='kw'>def</span> <span class='id default_short_prefix'>default_short_prefix</span>
861
- <span class='ivar'>@default_short_prefix</span>
862
- <span class='kw'>end</span></pre>
863
- </td>
864
- </tr>
865
- </table>
866
- </div>
867
-
868
-
869
- <span id="executable=-instance_method"></span>
870
- <span id="executable-instance_method"></span>
871
- <div class="method_details ">
872
- <p class="signature " id="executable-instance_method">
873
-
874
- - (<tt>Object</tt>) <strong>executable</strong>
875
-
876
-
877
-
878
- </p><div class="docstring">
879
- <div class="discussion">
880
-
881
- <p>The default Sprout executable that we will use for this executable.</p>
882
-
883
- <p>Classes that include the Task can set the default value for this property
884
- at the class level with:</p>
885
-
886
- <pre class="code"><span class='id set'>set</span> <span class='symbol'>:executable</span><span class='comma'>,</span> <span class='symbol'>:mxmlc</span></pre>
887
-
888
- <p>But that value can be overriden on each instance like:</p>
889
-
890
- <pre class="code"><span class='id executable'>executable</span> <span class='op'>=</span> <span class='const'>SomeToolTask</span><span class='period'>.</span><span class='id new'>new</span>
891
- <span class='id too'>too</span><span class='period'>.</span><span class='id executable'>executable</span> <span class='symbol'>:compc</span></pre>
892
-
893
- <p>This parameter is required - either from the including class or instance
894
- configuration.</p>
895
-
896
-
897
- </div>
898
- </div>
899
- <div class="tags">
900
-
901
- </div><table class="source_code">
902
- <tr>
903
- <td>
904
- <pre class="lines">
905
-
906
-
907
- 235
908
- 236
909
- 237</pre>
910
- </td>
911
- <td>
912
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 235</span>
913
-
914
- <span class='kw'>def</span> <span class='id executable'>executable</span>
915
- <span class='ivar'>@executable</span>
916
- <span class='kw'>end</span></pre>
917
- </td>
918
- </tr>
919
- </table>
920
- </div>
921
-
922
-
923
- <span id=""></span>
924
- <span id="param_hash-instance_method"></span>
925
- <div class="method_details ">
926
- <p class="signature " id="param_hash-instance_method">
927
-
928
- - (<tt>Object</tt>) <strong>param_hash</strong> <span class="extras">(readonly)</span>
929
-
930
-
931
-
932
- </p><div class="docstring">
933
- <div class="discussion">
934
-
935
- <p>Returns the value of attribute param_hash</p>
936
-
937
-
938
- </div>
939
- </div>
940
- <div class="tags">
941
-
942
- </div><table class="source_code">
943
- <tr>
944
- <td>
945
- <pre class="lines">
946
-
947
-
948
- 250
949
- 251
950
- 252</pre>
951
- </td>
952
- <td>
953
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 250</span>
954
-
955
- <span class='kw'>def</span> <span class='id param_hash'>param_hash</span>
956
- <span class='ivar'>@param_hash</span>
957
- <span class='kw'>end</span></pre>
958
- </td>
959
- </tr>
960
- </table>
961
- </div>
962
-
963
-
964
- <span id=""></span>
965
- <span id="params-instance_method"></span>
966
- <div class="method_details ">
967
- <p class="signature " id="params-instance_method">
968
-
969
- - (<tt>Object</tt>) <strong>params</strong> <span class="extras">(readonly)</span>
970
-
971
-
972
-
973
- </p><div class="docstring">
974
- <div class="discussion">
975
-
976
- <p>Returns the value of attribute params</p>
977
-
978
-
979
- </div>
980
- </div>
981
- <div class="tags">
982
-
983
- </div><table class="source_code">
984
- <tr>
985
- <td>
986
- <pre class="lines">
987
-
988
-
989
- 251
990
- 252
991
- 253</pre>
992
- </td>
993
- <td>
994
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 251</span>
995
-
996
- <span class='kw'>def</span> <span class='id params'>params</span>
997
- <span class='ivar'>@params</span>
998
- <span class='kw'>end</span></pre>
999
- </td>
1000
- </tr>
1001
- </table>
1002
- </div>
1003
-
1004
-
1005
- <span id="pkg_name=-instance_method"></span>
1006
- <span id="pkg_name-instance_method"></span>
1007
- <div class="method_details ">
1008
- <p class="signature " id="pkg_name-instance_method">
1009
-
1010
- - (<tt>Object</tt>) <strong>pkg_name</strong>
1011
-
1012
-
1013
-
1014
- </p><div class="docstring">
1015
- <div class="discussion">
1016
-
1017
- <p>The default RubyGem that we will use when requesting our executable.</p>
1018
-
1019
- <p>Classes that include the Executable can set the default value for this
1020
- property at the class level with:</p>
1021
-
1022
- <pre class="code"><span class='id set'>set</span> <span class='symbol'>:pkg_name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sprout-sometoolname</span><span class='tstring_end'>'</span></span></pre>
1023
-
1024
- <p>But that value can be overridden on each instance like:</p>
1025
-
1026
- <pre class="code"><span class='id executable'>executable</span> <span class='op'>=</span> <span class='const'>SomeToolTask</span><span class='period'>.</span><span class='id new'>new</span>
1027
- <span class='id executable'>executable</span><span class='period'>.</span><span class='id pkg_name'>pkg_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sprout-othertoolname</span><span class='tstring_end'>'</span></span></pre>
1028
-
1029
- <p>This parameter is required - either from the including class or instance
1030
- configuration.</p>
1031
-
1032
-
1033
- </div>
1034
- </div>
1035
- <div class="tags">
1036
-
1037
- </div><table class="source_code">
1038
- <tr>
1039
- <td>
1040
- <pre class="lines">
1041
-
1042
-
1043
- 181
1044
- 182
1045
- 183</pre>
1046
- </td>
1047
- <td>
1048
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 181</span>
1049
-
1050
- <span class='kw'>def</span> <span class='id pkg_name'>pkg_name</span>
1051
- <span class='ivar'>@pkg_name</span>
1052
- <span class='kw'>end</span></pre>
1053
- </td>
1054
- </tr>
1055
- </table>
1056
- </div>
1057
-
1058
-
1059
- <span id="pkg_version=-instance_method"></span>
1060
- <span id="pkg_version-instance_method"></span>
1061
- <div class="method_details ">
1062
- <p class="signature " id="pkg_version-instance_method">
1063
-
1064
- - (<tt>Object</tt>) <strong>pkg_version</strong>
1065
-
1066
-
1067
-
1068
- </p><div class="docstring">
1069
- <div class="discussion">
1070
-
1071
- <p>The default RubyGem version that we will use when requesting our
1072
- executable.</p>
1073
-
1074
- <p>Classes that include the Task can set the default value for this property
1075
- at the class level with:</p>
1076
-
1077
- <pre class="code"><span class='id set'>set</span> <span class='symbol'>:pkg_version</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>&gt;= 1.0.3</span><span class='tstring_end'>'</span></span></pre>
1078
-
1079
- <p>But that value can be overriden on each instance like:</p>
1080
-
1081
- <pre class="code"><span class='id executable'>executable</span> <span class='op'>=</span> <span class='const'>SomeToolTask</span><span class='period'>.</span><span class='id new'>new</span>
1082
- <span class='id too'>too</span><span class='period'>.</span><span class='id pkg_version'>pkg_version</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>&gt;= 2.0.0</span><span class='tstring_end'>'</span></span></pre>
1083
-
1084
- <p>This parameter is required - either from the including class or instance
1085
- configuration.</p>
1086
-
1087
-
1088
- </div>
1089
- </div>
1090
- <div class="tags">
1091
-
1092
- </div><table class="source_code">
1093
- <tr>
1094
- <td>
1095
- <pre class="lines">
1096
-
1097
-
1098
- 199
1099
- 200
1100
- 201</pre>
1101
- </td>
1102
- <td>
1103
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 199</span>
1104
-
1105
- <span class='kw'>def</span> <span class='id pkg_version'>pkg_version</span>
1106
- <span class='ivar'>@pkg_version</span>
1107
- <span class='kw'>end</span></pre>
1108
- </td>
1109
- </tr>
1110
- </table>
1111
- </div>
1112
-
1113
-
1114
- <span id=""></span>
1115
- <span id="prerequisites-instance_method"></span>
1116
- <div class="method_details ">
1117
- <p class="signature " id="prerequisites-instance_method">
1118
-
1119
- - (<tt>Object</tt>) <strong>prerequisites</strong> <span class="extras">(readonly)</span>
1120
-
1121
-
1122
-
1123
- </p><div class="docstring">
1124
- <div class="discussion">
1125
-
1126
- <p>Returns the value of attribute prerequisites</p>
1127
-
1128
-
1129
- </div>
1130
- </div>
1131
- <div class="tags">
1132
-
1133
- </div><table class="source_code">
1134
- <tr>
1135
- <td>
1136
- <pre class="lines">
1137
-
1138
-
1139
- 252
1140
- 253
1141
- 254</pre>
1142
- </td>
1143
- <td>
1144
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 252</span>
1145
-
1146
- <span class='kw'>def</span> <span class='id prerequisites'>prerequisites</span>
1147
- <span class='ivar'>@prerequisites</span>
1148
- <span class='kw'>end</span></pre>
1149
- </td>
1150
- </tr>
1151
- </table>
1152
- </div>
1153
-
1154
-
1155
- <span id="rake_task_name=-instance_method"></span>
1156
- <span id="rake_task_name-instance_method"></span>
1157
- <div class="method_details ">
1158
- <p class="signature " id="rake_task_name-instance_method">
1159
-
1160
- - (<tt>Object</tt>) <strong>rake_task_name</strong>
1161
-
1162
-
1163
-
1164
- </p><div class="docstring">
1165
- <div class="discussion">
1166
-
1167
- <p>If the executable is configured as a Rake::Task, it will extract the
1168
- Rake::Task[:name] property and apply it to this field.</p>
1169
-
1170
- <p>Concrete parameters can pull this value from their <tt>belongs_to</tt>
1171
- parameter.</p>
1172
-
1173
-
1174
- </div>
1175
- </div>
1176
- <div class="tags">
1177
-
1178
- </div><table class="source_code">
1179
- <tr>
1180
- <td>
1181
- <pre class="lines">
1182
-
1183
-
1184
- 248
1185
- 249
1186
- 250</pre>
1187
- </td>
1188
- <td>
1189
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 248</span>
1190
-
1191
- <span class='kw'>def</span> <span class='id rake_task_name'>rake_task_name</span>
1192
- <span class='ivar'>@rake_task_name</span>
1193
- <span class='kw'>end</span></pre>
1194
- </td>
1195
- </tr>
1196
- </table>
1197
- </div>
1198
-
1199
- </div>
1200
-
1201
-
1202
- <div id="instance_method_details" class="method_details_list">
1203
- <h2>Instance Method Details</h2>
1204
-
1205
-
1206
- <div class="method_details first">
1207
- <p class="signature first" id="create_outer_task-instance_method">
1208
-
1209
- - (<tt>Object</tt>) <strong>create_outer_task</strong>(*args) <span class="extras">(protected)</span>
1210
-
1211
-
1212
-
1213
- </p><div class="docstring">
1214
- <div class="discussion">
1215
-
1216
- <p>Create the outer rake task. For most executables, this will be a
1217
- Rake::File task, This is a template method that should be overridden for
1218
- executables that do not result in the creation of a file.</p>
1219
-
1220
-
1221
- </div>
1222
- </div>
1223
- <div class="tags">
1224
-
1225
- <h3>See Also:</h3>
1226
- <ul class="see">
1227
-
1228
- <li>update_rake_task_name_from_args</li>
1229
-
1230
- </ul>
1231
-
1232
- </div><table class="source_code">
1233
- <tr>
1234
- <td>
1235
- <pre class="lines">
1236
-
1237
-
1238
- 390
1239
- 391
1240
- 392
1241
- 393
1242
- 394</pre>
1243
- </td>
1244
- <td>
1245
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 390</span>
1246
-
1247
- <span class='kw'>def</span> <span class='id create_outer_task'>create_outer_task</span> <span class='op'>*</span><span class='id args'>args</span>
1248
- <span class='id file'>file</span> <span class='op'>*</span><span class='id args'>args</span> <span class='kw'>do</span>
1249
- <span class='id execute'>execute</span>
1250
- <span class='kw'>end</span>
1251
- <span class='kw'>end</span></pre>
1252
- </td>
1253
- </tr>
1254
- </table>
1255
- </div>
1256
-
1257
- <div class="method_details ">
1258
- <p class="signature " id="default_file_expression-instance_method">
1259
-
1260
- - (<tt>Object</tt>) <strong>default_file_expression</strong>
1261
-
1262
-
1263
-
1264
- </p><div class="docstring">
1265
- <div class="discussion">
1266
-
1267
- <p>Called by Parameters like :path and :paths</p>
1268
-
1269
-
1270
- </div>
1271
- </div>
1272
- <div class="tags">
1273
-
1274
- </div><table class="source_code">
1275
- <tr>
1276
- <td>
1277
- <pre class="lines">
1278
-
1279
-
1280
- 376
1281
- 377
1282
- 378</pre>
1283
- </td>
1284
- <td>
1285
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 376</span>
1286
-
1287
- <span class='kw'>def</span> <span class='id default_file_expression'>default_file_expression</span>
1288
- <span class='ivar'>@default_file_expression</span> <span class='op'>||=</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Executable</span><span class='op'>::</span><span class='const'>DEFAULT_FILE_EXPRESSION</span>
1289
- <span class='kw'>end</span></pre>
1290
- </td>
1291
- </tr>
1292
- </table>
1293
- </div>
1294
-
1295
- <div class="method_details ">
1296
- <p class="signature " id="execute-instance_method">
1297
-
1298
- - (<tt>Object</tt>) <strong>execute</strong>
1299
-
1300
-
1301
-
1302
- </p><div class="docstring">
1303
- <div class="discussion">
1304
-
1305
- <p>Execute the feature after calling parse with command line arguments.</p>
1306
-
1307
- <p>Subclasses will generally override this method if they are a Ruby
1308
- executable, but if you're just delegating to an external CLI application,
1309
- calling execute will wind up executing the external process.</p>
1310
-
1311
-
1312
- </div>
1313
- </div>
1314
- <div class="tags">
1315
-
1316
- </div><table class="source_code">
1317
- <tr>
1318
- <td>
1319
- <pre class="lines">
1320
-
1321
-
1322
- 288
1323
- 289
1324
- 290</pre>
1325
- </td>
1326
- <td>
1327
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 288</span>
1328
-
1329
- <span class='kw'>def</span> <span class='id execute'>execute</span>
1330
- <span class='id execute_delegate'>execute_delegate</span>
1331
- <span class='kw'>end</span></pre>
1332
- </td>
1333
- </tr>
1334
- </table>
1335
- </div>
1336
-
1337
- <div class="method_details ">
1338
- <p class="signature " id="execute_delegate-instance_method">
1339
-
1340
- - (<tt>Object</tt>) <strong>execute_delegate</strong>
1341
-
1342
-
1343
-
1344
- </p><div class="docstring">
1345
- <div class="discussion">
1346
-
1347
- <p>Call the provided executable delegate.</p>
1348
-
1349
- <p>This method is generally called from Rake task wrappers.</p>
1350
-
1351
-
1352
- </div>
1353
- </div>
1354
- <div class="tags">
1355
-
1356
- </div><table class="source_code">
1357
- <tr>
1358
- <td>
1359
- <pre class="lines">
1360
-
1361
-
1362
- 297
1363
- 298
1364
- 299</pre>
1365
- </td>
1366
- <td>
1367
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 297</span>
1368
-
1369
- <span class='kw'>def</span> <span class='id execute_delegate'>execute_delegate</span>
1370
- <span class='id system_execute'>system_execute</span> <span class='id binary_path'>binary_path</span><span class='comma'>,</span> <span class='id to_shell'>to_shell</span>
1371
- <span class='kw'>end</span></pre>
1372
- </td>
1373
- </tr>
1374
- </table>
1375
- </div>
1376
-
1377
- <div class="method_details ">
1378
- <p class="signature " id="from_hash-instance_method">
1379
-
1380
- - (<tt>Object</tt>) <strong>from_hash</strong>(hash)
1381
-
1382
-
1383
-
1384
- </p><div class="docstring">
1385
- <div class="discussion">
1386
-
1387
- <p>This will ignore unknown parameters, because our very first use case, is
1388
- when generators call other generators and generator A might have different
1389
- parameters than generator B.</p>
1390
-
1391
-
1392
- </div>
1393
- </div>
1394
- <div class="tags">
1395
-
1396
- </div><table class="source_code">
1397
- <tr>
1398
- <td>
1399
- <pre class="lines">
1400
-
1401
-
1402
- 346
1403
- 347
1404
- 348
1405
- 349
1406
- 350
1407
- 351
1408
- 352</pre>
1409
- </td>
1410
- <td>
1411
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 346</span>
1412
-
1413
- <span class='kw'>def</span> <span class='id from_hash'>from_hash</span> <span class='id hash'>hash</span>
1414
- <span class='id hash'>hash</span><span class='period'>.</span><span class='id each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id key'>key</span><span class='comma'>,</span> <span class='id value'>value</span><span class='op'>|</span>
1415
- <span class='kw'>if</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id key'>key</span><span class='rparen'>)</span><span class='rparen'>)</span>
1416
- <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id key'>key</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id value'>value</span>
1417
- <span class='kw'>end</span>
1418
- <span class='kw'>end</span>
1419
- <span class='kw'>end</span></pre>
1420
- </td>
1421
- </tr>
1422
- </table>
1423
- </div>
1424
-
1425
- <div class="method_details ">
1426
- <p class="signature " id="initialize-instance_method">
1427
-
1428
- - (<tt><span class='object_link'><a href="" title="Sprout::Executable::InstanceMethods (module)">InstanceMethods</a></span></tt>) <strong>initialize</strong>
1429
-
1430
-
1431
-
1432
- </p><div class="docstring">
1433
- <div class="discussion">
1434
-
1435
- <p>A new instance of InstanceMethods</p>
1436
-
1437
-
1438
- </div>
1439
- </div>
1440
- <div class="tags">
1441
-
1442
- </div><table class="source_code">
1443
- <tr>
1444
- <td>
1445
- <pre class="lines">
1446
-
1447
-
1448
- 254
1449
- 255
1450
- 256
1451
- 257
1452
- 258
1453
- 259
1454
- 260
1455
- 261
1456
- 262
1457
- 263
1458
- 264
1459
- 265
1460
- 266
1461
- 267</pre>
1462
- </td>
1463
- <td>
1464
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 254</span>
1465
-
1466
- <span class='kw'>def</span> <span class='id initialize'>initialize</span>
1467
- <span class='kw'>super</span>
1468
- <span class='ivar'>@abort_on_failure</span> <span class='op'>=</span> <span class='kw'>true</span>
1469
- <span class='ivar'>@appended_args</span> <span class='op'>=</span> <span class='kw'>nil</span>
1470
- <span class='ivar'>@prepended_args</span> <span class='op'>=</span> <span class='kw'>nil</span>
1471
- <span class='ivar'>@param_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1472
- <span class='ivar'>@params</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1473
- <span class='ivar'>@prerequisites</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1474
- <span class='ivar'>@option_parser</span> <span class='op'>=</span> <span class='const'>OptionParser</span><span class='period'>.</span><span class='id new'>new</span>
1475
- <span class='ivar'>@default_prefix</span> <span class='op'>=</span> <span class='const'>DEFAULT_PREFIX</span>
1476
- <span class='ivar'>@default_short_prefix</span> <span class='op'>=</span> <span class='const'>DEFAULT_SHORT_PREFIX</span>
1477
- <span class='id initialize_defaults'>initialize_defaults</span>
1478
- <span class='id initialize_parameters'>initialize_parameters</span>
1479
- <span class='kw'>end</span></pre>
1480
- </td>
1481
- </tr>
1482
- </table>
1483
- </div>
1484
-
1485
- <div class="method_details ">
1486
- <p class="signature " id="library_added-instance_method">
1487
-
1488
- - (<tt>Object</tt>) <strong>library_added</strong>(path_or_paths) <span class="extras">(protected)</span>
1489
-
1490
-
1491
-
1492
- </p><div class="docstring">
1493
- <div class="discussion">
1494
-
1495
- <p>This method will generally be overridden by subclasses and they can do
1496
- whatever customization is necessary for a particular library type.</p>
1497
-
1498
- <p>It's important to note that this value can be a String path to a file (or
1499
- folder), or it can be an Array of paths to files (or folders).</p>
1500
-
1501
-
1502
- </div>
1503
- </div>
1504
- <div class="tags">
1505
-
1506
- </div><table class="source_code">
1507
- <tr>
1508
- <td>
1509
- <pre class="lines">
1510
-
1511
-
1512
- 438
1513
- 439</pre>
1514
- </td>
1515
- <td>
1516
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 438</span>
1517
-
1518
- <span class='kw'>def</span> <span class='id library_added'>library_added</span> <span class='id path_or_paths'>path_or_paths</span>
1519
- <span class='kw'>end</span></pre>
1520
- </td>
1521
- </tr>
1522
- </table>
1523
- </div>
1524
-
1525
- <div class="method_details ">
1526
- <p class="signature " id="parse!-instance_method">
1527
-
1528
- - (<tt>Object</tt>) <strong>parse!</strong>(commandline_options)
1529
-
1530
-
1531
-
1532
- </p><table class="source_code">
1533
- <tr>
1534
- <td>
1535
- <pre class="lines">
1536
-
1537
-
1538
- 269
1539
- 270
1540
- 271
1541
- 272
1542
- 273
1543
- 274
1544
- 275
1545
- 276
1546
- 277</pre>
1547
- </td>
1548
- <td>
1549
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 269</span>
1550
-
1551
- <span class='kw'>def</span> <span class='id parse!'>parse!</span> <span class='id commandline_options'>commandline_options</span>
1552
- <span class='kw'>begin</span>
1553
- <span class='id option_parser'>option_parser</span><span class='period'>.</span><span class='id parse!'>parse!</span> <span class='id commandline_options'>commandline_options</span>
1554
- <span class='id parse_extra_options!'>parse_extra_options!</span> <span class='id commandline_options'>commandline_options</span>
1555
- <span class='id validate'>validate</span> <span class='kw'>unless</span> <span class='id help_requested?'>help_requested?</span> <span class='id commandline_options'>commandline_options</span>
1556
- <span class='kw'>rescue</span> <span class='const'>StandardError</span> <span class='op'>=&gt;</span> <span class='id e'>e</span>
1557
- <span class='id handle_parse_error'>handle_parse_error</span> <span class='id e'>e</span>
1558
- <span class='kw'>end</span>
1559
- <span class='kw'>end</span></pre>
1560
- </td>
1561
- </tr>
1562
- </table>
1563
- </div>
1564
-
1565
- <div class="method_details ">
1566
- <p class="signature " id="parse_extra_options!-instance_method">
1567
-
1568
- - (<tt>Object</tt>) <strong>parse_extra_options!</strong>(options) <span class="extras">(protected)</span>
1569
-
1570
-
1571
-
1572
- </p><table class="source_code">
1573
- <tr>
1574
- <td>
1575
- <pre class="lines">
1576
-
1577
-
1578
- 419
1579
- 420
1580
- 421
1581
- 422
1582
- 423
1583
- 424
1584
- 425
1585
- 426
1586
- 427
1587
- 428</pre>
1588
- </td>
1589
- <td>
1590
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 419</span>
1591
-
1592
- <span class='kw'>def</span> <span class='id parse_extra_options!'>parse_extra_options!</span> <span class='id options'>options</span>
1593
- <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id value'>value</span><span class='op'>|</span>
1594
- <span class='id params'>params</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id param'>param</span><span class='op'>|</span>
1595
- <span class='kw'>if</span> <span class='id param'>param</span><span class='period'>.</span><span class='id hidden_name?'>hidden_name?</span>
1596
- <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id param'>param</span><span class='period'>.</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id value'>value</span>
1597
- <span class='kw'>break</span>
1598
- <span class='kw'>end</span>
1599
- <span class='kw'>end</span>
1600
- <span class='kw'>end</span>
1601
- <span class='kw'>end</span></pre>
1602
- </td>
1603
- </tr>
1604
- </table>
1605
- </div>
1606
-
1607
- <div class="method_details ">
1608
- <p class="signature " id="parse_rake_task_arg-instance_method">
1609
-
1610
- - (<tt>Object</tt>) <strong>parse_rake_task_arg</strong>(arg) <span class="extras">(protected)</span>
1611
-
1612
-
1613
-
1614
- </p><table class="source_code">
1615
- <tr>
1616
- <td>
1617
- <pre class="lines">
1618
-
1619
-
1620
- 411
1621
- 412
1622
- 413
1623
- 414
1624
- 415
1625
- 416
1626
- 417</pre>
1627
- </td>
1628
- <td>
1629
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 411</span>
1630
-
1631
- <span class='kw'>def</span> <span class='id parse_rake_task_arg'>parse_rake_task_arg</span> <span class='id arg'>arg</span>
1632
- <span class='kw'>return</span> <span class='id arg'>arg</span> <span class='kw'>if</span> <span class='id arg'>arg</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id arg'>arg</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
1633
- <span class='id arg'>arg</span><span class='period'>.</span><span class='id each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id key'>key</span><span class='comma'>,</span> <span class='id value'>value</span><span class='op'>|</span>
1634
- <span class='kw'>return</span> <span class='id key'>key</span>
1635
- <span class='kw'>end</span>
1636
- <span class='kw'>nil</span>
1637
- <span class='kw'>end</span></pre>
1638
- </td>
1639
- </tr>
1640
- </table>
1641
- </div>
1642
-
1643
- <div class="method_details ">
1644
- <p class="signature " id="prepare-instance_method">
1645
-
1646
- - (<tt>Object</tt>) <strong>prepare</strong>
1647
-
1648
-
1649
-
1650
- </p><table class="source_code">
1651
- <tr>
1652
- <td>
1653
- <pre class="lines">
1654
-
1655
-
1656
- 301
1657
- 302
1658
- 303
1659
- 304
1660
- 305</pre>
1661
- </td>
1662
- <td>
1663
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 301</span>
1664
-
1665
- <span class='kw'>def</span> <span class='id prepare'>prepare</span>
1666
- <span class='id params'>params</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id param'>param</span><span class='op'>|</span>
1667
- <span class='id param'>param</span><span class='period'>.</span><span class='id prepare'>prepare</span>
1668
- <span class='kw'>end</span>
1669
- <span class='kw'>end</span></pre>
1670
- </td>
1671
- </tr>
1672
- </table>
1673
- </div>
1674
-
1675
- <div class="method_details ">
1676
- <p class="signature " id="system_execute-instance_method">
1677
-
1678
- - (<tt>Object</tt>) <strong>system_execute</strong>(binary, params) <span class="extras">(protected)</span>
1679
-
1680
-
1681
-
1682
- </p><table class="source_code">
1683
- <tr>
1684
- <td>
1685
- <pre class="lines">
1686
-
1687
-
1688
- 441
1689
- 442
1690
- 443</pre>
1691
- </td>
1692
- <td>
1693
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 441</span>
1694
-
1695
- <span class='kw'>def</span> <span class='id system_execute'>system_execute</span> <span class='id binary'>binary</span><span class='comma'>,</span> <span class='id params'>params</span>
1696
- <span class='const'>Sprout</span><span class='period'>.</span><span class='id current_system'>current_system</span><span class='period'>.</span><span class='id execute'>execute</span> <span class='id binary'>binary</span><span class='comma'>,</span> <span class='id params'>params</span>
1697
- <span class='kw'>end</span></pre>
1698
- </td>
1699
- </tr>
1700
- </table>
1701
- </div>
1702
-
1703
- <div class="method_details ">
1704
- <p class="signature " id="to_hash-instance_method">
1705
-
1706
- - (<tt>Object</tt>) <strong>to_hash</strong>
1707
-
1708
-
1709
-
1710
- </p><div class="docstring">
1711
- <div class="discussion">
1712
-
1713
- <p>This will create a hash of ONLY values that are created using
1714
- <tt>add_param</tt>, properties that are created with attr_accessor must be
1715
- handled manually, or patches are welcome!</p>
1716
-
1717
-
1718
- </div>
1719
- </div>
1720
- <div class="tags">
1721
-
1722
- </div><table class="source_code">
1723
- <tr>
1724
- <td>
1725
- <pre class="lines">
1726
-
1727
-
1728
- 333
1729
- 334
1730
- 335
1731
- 336
1732
- 337
1733
- 338
1734
- 339</pre>
1735
- </td>
1736
- <td>
1737
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 333</span>
1738
-
1739
- <span class='kw'>def</span> <span class='id to_hash'>to_hash</span>
1740
- <span class='id result'>result</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1741
- <span class='id params'>params</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id param'>param</span><span class='op'>|</span>
1742
- <span class='id result'>result</span><span class='lbracket'>[</span><span class='id param'>param</span><span class='period'>.</span><span class='id name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id param'>param</span><span class='period'>.</span><span class='id name'>name</span><span class='rparen'>)</span>
1743
- <span class='kw'>end</span>
1744
- <span class='id result'>result</span>
1745
- <span class='kw'>end</span></pre>
1746
- </td>
1747
- </tr>
1748
- </table>
1749
- </div>
1750
-
1751
- <div class="method_details ">
1752
- <p class="signature " id="to_help-instance_method">
1753
-
1754
- - (<tt>Object</tt>) <strong>to_help</strong>
1755
-
1756
-
1757
-
1758
- </p><table class="source_code">
1759
- <tr>
1760
- <td>
1761
- <pre class="lines">
1762
-
1763
-
1764
- 354
1765
- 355
1766
- 356</pre>
1767
- </td>
1768
- <td>
1769
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 354</span>
1770
-
1771
- <span class='kw'>def</span> <span class='id to_help'>to_help</span>
1772
- <span class='id option_parser'>option_parser</span><span class='period'>.</span><span class='id to_s'>to_s</span>
1773
- <span class='kw'>end</span></pre>
1774
- </td>
1775
- </tr>
1776
- </table>
1777
- </div>
1778
-
1779
- <div class="method_details ">
1780
- <p class="signature " id="to_rake-instance_method">
1781
-
1782
- - (<tt>Object</tt>) <strong>to_rake</strong>(*args) {|_self| ... }
1783
-
1784
-
1785
-
1786
- </p><div class="docstring">
1787
- <div class="discussion">
1788
-
1789
-
1790
- </div>
1791
- </div>
1792
- <div class="tags">
1793
- <h3>Yields:</h3>
1794
- <ul class="yield">
1795
-
1796
- <li>
1797
-
1798
- <span class='type'>(<tt>_self</tt>)</span>
1799
-
1800
-
1801
-
1802
-
1803
- </li>
1804
-
1805
- </ul>
1806
- <h3>Yield Parameters:</h3>
1807
- <ul class="yieldparam">
1808
-
1809
- <li>
1810
-
1811
- <span class='type'>(<tt><span class='object_link'><a href="" title="Sprout::Executable::InstanceMethods (module)">Sprout::Executable::InstanceMethods</a></span></tt>)</span>
1812
-
1813
-
1814
- <span class='name'>_self</span>
1815
-
1816
-
1817
-
1818
- &mdash;
1819
- <div class='inline'>
1820
- <p>the object that the method was called on</p>
1821
- </div>
1822
-
1823
- </li>
1824
-
1825
- </ul>
1826
-
1827
- </div><table class="source_code">
1828
- <tr>
1829
- <td>
1830
- <pre class="lines">
1831
-
1832
-
1833
- 307
1834
- 308
1835
- 309
1836
- 310
1837
- 311
1838
- 312
1839
- 313
1840
- 314
1841
- 315
1842
- 316
1843
- 317
1844
- 318
1845
- 319
1846
- 320
1847
- 321
1848
- 322
1849
- 323
1850
- 324
1851
- 325
1852
- 326
1853
- 327</pre>
1854
- </td>
1855
- <td>
1856
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 307</span>
1857
-
1858
- <span class='kw'>def</span> <span class='id to_rake'>to_rake</span> <span class='op'>*</span><span class='id args'>args</span>
1859
- <span class='comment'># Define the file task first - so that
1860
- </span> <span class='comment'># desc blocks hook up to it...
1861
- </span> <span class='id outer_task'>outer_task</span> <span class='op'>=</span> <span class='id create_outer_task'>create_outer_task</span> <span class='op'>*</span><span class='id args'>args</span>
1862
- <span class='id update_rake_task_name_from_args'>update_rake_task_name_from_args</span> <span class='op'>*</span><span class='id args'>args</span>
1863
- <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
1864
- <span class='id prepare'>prepare</span>
1865
-
1866
- <span class='comment'># TODO: Tried auto-updating with library
1867
- </span> <span class='comment'># prerequisites, but this led to strange
1868
- </span> <span class='comment'># behavior with multiple registrations.
1869
- </span> <span class='id handle_library_prerequisites'>handle_library_prerequisites</span> <span class='id outer_task'>outer_task</span><span class='period'>.</span><span class='id prerequisites'>prerequisites</span>
1870
-
1871
- <span class='comment'># Add the library resolution rake task
1872
- </span> <span class='comment'># as a prerequisite
1873
- </span> <span class='id outer_task'>outer_task</span><span class='period'>.</span><span class='id prerequisites'>prerequisites</span> <span class='op'>&lt;&lt;</span> <span class='id task'>task</span><span class='lparen'>(</span><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Library</span><span class='op'>::</span><span class='const'>TASK_NAME</span><span class='rparen'>)</span>
1874
- <span class='id prerequisites'>prerequisites</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id prereq'>prereq</span><span class='op'>|</span>
1875
- <span class='id outer_task'>outer_task</span><span class='period'>.</span><span class='id prerequisites'>prerequisites</span> <span class='op'>&lt;&lt;</span> <span class='id prereq'>prereq</span>
1876
- <span class='kw'>end</span>
1877
- <span class='id outer_task'>outer_task</span>
1878
- <span class='kw'>end</span></pre>
1879
- </td>
1880
- </tr>
1881
- </table>
1882
- </div>
1883
-
1884
- <div class="method_details ">
1885
- <p class="signature " id="to_shell-instance_method">
1886
-
1887
- - (<tt>Object</tt>) <strong>to_shell</strong>
1888
-
1889
-
1890
-
1891
- </p><div class="docstring">
1892
- <div class="discussion">
1893
-
1894
- <p>Create a string that represents this configured executable for shell
1895
- execution</p>
1896
-
1897
-
1898
- </div>
1899
- </div>
1900
- <div class="tags">
1901
-
1902
- </div><table class="source_code">
1903
- <tr>
1904
- <td>
1905
- <pre class="lines">
1906
-
1907
-
1908
- 359
1909
- 360
1910
- 361
1911
- 362
1912
- 363
1913
- 364
1914
- 365
1915
- 366
1916
- 367
1917
- 368
1918
- 369
1919
- 370
1920
- 371</pre>
1921
- </td>
1922
- <td>
1923
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 359</span>
1924
-
1925
- <span class='kw'>def</span> <span class='id to_shell'>to_shell</span>
1926
- <span class='kw'>return</span> <span class='ivar'>@to_shell_proc</span><span class='period'>.</span><span class='id call'>call</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@to_shell_proc</span><span class='period'>.</span><span class='id nil?'>nil?</span>
1927
-
1928
- <span class='id result'>result</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1929
- <span class='id result'>result</span> <span class='op'>&lt;&lt;</span> <span class='ivar'>@prepended_args</span> <span class='kw'>unless</span> <span class='ivar'>@prepended_args</span><span class='period'>.</span><span class='id nil?'>nil?</span>
1930
- <span class='id params'>params</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id param'>param</span><span class='op'>|</span>
1931
- <span class='kw'>if</span><span class='lparen'>(</span><span class='id param'>param</span><span class='period'>.</span><span class='id visible?'>visible?</span><span class='rparen'>)</span>
1932
- <span class='id result'>result</span> <span class='op'>&lt;&lt;</span> <span class='id param'>param</span><span class='period'>.</span><span class='id to_shell'>to_shell</span>
1933
- <span class='kw'>end</span>
1934
- <span class='kw'>end</span>
1935
- <span class='id result'>result</span> <span class='op'>&lt;&lt;</span> <span class='ivar'>@appended_args</span> <span class='kw'>unless</span> <span class='ivar'>@appended_args</span><span class='period'>.</span><span class='id nil?'>nil?</span>
1936
- <span class='kw'>return</span> <span class='id result'>result</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
1937
- <span class='kw'>end</span></pre>
1938
- </td>
1939
- </tr>
1940
- </table>
1941
- </div>
1942
-
1943
- <div class="method_details ">
1944
- <p class="signature " id="update_rake_task_name_from_args-instance_method">
1945
-
1946
- - (<tt>Object</tt>) <strong>update_rake_task_name_from_args</strong>(*args) <span class="extras">(protected)</span>
1947
-
1948
-
1949
-
1950
- </p><div class="docstring">
1951
- <div class="discussion">
1952
-
1953
- <p>This method will add the current task to the Rake CLEAN collection.</p>
1954
-
1955
- <p>Any Executable that does not create a Rake::File task should also override
1956
- this method and prevent it from calling <tt>CLEAN.add</tt>.</p>
1957
-
1958
-
1959
- </div>
1960
- </div>
1961
- <div class="tags">
1962
-
1963
- <h3>See Also:</h3>
1964
- <ul class="see">
1965
-
1966
- <li>create_outer_task</li>
1967
-
1968
- </ul>
1969
-
1970
- </div><table class="source_code">
1971
- <tr>
1972
- <td>
1973
- <pre class="lines">
1974
-
1975
-
1976
- 405
1977
- 406
1978
- 407
1979
- 408
1980
- 409</pre>
1981
- </td>
1982
- <td>
1983
- <pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 405</span>
1984
-
1985
- <span class='kw'>def</span> <span class='id update_rake_task_name_from_args'>update_rake_task_name_from_args</span> <span class='op'>*</span><span class='id args'>args</span>
1986
- <span class='kw'>self</span><span class='period'>.</span><span class='id rake_task_name'>rake_task_name</span> <span class='op'>=</span> <span class='id parse_rake_task_arg'>parse_rake_task_arg</span> <span class='id args'>args</span><span class='period'>.</span><span class='id last'>last</span>
1987
- <span class='const'>CLEAN</span><span class='period'>.</span><span class='id add'>add</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id rake_task_name'>rake_task_name</span><span class='rparen'>)</span>
1988
- <span class='kw'>self</span><span class='period'>.</span><span class='id rake_task_name'>rake_task_name</span>
1989
- <span class='kw'>end</span></pre>
1990
- </td>
1991
- </tr>
1992
- </table>
1993
- </div>
1994
-
1995
- </div>
1996
-
1997
- </div>
1998
-
1999
- <div id="footer">
2000
- Generated on Wed Dec 22 11:58:34 2010 by
2001
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2002
- 0.6.3 (ruby-1.9.2).
2003
- </div>
2004
-
2005
- </body>
2006
- </html>