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
data/doc/Sprout.html
ADDED
@@ -0,0 +1,778 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Module: Sprout
|
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 (S)</a> »
|
37
|
+
|
38
|
+
|
39
|
+
<span class="title">Sprout</span>
|
40
|
+
|
41
|
+
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<div id="search">
|
46
|
+
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
48
|
+
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
50
|
+
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
52
|
+
|
53
|
+
</div>
|
54
|
+
<div class="clear"></div>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<iframe id="search_frame"></iframe>
|
58
|
+
|
59
|
+
<div id="content"><h1>Module: Sprout
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
</h1>
|
64
|
+
|
65
|
+
<dl class="box">
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
<dt class="r1 last">Defined in:</dt>
|
75
|
+
<dd class="r1 last">lib/sprout.rb<span class="defines">,<br />
|
76
|
+
lib/sprout/errors.rb,<br /> lib/sprout/system.rb,<br /> lib/sprout/version.rb,<br /> lib/sprout/library.rb,<br /> lib/sprout/concern.rb,<br /> lib/sprout/platform.rb,<br /> lib/sprout/generator.rb,<br /> lib/sprout/executable.rb,<br /> lib/sprout/file_target.rb,<br /> lib/sprout/rdoc_parser.rb,<br /> lib/sprout/progress_bar.rb,<br /> lib/sprout/ruby_feature.rb,<br /> lib/sprout/command_line.rb,<br /> lib/sprout/specification.rb,<br /> lib/sprout/output_buffer.rb,<br /> lib/sprout/executable/url.rb,<br /> lib/sprout/generator/base.rb,<br /> lib/sprout/process_runner.rb,<br /> lib/sprout/executable/urls.rb,<br /> lib/sprout/executable/path.rb,<br /> lib/sprout/executable/base.rb,<br /> lib/sprout/executable/files.rb,<br /> lib/sprout/executable/param.rb,<br /> lib/sprout/executable/paths.rb,<br /> lib/sprout/executable/number.rb,<br /> lib/sprout/remote_file_loader.rb,<br /> lib/sprout/executable/boolean.rb,<br /> lib/sprout/executable/strings.rb,<br /> lib/sprout/remote_file_target.rb,<br /> lib/sprout/executable/file_param.rb,<br /> lib/sprout/executable/string_param.rb,<br /> lib/sprout/executable/collection_param.rb,<br /> lib/sprout/generators/tool/tool_generator.rb,<br /> lib/sprout/generators/ruby/ruby_generator.rb,<br /> lib/sprout/generators/library/library_generator.rb,<br /> lib/sprout/generators/generator/generator_generator.rb</span>
|
77
|
+
</dd>
|
78
|
+
|
79
|
+
</dl>
|
80
|
+
<div class="clear"></div>
|
81
|
+
|
82
|
+
<h2>Defined Under Namespace</h2>
|
83
|
+
<p class="children">
|
84
|
+
|
85
|
+
|
86
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Sprout/Concern.html" title="Sprout::Concern (module)">Concern</a></span>, <span class='object_link'><a href="Sprout/Errors.html" title="Sprout::Errors (module)">Errors</a></span>, <span class='object_link'><a href="Sprout/Executable.html" title="Sprout::Executable (module)">Executable</a></span>, <span class='object_link'><a href="Sprout/Generator.html" title="Sprout::Generator (module)">Generator</a></span>, <span class='object_link'><a href="Sprout/RubyFeature.html" title="Sprout::RubyFeature (module)">RubyFeature</a></span>, <span class='object_link'><a href="Sprout/System.html" title="Sprout::System (module)">System</a></span>, <span class='object_link'><a href="Sprout/TestHelper.html" title="Sprout::TestHelper (module)">TestHelper</a></span>, <span class='object_link'><a href="Sprout/VERSION.html" title="Sprout::VERSION (module)">VERSION</a></span>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Sprout/ArchiveUnpacker.html" title="Sprout::ArchiveUnpacker (class)">ArchiveUnpacker</a></span>, <span class='object_link'><a href="Sprout/CommandLine.html" title="Sprout::CommandLine (class)">CommandLine</a></span>, <span class='object_link'><a href="Sprout/FileTarget.html" title="Sprout::FileTarget (class)">FileTarget</a></span>, <span class='object_link'><a href="Sprout/GeneratorGenerator.html" title="Sprout::GeneratorGenerator (class)">GeneratorGenerator</a></span>, <span class='object_link'><a href="Sprout/Library.html" title="Sprout::Library (class)">Library</a></span>, <span class='object_link'><a href="Sprout/LibraryGenerator.html" title="Sprout::LibraryGenerator (class)">LibraryGenerator</a></span>, <span class='object_link'><a href="Sprout/OutputBuffer.html" title="Sprout::OutputBuffer (class)">OutputBuffer</a></span>, <span class='object_link'><a href="Sprout/Platform.html" title="Sprout::Platform (class)">Platform</a></span>, <span class='object_link'><a href="Sprout/ProcessRunner.html" title="Sprout::ProcessRunner (class)">ProcessRunner</a></span>, <span class='object_link'><a href="Sprout/ProgressBar.html" title="Sprout::ProgressBar (class)">ProgressBar</a></span>, <span class='object_link'><a href="Sprout/ProgressBarImpl.html" title="Sprout::ProgressBarImpl (class)">ProgressBarImpl</a></span>, <span class='object_link'><a href="Sprout/ProgressBarManager.html" title="Sprout::ProgressBarManager (class)">ProgressBarManager</a></span>, <span class='object_link'><a href="Sprout/ProgressBarOutputStream.html" title="Sprout::ProgressBarOutputStream (class)">ProgressBarOutputStream</a></span>, <span class='object_link'><a href="Sprout/RDocParser.html" title="Sprout::RDocParser (class)">RDocParser</a></span>, <span class='object_link'><a href="Sprout/RemoteFileLoader.html" title="Sprout::RemoteFileLoader (class)">RemoteFileLoader</a></span>, <span class='object_link'><a href="Sprout/RemoteFileTarget.html" title="Sprout::RemoteFileTarget (class)">RemoteFileTarget</a></span>, <span class='object_link'><a href="Sprout/ReversedProgressBar.html" title="Sprout::ReversedProgressBar (class)">ReversedProgressBar</a></span>, <span class='object_link'><a href="Sprout/RubyGenerator.html" title="Sprout::RubyGenerator (class)">RubyGenerator</a></span>, <span class='object_link'><a href="Sprout/Specification.html" title="Sprout::Specification (class)">Specification</a></span>, <span class='object_link'><a href="Sprout/ToolGenerator.html" title="Sprout::ToolGenerator (class)">ToolGenerator</a></span>
|
91
|
+
|
92
|
+
|
93
|
+
</p>
|
94
|
+
|
95
|
+
<h2>Constant Summary</h2>
|
96
|
+
|
97
|
+
<dl class="constants">
|
98
|
+
|
99
|
+
<dt id="NAME-constant" class="">NAME =
|
100
|
+
|
101
|
+
</dt>
|
102
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sprout</span><span class='tstring_end'>'</span></span></pre></dd>
|
103
|
+
|
104
|
+
</dl>
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
<h2>
|
115
|
+
Class Method Summary
|
116
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
117
|
+
</h2>
|
118
|
+
|
119
|
+
<ul class="summary">
|
120
|
+
|
121
|
+
<li class="public ">
|
122
|
+
<span class="summary_signature">
|
123
|
+
|
124
|
+
<a href="#cache-class_method" title="cache (class method)">+ (Dir) <strong>cache</strong> </a>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
</span>
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
<span class="summary_desc"><div class='inline'><p>
|
138
|
+
where Sprouts will look for downloaded archives.
|
139
|
+
</p>
|
140
|
+
</div></span>
|
141
|
+
|
142
|
+
</li>
|
143
|
+
|
144
|
+
|
145
|
+
<li class="public ">
|
146
|
+
<span class="summary_signature">
|
147
|
+
|
148
|
+
<a href="#current_system-class_method" title="current_system (class method)">+ (Sprout::System) <strong>current_system</strong> </a>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
</span>
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
<span class="summary_desc"><div class='inline'><p>
|
162
|
+
determine features like the cache path and how external processes are
|
163
|
+
executed.
|
164
|
+
</p>
|
165
|
+
</div></span>
|
166
|
+
|
167
|
+
</li>
|
168
|
+
|
169
|
+
|
170
|
+
<li class="public ">
|
171
|
+
<span class="summary_signature">
|
172
|
+
|
173
|
+
<a href="#file_from_caller-class_method" title="file_from_caller (class method)">+ (File) <strong>file_from_caller</strong>(caller_string) </a>
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
</span>
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
<span class="summary_desc"><div class='inline'><p>
|
187
|
+
a Ruby exception.
|
188
|
+
</p>
|
189
|
+
</div></span>
|
190
|
+
|
191
|
+
</li>
|
192
|
+
|
193
|
+
|
194
|
+
<li class="public ">
|
195
|
+
<span class="summary_signature">
|
196
|
+
|
197
|
+
<a href="#generator_cache-class_method" title="generator_cache (class method)">+ (Dir) <strong>generator_cache</strong> </a>
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
</span>
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
<span class="summary_desc"><div class='inline'><p>
|
211
|
+
templates.
|
212
|
+
</p>
|
213
|
+
</div></span>
|
214
|
+
|
215
|
+
</li>
|
216
|
+
|
217
|
+
|
218
|
+
<li class="public ">
|
219
|
+
<span class="summary_signature">
|
220
|
+
|
221
|
+
<a href="#home-class_method" title="home (class method)">+ (Dir) <strong>home</strong> </a>
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
</span>
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
<span class="summary_desc"><div class='inline'><p>
|
235
|
+
will write files and generators and their templates.
|
236
|
+
</p>
|
237
|
+
</div></span>
|
238
|
+
|
239
|
+
</li>
|
240
|
+
|
241
|
+
|
242
|
+
<li class="public ">
|
243
|
+
<span class="summary_signature">
|
244
|
+
|
245
|
+
<a href="#stderr-class_method" title="stderr (class method)">+ (Object) <strong>stderr</strong> </a>
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
</span>
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
259
|
+
|
260
|
+
</li>
|
261
|
+
|
262
|
+
|
263
|
+
<li class="public ">
|
264
|
+
<span class="summary_signature">
|
265
|
+
|
266
|
+
<a href="#stderr%3D-class_method" title="stderr= (class method)">+ (Object) <strong>stderr=</strong>(err) </a>
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
</span>
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
280
|
+
|
281
|
+
</li>
|
282
|
+
|
283
|
+
|
284
|
+
<li class="public ">
|
285
|
+
<span class="summary_signature">
|
286
|
+
|
287
|
+
<a href="#stdout-class_method" title="stdout (class method)">+ (Object) <strong>stdout</strong> </a>
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
</span>
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
301
|
+
|
302
|
+
</li>
|
303
|
+
|
304
|
+
|
305
|
+
<li class="public ">
|
306
|
+
<span class="summary_signature">
|
307
|
+
|
308
|
+
<a href="#stdout%3D-class_method" title="stdout= (class method)">+ (Object) <strong>stdout=</strong>(out) </a>
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
</span>
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
322
|
+
|
323
|
+
</li>
|
324
|
+
|
325
|
+
|
326
|
+
</ul>
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
<div id="class_method_details" class="method_details_list">
|
332
|
+
<h2>Class Method Details</h2>
|
333
|
+
|
334
|
+
|
335
|
+
<div class="method_details first">
|
336
|
+
<p class="signature first" id="cache-class_method">
|
337
|
+
|
338
|
+
+ (<tt><span class='object_link'><a href="Dir.html" title="Dir (class)">Dir</a></span></tt>) <strong>cache</strong>
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
</p><div class="docstring">
|
343
|
+
<div class="discussion">
|
344
|
+
<p>
|
345
|
+
where Sprouts will look for downloaded archives.
|
346
|
+
</p>
|
347
|
+
<pre class="code ruby"><code>
|
348
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>>> Sprout Cache: </span><span class='embexpr_beg'>#{</span><span class='const'>Sprout</span><span class='period'>.</span><span class='id identifier rubyid_cache'>cache</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span></code></pre>
|
349
|
+
|
350
|
+
|
351
|
+
</div>
|
352
|
+
</div>
|
353
|
+
<div class="tags">
|
354
|
+
|
355
|
+
<h3>Returns:</h3>
|
356
|
+
<ul class="return">
|
357
|
+
|
358
|
+
<li>
|
359
|
+
|
360
|
+
|
361
|
+
<span class='type'>(<tt><span class='object_link'><a href="Dir.html" title="Dir (class)">Dir</a></span></tt>)</span>
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
—
|
366
|
+
<div class='inline'><p>
|
367
|
+
The system-specific path to the writeable cache directory
|
368
|
+
</p>
|
369
|
+
</div>
|
370
|
+
|
371
|
+
</li>
|
372
|
+
|
373
|
+
</ul>
|
374
|
+
|
375
|
+
</div><table class="source_code">
|
376
|
+
<tr>
|
377
|
+
<td>
|
378
|
+
<pre class="lines">
|
379
|
+
|
380
|
+
|
381
|
+
63
|
382
|
+
64
|
383
|
+
65</pre>
|
384
|
+
</td>
|
385
|
+
<td>
|
386
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 63</span>
|
387
|
+
|
388
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cache'>cache</span>
|
389
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_home'>home</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cache</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
390
|
+
<span class='kw'>end</span></pre>
|
391
|
+
</td>
|
392
|
+
</tr>
|
393
|
+
</table>
|
394
|
+
</div>
|
395
|
+
|
396
|
+
<div class="method_details ">
|
397
|
+
<p class="signature " id="current_system-class_method">
|
398
|
+
|
399
|
+
+ (<tt><span class='object_link'><a href="Sprout/System.html" title="Sprout::System (module)">Sprout::System</a></span></tt>) <strong>current_system</strong>
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
</p><div class="docstring">
|
404
|
+
<div class="discussion">
|
405
|
+
<p>
|
406
|
+
determine features like the cache path and how external processes are
|
407
|
+
executed.
|
408
|
+
</p>
|
409
|
+
<pre class="code ruby"><code>
|
410
|
+
<span class='id identifier rubyid_system'>system</span> <span class='op'>=</span> <span class='const'>Sprout</span><span class='period'>.</span><span class='id identifier rubyid_current_system'>current_system</span>
|
411
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>>> System: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span></code></pre>
|
412
|
+
|
413
|
+
|
414
|
+
</div>
|
415
|
+
</div>
|
416
|
+
<div class="tags">
|
417
|
+
|
418
|
+
<h3>Returns:</h3>
|
419
|
+
<ul class="return">
|
420
|
+
|
421
|
+
<li>
|
422
|
+
|
423
|
+
|
424
|
+
<span class='type'>(<tt><span class='object_link'><a href="Sprout/System.html" title="Sprout::System (module)">Sprout::System</a></span></tt>)</span>
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
—
|
429
|
+
<div class='inline'><p>
|
430
|
+
That is currently being used to
|
431
|
+
</p>
|
432
|
+
</div>
|
433
|
+
|
434
|
+
</li>
|
435
|
+
|
436
|
+
</ul>
|
437
|
+
|
438
|
+
</div><table class="source_code">
|
439
|
+
<tr>
|
440
|
+
<td>
|
441
|
+
<pre class="lines">
|
442
|
+
|
443
|
+
|
444
|
+
95
|
445
|
+
96
|
446
|
+
97</pre>
|
447
|
+
</td>
|
448
|
+
<td>
|
449
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 95</span>
|
450
|
+
|
451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_current_system'>current_system</span>
|
452
|
+
<span class='const'>Sprout</span><span class='op'>::</span><span class='const'>System</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span>
|
453
|
+
<span class='kw'>end</span></pre>
|
454
|
+
</td>
|
455
|
+
</tr>
|
456
|
+
</table>
|
457
|
+
</div>
|
458
|
+
|
459
|
+
<div class="method_details ">
|
460
|
+
<p class="signature " id="file_from_caller-class_method">
|
461
|
+
|
462
|
+
+ (<tt>File</tt>) <strong>file_from_caller</strong>(caller_string)
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
</p><div class="docstring">
|
467
|
+
<div class="discussion">
|
468
|
+
<p>
|
469
|
+
a Ruby exception.
|
470
|
+
</p>
|
471
|
+
<p>
|
472
|
+
Note: It’s a real bummer that this string is colon delimited - The
|
473
|
+
value on Windows often includes a colon… Once again, Windows is
|
474
|
+
dissed by fundamental Ruby decisions.
|
475
|
+
</p>
|
476
|
+
|
477
|
+
|
478
|
+
</div>
|
479
|
+
</div>
|
480
|
+
<div class="tags">
|
481
|
+
|
482
|
+
<h3>Returns:</h3>
|
483
|
+
<ul class="return">
|
484
|
+
|
485
|
+
<li>
|
486
|
+
|
487
|
+
|
488
|
+
<span class='type'>(<tt>File</tt>)</span>
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
—
|
493
|
+
<div class='inline'><p>
|
494
|
+
Path to the file from the ‘caller’ property of
|
495
|
+
</p>
|
496
|
+
</div>
|
497
|
+
|
498
|
+
</li>
|
499
|
+
|
500
|
+
</ul>
|
501
|
+
|
502
|
+
</div><table class="source_code">
|
503
|
+
<tr>
|
504
|
+
<td>
|
505
|
+
<pre class="lines">
|
506
|
+
|
507
|
+
|
508
|
+
122
|
509
|
+
123
|
510
|
+
124
|
511
|
+
125
|
512
|
+
126
|
513
|
+
127
|
514
|
+
128
|
515
|
+
129</pre>
|
516
|
+
</td>
|
517
|
+
<td>
|
518
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 122</span>
|
519
|
+
|
520
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_file_from_caller'>file_from_caller</span> <span class='id identifier rubyid_caller_string'>caller_string</span>
|
521
|
+
<span class='id identifier rubyid_parts'>parts</span> <span class='op'>=</span> <span class='id identifier rubyid_caller_string'>caller_string</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
522
|
+
<span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
|
523
|
+
<span class='kw'>while</span><span class='lparen'>(</span><span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>&&</span> <span class='op'>!</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
524
|
+
<span class='id identifier rubyid_str'>str</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
525
|
+
<span class='kw'>end</span>
|
526
|
+
<span class='id identifier rubyid_str'>str</span>
|
527
|
+
<span class='kw'>end</span></pre>
|
528
|
+
</td>
|
529
|
+
</tr>
|
530
|
+
</table>
|
531
|
+
</div>
|
532
|
+
|
533
|
+
<div class="method_details ">
|
534
|
+
<p class="signature " id="generator_cache-class_method">
|
535
|
+
|
536
|
+
+ (<tt><span class='object_link'><a href="Dir.html" title="Dir (class)">Dir</a></span></tt>) <strong>generator_cache</strong>
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
</p><div class="docstring">
|
541
|
+
<div class="discussion">
|
542
|
+
<p>
|
543
|
+
templates.
|
544
|
+
</p>
|
545
|
+
<pre class="code ruby"><code>
|
546
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>>> Generator Cache: </span><span class='embexpr_beg'>#{</span><span class='const'>Sprout</span><span class='period'>.</span><span class='id identifier rubyid_generator_cache'>generator_cache</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span></code></pre>
|
547
|
+
|
548
|
+
|
549
|
+
</div>
|
550
|
+
</div>
|
551
|
+
<div class="tags">
|
552
|
+
|
553
|
+
<h3>Returns:</h3>
|
554
|
+
<ul class="return">
|
555
|
+
|
556
|
+
<li>
|
557
|
+
|
558
|
+
|
559
|
+
<span class='type'>(<tt><span class='object_link'><a href="Dir.html" title="Dir (class)">Dir</a></span></tt>)</span>
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
—
|
564
|
+
<div class='inline'><p>
|
565
|
+
The location where Sprouts will look for generators and their
|
566
|
+
</p>
|
567
|
+
</div>
|
568
|
+
|
569
|
+
</li>
|
570
|
+
|
571
|
+
</ul>
|
572
|
+
|
573
|
+
</div><table class="source_code">
|
574
|
+
<tr>
|
575
|
+
<td>
|
576
|
+
<pre class="lines">
|
577
|
+
|
578
|
+
|
579
|
+
83
|
580
|
+
84
|
581
|
+
85</pre>
|
582
|
+
</td>
|
583
|
+
<td>
|
584
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 83</span>
|
585
|
+
|
586
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_generator_cache'>generator_cache</span>
|
587
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span> <span class='id identifier rubyid_cache'>cache</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>generators</span><span class='tstring_end'>'</span></span>
|
588
|
+
<span class='kw'>end</span></pre>
|
589
|
+
</td>
|
590
|
+
</tr>
|
591
|
+
</table>
|
592
|
+
</div>
|
593
|
+
|
594
|
+
<div class="method_details ">
|
595
|
+
<p class="signature " id="home-class_method">
|
596
|
+
|
597
|
+
+ (<tt><span class='object_link'><a href="Dir.html" title="Dir (class)">Dir</a></span></tt>) <strong>home</strong>
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
</p><div class="docstring">
|
602
|
+
<div class="discussion">
|
603
|
+
<p>
|
604
|
+
will write files and generators and their templates.
|
605
|
+
</p>
|
606
|
+
<pre class="code ruby"><code>
|
607
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>>> Sprout home: </span><span class='embexpr_beg'>#{</span><span class='const'>Sprout</span><span class='period'>.</span><span class='id identifier rubyid_home'>home</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span></code></pre>
|
608
|
+
|
609
|
+
|
610
|
+
</div>
|
611
|
+
</div>
|
612
|
+
<div class="tags">
|
613
|
+
|
614
|
+
<h3>Returns:</h3>
|
615
|
+
<ul class="return">
|
616
|
+
|
617
|
+
<li>
|
618
|
+
|
619
|
+
|
620
|
+
<span class='type'>(<tt><span class='object_link'><a href="Dir.html" title="Dir (class)">Dir</a></span></tt>)</span>
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
—
|
625
|
+
<div class='inline'><p>
|
626
|
+
The location where the currently-running version of Sprouts
|
627
|
+
</p>
|
628
|
+
</div>
|
629
|
+
|
630
|
+
</li>
|
631
|
+
|
632
|
+
</ul>
|
633
|
+
|
634
|
+
</div><table class="source_code">
|
635
|
+
<tr>
|
636
|
+
<td>
|
637
|
+
<pre class="lines">
|
638
|
+
|
639
|
+
|
640
|
+
73
|
641
|
+
74
|
642
|
+
75</pre>
|
643
|
+
</td>
|
644
|
+
<td>
|
645
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 73</span>
|
646
|
+
|
647
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_home'>home</span>
|
648
|
+
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_current_system'>current_system</span><span class='period'>.</span><span class='id identifier rubyid_application_home'>application_home</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sprouts</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>VERSION</span><span class='op'>::</span><span class='const'>MAJOR_MINOR</span><span class='rparen'>)</span>
|
649
|
+
<span class='kw'>end</span></pre>
|
650
|
+
</td>
|
651
|
+
</tr>
|
652
|
+
</table>
|
653
|
+
</div>
|
654
|
+
|
655
|
+
<div class="method_details ">
|
656
|
+
<p class="signature " id="stderr-class_method">
|
657
|
+
|
658
|
+
+ (<tt>Object</tt>) <strong>stderr</strong>
|
659
|
+
|
660
|
+
|
661
|
+
|
662
|
+
</p><table class="source_code">
|
663
|
+
<tr>
|
664
|
+
<td>
|
665
|
+
<pre class="lines">
|
666
|
+
|
667
|
+
|
668
|
+
111
|
669
|
+
112
|
670
|
+
113</pre>
|
671
|
+
</td>
|
672
|
+
<td>
|
673
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 111</span>
|
674
|
+
|
675
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stderr'>stderr</span>
|
676
|
+
<span class='ivar'>@stderr</span> <span class='op'>||=</span> <span class='gvar'>$stderr</span>
|
677
|
+
<span class='kw'>end</span></pre>
|
678
|
+
</td>
|
679
|
+
</tr>
|
680
|
+
</table>
|
681
|
+
</div>
|
682
|
+
|
683
|
+
<div class="method_details ">
|
684
|
+
<p class="signature " id="stderr=-class_method">
|
685
|
+
|
686
|
+
+ (<tt>Object</tt>) <strong>stderr=</strong>(err)
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
</p><table class="source_code">
|
691
|
+
<tr>
|
692
|
+
<td>
|
693
|
+
<pre class="lines">
|
694
|
+
|
695
|
+
|
696
|
+
107
|
697
|
+
108
|
698
|
+
109</pre>
|
699
|
+
</td>
|
700
|
+
<td>
|
701
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 107</span>
|
702
|
+
|
703
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stderr='>stderr=</span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='rparen'>)</span>
|
704
|
+
<span class='ivar'>@stderr</span> <span class='op'>=</span> <span class='id identifier rubyid_err'>err</span>
|
705
|
+
<span class='kw'>end</span></pre>
|
706
|
+
</td>
|
707
|
+
</tr>
|
708
|
+
</table>
|
709
|
+
</div>
|
710
|
+
|
711
|
+
<div class="method_details ">
|
712
|
+
<p class="signature " id="stdout-class_method">
|
713
|
+
|
714
|
+
+ (<tt>Object</tt>) <strong>stdout</strong>
|
715
|
+
|
716
|
+
|
717
|
+
|
718
|
+
</p><table class="source_code">
|
719
|
+
<tr>
|
720
|
+
<td>
|
721
|
+
<pre class="lines">
|
722
|
+
|
723
|
+
|
724
|
+
103
|
725
|
+
104
|
726
|
+
105</pre>
|
727
|
+
</td>
|
728
|
+
<td>
|
729
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 103</span>
|
730
|
+
|
731
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stdout'>stdout</span>
|
732
|
+
<span class='ivar'>@stdout</span> <span class='op'>||=</span> <span class='gvar'>$stdout</span>
|
733
|
+
<span class='kw'>end</span></pre>
|
734
|
+
</td>
|
735
|
+
</tr>
|
736
|
+
</table>
|
737
|
+
</div>
|
738
|
+
|
739
|
+
<div class="method_details ">
|
740
|
+
<p class="signature " id="stdout=-class_method">
|
741
|
+
|
742
|
+
+ (<tt>Object</tt>) <strong>stdout=</strong>(out)
|
743
|
+
|
744
|
+
|
745
|
+
|
746
|
+
</p><table class="source_code">
|
747
|
+
<tr>
|
748
|
+
<td>
|
749
|
+
<pre class="lines">
|
750
|
+
|
751
|
+
|
752
|
+
99
|
753
|
+
100
|
754
|
+
101</pre>
|
755
|
+
</td>
|
756
|
+
<td>
|
757
|
+
<pre class="code"><span class="info file"># File 'lib/sprout.rb', line 99</span>
|
758
|
+
|
759
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stdout='>stdout=</span><span class='lparen'>(</span><span class='id identifier rubyid_out'>out</span><span class='rparen'>)</span>
|
760
|
+
<span class='ivar'>@stdout</span> <span class='op'>=</span> <span class='id identifier rubyid_out'>out</span>
|
761
|
+
<span class='kw'>end</span></pre>
|
762
|
+
</td>
|
763
|
+
</tr>
|
764
|
+
</table>
|
765
|
+
</div>
|
766
|
+
|
767
|
+
</div>
|
768
|
+
|
769
|
+
</div>
|
770
|
+
|
771
|
+
<div id="footer">
|
772
|
+
Generated on Sun Mar 11 14:30:31 2012 by
|
773
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
774
|
+
0.7.5 (ruby-1.9.2).
|
775
|
+
</div>
|
776
|
+
|
777
|
+
</body>
|
778
|
+
</html>
|