sprout 1.0.32.pre → 1.0.35.pre
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sprout might be problematic. Click here for more details.
- data/Gemfile +2 -1
- data/Gemfile.lock +4 -2
- data/README.textile +12 -13
- data/VERSION +1 -0
- data/doc/Dir.html +288 -0
- data/doc/Rake/Task.html +184 -0
- data/doc/Sprout.html +144 -0
- data/doc/Sprout/ArchiveUnpacker.html +1246 -0
- data/doc/Sprout/Base.html +126 -0
- data/doc/Sprout/Base/ClassMethods.html +434 -0
- data/doc/Sprout/Concern.html +353 -0
- data/doc/Sprout/Daemon.html +166 -0
- data/doc/Sprout/Daemon/ClassMethods.html +244 -0
- data/doc/Sprout/Daemon/InstanceMethods.html +601 -0
- data/doc/Sprout/Errors.html +101 -0
- data/doc/Sprout/Errors/ArchiveUnpackerError.html +125 -0
- data/doc/Sprout/Errors/DestinationExistsError.html +133 -0
- data/doc/Sprout/Errors/DuplicateMemberError.html +132 -0
- data/doc/Sprout/Errors/ExecutableError.html +125 -0
- data/doc/Sprout/Errors/ExecutableRegistrationError.html +132 -0
- data/doc/Sprout/Errors/ExecutionError.html +121 -0
- data/doc/Sprout/Errors/GeneratorError.html +125 -0
- data/doc/Sprout/Errors/InvalidArgumentError.html +132 -0
- data/doc/Sprout/Errors/LoadError.html +121 -0
- data/doc/Sprout/Errors/MissingArgumentError.html +132 -0
- data/doc/Sprout/Errors/MissingExecutableError.html +132 -0
- data/doc/Sprout/Errors/MissingGeneratorError.html +132 -0
- data/doc/Sprout/Errors/MissingTemplateError.html +132 -0
- data/doc/Sprout/Errors/ProcessRunnerError.html +121 -0
- data/doc/Sprout/Errors/RemoteFileLoaderError.html +110 -0
- data/doc/Sprout/Errors/SproutError.html +114 -0
- data/doc/Sprout/Errors/UnknownArchiveType.html +122 -0
- data/doc/Sprout/Errors/UsageError.html +121 -0
- data/doc/Sprout/Errors/ValidationError.html +121 -0
- data/doc/Sprout/Errors/VersionRequirementNotMetError.html +121 -0
- data/doc/Sprout/Executable.html +173 -0
- data/doc/Sprout/Executable/Boolean.html +483 -0
- data/doc/Sprout/Executable/ClassMethods.html +417 -0
- data/doc/Sprout/Executable/CollectionParam.html +483 -0
- data/doc/Sprout/Executable/FileParam.html +484 -0
- data/doc/Sprout/Executable/Files.html +292 -0
- data/doc/Sprout/Executable/InstanceMethods.html +2006 -0
- data/doc/Sprout/Executable/Number.html +141 -0
- data/doc/Sprout/Executable/Param.html +2818 -0
- data/doc/Sprout/Executable/ParameterFactory.html +232 -0
- data/doc/Sprout/Executable/Path.html +223 -0
- data/doc/Sprout/Executable/Paths.html +253 -0
- data/doc/Sprout/Executable/StringParam.html +213 -0
- data/doc/Sprout/Executable/Strings.html +167 -0
- data/doc/Sprout/Executable/Url.html +160 -0
- data/doc/Sprout/Executable/Urls.html +170 -0
- data/doc/Sprout/FileTarget.html +1109 -0
- data/doc/Sprout/Generator.html +689 -0
- data/doc/Sprout/Generator/Base.html +1626 -0
- data/doc/Sprout/Generator/Command.html +690 -0
- data/doc/Sprout/Generator/DirectoryManifest.html +476 -0
- data/doc/Sprout/Generator/FileManifest.html +572 -0
- data/doc/Sprout/Generator/Manifest.html +377 -0
- data/doc/Sprout/Generator/TemplateManifest.html +196 -0
- data/doc/Sprout/GeneratorGenerator.html +1018 -0
- data/doc/Sprout/Library.html +1141 -0
- data/doc/Sprout/LibraryGenerator.html +309 -0
- data/doc/Sprout/Log.html +496 -0
- data/doc/Sprout/MXMLC.html +6373 -0
- data/doc/Sprout/Platform.html +714 -0
- data/doc/Sprout/ProcessRunner.html +1352 -0
- data/doc/Sprout/ProgressBar.html +376 -0
- data/doc/Sprout/ProgressBarImpl.html +2119 -0
- data/doc/Sprout/ProgressBarManager.html +434 -0
- data/doc/Sprout/ProgressBarOutputStream.html +416 -0
- data/doc/Sprout/RDocParser.html +211 -0
- data/doc/Sprout/RemoteFileLoader.html +172 -0
- data/doc/Sprout/RemoteFileTarget.html +679 -0
- data/doc/Sprout/ReversedProgressBar.html +194 -0
- data/doc/Sprout/RubyFeature.html +155 -0
- data/doc/Sprout/RubyFeature/ClassMethods.html +1065 -0
- data/doc/Sprout/RubyGenerator.html +764 -0
- data/doc/Sprout/Specification.html +767 -0
- data/doc/Sprout/System.html +191 -0
- data/doc/Sprout/System/BaseSystem.html +1455 -0
- data/doc/Sprout/System/JavaSystem.html +122 -0
- data/doc/Sprout/System/OSXSystem.html +335 -0
- data/doc/Sprout/System/ThreadMock.html +193 -0
- data/doc/Sprout/System/UnixSystem.html +584 -0
- data/doc/Sprout/System/VistaSystem.html +251 -0
- data/doc/Sprout/System/WinNixSystem.html +325 -0
- data/doc/Sprout/System/WinSystem.html +571 -0
- data/doc/Sprout/ToolGenerator.html +931 -0
- data/doc/Sprout/VERSION.html +128 -0
- data/doc/SproutTestCase.html +1412 -0
- data/doc/String.html +286 -0
- data/doc/_index.html +1035 -0
- data/doc/class_list.html +36 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +53 -0
- data/doc/css/style.css +310 -0
- data/doc/file.README.html +96 -0
- data/doc/file.archive_unpacker.html +288 -0
- data/doc/file.base.html +208 -0
- data/doc/file.base_system.html +278 -0
- data/doc/file.boolean.html +135 -0
- data/doc/file.collection_param.html +139 -0
- data/doc/file.command.html +126 -0
- data/doc/file.concern.html +136 -0
- data/doc/file.daemon.html +309 -0
- data/doc/file.dir.html +76 -0
- data/doc/file.directory_manifest.html +122 -0
- data/doc/file.errors.html +147 -0
- data/doc/file.executable.html +638 -0
- data/doc/file.file_manifest.html +109 -0
- data/doc/file.file_param.html +120 -0
- data/doc/file.file_target.html +140 -0
- data/doc/file.files.html +85 -0
- data/doc/file.generator.html +296 -0
- data/doc/file.generator_class.html +72 -0
- data/doc/file.generator_generator.html +137 -0
- data/doc/file.generator_test.html +92 -0
- data/doc/file.generator_test_helper.html +67 -0
- data/doc/file.java_system.html +62 -0
- data/doc/file.library.html +291 -0
- data/doc/file.library_generator.html +74 -0
- data/doc/file.log.html +100 -0
- data/doc/file.manifest.html +67 -0
- data/doc/file.mxmlc.html +740 -0
- data/doc/file.number.html +67 -0
- data/doc/file.osx_system.html +79 -0
- data/doc/file.param.html +491 -0
- data/doc/file.parameter_factory.html +119 -0
- data/doc/file.path.html +81 -0
- data/doc/file.paths.html +80 -0
- data/doc/file.platform.html +124 -0
- data/doc/file.process_runner.html +224 -0
- data/doc/file.progress_bar.html +390 -0
- data/doc/file.rdoc_parser.html +145 -0
- data/doc/file.remote_file_loader.html +117 -0
- data/doc/file.remote_file_target.html +176 -0
- data/doc/file.ruby_base.html +64 -0
- data/doc/file.ruby_feature.html +244 -0
- data/doc/file.ruby_generator.html +118 -0
- data/doc/file.ruby_input.html +62 -0
- data/doc/file.ruby_test_case.html +78 -0
- data/doc/file.ruby_test_helper.html +61 -0
- data/doc/file.specification.html +248 -0
- data/doc/file.sprout.html +64 -0
- data/doc/file.sprout_test_case.html +280 -0
- data/doc/file.string.html +72 -0
- data/doc/file.string_param.html +76 -0
- data/doc/file.strings.html +71 -0
- data/doc/file.system.html +86 -0
- data/doc/file.template_manifest.html +67 -0
- data/doc/file.tool.html +92 -0
- data/doc/file.tool_generator.html +90 -0
- data/doc/file.unix_system.html +128 -0
- data/doc/file.url.html +71 -0
- data/doc/file.urls.html +70 -0
- data/doc/file.version.html +71 -0
- data/doc/file.vista_system.html +69 -0
- data/doc/file.win_nix_system.html +88 -0
- data/doc/file.win_system.html +129 -0
- data/doc/file_list.html +230 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +96 -0
- data/doc/js/app.js +202 -0
- data/doc/js/full_list.js +149 -0
- data/doc/js/jquery.js +154 -0
- data/doc/method_list.html +3355 -0
- data/doc/top-level-namespace.html +192 -0
- data/lib/sprout/archive_unpacker.rb +203 -137
- data/lib/sprout/base.rb +38 -11
- data/lib/sprout/concern.rb +51 -0
- data/lib/sprout/daemon.rb +256 -0
- data/lib/sprout/executable.rb +40 -11
- data/lib/sprout/executable/boolean.rb +47 -1
- data/lib/sprout/executable/collection_param.rb +33 -1
- data/lib/sprout/executable/file_param.rb +16 -3
- data/lib/sprout/executable/files.rb +5 -0
- data/lib/sprout/executable/number.rb +5 -1
- data/lib/sprout/executable/param.rb +232 -16
- data/lib/sprout/executable/parameter_factory.rb +39 -1
- data/lib/sprout/executable/path.rb +7 -1
- data/lib/sprout/executable/paths.rb +6 -1
- data/lib/sprout/executable/string_param.rb +8 -1
- data/lib/sprout/executable/strings.rb +7 -1
- data/lib/sprout/executable/url.rb +8 -1
- data/lib/sprout/executable/urls.rb +7 -1
- data/lib/sprout/file_target.rb +11 -11
- data/lib/sprout/generator.rb +244 -0
- data/lib/sprout/generator/base.rb +0 -94
- data/lib/sprout/generators/generator/generator_generator.rb +35 -1
- data/lib/sprout/generators/generator/templates/generator_class.rb +3 -3
- data/lib/sprout/library.rb +75 -0
- data/lib/sprout/log.rb +11 -12
- data/lib/sprout/process_runner.rb +29 -9
- data/lib/sprout/remote_file_target.rb +20 -9
- data/lib/sprout/system/base_system.rb +11 -3
- data/lib/sprout/test/sprout_test_case.rb +1 -0
- data/lib/sprout/version.rb +7 -11
- data/rakefile.rb +7 -12
- data/script/add_param_handler.rb +43 -0
- data/sprout.gemspec +2 -3
- data/test/fixtures/executable/fdb.rb +764 -0
- data/test/fixtures/executable/flex3sdk_gem/fdb +60 -0
- data/test/fixtures/executable/mxmlc.rb +9 -11
- data/test/unit/daemon_test.rb +61 -0
- data/test/unit/process_runner_test.rb +21 -0
- data/test/unit/remote_file_target_test.rb +45 -11
- data/test/unit/sprout_test_helper.rb +1 -1
- metadata +210 -29
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta name="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>Module: Sprout::Executable::ClassMethods</title>
|
|
7
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
9
|
+
|
|
10
|
+
<script type="text/javascript" charset="utf-8">
|
|
11
|
+
relpath = '../..';
|
|
12
|
+
if (relpath != '') relpath += '/';
|
|
13
|
+
</script>
|
|
14
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
16
|
+
|
|
17
|
+
</head>
|
|
18
|
+
<body>
|
|
19
|
+
<script type="text/javascript" charset="utf-8">
|
|
20
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
<div id="header">
|
|
24
|
+
<div id="menu">
|
|
25
|
+
|
|
26
|
+
<a href="../../_index.html">Index (C)</a> »
|
|
27
|
+
<span class='title'><span class='object_link'><a href="../../Sprout.html" title="Sprout (module)">Sprout</a></span></span> » <span class='title'><span class='object_link'><a href="../Executable.html" title="Sprout::Executable (module)">Executable</a></span></span>
|
|
28
|
+
»
|
|
29
|
+
<span class="title">ClassMethods</span>
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="search">
|
|
36
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
37
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
38
|
+
<a id ="file_list_link" href="#">File List</a>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div class="clear"></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<iframe id="search_frame"></iframe>
|
|
45
|
+
|
|
46
|
+
<div id="content"><h1>Module: Sprout::Executable::ClassMethods
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
</h1>
|
|
51
|
+
|
|
52
|
+
<dl class="box">
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<dt class="r1 last">Defined in:</dt>
|
|
62
|
+
<dd class="r1 last">lib/sprout/executable.rb</dd>
|
|
63
|
+
|
|
64
|
+
</dl>
|
|
65
|
+
<div class="clear"></div>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<h2>
|
|
72
|
+
Instance Method Summary
|
|
73
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
74
|
+
</h2>
|
|
75
|
+
|
|
76
|
+
<ul class="summary">
|
|
77
|
+
|
|
78
|
+
<li class="public ">
|
|
79
|
+
<span class="summary_signature">
|
|
80
|
+
|
|
81
|
+
<a href="#add_param-instance_method" title="#add_param (instance method)">- (Object) <strong>add_param</strong>(name, type, options = nil) </a>
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
</span>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<span class="summary_desc"><div class='inline'>
|
|
95
|
+
<p><tt>add_param</tt> is the workhorse of the Task.</p>
|
|
96
|
+
</div></span>
|
|
97
|
+
|
|
98
|
+
</li>
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
<li class="public ">
|
|
102
|
+
<span class="summary_signature">
|
|
103
|
+
|
|
104
|
+
<a href="#add_param_alias-instance_method" title="#add_param_alias (instance method)">- (Object) <strong>add_param_alias</strong>(new_name, old_name) </a>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</span>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
118
|
+
|
|
119
|
+
</li>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<li class="public ">
|
|
123
|
+
<span class="summary_signature">
|
|
124
|
+
|
|
125
|
+
<a href="#set-instance_method" title="#set (instance method)">- (Object) <strong>set</strong>(key, value) </a>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</span>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
139
|
+
|
|
140
|
+
</li>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<li class="public ">
|
|
144
|
+
<span class="summary_signature">
|
|
145
|
+
|
|
146
|
+
<a href="#static_default_value_collection-instance_method" title="#static_default_value_collection (instance method)">- (Object) <strong>static_default_value_collection</strong> </a>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</span>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
160
|
+
|
|
161
|
+
</li>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<li class="public ">
|
|
165
|
+
<span class="summary_signature">
|
|
166
|
+
|
|
167
|
+
<a href="#static_parameter_collection-instance_method" title="#static_parameter_collection (instance method)">- (Object) <strong>static_parameter_collection</strong> </a>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
</span>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
181
|
+
|
|
182
|
+
</li>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</ul>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<div id="instance_method_details" class="method_details_list">
|
|
191
|
+
<h2>Instance Method Details</h2>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<div class="method_details first">
|
|
195
|
+
<p class="signature first" id="add_param-instance_method">
|
|
196
|
+
|
|
197
|
+
- (<tt>Object</tt>) <strong>add_param</strong>(name, type, options = nil)
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</p><div class="docstring">
|
|
202
|
+
<div class="discussion">
|
|
203
|
+
|
|
204
|
+
<p><tt>add_param</tt> is the workhorse of the Task. This method is used to add
|
|
205
|
+
new shell parameters to the executable interface.</p>
|
|
206
|
+
|
|
207
|
+
<p><tt>name</tt> is a symbol or string that represents the parameter that you
|
|
208
|
+
would like to add such as :debug or :source_path.</p>
|
|
209
|
+
|
|
210
|
+
<p><tt>type</tt> is a class reference of the Executable::Param that you'd like
|
|
211
|
+
to use. At the time of this writing, add_param will accept 2 class
|
|
212
|
+
references that do not extend Param - String and File. The
|
|
213
|
+
ParameterFactory will automatically resolve these to the correct data type
|
|
214
|
+
when they are created.</p>
|
|
215
|
+
|
|
216
|
+
<pre class="code"><span class='const'>Boolean</span> <span class='kw'>true</span> <span class='kw'>or</span> <span class='kw'>false</span>
|
|
217
|
+
<span class='const'>File</span> <span class='const'>Path</span> <span class='id to'>to</span> <span class='id a'>a</span> <span class='id file'>file</span>
|
|
218
|
+
<span class='const'>Number</span> <span class='const'>Any</span> <span class='id number'>number</span>
|
|
219
|
+
<span class='const'>Path</span> <span class='const'>Path</span> <span class='id to'>to</span> <span class='id a'>a</span> <span class='id directory'>directory</span>
|
|
220
|
+
<span class='const'>String</span> <span class='const'>Any</span> <span class='id string'>string</span> <span class='id value'>value</span>
|
|
221
|
+
<span class='const'>Url</span> <span class='const'>Basic</span> <span class='const'>URL</span>
|
|
222
|
+
|
|
223
|
+
<span class='const'>Files</span> <span class='const'>Collection</span> <span class='id of'>of</span> <span class='id files'>files</span>
|
|
224
|
+
<span class='const'>Paths</span> <span class='const'>Collection</span> <span class='id of'>of</span> <span class='id directories'>directories</span>
|
|
225
|
+
<span class='const'>Strings</span> <span class='const'>Collection</span> <span class='id of'>of</span> <span class='id arbitrary'>arbitrary</span> <span class='id strings'>strings</span>
|
|
226
|
+
<span class='const'>Urls</span> <span class='const'>Collection</span> <span class='id of'>of</span> <span class='const'>URLs</span></pre>
|
|
227
|
+
|
|
228
|
+
<p>Be sure to check out the Sprout::Executable::Param class to learn more
|
|
229
|
+
about working with executable parameters.</p>
|
|
230
|
+
|
|
231
|
+
<p>Once parameters have been added using the <tt>add_param</tt> method,
|
|
232
|
+
clients can set and get those parameters from any newly created executable
|
|
233
|
+
instance, or from the command line.</p>
|
|
234
|
+
|
|
235
|
+
<p>In the case of an executable delegate, parameter values will be sent to the
|
|
236
|
+
command line executable in the order they are added using
|
|
237
|
+
<tt>add_param</tt>.</p>
|
|
238
|
+
|
|
239
|
+
<p>In the case of a Ruby executable, command line parameters will be
|
|
240
|
+
interpreted in the order they are defined using <tt>add_param</tt>.</p>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</div>
|
|
244
|
+
</div>
|
|
245
|
+
<div class="tags">
|
|
246
|
+
|
|
247
|
+
</div><table class="source_code">
|
|
248
|
+
<tr>
|
|
249
|
+
<td>
|
|
250
|
+
<pre class="lines">
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
79
|
|
254
|
+
80
|
|
255
|
+
81
|
|
256
|
+
82
|
|
257
|
+
83
|
|
258
|
+
84
|
|
259
|
+
85
|
|
260
|
+
86
|
|
261
|
+
87
|
|
262
|
+
88
|
|
263
|
+
89
|
|
264
|
+
90
|
|
265
|
+
91
|
|
266
|
+
92
|
|
267
|
+
93
|
|
268
|
+
94</pre>
|
|
269
|
+
</td>
|
|
270
|
+
<td>
|
|
271
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 79</span>
|
|
272
|
+
|
|
273
|
+
<span class='kw'>def</span> <span class='id add_param'>add_param</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id type'>type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='comment'># :yields: Sprout::Executable::Param
|
|
274
|
+
</span> <span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>UsageError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[DEPRECATED] add_param no longer uses closures, you can provide the same values as a hash in the optional last argument.</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
|
|
275
|
+
<span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>UsageError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>The first parameter (name:SymbolOrString) is required</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id name'>name</span><span class='period'>.</span><span class='id nil?'>nil?</span>
|
|
276
|
+
<span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>UsageError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>The second parameter (type:Class) is required</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id type'>type</span><span class='period'>.</span><span class='id nil?'>nil?</span>
|
|
277
|
+
<span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>UsageError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>The type parameter must be a Class by reference</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id type'>type</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Class</span><span class='rparen'>)</span>
|
|
278
|
+
|
|
279
|
+
<span class='id options'>options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
280
|
+
<span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id name'>name</span>
|
|
281
|
+
<span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id type'>type</span>
|
|
282
|
+
<span class='comment'># TODO: Integrate the RDOC-parsed parameter description here:
|
|
283
|
+
</span> <span class='comment'>#options[:description] ||= Sprout::RDocParser.description_for_caller caller.shift
|
|
284
|
+
</span>
|
|
285
|
+
<span class='id create_param_accessors'>create_param_accessors</span> <span class='id options'>options</span>
|
|
286
|
+
<span class='id static_parameter_collection'>static_parameter_collection</span> <span class='op'><<</span> <span class='id options'>options</span>
|
|
287
|
+
<span class='id options'>options</span>
|
|
288
|
+
<span class='kw'>end</span></pre>
|
|
289
|
+
</td>
|
|
290
|
+
</tr>
|
|
291
|
+
</table>
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
<div class="method_details ">
|
|
295
|
+
<p class="signature " id="add_param_alias-instance_method">
|
|
296
|
+
|
|
297
|
+
- (<tt>Object</tt>) <strong>add_param_alias</strong>(new_name, old_name)
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
</p><table class="source_code">
|
|
302
|
+
<tr>
|
|
303
|
+
<td>
|
|
304
|
+
<pre class="lines">
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
96
|
|
308
|
+
97
|
|
309
|
+
98</pre>
|
|
310
|
+
</td>
|
|
311
|
+
<td>
|
|
312
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 96</span>
|
|
313
|
+
|
|
314
|
+
<span class='kw'>def</span> <span class='id add_param_alias'>add_param_alias</span> <span class='id new_name'>new_name</span><span class='comma'>,</span> <span class='id old_name'>old_name</span>
|
|
315
|
+
<span class='id create_param_accessors'>create_param_accessors</span> <span class='symbol'>:name</span> <span class='op'>=></span> <span class='id new_name'>new_name</span><span class='comma'>,</span> <span class='symbol'>:real_name</span> <span class='op'>=></span> <span class='id old_name'>old_name</span>
|
|
316
|
+
<span class='kw'>end</span></pre>
|
|
317
|
+
</td>
|
|
318
|
+
</tr>
|
|
319
|
+
</table>
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
<div class="method_details ">
|
|
323
|
+
<p class="signature " id="set-instance_method">
|
|
324
|
+
|
|
325
|
+
- (<tt>Object</tt>) <strong>set</strong>(key, value)
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</p><table class="source_code">
|
|
330
|
+
<tr>
|
|
331
|
+
<td>
|
|
332
|
+
<pre class="lines">
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
108
|
|
336
|
+
109
|
|
337
|
+
110</pre>
|
|
338
|
+
</td>
|
|
339
|
+
<td>
|
|
340
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 108</span>
|
|
341
|
+
|
|
342
|
+
<span class='kw'>def</span> <span class='id set'>set</span> <span class='id key'>key</span><span class='comma'>,</span> <span class='id value'>value</span>
|
|
343
|
+
<span class='id set_default_value'>set_default_value</span> <span class='id key'>key</span><span class='comma'>,</span> <span class='id value'>value</span>
|
|
344
|
+
<span class='kw'>end</span></pre>
|
|
345
|
+
</td>
|
|
346
|
+
</tr>
|
|
347
|
+
</table>
|
|
348
|
+
</div>
|
|
349
|
+
|
|
350
|
+
<div class="method_details ">
|
|
351
|
+
<p class="signature " id="static_default_value_collection-instance_method">
|
|
352
|
+
|
|
353
|
+
- (<tt>Object</tt>) <strong>static_default_value_collection</strong>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</p><table class="source_code">
|
|
358
|
+
<tr>
|
|
359
|
+
<td>
|
|
360
|
+
<pre class="lines">
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
104
|
|
364
|
+
105
|
|
365
|
+
106</pre>
|
|
366
|
+
</td>
|
|
367
|
+
<td>
|
|
368
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 104</span>
|
|
369
|
+
|
|
370
|
+
<span class='kw'>def</span> <span class='id static_default_value_collection'>static_default_value_collection</span>
|
|
371
|
+
<span class='ivar'>@static_default_value_collection</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
372
|
+
<span class='kw'>end</span></pre>
|
|
373
|
+
</td>
|
|
374
|
+
</tr>
|
|
375
|
+
</table>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
<div class="method_details ">
|
|
379
|
+
<p class="signature " id="static_parameter_collection-instance_method">
|
|
380
|
+
|
|
381
|
+
- (<tt>Object</tt>) <strong>static_parameter_collection</strong>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</p><table class="source_code">
|
|
386
|
+
<tr>
|
|
387
|
+
<td>
|
|
388
|
+
<pre class="lines">
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
100
|
|
392
|
+
101
|
|
393
|
+
102</pre>
|
|
394
|
+
</td>
|
|
395
|
+
<td>
|
|
396
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable.rb', line 100</span>
|
|
397
|
+
|
|
398
|
+
<span class='kw'>def</span> <span class='id static_parameter_collection'>static_parameter_collection</span>
|
|
399
|
+
<span class='ivar'>@static_parameter_collection</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
400
|
+
<span class='kw'>end</span></pre>
|
|
401
|
+
</td>
|
|
402
|
+
</tr>
|
|
403
|
+
</table>
|
|
404
|
+
</div>
|
|
405
|
+
|
|
406
|
+
</div>
|
|
407
|
+
|
|
408
|
+
</div>
|
|
409
|
+
|
|
410
|
+
<div id="footer">
|
|
411
|
+
Generated on Wed Dec 22 11:58:33 2010 by
|
|
412
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
413
|
+
0.6.3 (ruby-1.9.2).
|
|
414
|
+
</div>
|
|
415
|
+
|
|
416
|
+
</body>
|
|
417
|
+
</html>
|
|
@@ -0,0 +1,483 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta name="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>Module: Sprout::Executable::CollectionParam</title>
|
|
7
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
9
|
+
|
|
10
|
+
<script type="text/javascript" charset="utf-8">
|
|
11
|
+
relpath = '../..';
|
|
12
|
+
if (relpath != '') relpath += '/';
|
|
13
|
+
</script>
|
|
14
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
16
|
+
|
|
17
|
+
</head>
|
|
18
|
+
<body>
|
|
19
|
+
<script type="text/javascript" charset="utf-8">
|
|
20
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
<div id="header">
|
|
24
|
+
<div id="menu">
|
|
25
|
+
|
|
26
|
+
<a href="../../_index.html">Index (C)</a> »
|
|
27
|
+
<span class='title'><span class='object_link'><a href="../../Sprout.html" title="Sprout (module)">Sprout</a></span></span> » <span class='title'><span class='object_link'><a href="../Executable.html" title="Sprout::Executable (module)">Executable</a></span></span>
|
|
28
|
+
»
|
|
29
|
+
<span class="title">CollectionParam</span>
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="search">
|
|
36
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
37
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
38
|
+
<a id ="file_list_link" href="#">File List</a>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div class="clear"></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<iframe id="search_frame"></iframe>
|
|
45
|
+
|
|
46
|
+
<div id="content"><h1>Module: Sprout::Executable::CollectionParam
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
</h1>
|
|
51
|
+
|
|
52
|
+
<dl class="box">
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<dt class="r1">Included in:</dt>
|
|
61
|
+
<dd class="r1"><span class='object_link'><a href="Files.html" title="Sprout::Executable::Files (class)">Files</a></span>, <span class='object_link'><a href="Strings.html" title="Sprout::Executable::Strings (class)">Strings</a></span></dd>
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
<dt class="r2 last">Defined in:</dt>
|
|
66
|
+
<dd class="r2 last">lib/sprout/executable/collection_param.rb</dd>
|
|
67
|
+
|
|
68
|
+
</dl>
|
|
69
|
+
<div class="clear"></div>
|
|
70
|
+
|
|
71
|
+
<h2>Overview</h2><div class="docstring">
|
|
72
|
+
<div class="discussion">
|
|
73
|
+
|
|
74
|
+
<p>Included by any parameters that represent a collection of values, rather
|
|
75
|
+
than a single value.</p>
|
|
76
|
+
|
|
77
|
+
<p>Should only be included by classes that extend Sprout::Executable::Param.</p>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
</div>
|
|
81
|
+
</div>
|
|
82
|
+
<div class="tags">
|
|
83
|
+
|
|
84
|
+
<h3>See Also:</h3>
|
|
85
|
+
<ul class="see">
|
|
86
|
+
|
|
87
|
+
<li><span class='object_link'><a href="Files.html" title="Sprout::Executable::Files (class)">Files</a></span></li>
|
|
88
|
+
|
|
89
|
+
<li><span class='object_link'><a href="Paths.html" title="Sprout::Executable::Paths (class)">Paths</a></span></li>
|
|
90
|
+
|
|
91
|
+
<li><span class='object_link'><a href="Strings.html" title="Sprout::Executable::Strings (class)">Strings</a></span></li>
|
|
92
|
+
|
|
93
|
+
<li><span class='object_link'><a href="Urls.html" title="Sprout::Executable::Urls (class)">Urls</a></span></li>
|
|
94
|
+
|
|
95
|
+
</ul>
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
<h2>
|
|
102
|
+
Instance Method Summary
|
|
103
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
104
|
+
</h2>
|
|
105
|
+
|
|
106
|
+
<ul class="summary">
|
|
107
|
+
|
|
108
|
+
<li class="public ">
|
|
109
|
+
<span class="summary_signature">
|
|
110
|
+
|
|
111
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (CollectionParam) <strong>initialize</strong> </a>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</span>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<span class="summary_desc"><div class='inline'>
|
|
125
|
+
<p>A new instance of CollectionParam.</p>
|
|
126
|
+
</div></span>
|
|
127
|
+
|
|
128
|
+
</li>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<li class="public ">
|
|
132
|
+
<span class="summary_signature">
|
|
133
|
+
|
|
134
|
+
<a href="#to_shell-instance_method" title="#to_shell (instance method)">- (Object) <strong>to_shell</strong> </a>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
</span>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'>
|
|
148
|
+
<p>Returns a shell formatted string of the collection.</p>
|
|
149
|
+
</div></span>
|
|
150
|
+
|
|
151
|
+
</li>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<li class="public ">
|
|
155
|
+
<span class="summary_signature">
|
|
156
|
+
|
|
157
|
+
<a href="#to_shell_value-instance_method" title="#to_shell_value (instance method)">- (Object) <strong>to_shell_value</strong> </a>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</span>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
171
|
+
|
|
172
|
+
</li>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<li class="public ">
|
|
176
|
+
<span class="summary_signature">
|
|
177
|
+
|
|
178
|
+
<a href="#value%3D-instance_method" title="#value= (instance method)">- (Object) <strong>value=</strong>(val) </a>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</span>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="summary_desc"><div class='inline'>
|
|
192
|
+
<p>Assign the value and raise if a collection wasn't provided.</p>
|
|
193
|
+
</div></span>
|
|
194
|
+
|
|
195
|
+
</li>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<li class="public ">
|
|
199
|
+
<span class="summary_signature">
|
|
200
|
+
|
|
201
|
+
<a href="#visible%3F-instance_method" title="#visible? (instance method)">- (Boolean) <strong>visible?</strong> </a>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</span>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<span class="summary_desc"><div class='inline'>
|
|
215
|
+
<p>Hide the collection param if no items have been added to it.</p>
|
|
216
|
+
</div></span>
|
|
217
|
+
|
|
218
|
+
</li>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</ul>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<div id="instance_method_details" class="method_details_list">
|
|
227
|
+
<h2>Instance Method Details</h2>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<div class="method_details first">
|
|
231
|
+
<p class="signature first" id="initialize-instance_method">
|
|
232
|
+
|
|
233
|
+
- (<tt><span class='object_link'><a href="" title="Sprout::Executable::CollectionParam (module)">CollectionParam</a></span></tt>) <strong>initialize</strong>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</p><div class="docstring">
|
|
238
|
+
<div class="discussion">
|
|
239
|
+
|
|
240
|
+
<p>A new instance of CollectionParam</p>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</div>
|
|
244
|
+
</div>
|
|
245
|
+
<div class="tags">
|
|
246
|
+
|
|
247
|
+
</div><table class="source_code">
|
|
248
|
+
<tr>
|
|
249
|
+
<td>
|
|
250
|
+
<pre class="lines">
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
20
|
|
254
|
+
21
|
|
255
|
+
22
|
|
256
|
+
23
|
|
257
|
+
24
|
|
258
|
+
25</pre>
|
|
259
|
+
</td>
|
|
260
|
+
<td>
|
|
261
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/collection_param.rb', line 20</span>
|
|
262
|
+
|
|
263
|
+
<span class='kw'>def</span> <span class='id initialize'>initialize</span>
|
|
264
|
+
<span class='kw'>super</span>
|
|
265
|
+
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
266
|
+
<span class='ivar'>@delimiter</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>+=</span><span class='tstring_end'>"</span></span>
|
|
267
|
+
<span class='ivar'>@option_parser_type_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a,b,c</span><span class='tstring_end'>'</span></span>
|
|
268
|
+
<span class='kw'>end</span></pre>
|
|
269
|
+
</td>
|
|
270
|
+
</tr>
|
|
271
|
+
</table>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
<div class="method_details ">
|
|
275
|
+
<p class="signature " id="to_shell-instance_method">
|
|
276
|
+
|
|
277
|
+
- (<tt>Object</tt>) <strong>to_shell</strong>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</p><div class="docstring">
|
|
282
|
+
<div class="discussion">
|
|
283
|
+
|
|
284
|
+
<p>Returns a shell formatted string of the collection</p>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</div>
|
|
288
|
+
</div>
|
|
289
|
+
<div class="tags">
|
|
290
|
+
|
|
291
|
+
</div><table class="source_code">
|
|
292
|
+
<tr>
|
|
293
|
+
<td>
|
|
294
|
+
<pre class="lines">
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
68
|
|
298
|
+
69
|
|
299
|
+
70
|
|
300
|
+
71
|
|
301
|
+
72
|
|
302
|
+
73
|
|
303
|
+
74
|
|
304
|
+
75
|
|
305
|
+
76
|
|
306
|
+
77</pre>
|
|
307
|
+
</td>
|
|
308
|
+
<td>
|
|
309
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/collection_param.rb', line 68</span>
|
|
310
|
+
|
|
311
|
+
<span class='kw'>def</span> <span class='id to_shell'>to_shell</span>
|
|
312
|
+
<span class='id prepare'>prepare</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id prepared?'>prepared?</span>
|
|
313
|
+
<span class='id validate'>validate</span>
|
|
314
|
+
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='id visible?'>visible?</span>
|
|
315
|
+
<span class='kw'>return</span> <span class='ivar'>@to_shell_proc</span><span class='period'>.</span><span class='id call'>call</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@to_shell_proc</span><span class='period'>.</span><span class='id nil?'>nil?</span>
|
|
316
|
+
<span class='kw'>return</span> <span class='id value'>value</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id hidden_name?'>hidden_name?</span>
|
|
317
|
+
<span class='kw'>return</span> <span class='id to_shell_value'>to_shell_value</span><span class='period'>.</span><span class='id collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id val'>val</span><span class='op'>|</span>
|
|
318
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id shell_name'>shell_name</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id delimiter'>delimiter</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id val'>val</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
319
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
320
|
+
<span class='kw'>end</span></pre>
|
|
321
|
+
</td>
|
|
322
|
+
</tr>
|
|
323
|
+
</table>
|
|
324
|
+
</div>
|
|
325
|
+
|
|
326
|
+
<div class="method_details ">
|
|
327
|
+
<p class="signature " id="to_shell_value-instance_method">
|
|
328
|
+
|
|
329
|
+
- (<tt>Object</tt>) <strong>to_shell_value</strong>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</p><table class="source_code">
|
|
334
|
+
<tr>
|
|
335
|
+
<td>
|
|
336
|
+
<pre class="lines">
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
79
|
|
340
|
+
80
|
|
341
|
+
81</pre>
|
|
342
|
+
</td>
|
|
343
|
+
<td>
|
|
344
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/collection_param.rb', line 79</span>
|
|
345
|
+
|
|
346
|
+
<span class='kw'>def</span> <span class='id to_shell_value'>to_shell_value</span>
|
|
347
|
+
<span class='id value'>value</span>
|
|
348
|
+
<span class='kw'>end</span></pre>
|
|
349
|
+
</td>
|
|
350
|
+
</tr>
|
|
351
|
+
</table>
|
|
352
|
+
</div>
|
|
353
|
+
|
|
354
|
+
<div class="method_details ">
|
|
355
|
+
<p class="signature " id="value=-instance_method">
|
|
356
|
+
|
|
357
|
+
- (<tt>Object</tt>) <strong>value=</strong>(val)
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</p><div class="docstring">
|
|
362
|
+
<div class="discussion">
|
|
363
|
+
|
|
364
|
+
<p>Assign the value and raise if a collection wasn't provided.</p>
|
|
365
|
+
|
|
366
|
+
<p>This customization was added so that Rake tasks could help users avoid
|
|
367
|
+
accidentally clobbering a collection with equals assignments.</p>
|
|
368
|
+
|
|
369
|
+
<p>The following example is incorrect and will raise an exception:</p>
|
|
370
|
+
|
|
371
|
+
<pre class="code"><span class='id foo'>foo</span> <span class='symbol'>:name</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id t'>t</span><span class='op'>|</span>
|
|
372
|
+
<span class='id t'>t</span><span class='period'>.</span><span class='id collection'>collection</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A</span><span class='tstring_end'>'</span></span>
|
|
373
|
+
<span class='kw'>end</span></pre>
|
|
374
|
+
|
|
375
|
+
<p>The following example is correct and should not raise an exception:</p>
|
|
376
|
+
|
|
377
|
+
<pre class="code"><span class='id foo'>foo</span> <span class='symbol'>:name</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id t'>t</span><span class='op'>|</span>
|
|
378
|
+
<span class='id t'>t</span><span class='period'>.</span><span class='id collection'>collection</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A</span><span class='tstring_end'>'</span></span>
|
|
379
|
+
<span class='kw'>end</span></pre>
|
|
380
|
+
|
|
381
|
+
<p>The following example is also correct and should not raise an exception:</p>
|
|
382
|
+
|
|
383
|
+
<pre class="code"><span class='id foo'>foo</span> <span class='symbol'>:name</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id t'>t</span><span class='op'>|</span>
|
|
384
|
+
<span class='id t'>t</span><span class='period'>.</span><span class='id collection'>collection</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
385
|
+
<span class='kw'>end</span></pre>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
</div>
|
|
389
|
+
</div>
|
|
390
|
+
<div class="tags">
|
|
391
|
+
|
|
392
|
+
</div><table class="source_code">
|
|
393
|
+
<tr>
|
|
394
|
+
<td>
|
|
395
|
+
<pre class="lines">
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
51
|
|
399
|
+
52
|
|
400
|
+
53
|
|
401
|
+
54
|
|
402
|
+
55
|
|
403
|
+
56
|
|
404
|
+
57</pre>
|
|
405
|
+
</td>
|
|
406
|
+
<td>
|
|
407
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/collection_param.rb', line 51</span>
|
|
408
|
+
|
|
409
|
+
<span class='kw'>def</span> <span class='id value='>value=</span><span class='lparen'>(</span><span class='id val'>val</span><span class='rparen'>)</span>
|
|
410
|
+
<span class='kw'>if</span><span class='lparen'>(</span><span class='id val'>val</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='op'>!</span><span class='id val'>val</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Enumerable</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
411
|
+
<span class='id message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>The </span><span class='embexpr_beg'>#{</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_content'> property is an Enumerable. It looks like you may have used the assignment operator (=) with (</span><span class='embexpr_beg'>#{</span><span class='id value'>value</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_content'>) where the append operator (<<) was expected.</span><span class='tstring_end'>"</span></span>
|
|
412
|
+
<span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>ExecutableError</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id message'>message</span><span class='rparen'>)</span>
|
|
413
|
+
<span class='kw'>end</span>
|
|
414
|
+
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='id val'>val</span>
|
|
415
|
+
<span class='kw'>end</span></pre>
|
|
416
|
+
</td>
|
|
417
|
+
</tr>
|
|
418
|
+
</table>
|
|
419
|
+
</div>
|
|
420
|
+
|
|
421
|
+
<div class="method_details ">
|
|
422
|
+
<p class="signature " id="visible?-instance_method">
|
|
423
|
+
|
|
424
|
+
- (<tt><span class='object_link'><a href="Boolean.html" title="Sprout::Executable::Boolean (class)">Boolean</a></span></tt>) <strong>visible?</strong>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
</p><div class="docstring">
|
|
429
|
+
<div class="discussion">
|
|
430
|
+
|
|
431
|
+
<p>Hide the collection param if no items have been added to it.</p>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</div>
|
|
435
|
+
</div>
|
|
436
|
+
<div class="tags">
|
|
437
|
+
<h3>Returns:</h3>
|
|
438
|
+
<ul class="return">
|
|
439
|
+
|
|
440
|
+
<li>
|
|
441
|
+
|
|
442
|
+
<span class='type'>(<tt><span class='object_link'><a href="Boolean.html" title="Sprout::Executable::Boolean (class)">Boolean</a></span></tt>)</span>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</li>
|
|
448
|
+
|
|
449
|
+
</ul>
|
|
450
|
+
|
|
451
|
+
</div><table class="source_code">
|
|
452
|
+
<tr>
|
|
453
|
+
<td>
|
|
454
|
+
<pre class="lines">
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
62
|
|
458
|
+
63
|
|
459
|
+
64</pre>
|
|
460
|
+
</td>
|
|
461
|
+
<td>
|
|
462
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/collection_param.rb', line 62</span>
|
|
463
|
+
|
|
464
|
+
<span class='kw'>def</span> <span class='id visible?'>visible?</span>
|
|
465
|
+
<span class='lparen'>(</span><span class='op'>!</span><span class='id value'>value</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='op'>&&</span> <span class='id value'>value</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>></span> <span class='int'>0</span><span class='rparen'>)</span>
|
|
466
|
+
<span class='kw'>end</span></pre>
|
|
467
|
+
</td>
|
|
468
|
+
</tr>
|
|
469
|
+
</table>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
<div id="footer">
|
|
477
|
+
Generated on Wed Dec 22 11:58:36 2010 by
|
|
478
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
479
|
+
0.6.3 (ruby-1.9.2).
|
|
480
|
+
</div>
|
|
481
|
+
|
|
482
|
+
</body>
|
|
483
|
+
</html>
|