sprout 1.0.11.pre → 1.0.13.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/lib/sprout/executable.rb +37 -10
- data/lib/sprout/generator/base.rb +17 -0
- data/lib/sprout/ruby_feature.rb +1 -1
- data/lib/sprout/version.rb +1 -1
- data/rdoc/<.html +274 -0
- data/rdoc/Dir.html +387 -0
- data/rdoc/Object.html +344 -0
- data/rdoc/Sprout.html +440 -0
- data/rdoc/Sprout/ArchiveUnpacker.html +1045 -0
- data/rdoc/Sprout/Base.html +283 -0
- data/rdoc/Sprout/Base/ClassMethods.html +474 -0
- data/rdoc/Sprout/Concern.html +415 -0
- data/rdoc/Sprout/Errors.html +324 -0
- data/rdoc/Sprout/Errors/ArchiveUnpackerError.html +284 -0
- data/rdoc/Sprout/Errors/DestinationExistsError.html +286 -0
- data/rdoc/Sprout/Errors/DuplicateMemberError.html +284 -0
- data/rdoc/Sprout/Errors/ExecutableError.html +285 -0
- data/rdoc/Sprout/Errors/ExecutableRegistrationError.html +284 -0
- data/rdoc/Sprout/Errors/ExecutionError.html +284 -0
- data/rdoc/Sprout/Errors/GeneratorError.html +284 -0
- data/rdoc/Sprout/Errors/InvalidArgumentError.html +284 -0
- data/rdoc/Sprout/Errors/LoadError.html +284 -0
- data/rdoc/Sprout/Errors/MissingArgumentError.html +284 -0
- data/rdoc/Sprout/Errors/MissingExecutableError.html +284 -0
- data/rdoc/Sprout/Errors/MissingGeneratorError.html +285 -0
- data/rdoc/Sprout/Errors/MissingTemplateError.html +285 -0
- data/rdoc/Sprout/Errors/ProcessRunnerError.html +284 -0
- data/rdoc/Sprout/Errors/RemoteFileLoaderError.html +284 -0
- data/rdoc/Sprout/Errors/SproutError.html +284 -0
- data/rdoc/Sprout/Errors/UnknownArchiveType.html +285 -0
- data/rdoc/Sprout/Errors/UsageError.html +284 -0
- data/rdoc/Sprout/Errors/ValidationError.html +284 -0
- data/rdoc/Sprout/Errors/VersionRequirementNotMetError.html +284 -0
- data/rdoc/Sprout/Executable.html +549 -0
- data/rdoc/Sprout/Executable/Boolean.html +445 -0
- data/rdoc/Sprout/Executable/ClassMethods.html +713 -0
- data/rdoc/Sprout/Executable/CollectionParam.html +501 -0
- data/rdoc/Sprout/Executable/FileParam.html +512 -0
- data/rdoc/Sprout/Executable/Files.html +385 -0
- data/rdoc/Sprout/Executable/InstanceMethods.html +1597 -0
- data/rdoc/Sprout/Executable/Number.html +284 -0
- data/rdoc/Sprout/Executable/Param.html +1660 -0
- data/rdoc/Sprout/Executable/ParameterFactory.html +345 -0
- data/rdoc/Sprout/Executable/Path.html +339 -0
- data/rdoc/Sprout/Executable/Paths.html +339 -0
- data/rdoc/Sprout/Executable/StringParam.html +333 -0
- data/rdoc/Sprout/Executable/Strings.html +295 -0
- data/rdoc/Sprout/Executable/Url.html +284 -0
- data/rdoc/Sprout/Executable/Urls.html +284 -0
- data/rdoc/Sprout/FileTarget.html +660 -0
- data/rdoc/Sprout/Generator.html +643 -0
- data/rdoc/Sprout/Generator/Base.html +1143 -0
- data/rdoc/Sprout/Generator/Command.html +604 -0
- data/rdoc/Sprout/Generator/DirectoryManifest.html +561 -0
- data/rdoc/Sprout/Generator/FileManifest.html +545 -0
- data/rdoc/Sprout/Generator/Manifest.html +387 -0
- data/rdoc/Sprout/Generator/TemplateManifest.html +331 -0
- data/rdoc/Sprout/GeneratorGenerator.html +358 -0
- data/rdoc/Sprout/Library.html +646 -0
- data/rdoc/Sprout/LibraryGenerator.html +368 -0
- data/rdoc/Sprout/Log.html +281 -0
- data/rdoc/Sprout/Platform.html +610 -0
- data/rdoc/Sprout/ProcessRunner.html +1145 -0
- data/rdoc/Sprout/ProgressBar.html +281 -0
- data/rdoc/Sprout/ProgressBarImpl.html +281 -0
- data/rdoc/Sprout/ProgressBarManager.html +281 -0
- data/rdoc/Sprout/ProgressBarOutputStream.html +281 -0
- data/rdoc/Sprout/RDocParser.html +702 -0
- data/rdoc/Sprout/RemoteFileLoader.html +537 -0
- data/rdoc/Sprout/RemoteFileTarget.html +741 -0
- data/rdoc/Sprout/ReversedProgressBar.html +281 -0
- data/rdoc/Sprout/RubyFeature.html +324 -0
- data/rdoc/Sprout/RubyFeature/ClassMethods.html +821 -0
- data/rdoc/Sprout/RubyGenerator.html +576 -0
- data/rdoc/Sprout/Specification.html +915 -0
- data/rdoc/Sprout/System.html +383 -0
- data/rdoc/Sprout/System/BaseSystem.html +1173 -0
- data/rdoc/Sprout/System/JavaSystem.html +284 -0
- data/rdoc/Sprout/System/OSXSystem.html +419 -0
- data/rdoc/Sprout/System/ThreadMock.html +281 -0
- data/rdoc/Sprout/System/UnixSystem.html +583 -0
- data/rdoc/Sprout/System/VistaSystem.html +367 -0
- data/rdoc/Sprout/System/WinNixSystem.html +417 -0
- data/rdoc/Sprout/System/WinSystem.html +672 -0
- data/rdoc/Sprout/ToolGenerator.html +376 -0
- data/rdoc/Sprout/VERSION.html +274 -0
- data/rdoc/SproutTestCase.html +279 -0
- data/rdoc/String.html +411 -0
- data/rdoc/created.rid +61 -0
- data/rdoc/index.html +795 -0
- data/rdoc/lib/sprout/archive_unpacker_rb.html +56 -0
- data/rdoc/lib/sprout/base_rb.html +111 -0
- data/rdoc/lib/sprout/concern_rb.html +52 -0
- data/rdoc/lib/sprout/dir_rb.html +52 -0
- data/rdoc/lib/sprout/errors_rb.html +52 -0
- data/rdoc/lib/sprout/executable/boolean_rb.html +52 -0
- data/rdoc/lib/sprout/executable/collection_param_rb.html +52 -0
- data/rdoc/lib/sprout/executable/file_param_rb.html +52 -0
- data/rdoc/lib/sprout/executable/files_rb.html +52 -0
- data/rdoc/lib/sprout/executable/number_rb.html +52 -0
- data/rdoc/lib/sprout/executable/param_rb.html +52 -0
- data/rdoc/lib/sprout/executable/parameter_factory_rb.html +52 -0
- data/rdoc/lib/sprout/executable/path_rb.html +52 -0
- data/rdoc/lib/sprout/executable/paths_rb.html +52 -0
- data/rdoc/lib/sprout/executable/string_param_rb.html +52 -0
- data/rdoc/lib/sprout/executable/strings_rb.html +52 -0
- data/rdoc/lib/sprout/executable/url_rb.html +52 -0
- data/rdoc/lib/sprout/executable/urls_rb.html +52 -0
- data/rdoc/lib/sprout/executable_rb.html +78 -0
- data/rdoc/lib/sprout/file_target_rb.html +52 -0
- data/rdoc/lib/sprout/generator/base_rb.html +54 -0
- data/rdoc/lib/sprout/generator/command_rb.html +52 -0
- data/rdoc/lib/sprout/generator/directory_manifest_rb.html +52 -0
- data/rdoc/lib/sprout/generator/file_manifest_rb.html +52 -0
- data/rdoc/lib/sprout/generator/manifest_rb.html +52 -0
- data/rdoc/lib/sprout/generator/template_manifest_rb.html +52 -0
- data/rdoc/lib/sprout/generators/generator/generator_generator_rb.html +52 -0
- data/rdoc/lib/sprout/generators/generator/templates/generator_test_helper_rb.html +64 -0
- data/rdoc/lib/sprout/generators/library/library_generator_rb.html +52 -0
- data/rdoc/lib/sprout/generators/ruby/ruby_generator_rb.html +52 -0
- data/rdoc/lib/sprout/generators/ruby/templates/ruby_base_rb.html +54 -0
- data/rdoc/lib/sprout/generators/tool/tool_generator_rb.html +52 -0
- data/rdoc/lib/sprout/library_rb.html +52 -0
- data/rdoc/lib/sprout/log_rb.html +52 -0
- data/rdoc/lib/sprout/platform_rb.html +52 -0
- data/rdoc/lib/sprout/process_runner_rb.html +58 -0
- data/rdoc/lib/sprout/progress_bar_rb.html +72 -0
- data/rdoc/lib/sprout/rdoc_parser_rb.html +54 -0
- data/rdoc/lib/sprout/remote_file_loader_rb.html +54 -0
- data/rdoc/lib/sprout/remote_file_target_rb.html +52 -0
- data/rdoc/lib/sprout/ruby_feature_rb.html +52 -0
- data/rdoc/lib/sprout/specification_rb.html +52 -0
- data/rdoc/lib/sprout/string_rb.html +52 -0
- data/rdoc/lib/sprout/system/base_system_rb.html +52 -0
- data/rdoc/lib/sprout/system/java_system_rb.html +52 -0
- data/rdoc/lib/sprout/system/osx_system_rb.html +52 -0
- data/rdoc/lib/sprout/system/unix_system_rb.html +52 -0
- data/rdoc/lib/sprout/system/vista_system_rb.html +52 -0
- data/rdoc/lib/sprout/system/win_nix_system_rb.html +52 -0
- data/rdoc/lib/sprout/system/win_system_rb.html +52 -0
- data/rdoc/lib/sprout/system_rb.html +66 -0
- data/rdoc/lib/sprout/test/sprout_test_case_rb.html +57 -0
- data/rdoc/lib/sprout/version_rb.html +52 -0
- data/rdoc/lib/sprout_rb.html +54 -0
- data/rdoc/rdoc.css +706 -0
- data/test/fixtures/executable/mxmlc.rb +2 -2
- data/test/unit/executable_test.rb +13 -0
- data/test/unit/generator_test.rb +25 -2
- metadata +144 -3
@@ -0,0 +1,1143 @@
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
7
|
+
|
8
|
+
<title>Class: Sprout::Generator::Base</title>
|
9
|
+
|
10
|
+
<link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
|
11
|
+
|
12
|
+
<script src="../../js/jquery.js" type="text/javascript"
|
13
|
+
charset="utf-8"></script>
|
14
|
+
<script src="../../js/thickbox-compressed.js" type="text/javascript"
|
15
|
+
charset="utf-8"></script>
|
16
|
+
<script src="../../js/quicksearch.js" type="text/javascript"
|
17
|
+
charset="utf-8"></script>
|
18
|
+
<script src="../../js/darkfish.js" type="text/javascript"
|
19
|
+
charset="utf-8"></script>
|
20
|
+
|
21
|
+
</head>
|
22
|
+
<body class="class">
|
23
|
+
|
24
|
+
<div id="metadata">
|
25
|
+
<div id="home-metadata">
|
26
|
+
<div id="home-section" class="section">
|
27
|
+
<h3 class="section-header">
|
28
|
+
<a href="../../index.html">Home</a>
|
29
|
+
<a href="../../index.html#classes">Classes</a>
|
30
|
+
<a href="../../index.html#methods">Methods</a>
|
31
|
+
</h3>
|
32
|
+
</div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="file-metadata">
|
36
|
+
<div id="file-list-section" class="section">
|
37
|
+
<h3 class="section-header">In Files</h3>
|
38
|
+
<div class="section-body">
|
39
|
+
<ul>
|
40
|
+
|
41
|
+
<li><a href="../../lib/sprout/generator/base_rb.html?TB_iframe=true&height=550&width=785"
|
42
|
+
class="thickbox" title="lib/sprout/generator/base.rb">lib/sprout/generator/base.rb</a></li>
|
43
|
+
|
44
|
+
</ul>
|
45
|
+
</div>
|
46
|
+
</div>
|
47
|
+
|
48
|
+
|
49
|
+
</div>
|
50
|
+
|
51
|
+
<div id="class-metadata">
|
52
|
+
|
53
|
+
<!-- Parent Class -->
|
54
|
+
|
55
|
+
<div id="parent-class-section" class="section">
|
56
|
+
<h3 class="section-header">Parent</h3>
|
57
|
+
|
58
|
+
<p class="link"><a href="../../Object.html">Object</a></p>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
|
62
|
+
|
63
|
+
<!-- Namespace Contents -->
|
64
|
+
|
65
|
+
|
66
|
+
<!-- Method Quickref -->
|
67
|
+
|
68
|
+
<div id="method-list-section" class="section">
|
69
|
+
<h3 class="section-header">Methods</h3>
|
70
|
+
<ul class="link-list">
|
71
|
+
|
72
|
+
<li><a href="#method-c-inherited">::inherited</a></li>
|
73
|
+
|
74
|
+
<li><a href="#method-c-template_from_caller">::template_from_caller</a></li>
|
75
|
+
|
76
|
+
<li><a href="#method-i-default_search_paths">#default_search_paths</a></li>
|
77
|
+
|
78
|
+
<li><a href="#method-i-destroy">#destroy</a></li>
|
79
|
+
|
80
|
+
<li><a href="#method-i-directory">#directory</a></li>
|
81
|
+
|
82
|
+
<li><a href="#method-i-execute">#execute</a></li>
|
83
|
+
|
84
|
+
<li><a href="#method-i-file">#file</a></li>
|
85
|
+
|
86
|
+
<li><a href="#method-i-force">#force</a></li>
|
87
|
+
|
88
|
+
<li><a href="#method-i-input">#input</a></li>
|
89
|
+
|
90
|
+
<li><a href="#method-i-name">#name</a></li>
|
91
|
+
|
92
|
+
<li><a href="#method-i-path">#path</a></li>
|
93
|
+
|
94
|
+
<li><a href="#method-i-prepare_command">#prepare_command</a></li>
|
95
|
+
|
96
|
+
<li><a href="#method-i-quiet">#quiet</a></li>
|
97
|
+
|
98
|
+
<li><a href="#method-i-resolve_template">#resolve_template</a></li>
|
99
|
+
|
100
|
+
<li><a href="#method-i-say">#say</a></li>
|
101
|
+
|
102
|
+
<li><a href="#method-i-template">#template</a></li>
|
103
|
+
|
104
|
+
<li><a href="#method-i-template_paths">#template_paths</a></li>
|
105
|
+
|
106
|
+
<li><a href="#method-i-templates">#templates</a></li>
|
107
|
+
|
108
|
+
<li><a href="#method-i-unexecute">#unexecute</a></li>
|
109
|
+
|
110
|
+
</ul>
|
111
|
+
</div>
|
112
|
+
|
113
|
+
|
114
|
+
<!-- Included Modules -->
|
115
|
+
|
116
|
+
<div id="includes-section" class="section">
|
117
|
+
<h3 class="section-header">Included Modules</h3>
|
118
|
+
<ul class="link-list">
|
119
|
+
|
120
|
+
|
121
|
+
<li><a class="include" href="../Executable.html">Sprout::Executable</a></li>
|
122
|
+
|
123
|
+
|
124
|
+
</ul>
|
125
|
+
</div>
|
126
|
+
|
127
|
+
</div>
|
128
|
+
|
129
|
+
<div id="project-metadata">
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
<div id="classindex-section" class="section project-section">
|
134
|
+
<h3 class="section-header">Class Index
|
135
|
+
<span class="search-toggle"><img src="../../images/find.png"
|
136
|
+
height="16" width="16" alt="[+]"
|
137
|
+
title="show/hide quicksearch" /></span></h3>
|
138
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
139
|
+
<fieldset>
|
140
|
+
<legend>Quicksearch</legend>
|
141
|
+
<input type="text" name="quicksearch" value=""
|
142
|
+
class="quicksearch-field" />
|
143
|
+
</fieldset>
|
144
|
+
</form>
|
145
|
+
|
146
|
+
<ul class="link-list">
|
147
|
+
|
148
|
+
<li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
|
149
|
+
|
150
|
+
<li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
|
151
|
+
|
152
|
+
<li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
|
153
|
+
|
154
|
+
<li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
|
155
|
+
|
156
|
+
<li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
|
157
|
+
|
158
|
+
<li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
|
159
|
+
|
160
|
+
<li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
|
161
|
+
|
162
|
+
<li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
|
163
|
+
|
164
|
+
<li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
|
165
|
+
|
166
|
+
<li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
|
167
|
+
|
168
|
+
<li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
|
169
|
+
|
170
|
+
<li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
|
171
|
+
|
172
|
+
<li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
|
173
|
+
|
174
|
+
<li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
|
175
|
+
|
176
|
+
<li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
|
177
|
+
|
178
|
+
<li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
|
179
|
+
|
180
|
+
<li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
|
181
|
+
|
182
|
+
<li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
|
183
|
+
|
184
|
+
<li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
|
185
|
+
|
186
|
+
<li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
|
187
|
+
|
188
|
+
<li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
|
189
|
+
|
190
|
+
<li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
|
191
|
+
|
192
|
+
<li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
|
193
|
+
|
194
|
+
<li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
|
195
|
+
|
196
|
+
<li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
|
197
|
+
|
198
|
+
<li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
|
199
|
+
|
200
|
+
<li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
|
201
|
+
|
202
|
+
<li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
|
203
|
+
|
204
|
+
<li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
|
205
|
+
|
206
|
+
<li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
|
207
|
+
|
208
|
+
<li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
|
209
|
+
|
210
|
+
<li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
|
211
|
+
|
212
|
+
<li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
|
213
|
+
|
214
|
+
<li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
|
215
|
+
|
216
|
+
<li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
|
217
|
+
|
218
|
+
<li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
|
219
|
+
|
220
|
+
<li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
|
221
|
+
|
222
|
+
<li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
|
223
|
+
|
224
|
+
<li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
|
225
|
+
|
226
|
+
<li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
|
227
|
+
|
228
|
+
<li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
|
229
|
+
|
230
|
+
<li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
|
231
|
+
|
232
|
+
<li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
|
233
|
+
|
234
|
+
<li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
|
235
|
+
|
236
|
+
<li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
|
237
|
+
|
238
|
+
<li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
|
239
|
+
|
240
|
+
<li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
|
241
|
+
|
242
|
+
<li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
|
243
|
+
|
244
|
+
<li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
|
245
|
+
|
246
|
+
<li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
|
247
|
+
|
248
|
+
<li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
|
249
|
+
|
250
|
+
<li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
|
251
|
+
|
252
|
+
<li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
|
253
|
+
|
254
|
+
<li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
|
255
|
+
|
256
|
+
<li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
|
257
|
+
|
258
|
+
<li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
|
259
|
+
|
260
|
+
<li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
|
261
|
+
|
262
|
+
<li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
|
263
|
+
|
264
|
+
<li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
|
265
|
+
|
266
|
+
<li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
|
267
|
+
|
268
|
+
<li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
|
269
|
+
|
270
|
+
<li><a href="../../Sprout/System.html">Sprout::System</a></li>
|
271
|
+
|
272
|
+
<li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
|
273
|
+
|
274
|
+
<li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
|
275
|
+
|
276
|
+
<li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
|
277
|
+
|
278
|
+
<li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
|
279
|
+
|
280
|
+
<li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
|
281
|
+
|
282
|
+
<li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
|
283
|
+
|
284
|
+
<li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
|
285
|
+
|
286
|
+
<li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
|
287
|
+
|
288
|
+
<li><a href="../../<.html"><</a></li>
|
289
|
+
|
290
|
+
<li><a href="../../Dir.html">Dir</a></li>
|
291
|
+
|
292
|
+
<li><a href="../../Object.html">Object</a></li>
|
293
|
+
|
294
|
+
<li><a href="../../String.html">String</a></li>
|
295
|
+
|
296
|
+
</ul>
|
297
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
298
|
+
</div>
|
299
|
+
|
300
|
+
|
301
|
+
</div>
|
302
|
+
</div>
|
303
|
+
|
304
|
+
<div id="documentation">
|
305
|
+
<h1 class="class">Sprout::Generator::Base</h1>
|
306
|
+
|
307
|
+
<div id="description">
|
308
|
+
|
309
|
+
</div>
|
310
|
+
|
311
|
+
<!-- Constants -->
|
312
|
+
|
313
|
+
|
314
|
+
<!-- Attributes -->
|
315
|
+
|
316
|
+
<div id="attribute-method-details" class="method-section section">
|
317
|
+
<h3 class="section-header">Attributes</h3>
|
318
|
+
|
319
|
+
|
320
|
+
<div id="name-attribute-method" class="method-detail">
|
321
|
+
<a name="name"></a>
|
322
|
+
|
323
|
+
<a name="name="></a>
|
324
|
+
|
325
|
+
<div class="method-heading attribute-method-heading">
|
326
|
+
<span class="method-name">name</span><span
|
327
|
+
class="attribute-access-type">[RW]</span>
|
328
|
+
</div>
|
329
|
+
|
330
|
+
<div class="method-description">
|
331
|
+
|
332
|
+
<p>
|
333
|
+
The symbol name for which this generator is most appropriate.
|
334
|
+
</p>
|
335
|
+
<p>
|
336
|
+
This value defaults to :application so, if you’re working on an
|
337
|
+
application generator, you can leave it as the default.
|
338
|
+
</p>
|
339
|
+
<p>
|
340
|
+
For all other generator types, you’ll want to select the most general
|
341
|
+
project type that this generator may be useful in.
|
342
|
+
</p>
|
343
|
+
<p>
|
344
|
+
Following are some example values:
|
345
|
+
</p>
|
346
|
+
<pre>
|
347
|
+
:as3, :flex3, :flex4, :air2
|
348
|
+
</pre>
|
349
|
+
<p>
|
350
|
+
or core libraries:
|
351
|
+
</p>
|
352
|
+
<pre>
|
353
|
+
:asunit4, :flexunit4
|
354
|
+
</pre>
|
355
|
+
<p>
|
356
|
+
or even other libraries:
|
357
|
+
</p>
|
358
|
+
<pre>
|
359
|
+
:puremvc, :robotlegs, :swizz</pre>
|
360
|
+
|
361
|
+
</div>
|
362
|
+
</div>
|
363
|
+
|
364
|
+
<div id="logger-attribute-method" class="method-detail">
|
365
|
+
<a name="logger"></a>
|
366
|
+
|
367
|
+
<a name="logger="></a>
|
368
|
+
|
369
|
+
<div class="method-heading attribute-method-heading">
|
370
|
+
<span class="method-name">logger</span><span
|
371
|
+
class="attribute-access-type">[RW]</span>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
<div class="method-description">
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
</div>
|
379
|
+
</div>
|
380
|
+
|
381
|
+
<div id="pkg-name-attribute-method" class="method-detail">
|
382
|
+
<a name="pkg_name"></a>
|
383
|
+
|
384
|
+
<a name="pkg_name="></a>
|
385
|
+
|
386
|
+
<div class="method-heading attribute-method-heading">
|
387
|
+
<span class="method-name">pkg_name</span><span
|
388
|
+
class="attribute-access-type">[RW]</span>
|
389
|
+
</div>
|
390
|
+
|
391
|
+
<div class="method-description">
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
</div>
|
396
|
+
</div>
|
397
|
+
|
398
|
+
<div id="pkg-version-attribute-method" class="method-detail">
|
399
|
+
<a name="pkg_version"></a>
|
400
|
+
|
401
|
+
<a name="pkg_version="></a>
|
402
|
+
|
403
|
+
<div class="method-heading attribute-method-heading">
|
404
|
+
<span class="method-name">pkg_version</span><span
|
405
|
+
class="attribute-access-type">[RW]</span>
|
406
|
+
</div>
|
407
|
+
|
408
|
+
<div class="method-description">
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
</div>
|
413
|
+
</div>
|
414
|
+
|
415
|
+
</div>
|
416
|
+
|
417
|
+
|
418
|
+
<!-- Methods -->
|
419
|
+
|
420
|
+
<div id="public-class-method-details" class="method-section section">
|
421
|
+
<h3 class="section-header">Public Class Methods</h3>
|
422
|
+
|
423
|
+
|
424
|
+
<div id="inherited-method" class="method-detail ">
|
425
|
+
<a name="method-c-inherited"></a>
|
426
|
+
|
427
|
+
<div class="method-heading">
|
428
|
+
|
429
|
+
<span class="method-name">inherited</span><span
|
430
|
+
class="method-args">(base)</span>
|
431
|
+
<span class="method-click-advice">click to toggle source</span>
|
432
|
+
|
433
|
+
</div>
|
434
|
+
|
435
|
+
<div class="method-description">
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
<div class="method-source-code"
|
442
|
+
id="inherited-source">
|
443
|
+
<pre>
|
444
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 91</span>
|
445
|
+
91: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span> <span class="ruby-identifier">base</span>
|
446
|
+
92: <span class="ruby-comment cmt"># NOTE: We can NOT instantiate the class here,</span>
|
447
|
+
93: <span class="ruby-comment cmt"># because only it's first line has been interpreted, if we </span>
|
448
|
+
94: <span class="ruby-comment cmt"># instantiate here, none of the code declared in the class body will</span>
|
449
|
+
95: <span class="ruby-comment cmt"># be associated with this instance.</span>
|
450
|
+
96: <span class="ruby-comment cmt">#</span>
|
451
|
+
97: <span class="ruby-comment cmt"># Go ahead and register the class and update instances afterwards.</span>
|
452
|
+
98: <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">register</span> <span class="ruby-identifier">base</span>, <span class="ruby-identifier">template_from_caller</span>(<span class="ruby-identifier">caller</span>.<span class="ruby-identifier">first</span>)
|
453
|
+
99: <span class="ruby-keyword kw">end</span></pre>
|
454
|
+
</div>
|
455
|
+
|
456
|
+
</div>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
</div>
|
462
|
+
|
463
|
+
|
464
|
+
</div>
|
465
|
+
|
466
|
+
<div id="private-class-method-details" class="method-section section">
|
467
|
+
<h3 class="section-header">Private Class Methods</h3>
|
468
|
+
|
469
|
+
|
470
|
+
<div id="template-from-caller-method" class="method-detail ">
|
471
|
+
<a name="method-c-template_from_caller"></a>
|
472
|
+
|
473
|
+
<div class="method-heading">
|
474
|
+
|
475
|
+
<span class="method-name">template_from_caller</span><span
|
476
|
+
class="method-args">(caller_string)</span>
|
477
|
+
<span class="method-click-advice">click to toggle source</span>
|
478
|
+
|
479
|
+
</div>
|
480
|
+
|
481
|
+
<div class="method-description">
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
<div class="method-source-code"
|
488
|
+
id="template-from-caller-source">
|
489
|
+
<pre>
|
490
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 225</span>
|
491
|
+
225: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">template_from_caller</span> <span class="ruby-identifier">caller_string</span>
|
492
|
+
226: <span class="ruby-identifier">file</span> = <span class="ruby-constant">Sprout</span>.<span class="ruby-identifier">file_from_caller</span> <span class="ruby-identifier">caller_string</span>
|
493
|
+
227: <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">file</span>), <span class="ruby-value str">'templates'</span>)
|
494
|
+
228: <span class="ruby-keyword kw">end</span></pre>
|
495
|
+
</div>
|
496
|
+
|
497
|
+
</div>
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
</div>
|
503
|
+
|
504
|
+
|
505
|
+
</div>
|
506
|
+
|
507
|
+
<div id="public-instance-method-details" class="method-section section">
|
508
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
509
|
+
|
510
|
+
|
511
|
+
<div id="destroy-method" class="method-detail ">
|
512
|
+
<a name="method-i-destroy"></a>
|
513
|
+
|
514
|
+
<div class="method-heading">
|
515
|
+
|
516
|
+
<span class="method-name">destroy</span><span
|
517
|
+
class="method-args"></span>
|
518
|
+
<span class="method-click-advice">click to toggle source</span>
|
519
|
+
|
520
|
+
</div>
|
521
|
+
|
522
|
+
<div class="method-description">
|
523
|
+
|
524
|
+
<p>
|
525
|
+
Insteast of creating, destroy the files.
|
526
|
+
</p>
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
<div class="method-source-code"
|
531
|
+
id="destroy-source">
|
532
|
+
<pre>
|
533
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 107</span>
|
534
|
+
107: <span class="ruby-identifier">add_param</span> <span class="ruby-value">:destroy</span>, <span class="ruby-constant">Boolean</span>
|
535
|
+
</pre>
|
536
|
+
</div>
|
537
|
+
|
538
|
+
</div>
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
</div>
|
544
|
+
|
545
|
+
|
546
|
+
<div id="execute-method" class="method-detail ">
|
547
|
+
<a name="method-i-execute"></a>
|
548
|
+
|
549
|
+
<div class="method-heading">
|
550
|
+
|
551
|
+
<span class="method-name">execute</span><span
|
552
|
+
class="method-args">()</span>
|
553
|
+
<span class="method-click-advice">click to toggle source</span>
|
554
|
+
|
555
|
+
</div>
|
556
|
+
|
557
|
+
<div class="method-description">
|
558
|
+
|
559
|
+
<p>
|
560
|
+
Record the actions and trigger them
|
561
|
+
</p>
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
<div class="method-source-code"
|
566
|
+
id="execute-source">
|
567
|
+
<pre>
|
568
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 160</span>
|
569
|
+
160: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>
|
570
|
+
161: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">prepare_command</span>.<span class="ruby-identifier">unexecute</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">destroy</span>
|
571
|
+
162: <span class="ruby-identifier">prepare_command</span>.<span class="ruby-identifier">execute</span>
|
572
|
+
163: <span class="ruby-keyword kw">end</span></pre>
|
573
|
+
</div>
|
574
|
+
|
575
|
+
</div>
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
</div>
|
581
|
+
|
582
|
+
|
583
|
+
<div id="force-method" class="method-detail ">
|
584
|
+
<a name="method-i-force"></a>
|
585
|
+
|
586
|
+
<div class="method-heading">
|
587
|
+
|
588
|
+
<span class="method-name">force</span><span
|
589
|
+
class="method-args"></span>
|
590
|
+
<span class="method-click-advice">click to toggle source</span>
|
591
|
+
|
592
|
+
</div>
|
593
|
+
|
594
|
+
<div class="method-description">
|
595
|
+
|
596
|
+
<p>
|
597
|
+
Force the creation of files without prompting.
|
598
|
+
</p>
|
599
|
+
|
600
|
+
|
601
|
+
|
602
|
+
<div class="method-source-code"
|
603
|
+
id="force-source">
|
604
|
+
<pre>
|
605
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 111</span>
|
606
|
+
111: <span class="ruby-identifier">add_param</span> <span class="ruby-value">:force</span>, <span class="ruby-constant">Boolean</span>
|
607
|
+
</pre>
|
608
|
+
</div>
|
609
|
+
|
610
|
+
</div>
|
611
|
+
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
</div>
|
616
|
+
|
617
|
+
|
618
|
+
<div id="input-method" class="method-detail ">
|
619
|
+
<a name="method-i-input"></a>
|
620
|
+
|
621
|
+
<div class="method-heading">
|
622
|
+
|
623
|
+
<span class="method-name">input</span><span
|
624
|
+
class="method-args"></span>
|
625
|
+
<span class="method-click-advice">click to toggle source</span>
|
626
|
+
|
627
|
+
</div>
|
628
|
+
|
629
|
+
<div class="method-description">
|
630
|
+
|
631
|
+
<p>
|
632
|
+
The primary input for the application or component.
|
633
|
+
</p>
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
<div class="method-source-code"
|
638
|
+
id="input-source">
|
639
|
+
<pre>
|
640
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 124</span>
|
641
|
+
124: <span class="ruby-identifier">add_param</span> <span class="ruby-value">:input</span>, <span class="ruby-constant">String</span>, { <span class="ruby-value">:hidden_name</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span>, <span class="ruby-value">:required</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">true</span> }
|
642
|
+
</pre>
|
643
|
+
</div>
|
644
|
+
|
645
|
+
</div>
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
</div>
|
651
|
+
|
652
|
+
|
653
|
+
<div id="name-method" class="method-detail ">
|
654
|
+
<a name="method-i-name"></a>
|
655
|
+
|
656
|
+
<div class="method-heading">
|
657
|
+
|
658
|
+
<span class="method-name">name</span><span
|
659
|
+
class="method-args"></span>
|
660
|
+
<span class="method-click-advice">click to toggle source</span>
|
661
|
+
|
662
|
+
</div>
|
663
|
+
|
664
|
+
<div class="method-description">
|
665
|
+
|
666
|
+
<p>
|
667
|
+
Set the default name for generators.
|
668
|
+
</p>
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
<div class="method-source-code"
|
673
|
+
id="name-source">
|
674
|
+
<pre>
|
675
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 129</span>
|
676
|
+
129: <span class="ruby-identifier">set</span> <span class="ruby-value">:name</span>, <span class="ruby-value">:application</span>
|
677
|
+
</pre>
|
678
|
+
</div>
|
679
|
+
|
680
|
+
</div>
|
681
|
+
|
682
|
+
|
683
|
+
|
684
|
+
|
685
|
+
</div>
|
686
|
+
|
687
|
+
|
688
|
+
<div id="path-method" class="method-detail ">
|
689
|
+
<a name="method-i-path"></a>
|
690
|
+
|
691
|
+
<div class="method-heading">
|
692
|
+
|
693
|
+
<span class="method-name">path</span><span
|
694
|
+
class="method-args"></span>
|
695
|
+
<span class="method-click-advice">click to toggle source</span>
|
696
|
+
|
697
|
+
</div>
|
698
|
+
|
699
|
+
<div class="method-description">
|
700
|
+
|
701
|
+
<p>
|
702
|
+
The directory where files will be created.
|
703
|
+
</p>
|
704
|
+
|
705
|
+
|
706
|
+
|
707
|
+
<div class="method-source-code"
|
708
|
+
id="path-source">
|
709
|
+
<pre>
|
710
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 103</span>
|
711
|
+
103: <span class="ruby-identifier">add_param</span> <span class="ruby-value">:path</span>, <span class="ruby-constant">Path</span>, { <span class="ruby-value">:default</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span> }
|
712
|
+
</pre>
|
713
|
+
</div>
|
714
|
+
|
715
|
+
</div>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
</div>
|
721
|
+
|
722
|
+
|
723
|
+
<div id="quiet-method" class="method-detail ">
|
724
|
+
<a name="method-i-quiet"></a>
|
725
|
+
|
726
|
+
<div class="method-heading">
|
727
|
+
|
728
|
+
<span class="method-name">quiet</span><span
|
729
|
+
class="method-args"></span>
|
730
|
+
<span class="method-click-advice">click to toggle source</span>
|
731
|
+
|
732
|
+
</div>
|
733
|
+
|
734
|
+
<div class="method-description">
|
735
|
+
|
736
|
+
<p>
|
737
|
+
Run the generator in Quiet mode - do not write status to standard output.
|
738
|
+
</p>
|
739
|
+
|
740
|
+
|
741
|
+
|
742
|
+
<div class="method-source-code"
|
743
|
+
id="quiet-source">
|
744
|
+
<pre>
|
745
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 116</span>
|
746
|
+
116: <span class="ruby-identifier">add_param</span> <span class="ruby-value">:quiet</span>, <span class="ruby-constant">Boolean</span>
|
747
|
+
</pre>
|
748
|
+
</div>
|
749
|
+
|
750
|
+
</div>
|
751
|
+
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
</div>
|
756
|
+
|
757
|
+
|
758
|
+
<div id="resolve-template-method" class="method-detail ">
|
759
|
+
<a name="method-i-resolve_template"></a>
|
760
|
+
|
761
|
+
<div class="method-heading">
|
762
|
+
|
763
|
+
<span class="method-name">resolve_template</span><span
|
764
|
+
class="method-args">(content)</span>
|
765
|
+
<span class="method-click-advice">click to toggle source</span>
|
766
|
+
|
767
|
+
</div>
|
768
|
+
|
769
|
+
<div class="method-description">
|
770
|
+
|
771
|
+
<p>
|
772
|
+
TODO: Add support for arbitrary templating languages. For now, just support
|
773
|
+
ERB…
|
774
|
+
</p>
|
775
|
+
<p>
|
776
|
+
TODO: This is also a possible spot where those of you that don’t want
|
777
|
+
to snuggle might put pretty-print code or some such modifiers...
|
778
|
+
</p>
|
779
|
+
|
780
|
+
|
781
|
+
|
782
|
+
<div class="method-source-code"
|
783
|
+
id="resolve-template-source">
|
784
|
+
<pre>
|
785
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 182</span>
|
786
|
+
182: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">resolve_template</span> <span class="ruby-identifier">content</span>
|
787
|
+
183: <span class="ruby-identifier">require</span> <span class="ruby-value str">'erb'</span>
|
788
|
+
184: <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">content</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">'>'</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
|
789
|
+
185: <span class="ruby-keyword kw">end</span></pre>
|
790
|
+
</div>
|
791
|
+
|
792
|
+
</div>
|
793
|
+
|
794
|
+
|
795
|
+
|
796
|
+
|
797
|
+
</div>
|
798
|
+
|
799
|
+
|
800
|
+
<div id="say-method" class="method-detail ">
|
801
|
+
<a name="method-i-say"></a>
|
802
|
+
|
803
|
+
<div class="method-heading">
|
804
|
+
|
805
|
+
<span class="method-name">say</span><span
|
806
|
+
class="method-args">(message)</span>
|
807
|
+
<span class="method-click-advice">click to toggle source</span>
|
808
|
+
|
809
|
+
</div>
|
810
|
+
|
811
|
+
<div class="method-description">
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
|
816
|
+
|
817
|
+
<div class="method-source-code"
|
818
|
+
id="say-source">
|
819
|
+
<pre>
|
820
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 171</span>
|
821
|
+
171: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">say</span> <span class="ruby-identifier">message</span>
|
822
|
+
172: <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-node">"#{path}"</span>, <span class="ruby-value str">'.'</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">quiet</span>
|
823
|
+
173: <span class="ruby-keyword kw">end</span></pre>
|
824
|
+
</div>
|
825
|
+
|
826
|
+
</div>
|
827
|
+
|
828
|
+
|
829
|
+
|
830
|
+
|
831
|
+
</div>
|
832
|
+
|
833
|
+
|
834
|
+
<div id="template-paths-method" class="method-detail ">
|
835
|
+
<a name="method-i-template_paths"></a>
|
836
|
+
|
837
|
+
<div class="method-heading">
|
838
|
+
|
839
|
+
<span class="method-name">template_paths</span><span
|
840
|
+
class="method-args">()</span>
|
841
|
+
<span class="method-click-advice">click to toggle source</span>
|
842
|
+
|
843
|
+
</div>
|
844
|
+
|
845
|
+
<div class="method-description">
|
846
|
+
|
847
|
+
<p>
|
848
|
+
Returns a collection of templates that were provided on the command line,
|
849
|
+
followed by templates that are created by a concrete generator, followed
|
850
|
+
by the Sprout::Generator.search_paths + ‘templates’ folders.
|
851
|
+
</p>
|
852
|
+
|
853
|
+
|
854
|
+
|
855
|
+
<div class="method-source-code"
|
856
|
+
id="template-paths-source">
|
857
|
+
<pre>
|
858
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 193</span>
|
859
|
+
193: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">template_paths</span>
|
860
|
+
194: <span class="ruby-identifier">templates</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span><span class="ruby-operator">::</span><span class="ruby-identifier">template_folder_for</span>(<span class="ruby-keyword kw">self</span>)
|
861
|
+
195: <span class="ruby-identifier">templates</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">default_search_paths</span>
|
862
|
+
196: <span class="ruby-keyword kw">end</span></pre>
|
863
|
+
</div>
|
864
|
+
|
865
|
+
</div>
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
</div>
|
871
|
+
|
872
|
+
|
873
|
+
<div id="templates-method" class="method-detail ">
|
874
|
+
<a name="method-i-templates"></a>
|
875
|
+
|
876
|
+
<div class="method-heading">
|
877
|
+
|
878
|
+
<span class="method-name">templates</span><span
|
879
|
+
class="method-args"></span>
|
880
|
+
<span class="method-click-advice">click to toggle source</span>
|
881
|
+
|
882
|
+
</div>
|
883
|
+
|
884
|
+
<div class="method-description">
|
885
|
+
|
886
|
+
<p>
|
887
|
+
A collection of paths to look in for named templates.
|
888
|
+
</p>
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
<div class="method-source-code"
|
893
|
+
id="templates-source">
|
894
|
+
<pre>
|
895
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 120</span>
|
896
|
+
120: <span class="ruby-identifier">add_param</span> <span class="ruby-value">:templates</span>, <span class="ruby-constant">Paths</span>
|
897
|
+
</pre>
|
898
|
+
</div>
|
899
|
+
|
900
|
+
</div>
|
901
|
+
|
902
|
+
|
903
|
+
|
904
|
+
|
905
|
+
</div>
|
906
|
+
|
907
|
+
|
908
|
+
<div id="unexecute-method" class="method-detail ">
|
909
|
+
<a name="method-i-unexecute"></a>
|
910
|
+
|
911
|
+
<div class="method-heading">
|
912
|
+
|
913
|
+
<span class="method-name">unexecute</span><span
|
914
|
+
class="method-args">()</span>
|
915
|
+
<span class="method-click-advice">click to toggle source</span>
|
916
|
+
|
917
|
+
</div>
|
918
|
+
|
919
|
+
<div class="method-description">
|
920
|
+
|
921
|
+
<p>
|
922
|
+
Rollback the generator
|
923
|
+
</p>
|
924
|
+
|
925
|
+
|
926
|
+
|
927
|
+
<div class="method-source-code"
|
928
|
+
id="unexecute-source">
|
929
|
+
<pre>
|
930
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 167</span>
|
931
|
+
167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unexecute</span>
|
932
|
+
168: <span class="ruby-identifier">prepare_command</span>.<span class="ruby-identifier">unexecute</span>
|
933
|
+
169: <span class="ruby-keyword kw">end</span></pre>
|
934
|
+
</div>
|
935
|
+
|
936
|
+
</div>
|
937
|
+
|
938
|
+
|
939
|
+
|
940
|
+
|
941
|
+
</div>
|
942
|
+
|
943
|
+
|
944
|
+
</div>
|
945
|
+
|
946
|
+
<div id="protected-instance-method-details" class="method-section section">
|
947
|
+
<h3 class="section-header">Protected Instance Methods</h3>
|
948
|
+
|
949
|
+
|
950
|
+
<div id="default-search-paths-method" class="method-detail ">
|
951
|
+
<a name="method-i-default_search_paths"></a>
|
952
|
+
|
953
|
+
<div class="method-heading">
|
954
|
+
|
955
|
+
<span class="method-name">default_search_paths</span><span
|
956
|
+
class="method-args">()</span>
|
957
|
+
<span class="method-click-advice">click to toggle source</span>
|
958
|
+
|
959
|
+
</div>
|
960
|
+
|
961
|
+
<div class="method-description">
|
962
|
+
|
963
|
+
|
964
|
+
|
965
|
+
|
966
|
+
|
967
|
+
<div class="method-source-code"
|
968
|
+
id="default-search-paths-source">
|
969
|
+
<pre>
|
970
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 200</span>
|
971
|
+
200: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">default_search_paths</span>
|
972
|
+
201: <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">search_paths</span>.<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value str">'templates'</span>) }
|
973
|
+
202: <span class="ruby-keyword kw">end</span></pre>
|
974
|
+
</div>
|
975
|
+
|
976
|
+
</div>
|
977
|
+
|
978
|
+
|
979
|
+
|
980
|
+
|
981
|
+
</div>
|
982
|
+
|
983
|
+
|
984
|
+
<div id="directory-method" class="method-detail ">
|
985
|
+
<a name="method-i-directory"></a>
|
986
|
+
|
987
|
+
<div class="method-heading">
|
988
|
+
|
989
|
+
<span class="method-name">directory</span><span
|
990
|
+
class="method-args">(name, &block)</span>
|
991
|
+
<span class="method-click-advice">click to toggle source</span>
|
992
|
+
|
993
|
+
</div>
|
994
|
+
|
995
|
+
<div class="method-description">
|
996
|
+
|
997
|
+
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
<div class="method-source-code"
|
1002
|
+
id="directory-source">
|
1003
|
+
<pre>
|
1004
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 211</span>
|
1005
|
+
211: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">directory</span> <span class="ruby-identifier">name</span>, &<span class="ruby-identifier">block</span>
|
1006
|
+
212: <span class="ruby-ivar">@command</span>.<span class="ruby-identifier">directory</span> <span class="ruby-identifier">name</span>, &<span class="ruby-identifier">block</span>
|
1007
|
+
213: <span class="ruby-keyword kw">end</span></pre>
|
1008
|
+
</div>
|
1009
|
+
|
1010
|
+
</div>
|
1011
|
+
|
1012
|
+
|
1013
|
+
|
1014
|
+
|
1015
|
+
</div>
|
1016
|
+
|
1017
|
+
|
1018
|
+
<div id="file-method" class="method-detail ">
|
1019
|
+
<a name="method-i-file"></a>
|
1020
|
+
|
1021
|
+
<div class="method-heading">
|
1022
|
+
|
1023
|
+
<span class="method-name">file</span><span
|
1024
|
+
class="method-args">(name, template=nil)</span>
|
1025
|
+
<span class="method-click-advice">click to toggle source</span>
|
1026
|
+
|
1027
|
+
</div>
|
1028
|
+
|
1029
|
+
<div class="method-description">
|
1030
|
+
|
1031
|
+
|
1032
|
+
|
1033
|
+
|
1034
|
+
|
1035
|
+
<div class="method-source-code"
|
1036
|
+
id="file-source">
|
1037
|
+
<pre>
|
1038
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 215</span>
|
1039
|
+
215: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">template</span>=<span class="ruby-keyword kw">nil</span>
|
1040
|
+
216: <span class="ruby-ivar">@command</span>.<span class="ruby-identifier">file</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">template</span>
|
1041
|
+
217: <span class="ruby-keyword kw">end</span></pre>
|
1042
|
+
</div>
|
1043
|
+
|
1044
|
+
</div>
|
1045
|
+
|
1046
|
+
|
1047
|
+
|
1048
|
+
|
1049
|
+
</div>
|
1050
|
+
|
1051
|
+
|
1052
|
+
<div id="prepare-command-method" class="method-detail ">
|
1053
|
+
<a name="method-i-prepare_command"></a>
|
1054
|
+
|
1055
|
+
<div class="method-heading">
|
1056
|
+
|
1057
|
+
<span class="method-name">prepare_command</span><span
|
1058
|
+
class="method-args">()</span>
|
1059
|
+
<span class="method-click-advice">click to toggle source</span>
|
1060
|
+
|
1061
|
+
</div>
|
1062
|
+
|
1063
|
+
<div class="method-description">
|
1064
|
+
|
1065
|
+
|
1066
|
+
|
1067
|
+
|
1068
|
+
|
1069
|
+
<div class="method-source-code"
|
1070
|
+
id="prepare-command-source">
|
1071
|
+
<pre>
|
1072
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 204</span>
|
1073
|
+
204: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare_command</span>
|
1074
|
+
205: <span class="ruby-ivar">@logger</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">$stdout</span>
|
1075
|
+
206: <span class="ruby-ivar">@command</span> = <span class="ruby-constant">Command</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">self</span>
|
1076
|
+
207: <span class="ruby-identifier">manifest</span>
|
1077
|
+
208: <span class="ruby-ivar">@command</span>
|
1078
|
+
209: <span class="ruby-keyword kw">end</span></pre>
|
1079
|
+
</div>
|
1080
|
+
|
1081
|
+
</div>
|
1082
|
+
|
1083
|
+
|
1084
|
+
|
1085
|
+
|
1086
|
+
</div>
|
1087
|
+
|
1088
|
+
|
1089
|
+
<div id="template-method" class="method-detail ">
|
1090
|
+
<a name="method-i-template"></a>
|
1091
|
+
|
1092
|
+
<div class="method-heading">
|
1093
|
+
|
1094
|
+
<span class="method-name">template</span><span
|
1095
|
+
class="method-args">(name, template=nil)</span>
|
1096
|
+
<span class="method-click-advice">click to toggle source</span>
|
1097
|
+
|
1098
|
+
</div>
|
1099
|
+
|
1100
|
+
<div class="method-description">
|
1101
|
+
|
1102
|
+
|
1103
|
+
|
1104
|
+
|
1105
|
+
|
1106
|
+
<div class="method-source-code"
|
1107
|
+
id="template-source">
|
1108
|
+
<pre>
|
1109
|
+
<span class="ruby-comment cmt"># File lib/sprout/generator/base.rb, line 219</span>
|
1110
|
+
219: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">template</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">template</span>=<span class="ruby-keyword kw">nil</span>
|
1111
|
+
220: <span class="ruby-ivar">@command</span>.<span class="ruby-identifier">template</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">template</span>
|
1112
|
+
221: <span class="ruby-keyword kw">end</span></pre>
|
1113
|
+
</div>
|
1114
|
+
|
1115
|
+
</div>
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
|
1120
|
+
</div>
|
1121
|
+
|
1122
|
+
|
1123
|
+
</div>
|
1124
|
+
|
1125
|
+
|
1126
|
+
</div>
|
1127
|
+
|
1128
|
+
|
1129
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
1130
|
+
|
1131
|
+
<p>Disabled; run with --debug to generate this.</p>
|
1132
|
+
|
1133
|
+
</div>
|
1134
|
+
|
1135
|
+
<div id="validator-badges">
|
1136
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
1137
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
1138
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
1139
|
+
</div>
|
1140
|
+
|
1141
|
+
</body>
|
1142
|
+
</html>
|
1143
|
+
|