sprout 1.1.17.pre → 1.1.18.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.
- data/VERSION +1 -1
- data/doc/Dir.html +313 -0
- data/doc/Rake/Task.html +206 -0
- data/doc/Sprout.html +778 -0
- data/doc/Sprout/ArchiveUnpacker.html +1313 -0
- data/doc/Sprout/CommandLine.html +521 -0
- data/doc/Sprout/Concern.html +382 -0
- data/doc/Sprout/Errors.html +120 -0
- data/doc/Sprout/Errors/ArchiveUnpackerError.html +139 -0
- data/doc/Sprout/Errors/DestinationExistsError.html +143 -0
- data/doc/Sprout/Errors/DuplicateMemberError.html +142 -0
- data/doc/Sprout/Errors/ExecutableError.html +139 -0
- data/doc/Sprout/Errors/ExecutableRegistrationError.html +142 -0
- data/doc/Sprout/Errors/ExecutionError.html +135 -0
- data/doc/Sprout/Errors/GeneratorError.html +139 -0
- data/doc/Sprout/Errors/InvalidArgumentError.html +142 -0
- data/doc/Sprout/Errors/LoadError.html +135 -0
- data/doc/Sprout/Errors/MissingArgumentError.html +142 -0
- data/doc/Sprout/Errors/MissingExecutableError.html +142 -0
- data/doc/Sprout/Errors/MissingGeneratorError.html +142 -0
- data/doc/Sprout/Errors/MissingTemplateError.html +142 -0
- data/doc/Sprout/Errors/ProcessRunnerError.html +135 -0
- data/doc/Sprout/Errors/RemoteFileLoaderError.html +128 -0
- data/doc/Sprout/Errors/SproutError.html +132 -0
- data/doc/Sprout/Errors/UnknownArchiveType.html +136 -0
- data/doc/Sprout/Errors/UsageError.html +135 -0
- data/doc/Sprout/Errors/ValidationError.html +135 -0
- data/doc/Sprout/Errors/VersionRequirementNotMetError.html +135 -0
- data/doc/Sprout/Executable.html +183 -0
- data/doc/Sprout/Executable/Base.html +2986 -0
- data/doc/Sprout/Executable/Boolean.html +577 -0
- data/doc/Sprout/Executable/CollectionParam.html +521 -0
- data/doc/Sprout/Executable/FileParam.html +517 -0
- data/doc/Sprout/Executable/Files.html +311 -0
- data/doc/Sprout/Executable/Number.html +164 -0
- data/doc/Sprout/Executable/Param.html +3011 -0
- data/doc/Sprout/Executable/ParameterFactory.html +262 -0
- data/doc/Sprout/Executable/Path.html +247 -0
- data/doc/Sprout/Executable/Paths.html +268 -0
- data/doc/Sprout/Executable/Session.html +1587 -0
- data/doc/Sprout/Executable/StringParam.html +237 -0
- data/doc/Sprout/Executable/Strings.html +186 -0
- data/doc/Sprout/Executable/Url.html +180 -0
- data/doc/Sprout/Executable/Urls.html +185 -0
- data/doc/Sprout/FileTarget.html +1170 -0
- data/doc/Sprout/Generator.html +800 -0
- data/doc/Sprout/Generator/Base.html +1834 -0
- data/doc/Sprout/Generator/Command.html +716 -0
- data/doc/Sprout/Generator/DirectoryManifest.html +503 -0
- data/doc/Sprout/Generator/FileManifest.html +667 -0
- data/doc/Sprout/Generator/Manifest.html +403 -0
- data/doc/Sprout/Generator/TemplateManifest.html +213 -0
- data/doc/Sprout/GeneratorGenerator.html +990 -0
- data/doc/Sprout/Library.html +1259 -0
- data/doc/Sprout/LibraryGenerator.html +326 -0
- data/doc/Sprout/OutputBuffer.html +461 -0
- data/doc/Sprout/Platform.html +758 -0
- data/doc/Sprout/ProcessRunner.html +1801 -0
- data/doc/Sprout/ProgressBar.html +384 -0
- data/doc/Sprout/ProgressBarImpl.html +2151 -0
- data/doc/Sprout/ProgressBarManager.html +443 -0
- data/doc/Sprout/ProgressBarOutputStream.html +429 -0
- data/doc/Sprout/RDocParser.html +228 -0
- data/doc/Sprout/RemoteFileLoader.html +191 -0
- data/doc/Sprout/RemoteFileTarget.html +710 -0
- data/doc/Sprout/ReversedProgressBar.html +200 -0
- data/doc/Sprout/RubyFeature.html +176 -0
- data/doc/Sprout/RubyFeature/ClassMethods.html +1099 -0
- data/doc/Sprout/RubyGenerator.html +712 -0
- data/doc/Sprout/Specification.html +838 -0
- data/doc/Sprout/System.html +212 -0
- data/doc/Sprout/System/BaseSystem.html +1732 -0
- data/doc/Sprout/System/JavaSystem.html +137 -0
- data/doc/Sprout/System/OSXSystem.html +345 -0
- data/doc/Sprout/System/ThreadMock.html +201 -0
- data/doc/Sprout/System/UnixSystem.html +610 -0
- data/doc/Sprout/System/VistaSystem.html +263 -0
- data/doc/Sprout/System/WinNixSystem.html +340 -0
- data/doc/Sprout/System/WinSystem.html +590 -0
- data/doc/Sprout/TestHelper.html +2280 -0
- data/doc/Sprout/ToolGenerator.html +995 -0
- data/doc/Sprout/VERSION.html +135 -0
- data/doc/String.html +313 -0
- data/doc/_index.html +829 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +109 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +109 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +3622 -0
- data/doc/top-level-namespace.html +220 -0
- data/lib/sprout/generators/generator/generator_generator.rb +3 -3
- data/lib/sprout/generators/generator/templates/{generator_class.rb → generator_class.erb} +0 -0
- data/lib/sprout/generators/generator/templates/{generator_test.rb → generator_test.erb} +0 -0
- data/lib/sprout/generators/generator/templates/{generator_test_helper.rb → generator_test_helper.erb} +0 -0
- data/lib/sprout/generators/library/library_generator.rb +1 -1
- data/lib/sprout/generators/library/templates/{library.rb → library.erb} +0 -0
- data/lib/sprout/generators/ruby/ruby_generator.rb +4 -5
- data/lib/sprout/generators/ruby/templates/{ruby_base.rb → ruby_base.erb} +0 -0
- data/lib/sprout/generators/ruby/templates/{ruby_input.rb → ruby_input.erb} +0 -0
- data/lib/sprout/generators/ruby/templates/{ruby_test_case.rb → ruby_test_case.erb} +0 -0
- data/lib/sprout/generators/ruby/templates/{ruby_test_helper.rb → ruby_test_helper.erb} +0 -0
- data/lib/sprout/generators/tool/templates/{tool.rb → tool.erb} +0 -2
- data/lib/sprout/generators/tool/tool_generator.rb +1 -1
- metadata +128 -32
|
@@ -0,0 +1,990 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Sprout::GeneratorGenerator
|
|
8
|
+
|
|
9
|
+
— Sprouts v.1.0.34.pre
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
relpath = '..';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="../_index.html">Index (G)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Sprout.html" title="Sprout (module)">Sprout</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">GeneratorGenerator</span>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<div id="search">
|
|
46
|
+
|
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
48
|
+
|
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
50
|
+
|
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<div class="clear"></div>
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<iframe id="search_frame"></iframe>
|
|
58
|
+
|
|
59
|
+
<div id="content"><h1>Class: Sprout::GeneratorGenerator
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</h1>
|
|
64
|
+
|
|
65
|
+
<dl class="box">
|
|
66
|
+
|
|
67
|
+
<dt class="r1">Inherits:</dt>
|
|
68
|
+
<dd class="r1">
|
|
69
|
+
<span class="inheritName"><span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Sprout::Generator::Base</a></span></span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next"><span class='object_link'><a href="Executable/Base.html" title="Sprout::Executable::Base (class)">Executable::Base</a></span></li>
|
|
75
|
+
|
|
76
|
+
<li class="next"><span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Sprout::Generator::Base</a></span></li>
|
|
77
|
+
|
|
78
|
+
<li class="next">Sprout::GeneratorGenerator</li>
|
|
79
|
+
|
|
80
|
+
</ul>
|
|
81
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
82
|
+
|
|
83
|
+
</dd>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<dt class="r2 last">Defined in:</dt>
|
|
94
|
+
<dd class="r2 last">lib/sprout/generators/generator/generator_generator.rb</dd>
|
|
95
|
+
|
|
96
|
+
</dl>
|
|
97
|
+
<div class="clear"></div>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<h2>Constant Summary</h2>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<h2>Constant Summary</h2>
|
|
106
|
+
|
|
107
|
+
<h3 class="inherited">Constants included
|
|
108
|
+
from <span class='object_link'><a href="Executable.html" title="Sprout::Executable (module)">Executable</a></span></h3>
|
|
109
|
+
<p class="inherited"><span class='object_link'><a href="Executable.html#DEFAULT_FILE_EXPRESSION-constant" title="Sprout::Executable::DEFAULT_FILE_EXPRESSION (constant)">Executable::DEFAULT_FILE_EXPRESSION</a></span>, <span class='object_link'><a href="Executable.html#DEFAULT_PREFIX-constant" title="Sprout::Executable::DEFAULT_PREFIX (constant)">Executable::DEFAULT_PREFIX</a></span>, <span class='object_link'><a href="Executable.html#DEFAULT_SHORT_PREFIX-constant" title="Sprout::Executable::DEFAULT_SHORT_PREFIX (constant)">Executable::DEFAULT_SHORT_PREFIX</a></span></p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
113
|
+
<ul class="summary">
|
|
114
|
+
|
|
115
|
+
<li class="public ">
|
|
116
|
+
<span class="summary_signature">
|
|
117
|
+
|
|
118
|
+
<a href="#bin-instance_method" title="#bin (instance method)">- (Object) <strong>bin</strong> </a>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
</span>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
135
|
+
The name of the folder where binary or executable artifacts should be
|
|
136
|
+
created by compiler tasks.
|
|
137
|
+
</p>
|
|
138
|
+
</div></span>
|
|
139
|
+
|
|
140
|
+
</li>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<li class="public ">
|
|
144
|
+
<span class="summary_signature">
|
|
145
|
+
|
|
146
|
+
<a href="#extension-instance_method" title="#extension (instance method)">- (Object) <strong>extension</strong> </a>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</span>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
163
|
+
The default (primary) file extension for generated source files.
|
|
164
|
+
</p>
|
|
165
|
+
</div></span>
|
|
166
|
+
|
|
167
|
+
</li>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#fixtures-instance_method" title="#fixtures (instance method)">- (Object) <strong>fixtures</strong> </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
190
|
+
The name of the child folder of the test folder where fixtures should be
|
|
191
|
+
generated.
|
|
192
|
+
</p>
|
|
193
|
+
</div></span>
|
|
194
|
+
|
|
195
|
+
</li>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<li class="public ">
|
|
199
|
+
<span class="summary_signature">
|
|
200
|
+
|
|
201
|
+
<a href="#generators-instance_method" title="#generators (instance method)">- (Object) <strong>generators</strong> </a>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</span>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
218
|
+
The name of the folder where custom generators and templates will be found.
|
|
219
|
+
</p>
|
|
220
|
+
</div></span>
|
|
221
|
+
|
|
222
|
+
</li>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<li class="public ">
|
|
226
|
+
<span class="summary_signature">
|
|
227
|
+
|
|
228
|
+
<a href="#lib-instance_method" title="#lib (instance method)">- (Object) <strong>lib</strong> </a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
</span>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
245
|
+
The name of the folder where external libraries will be installed.
|
|
246
|
+
</p>
|
|
247
|
+
</div></span>
|
|
248
|
+
|
|
249
|
+
</li>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<li class="public ">
|
|
253
|
+
<span class="summary_signature">
|
|
254
|
+
|
|
255
|
+
<a href="#namespace-instance_method" title="#namespace (instance method)">- (Object) <strong>namespace</strong> </a>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
</span>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
272
|
+
The default module that classes will be added to.
|
|
273
|
+
</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#test-instance_method" title="#test (instance method)">- (Object) <strong>test</strong> </a>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</span>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
299
|
+
The name of the folder where tests should be generated.
|
|
300
|
+
</p>
|
|
301
|
+
</div></span>
|
|
302
|
+
|
|
303
|
+
</li>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<li class="public ">
|
|
307
|
+
<span class="summary_signature">
|
|
308
|
+
|
|
309
|
+
<a href="#unit-instance_method" title="#unit (instance method)">- (Object) <strong>unit</strong> </a>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
</span>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
326
|
+
The name of the child folder of the test folder where unit tests should be
|
|
327
|
+
generated.
|
|
328
|
+
</p>
|
|
329
|
+
</div></span>
|
|
330
|
+
|
|
331
|
+
</li>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<li class="public ">
|
|
335
|
+
<span class="summary_signature">
|
|
336
|
+
|
|
337
|
+
<a href="#vendor-instance_method" title="#vendor (instance method)">- (Object) <strong>vendor</strong> </a>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
</span>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
354
|
+
The name of the folder where external source code should be placed.
|
|
355
|
+
</p>
|
|
356
|
+
</div></span>
|
|
357
|
+
|
|
358
|
+
</li>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</ul>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Generator/Base.html" title="Sprout::Generator::Base (class)">Sprout::Generator::Base</a></span></h3>
|
|
368
|
+
<p class="inherited"><span class='object_link'><a href="Generator/Base.html#destroy-instance_method" title="Sprout::Generator::Base#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Generator/Base.html#force-instance_method" title="Sprout::Generator::Base#force (method)">#force</a></span>, <span class='object_link'><a href="Generator/Base.html#input-instance_method" title="Sprout::Generator::Base#input (method)">#input</a></span>, <span class='object_link'><a href="Generator/Base.html#logger-instance_method" title="Sprout::Generator::Base#logger (method)">#logger</a></span>, <span class='object_link'><a href="Generator/Base.html#name-instance_method" title="Sprout::Generator::Base#name (method)">#name</a></span>, <span class='object_link'><a href="Generator/Base.html#path-instance_method" title="Sprout::Generator::Base#path (method)">#path</a></span>, <span class='object_link'><a href="Generator/Base.html#pkg_name-instance_method" title="Sprout::Generator::Base#pkg_name (method)">#pkg_name</a></span>, <span class='object_link'><a href="Generator/Base.html#pkg_version-instance_method" title="Sprout::Generator::Base#pkg_version (method)">#pkg_version</a></span>, <span class='object_link'><a href="Generator/Base.html#quiet-instance_method" title="Sprout::Generator::Base#quiet (method)">#quiet</a></span>, <span class='object_link'><a href="Generator/Base.html#show_template_paths-instance_method" title="Sprout::Generator::Base#show_template_paths (method)">#show_template_paths</a></span>, <span class='object_link'><a href="Generator/Base.html#templates-instance_method" title="Sprout::Generator::Base#templates (method)">#templates</a></span></p>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Executable/Base.html" title="Sprout::Executable::Base (class)">Executable::Base</a></span></h3>
|
|
373
|
+
<p class="inherited"><span class='object_link'><a href="Executable/Base.html#abort_on_failure-instance_method" title="Sprout::Executable::Base#abort_on_failure (method)">#abort_on_failure</a></span>, <span class='object_link'><a href="Executable/Base.html#default_prefix-instance_method" title="Sprout::Executable::Base#default_prefix (method)">#default_prefix</a></span>, <span class='object_link'><a href="Executable/Base.html#default_short_prefix-instance_method" title="Sprout::Executable::Base#default_short_prefix (method)">#default_short_prefix</a></span>, <span class='object_link'><a href="Executable/Base.html#executable-instance_method" title="Sprout::Executable::Base#executable (method)">#executable</a></span>, <span class='object_link'><a href="Executable/Base.html#param_hash-instance_method" title="Sprout::Executable::Base#param_hash (method)">#param_hash</a></span>, <span class='object_link'><a href="Executable/Base.html#params-instance_method" title="Sprout::Executable::Base#params (method)">#params</a></span>, <span class='object_link'><a href="Executable/Base.html#pkg_name-instance_method" title="Sprout::Executable::Base#pkg_name (method)">#pkg_name</a></span>, <span class='object_link'><a href="Executable/Base.html#pkg_version-instance_method" title="Sprout::Executable::Base#pkg_version (method)">#pkg_version</a></span>, <span class='object_link'><a href="Executable/Base.html#prerequisites-instance_method" title="Sprout::Executable::Base#prerequisites (method)">#prerequisites</a></span>, <span class='object_link'><a href="Executable/Base.html#rake_task_name-instance_method" title="Sprout::Executable::Base#rake_task_name (method)">#rake_task_name</a></span></p>
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<h2>
|
|
378
|
+
Instance Method Summary
|
|
379
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
380
|
+
</h2>
|
|
381
|
+
|
|
382
|
+
<ul class="summary">
|
|
383
|
+
|
|
384
|
+
<li class="public ">
|
|
385
|
+
<span class="summary_signature">
|
|
386
|
+
|
|
387
|
+
<a href="#manifest-instance_method" title="#manifest (instance method)">- (Object) <strong>manifest</strong> </a>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
</span>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
401
|
+
|
|
402
|
+
</li>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
<li class="protected ">
|
|
406
|
+
<span class="summary_signature">
|
|
407
|
+
|
|
408
|
+
<a href="#massage_input-instance_method" title="#massage_input (instance method)">- (Object) <strong>massage_input</strong> </a>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
</span>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
<span class="note title protected">protected</span>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
422
|
+
|
|
423
|
+
</li>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
</ul>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
<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>
|
|
438
|
+
<p class="inherited"><span class='object_link'><a href="Generator/Base.html#create_template_paths-instance_method" title="Sprout::Generator::Base#create_template_paths (method)">#create_template_paths</a></span>, <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#do_show_template_paths-instance_method" title="Sprout::Generator::Base#do_show_template_paths (method)">#do_show_template_paths</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>, <span class='object_link'><a href="Generator/Base.html#validate-instance_method" title="Sprout::Generator::Base#validate (method)">#validate</a></span></p>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Executable/Base.html" title="Sprout::Executable::Base (class)">Executable::Base</a></span></h3>
|
|
448
|
+
<p class="inherited"><span class='object_link'><a href="Executable/Base.html#add_param-class_method" title="Sprout::Executable::Base.add_param (method)">add_param</a></span>, <span class='object_link'><a href="Executable/Base.html#add_param_alias-class_method" title="Sprout::Executable::Base.add_param_alias (method)">add_param_alias</a></span>, <span class='object_link'><a href="Executable/Base.html#binary_path-instance_method" title="Sprout::Executable::Base#binary_path (method)">#binary_path</a></span>, <span class='object_link'><a href="Executable/Base.html#binary_path%3D-instance_method" title="Sprout::Executable::Base#binary_path= (method)">#binary_path=</a></span>, <span class='object_link'><a href="Executable/Base.html#create_outer_task-instance_method" title="Sprout::Executable::Base#create_outer_task (method)">#create_outer_task</a></span>, <span class='object_link'><a href="Executable/Base.html#default_file_expression-instance_method" title="Sprout::Executable::Base#default_file_expression (method)">#default_file_expression</a></span>, <span class='object_link'><a href="Executable/Base.html#execute-instance_method" title="Sprout::Executable::Base#execute (method)">#execute</a></span>, <span class='object_link'><a href="Executable/Base.html#execute_delegate-instance_method" title="Sprout::Executable::Base#execute_delegate (method)">#execute_delegate</a></span>, <span class='object_link'><a href="Executable/Base.html#from_hash-instance_method" title="Sprout::Executable::Base#from_hash (method)">#from_hash</a></span>, <span class='object_link'><a href="Executable/Base.html#initialize-instance_method" title="Sprout::Executable::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Executable/Base.html#initialize_defaults-instance_method" title="Sprout::Executable::Base#initialize_defaults (method)">#initialize_defaults</a></span>, <span class='object_link'><a href="Executable/Base.html#library_added-instance_method" title="Sprout::Executable::Base#library_added (method)">#library_added</a></span>, <span class='object_link'><a href="Executable/Base.html#parse%21-instance_method" title="Sprout::Executable::Base#parse! (method)">#parse!</a></span>, <span class='object_link'><a href="Executable/Base.html#parse_extra_options%21-instance_method" title="Sprout::Executable::Base#parse_extra_options! (method)">#parse_extra_options!</a></span>, <span class='object_link'><a href="Executable/Base.html#parse_rake_task_arg-instance_method" title="Sprout::Executable::Base#parse_rake_task_arg (method)">#parse_rake_task_arg</a></span>, <span class='object_link'><a href="Executable/Base.html#prepare-instance_method" title="Sprout::Executable::Base#prepare (method)">#prepare</a></span>, <span class='object_link'><a href="Executable/Base.html#set-class_method" title="Sprout::Executable::Base.set (method)">set</a></span>, <span class='object_link'><a href="Executable/Base.html#static_default_value_collection-class_method" title="Sprout::Executable::Base.static_default_value_collection (method)">static_default_value_collection</a></span>, <span class='object_link'><a href="Executable/Base.html#static_parameter_collection-class_method" title="Sprout::Executable::Base.static_parameter_collection (method)">static_parameter_collection</a></span>, <span class='object_link'><a href="Executable/Base.html#stderr-instance_method" title="Sprout::Executable::Base#stderr (method)">#stderr</a></span>, <span class='object_link'><a href="Executable/Base.html#stderr%3D-instance_method" title="Sprout::Executable::Base#stderr= (method)">#stderr=</a></span>, <span class='object_link'><a href="Executable/Base.html#stdout-instance_method" title="Sprout::Executable::Base#stdout (method)">#stdout</a></span>, <span class='object_link'><a href="Executable/Base.html#stdout%3D-instance_method" title="Sprout::Executable::Base#stdout= (method)">#stdout=</a></span>, <span class='object_link'><a href="Executable/Base.html#system_execute-instance_method" title="Sprout::Executable::Base#system_execute (method)">#system_execute</a></span>, <span class='object_link'><a href="Executable/Base.html#to_hash-instance_method" title="Sprout::Executable::Base#to_hash (method)">#to_hash</a></span>, <span class='object_link'><a href="Executable/Base.html#to_help-instance_method" title="Sprout::Executable::Base#to_help (method)">#to_help</a></span>, <span class='object_link'><a href="Executable/Base.html#to_rake-instance_method" title="Sprout::Executable::Base#to_rake (method)">#to_rake</a></span>, <span class='object_link'><a href="Executable/Base.html#to_shell-instance_method" title="Sprout::Executable::Base#to_shell (method)">#to_shell</a></span>, <span class='object_link'><a href="Executable/Base.html#update_rake_task_name_from_args-instance_method" title="Sprout::Executable::Base#update_rake_task_name_from_args (method)">#update_rake_task_name_from_args</a></span></p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concern.html" title="Sprout::Concern (module)">Concern</a></span></h3>
|
|
468
|
+
<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>
|
|
469
|
+
<div id="constructor_details" class="method_details_list">
|
|
470
|
+
<h2>Constructor Details</h2>
|
|
471
|
+
|
|
472
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Executable/Base.html#initialize-instance_method" title="Sprout::Executable::Base#initialize (method)">Sprout::Executable::Base</a></span></p>
|
|
473
|
+
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
<div id="instance_attr_details" class="attr_details">
|
|
477
|
+
<h2>Instance Attribute Details</h2>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<span id="bin=-instance_method"></span>
|
|
481
|
+
<span id="bin-instance_method"></span>
|
|
482
|
+
<div class="method_details first">
|
|
483
|
+
<p class="signature first" id="bin-instance_method">
|
|
484
|
+
|
|
485
|
+
- (<tt>Object</tt>) <strong>bin</strong>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
</p><div class="docstring">
|
|
490
|
+
<div class="discussion">
|
|
491
|
+
<p>
|
|
492
|
+
The name of the folder where binary or executable artifacts should be
|
|
493
|
+
created by compiler tasks.
|
|
494
|
+
</p>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div>
|
|
498
|
+
</div>
|
|
499
|
+
<div class="tags">
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
</div><table class="source_code">
|
|
503
|
+
<tr>
|
|
504
|
+
<td>
|
|
505
|
+
<pre class="lines">
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
42</pre>
|
|
509
|
+
</td>
|
|
510
|
+
<td>
|
|
511
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 42</span>
|
|
512
|
+
|
|
513
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
514
|
+
</td>
|
|
515
|
+
</tr>
|
|
516
|
+
</table>
|
|
517
|
+
</div>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
<span id="extension=-instance_method"></span>
|
|
521
|
+
<span id="extension-instance_method"></span>
|
|
522
|
+
<div class="method_details ">
|
|
523
|
+
<p class="signature " id="extension-instance_method">
|
|
524
|
+
|
|
525
|
+
- (<tt>Object</tt>) <strong>extension</strong>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
</p><div class="docstring">
|
|
530
|
+
<div class="discussion">
|
|
531
|
+
<p>
|
|
532
|
+
The default (primary) file extension for generated source files. This
|
|
533
|
+
should hint at the project type.
|
|
534
|
+
</p>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</div>
|
|
538
|
+
</div>
|
|
539
|
+
<div class="tags">
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
</div><table class="source_code">
|
|
543
|
+
<tr>
|
|
544
|
+
<td>
|
|
545
|
+
<pre class="lines">
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
47</pre>
|
|
549
|
+
</td>
|
|
550
|
+
<td>
|
|
551
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 47</span>
|
|
552
|
+
|
|
553
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
554
|
+
</td>
|
|
555
|
+
</tr>
|
|
556
|
+
</table>
|
|
557
|
+
</div>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
<span id="fixtures=-instance_method"></span>
|
|
561
|
+
<span id="fixtures-instance_method"></span>
|
|
562
|
+
<div class="method_details ">
|
|
563
|
+
<p class="signature " id="fixtures-instance_method">
|
|
564
|
+
|
|
565
|
+
- (<tt>Object</tt>) <strong>fixtures</strong>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
</p><div class="docstring">
|
|
570
|
+
<div class="discussion">
|
|
571
|
+
<p>
|
|
572
|
+
The name of the child folder of the test folder where fixtures should be
|
|
573
|
+
generated.
|
|
574
|
+
</p>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
</div>
|
|
578
|
+
</div>
|
|
579
|
+
<div class="tags">
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</div><table class="source_code">
|
|
583
|
+
<tr>
|
|
584
|
+
<td>
|
|
585
|
+
<pre class="lines">
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
32</pre>
|
|
589
|
+
</td>
|
|
590
|
+
<td>
|
|
591
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 32</span>
|
|
592
|
+
|
|
593
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
594
|
+
</td>
|
|
595
|
+
</tr>
|
|
596
|
+
</table>
|
|
597
|
+
</div>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<span id="generators=-instance_method"></span>
|
|
601
|
+
<span id="generators-instance_method"></span>
|
|
602
|
+
<div class="method_details ">
|
|
603
|
+
<p class="signature " id="generators-instance_method">
|
|
604
|
+
|
|
605
|
+
- (<tt>Object</tt>) <strong>generators</strong>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
</p><div class="docstring">
|
|
610
|
+
<div class="discussion">
|
|
611
|
+
<p>
|
|
612
|
+
The name of the folder where custom generators and templates will be found.
|
|
613
|
+
</p>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
</div>
|
|
617
|
+
</div>
|
|
618
|
+
<div class="tags">
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
</div><table class="source_code">
|
|
622
|
+
<tr>
|
|
623
|
+
<td>
|
|
624
|
+
<pre class="lines">
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
18</pre>
|
|
628
|
+
</td>
|
|
629
|
+
<td>
|
|
630
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 18</span>
|
|
631
|
+
|
|
632
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
633
|
+
</td>
|
|
634
|
+
</tr>
|
|
635
|
+
</table>
|
|
636
|
+
</div>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
<span id="lib=-instance_method"></span>
|
|
640
|
+
<span id="lib-instance_method"></span>
|
|
641
|
+
<div class="method_details ">
|
|
642
|
+
<p class="signature " id="lib-instance_method">
|
|
643
|
+
|
|
644
|
+
- (<tt>Object</tt>) <strong>lib</strong>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
</p><div class="docstring">
|
|
649
|
+
<div class="discussion">
|
|
650
|
+
<p>
|
|
651
|
+
The name of the folder where external libraries will be installed.
|
|
652
|
+
</p>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
</div>
|
|
656
|
+
</div>
|
|
657
|
+
<div class="tags">
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
</div><table class="source_code">
|
|
661
|
+
<tr>
|
|
662
|
+
<td>
|
|
663
|
+
<pre class="lines">
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
13</pre>
|
|
667
|
+
</td>
|
|
668
|
+
<td>
|
|
669
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 13</span>
|
|
670
|
+
|
|
671
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
672
|
+
</td>
|
|
673
|
+
</tr>
|
|
674
|
+
</table>
|
|
675
|
+
</div>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<span id="namespace=-instance_method"></span>
|
|
679
|
+
<span id="namespace-instance_method"></span>
|
|
680
|
+
<div class="method_details ">
|
|
681
|
+
<p class="signature " id="namespace-instance_method">
|
|
682
|
+
|
|
683
|
+
- (<tt>Object</tt>) <strong>namespace</strong>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
</p><div class="docstring">
|
|
688
|
+
<div class="discussion">
|
|
689
|
+
<p>
|
|
690
|
+
The default module that classes will be added to.
|
|
691
|
+
</p>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
</div>
|
|
695
|
+
</div>
|
|
696
|
+
<div class="tags">
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
</div><table class="source_code">
|
|
700
|
+
<tr>
|
|
701
|
+
<td>
|
|
702
|
+
<pre class="lines">
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
8</pre>
|
|
706
|
+
</td>
|
|
707
|
+
<td>
|
|
708
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 8</span>
|
|
709
|
+
|
|
710
|
+
<span class='id identifier rubyid_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'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span></pre>
|
|
711
|
+
</td>
|
|
712
|
+
</tr>
|
|
713
|
+
</table>
|
|
714
|
+
</div>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<span id="test=-instance_method"></span>
|
|
718
|
+
<span id="test-instance_method"></span>
|
|
719
|
+
<div class="method_details ">
|
|
720
|
+
<p class="signature " id="test-instance_method">
|
|
721
|
+
|
|
722
|
+
- (<tt>Object</tt>) <strong>test</strong>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
</p><div class="docstring">
|
|
727
|
+
<div class="discussion">
|
|
728
|
+
<p>
|
|
729
|
+
The name of the folder where tests should be generated.
|
|
730
|
+
</p>
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
</div>
|
|
734
|
+
</div>
|
|
735
|
+
<div class="tags">
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
</div><table class="source_code">
|
|
739
|
+
<tr>
|
|
740
|
+
<td>
|
|
741
|
+
<pre class="lines">
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
22</pre>
|
|
745
|
+
</td>
|
|
746
|
+
<td>
|
|
747
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 22</span>
|
|
748
|
+
|
|
749
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
750
|
+
</td>
|
|
751
|
+
</tr>
|
|
752
|
+
</table>
|
|
753
|
+
</div>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<span id="unit=-instance_method"></span>
|
|
757
|
+
<span id="unit-instance_method"></span>
|
|
758
|
+
<div class="method_details ">
|
|
759
|
+
<p class="signature " id="unit-instance_method">
|
|
760
|
+
|
|
761
|
+
- (<tt>Object</tt>) <strong>unit</strong>
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
</p><div class="docstring">
|
|
766
|
+
<div class="discussion">
|
|
767
|
+
<p>
|
|
768
|
+
The name of the child folder of the test folder where unit tests should be
|
|
769
|
+
generated.
|
|
770
|
+
</p>
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
</div>
|
|
774
|
+
</div>
|
|
775
|
+
<div class="tags">
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</div><table class="source_code">
|
|
779
|
+
<tr>
|
|
780
|
+
<td>
|
|
781
|
+
<pre class="lines">
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
27</pre>
|
|
785
|
+
</td>
|
|
786
|
+
<td>
|
|
787
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 27</span>
|
|
788
|
+
|
|
789
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
790
|
+
</td>
|
|
791
|
+
</tr>
|
|
792
|
+
</table>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
<span id="vendor=-instance_method"></span>
|
|
797
|
+
<span id="vendor-instance_method"></span>
|
|
798
|
+
<div class="method_details ">
|
|
799
|
+
<p class="signature " id="vendor-instance_method">
|
|
800
|
+
|
|
801
|
+
- (<tt>Object</tt>) <strong>vendor</strong>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
</p><div class="docstring">
|
|
806
|
+
<div class="discussion">
|
|
807
|
+
<p>
|
|
808
|
+
The name of the folder where external source code should be placed.
|
|
809
|
+
</p>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</div>
|
|
813
|
+
</div>
|
|
814
|
+
<div class="tags">
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
</div><table class="source_code">
|
|
818
|
+
<tr>
|
|
819
|
+
<td>
|
|
820
|
+
<pre class="lines">
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
37</pre>
|
|
824
|
+
</td>
|
|
825
|
+
<td>
|
|
826
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 37</span>
|
|
827
|
+
|
|
828
|
+
<span class='id identifier rubyid_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'>=></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>
|
|
829
|
+
</td>
|
|
830
|
+
</tr>
|
|
831
|
+
</table>
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
</div>
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<div id="instance_method_details" class="method_details_list">
|
|
838
|
+
<h2>Instance Method Details</h2>
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
<div class="method_details first">
|
|
842
|
+
<p class="signature first" id="manifest-instance_method">
|
|
843
|
+
|
|
844
|
+
- (<tt>Object</tt>) <strong>manifest</strong>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
</p><table class="source_code">
|
|
849
|
+
<tr>
|
|
850
|
+
<td>
|
|
851
|
+
<pre class="lines">
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
49
|
|
855
|
+
50
|
|
856
|
+
51
|
|
857
|
+
52
|
|
858
|
+
53
|
|
859
|
+
54
|
|
860
|
+
55
|
|
861
|
+
56
|
|
862
|
+
57
|
|
863
|
+
58
|
|
864
|
+
59
|
|
865
|
+
60
|
|
866
|
+
61
|
|
867
|
+
62
|
|
868
|
+
63
|
|
869
|
+
64
|
|
870
|
+
65
|
|
871
|
+
66
|
|
872
|
+
67
|
|
873
|
+
68
|
|
874
|
+
69
|
|
875
|
+
70
|
|
876
|
+
71
|
|
877
|
+
72
|
|
878
|
+
73
|
|
879
|
+
74
|
|
880
|
+
75
|
|
881
|
+
76
|
|
882
|
+
77
|
|
883
|
+
78
|
|
884
|
+
79
|
|
885
|
+
80
|
|
886
|
+
81
|
|
887
|
+
82
|
|
888
|
+
83
|
|
889
|
+
84
|
|
890
|
+
85
|
|
891
|
+
86
|
|
892
|
+
87
|
|
893
|
+
88
|
|
894
|
+
89
|
|
895
|
+
90
|
|
896
|
+
91</pre>
|
|
897
|
+
</td>
|
|
898
|
+
<td>
|
|
899
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 49</span>
|
|
900
|
+
|
|
901
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_manifest'>manifest</span>
|
|
902
|
+
<span class='id identifier rubyid_massage_input'>massage_input</span>
|
|
903
|
+
|
|
904
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_bin'>bin</span> <span class='kw'>do</span>
|
|
905
|
+
<span class='id identifier rubyid_template'>template</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_dash_case'>dash_case</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>generator_executable</span><span class='tstring_end'>"</span></span>
|
|
906
|
+
<span class='kw'>end</span>
|
|
907
|
+
|
|
908
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_lib'>lib</span> <span class='kw'>do</span>
|
|
909
|
+
<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
|
|
910
|
+
</span> <span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_namespace'>namespace</span> <span class='kw'>do</span>
|
|
911
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_generators'>generators</span> <span class='kw'>do</span>
|
|
912
|
+
<span class='id identifier rubyid_template'>template</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_snake_case'>snake_case</span><span class='rbrace'>}</span><span class='tstring_content'>_generator.rb</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>generator_class.rb</span><span class='tstring_end'>"</span></span>
|
|
913
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>templates</span><span class='tstring_end'>"</span></span> <span class='kw'>do</span>
|
|
914
|
+
<span class='id identifier rubyid_template'>template</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_camel_case'>camel_case</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_extension'>extension</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>generator_template</span><span class='tstring_end'>"</span></span>
|
|
915
|
+
<span class='kw'>end</span>
|
|
916
|
+
<span class='kw'>end</span>
|
|
917
|
+
<span class='kw'>end</span>
|
|
918
|
+
<span class='kw'>end</span>
|
|
919
|
+
|
|
920
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_test'>test</span> <span class='kw'>do</span>
|
|
921
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_unit'>unit</span> <span class='kw'>do</span>
|
|
922
|
+
<span class='id identifier rubyid_template'>template</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_snake_case'>snake_case</span><span class='rbrace'>}</span><span class='tstring_content'>_generator_test.rb</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>generator_test.rb</span><span class='tstring_end'>"</span></span>
|
|
923
|
+
<span class='id identifier rubyid_template'>template</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>test_helper.rb</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>generator_test_helper.rb</span><span class='tstring_end'>"</span></span>
|
|
924
|
+
<span class='kw'>end</span>
|
|
925
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='id identifier rubyid_fixtures'>fixtures</span> <span class='kw'>do</span>
|
|
926
|
+
<span class='id identifier rubyid_directory'>directory</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>generators</span><span class='tstring_end'>"</span></span>
|
|
927
|
+
<span class='kw'>end</span>
|
|
928
|
+
<span class='kw'>end</span>
|
|
929
|
+
|
|
930
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Gemfile</span><span class='tstring_end'>'</span></span>
|
|
931
|
+
<span class='id identifier rubyid_template'>template</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Gemfile</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>generator_gemfile</span><span class='tstring_end'>'</span></span>
|
|
932
|
+
<span class='kw'>else</span>
|
|
933
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[INFO] It seems you already have a Gemfile in this project, please be sure it has the following content:</span><span class='tstring_end'>"</span></span>
|
|
934
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
935
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> gem "sprout", ">= #{Sprout::VERSION::STRING}"</span><span class='tstring_end'>'</span></span>
|
|
936
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
937
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> group :development do</span><span class='tstring_end'>'</span></span>
|
|
938
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> gem "shoulda"</span><span class='tstring_end'>'</span></span>
|
|
939
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> gem "mocha"</span><span class='tstring_end'>'</span></span>
|
|
940
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> end</span><span class='tstring_end'>'</span></span>
|
|
941
|
+
<span class='id identifier rubyid_say'>say</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
942
|
+
<span class='kw'>end</span>
|
|
943
|
+
<span class='kw'>end</span></pre>
|
|
944
|
+
</td>
|
|
945
|
+
</tr>
|
|
946
|
+
</table>
|
|
947
|
+
</div>
|
|
948
|
+
|
|
949
|
+
<div class="method_details ">
|
|
950
|
+
<p class="signature " id="massage_input-instance_method">
|
|
951
|
+
|
|
952
|
+
- (<tt>Object</tt>) <strong>massage_input</strong> <span class="extras">(protected)</span>
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
</p><table class="source_code">
|
|
957
|
+
<tr>
|
|
958
|
+
<td>
|
|
959
|
+
<pre class="lines">
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
95
|
|
963
|
+
96
|
|
964
|
+
97
|
|
965
|
+
98</pre>
|
|
966
|
+
</td>
|
|
967
|
+
<td>
|
|
968
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/generators/generator/generator_generator.rb', line 95</span>
|
|
969
|
+
|
|
970
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_massage_input'>massage_input</span>
|
|
971
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>_generator$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
972
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>Generator$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
973
|
+
<span class='kw'>end</span></pre>
|
|
974
|
+
</td>
|
|
975
|
+
</tr>
|
|
976
|
+
</table>
|
|
977
|
+
</div>
|
|
978
|
+
|
|
979
|
+
</div>
|
|
980
|
+
|
|
981
|
+
</div>
|
|
982
|
+
|
|
983
|
+
<div id="footer">
|
|
984
|
+
Generated on Sun Mar 11 14:30:35 2012 by
|
|
985
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
986
|
+
0.7.5 (ruby-1.9.2).
|
|
987
|
+
</div>
|
|
988
|
+
|
|
989
|
+
</body>
|
|
990
|
+
</html>
|