sprout 1.0.32.pre → 1.0.35.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 (208) hide show
  1. data/Gemfile +2 -1
  2. data/Gemfile.lock +4 -2
  3. data/README.textile +12 -13
  4. data/VERSION +1 -0
  5. data/doc/Dir.html +288 -0
  6. data/doc/Rake/Task.html +184 -0
  7. data/doc/Sprout.html +144 -0
  8. data/doc/Sprout/ArchiveUnpacker.html +1246 -0
  9. data/doc/Sprout/Base.html +126 -0
  10. data/doc/Sprout/Base/ClassMethods.html +434 -0
  11. data/doc/Sprout/Concern.html +353 -0
  12. data/doc/Sprout/Daemon.html +166 -0
  13. data/doc/Sprout/Daemon/ClassMethods.html +244 -0
  14. data/doc/Sprout/Daemon/InstanceMethods.html +601 -0
  15. data/doc/Sprout/Errors.html +101 -0
  16. data/doc/Sprout/Errors/ArchiveUnpackerError.html +125 -0
  17. data/doc/Sprout/Errors/DestinationExistsError.html +133 -0
  18. data/doc/Sprout/Errors/DuplicateMemberError.html +132 -0
  19. data/doc/Sprout/Errors/ExecutableError.html +125 -0
  20. data/doc/Sprout/Errors/ExecutableRegistrationError.html +132 -0
  21. data/doc/Sprout/Errors/ExecutionError.html +121 -0
  22. data/doc/Sprout/Errors/GeneratorError.html +125 -0
  23. data/doc/Sprout/Errors/InvalidArgumentError.html +132 -0
  24. data/doc/Sprout/Errors/LoadError.html +121 -0
  25. data/doc/Sprout/Errors/MissingArgumentError.html +132 -0
  26. data/doc/Sprout/Errors/MissingExecutableError.html +132 -0
  27. data/doc/Sprout/Errors/MissingGeneratorError.html +132 -0
  28. data/doc/Sprout/Errors/MissingTemplateError.html +132 -0
  29. data/doc/Sprout/Errors/ProcessRunnerError.html +121 -0
  30. data/doc/Sprout/Errors/RemoteFileLoaderError.html +110 -0
  31. data/doc/Sprout/Errors/SproutError.html +114 -0
  32. data/doc/Sprout/Errors/UnknownArchiveType.html +122 -0
  33. data/doc/Sprout/Errors/UsageError.html +121 -0
  34. data/doc/Sprout/Errors/ValidationError.html +121 -0
  35. data/doc/Sprout/Errors/VersionRequirementNotMetError.html +121 -0
  36. data/doc/Sprout/Executable.html +173 -0
  37. data/doc/Sprout/Executable/Boolean.html +483 -0
  38. data/doc/Sprout/Executable/ClassMethods.html +417 -0
  39. data/doc/Sprout/Executable/CollectionParam.html +483 -0
  40. data/doc/Sprout/Executable/FileParam.html +484 -0
  41. data/doc/Sprout/Executable/Files.html +292 -0
  42. data/doc/Sprout/Executable/InstanceMethods.html +2006 -0
  43. data/doc/Sprout/Executable/Number.html +141 -0
  44. data/doc/Sprout/Executable/Param.html +2818 -0
  45. data/doc/Sprout/Executable/ParameterFactory.html +232 -0
  46. data/doc/Sprout/Executable/Path.html +223 -0
  47. data/doc/Sprout/Executable/Paths.html +253 -0
  48. data/doc/Sprout/Executable/StringParam.html +213 -0
  49. data/doc/Sprout/Executable/Strings.html +167 -0
  50. data/doc/Sprout/Executable/Url.html +160 -0
  51. data/doc/Sprout/Executable/Urls.html +170 -0
  52. data/doc/Sprout/FileTarget.html +1109 -0
  53. data/doc/Sprout/Generator.html +689 -0
  54. data/doc/Sprout/Generator/Base.html +1626 -0
  55. data/doc/Sprout/Generator/Command.html +690 -0
  56. data/doc/Sprout/Generator/DirectoryManifest.html +476 -0
  57. data/doc/Sprout/Generator/FileManifest.html +572 -0
  58. data/doc/Sprout/Generator/Manifest.html +377 -0
  59. data/doc/Sprout/Generator/TemplateManifest.html +196 -0
  60. data/doc/Sprout/GeneratorGenerator.html +1018 -0
  61. data/doc/Sprout/Library.html +1141 -0
  62. data/doc/Sprout/LibraryGenerator.html +309 -0
  63. data/doc/Sprout/Log.html +496 -0
  64. data/doc/Sprout/MXMLC.html +6373 -0
  65. data/doc/Sprout/Platform.html +714 -0
  66. data/doc/Sprout/ProcessRunner.html +1352 -0
  67. data/doc/Sprout/ProgressBar.html +376 -0
  68. data/doc/Sprout/ProgressBarImpl.html +2119 -0
  69. data/doc/Sprout/ProgressBarManager.html +434 -0
  70. data/doc/Sprout/ProgressBarOutputStream.html +416 -0
  71. data/doc/Sprout/RDocParser.html +211 -0
  72. data/doc/Sprout/RemoteFileLoader.html +172 -0
  73. data/doc/Sprout/RemoteFileTarget.html +679 -0
  74. data/doc/Sprout/ReversedProgressBar.html +194 -0
  75. data/doc/Sprout/RubyFeature.html +155 -0
  76. data/doc/Sprout/RubyFeature/ClassMethods.html +1065 -0
  77. data/doc/Sprout/RubyGenerator.html +764 -0
  78. data/doc/Sprout/Specification.html +767 -0
  79. data/doc/Sprout/System.html +191 -0
  80. data/doc/Sprout/System/BaseSystem.html +1455 -0
  81. data/doc/Sprout/System/JavaSystem.html +122 -0
  82. data/doc/Sprout/System/OSXSystem.html +335 -0
  83. data/doc/Sprout/System/ThreadMock.html +193 -0
  84. data/doc/Sprout/System/UnixSystem.html +584 -0
  85. data/doc/Sprout/System/VistaSystem.html +251 -0
  86. data/doc/Sprout/System/WinNixSystem.html +325 -0
  87. data/doc/Sprout/System/WinSystem.html +571 -0
  88. data/doc/Sprout/ToolGenerator.html +931 -0
  89. data/doc/Sprout/VERSION.html +128 -0
  90. data/doc/SproutTestCase.html +1412 -0
  91. data/doc/String.html +286 -0
  92. data/doc/_index.html +1035 -0
  93. data/doc/class_list.html +36 -0
  94. data/doc/css/common.css +1 -0
  95. data/doc/css/full_list.css +53 -0
  96. data/doc/css/style.css +310 -0
  97. data/doc/file.README.html +96 -0
  98. data/doc/file.archive_unpacker.html +288 -0
  99. data/doc/file.base.html +208 -0
  100. data/doc/file.base_system.html +278 -0
  101. data/doc/file.boolean.html +135 -0
  102. data/doc/file.collection_param.html +139 -0
  103. data/doc/file.command.html +126 -0
  104. data/doc/file.concern.html +136 -0
  105. data/doc/file.daemon.html +309 -0
  106. data/doc/file.dir.html +76 -0
  107. data/doc/file.directory_manifest.html +122 -0
  108. data/doc/file.errors.html +147 -0
  109. data/doc/file.executable.html +638 -0
  110. data/doc/file.file_manifest.html +109 -0
  111. data/doc/file.file_param.html +120 -0
  112. data/doc/file.file_target.html +140 -0
  113. data/doc/file.files.html +85 -0
  114. data/doc/file.generator.html +296 -0
  115. data/doc/file.generator_class.html +72 -0
  116. data/doc/file.generator_generator.html +137 -0
  117. data/doc/file.generator_test.html +92 -0
  118. data/doc/file.generator_test_helper.html +67 -0
  119. data/doc/file.java_system.html +62 -0
  120. data/doc/file.library.html +291 -0
  121. data/doc/file.library_generator.html +74 -0
  122. data/doc/file.log.html +100 -0
  123. data/doc/file.manifest.html +67 -0
  124. data/doc/file.mxmlc.html +740 -0
  125. data/doc/file.number.html +67 -0
  126. data/doc/file.osx_system.html +79 -0
  127. data/doc/file.param.html +491 -0
  128. data/doc/file.parameter_factory.html +119 -0
  129. data/doc/file.path.html +81 -0
  130. data/doc/file.paths.html +80 -0
  131. data/doc/file.platform.html +124 -0
  132. data/doc/file.process_runner.html +224 -0
  133. data/doc/file.progress_bar.html +390 -0
  134. data/doc/file.rdoc_parser.html +145 -0
  135. data/doc/file.remote_file_loader.html +117 -0
  136. data/doc/file.remote_file_target.html +176 -0
  137. data/doc/file.ruby_base.html +64 -0
  138. data/doc/file.ruby_feature.html +244 -0
  139. data/doc/file.ruby_generator.html +118 -0
  140. data/doc/file.ruby_input.html +62 -0
  141. data/doc/file.ruby_test_case.html +78 -0
  142. data/doc/file.ruby_test_helper.html +61 -0
  143. data/doc/file.specification.html +248 -0
  144. data/doc/file.sprout.html +64 -0
  145. data/doc/file.sprout_test_case.html +280 -0
  146. data/doc/file.string.html +72 -0
  147. data/doc/file.string_param.html +76 -0
  148. data/doc/file.strings.html +71 -0
  149. data/doc/file.system.html +86 -0
  150. data/doc/file.template_manifest.html +67 -0
  151. data/doc/file.tool.html +92 -0
  152. data/doc/file.tool_generator.html +90 -0
  153. data/doc/file.unix_system.html +128 -0
  154. data/doc/file.url.html +71 -0
  155. data/doc/file.urls.html +70 -0
  156. data/doc/file.version.html +71 -0
  157. data/doc/file.vista_system.html +69 -0
  158. data/doc/file.win_nix_system.html +88 -0
  159. data/doc/file.win_system.html +129 -0
  160. data/doc/file_list.html +230 -0
  161. data/doc/frames.html +13 -0
  162. data/doc/index.html +96 -0
  163. data/doc/js/app.js +202 -0
  164. data/doc/js/full_list.js +149 -0
  165. data/doc/js/jquery.js +154 -0
  166. data/doc/method_list.html +3355 -0
  167. data/doc/top-level-namespace.html +192 -0
  168. data/lib/sprout/archive_unpacker.rb +203 -137
  169. data/lib/sprout/base.rb +38 -11
  170. data/lib/sprout/concern.rb +51 -0
  171. data/lib/sprout/daemon.rb +256 -0
  172. data/lib/sprout/executable.rb +40 -11
  173. data/lib/sprout/executable/boolean.rb +47 -1
  174. data/lib/sprout/executable/collection_param.rb +33 -1
  175. data/lib/sprout/executable/file_param.rb +16 -3
  176. data/lib/sprout/executable/files.rb +5 -0
  177. data/lib/sprout/executable/number.rb +5 -1
  178. data/lib/sprout/executable/param.rb +232 -16
  179. data/lib/sprout/executable/parameter_factory.rb +39 -1
  180. data/lib/sprout/executable/path.rb +7 -1
  181. data/lib/sprout/executable/paths.rb +6 -1
  182. data/lib/sprout/executable/string_param.rb +8 -1
  183. data/lib/sprout/executable/strings.rb +7 -1
  184. data/lib/sprout/executable/url.rb +8 -1
  185. data/lib/sprout/executable/urls.rb +7 -1
  186. data/lib/sprout/file_target.rb +11 -11
  187. data/lib/sprout/generator.rb +244 -0
  188. data/lib/sprout/generator/base.rb +0 -94
  189. data/lib/sprout/generators/generator/generator_generator.rb +35 -1
  190. data/lib/sprout/generators/generator/templates/generator_class.rb +3 -3
  191. data/lib/sprout/library.rb +75 -0
  192. data/lib/sprout/log.rb +11 -12
  193. data/lib/sprout/process_runner.rb +29 -9
  194. data/lib/sprout/remote_file_target.rb +20 -9
  195. data/lib/sprout/system/base_system.rb +11 -3
  196. data/lib/sprout/test/sprout_test_case.rb +1 -0
  197. data/lib/sprout/version.rb +7 -11
  198. data/rakefile.rb +7 -12
  199. data/script/add_param_handler.rb +43 -0
  200. data/sprout.gemspec +2 -3
  201. data/test/fixtures/executable/fdb.rb +764 -0
  202. data/test/fixtures/executable/flex3sdk_gem/fdb +60 -0
  203. data/test/fixtures/executable/mxmlc.rb +9 -11
  204. data/test/unit/daemon_test.rb +61 -0
  205. data/test/unit/process_runner_test.rb +21 -0
  206. data/test/unit/remote_file_target_test.rb +45 -11
  207. data/test/unit/sprout_test_helper.rb +1 -1
  208. metadata +210 -29
