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,385 @@
|
|
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::Executable::Files</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/executable/files_rb.html?TB_iframe=true&height=550&width=785"
|
42
|
+
class="thickbox" title="lib/sprout/executable/files.rb">lib/sprout/executable/files.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">Executable::Param</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-i-prepare_prerequisites">#prepare_prerequisites</a></li>
|
73
|
+
|
74
|
+
<li><a href="#method-i-to_shell_value">#to_shell_value</a></li>
|
75
|
+
|
76
|
+
</ul>
|
77
|
+
</div>
|
78
|
+
|
79
|
+
|
80
|
+
<!-- Included Modules -->
|
81
|
+
|
82
|
+
<div id="includes-section" class="section">
|
83
|
+
<h3 class="section-header">Included Modules</h3>
|
84
|
+
<ul class="link-list">
|
85
|
+
|
86
|
+
|
87
|
+
<li><span class="include">CollectionParam</span></li>
|
88
|
+
|
89
|
+
|
90
|
+
</ul>
|
91
|
+
</div>
|
92
|
+
|
93
|
+
</div>
|
94
|
+
|
95
|
+
<div id="project-metadata">
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
<div id="classindex-section" class="section project-section">
|
100
|
+
<h3 class="section-header">Class Index
|
101
|
+
<span class="search-toggle"><img src="../../images/find.png"
|
102
|
+
height="16" width="16" alt="[+]"
|
103
|
+
title="show/hide quicksearch" /></span></h3>
|
104
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
105
|
+
<fieldset>
|
106
|
+
<legend>Quicksearch</legend>
|
107
|
+
<input type="text" name="quicksearch" value=""
|
108
|
+
class="quicksearch-field" />
|
109
|
+
</fieldset>
|
110
|
+
</form>
|
111
|
+
|
112
|
+
<ul class="link-list">
|
113
|
+
|
114
|
+
<li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
|
115
|
+
|
116
|
+
<li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
|
117
|
+
|
118
|
+
<li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
|
119
|
+
|
120
|
+
<li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
|
121
|
+
|
122
|
+
<li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
|
123
|
+
|
124
|
+
<li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
|
125
|
+
|
126
|
+
<li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
|
127
|
+
|
128
|
+
<li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
|
129
|
+
|
130
|
+
<li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
|
131
|
+
|
132
|
+
<li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
|
133
|
+
|
134
|
+
<li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
|
135
|
+
|
136
|
+
<li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
|
137
|
+
|
138
|
+
<li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
|
139
|
+
|
140
|
+
<li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
|
141
|
+
|
142
|
+
<li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
|
143
|
+
|
144
|
+
<li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
|
145
|
+
|
146
|
+
<li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
|
147
|
+
|
148
|
+
<li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
|
149
|
+
|
150
|
+
<li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
|
151
|
+
|
152
|
+
<li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
|
153
|
+
|
154
|
+
<li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
|
155
|
+
|
156
|
+
<li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
|
157
|
+
|
158
|
+
<li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
|
159
|
+
|
160
|
+
<li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
|
161
|
+
|
162
|
+
<li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
|
163
|
+
|
164
|
+
<li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
|
165
|
+
|
166
|
+
<li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
|
167
|
+
|
168
|
+
<li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
|
169
|
+
|
170
|
+
<li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
|
171
|
+
|
172
|
+
<li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
|
173
|
+
|
174
|
+
<li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
|
175
|
+
|
176
|
+
<li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
|
177
|
+
|
178
|
+
<li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
|
179
|
+
|
180
|
+
<li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
|
181
|
+
|
182
|
+
<li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
|
183
|
+
|
184
|
+
<li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
|
185
|
+
|
186
|
+
<li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
|
187
|
+
|
188
|
+
<li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
|
189
|
+
|
190
|
+
<li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
|
191
|
+
|
192
|
+
<li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
|
193
|
+
|
194
|
+
<li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
|
195
|
+
|
196
|
+
<li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
|
197
|
+
|
198
|
+
<li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
|
199
|
+
|
200
|
+
<li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
|
201
|
+
|
202
|
+
<li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
|
203
|
+
|
204
|
+
<li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
|
205
|
+
|
206
|
+
<li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
|
207
|
+
|
208
|
+
<li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
|
209
|
+
|
210
|
+
<li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
|
211
|
+
|
212
|
+
<li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
|
213
|
+
|
214
|
+
<li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
|
215
|
+
|
216
|
+
<li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
|
217
|
+
|
218
|
+
<li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
|
219
|
+
|
220
|
+
<li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
|
221
|
+
|
222
|
+
<li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
|
223
|
+
|
224
|
+
<li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
|
225
|
+
|
226
|
+
<li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
|
227
|
+
|
228
|
+
<li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
|
229
|
+
|
230
|
+
<li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
|
231
|
+
|
232
|
+
<li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
|
233
|
+
|
234
|
+
<li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
|
235
|
+
|
236
|
+
<li><a href="../../Sprout/System.html">Sprout::System</a></li>
|
237
|
+
|
238
|
+
<li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
|
239
|
+
|
240
|
+
<li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
|
241
|
+
|
242
|
+
<li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
|
243
|
+
|
244
|
+
<li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
|
245
|
+
|
246
|
+
<li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
|
247
|
+
|
248
|
+
<li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
|
249
|
+
|
250
|
+
<li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
|
251
|
+
|
252
|
+
<li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
|
253
|
+
|
254
|
+
<li><a href="../../<.html"><</a></li>
|
255
|
+
|
256
|
+
<li><a href="../../Dir.html">Dir</a></li>
|
257
|
+
|
258
|
+
<li><a href="../../Object.html">Object</a></li>
|
259
|
+
|
260
|
+
<li><a href="../../String.html">String</a></li>
|
261
|
+
|
262
|
+
</ul>
|
263
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
264
|
+
</div>
|
265
|
+
|
266
|
+
|
267
|
+
</div>
|
268
|
+
</div>
|
269
|
+
|
270
|
+
<div id="documentation">
|
271
|
+
<h1 class="class">Sprout::Executable::Files</h1>
|
272
|
+
|
273
|
+
<div id="description">
|
274
|
+
<p>
|
275
|
+
Concrete param object for collections of files
|
276
|
+
</p>
|
277
|
+
|
278
|
+
</div>
|
279
|
+
|
280
|
+
<!-- Constants -->
|
281
|
+
|
282
|
+
|
283
|
+
<!-- Attributes -->
|
284
|
+
|
285
|
+
|
286
|
+
<!-- Methods -->
|
287
|
+
|
288
|
+
<div id="public-instance-method-details" class="method-section section">
|
289
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
290
|
+
|
291
|
+
|
292
|
+
<div id="prepare-prerequisites-method" class="method-detail ">
|
293
|
+
<a name="method-i-prepare_prerequisites"></a>
|
294
|
+
|
295
|
+
<div class="method-heading">
|
296
|
+
|
297
|
+
<span class="method-name">prepare_prerequisites</span><span
|
298
|
+
class="method-args">()</span>
|
299
|
+
<span class="method-click-advice">click to toggle source</span>
|
300
|
+
|
301
|
+
</div>
|
302
|
+
|
303
|
+
<div class="method-description">
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
<div class="method-source-code"
|
310
|
+
id="prepare-prerequisites-source">
|
311
|
+
<pre>
|
312
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable/files.rb, line 16</span>
|
313
|
+
16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare_prerequisites</span>
|
314
|
+
17: <span class="ruby-identifier">value</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
|
315
|
+
18: <span class="ruby-identifier">file</span> <span class="ruby-identifier">f</span>
|
316
|
+
19: <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">prerequisites</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">f</span>
|
317
|
+
20: <span class="ruby-keyword kw">end</span>
|
318
|
+
21: <span class="ruby-keyword kw">end</span></pre>
|
319
|
+
</div>
|
320
|
+
|
321
|
+
</div>
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
</div>
|
327
|
+
|
328
|
+
|
329
|
+
<div id="to-shell-value-method" class="method-detail ">
|
330
|
+
<a name="method-i-to_shell_value"></a>
|
331
|
+
|
332
|
+
<div class="method-heading">
|
333
|
+
|
334
|
+
<span class="method-name">to_shell_value</span><span
|
335
|
+
class="method-args">()</span>
|
336
|
+
<span class="method-click-advice">click to toggle source</span>
|
337
|
+
|
338
|
+
</div>
|
339
|
+
|
340
|
+
<div class="method-description">
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
<div class="method-source-code"
|
347
|
+
id="to-shell-value-source">
|
348
|
+
<pre>
|
349
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable/files.rb, line 10</span>
|
350
|
+
10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_shell_value</span>
|
351
|
+
11: <span class="ruby-identifier">value</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
|
352
|
+
12: <span class="ruby-identifier">clean_path</span> <span class="ruby-identifier">path</span>
|
353
|
+
13: <span class="ruby-keyword kw">end</span>
|
354
|
+
14: <span class="ruby-keyword kw">end</span></pre>
|
355
|
+
</div>
|
356
|
+
|
357
|
+
</div>
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
</div>
|
363
|
+
|
364
|
+
|
365
|
+
</div>
|
366
|
+
|
367
|
+
|
368
|
+
</div>
|
369
|
+
|
370
|
+
|
371
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
372
|
+
|
373
|
+
<p>Disabled; run with --debug to generate this.</p>
|
374
|
+
|
375
|
+
</div>
|
376
|
+
|
377
|
+
<div id="validator-badges">
|
378
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
379
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
380
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
381
|
+
</div>
|
382
|
+
|
383
|
+
</body>
|
384
|
+
</html>
|
385
|
+
|
@@ -0,0 +1,1597 @@
|
|
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>Module: Sprout::Executable::InstanceMethods</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="module">
|
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/executable_rb.html?TB_iframe=true&height=550&width=785"
|
42
|
+
class="thickbox" title="lib/sprout/executable.rb">lib/sprout/executable.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
|
+
|
56
|
+
<!-- Namespace Contents -->
|
57
|
+
|
58
|
+
|
59
|
+
<!-- Method Quickref -->
|
60
|
+
|
61
|
+
<div id="method-list-section" class="section">
|
62
|
+
<h3 class="section-header">Methods</h3>
|
63
|
+
<ul class="link-list">
|
64
|
+
|
65
|
+
<li><a href="#method-c-new">::new</a></li>
|
66
|
+
|
67
|
+
<li><a href="#method-i-add_help_param">#add_help_param</a></li>
|
68
|
+
|
69
|
+
<li><a href="#method-i-assembled_default_parameter_collection">#assembled_default_parameter_collection</a></li>
|
70
|
+
|
71
|
+
<li><a href="#method-i-assembled_parameter_collection">#assembled_parameter_collection</a></li>
|
72
|
+
|
73
|
+
<li><a href="#method-i-assembled_static_collection">#assembled_static_collection</a></li>
|
74
|
+
|
75
|
+
<li><a href="#method-i-create_parameter">#create_parameter</a></li>
|
76
|
+
|
77
|
+
<li><a href="#method-i-default_file_expression">#default_file_expression</a></li>
|
78
|
+
|
79
|
+
<li><a href="#method-i-execute">#execute</a></li>
|
80
|
+
|
81
|
+
<li><a href="#method-i-execute_delegate">#execute_delegate</a></li>
|
82
|
+
|
83
|
+
<li><a href="#method-i-handle_parse_error">#handle_parse_error</a></li>
|
84
|
+
|
85
|
+
<li><a href="#method-i-help_requested%3F">#help_requested?</a></li>
|
86
|
+
|
87
|
+
<li><a href="#method-i-initialize_defaults">#initialize_defaults</a></li>
|
88
|
+
|
89
|
+
<li><a href="#method-i-initialize_parameter">#initialize_parameter</a></li>
|
90
|
+
|
91
|
+
<li><a href="#method-i-initialize_parameters">#initialize_parameters</a></li>
|
92
|
+
|
93
|
+
<li><a href="#method-i-option_parser">#option_parser</a></li>
|
94
|
+
|
95
|
+
<li><a href="#method-i-parameter_hash_includes%3F">#parameter_hash_includes?</a></li>
|
96
|
+
|
97
|
+
<li><a href="#method-i-parse%21">#parse!</a></li>
|
98
|
+
|
99
|
+
<li><a href="#method-i-parse_extra_options%21">#parse_extra_options!</a></li>
|
100
|
+
|
101
|
+
<li><a href="#method-i-parse_rake_task_arg">#parse_rake_task_arg</a></li>
|
102
|
+
|
103
|
+
<li><a href="#method-i-prepare">#prepare</a></li>
|
104
|
+
|
105
|
+
<li><a href="#method-i-to_help">#to_help</a></li>
|
106
|
+
|
107
|
+
<li><a href="#method-i-to_rake">#to_rake</a></li>
|
108
|
+
|
109
|
+
<li><a href="#method-i-to_shell">#to_shell</a></li>
|
110
|
+
|
111
|
+
<li><a href="#method-i-update_rake_task_name_from_args">#update_rake_task_name_from_args</a></li>
|
112
|
+
|
113
|
+
<li><a href="#method-i-validate">#validate</a></li>
|
114
|
+
|
115
|
+
</ul>
|
116
|
+
</div>
|
117
|
+
|
118
|
+
|
119
|
+
<!-- Included Modules -->
|
120
|
+
|
121
|
+
</div>
|
122
|
+
|
123
|
+
<div id="project-metadata">
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
<div id="classindex-section" class="section project-section">
|
128
|
+
<h3 class="section-header">Class Index
|
129
|
+
<span class="search-toggle"><img src="../../images/find.png"
|
130
|
+
height="16" width="16" alt="[+]"
|
131
|
+
title="show/hide quicksearch" /></span></h3>
|
132
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
133
|
+
<fieldset>
|
134
|
+
<legend>Quicksearch</legend>
|
135
|
+
<input type="text" name="quicksearch" value=""
|
136
|
+
class="quicksearch-field" />
|
137
|
+
</fieldset>
|
138
|
+
</form>
|
139
|
+
|
140
|
+
<ul class="link-list">
|
141
|
+
|
142
|
+
<li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
|
143
|
+
|
144
|
+
<li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
|
145
|
+
|
146
|
+
<li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
|
147
|
+
|
148
|
+
<li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
|
149
|
+
|
150
|
+
<li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
|
151
|
+
|
152
|
+
<li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
|
153
|
+
|
154
|
+
<li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
|
155
|
+
|
156
|
+
<li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
|
157
|
+
|
158
|
+
<li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
|
159
|
+
|
160
|
+
<li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
|
161
|
+
|
162
|
+
<li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
|
163
|
+
|
164
|
+
<li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
|
165
|
+
|
166
|
+
<li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
|
167
|
+
|
168
|
+
<li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
|
169
|
+
|
170
|
+
<li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
|
171
|
+
|
172
|
+
<li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
|
173
|
+
|
174
|
+
<li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
|
175
|
+
|
176
|
+
<li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
|
177
|
+
|
178
|
+
<li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
|
179
|
+
|
180
|
+
<li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
|
181
|
+
|
182
|
+
<li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
|
183
|
+
|
184
|
+
<li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
|
185
|
+
|
186
|
+
<li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
|
187
|
+
|
188
|
+
<li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
|
189
|
+
|
190
|
+
<li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
|
191
|
+
|
192
|
+
<li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
|
193
|
+
|
194
|
+
<li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
|
195
|
+
|
196
|
+
<li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
|
197
|
+
|
198
|
+
<li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
|
199
|
+
|
200
|
+
<li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
|
201
|
+
|
202
|
+
<li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
|
203
|
+
|
204
|
+
<li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
|
205
|
+
|
206
|
+
<li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
|
207
|
+
|
208
|
+
<li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
|
209
|
+
|
210
|
+
<li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
|
211
|
+
|
212
|
+
<li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
|
213
|
+
|
214
|
+
<li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
|
215
|
+
|
216
|
+
<li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
|
217
|
+
|
218
|
+
<li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
|
219
|
+
|
220
|
+
<li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
|
221
|
+
|
222
|
+
<li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
|
223
|
+
|
224
|
+
<li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
|
225
|
+
|
226
|
+
<li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
|
227
|
+
|
228
|
+
<li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
|
229
|
+
|
230
|
+
<li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
|
231
|
+
|
232
|
+
<li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
|
233
|
+
|
234
|
+
<li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
|
235
|
+
|
236
|
+
<li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
|
237
|
+
|
238
|
+
<li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
|
239
|
+
|
240
|
+
<li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
|
241
|
+
|
242
|
+
<li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
|
243
|
+
|
244
|
+
<li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
|
245
|
+
|
246
|
+
<li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
|
247
|
+
|
248
|
+
<li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
|
249
|
+
|
250
|
+
<li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
|
251
|
+
|
252
|
+
<li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
|
253
|
+
|
254
|
+
<li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
|
255
|
+
|
256
|
+
<li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
|
257
|
+
|
258
|
+
<li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
|
259
|
+
|
260
|
+
<li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
|
261
|
+
|
262
|
+
<li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
|
263
|
+
|
264
|
+
<li><a href="../../Sprout/System.html">Sprout::System</a></li>
|
265
|
+
|
266
|
+
<li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
|
267
|
+
|
268
|
+
<li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
|
269
|
+
|
270
|
+
<li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
|
271
|
+
|
272
|
+
<li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
|
273
|
+
|
274
|
+
<li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
|
275
|
+
|
276
|
+
<li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
|
277
|
+
|
278
|
+
<li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
|
279
|
+
|
280
|
+
<li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
|
281
|
+
|
282
|
+
<li><a href="../../<.html"><</a></li>
|
283
|
+
|
284
|
+
<li><a href="../../Dir.html">Dir</a></li>
|
285
|
+
|
286
|
+
<li><a href="../../Object.html">Object</a></li>
|
287
|
+
|
288
|
+
<li><a href="../../String.html">String</a></li>
|
289
|
+
|
290
|
+
</ul>
|
291
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
292
|
+
</div>
|
293
|
+
|
294
|
+
|
295
|
+
</div>
|
296
|
+
</div>
|
297
|
+
|
298
|
+
<div id="documentation">
|
299
|
+
<h1 class="module">Sprout::Executable::InstanceMethods</h1>
|
300
|
+
|
301
|
+
<div id="description">
|
302
|
+
|
303
|
+
</div>
|
304
|
+
|
305
|
+
<!-- Constants -->
|
306
|
+
|
307
|
+
|
308
|
+
<!-- Attributes -->
|
309
|
+
|
310
|
+
<div id="attribute-method-details" class="method-section section">
|
311
|
+
<h3 class="section-header">Attributes</h3>
|
312
|
+
|
313
|
+
|
314
|
+
<div id="pkg-name-attribute-method" class="method-detail">
|
315
|
+
<a name="pkg_name"></a>
|
316
|
+
|
317
|
+
<a name="pkg_name="></a>
|
318
|
+
|
319
|
+
<div class="method-heading attribute-method-heading">
|
320
|
+
<span class="method-name">pkg_name</span><span
|
321
|
+
class="attribute-access-type">[RW]</span>
|
322
|
+
</div>
|
323
|
+
|
324
|
+
<div class="method-description">
|
325
|
+
|
326
|
+
<p>
|
327
|
+
The default RubyGem that we will use when requesting our executable.
|
328
|
+
</p>
|
329
|
+
<p>
|
330
|
+
Classes that include the <a href="../Executable.html">Executable</a> can
|
331
|
+
set the default value for this property at the class level with:
|
332
|
+
</p>
|
333
|
+
<pre>
|
334
|
+
set :pkg_name, 'sprout-sometoolname'
|
335
|
+
</pre>
|
336
|
+
<p>
|
337
|
+
But that value can be overridden on each instance like:
|
338
|
+
</p>
|
339
|
+
<pre>
|
340
|
+
executable = SomeToolTask.new
|
341
|
+
executable.pkg_name = 'sprout-othertoolname'
|
342
|
+
</pre>
|
343
|
+
<p>
|
344
|
+
This parameter is required - either from the including class or instance
|
345
|
+
configuration.
|
346
|
+
</p>
|
347
|
+
|
348
|
+
</div>
|
349
|
+
</div>
|
350
|
+
|
351
|
+
<div id="pkg-version-attribute-method" class="method-detail">
|
352
|
+
<a name="pkg_version"></a>
|
353
|
+
|
354
|
+
<a name="pkg_version="></a>
|
355
|
+
|
356
|
+
<div class="method-heading attribute-method-heading">
|
357
|
+
<span class="method-name">pkg_version</span><span
|
358
|
+
class="attribute-access-type">[RW]</span>
|
359
|
+
</div>
|
360
|
+
|
361
|
+
<div class="method-description">
|
362
|
+
|
363
|
+
<p>
|
364
|
+
The default RubyGem version that we will use when requesting our
|
365
|
+
executable.
|
366
|
+
</p>
|
367
|
+
<p>
|
368
|
+
Classes that include the Task can set the default value for this property
|
369
|
+
at the class level with:
|
370
|
+
</p>
|
371
|
+
<pre>
|
372
|
+
set :pkg_version, '>= 1.0.3'
|
373
|
+
</pre>
|
374
|
+
<p>
|
375
|
+
But that value can be overriden on each instance like:
|
376
|
+
</p>
|
377
|
+
<pre>
|
378
|
+
executable = SomeToolTask.new
|
379
|
+
too.pkg_version = '>= 2.0.0'
|
380
|
+
</pre>
|
381
|
+
<p>
|
382
|
+
This parameter is required - either from the including class or instance
|
383
|
+
configuration.
|
384
|
+
</p>
|
385
|
+
|
386
|
+
</div>
|
387
|
+
</div>
|
388
|
+
|
389
|
+
<div id="default-prefix-attribute-method" class="method-detail">
|
390
|
+
<a name="default_prefix"></a>
|
391
|
+
|
392
|
+
<a name="default_prefix="></a>
|
393
|
+
|
394
|
+
<div class="method-heading attribute-method-heading">
|
395
|
+
<span class="method-name">default_prefix</span><span
|
396
|
+
class="attribute-access-type">[RW]</span>
|
397
|
+
</div>
|
398
|
+
|
399
|
+
<div class="method-description">
|
400
|
+
|
401
|
+
<p>
|
402
|
+
The default command line prefix that should be used in front of parameter
|
403
|
+
names.
|
404
|
+
</p>
|
405
|
+
<p>
|
406
|
+
The default value for this parameter is ’—’, but some
|
407
|
+
command line applications (like MXMLC) prefer ’-’.
|
408
|
+
</p>
|
409
|
+
|
410
|
+
</div>
|
411
|
+
</div>
|
412
|
+
|
413
|
+
<div id="default-short-prefix-attribute-method" class="method-detail">
|
414
|
+
<a name="default_short_prefix"></a>
|
415
|
+
|
416
|
+
<a name="default_short_prefix="></a>
|
417
|
+
|
418
|
+
<div class="method-heading attribute-method-heading">
|
419
|
+
<span class="method-name">default_short_prefix</span><span
|
420
|
+
class="attribute-access-type">[RW]</span>
|
421
|
+
</div>
|
422
|
+
|
423
|
+
<div class="method-description">
|
424
|
+
|
425
|
+
<p>
|
426
|
+
The default command line prefix for short name parameters.
|
427
|
+
</p>
|
428
|
+
<p>
|
429
|
+
This value defaults to ’-’, but can be changed to whatever a
|
430
|
+
particular tool prefers.
|
431
|
+
</p>
|
432
|
+
|
433
|
+
</div>
|
434
|
+
</div>
|
435
|
+
|
436
|
+
<div id="executable-attribute-method" class="method-detail">
|
437
|
+
<a name="executable"></a>
|
438
|
+
|
439
|
+
<a name="executable="></a>
|
440
|
+
|
441
|
+
<div class="method-heading attribute-method-heading">
|
442
|
+
<span class="method-name">executable</span><span
|
443
|
+
class="attribute-access-type">[RW]</span>
|
444
|
+
</div>
|
445
|
+
|
446
|
+
<div class="method-description">
|
447
|
+
|
448
|
+
<p>
|
449
|
+
The default Sprout executable that we will use for this executable.
|
450
|
+
</p>
|
451
|
+
<p>
|
452
|
+
Classes that include the Task can set the default value for this property
|
453
|
+
at the class level with:
|
454
|
+
</p>
|
455
|
+
<pre>
|
456
|
+
set :executable, :mxmlc
|
457
|
+
</pre>
|
458
|
+
<p>
|
459
|
+
But that value can be overriden on each instance like:
|
460
|
+
</p>
|
461
|
+
<pre>
|
462
|
+
executable = SomeToolTask.new
|
463
|
+
too.executable :compc
|
464
|
+
</pre>
|
465
|
+
<p>
|
466
|
+
This parameter is required - either from the including class or instance
|
467
|
+
configuration.
|
468
|
+
</p>
|
469
|
+
|
470
|
+
</div>
|
471
|
+
</div>
|
472
|
+
|
473
|
+
<div id="abort-on-failure-attribute-method" class="method-detail">
|
474
|
+
<a name="abort_on_failure"></a>
|
475
|
+
|
476
|
+
<a name="abort_on_failure="></a>
|
477
|
+
|
478
|
+
<div class="method-heading attribute-method-heading">
|
479
|
+
<span class="method-name">abort_on_failure</span><span
|
480
|
+
class="attribute-access-type">[RW]</span>
|
481
|
+
</div>
|
482
|
+
|
483
|
+
<div class="method-description">
|
484
|
+
|
485
|
+
<p>
|
486
|
+
Configure the executable instance to output failure messages to stderr and
|
487
|
+
abort with non-zero response.
|
488
|
+
</p>
|
489
|
+
|
490
|
+
</div>
|
491
|
+
</div>
|
492
|
+
|
493
|
+
<div id="rake-task-name-attribute-method" class="method-detail">
|
494
|
+
<a name="rake_task_name"></a>
|
495
|
+
|
496
|
+
<a name="rake_task_name="></a>
|
497
|
+
|
498
|
+
<div class="method-heading attribute-method-heading">
|
499
|
+
<span class="method-name">rake_task_name</span><span
|
500
|
+
class="attribute-access-type">[RW]</span>
|
501
|
+
</div>
|
502
|
+
|
503
|
+
<div class="method-description">
|
504
|
+
|
505
|
+
<p>
|
506
|
+
If the executable is configured as a Rake::Task, it will extract the
|
507
|
+
Rake::Task[:name] property and apply it to this field.
|
508
|
+
</p>
|
509
|
+
<p>
|
510
|
+
Concrete parameters can pull this value from their <tt>belongs_to</tt>
|
511
|
+
parameter.
|
512
|
+
</p>
|
513
|
+
|
514
|
+
</div>
|
515
|
+
</div>
|
516
|
+
|
517
|
+
<div id="param-hash-attribute-method" class="method-detail">
|
518
|
+
<a name="param_hash"></a>
|
519
|
+
|
520
|
+
<div class="method-heading attribute-method-heading">
|
521
|
+
<span class="method-name">param_hash</span><span
|
522
|
+
class="attribute-access-type">[R]</span>
|
523
|
+
</div>
|
524
|
+
|
525
|
+
<div class="method-description">
|
526
|
+
|
527
|
+
|
528
|
+
|
529
|
+
</div>
|
530
|
+
</div>
|
531
|
+
|
532
|
+
<div id="params-attribute-method" class="method-detail">
|
533
|
+
<a name="params"></a>
|
534
|
+
|
535
|
+
<div class="method-heading attribute-method-heading">
|
536
|
+
<span class="method-name">params</span><span
|
537
|
+
class="attribute-access-type">[R]</span>
|
538
|
+
</div>
|
539
|
+
|
540
|
+
<div class="method-description">
|
541
|
+
|
542
|
+
|
543
|
+
|
544
|
+
</div>
|
545
|
+
</div>
|
546
|
+
|
547
|
+
<div id="prerequisites-attribute-method" class="method-detail">
|
548
|
+
<a name="prerequisites"></a>
|
549
|
+
|
550
|
+
<div class="method-heading attribute-method-heading">
|
551
|
+
<span class="method-name">prerequisites</span><span
|
552
|
+
class="attribute-access-type">[R]</span>
|
553
|
+
</div>
|
554
|
+
|
555
|
+
<div class="method-description">
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
</div>
|
560
|
+
</div>
|
561
|
+
|
562
|
+
</div>
|
563
|
+
|
564
|
+
|
565
|
+
<!-- Methods -->
|
566
|
+
|
567
|
+
<div id="public-class-method-details" class="method-section section">
|
568
|
+
<h3 class="section-header">Public Class Methods</h3>
|
569
|
+
|
570
|
+
|
571
|
+
<div id="new-method" class="method-detail ">
|
572
|
+
<a name="method-c-new"></a>
|
573
|
+
|
574
|
+
<div class="method-heading">
|
575
|
+
|
576
|
+
<span class="method-name">new</span><span
|
577
|
+
class="method-args">()</span>
|
578
|
+
<span class="method-click-advice">click to toggle source</span>
|
579
|
+
|
580
|
+
</div>
|
581
|
+
|
582
|
+
<div class="method-description">
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
|
588
|
+
<div class="method-source-code"
|
589
|
+
id="new-source">
|
590
|
+
<pre>
|
591
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 252</span>
|
592
|
+
252: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
|
593
|
+
253: <span class="ruby-keyword kw">super</span>
|
594
|
+
254: <span class="ruby-ivar">@abort_on_failure</span> = <span class="ruby-keyword kw">true</span>
|
595
|
+
255: <span class="ruby-ivar">@appended_args</span> = <span class="ruby-keyword kw">nil</span>
|
596
|
+
256: <span class="ruby-ivar">@prepended_args</span> = <span class="ruby-keyword kw">nil</span>
|
597
|
+
257: <span class="ruby-ivar">@param_hash</span> = {}
|
598
|
+
258: <span class="ruby-ivar">@params</span> = []
|
599
|
+
259: <span class="ruby-ivar">@prerequisites</span> = []
|
600
|
+
260: <span class="ruby-ivar">@option_parser</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span>
|
601
|
+
261: <span class="ruby-ivar">@default_prefix</span> = <span class="ruby-constant">DEFAULT_PREFIX</span>
|
602
|
+
262: <span class="ruby-ivar">@default_short_prefix</span> = <span class="ruby-constant">DEFAULT_SHORT_PREFIX</span>
|
603
|
+
263: <span class="ruby-identifier">initialize_parameters</span>
|
604
|
+
264: <span class="ruby-identifier">initialize_defaults</span>
|
605
|
+
265: <span class="ruby-keyword kw">end</span></pre>
|
606
|
+
</div>
|
607
|
+
|
608
|
+
</div>
|
609
|
+
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
</div>
|
614
|
+
|
615
|
+
|
616
|
+
</div>
|
617
|
+
|
618
|
+
<div id="public-instance-method-details" class="method-section section">
|
619
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
620
|
+
|
621
|
+
|
622
|
+
<div id="default-file-expression-method" class="method-detail ">
|
623
|
+
<a name="method-i-default_file_expression"></a>
|
624
|
+
|
625
|
+
<div class="method-heading">
|
626
|
+
|
627
|
+
<span class="method-name">default_file_expression</span><span
|
628
|
+
class="method-args">()</span>
|
629
|
+
<span class="method-click-advice">click to toggle source</span>
|
630
|
+
|
631
|
+
</div>
|
632
|
+
|
633
|
+
<div class="method-description">
|
634
|
+
|
635
|
+
<p>
|
636
|
+
Called by Parameters like :path and :paths
|
637
|
+
</p>
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
<div class="method-source-code"
|
642
|
+
id="default-file-expression-source">
|
643
|
+
<pre>
|
644
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 344</span>
|
645
|
+
344: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">default_file_expression</span>
|
646
|
+
345: <span class="ruby-ivar">@default_file_expression</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Executable</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_FILE_EXPRESSION</span>
|
647
|
+
346: <span class="ruby-keyword kw">end</span></pre>
|
648
|
+
</div>
|
649
|
+
|
650
|
+
</div>
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
</div>
|
656
|
+
|
657
|
+
|
658
|
+
<div id="execute-method" class="method-detail ">
|
659
|
+
<a name="method-i-execute"></a>
|
660
|
+
|
661
|
+
<div class="method-heading">
|
662
|
+
|
663
|
+
<span class="method-name">execute</span><span
|
664
|
+
class="method-args">()</span>
|
665
|
+
<span class="method-click-advice">click to toggle source</span>
|
666
|
+
|
667
|
+
</div>
|
668
|
+
|
669
|
+
<div class="method-description">
|
670
|
+
|
671
|
+
<p>
|
672
|
+
Execute the feature after calling parse with command line arguments.
|
673
|
+
</p>
|
674
|
+
<p>
|
675
|
+
Subclasses will generally override this method if they are a Ruby
|
676
|
+
executable, but if you’re just delegating to an external CLI
|
677
|
+
application, calling execute will wind up executing the external process.
|
678
|
+
</p>
|
679
|
+
|
680
|
+
|
681
|
+
|
682
|
+
<div class="method-source-code"
|
683
|
+
id="execute-source">
|
684
|
+
<pre>
|
685
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 286</span>
|
686
|
+
286: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>
|
687
|
+
287: <span class="ruby-identifier">execute_delegate</span>
|
688
|
+
288: <span class="ruby-keyword kw">end</span></pre>
|
689
|
+
</div>
|
690
|
+
|
691
|
+
</div>
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
</div>
|
697
|
+
|
698
|
+
|
699
|
+
<div id="execute-delegate-method" class="method-detail ">
|
700
|
+
<a name="method-i-execute_delegate"></a>
|
701
|
+
|
702
|
+
<div class="method-heading">
|
703
|
+
|
704
|
+
<span class="method-name">execute_delegate</span><span
|
705
|
+
class="method-args">()</span>
|
706
|
+
<span class="method-click-advice">click to toggle source</span>
|
707
|
+
|
708
|
+
</div>
|
709
|
+
|
710
|
+
<div class="method-description">
|
711
|
+
|
712
|
+
<p>
|
713
|
+
Call the provided executable delegate.
|
714
|
+
</p>
|
715
|
+
<p>
|
716
|
+
This method is generally called from Rake task wrappers.
|
717
|
+
</p>
|
718
|
+
|
719
|
+
|
720
|
+
|
721
|
+
<div class="method-source-code"
|
722
|
+
id="execute-delegate-source">
|
723
|
+
<pre>
|
724
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 295</span>
|
725
|
+
295: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute_delegate</span>
|
726
|
+
296: <span class="ruby-identifier">exe</span> = <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Executable</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">executable</span>, <span class="ruby-identifier">pkg_name</span>, <span class="ruby-identifier">pkg_version</span>).<span class="ruby-identifier">path</span>
|
727
|
+
297: <span class="ruby-constant">Sprout</span>.<span class="ruby-identifier">current_system</span>.<span class="ruby-identifier">execute</span> <span class="ruby-identifier">exe</span>, <span class="ruby-identifier">to_shell</span>
|
728
|
+
298: <span class="ruby-keyword kw">end</span></pre>
|
729
|
+
</div>
|
730
|
+
|
731
|
+
</div>
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
</div>
|
737
|
+
|
738
|
+
|
739
|
+
<div id="parse--method" class="method-detail ">
|
740
|
+
<a name="method-i-parse%21"></a>
|
741
|
+
|
742
|
+
<div class="method-heading">
|
743
|
+
|
744
|
+
<span class="method-name">parse!</span><span
|
745
|
+
class="method-args">(commandline_options)</span>
|
746
|
+
<span class="method-click-advice">click to toggle source</span>
|
747
|
+
|
748
|
+
</div>
|
749
|
+
|
750
|
+
<div class="method-description">
|
751
|
+
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
|
756
|
+
<div class="method-source-code"
|
757
|
+
id="parse--source">
|
758
|
+
<pre>
|
759
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 267</span>
|
760
|
+
267: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse!</span> <span class="ruby-identifier">commandline_options</span>
|
761
|
+
268: <span class="ruby-keyword kw">begin</span>
|
762
|
+
269: <span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">parse!</span> <span class="ruby-identifier">commandline_options</span>
|
763
|
+
270: <span class="ruby-identifier">parse_extra_options!</span> <span class="ruby-identifier">commandline_options</span>
|
764
|
+
271: <span class="ruby-identifier">validate</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">help_requested?</span> <span class="ruby-identifier">commandline_options</span>
|
765
|
+
272: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">StandardError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
766
|
+
273: <span class="ruby-identifier">handle_parse_error</span> <span class="ruby-identifier">e</span>
|
767
|
+
274: <span class="ruby-keyword kw">end</span>
|
768
|
+
275: <span class="ruby-keyword kw">end</span></pre>
|
769
|
+
</div>
|
770
|
+
|
771
|
+
</div>
|
772
|
+
|
773
|
+
|
774
|
+
|
775
|
+
|
776
|
+
</div>
|
777
|
+
|
778
|
+
|
779
|
+
<div id="prepare-method" class="method-detail ">
|
780
|
+
<a name="method-i-prepare"></a>
|
781
|
+
|
782
|
+
<div class="method-heading">
|
783
|
+
|
784
|
+
<span class="method-name">prepare</span><span
|
785
|
+
class="method-args">()</span>
|
786
|
+
<span class="method-click-advice">click to toggle source</span>
|
787
|
+
|
788
|
+
</div>
|
789
|
+
|
790
|
+
<div class="method-description">
|
791
|
+
|
792
|
+
|
793
|
+
|
794
|
+
|
795
|
+
|
796
|
+
<div class="method-source-code"
|
797
|
+
id="prepare-source">
|
798
|
+
<pre>
|
799
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 300</span>
|
800
|
+
300: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare</span>
|
801
|
+
301: <span class="ruby-identifier">params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">param</span><span class="ruby-operator">|</span>
|
802
|
+
302: <span class="ruby-identifier">param</span>.<span class="ruby-identifier">prepare</span>
|
803
|
+
303: <span class="ruby-keyword kw">end</span>
|
804
|
+
304: <span class="ruby-keyword kw">end</span></pre>
|
805
|
+
</div>
|
806
|
+
|
807
|
+
</div>
|
808
|
+
|
809
|
+
|
810
|
+
|
811
|
+
|
812
|
+
</div>
|
813
|
+
|
814
|
+
|
815
|
+
<div id="to-help-method" class="method-detail ">
|
816
|
+
<a name="method-i-to_help"></a>
|
817
|
+
|
818
|
+
<div class="method-heading">
|
819
|
+
|
820
|
+
<span class="method-name">to_help</span><span
|
821
|
+
class="method-args">()</span>
|
822
|
+
<span class="method-click-advice">click to toggle source</span>
|
823
|
+
|
824
|
+
</div>
|
825
|
+
|
826
|
+
<div class="method-description">
|
827
|
+
|
828
|
+
|
829
|
+
|
830
|
+
|
831
|
+
|
832
|
+
<div class="method-source-code"
|
833
|
+
id="to-help-source">
|
834
|
+
<pre>
|
835
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 322</span>
|
836
|
+
322: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_help</span>
|
837
|
+
323: <span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">to_s</span>
|
838
|
+
324: <span class="ruby-keyword kw">end</span></pre>
|
839
|
+
</div>
|
840
|
+
|
841
|
+
</div>
|
842
|
+
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
</div>
|
847
|
+
|
848
|
+
|
849
|
+
<div id="to-rake-method" class="method-detail ">
|
850
|
+
<a name="method-i-to_rake"></a>
|
851
|
+
|
852
|
+
<div class="method-heading">
|
853
|
+
|
854
|
+
<span class="method-name">to_rake</span><span
|
855
|
+
class="method-args">(*args)</span>
|
856
|
+
<span class="method-click-advice">click to toggle source</span>
|
857
|
+
|
858
|
+
</div>
|
859
|
+
|
860
|
+
<div class="method-description">
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
<div class="method-source-code"
|
867
|
+
id="to-rake-source">
|
868
|
+
<pre>
|
869
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 306</span>
|
870
|
+
306: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_rake</span> *<span class="ruby-identifier">args</span>
|
871
|
+
307: <span class="ruby-comment cmt"># Define the file task for - so that</span>
|
872
|
+
308: <span class="ruby-comment cmt"># desc blocks hook up to it...</span>
|
873
|
+
309: <span class="ruby-identifier">file_task</span> = <span class="ruby-identifier">file</span> *<span class="ruby-identifier">args</span> <span class="ruby-keyword kw">do</span>
|
874
|
+
310: <span class="ruby-identifier">execute</span>
|
875
|
+
311: <span class="ruby-keyword kw">end</span>
|
876
|
+
312: <span class="ruby-identifier">update_rake_task_name_from_args</span> *<span class="ruby-identifier">args</span>
|
877
|
+
313: <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
|
878
|
+
314: <span class="ruby-identifier">prepare</span>
|
879
|
+
315: <span class="ruby-identifier">file_task</span>.<span class="ruby-identifier">prerequisites</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">task</span>(<span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Library</span><span class="ruby-operator">::</span><span class="ruby-constant">TASK_NAME</span>)
|
880
|
+
316: <span class="ruby-identifier">prerequisites</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prereq</span><span class="ruby-operator">|</span>
|
881
|
+
317: <span class="ruby-identifier">file_task</span>.<span class="ruby-identifier">prerequisites</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">prereq</span>
|
882
|
+
318: <span class="ruby-keyword kw">end</span>
|
883
|
+
319: <span class="ruby-identifier">file_task</span>
|
884
|
+
320: <span class="ruby-keyword kw">end</span></pre>
|
885
|
+
</div>
|
886
|
+
|
887
|
+
</div>
|
888
|
+
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
</div>
|
893
|
+
|
894
|
+
|
895
|
+
<div id="to-shell-method" class="method-detail ">
|
896
|
+
<a name="method-i-to_shell"></a>
|
897
|
+
|
898
|
+
<div class="method-heading">
|
899
|
+
|
900
|
+
<span class="method-name">to_shell</span><span
|
901
|
+
class="method-args">()</span>
|
902
|
+
<span class="method-click-advice">click to toggle source</span>
|
903
|
+
|
904
|
+
</div>
|
905
|
+
|
906
|
+
<div class="method-description">
|
907
|
+
|
908
|
+
<p>
|
909
|
+
Create a string that represents this configured executable for shell
|
910
|
+
execution
|
911
|
+
</p>
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
<div class="method-source-code"
|
916
|
+
id="to-shell-source">
|
917
|
+
<pre>
|
918
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 327</span>
|
919
|
+
327: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_shell</span>
|
920
|
+
328: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@to_shell_proc</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@to_shell_proc</span>.<span class="ruby-identifier">nil?</span>
|
921
|
+
329:
|
922
|
+
330: <span class="ruby-identifier">result</span> = []
|
923
|
+
331: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@prepended_args</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@prepended_args</span>.<span class="ruby-identifier">nil?</span>
|
924
|
+
332: <span class="ruby-identifier">params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">param</span><span class="ruby-operator">|</span>
|
925
|
+
333: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">param</span>.<span class="ruby-identifier">visible?</span>)
|
926
|
+
334: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">param</span>.<span class="ruby-identifier">to_shell</span>
|
927
|
+
335: <span class="ruby-keyword kw">end</span>
|
928
|
+
336: <span class="ruby-keyword kw">end</span>
|
929
|
+
337: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@appended_args</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@appended_args</span>.<span class="ruby-identifier">nil?</span>
|
930
|
+
338: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">' '</span>)
|
931
|
+
339: <span class="ruby-keyword kw">end</span></pre>
|
932
|
+
</div>
|
933
|
+
|
934
|
+
</div>
|
935
|
+
|
936
|
+
|
937
|
+
|
938
|
+
|
939
|
+
</div>
|
940
|
+
|
941
|
+
|
942
|
+
</div>
|
943
|
+
|
944
|
+
<div id="protected-instance-method-details" class="method-section section">
|
945
|
+
<h3 class="section-header">Protected Instance Methods</h3>
|
946
|
+
|
947
|
+
|
948
|
+
<div id="parse-extra-options--method" class="method-detail ">
|
949
|
+
<a name="method-i-parse_extra_options%21"></a>
|
950
|
+
|
951
|
+
<div class="method-heading">
|
952
|
+
|
953
|
+
<span class="method-name">parse_extra_options!</span><span
|
954
|
+
class="method-args">(options)</span>
|
955
|
+
<span class="method-click-advice">click to toggle source</span>
|
956
|
+
|
957
|
+
</div>
|
958
|
+
|
959
|
+
<div class="method-description">
|
960
|
+
|
961
|
+
|
962
|
+
|
963
|
+
|
964
|
+
|
965
|
+
<div class="method-source-code"
|
966
|
+
id="parse-extra-options--source">
|
967
|
+
<pre>
|
968
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 362</span>
|
969
|
+
362: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_extra_options!</span> <span class="ruby-identifier">options</span>
|
970
|
+
363: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
971
|
+
364: <span class="ruby-identifier">params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">param</span><span class="ruby-operator">|</span>
|
972
|
+
365: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">param</span>.<span class="ruby-identifier">hidden_name?</span>
|
973
|
+
366: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span> <span class="ruby-node">"#{param.name}="</span>, <span class="ruby-identifier">value</span>
|
974
|
+
367: <span class="ruby-keyword kw">break</span>
|
975
|
+
368: <span class="ruby-keyword kw">end</span>
|
976
|
+
369: <span class="ruby-keyword kw">end</span>
|
977
|
+
370: <span class="ruby-keyword kw">end</span>
|
978
|
+
371: <span class="ruby-keyword kw">end</span></pre>
|
979
|
+
</div>
|
980
|
+
|
981
|
+
</div>
|
982
|
+
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
</div>
|
987
|
+
|
988
|
+
|
989
|
+
<div id="parse-rake-task-arg-method" class="method-detail ">
|
990
|
+
<a name="method-i-parse_rake_task_arg"></a>
|
991
|
+
|
992
|
+
<div class="method-heading">
|
993
|
+
|
994
|
+
<span class="method-name">parse_rake_task_arg</span><span
|
995
|
+
class="method-args">(arg)</span>
|
996
|
+
<span class="method-click-advice">click to toggle source</span>
|
997
|
+
|
998
|
+
</div>
|
999
|
+
|
1000
|
+
<div class="method-description">
|
1001
|
+
|
1002
|
+
|
1003
|
+
|
1004
|
+
|
1005
|
+
|
1006
|
+
<div class="method-source-code"
|
1007
|
+
id="parse-rake-task-arg-source">
|
1008
|
+
<pre>
|
1009
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 354</span>
|
1010
|
+
354: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_rake_task_arg</span> <span class="ruby-identifier">arg</span>
|
1011
|
+
355: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
|
1012
|
+
356: <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
1013
|
+
357: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">key</span>
|
1014
|
+
358: <span class="ruby-keyword kw">end</span>
|
1015
|
+
359: <span class="ruby-keyword kw">nil</span>
|
1016
|
+
360: <span class="ruby-keyword kw">end</span></pre>
|
1017
|
+
</div>
|
1018
|
+
|
1019
|
+
</div>
|
1020
|
+
|
1021
|
+
|
1022
|
+
|
1023
|
+
|
1024
|
+
</div>
|
1025
|
+
|
1026
|
+
|
1027
|
+
<div id="update-rake-task-name-from-args-method" class="method-detail ">
|
1028
|
+
<a name="method-i-update_rake_task_name_from_args"></a>
|
1029
|
+
|
1030
|
+
<div class="method-heading">
|
1031
|
+
|
1032
|
+
<span class="method-name">update_rake_task_name_from_args</span><span
|
1033
|
+
class="method-args">(*args)</span>
|
1034
|
+
<span class="method-click-advice">click to toggle source</span>
|
1035
|
+
|
1036
|
+
</div>
|
1037
|
+
|
1038
|
+
<div class="method-description">
|
1039
|
+
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
<div class="method-source-code"
|
1045
|
+
id="update-rake-task-name-from-args-source">
|
1046
|
+
<pre>
|
1047
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 350</span>
|
1048
|
+
350: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update_rake_task_name_from_args</span> *<span class="ruby-identifier">args</span>
|
1049
|
+
351: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rake_task_name</span> = <span class="ruby-identifier">parse_rake_task_arg</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>
|
1050
|
+
352: <span class="ruby-keyword kw">end</span></pre>
|
1051
|
+
</div>
|
1052
|
+
|
1053
|
+
</div>
|
1054
|
+
|
1055
|
+
|
1056
|
+
|
1057
|
+
|
1058
|
+
</div>
|
1059
|
+
|
1060
|
+
|
1061
|
+
</div>
|
1062
|
+
|
1063
|
+
<div id="private-instance-method-details" class="method-section section">
|
1064
|
+
<h3 class="section-header">Private Instance Methods</h3>
|
1065
|
+
|
1066
|
+
|
1067
|
+
<div id="add-help-param-method" class="method-detail ">
|
1068
|
+
<a name="method-i-add_help_param"></a>
|
1069
|
+
|
1070
|
+
<div class="method-heading">
|
1071
|
+
|
1072
|
+
<span class="method-name">add_help_param</span><span
|
1073
|
+
class="method-args">()</span>
|
1074
|
+
<span class="method-click-advice">click to toggle source</span>
|
1075
|
+
|
1076
|
+
</div>
|
1077
|
+
|
1078
|
+
<div class="method-description">
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
|
1084
|
+
<div class="method-source-code"
|
1085
|
+
id="add-help-param-source">
|
1086
|
+
<pre>
|
1087
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 438</span>
|
1088
|
+
438: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_help_param</span>
|
1089
|
+
439: <span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">on</span> <span class="ruby-value str">'--help'</span>, <span class="ruby-value str">'Display this help message'</span> <span class="ruby-keyword kw">do</span>
|
1090
|
+
440: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">to_s</span>
|
1091
|
+
441: <span class="ruby-identifier">exit</span>
|
1092
|
+
442: <span class="ruby-keyword kw">end</span>
|
1093
|
+
443: <span class="ruby-keyword kw">end</span></pre>
|
1094
|
+
</div>
|
1095
|
+
|
1096
|
+
</div>
|
1097
|
+
|
1098
|
+
|
1099
|
+
|
1100
|
+
|
1101
|
+
</div>
|
1102
|
+
|
1103
|
+
|
1104
|
+
<div id="assembled-default-parameter-collection-method" class="method-detail ">
|
1105
|
+
<a name="method-i-assembled_default_parameter_collection"></a>
|
1106
|
+
|
1107
|
+
<div class="method-heading">
|
1108
|
+
|
1109
|
+
<span class="method-name">assembled_default_parameter_collection</span><span
|
1110
|
+
class="method-args">()</span>
|
1111
|
+
<span class="method-click-advice">click to toggle source</span>
|
1112
|
+
|
1113
|
+
</div>
|
1114
|
+
|
1115
|
+
<div class="method-description">
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
|
1120
|
+
|
1121
|
+
<div class="method-source-code"
|
1122
|
+
id="assembled-default-parameter-collection-source">
|
1123
|
+
<pre>
|
1124
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 422</span>
|
1125
|
+
422: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">assembled_default_parameter_collection</span>
|
1126
|
+
423: <span class="ruby-identifier">assembled_static_collection</span> <span class="ruby-value">:static_default_value_collection</span>
|
1127
|
+
424: <span class="ruby-keyword kw">end</span></pre>
|
1128
|
+
</div>
|
1129
|
+
|
1130
|
+
</div>
|
1131
|
+
|
1132
|
+
|
1133
|
+
|
1134
|
+
|
1135
|
+
</div>
|
1136
|
+
|
1137
|
+
|
1138
|
+
<div id="assembled-parameter-collection-method" class="method-detail ">
|
1139
|
+
<a name="method-i-assembled_parameter_collection"></a>
|
1140
|
+
|
1141
|
+
<div class="method-heading">
|
1142
|
+
|
1143
|
+
<span class="method-name">assembled_parameter_collection</span><span
|
1144
|
+
class="method-args">()</span>
|
1145
|
+
<span class="method-click-advice">click to toggle source</span>
|
1146
|
+
|
1147
|
+
</div>
|
1148
|
+
|
1149
|
+
<div class="method-description">
|
1150
|
+
|
1151
|
+
|
1152
|
+
|
1153
|
+
|
1154
|
+
|
1155
|
+
<div class="method-source-code"
|
1156
|
+
id="assembled-parameter-collection-source">
|
1157
|
+
<pre>
|
1158
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 418</span>
|
1159
|
+
418: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">assembled_parameter_collection</span>
|
1160
|
+
419: <span class="ruby-identifier">assembled_static_collection</span> <span class="ruby-value">:static_parameter_collection</span>
|
1161
|
+
420: <span class="ruby-keyword kw">end</span></pre>
|
1162
|
+
</div>
|
1163
|
+
|
1164
|
+
</div>
|
1165
|
+
|
1166
|
+
|
1167
|
+
|
1168
|
+
|
1169
|
+
</div>
|
1170
|
+
|
1171
|
+
|
1172
|
+
<div id="assembled-static-collection-method" class="method-detail ">
|
1173
|
+
<a name="method-i-assembled_static_collection"></a>
|
1174
|
+
|
1175
|
+
<div class="method-heading">
|
1176
|
+
|
1177
|
+
<span class="method-name">assembled_static_collection</span><span
|
1178
|
+
class="method-args">(collection_name)</span>
|
1179
|
+
<span class="method-click-advice">click to toggle source</span>
|
1180
|
+
|
1181
|
+
</div>
|
1182
|
+
|
1183
|
+
<div class="method-description">
|
1184
|
+
|
1185
|
+
|
1186
|
+
|
1187
|
+
|
1188
|
+
|
1189
|
+
<div class="method-source-code"
|
1190
|
+
id="assembled-static-collection-source">
|
1191
|
+
<pre>
|
1192
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 426</span>
|
1193
|
+
426: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">assembled_static_collection</span> <span class="ruby-identifier">collection_name</span>
|
1194
|
+
427: <span class="ruby-identifier">collection</span> = []
|
1195
|
+
428: <span class="ruby-identifier">clazz</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>
|
1196
|
+
429: <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">clazz</span> <span class="ruby-keyword kw">do</span>
|
1197
|
+
430: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">clazz</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">collection_name</span>)
|
1198
|
+
431: <span class="ruby-identifier">collection</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">clazz</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">collection_name</span>)
|
1199
|
+
432: <span class="ruby-keyword kw">end</span>
|
1200
|
+
433: <span class="ruby-identifier">clazz</span> = <span class="ruby-identifier">clazz</span>.<span class="ruby-identifier">superclass</span>
|
1201
|
+
434: <span class="ruby-keyword kw">end</span>
|
1202
|
+
435: <span class="ruby-identifier">collection</span>
|
1203
|
+
436: <span class="ruby-keyword kw">end</span></pre>
|
1204
|
+
</div>
|
1205
|
+
|
1206
|
+
</div>
|
1207
|
+
|
1208
|
+
|
1209
|
+
|
1210
|
+
|
1211
|
+
</div>
|
1212
|
+
|
1213
|
+
|
1214
|
+
<div id="create-parameter-method" class="method-detail ">
|
1215
|
+
<a name="method-i-create_parameter"></a>
|
1216
|
+
|
1217
|
+
<div class="method-heading">
|
1218
|
+
|
1219
|
+
<span class="method-name">create_parameter</span><span
|
1220
|
+
class="method-args">(declaration)</span>
|
1221
|
+
<span class="method-click-advice">click to toggle source</span>
|
1222
|
+
|
1223
|
+
</div>
|
1224
|
+
|
1225
|
+
<div class="method-description">
|
1226
|
+
|
1227
|
+
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
1231
|
+
<div class="method-source-code"
|
1232
|
+
id="create-parameter-source">
|
1233
|
+
<pre>
|
1234
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 458</span>
|
1235
|
+
458: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_parameter</span> <span class="ruby-identifier">declaration</span>
|
1236
|
+
459: <span class="ruby-identifier">param</span> = <span class="ruby-constant">ParameterFactory</span>.<span class="ruby-identifier">create</span> <span class="ruby-identifier">declaration</span>[<span class="ruby-value">:type</span>]
|
1237
|
+
460: <span class="ruby-identifier">param</span>.<span class="ruby-identifier">belongs_to</span> = <span class="ruby-keyword kw">self</span>
|
1238
|
+
461:
|
1239
|
+
462: <span class="ruby-keyword kw">begin</span>
|
1240
|
+
463: <span class="ruby-identifier">declaration</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
1241
|
+
464: <span class="ruby-identifier">param</span>.<span class="ruby-identifier">send</span> <span class="ruby-node">"#{key}="</span>, <span class="ruby-identifier">value</span>
|
1242
|
+
465: <span class="ruby-keyword kw">end</span>
|
1243
|
+
466: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">ArgumentError</span>
|
1244
|
+
467: <span class="ruby-identifier">raise</span> <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">UsageError</span>.<span class="ruby-identifier">new</span> <span class="ruby-node">"Unexpected parameter option encountered with: #{key} and value: #{value}"</span>
|
1245
|
+
468: <span class="ruby-keyword kw">end</span>
|
1246
|
+
469:
|
1247
|
+
470: <span class="ruby-identifier">raise</span> <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">UsageError</span>.<span class="ruby-identifier">new</span> <span class="ruby-value str">"Parameter name is required"</span> <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">param</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span>)
|
1248
|
+
471:
|
1249
|
+
472: <span class="ruby-identifier">param_hash</span>[<span class="ruby-identifier">param</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">param</span>
|
1250
|
+
473: <span class="ruby-identifier">params</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">param</span>
|
1251
|
+
474:
|
1252
|
+
475: <span class="ruby-comment cmt"># Expose this parameter to command line arguments:</span>
|
1253
|
+
476: <span class="ruby-comment cmt">#add_commandline_param param</span>
|
1254
|
+
477:
|
1255
|
+
478: <span class="ruby-identifier">param</span>
|
1256
|
+
479: <span class="ruby-keyword kw">end</span></pre>
|
1257
|
+
</div>
|
1258
|
+
|
1259
|
+
</div>
|
1260
|
+
|
1261
|
+
|
1262
|
+
|
1263
|
+
|
1264
|
+
</div>
|
1265
|
+
|
1266
|
+
|
1267
|
+
<div id="handle-parse-error-method" class="method-detail ">
|
1268
|
+
<a name="method-i-handle_parse_error"></a>
|
1269
|
+
|
1270
|
+
<div class="method-heading">
|
1271
|
+
|
1272
|
+
<span class="method-name">handle_parse_error</span><span
|
1273
|
+
class="method-args">(error)</span>
|
1274
|
+
<span class="method-click-advice">click to toggle source</span>
|
1275
|
+
|
1276
|
+
</div>
|
1277
|
+
|
1278
|
+
<div class="method-description">
|
1279
|
+
|
1280
|
+
|
1281
|
+
|
1282
|
+
|
1283
|
+
|
1284
|
+
<div class="method-source-code"
|
1285
|
+
id="handle-parse-error-source">
|
1286
|
+
<pre>
|
1287
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 379</span>
|
1288
|
+
379: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">handle_parse_error</span> <span class="ruby-identifier">error</span>
|
1289
|
+
380: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">abort_on_failure</span>)
|
1290
|
+
381: <span class="ruby-identifier">parts</span> = []
|
1291
|
+
382: <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">nil</span>
|
1292
|
+
383: <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"[ERROR - #{error.class.name}] #{error.message}"</span>
|
1293
|
+
384: <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">nil</span>
|
1294
|
+
385: <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">to_s</span>
|
1295
|
+
386: <span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">nil</span>
|
1296
|
+
387: <span class="ruby-identifier">abort</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n"</span>)
|
1297
|
+
388: <span class="ruby-keyword kw">else</span>
|
1298
|
+
389: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">error</span>
|
1299
|
+
390: <span class="ruby-keyword kw">end</span>
|
1300
|
+
391: <span class="ruby-keyword kw">end</span></pre>
|
1301
|
+
</div>
|
1302
|
+
|
1303
|
+
</div>
|
1304
|
+
|
1305
|
+
|
1306
|
+
|
1307
|
+
|
1308
|
+
</div>
|
1309
|
+
|
1310
|
+
|
1311
|
+
<div id="help-requested--method" class="method-detail ">
|
1312
|
+
<a name="method-i-help_requested%3F"></a>
|
1313
|
+
|
1314
|
+
<div class="method-heading">
|
1315
|
+
|
1316
|
+
<span class="method-name">help_requested?</span><span
|
1317
|
+
class="method-args">(options)</span>
|
1318
|
+
<span class="method-click-advice">click to toggle source</span>
|
1319
|
+
|
1320
|
+
</div>
|
1321
|
+
|
1322
|
+
<div class="method-description">
|
1323
|
+
|
1324
|
+
|
1325
|
+
|
1326
|
+
|
1327
|
+
|
1328
|
+
<div class="method-source-code"
|
1329
|
+
id="help-requested--source">
|
1330
|
+
<pre>
|
1331
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 375</span>
|
1332
|
+
375: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">help_requested?</span> <span class="ruby-identifier">options</span>
|
1333
|
+
376: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">include?</span> <span class="ruby-value str">'--help'</span>
|
1334
|
+
377: <span class="ruby-keyword kw">end</span></pre>
|
1335
|
+
</div>
|
1336
|
+
|
1337
|
+
</div>
|
1338
|
+
|
1339
|
+
|
1340
|
+
|
1341
|
+
|
1342
|
+
</div>
|
1343
|
+
|
1344
|
+
|
1345
|
+
<div id="initialize-defaults-method" class="method-detail ">
|
1346
|
+
<a name="method-i-initialize_defaults"></a>
|
1347
|
+
|
1348
|
+
<div class="method-heading">
|
1349
|
+
|
1350
|
+
<span class="method-name">initialize_defaults</span><span
|
1351
|
+
class="method-args">()</span>
|
1352
|
+
<span class="method-click-advice">click to toggle source</span>
|
1353
|
+
|
1354
|
+
</div>
|
1355
|
+
|
1356
|
+
<div class="method-description">
|
1357
|
+
|
1358
|
+
|
1359
|
+
|
1360
|
+
|
1361
|
+
|
1362
|
+
<div class="method-source-code"
|
1363
|
+
id="initialize-defaults-source">
|
1364
|
+
<pre>
|
1365
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 411</span>
|
1366
|
+
411: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_defaults</span>
|
1367
|
+
412: <span class="ruby-identifier">assembled_default_parameter_collection</span>.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">option</span><span class="ruby-operator">|</span>
|
1368
|
+
413: <span class="ruby-comment cmt">#puts ">> updating default on: #{self} for: #{option[:name]} with: #{option[:value]}"</span>
|
1369
|
+
414: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span> <span class="ruby-node">"#{option[:name]}="</span>, <span class="ruby-identifier">option</span>[<span class="ruby-value">:value</span>]
|
1370
|
+
415: <span class="ruby-keyword kw">end</span>
|
1371
|
+
416: <span class="ruby-keyword kw">end</span></pre>
|
1372
|
+
</div>
|
1373
|
+
|
1374
|
+
</div>
|
1375
|
+
|
1376
|
+
|
1377
|
+
|
1378
|
+
|
1379
|
+
</div>
|
1380
|
+
|
1381
|
+
|
1382
|
+
<div id="initialize-parameter-method" class="method-detail ">
|
1383
|
+
<a name="method-i-initialize_parameter"></a>
|
1384
|
+
|
1385
|
+
<div class="method-heading">
|
1386
|
+
|
1387
|
+
<span class="method-name">initialize_parameter</span><span
|
1388
|
+
class="method-args">(declaration)</span>
|
1389
|
+
<span class="method-click-advice">click to toggle source</span>
|
1390
|
+
|
1391
|
+
</div>
|
1392
|
+
|
1393
|
+
<div class="method-description">
|
1394
|
+
|
1395
|
+
|
1396
|
+
|
1397
|
+
|
1398
|
+
|
1399
|
+
<div class="method-source-code"
|
1400
|
+
id="initialize-parameter-source">
|
1401
|
+
<pre>
|
1402
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 445</span>
|
1403
|
+
445: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_parameter</span> <span class="ruby-identifier">declaration</span>
|
1404
|
+
446: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">declaration</span>[<span class="ruby-value">:name</span>]
|
1405
|
+
447: <span class="ruby-identifier">name_s</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
|
1406
|
+
448: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">declaration</span>[<span class="ruby-value">:type</span>]
|
1407
|
+
449:
|
1408
|
+
450: <span class="ruby-comment cmt"># First ensure the named accessor doesn't yet exist...</span>
|
1409
|
+
451: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">parameter_hash_includes?</span> <span class="ruby-identifier">name</span>)
|
1410
|
+
452: <span class="ruby-identifier">raise</span> <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">ExecutableError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"ToolTask.add_param called with existing parameter name: #{name_s}"</span>)
|
1411
|
+
453: <span class="ruby-keyword kw">end</span>
|
1412
|
+
454:
|
1413
|
+
455: <span class="ruby-identifier">create_parameter</span> <span class="ruby-identifier">declaration</span>
|
1414
|
+
456: <span class="ruby-keyword kw">end</span></pre>
|
1415
|
+
</div>
|
1416
|
+
|
1417
|
+
</div>
|
1418
|
+
|
1419
|
+
|
1420
|
+
|
1421
|
+
|
1422
|
+
</div>
|
1423
|
+
|
1424
|
+
|
1425
|
+
<div id="initialize-parameters-method" class="method-detail ">
|
1426
|
+
<a name="method-i-initialize_parameters"></a>
|
1427
|
+
|
1428
|
+
<div class="method-heading">
|
1429
|
+
|
1430
|
+
<span class="method-name">initialize_parameters</span><span
|
1431
|
+
class="method-args">()</span>
|
1432
|
+
<span class="method-click-advice">click to toggle source</span>
|
1433
|
+
|
1434
|
+
</div>
|
1435
|
+
|
1436
|
+
<div class="method-description">
|
1437
|
+
|
1438
|
+
|
1439
|
+
|
1440
|
+
|
1441
|
+
|
1442
|
+
<div class="method-source-code"
|
1443
|
+
id="initialize-parameters-source">
|
1444
|
+
<pre>
|
1445
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 393</span>
|
1446
|
+
393: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_parameters</span>
|
1447
|
+
394: <span class="ruby-identifier">add_help_param</span>
|
1448
|
+
395: <span class="ruby-identifier">assembled_parameter_collection</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">declaration</span><span class="ruby-operator">|</span>
|
1449
|
+
396: <span class="ruby-identifier">param</span> = <span class="ruby-identifier">initialize_parameter</span> <span class="ruby-identifier">declaration</span>
|
1450
|
+
397: <span class="ruby-identifier">short</span> = <span class="ruby-identifier">param</span>.<span class="ruby-identifier">option_parser_short_name</span>
|
1451
|
+
398:
|
1452
|
+
399: <span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">on</span> <span class="ruby-identifier">short</span>,
|
1453
|
+
400: <span class="ruby-identifier">param</span>.<span class="ruby-identifier">option_parser_declaration</span>,
|
1454
|
+
401: <span class="ruby-identifier">param</span>.<span class="ruby-identifier">description</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
1455
|
+
402: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">param</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">CollectionParam</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">param</span>.<span class="ruby-identifier">delimiter</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'+='</span>)
|
1456
|
+
403: <span class="ruby-identifier">eval</span> <span class="ruby-node">"self.#{param.name} << '#{value}'"</span>
|
1457
|
+
404: <span class="ruby-keyword kw">else</span>
|
1458
|
+
405: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span> <span class="ruby-node">"#{param.name}="</span>, <span class="ruby-identifier">value</span>
|
1459
|
+
406: <span class="ruby-keyword kw">end</span>
|
1460
|
+
407: <span class="ruby-keyword kw">end</span>
|
1461
|
+
408: <span class="ruby-keyword kw">end</span>
|
1462
|
+
409: <span class="ruby-keyword kw">end</span></pre>
|
1463
|
+
</div>
|
1464
|
+
|
1465
|
+
</div>
|
1466
|
+
|
1467
|
+
|
1468
|
+
|
1469
|
+
|
1470
|
+
</div>
|
1471
|
+
|
1472
|
+
|
1473
|
+
<div id="option-parser-method" class="method-detail ">
|
1474
|
+
<a name="method-i-option_parser"></a>
|
1475
|
+
|
1476
|
+
<div class="method-heading">
|
1477
|
+
|
1478
|
+
<span class="method-name">option_parser</span><span
|
1479
|
+
class="method-args">()</span>
|
1480
|
+
<span class="method-click-advice">click to toggle source</span>
|
1481
|
+
|
1482
|
+
</div>
|
1483
|
+
|
1484
|
+
<div class="method-description">
|
1485
|
+
|
1486
|
+
|
1487
|
+
|
1488
|
+
|
1489
|
+
|
1490
|
+
<div class="method-source-code"
|
1491
|
+
id="option-parser-source">
|
1492
|
+
<pre>
|
1493
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 491</span>
|
1494
|
+
491: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option_parser</span>
|
1495
|
+
492: <span class="ruby-ivar">@option_parser</span>
|
1496
|
+
493: <span class="ruby-keyword kw">end</span></pre>
|
1497
|
+
</div>
|
1498
|
+
|
1499
|
+
</div>
|
1500
|
+
|
1501
|
+
|
1502
|
+
|
1503
|
+
|
1504
|
+
</div>
|
1505
|
+
|
1506
|
+
|
1507
|
+
<div id="parameter-hash-includes--method" class="method-detail ">
|
1508
|
+
<a name="method-i-parameter_hash_includes%3F"></a>
|
1509
|
+
|
1510
|
+
<div class="method-heading">
|
1511
|
+
|
1512
|
+
<span class="method-name">parameter_hash_includes?</span><span
|
1513
|
+
class="method-args">(name)</span>
|
1514
|
+
<span class="method-click-advice">click to toggle source</span>
|
1515
|
+
|
1516
|
+
</div>
|
1517
|
+
|
1518
|
+
<div class="method-description">
|
1519
|
+
|
1520
|
+
|
1521
|
+
|
1522
|
+
|
1523
|
+
|
1524
|
+
<div class="method-source-code"
|
1525
|
+
id="parameter-hash-includes--source">
|
1526
|
+
<pre>
|
1527
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 481</span>
|
1528
|
+
481: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parameter_hash_includes?</span> <span class="ruby-identifier">name</span>
|
1529
|
+
482: <span class="ruby-identifier">param_hash</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>
|
1530
|
+
483: <span class="ruby-keyword kw">end</span></pre>
|
1531
|
+
</div>
|
1532
|
+
|
1533
|
+
</div>
|
1534
|
+
|
1535
|
+
|
1536
|
+
|
1537
|
+
|
1538
|
+
</div>
|
1539
|
+
|
1540
|
+
|
1541
|
+
<div id="validate-method" class="method-detail ">
|
1542
|
+
<a name="method-i-validate"></a>
|
1543
|
+
|
1544
|
+
<div class="method-heading">
|
1545
|
+
|
1546
|
+
<span class="method-name">validate</span><span
|
1547
|
+
class="method-args">()</span>
|
1548
|
+
<span class="method-click-advice">click to toggle source</span>
|
1549
|
+
|
1550
|
+
</div>
|
1551
|
+
|
1552
|
+
<div class="method-description">
|
1553
|
+
|
1554
|
+
|
1555
|
+
|
1556
|
+
|
1557
|
+
|
1558
|
+
<div class="method-source-code"
|
1559
|
+
id="validate-source">
|
1560
|
+
<pre>
|
1561
|
+
<span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 485</span>
|
1562
|
+
485: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>
|
1563
|
+
486: <span class="ruby-identifier">params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">param</span><span class="ruby-operator">|</span>
|
1564
|
+
487: <span class="ruby-identifier">param</span>.<span class="ruby-identifier">validate</span>
|
1565
|
+
488: <span class="ruby-keyword kw">end</span>
|
1566
|
+
489: <span class="ruby-keyword kw">end</span></pre>
|
1567
|
+
</div>
|
1568
|
+
|
1569
|
+
</div>
|
1570
|
+
|
1571
|
+
|
1572
|
+
|
1573
|
+
|
1574
|
+
</div>
|
1575
|
+
|
1576
|
+
|
1577
|
+
</div>
|
1578
|
+
|
1579
|
+
|
1580
|
+
</div>
|
1581
|
+
|
1582
|
+
|
1583
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
1584
|
+
|
1585
|
+
<p>Disabled; run with --debug to generate this.</p>
|
1586
|
+
|
1587
|
+
</div>
|
1588
|
+
|
1589
|
+
<div id="validator-badges">
|
1590
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
1591
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
1592
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
1593
|
+
</div>
|
1594
|
+
|
1595
|
+
</body>
|
1596
|
+
</html>
|
1597
|
+
|