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,244 @@
|
|
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::Daemon::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="../Daemon.html" title="Sprout::Daemon (module)">Daemon</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::Daemon::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/daemon.rb</dd>
|
63
|
+
|
64
|
+
</dl>
|
65
|
+
<div class="clear"></div>
|
66
|
+
|
67
|
+
<h2>Overview</h2><div class="docstring">
|
68
|
+
<div class="discussion">
|
69
|
+
|
70
|
+
<p>These are the methods that will be available on any class that includes
|
71
|
+
Sprout::Daemon.</p>
|
72
|
+
|
73
|
+
|
74
|
+
</div>
|
75
|
+
</div>
|
76
|
+
<div class="tags">
|
77
|
+
|
78
|
+
</div>
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
<h2>
|
83
|
+
Instance Method Summary
|
84
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
85
|
+
</h2>
|
86
|
+
|
87
|
+
<ul class="summary">
|
88
|
+
|
89
|
+
<li class="public ">
|
90
|
+
<span class="summary_signature">
|
91
|
+
|
92
|
+
<a href="#add_action-instance_method" title="#add_action (instance method)">- (Object) <strong>add_action</strong>(name, arguments = nil, options = nil) </a>
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
</span>
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
<span class="summary_desc"><div class='inline'>
|
106
|
+
<p>Add an action that can be called while the long-lived process is active.</p>
|
107
|
+
</div></span>
|
108
|
+
|
109
|
+
</li>
|
110
|
+
|
111
|
+
|
112
|
+
<li class="public ">
|
113
|
+
<span class="summary_signature">
|
114
|
+
|
115
|
+
<a href="#add_action_alias-instance_method" title="#add_action_alias (instance method)">- (Object) <strong>add_action_alias</strong>(alias_name, source_name) </a>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
</span>
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
<span class="summary_desc"><div class='inline'>
|
129
|
+
<p>Create an (often shorter) alias to another action name.</p>
|
130
|
+
</div></span>
|
131
|
+
|
132
|
+
</li>
|
133
|
+
|
134
|
+
|
135
|
+
</ul>
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
<div id="instance_method_details" class="method_details_list">
|
141
|
+
<h2>Instance Method Details</h2>
|
142
|
+
|
143
|
+
|
144
|
+
<div class="method_details first">
|
145
|
+
<p class="signature first" id="add_action-instance_method">
|
146
|
+
|
147
|
+
- (<tt>Object</tt>) <strong>add_action</strong>(name, arguments = nil, options = nil)
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
</p><div class="docstring">
|
152
|
+
<div class="discussion">
|
153
|
+
|
154
|
+
<p>Add an action that can be called while the long-lived process is active.</p>
|
155
|
+
|
156
|
+
<p>This method should raise a Sprout::Errors::UsageError if the provided
|
157
|
+
action name is already defined for the provided instance.</p>
|
158
|
+
|
159
|
+
|
160
|
+
</div>
|
161
|
+
</div>
|
162
|
+
<div class="tags">
|
163
|
+
|
164
|
+
</div><table class="source_code">
|
165
|
+
<tr>
|
166
|
+
<td>
|
167
|
+
<pre class="lines">
|
168
|
+
|
169
|
+
|
170
|
+
72
|
171
|
+
73
|
172
|
+
74
|
173
|
+
75
|
174
|
+
76
|
175
|
+
77</pre>
|
176
|
+
</td>
|
177
|
+
<td>
|
178
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 72</span>
|
179
|
+
|
180
|
+
<span class='kw'>def</span> <span class='id add_action'>add_action</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id arguments'>arguments</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='kw'>nil</span>
|
181
|
+
<span class='id options'>options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
182
|
+
<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>
|
183
|
+
<span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:arguments</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id arguments'>arguments</span>
|
184
|
+
<span class='id create_action_method'>create_action_method</span> <span class='id options'>options</span>
|
185
|
+
<span class='kw'>end</span></pre>
|
186
|
+
</td>
|
187
|
+
</tr>
|
188
|
+
</table>
|
189
|
+
</div>
|
190
|
+
|
191
|
+
<div class="method_details ">
|
192
|
+
<p class="signature " id="add_action_alias-instance_method">
|
193
|
+
|
194
|
+
- (<tt>Object</tt>) <strong>add_action_alias</strong>(alias_name, source_name)
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
</p><div class="docstring">
|
199
|
+
<div class="discussion">
|
200
|
+
|
201
|
+
<p>Create an (often shorter) alias to another action name.</p>
|
202
|
+
|
203
|
+
|
204
|
+
</div>
|
205
|
+
</div>
|
206
|
+
<div class="tags">
|
207
|
+
|
208
|
+
</div><table class="source_code">
|
209
|
+
<tr>
|
210
|
+
<td>
|
211
|
+
<pre class="lines">
|
212
|
+
|
213
|
+
|
214
|
+
82
|
215
|
+
83
|
216
|
+
84
|
217
|
+
85
|
218
|
+
86</pre>
|
219
|
+
</td>
|
220
|
+
<td>
|
221
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 82</span>
|
222
|
+
|
223
|
+
<span class='kw'>def</span> <span class='id add_action_alias'>add_action_alias</span> <span class='id alias_name'>alias_name</span><span class='comma'>,</span> <span class='id source_name'>source_name</span>
|
224
|
+
<span class='id define_method'>define_method</span><span class='lparen'>(</span><span class='id alias_name'>alias_name</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='op'>*</span><span class='id params'>params</span><span class='op'>|</span>
|
225
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id source_name'>source_name</span><span class='comma'>,</span> <span class='id params'>params</span><span class='rparen'>)</span>
|
226
|
+
<span class='kw'>end</span>
|
227
|
+
<span class='kw'>end</span></pre>
|
228
|
+
</td>
|
229
|
+
</tr>
|
230
|
+
</table>
|
231
|
+
</div>
|
232
|
+
|
233
|
+
</div>
|
234
|
+
|
235
|
+
</div>
|
236
|
+
|
237
|
+
<div id="footer">
|
238
|
+
Generated on Wed Dec 22 11:58:33 2010 by
|
239
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
240
|
+
0.6.3 (ruby-1.9.2).
|
241
|
+
</div>
|
242
|
+
|
243
|
+
</body>
|
244
|
+
</html>
|
@@ -0,0 +1,601 @@
|
|
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::Daemon::InstanceMethods</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 (I)</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="../Daemon.html" title="Sprout::Daemon (module)">Daemon</a></span></span>
|
28
|
+
»
|
29
|
+
<span class="title">InstanceMethods</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::Daemon::InstanceMethods
|
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/daemon.rb</dd>
|
63
|
+
|
64
|
+
</dl>
|
65
|
+
<div class="clear"></div>
|
66
|
+
|
67
|
+
<h2>Overview</h2><div class="docstring">
|
68
|
+
<div class="discussion">
|
69
|
+
|
70
|
+
<p>Instance methods that will be available on any class that includes
|
71
|
+
Sprout::Daemon.</p>
|
72
|
+
|
73
|
+
|
74
|
+
</div>
|
75
|
+
</div>
|
76
|
+
<div class="tags">
|
77
|
+
|
78
|
+
</div>
|
79
|
+
|
80
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
81
|
+
<ul class="summary">
|
82
|
+
|
83
|
+
<li class="public ">
|
84
|
+
<span class="summary_signature">
|
85
|
+
|
86
|
+
<a href="#action_stack-instance_method" title="#action_stack (instance method)">- (Object) <strong>action_stack</strong> </a>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
</span>
|
91
|
+
|
92
|
+
|
93
|
+
<span class="note title readonly">readonly</span>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
<span class="summary_desc"><div class='inline'>
|
103
|
+
<p>This is the array of actions that have been provided at the class level to
|
104
|
+
this instance.</p>
|
105
|
+
</div></span>
|
106
|
+
|
107
|
+
</li>
|
108
|
+
|
109
|
+
|
110
|
+
<li class="public ">
|
111
|
+
<span class="summary_signature">
|
112
|
+
|
113
|
+
<a href="#prompt-instance_method" title="#prompt (instance method)">- (Object) <strong>prompt</strong> </a>
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
</span>
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
<span class="summary_desc"><div class='inline'>
|
130
|
+
<p>The prompt expression for this daemon process.</p>
|
131
|
+
</div></span>
|
132
|
+
|
133
|
+
</li>
|
134
|
+
|
135
|
+
|
136
|
+
</ul>
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
<h2>
|
141
|
+
Instance Method Summary
|
142
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
143
|
+
</h2>
|
144
|
+
|
145
|
+
<ul class="summary">
|
146
|
+
|
147
|
+
<li class="protected ">
|
148
|
+
<span class="summary_signature">
|
149
|
+
|
150
|
+
<a href="#create_outer_task-instance_method" title="#create_outer_task (instance method)">- (Object) <strong>create_outer_task</strong>(*args) </a>
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
</span>
|
155
|
+
|
156
|
+
|
157
|
+
<span class="note title protected">protected</span>
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
<span class="summary_desc"><div class='inline'>
|
164
|
+
<p>This is the override of the underlying Sprout::Executable template method
|
165
|
+
so that we create a 'task' instead of a 'file' task.</p>
|
166
|
+
</div></span>
|
167
|
+
|
168
|
+
</li>
|
169
|
+
|
170
|
+
|
171
|
+
<li class="public ">
|
172
|
+
<span class="summary_signature">
|
173
|
+
|
174
|
+
<a href="#execute-instance_method" title="#execute (instance method)">- (Object) <strong>execute</strong> </a>
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
</span>
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
188
|
+
<p>Execute the Daemon executable, followed by the collection of stored actions
|
189
|
+
in the order they were called.</p>
|
190
|
+
</div></span>
|
191
|
+
|
192
|
+
</li>
|
193
|
+
|
194
|
+
|
195
|
+
<li class="public ">
|
196
|
+
<span class="summary_signature">
|
197
|
+
|
198
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (InstanceMethods) <strong>initialize</strong> </a>
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
</span>
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
<span class="summary_desc"><div class='inline'>
|
212
|
+
<p>A new instance of InstanceMethods.</p>
|
213
|
+
</div></span>
|
214
|
+
|
215
|
+
</li>
|
216
|
+
|
217
|
+
|
218
|
+
<li class="protected ">
|
219
|
+
<span class="summary_signature">
|
220
|
+
|
221
|
+
<a href="#system_execute-instance_method" title="#system_execute (instance method)">- (Object) <strong>system_execute</strong>(binary, params) </a>
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
</span>
|
226
|
+
|
227
|
+
|
228
|
+
<span class="note title protected">protected</span>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
<span class="summary_desc"><div class='inline'>
|
235
|
+
<p>This is the override of the underlying Sprout::Executable template method
|
236
|
+
so that we create the process in a thread in order to read and write to
|
237
|
+
it.</p>
|
238
|
+
</div></span>
|
239
|
+
|
240
|
+
</li>
|
241
|
+
|
242
|
+
|
243
|
+
<li class="protected ">
|
244
|
+
<span class="summary_signature">
|
245
|
+
|
246
|
+
<a href="#update_rake_task_name_from_args-instance_method" title="#update_rake_task_name_from_args (instance method)">- (Object) <strong>update_rake_task_name_from_args</strong>(*args) </a>
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
</span>
|
251
|
+
|
252
|
+
|
253
|
+
<span class="note title protected">protected</span>
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
<span class="summary_desc"><div class='inline'>
|
260
|
+
<p>This is the override of the underlying Sprout::Executable template method
|
261
|
+
so that we are NOT added to the CLEAN collection.</p>
|
262
|
+
</div></span>
|
263
|
+
|
264
|
+
</li>
|
265
|
+
|
266
|
+
|
267
|
+
</ul>
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
<div id="instance_attr_details" class="attr_details">
|
272
|
+
<h2>Instance Attribute Details</h2>
|
273
|
+
|
274
|
+
|
275
|
+
<span id=""></span>
|
276
|
+
<span id="action_stack-instance_method"></span>
|
277
|
+
<div class="method_details first">
|
278
|
+
<p class="signature first" id="action_stack-instance_method">
|
279
|
+
|
280
|
+
- (<tt>Object</tt>) <strong>action_stack</strong> <span class="extras">(readonly)</span>
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
</p><div class="docstring">
|
285
|
+
<div class="discussion">
|
286
|
+
|
287
|
+
<p>This is the array of actions that have been provided at the class level to
|
288
|
+
this instance.</p>
|
289
|
+
|
290
|
+
|
291
|
+
</div>
|
292
|
+
</div>
|
293
|
+
<div class="tags">
|
294
|
+
|
295
|
+
</div><table class="source_code">
|
296
|
+
<tr>
|
297
|
+
<td>
|
298
|
+
<pre class="lines">
|
299
|
+
|
300
|
+
|
301
|
+
144
|
302
|
+
145
|
303
|
+
146</pre>
|
304
|
+
</td>
|
305
|
+
<td>
|
306
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 144</span>
|
307
|
+
|
308
|
+
<span class='kw'>def</span> <span class='id action_stack'>action_stack</span>
|
309
|
+
<span class='ivar'>@action_stack</span>
|
310
|
+
<span class='kw'>end</span></pre>
|
311
|
+
</td>
|
312
|
+
</tr>
|
313
|
+
</table>
|
314
|
+
</div>
|
315
|
+
|
316
|
+
|
317
|
+
<span id="prompt=-instance_method"></span>
|
318
|
+
<span id="prompt-instance_method"></span>
|
319
|
+
<div class="method_details ">
|
320
|
+
<p class="signature " id="prompt-instance_method">
|
321
|
+
|
322
|
+
- (<tt>Object</tt>) <strong>prompt</strong>
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
</p><div class="docstring">
|
327
|
+
<div class="discussion">
|
328
|
+
|
329
|
+
<p>The prompt expression for this daemon process.</p>
|
330
|
+
|
331
|
+
<p>When executing a series of commands, the wrapper will wait until it matches
|
332
|
+
this expression on stdout before continuing the series.</p>
|
333
|
+
|
334
|
+
<p>For FDB, this value is set like:</p>
|
335
|
+
|
336
|
+
<pre class="code"><span class='id set'>set</span> <span class='symbol'>:prompt</span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\(fdb\) </span><span class='regexp_end'>/</span></span></pre>
|
337
|
+
|
338
|
+
<p>Most processes can trigger a variety of different prompts, these can be
|
339
|
+
expressed here using the | (or) operator.</p>
|
340
|
+
|
341
|
+
<p>FDB actually uses the following:</p>
|
342
|
+
|
343
|
+
<pre class="code"><span class='id set'>set</span> <span class='symbol'>:prompt</span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\(fdb\) |\(y or n\) </span><span class='regexp_end'>/</span></span></pre>
|
344
|
+
|
345
|
+
|
346
|
+
</div>
|
347
|
+
</div>
|
348
|
+
<div class="tags">
|
349
|
+
|
350
|
+
</div><table class="source_code">
|
351
|
+
<tr>
|
352
|
+
<td>
|
353
|
+
<pre class="lines">
|
354
|
+
|
355
|
+
|
356
|
+
139
|
357
|
+
140
|
358
|
+
141</pre>
|
359
|
+
</td>
|
360
|
+
<td>
|
361
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 139</span>
|
362
|
+
|
363
|
+
<span class='kw'>def</span> <span class='id prompt'>prompt</span>
|
364
|
+
<span class='ivar'>@prompt</span>
|
365
|
+
<span class='kw'>end</span></pre>
|
366
|
+
</td>
|
367
|
+
</tr>
|
368
|
+
</table>
|
369
|
+
</div>
|
370
|
+
|
371
|
+
</div>
|
372
|
+
|
373
|
+
|
374
|
+
<div id="instance_method_details" class="method_details_list">
|
375
|
+
<h2>Instance Method Details</h2>
|
376
|
+
|
377
|
+
|
378
|
+
<div class="method_details first">
|
379
|
+
<p class="signature first" id="create_outer_task-instance_method">
|
380
|
+
|
381
|
+
- (<tt>Object</tt>) <strong>create_outer_task</strong>(*args) <span class="extras">(protected)</span>
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
</p><div class="docstring">
|
386
|
+
<div class="discussion">
|
387
|
+
|
388
|
+
<p>This is the override of the underlying Sprout::Executable template method
|
389
|
+
so that we create a 'task' instead of a 'file' task.</p>
|
390
|
+
|
391
|
+
|
392
|
+
</div>
|
393
|
+
</div>
|
394
|
+
<div class="tags">
|
395
|
+
|
396
|
+
</div><table class="source_code">
|
397
|
+
<tr>
|
398
|
+
<td>
|
399
|
+
<pre class="lines">
|
400
|
+
|
401
|
+
|
402
|
+
173
|
403
|
+
174
|
404
|
+
175
|
405
|
+
176
|
406
|
+
177</pre>
|
407
|
+
</td>
|
408
|
+
<td>
|
409
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 173</span>
|
410
|
+
|
411
|
+
<span class='kw'>def</span> <span class='id create_outer_task'>create_outer_task</span> <span class='op'>*</span><span class='id args'>args</span>
|
412
|
+
<span class='id task'>task</span> <span class='op'>*</span><span class='id args'>args</span> <span class='kw'>do</span>
|
413
|
+
<span class='id execute'>execute</span>
|
414
|
+
<span class='kw'>end</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="execute-instance_method">
|
423
|
+
|
424
|
+
- (<tt>Object</tt>) <strong>execute</strong>
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
</p><div class="docstring">
|
429
|
+
<div class="discussion">
|
430
|
+
|
431
|
+
<p>Execute the Daemon executable, followed by the collection of stored actions
|
432
|
+
in the order they were called.</p>
|
433
|
+
|
434
|
+
<p>If none of the stored actions result in terminating the process, the
|
435
|
+
underlying daemon will be connected to the terminal for user (manual)
|
436
|
+
input.</p>
|
437
|
+
|
438
|
+
|
439
|
+
</div>
|
440
|
+
</div>
|
441
|
+
<div class="tags">
|
442
|
+
|
443
|
+
</div><table class="source_code">
|
444
|
+
<tr>
|
445
|
+
<td>
|
446
|
+
<pre class="lines">
|
447
|
+
|
448
|
+
|
449
|
+
160
|
450
|
+
161
|
451
|
+
162
|
452
|
+
163
|
453
|
+
164
|
454
|
+
165</pre>
|
455
|
+
</td>
|
456
|
+
<td>
|
457
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 160</span>
|
458
|
+
|
459
|
+
<span class='kw'>def</span> <span class='id execute'>execute</span>
|
460
|
+
<span class='id runner'>runner</span> <span class='op'>=</span> <span class='kw'>super</span>
|
461
|
+
<span class='id execute_actions'>execute_actions</span> <span class='id runner'>runner</span>
|
462
|
+
<span class='id handle_user_session'>handle_user_session</span> <span class='id runner'>runner</span>
|
463
|
+
<span class='const'>Process</span><span class='period'>.</span><span class='id wait'>wait</span> <span class='id runner'>runner</span><span class='period'>.</span><span class='id pid'>pid</span>
|
464
|
+
<span class='kw'>end</span></pre>
|
465
|
+
</td>
|
466
|
+
</tr>
|
467
|
+
</table>
|
468
|
+
</div>
|
469
|
+
|
470
|
+
<div class="method_details ">
|
471
|
+
<p class="signature " id="initialize-instance_method">
|
472
|
+
|
473
|
+
- (<tt><span class='object_link'><a href="" title="Sprout::Daemon::InstanceMethods (module)">InstanceMethods</a></span></tt>) <strong>initialize</strong>
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
</p><div class="docstring">
|
478
|
+
<div class="discussion">
|
479
|
+
|
480
|
+
<p>A new instance of InstanceMethods</p>
|
481
|
+
|
482
|
+
|
483
|
+
</div>
|
484
|
+
</div>
|
485
|
+
<div class="tags">
|
486
|
+
|
487
|
+
</div><table class="source_code">
|
488
|
+
<tr>
|
489
|
+
<td>
|
490
|
+
<pre class="lines">
|
491
|
+
|
492
|
+
|
493
|
+
146
|
494
|
+
147
|
495
|
+
148
|
496
|
+
149</pre>
|
497
|
+
</td>
|
498
|
+
<td>
|
499
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 146</span>
|
500
|
+
|
501
|
+
<span class='kw'>def</span> <span class='id initialize'>initialize</span>
|
502
|
+
<span class='kw'>super</span>
|
503
|
+
<span class='ivar'>@action_stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
504
|
+
<span class='kw'>end</span></pre>
|
505
|
+
</td>
|
506
|
+
</tr>
|
507
|
+
</table>
|
508
|
+
</div>
|
509
|
+
|
510
|
+
<div class="method_details ">
|
511
|
+
<p class="signature " id="system_execute-instance_method">
|
512
|
+
|
513
|
+
- (<tt>Object</tt>) <strong>system_execute</strong>(binary, params) <span class="extras">(protected)</span>
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
</p><div class="docstring">
|
518
|
+
<div class="discussion">
|
519
|
+
|
520
|
+
<p>This is the override of the underlying Sprout::Executable template method
|
521
|
+
so that we create the process in a thread in order to read and write to
|
522
|
+
it.</p>
|
523
|
+
|
524
|
+
|
525
|
+
</div>
|
526
|
+
</div>
|
527
|
+
<div class="tags">
|
528
|
+
|
529
|
+
</div><table class="source_code">
|
530
|
+
<tr>
|
531
|
+
<td>
|
532
|
+
<pre class="lines">
|
533
|
+
|
534
|
+
|
535
|
+
193
|
536
|
+
194
|
537
|
+
195</pre>
|
538
|
+
</td>
|
539
|
+
<td>
|
540
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 193</span>
|
541
|
+
|
542
|
+
<span class='kw'>def</span> <span class='id system_execute'>system_execute</span> <span class='id binary'>binary</span><span class='comma'>,</span> <span class='id params'>params</span>
|
543
|
+
<span class='const'>Sprout</span><span class='period'>.</span><span class='id current_system'>current_system</span><span class='period'>.</span><span class='id execute_thread'>execute_thread</span> <span class='id binary'>binary</span><span class='comma'>,</span> <span class='id params'>params</span>
|
544
|
+
<span class='kw'>end</span></pre>
|
545
|
+
</td>
|
546
|
+
</tr>
|
547
|
+
</table>
|
548
|
+
</div>
|
549
|
+
|
550
|
+
<div class="method_details ">
|
551
|
+
<p class="signature " id="update_rake_task_name_from_args-instance_method">
|
552
|
+
|
553
|
+
- (<tt>Object</tt>) <strong>update_rake_task_name_from_args</strong>(*args) <span class="extras">(protected)</span>
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
</p><div class="docstring">
|
558
|
+
<div class="discussion">
|
559
|
+
|
560
|
+
<p>This is the override of the underlying Sprout::Executable template method
|
561
|
+
so that we are NOT added to the CLEAN collection. (Work performed in the
|
562
|
+
Executable)</p>
|
563
|
+
|
564
|
+
|
565
|
+
</div>
|
566
|
+
</div>
|
567
|
+
<div class="tags">
|
568
|
+
|
569
|
+
</div><table class="source_code">
|
570
|
+
<tr>
|
571
|
+
<td>
|
572
|
+
<pre class="lines">
|
573
|
+
|
574
|
+
|
575
|
+
184
|
576
|
+
185
|
577
|
+
186</pre>
|
578
|
+
</td>
|
579
|
+
<td>
|
580
|
+
<pre class="code"><span class="info file"># File 'lib/sprout/daemon.rb', line 184</span>
|
581
|
+
|
582
|
+
<span class='kw'>def</span> <span class='id update_rake_task_name_from_args'>update_rake_task_name_from_args</span> <span class='op'>*</span><span class='id args'>args</span>
|
583
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id rake_task_name'>rake_task_name</span> <span class='op'>=</span> <span class='id parse_rake_task_arg'>parse_rake_task_arg</span> <span class='id args'>args</span><span class='period'>.</span><span class='id last'>last</span>
|
584
|
+
<span class='kw'>end</span></pre>
|
585
|
+
</td>
|
586
|
+
</tr>
|
587
|
+
</table>
|
588
|
+
</div>
|
589
|
+
|
590
|
+
</div>
|
591
|
+
|
592
|
+
</div>
|
593
|
+
|
594
|
+
<div id="footer">
|
595
|
+
Generated on Wed Dec 22 11:58:33 2010 by
|
596
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
597
|
+
0.6.3 (ruby-1.9.2).
|
598
|
+
</div>
|
599
|
+
|
600
|
+
</body>
|
601
|
+
</html>
|