@@ -0,0 +1,1018 @@
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>Class: Sprout::GeneratorGenerator</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 (G)</a> &raquo;
27
+ <span class='title'><span class='object_link'><a href="../Sprout.html" title="Sprout (module)">Sprout</a></span></span>
28
+ &raquo;
29
+ <span class="title">GeneratorGenerator</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>Class: Sprout::GeneratorGenerator
47
+
48
+
49
+
50
+ </h1>
51
+
52
+ <dl class="box">
53
+
54
+ <dt class="r1">Inherits:</dt>
55
+ <dd class="r1">
56
+ <span class="inheritName"><span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Sprout::Generator::Base</a></span></span>
57
+
58
+ <ul class="fullTree">
59
+ <li>Object</li>
60
+
61
+ <li class="next"><span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Sprout::Generator::Base</a></span></li>
62
+
63
+ <li class="next">Sprout::GeneratorGenerator</li>
64
+
65
+ </ul>
66
+ <a href="#" class="inheritanceTree">show all</a>
67
+
68
+ </dd>
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/sprout/generators/generator/generator_generator.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+
85
+ <h2>Constant Summary</h2>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <h3 class="inherited">Constants included from <span class='object_link'><a href="Executable.html" title="Sprout::Executable (module)">Executable</a></span></h3>
98
+ <p class="inherited"><span class='object_link'><a href="Executable.html#DEFAULT_FILE_EXPRESSION-constant" title="Sprout::Executable::DEFAULT_FILE_EXPRESSION (constant)">DEFAULT_FILE_EXPRESSION</a></span>, <span class='object_link'><a href="Executable.html#DEFAULT_PREFIX-constant" title="Sprout::Executable::DEFAULT_PREFIX (constant)">DEFAULT_PREFIX</a></span>, <span class='object_link'><a href="Executable.html#DEFAULT_SHORT_PREFIX-constant" title="Sprout::Executable::DEFAULT_SHORT_PREFIX (constant)">DEFAULT_SHORT_PREFIX</a></span></p>
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#bin-instance_method" title="#bin (instance method)">- (String) <strong>bin</strong> </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <span class="summary_desc"><div class='inline'>
131
+ <p>The name of the folder where binary or executable artifacts should be
132
+ created by compiler tasks.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#extension-instance_method" title="#extension (instance method)">- (String) <strong>extension</strong> </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+ <span class="summary_desc"><div class='inline'>
158
+ <p>The default (primary) file extension for generated source files.</p>
159
+ </div></span>
160
+
161
+ </li>
162
+
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#fixtures-instance_method" title="#fixtures (instance method)">- (String) <strong>fixtures</strong> </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'>
184
+ <p>The name of the child folder of the test folder where fixtures should be
185
+ generated.</p>
186
+ </div></span>
187
+
188
+ </li>
189
+
190
+
191
+ <li class="public ">
192
+ <span class="summary_signature">
193
+
194
+ <a href="#generators-instance_method" title="#generators (instance method)">- (String) <strong>generators</strong> </a>
195
+
196
+
197
+
198
+ </span>
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>The name of the folder where custom generators and templates will be found.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#lib-instance_method" title="#lib (instance method)">- (String) <strong>lib</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+ <span class="summary_desc"><div class='inline'>
237
+ <p>The name of the folder where external libraries will be installed.</p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#namespace-instance_method" title="#namespace (instance method)">- (String) <strong>namespace</strong> </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'>
263
+ <p>The default module that classes will be added to.</p>
264
+ </div></span>
265
+
266
+ </li>
267
+
268
+
269
+ <li class="public ">
270
+ <span class="summary_signature">
271
+
272
+ <a href="#test-instance_method" title="#test (instance method)">- (String) <strong>test</strong> </a>
273
+
274
+
275
+
276
+ </span>
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ <span class="summary_desc"><div class='inline'>
289
+ <p>The name of the folder where tests should be generated.</p>
290
+ </div></span>
291
+
292
+ </li>
293
+
294
+
295
+ <li class="public ">
296
+ <span class="summary_signature">
297
+
298
+ <a href="#unit-instance_method" title="#unit (instance method)">- (String) <strong>unit</strong> </a>
299
+
300
+
301
+
302
+ </span>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+ <span class="summary_desc"><div class='inline'>
315
+ <p>The name of the child folder of the test folder where unit tests should be
316
+ generated.</p>
317
+ </div></span>
318
+
319
+ </li>
320
+
321
+
322
+ <li class="public ">
323
+ <span class="summary_signature">
324
+
325
+ <a href="#vendor-instance_method" title="#vendor (instance method)">- (String) <strong>vendor</strong> </a>
326
+
327
+
328
+
329
+ </span>
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <span class="summary_desc"><div class='inline'>
342
+ <p>The name of the folder where external source code should be placed.</p>
343
+ </div></span>
344
+
345
+ </li>
346
+
347
+
348
+ </ul>
349
+
350
+
351
+
352
+ <h2>
353
+ Instance Method Summary
354
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
355
+ </h2>
356
+
357
+ <ul class="summary">
358
+
359
+ <li class="public ">
360
+ <span class="summary_signature">
361
+
362
+ <a href="#manifest-instance_method" title="#manifest (instance method)">- (Object) <strong>manifest</strong> </a>
363
+
364
+
365
+
366
+ </span>
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+ <span class="summary_desc"><div class='inline'></div></span>
376
+
377
+ </li>
378
+
379
+
380
+ </ul>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Sprout::Generator::Base</a></span></h3>
392
+ <p class="inherited"><span class='object_link'><a href="Generator/Base.html#default_search_paths-instance_method" title="Sprout::Generator::Base#default_search_paths (method)">#default_search_paths</a></span>, <span class='object_link'><a href="Generator/Base.html#directory-instance_method" title="Sprout::Generator::Base#directory (method)">#directory</a></span>, <span class='object_link'><a href="Generator/Base.html#execute-instance_method" title="Sprout::Generator::Base#execute (method)">#execute</a></span>, <span class='object_link'><a href="Generator/Base.html#file-instance_method" title="Sprout::Generator::Base#file (method)">#file</a></span>, <span class='object_link'><a href="Generator/Base.html#generator-instance_method" title="Sprout::Generator::Base#generator (method)">#generator</a></span>, <span class='object_link'><a href="Generator/Base.html#inherited-class_method" title="Sprout::Generator::Base.inherited (method)">inherited</a></span>, <span class='object_link'><a href="Generator/Base.html#prepare_command-instance_method" title="Sprout::Generator::Base#prepare_command (method)">#prepare_command</a></span>, <span class='object_link'><a href="Generator/Base.html#resolve_template-instance_method" title="Sprout::Generator::Base#resolve_template (method)">#resolve_template</a></span>, <span class='object_link'><a href="Generator/Base.html#say-instance_method" title="Sprout::Generator::Base#say (method)">#say</a></span>, <span class='object_link'><a href="Generator/Base.html#template-instance_method" title="Sprout::Generator::Base#template (method)">#template</a></span>, <span class='object_link'><a href="Generator/Base.html#template_paths-instance_method" title="Sprout::Generator::Base#template_paths (method)">#template_paths</a></span>, <span class='object_link'><a href="Generator/Base.html#unexecute-instance_method" title="Sprout::Generator::Base#unexecute (method)">#unexecute</a></span></p>
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concern.html" title="Sprout::Concern (module)">Concern</a></span></h3>
407
+ <p class="inherited"><span class='object_link'><a href="Concern.html#append_features-instance_method" title="Sprout::Concern#append_features (method)">#append_features</a></span>, <span class='object_link'><a href="Concern.html#extended-class_method" title="Sprout::Concern.extended (method)">extended</a></span>, <span class='object_link'><a href="Concern.html#included-instance_method" title="Sprout::Concern#included (method)">#included</a></span></p>
408
+
409
+
410
+
411
+
412
+
413
+
414
+ <div id="instance_attr_details" class="attr_details">
415
+ <h2>Instance Attribute Details</h2>
416
+
417
+
418
+ <span id="bin=-instance_method"></span>
419
+ <span id="bin-instance_method"></span>
420
+ <div class="method_details first">
421
+ <p class="signature first" id="bin-instance_method">
422
+
423
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>bin</strong>
424
+
425
+
426
+
427
+ </p><div class="docstring">
428
+ <div class="discussion">
429
+
430
+ <p>The name of the folder where binary or executable artifacts should be
431
+ created by compiler tasks.</p>
432
+
433
+
434
+ </div>
435
+ </div>
436
+ <div class="tags">
437
+ <h3>Returns:</h3>
438
+ <ul class="return">
439
+
440
+ <li>
441
+
442
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
443
+
444
+
445
+
446
+
447
+ &mdash;
448
+ <div class='inline'>
449
+ <p>An instance of String</p>
450
+ </div>
451
+
452
+ </li>
453
+
454
+ </ul>
455
+
456
+ </div><table class="source_code">
457
+ <tr>
458
+ <td>
459
+ <pre class="lines">
460
+
461
+
462
+ </pre>
463
+ </td>
464
+ <td>
465
+ <pre class="code"><span class="info file"># File ''</span>
466
+
467
+ <span class='id add_param'>add_param</span> <span class='symbol'>:bin</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bin</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
468
+ </td>
469
+ </tr>
470
+ </table>
471
+ </div>
472
+
473
+
474
+ <span id="extension=-instance_method"></span>
475
+ <span id="extension-instance_method"></span>
476
+ <div class="method_details ">
477
+ <p class="signature " id="extension-instance_method">
478
+
479
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>extension</strong>
480
+
481
+
482
+
483
+ </p><div class="docstring">
484
+ <div class="discussion">
485
+
486
+ <p>The default (primary) file extension for generated source files. This
487
+ should hint at the project type.</p>
488
+
489
+
490
+ </div>
491
+ </div>
492
+ <div class="tags">
493
+ <h3>Returns:</h3>
494
+ <ul class="return">
495
+
496
+ <li>
497
+
498
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
499
+
500
+
501
+
502
+
503
+ &mdash;
504
+ <div class='inline'>
505
+ <p>An instance of String</p>
506
+ </div>
507
+
508
+ </li>
509
+
510
+ </ul>
511
+
512
+ </div><table class="source_code">
513
+ <tr>
514
+ <td>
515
+ <pre class="lines">
516
+
517
+
518
+ </pre>
519
+ </td>
520
+ <td>
521
+ <pre class="code"><span class="info file"># File ''</span>
522
+
523
+ <span class='id add_param'>add_param</span> <span class='symbol'>:extension</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.as</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
524
+ </td>
525
+ </tr>
526
+ </table>
527
+ </div>
528
+
529
+
530
+ <span id="fixtures=-instance_method"></span>
531
+ <span id="fixtures-instance_method"></span>
532
+ <div class="method_details ">
533
+ <p class="signature " id="fixtures-instance_method">
534
+
535
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>fixtures</strong>
536
+
537
+
538
+
539
+ </p><div class="docstring">
540
+ <div class="discussion">
541
+
542
+ <p>The name of the child folder of the test folder where fixtures should be
543
+ generated.</p>
544
+
545
+
546
+ </div>
547
+ </div>
548
+ <div class="tags">
549
+ <h3>Returns:</h3>
550
+ <ul class="return">
551
+
552
+ <li>
553
+
554
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
555
+
556
+
557
+
558
+
559
+ &mdash;
560
+ <div class='inline'>
561
+ <p>An instance of String</p>
562
+ </div>
563
+
564
+ </li>
565
+
566
+ </ul>
567
+
568
+ </div><table class="source_code">
569
+ <tr>
570
+ <td>
571
+ <pre class="lines">
572
+
573
+
574
+ </pre>
575
+ </td>
576
+ <td>
577
+ <pre class="code"><span class="info file"># File ''</span>
578
+
579
+ <span class='id add_param'>add_param</span> <span class='symbol'>:fixtures</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>fixtures</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
580
+ </td>
581
+ </tr>
582
+ </table>
583
+ </div>
584
+
585
+
586
+ <span id="generators=-instance_method"></span>
587
+ <span id="generators-instance_method"></span>
588
+ <div class="method_details ">
589
+ <p class="signature " id="generators-instance_method">
590
+
591
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>generators</strong>
592
+
593
+
594
+
595
+ </p><div class="docstring">
596
+ <div class="discussion">
597
+
598
+ <p>The name of the folder where custom generators and templates will be found.</p>
599
+
600
+
601
+ </div>
602
+ </div>
603
+ <div class="tags">
604
+ <h3>Returns:</h3>
605
+ <ul class="return">
606
+
607
+ <li>
608
+
609
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
610
+
611
+
612
+
613
+
614
+ &mdash;
615
+ <div class='inline'>
616
+ <p>An instance of String</p>
617
+ </div>
618
+
619
+ </li>
620
+
621
+ </ul>
622
+
623
+ </div><table class="source_code">
624
+ <tr>
625
+ <td>
626
+ <pre class="lines">
627
+
628
+
629
+ </pre>
630
+ </td>
631
+ <td>
632
+ <pre class="code"><span class="info file"># File ''</span>
633
+
634
+ <span class='id add_param'>add_param</span> <span class='symbol'>:generators</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>generators</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
635
+ </td>
636
+ </tr>
637
+ </table>
638
+ </div>
639
+
640
+
641
+ <span id="lib=-instance_method"></span>
642
+ <span id="lib-instance_method"></span>
643
+ <div class="method_details ">
644
+ <p class="signature " id="lib-instance_method">
645
+
646
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>lib</strong>
647
+
648
+
649
+
650
+ </p><div class="docstring">
651
+ <div class="discussion">
652
+
653
+ <p>The name of the folder where external libraries will be installed.</p>
654
+
655
+
656
+ </div>
657
+ </div>
658
+ <div class="tags">
659
+ <h3>Returns:</h3>
660
+ <ul class="return">
661
+
662
+ <li>
663
+
664
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
665
+
666
+
667
+
668
+
669
+ &mdash;
670
+ <div class='inline'>
671
+ <p>An instance of String</p>
672
+ </div>
673
+
674
+ </li>
675
+
676
+ </ul>
677
+
678
+ </div><table class="source_code">
679
+ <tr>
680
+ <td>
681
+ <pre class="lines">
682
+
683
+
684
+ </pre>
685
+ </td>
686
+ <td>
687
+ <pre class="code"><span class="info file"># File ''</span>
688
+
689
+ <span class='id add_param'>add_param</span> <span class='symbol'>:lib</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
690
+ </td>
691
+ </tr>
692
+ </table>
693
+ </div>
694
+
695
+
696
+ <span id="namespace=-instance_method"></span>
697
+ <span id="namespace-instance_method"></span>
698
+ <div class="method_details ">
699
+ <p class="signature " id="namespace-instance_method">
700
+
701
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>namespace</strong>
702
+
703
+
704
+
705
+ </p><div class="docstring">
706
+ <div class="discussion">
707
+
708
+ <p>The default module that classes will be added to.</p>
709
+
710
+
711
+ </div>
712
+ </div>
713
+ <div class="tags">
714
+ <h3>Returns:</h3>
715
+ <ul class="return">
716
+
717
+ <li>
718
+
719
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
720
+
721
+
722
+
723
+
724
+ &mdash;
725
+ <div class='inline'>
726
+ <p>An instance of String</p>
727
+ </div>
728
+
729
+ </li>
730
+
731
+ </ul>
732
+
733
+ </div><table class="source_code">
734
+ <tr>
735
+ <td>
736
+ <pre class="lines">
737
+
738
+
739
+ </pre>
740
+ </td>
741
+ <td>
742
+ <pre class="code"><span class="info file"># File ''</span>
743
+
744
+ <span class='id add_param'>add_param</span> <span class='symbol'>:namespace</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span></pre>
745
+ </td>
746
+ </tr>
747
+ </table>
748
+ </div>
749
+
750
+
751
+ <span id="test=-instance_method"></span>
752
+ <span id="test-instance_method"></span>
753
+ <div class="method_details ">
754
+ <p class="signature " id="test-instance_method">
755
+
756
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>test</strong>
757
+
758
+
759
+
760
+ </p><div class="docstring">
761
+ <div class="discussion">
762
+
763
+ <p>The name of the folder where tests should be generated.</p>
764
+
765
+
766
+ </div>
767
+ </div>
768
+ <div class="tags">
769
+ <h3>Returns:</h3>
770
+ <ul class="return">
771
+
772
+ <li>
773
+
774
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
775
+
776
+
777
+
778
+
779
+ &mdash;
780
+ <div class='inline'>
781
+ <p>An instance of String</p>
782
+ </div>
783
+
784
+ </li>
785
+
786
+ </ul>
787
+
788
+ </div><table class="source_code">
789
+ <tr>
790
+ <td>
791
+ <pre class="lines">
792
+
793
+
794
+ </pre>
795
+ </td>
796
+ <td>
797
+ <pre class="code"><span class="info file"># File ''</span>
798
+
799
+ <span class='id add_param'>add_param</span> <span class='symbol'>:test</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>test</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
800
+ </td>
801
+ </tr>
802
+ </table>
803
+ </div>
804
+
805
+
806
+ <span id="unit=-instance_method"></span>
807
+ <span id="unit-instance_method"></span>
808
+ <div class="method_details ">
809
+ <p class="signature " id="unit-instance_method">
810
+
811
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>unit</strong>
812
+
813
+
814
+
815
+ </p><div class="docstring">
816
+ <div class="discussion">
817
+
818
+ <p>The name of the child folder of the test folder where unit tests should be
819
+ generated.</p>
820
+
821
+
822
+ </div>
823
+ </div>
824
+ <div class="tags">
825
+ <h3>Returns:</h3>
826
+ <ul class="return">
827
+
828
+ <li>
829
+
830
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
831
+
832
+
833
+
834
+
835
+ &mdash;
836
+ <div class='inline'>
837
+ <p>An instance of String</p>
838
+ </div>
839
+
840
+ </li>
841
+
842
+ </ul>
843
+
844
+ </div><table class="source_code">
845
+ <tr>
846
+ <td>
847
+ <pre class="lines">
848
+
849
+
850
+ </pre>
851
+ </td>
852
+ <td>
853
+ <pre class="code"><span class="info file"># File ''</span>
854
+
855
+ <span class='id add_param'>add_param</span> <span class='symbol'>:unit</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unit</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
856
+ </td>
857
+ </tr>
858
+ </table>
859
+ </div>
860
+
861
+
862
+ <span id="vendor=-instance_method"></span>
863
+ <span id="vendor-instance_method"></span>
864
+ <div class="method_details ">
865
+ <p class="signature " id="vendor-instance_method">
866
+
867
+ - (<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>) <strong>vendor</strong>
868
+
869
+
870
+
871
+ </p><div class="docstring">
872
+ <div class="discussion">
873
+
874
+ <p>The name of the folder where external source code should be placed.</p>
875
+
876
+
877
+ </div>
878
+ </div>
879
+ <div class="tags">
880
+ <h3>Returns:</h3>
881
+ <ul class="return">
882
+
883
+ <li>
884
+
885
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
886
+
887
+
888
+
889
+
890
+ &mdash;
891
+ <div class='inline'>
892
+ <p>An instance of String</p>
893
+ </div>
894
+
895
+ </li>
896
+
897
+ </ul>
898
+
899
+ </div><table class="source_code">
900
+ <tr>
901
+ <td>
902
+ <pre class="lines">
903
+
904
+
905
+ </pre>
906
+ </td>
907
+ <td>
908
+ <pre class="code"><span class="info file"># File ''</span>
909
+
910
+ <span class='id add_param'>add_param</span> <span class='symbol'>:vendor</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:default</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vendor</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span></pre>
911
+ </td>
912
+ </tr>
913
+ </table>
914
+ </div>
915
+
916
+ </div>
917
+
918
+
919
+ <div id="instance_method_details" class="method_details_list">
920
+ <h2>Instance Method Details</h2>
921
+
922
+
923
+ <div class="method_details first">
924
+ <p class="signature first" id="manifest-instance_method">
925
+
926
+ - (<tt>Object</tt>) <strong>manifest</strong>
927
+
928
+
929
+
930
+ </p><table class="source_code">
931
+ <tr>
932
+ <td>
933
+ <pre class="lines">
934
+
935
+
936
+ 49
937
+ 50
938
+ 51
939
+ 52
940
+ 53
941
+ 54
942
+ 55
943
+ 56
944
+ 57
945
+ 58
946
+ 59
947
+ 60
948
+ 61
949
+ 62
950
+ 63
951
+ 64
952
+ 65
953
+ 66
954
+ 67
955
+ 68
956
+ 69
957
+ 70
958
+ 71
959
+ 72
960
+ 73
961
+ 74
962
+ 75
963
+ 76
964
+ 77
965
+ 78
966
+ 79</pre>
967
+ </td>
968
+ <td>
969
+ <pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 49</span>
970
+
971
+ <span class='kw'>def</span> <span class='id manifest'>manifest</span>
972
+ <span class='id directory'>directory</span> <span class='id bin'>bin</span> <span class='kw'>do</span>
973
+ <span class='id template'>template</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id input'>input</span><span class='period'>.</span><span class='id snake_case'>snake_case</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>generator_executable</span><span class='tstring_end'>&quot;</span></span>
974
+ <span class='kw'>end</span>
975
+
976
+ <span class='id directory'>directory</span> <span class='id lib'>lib</span> <span class='kw'>do</span>
977
+ <span class='comment'>#We need to add a folder with the same name as the module to be used in order to faux namespace our generators to avoid collisions from super classes
978
+ </span> <span class='id directory'>directory</span> <span class='id namespace'>namespace</span> <span class='kw'>do</span>
979
+ <span class='id directory'>directory</span> <span class='id generators'>generators</span> <span class='kw'>do</span>
980
+ <span class='id template'>template</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id input'>input</span><span class='period'>.</span><span class='id snake_case'>snake_case</span><span class='rbrace'>}</span><span class='tstring_content'>_generator.rb</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>generator_class.rb</span><span class='tstring_end'>&quot;</span></span>
981
+ <span class='id directory'>directory</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>templates</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
982
+ <span class='id template'>template</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id input'>input</span><span class='period'>.</span><span class='id camel_case'>camel_case</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id extension'>extension</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>generator_template</span><span class='tstring_end'>&quot;</span></span>
983
+ <span class='kw'>end</span>
984
+ <span class='kw'>end</span>
985
+ <span class='kw'>end</span>
986
+ <span class='kw'>end</span>
987
+
988
+ <span class='id directory'>directory</span> <span class='id test'>test</span> <span class='kw'>do</span>
989
+ <span class='id directory'>directory</span> <span class='id unit'>unit</span> <span class='kw'>do</span>
990
+ <span class='id template'>template</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id input'>input</span><span class='period'>.</span><span class='id snake_case'>snake_case</span><span class='rbrace'>}</span><span class='tstring_content'>_generator_test.rb</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>generator_test.rb</span><span class='tstring_end'>&quot;</span></span>
991
+ <span class='id template'>template</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>test_helper.rb</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>generator_test_helper.rb</span><span class='tstring_end'>&quot;</span></span>
992
+ <span class='kw'>end</span>
993
+ <span class='id directory'>directory</span> <span class='id fixtures'>fixtures</span> <span class='kw'>do</span>
994
+ <span class='id directory'>directory</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>generators</span><span class='tstring_end'>&quot;</span></span>
995
+ <span class='kw'>end</span>
996
+ <span class='kw'>end</span>
997
+
998
+ <span class='comment'>#This should actually be moved to the library generator
999
+ </span> <span class='comment'>#directory vendor
1000
+ </span>
1001
+ <span class='kw'>end</span></pre>
1002
+ </td>
1003
+ </tr>
1004
+ </table>
1005
+ </div>
1006
+
1007
+ </div>
1008
+
1009
+ </div>
1010
+
1011
+ <div id="footer">
1012
+ Generated on Wed Dec 22 11:58:37 2010 by
1013
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1014
+ 0.6.3 (ruby-1.9.2).
1015
+ </div>
1016
+
1017
+ </body>
1018
+ </html>