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,232 @@
|
|
|
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>Class: Sprout::Executable::ParameterFactory</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 (P)</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">ParameterFactory</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>Class: Sprout::Executable::ParameterFactory
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
</h1>
|
|
51
|
+
|
|
52
|
+
<dl class="box">
|
|
53
|
+
|
|
54
|
+
<dt class="r1">Inherits:</dt>
|
|
55
|
+
<dd class="r1">
|
|
56
|
+
<span class="inheritName">Object</span>
|
|
57
|
+
|
|
58
|
+
<ul class="fullTree">
|
|
59
|
+
<li>Object</li>
|
|
60
|
+
|
|
61
|
+
<li class="next">Sprout::Executable::ParameterFactory</li>
|
|
62
|
+
|
|
63
|
+
</ul>
|
|
64
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
65
|
+
|
|
66
|
+
</dd>
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<dt class="r2 last">Defined in:</dt>
|
|
77
|
+
<dd class="r2 last">lib/sprout/executable/parameter_factory.rb</dd>
|
|
78
|
+
|
|
79
|
+
</dl>
|
|
80
|
+
<div class="clear"></div>
|
|
81
|
+
|
|
82
|
+
<h2>Overview</h2><div class="docstring">
|
|
83
|
+
<div class="discussion">
|
|
84
|
+
|
|
85
|
+
<p>A factory to create concrete Sprout::Executable::Param entities from a set
|
|
86
|
+
of known types.</p>
|
|
87
|
+
|
|
88
|
+
<p>If an unrecognized Class reference is provided we will instantiate it and
|
|
89
|
+
ensure that it responds to the public members of the Executable::Param
|
|
90
|
+
interface.</p>
|
|
91
|
+
|
|
92
|
+
<p>This Factory gives you the ability to create new, custom parameter types by
|
|
93
|
+
simply ensuring they are available to Ruby before your executable is
|
|
94
|
+
interpreted.</p>
|
|
95
|
+
|
|
96
|
+
<p>Following is an example of a custom Parameter:</p>
|
|
97
|
+
|
|
98
|
+
<pre class="code"><span class='kw'>class</span> <span class='const'>CustomParam</span> <span class='op'><</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Executable</span><span class='op'>::</span><span class='const'>Param</span>
|
|
99
|
+
|
|
100
|
+
<span class='kw'>def</span> <span class='id to_shell'>to_shell</span>
|
|
101
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--foo-bar=</span><span class='embexpr_beg'>#{</span><span class='id value'>value</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
102
|
+
<span class='kw'>end</span>
|
|
103
|
+
<span class='kw'>end</span></pre>
|
|
104
|
+
|
|
105
|
+
<p>Following is an example Executable that can consume the above parameter:</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code"><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>custom_param</span><span class='tstring_end'>'</span></span>
|
|
108
|
+
|
|
109
|
+
<span class='kw'>class</span> <span class='const'>Foo</span>
|
|
110
|
+
<span class='id include'>include</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Executable</span>
|
|
111
|
+
|
|
112
|
+
<span class='id add_param'>add_param</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='const'>CustomParam</span>
|
|
113
|
+
|
|
114
|
+
<span class='kw'>end</span></pre>
|
|
115
|
+
|
|
116
|
+
<p>That's it, there is no need to register your custom types with the Factory,
|
|
117
|
+
just get it into your load path and require it.</p>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
</div>
|
|
122
|
+
<div class="tags">
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<h2>
|
|
129
|
+
Class Method Summary
|
|
130
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
131
|
+
</h2>
|
|
132
|
+
|
|
133
|
+
<ul class="summary">
|
|
134
|
+
|
|
135
|
+
<li class="public ">
|
|
136
|
+
<span class="summary_signature">
|
|
137
|
+
|
|
138
|
+
<a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong>(type) </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<span class="summary_desc"><div class='inline'>
|
|
152
|
+
<p>This factory allows us to use classes by reference in the Executable
|
|
153
|
+
interface.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</ul>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<div id="class_method_details" class="method_details_list">
|
|
165
|
+
<h2>Class Method Details</h2>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<div class="method_details first">
|
|
169
|
+
<p class="signature first" id="create-class_method">
|
|
170
|
+
|
|
171
|
+
+ (<tt>Object</tt>) <strong>create</strong>(type)
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</p><div class="docstring">
|
|
176
|
+
<div class="discussion">
|
|
177
|
+
|
|
178
|
+
<p>This factory allows us to use classes by reference in the Executable
|
|
179
|
+
interface. Since there are already Ruby primitives for String and File and
|
|
180
|
+
we don't want to clobber them, we use this factory to convert those to the
|
|
181
|
+
appropriate types.</p>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
<div class="tags">
|
|
187
|
+
|
|
188
|
+
</div><table class="source_code">
|
|
189
|
+
<tr>
|
|
190
|
+
<td>
|
|
191
|
+
<pre class="lines">
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
54
|
|
195
|
+
55
|
|
196
|
+
56
|
|
197
|
+
57
|
|
198
|
+
58
|
|
199
|
+
59
|
|
200
|
+
60
|
|
201
|
+
61
|
|
202
|
+
62</pre>
|
|
203
|
+
</td>
|
|
204
|
+
<td>
|
|
205
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/parameter_factory.rb', line 54</span>
|
|
206
|
+
|
|
207
|
+
<span class='kw'>def</span> <span class='id create'>create</span> <span class='id type'>type</span>
|
|
208
|
+
<span class='comment'># Didn't want to clobber the stdlib references
|
|
209
|
+
</span> <span class='comment'># to these two important data types...
|
|
210
|
+
</span> <span class='comment'># But wanted to keep the add_param interface
|
|
211
|
+
</span> <span class='comment'># clean and simple.
|
|
212
|
+
</span> <span class='kw'>return</span> <span class='const'>StringParam</span><span class='period'>.</span><span class='id new'>new</span> <span class='kw'>if</span> <span class='id type'>type</span> <span class='op'>==</span> <span class='const'>String</span>
|
|
213
|
+
<span class='kw'>return</span> <span class='const'>FileParam</span><span class='period'>.</span><span class='id new'>new</span> <span class='kw'>if</span> <span class='id type'>type</span> <span class='op'>==</span> <span class='const'>File</span>
|
|
214
|
+
<span class='id type'>type</span><span class='period'>.</span><span class='id new'>new</span>
|
|
215
|
+
<span class='kw'>end</span></pre>
|
|
216
|
+
</td>
|
|
217
|
+
</tr>
|
|
218
|
+
</table>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
</div>
|
|
224
|
+
|
|
225
|
+
<div id="footer">
|
|
226
|
+
Generated on Wed Dec 22 11:58:36 2010 by
|
|
227
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
228
|
+
0.6.3 (ruby-1.9.2).
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
</body>
|
|
232
|
+
</html>
|
|
@@ -0,0 +1,223 @@
|
|
|
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>Class: Sprout::Executable::Path</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 (P)</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">Path</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>Class: Sprout::Executable::Path
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
</h1>
|
|
51
|
+
|
|
52
|
+
<dl class="box">
|
|
53
|
+
|
|
54
|
+
<dt class="r1">Inherits:</dt>
|
|
55
|
+
<dd class="r1">
|
|
56
|
+
<span class="inheritName"><span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></span>
|
|
57
|
+
|
|
58
|
+
<ul class="fullTree">
|
|
59
|
+
<li>Object</li>
|
|
60
|
+
|
|
61
|
+
<li class="next"><span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></li>
|
|
62
|
+
|
|
63
|
+
<li class="next">Sprout::Executable::Path</li>
|
|
64
|
+
|
|
65
|
+
</ul>
|
|
66
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
67
|
+
|
|
68
|
+
</dd>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<dt class="r2 last">Defined in:</dt>
|
|
79
|
+
<dd class="r2 last">lib/sprout/executable/path.rb</dd>
|
|
80
|
+
|
|
81
|
+
</dl>
|
|
82
|
+
<div class="clear"></div>
|
|
83
|
+
|
|
84
|
+
<h2>Overview</h2><div class="docstring">
|
|
85
|
+
<div class="discussion">
|
|
86
|
+
|
|
87
|
+
<p>Concrete Sprout::Executable::Param object for Path values.</p>
|
|
88
|
+
|
|
89
|
+
<p>Path parameters will create a FileList of prerequisites by concatenating
|
|
90
|
+
the value with the <tt>file_expression</tt> that is set on the parameter or
|
|
91
|
+
Sprout::Executable.</p>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
</div>
|
|
95
|
+
</div>
|
|
96
|
+
<div class="tags">
|
|
97
|
+
|
|
98
|
+
<h3>See Also:</h3>
|
|
99
|
+
<ul class="see">
|
|
100
|
+
|
|
101
|
+
<li><span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></li>
|
|
102
|
+
|
|
103
|
+
</ul>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
<h2>Constant Summary</h2>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<h3 class="inherited">Constants inherited from <span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></h3>
|
|
115
|
+
<p class="inherited"><span class='object_link'><a href="Param.html#DEFAULT_DELIMITER-constant" title="Sprout::Executable::Param::DEFAULT_DELIMITER (constant)">DEFAULT_DELIMITER</a></span>, <span class='object_link'><a href="Param.html#DEFAULT_OPTION_PARSER_TYPE_NAME-constant" title="Sprout::Executable::Param::DEFAULT_OPTION_PARSER_TYPE_NAME (constant)">DEFAULT_OPTION_PARSER_TYPE_NAME</a></span>, <span class='object_link'><a href="Param.html#DEFAULT_PREFIX-constant" title="Sprout::Executable::Param::DEFAULT_PREFIX (constant)">DEFAULT_PREFIX</a></span>, <span class='object_link'><a href="Param.html#DEFAULT_SHORT_PREFIX-constant" title="Sprout::Executable::Param::DEFAULT_SHORT_PREFIX (constant)">DEFAULT_SHORT_PREFIX</a></span></p>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>
|
|
120
|
+
Instance Method Summary
|
|
121
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
122
|
+
</h2>
|
|
123
|
+
|
|
124
|
+
<ul class="summary">
|
|
125
|
+
|
|
126
|
+
<li class="public ">
|
|
127
|
+
<span class="summary_signature">
|
|
128
|
+
|
|
129
|
+
<a href="#prepare_prerequisites-instance_method" title="#prepare_prerequisites (instance method)">- (Object) <strong>prepare_prerequisites</strong> </a>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
143
|
+
|
|
144
|
+
</li>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</ul>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></h3>
|
|
159
|
+
<p class="inherited"><span class='object_link'><a href="Param.html#clean_path-instance_method" title="Sprout::Executable::Param#clean_path (method)">#clean_path</a></span>, <span class='object_link'><a href="Param.html#default-instance_method" title="Sprout::Executable::Param#default (method)">#default</a></span>, <span class='object_link'><a href="Param.html#default%3D-instance_method" title="Sprout::Executable::Param#default= (method)">#default=</a></span>, <span class='object_link'><a href="Param.html#file_is_output%3F-instance_method" title="Sprout::Executable::Param#file_is_output? (method)">#file_is_output?</a></span>, <span class='object_link'><a href="Param.html#hidden_name%3F-instance_method" title="Sprout::Executable::Param#hidden_name? (method)">#hidden_name?</a></span>, <span class='object_link'><a href="Param.html#hidden_value%3F-instance_method" title="Sprout::Executable::Param#hidden_value? (method)">#hidden_value?</a></span>, <span class='object_link'><a href="Param.html#initialize-instance_method" title="Sprout::Executable::Param#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Param.html#option_parser_declaration-instance_method" title="Sprout::Executable::Param#option_parser_declaration (method)">#option_parser_declaration</a></span>, <span class='object_link'><a href="Param.html#option_parser_name-instance_method" title="Sprout::Executable::Param#option_parser_name (method)">#option_parser_name</a></span>, <span class='object_link'><a href="Param.html#option_parser_short_name-instance_method" title="Sprout::Executable::Param#option_parser_short_name (method)">#option_parser_short_name</a></span>, <span class='object_link'><a href="Param.html#option_parser_type_name-instance_method" title="Sprout::Executable::Param#option_parser_type_name (method)">#option_parser_type_name</a></span>, <span class='object_link'><a href="Param.html#option_parser_type_output-instance_method" title="Sprout::Executable::Param#option_parser_type_output (method)">#option_parser_type_output</a></span>, <span class='object_link'><a href="Param.html#prepare-instance_method" title="Sprout::Executable::Param#prepare (method)">#prepare</a></span>, <span class='object_link'><a href="Param.html#prepared%3F-instance_method" title="Sprout::Executable::Param#prepared? (method)">#prepared?</a></span>, <span class='object_link'><a href="Param.html#required%3F-instance_method" title="Sprout::Executable::Param#required? (method)">#required?</a></span>, <span class='object_link'><a href="Param.html#shell_value-instance_method" title="Sprout::Executable::Param#shell_value (method)">#shell_value</a></span>, <span class='object_link'><a href="Param.html#short_prefix-instance_method" title="Sprout::Executable::Param#short_prefix (method)">#short_prefix</a></span>, <span class='object_link'><a href="Param.html#to_rdoc-instance_method" title="Sprout::Executable::Param#to_rdoc (method)">#to_rdoc</a></span>, <span class='object_link'><a href="Param.html#to_shell-instance_method" title="Sprout::Executable::Param#to_shell (method)">#to_shell</a></span>, <span class='object_link'><a href="Param.html#validate-instance_method" title="Sprout::Executable::Param#validate (method)">#validate</a></span>, <span class='object_link'><a href="Param.html#visible%3F-instance_method" title="Sprout::Executable::Param#visible? (method)">#visible?</a></span></p>
|
|
160
|
+
<div id="constructor_details" class="method_details_list">
|
|
161
|
+
<h2>Constructor Details</h2>
|
|
162
|
+
|
|
163
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Param.html#initialize-instance_method" title="Sprout::Executable::Param#initialize (method)">Sprout::Executable::Param</a></span></p>
|
|
164
|
+
|
|
165
|
+
</div>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<div id="instance_method_details" class="method_details_list">
|
|
169
|
+
<h2>Instance Method Details</h2>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<div class="method_details first">
|
|
173
|
+
<p class="signature first" id="prepare_prerequisites-instance_method">
|
|
174
|
+
|
|
175
|
+
- (<tt>Object</tt>) <strong>prepare_prerequisites</strong>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
</p><table class="source_code">
|
|
180
|
+
<tr>
|
|
181
|
+
<td>
|
|
182
|
+
<pre class="lines">
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
15
|
|
186
|
+
16
|
|
187
|
+
17
|
|
188
|
+
18
|
|
189
|
+
19
|
|
190
|
+
20
|
|
191
|
+
21
|
|
192
|
+
22
|
|
193
|
+
23</pre>
|
|
194
|
+
</td>
|
|
195
|
+
<td>
|
|
196
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/executable/path.rb', line 15</span>
|
|
197
|
+
|
|
198
|
+
<span class='kw'>def</span> <span class='id prepare_prerequisites'>prepare_prerequisites</span>
|
|
199
|
+
<span class='kw'>if</span><span class='lparen'>(</span><span class='id value'>value</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id file_is_output?'>file_is_output?</span><span class='lparen'>(</span><span class='id value'>value</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
200
|
+
<span class='id files'>files</span> <span class='op'>=</span> <span class='const'>FileList</span><span class='lbracket'>[</span><span class='id value'>value</span> <span class='op'>+</span> <span class='id file_expression'>file_expression</span><span class='rbracket'>]</span>
|
|
201
|
+
<span class='id files'>files</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id f'>f</span><span class='op'>|</span>
|
|
202
|
+
<span class='id file'>file</span> <span class='id f'>f</span>
|
|
203
|
+
<span class='id belongs_to'>belongs_to</span><span class='period'>.</span><span class='id prerequisites'>prerequisites</span> <span class='op'><<</span> <span class='id f'>f</span>
|
|
204
|
+
<span class='kw'>end</span>
|
|
205
|
+
<span class='kw'>end</span>
|
|
206
|
+
<span class='kw'>end</span></pre>
|
|
207
|
+
</td>
|
|
208
|
+
</tr>
|
|
209
|
+
</table>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
</div>
|
|
213
|
+
|
|
214
|
+
</div>
|
|
215
|
+
|
|
216
|
+
<div id="footer">
|
|
217
|
+
Generated on Wed Dec 22 11:58:35 2010 by
|
|
218
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
219
|
+
0.6.3 (ruby-1.9.2).
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
</body>
|
|
223
|
+
</html>
|