sprout 1.0.13.pre → 1.0.14.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.

Files changed (148) hide show
  1. data/lib/sprout/version.rb +1 -1
  2. data/sprout-1.0.13.pre.gem +0 -0
  3. data/sprout.gemspec +1 -1
  4. metadata +3 -146
  5. data/POSTINSTALL.rdoc +0 -28
  6. data/lib/sprout/rdoc_parser.rb +0 -91
  7. data/rdoc/<.html +0 -274
  8. data/rdoc/Dir.html +0 -387
  9. data/rdoc/Object.html +0 -344
  10. data/rdoc/Sprout.html +0 -440
  11. data/rdoc/Sprout/ArchiveUnpacker.html +0 -1045
  12. data/rdoc/Sprout/Base.html +0 -283
  13. data/rdoc/Sprout/Base/ClassMethods.html +0 -474
  14. data/rdoc/Sprout/Concern.html +0 -415
  15. data/rdoc/Sprout/Errors.html +0 -324
  16. data/rdoc/Sprout/Errors/ArchiveUnpackerError.html +0 -284
  17. data/rdoc/Sprout/Errors/DestinationExistsError.html +0 -286
  18. data/rdoc/Sprout/Errors/DuplicateMemberError.html +0 -284
  19. data/rdoc/Sprout/Errors/ExecutableError.html +0 -285
  20. data/rdoc/Sprout/Errors/ExecutableRegistrationError.html +0 -284
  21. data/rdoc/Sprout/Errors/ExecutionError.html +0 -284
  22. data/rdoc/Sprout/Errors/GeneratorError.html +0 -284
  23. data/rdoc/Sprout/Errors/InvalidArgumentError.html +0 -284
  24. data/rdoc/Sprout/Errors/LoadError.html +0 -284
  25. data/rdoc/Sprout/Errors/MissingArgumentError.html +0 -284
  26. data/rdoc/Sprout/Errors/MissingExecutableError.html +0 -284
  27. data/rdoc/Sprout/Errors/MissingGeneratorError.html +0 -285
  28. data/rdoc/Sprout/Errors/MissingTemplateError.html +0 -285
  29. data/rdoc/Sprout/Errors/ProcessRunnerError.html +0 -284
  30. data/rdoc/Sprout/Errors/RemoteFileLoaderError.html +0 -284
  31. data/rdoc/Sprout/Errors/SproutError.html +0 -284
  32. data/rdoc/Sprout/Errors/UnknownArchiveType.html +0 -285
  33. data/rdoc/Sprout/Errors/UsageError.html +0 -284
  34. data/rdoc/Sprout/Errors/ValidationError.html +0 -284
  35. data/rdoc/Sprout/Errors/VersionRequirementNotMetError.html +0 -284
  36. data/rdoc/Sprout/Executable.html +0 -549
  37. data/rdoc/Sprout/Executable/Boolean.html +0 -445
  38. data/rdoc/Sprout/Executable/ClassMethods.html +0 -713
  39. data/rdoc/Sprout/Executable/CollectionParam.html +0 -501
  40. data/rdoc/Sprout/Executable/FileParam.html +0 -512
  41. data/rdoc/Sprout/Executable/Files.html +0 -385
  42. data/rdoc/Sprout/Executable/InstanceMethods.html +0 -1597
  43. data/rdoc/Sprout/Executable/Number.html +0 -284
  44. data/rdoc/Sprout/Executable/Param.html +0 -1660
  45. data/rdoc/Sprout/Executable/ParameterFactory.html +0 -345
  46. data/rdoc/Sprout/Executable/Path.html +0 -339
  47. data/rdoc/Sprout/Executable/Paths.html +0 -339
  48. data/rdoc/Sprout/Executable/StringParam.html +0 -333
  49. data/rdoc/Sprout/Executable/Strings.html +0 -295
  50. data/rdoc/Sprout/Executable/Url.html +0 -284
  51. data/rdoc/Sprout/Executable/Urls.html +0 -284
  52. data/rdoc/Sprout/FileTarget.html +0 -660
  53. data/rdoc/Sprout/Generator.html +0 -643
  54. data/rdoc/Sprout/Generator/Base.html +0 -1143
  55. data/rdoc/Sprout/Generator/Command.html +0 -604
  56. data/rdoc/Sprout/Generator/DirectoryManifest.html +0 -561
  57. data/rdoc/Sprout/Generator/FileManifest.html +0 -545
  58. data/rdoc/Sprout/Generator/Manifest.html +0 -387
  59. data/rdoc/Sprout/Generator/TemplateManifest.html +0 -331
  60. data/rdoc/Sprout/GeneratorGenerator.html +0 -358
  61. data/rdoc/Sprout/Library.html +0 -646
  62. data/rdoc/Sprout/LibraryGenerator.html +0 -368
  63. data/rdoc/Sprout/Log.html +0 -281
  64. data/rdoc/Sprout/Platform.html +0 -610
  65. data/rdoc/Sprout/ProcessRunner.html +0 -1145
  66. data/rdoc/Sprout/ProgressBar.html +0 -281
  67. data/rdoc/Sprout/ProgressBarImpl.html +0 -281
  68. data/rdoc/Sprout/ProgressBarManager.html +0 -281
  69. data/rdoc/Sprout/ProgressBarOutputStream.html +0 -281
  70. data/rdoc/Sprout/RDocParser.html +0 -702
  71. data/rdoc/Sprout/RemoteFileLoader.html +0 -537
  72. data/rdoc/Sprout/RemoteFileTarget.html +0 -741
  73. data/rdoc/Sprout/ReversedProgressBar.html +0 -281
  74. data/rdoc/Sprout/RubyFeature.html +0 -324
  75. data/rdoc/Sprout/RubyFeature/ClassMethods.html +0 -821
  76. data/rdoc/Sprout/RubyGenerator.html +0 -576
  77. data/rdoc/Sprout/Specification.html +0 -915
  78. data/rdoc/Sprout/System.html +0 -383
  79. data/rdoc/Sprout/System/BaseSystem.html +0 -1173
  80. data/rdoc/Sprout/System/JavaSystem.html +0 -284
  81. data/rdoc/Sprout/System/OSXSystem.html +0 -419
  82. data/rdoc/Sprout/System/ThreadMock.html +0 -281
  83. data/rdoc/Sprout/System/UnixSystem.html +0 -583
  84. data/rdoc/Sprout/System/VistaSystem.html +0 -367
  85. data/rdoc/Sprout/System/WinNixSystem.html +0 -417
  86. data/rdoc/Sprout/System/WinSystem.html +0 -672
  87. data/rdoc/Sprout/ToolGenerator.html +0 -376
  88. data/rdoc/Sprout/VERSION.html +0 -274
  89. data/rdoc/SproutTestCase.html +0 -279
  90. data/rdoc/String.html +0 -411
  91. data/rdoc/created.rid +0 -61
  92. data/rdoc/index.html +0 -795
  93. data/rdoc/lib/sprout/archive_unpacker_rb.html +0 -56
  94. data/rdoc/lib/sprout/base_rb.html +0 -111
  95. data/rdoc/lib/sprout/concern_rb.html +0 -52
  96. data/rdoc/lib/sprout/dir_rb.html +0 -52
  97. data/rdoc/lib/sprout/errors_rb.html +0 -52
  98. data/rdoc/lib/sprout/executable/boolean_rb.html +0 -52
  99. data/rdoc/lib/sprout/executable/collection_param_rb.html +0 -52
  100. data/rdoc/lib/sprout/executable/file_param_rb.html +0 -52
  101. data/rdoc/lib/sprout/executable/files_rb.html +0 -52
  102. data/rdoc/lib/sprout/executable/number_rb.html +0 -52
  103. data/rdoc/lib/sprout/executable/param_rb.html +0 -52
  104. data/rdoc/lib/sprout/executable/parameter_factory_rb.html +0 -52
  105. data/rdoc/lib/sprout/executable/path_rb.html +0 -52
  106. data/rdoc/lib/sprout/executable/paths_rb.html +0 -52
  107. data/rdoc/lib/sprout/executable/string_param_rb.html +0 -52
  108. data/rdoc/lib/sprout/executable/strings_rb.html +0 -52
  109. data/rdoc/lib/sprout/executable/url_rb.html +0 -52
  110. data/rdoc/lib/sprout/executable/urls_rb.html +0 -52
  111. data/rdoc/lib/sprout/executable_rb.html +0 -78
  112. data/rdoc/lib/sprout/file_target_rb.html +0 -52
  113. data/rdoc/lib/sprout/generator/base_rb.html +0 -54
  114. data/rdoc/lib/sprout/generator/command_rb.html +0 -52
  115. data/rdoc/lib/sprout/generator/directory_manifest_rb.html +0 -52
  116. data/rdoc/lib/sprout/generator/file_manifest_rb.html +0 -52
  117. data/rdoc/lib/sprout/generator/manifest_rb.html +0 -52
  118. data/rdoc/lib/sprout/generator/template_manifest_rb.html +0 -52
  119. data/rdoc/lib/sprout/generators/generator/generator_generator_rb.html +0 -52
  120. data/rdoc/lib/sprout/generators/generator/templates/generator_test_helper_rb.html +0 -64
  121. data/rdoc/lib/sprout/generators/library/library_generator_rb.html +0 -52
  122. data/rdoc/lib/sprout/generators/ruby/ruby_generator_rb.html +0 -52
  123. data/rdoc/lib/sprout/generators/ruby/templates/ruby_base_rb.html +0 -54
  124. data/rdoc/lib/sprout/generators/tool/tool_generator_rb.html +0 -52
  125. data/rdoc/lib/sprout/library_rb.html +0 -52
  126. data/rdoc/lib/sprout/log_rb.html +0 -52
  127. data/rdoc/lib/sprout/platform_rb.html +0 -52
  128. data/rdoc/lib/sprout/process_runner_rb.html +0 -58
  129. data/rdoc/lib/sprout/progress_bar_rb.html +0 -72
  130. data/rdoc/lib/sprout/rdoc_parser_rb.html +0 -54
  131. data/rdoc/lib/sprout/remote_file_loader_rb.html +0 -54
  132. data/rdoc/lib/sprout/remote_file_target_rb.html +0 -52
  133. data/rdoc/lib/sprout/ruby_feature_rb.html +0 -52
  134. data/rdoc/lib/sprout/specification_rb.html +0 -52
  135. data/rdoc/lib/sprout/string_rb.html +0 -52
  136. data/rdoc/lib/sprout/system/base_system_rb.html +0 -52
  137. data/rdoc/lib/sprout/system/java_system_rb.html +0 -52
  138. data/rdoc/lib/sprout/system/osx_system_rb.html +0 -52
  139. data/rdoc/lib/sprout/system/unix_system_rb.html +0 -52
  140. data/rdoc/lib/sprout/system/vista_system_rb.html +0 -52
  141. data/rdoc/lib/sprout/system/win_nix_system_rb.html +0 -52
  142. data/rdoc/lib/sprout/system/win_system_rb.html +0 -52
  143. data/rdoc/lib/sprout/system_rb.html +0 -66
  144. data/rdoc/lib/sprout/test/sprout_test_case_rb.html +0 -57
  145. data/rdoc/lib/sprout/version_rb.html +0 -52
  146. data/rdoc/lib/sprout_rb.html +0 -54
  147. data/rdoc/rdoc.css +0 -706
  148. data/test/unit/rdoc_parser_test.rb +0 -15
data/rdoc/Sprout/Executable/Number.html DELETED
@@ -1,284 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
-
8
- <title>Class: Sprout::Executable::Number</title>
9
-
10
- <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
11
-
12
- <script src="../../js/jquery.js" type="text/javascript"
13
- charset="utf-8"></script>
14
- <script src="../../js/thickbox-compressed.js" type="text/javascript"
15
- charset="utf-8"></script>
16
- <script src="../../js/quicksearch.js" type="text/javascript"
17
- charset="utf-8"></script>
18
- <script src="../../js/darkfish.js" type="text/javascript"
19
- charset="utf-8"></script>
20
-
21
- </head>
22
- <body class="class">
23
-
24
- <div id="metadata">
25
- <div id="home-metadata">
26
- <div id="home-section" class="section">
27
- <h3 class="section-header">
28
- <a href="../../index.html">Home</a>
29
- <a href="../../index.html#classes">Classes</a>
30
- <a href="../../index.html#methods">Methods</a>
31
- </h3>
32
- </div>
33
- </div>
34
-
35
- <div id="file-metadata">
36
- <div id="file-list-section" class="section">
37
- <h3 class="section-header">In Files</h3>
38
- <div class="section-body">
39
- <ul>
40
-
41
- <li><a href="../../lib/sprout/executable/number_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
- class="thickbox" title="lib/sprout/executable/number.rb">lib/sprout/executable/number.rb</a></li>
43
-
44
- </ul>
45
- </div>
46
- </div>
47
-
48
-
49
- </div>
50
-
51
- <div id="class-metadata">
52
-
53
- <!-- Parent Class -->
54
-
55
- <div id="parent-class-section" class="section">
56
- <h3 class="section-header">Parent</h3>
57
-
58
- <p class="link"><a href="Param.html">Sprout::Executable::Param</a></p>
59
-
60
- </div>
61
-
62
-
63
- <!-- Namespace Contents -->
64
-
65
-
66
- <!-- Method Quickref -->
67
-
68
-
69
- <!-- Included Modules -->
70
-
71
- </div>
72
-
73
- <div id="project-metadata">
74
-
75
-
76
-
77
- <div id="classindex-section" class="section project-section">
78
- <h3 class="section-header">Class Index
79
- <span class="search-toggle"><img src="../../images/find.png"
80
- height="16" width="16" alt="[+]"
81
- title="show/hide quicksearch" /></span></h3>
82
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
83
- <fieldset>
84
- <legend>Quicksearch</legend>
85
- <input type="text" name="quicksearch" value=""
86
- class="quicksearch-field" />
87
- </fieldset>
88
- </form>
89
-
90
- <ul class="link-list">
91
-
92
- <li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
93
-
94
- <li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
95
-
96
- <li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
97
-
98
- <li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
99
-
100
- <li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
101
-
102
- <li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
103
-
104
- <li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
105
-
106
- <li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
107
-
108
- <li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
109
-
110
- <li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
111
-
112
- <li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
113
-
114
- <li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
115
-
116
- <li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
117
-
118
- <li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
119
-
120
- <li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
121
-
122
- <li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
123
-
124
- <li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
125
-
126
- <li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
127
-
128
- <li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
129
-
130
- <li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
131
-
132
- <li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
133
-
134
- <li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
135
-
136
- <li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
137
-
138
- <li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
139
-
140
- <li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
141
-
142
- <li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
143
-
144
- <li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
145
-
146
- <li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
147
-
148
- <li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
149
-
150
- <li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
151
-
152
- <li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
153
-
154
- <li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
155
-
156
- <li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
157
-
158
- <li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
159
-
160
- <li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
161
-
162
- <li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
163
-
164
- <li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
165
-
166
- <li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
167
-
168
- <li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
169
-
170
- <li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
171
-
172
- <li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
173
-
174
- <li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
175
-
176
- <li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
177
-
178
- <li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
179
-
180
- <li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
181
-
182
- <li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
183
-
184
- <li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
185
-
186
- <li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
187
-
188
- <li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
189
-
190
- <li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
191
-
192
- <li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
193
-
194
- <li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
195
-
196
- <li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
197
-
198
- <li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
199
-
200
- <li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
201
-
202
- <li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
203
-
204
- <li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
205
-
206
- <li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
207
-
208
- <li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
209
-
210
- <li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
211
-
212
- <li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
213
-
214
- <li><a href="../../Sprout/System.html">Sprout::System</a></li>
215
-
216
- <li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
217
-
218
- <li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
219
-
220
- <li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
221
-
222
- <li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
223
-
224
- <li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
225
-
226
- <li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
227
-
228
- <li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
229
-
230
- <li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
231
-
232
- <li><a href="../../<.html"><</a></li>
233
-
234
- <li><a href="../../Dir.html">Dir</a></li>
235
-
236
- <li><a href="../../Object.html">Object</a></li>
237
-
238
- <li><a href="../../String.html">String</a></li>
239
-
240
- </ul>
241
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
242
- </div>
243
-
244
-
245
- </div>
246
- </div>
247
-
248
- <div id="documentation">
249
- <h1 class="class">Sprout::Executable::Number</h1>
250
-
251
- <div id="description">
252
- <p>
253
- Concrete param object for numberic values
254
- </p>
255
-
256
- </div>
257
-
258
- <!-- Constants -->
259
-
260
-
261
- <!-- Attributes -->
262
-
263
-
264
- <!-- Methods -->
265
-
266
-
267
- </div>
268
-
269
-
270
- <div id="rdoc-debugging-section-dump" class="debugging-section">
271
-
272
- <p>Disabled; run with --debug to generate this.</p>
273
-
274
- </div>
275
-
276
- <div id="validator-badges">
277
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
278
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
279
- Rdoc Generator</a> 1.1.6</small>.</p>
280
- </div>
281
-
282
- </body>
283
- </html>
284
-
data/rdoc/Sprout/Executable/Param.html DELETED
@@ -1,1660 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
-
8
- <title>Class: Sprout::Executable::Param</title>
9
-
10
- <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
11
-
12
- <script src="../../js/jquery.js" type="text/javascript"
13
- charset="utf-8"></script>
14
- <script src="../../js/thickbox-compressed.js" type="text/javascript"
15
- charset="utf-8"></script>
16
- <script src="../../js/quicksearch.js" type="text/javascript"
17
- charset="utf-8"></script>
18
- <script src="../../js/darkfish.js" type="text/javascript"
19
- charset="utf-8"></script>
20
-
21
- </head>
22
- <body class="class">
23
-
24
- <div id="metadata">
25
- <div id="home-metadata">
26
- <div id="home-section" class="section">
27
- <h3 class="section-header">
28
- <a href="../../index.html">Home</a>
29
- <a href="../../index.html#classes">Classes</a>
30
- <a href="../../index.html#methods">Methods</a>
31
- </h3>
32
- </div>
33
- </div>
34
-
35
- <div id="file-metadata">
36
- <div id="file-list-section" class="section">
37
- <h3 class="section-header">In Files</h3>
38
- <div class="section-body">
39
- <ul>
40
-
41
- <li><a href="../../lib/sprout/executable/param_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
- class="thickbox" title="lib/sprout/executable/param.rb">lib/sprout/executable/param.rb</a></li>
43
-
44
- </ul>
45
- </div>
46
- </div>
47
-
48
-
49
- </div>
50
-
51
- <div id="class-metadata">
52
-
53
- <!-- Parent Class -->
54
-
55
- <div id="parent-class-section" class="section">
56
- <h3 class="section-header">Parent</h3>
57
-
58
- <p class="link"><a href="../../Object.html">Object</a></p>
59
-
60
- </div>
61
-
62
-
63
- <!-- Namespace Contents -->
64
-
65
-
66
- <!-- Method Quickref -->
67
-
68
- <div id="method-list-section" class="section">
69
- <h3 class="section-header">Methods</h3>
70
- <ul class="link-list">
71
-
72
- <li><a href="#method-c-new">::new</a></li>
73
-
74
- <li><a href="#method-i-clean_path">#clean_path</a></li>
75
-
76
- <li><a href="#method-i-default">#default</a></li>
77
-
78
- <li><a href="#method-i-default%3D">#default=</a></li>
79
-
80
- <li><a href="#method-i-file_expression">#file_expression</a></li>
81
-
82
- <li><a href="#method-i-file_is_output%3F">#file_is_output?</a></li>
83
-
84
- <li><a href="#method-i-hidden_name%3F">#hidden_name?</a></li>
85
-
86
- <li><a href="#method-i-hidden_value%3F">#hidden_value?</a></li>
87
-
88
- <li><a href="#method-i-option_parser_declaration">#option_parser_declaration</a></li>
89
-
90
- <li><a href="#method-i-option_parser_name">#option_parser_name</a></li>
91
-
92
- <li><a href="#method-i-option_parser_short_name">#option_parser_short_name</a></li>
93
-
94
- <li><a href="#method-i-option_parser_type_name">#option_parser_type_name</a></li>
95
-
96
- <li><a href="#method-i-option_parser_type_output">#option_parser_type_output</a></li>
97
-
98
- <li><a href="#method-i-prefix">#prefix</a></li>
99
-
100
- <li><a href="#method-i-prepare">#prepare</a></li>
101
-
102
- <li><a href="#method-i-prepare_prerequisites">#prepare_prerequisites</a></li>
103
-
104
- <li><a href="#method-i-prepared%3F">#prepared?</a></li>
105
-
106
- <li><a href="#method-i-required%3F">#required?</a></li>
107
-
108
- <li><a href="#method-i-shell_name">#shell_name</a></li>
109
-
110
- <li><a href="#method-i-shell_value">#shell_value</a></li>
111
-
112
- <li><a href="#method-i-short_name">#short_name</a></li>
113
-
114
- <li><a href="#method-i-short_prefix">#short_prefix</a></li>
115
-
116
- <li><a href="#method-i-to_rdoc">#to_rdoc</a></li>
117
-
118
- <li><a href="#method-i-to_shell">#to_shell</a></li>
119
-
120
- <li><a href="#method-i-validate">#validate</a></li>
121
-
122
- <li><a href="#method-i-visible%3F">#visible?</a></li>
123
-
124
- </ul>
125
- </div>
126
-
127
-
128
- <!-- Included Modules -->
129
-
130
- </div>
131
-
132
- <div id="project-metadata">
133
-
134
-
135
-
136
- <div id="classindex-section" class="section project-section">
137
- <h3 class="section-header">Class Index
138
- <span class="search-toggle"><img src="../../images/find.png"
139
- height="16" width="16" alt="[+]"
140
- title="show/hide quicksearch" /></span></h3>
141
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
142
- <fieldset>
143
- <legend>Quicksearch</legend>
144
- <input type="text" name="quicksearch" value=""
145
- class="quicksearch-field" />
146
- </fieldset>
147
- </form>
148
-
149
- <ul class="link-list">
150
-
151
- <li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
152
-
153
- <li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
154
-
155
- <li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
156
-
157
- <li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
158
-
159
- <li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
160
-
161
- <li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
162
-
163
- <li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
164
-
165
- <li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
166
-
167
- <li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
168
-
169
- <li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
170
-
171
- <li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
172
-
173
- <li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
174
-
175
- <li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
176
-
177
- <li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
178
-
179
- <li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
180
-
181
- <li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
182
-
183
- <li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
184
-
185
- <li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
186
-
187
- <li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
188
-
189
- <li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
190
-
191
- <li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
192
-
193
- <li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
194
-
195
- <li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
196
-
197
- <li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
198
-
199
- <li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
200
-
201
- <li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
202
-
203
- <li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
204
-
205
- <li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
206
-
207
- <li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
208
-
209
- <li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
210
-
211
- <li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
212
-
213
- <li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
214
-
215
- <li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
216
-
217
- <li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
218
-
219
- <li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
220
-
221
- <li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
222
-
223
- <li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
224
-
225
- <li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
226
-
227
- <li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
228
-
229
- <li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
230
-
231
- <li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
232
-
233
- <li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
234
-
235
- <li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
236
-
237
- <li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
238
-
239
- <li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
240
-
241
- <li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
242
-
243
- <li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
244
-
245
- <li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
246
-
247
- <li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
248
-
249
- <li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
250
-
251
- <li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
252
-
253
- <li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
254
-
255
- <li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
256
-
257
- <li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
258
-
259
- <li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
260
-
261
- <li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
262
-
263
- <li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
264
-
265
- <li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
266
-
267
- <li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
268
-
269
- <li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
270
-
271
- <li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
272
-
273
- <li><a href="../../Sprout/System.html">Sprout::System</a></li>
274
-
275
- <li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
276
-
277
- <li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
278
-
279
- <li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
280
-
281
- <li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
282
-
283
- <li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
284
-
285
- <li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
286
-
287
- <li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
288
-
289
- <li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
290
-
291
- <li><a href="../../<.html"><</a></li>
292
-
293
- <li><a href="../../Dir.html">Dir</a></li>
294
-
295
- <li><a href="../../Object.html">Object</a></li>
296
-
297
- <li><a href="../../String.html">String</a></li>
298
-
299
- </ul>
300
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
301
- </div>
302
-
303
-
304
- </div>
305
- </div>
306
-
307
- <div id="documentation">
308
- <h1 class="class">Sprout::Executable::Param</h1>
309
-
310
- <div id="description">
311
- <p>
312
- The abstract base class for all <a href="../Executable.html">Executable</a>
313
- parameters.
314
- </p>
315
-
316
- </div>
317
-
318
- <!-- Constants -->
319
-
320
- <div id="constants-list" class="section">
321
- <h3 class="section-header">Constants</h3>
322
- <dl>
323
-
324
- <dt><a name="DEFAULT_DELIMITER">DEFAULT_DELIMITER</a></dt>
325
-
326
- <dd class="description"></dd>
327
-
328
-
329
- <dt><a name="DEFAULT_OPTION_PARSER_TYPE_NAME">DEFAULT_OPTION_PARSER_TYPE_NAME</a></dt>
330
-
331
- <dd class="description"></dd>
332
-
333
-
334
- <dt><a name="DEFAULT_PREFIX">DEFAULT_PREFIX</a></dt>
335
-
336
- <dd class="description"><p>
337
- These values should usually be pulled from the &#8216;<a
338
- href="Param.html#belongs_to">belongs_to</a>&#8217; executable:
339
- </p></dd>
340
-
341
-
342
- <dt><a name="DEFAULT_SHORT_PREFIX">DEFAULT_SHORT_PREFIX</a></dt>
343
-
344
- <dd class="description"></dd>
345
-
346
-
347
- </dl>
348
- </div>
349
-
350
-
351
- <!-- Attributes -->
352
-
353
- <div id="attribute-method-details" class="method-section section">
354
- <h3 class="section-header">Attributes</h3>
355
-
356
-
357
- <div id="belongs-to-attribute-method" class="method-detail">
358
- <a name="belongs_to"></a>
359
-
360
- <a name="belongs_to="></a>
361
-
362
- <div class="method-heading attribute-method-heading">
363
- <span class="method-name">belongs_to</span><span
364
- class="attribute-access-type">[RW]</span>
365
- </div>
366
-
367
- <div class="method-description">
368
-
369
-
370
-
371
- </div>
372
- </div>
373
-
374
- <div id="description-attribute-method" class="method-detail">
375
- <a name="description"></a>
376
-
377
- <a name="description="></a>
378
-
379
- <div class="method-heading attribute-method-heading">
380
- <span class="method-name">description</span><span
381
- class="attribute-access-type">[RW]</span>
382
- </div>
383
-
384
- <div class="method-description">
385
-
386
-
387
-
388
- </div>
389
- </div>
390
-
391
- <div id="hidden-name-attribute-method" class="method-detail">
392
- <a name="hidden_name"></a>
393
-
394
- <a name="hidden_name="></a>
395
-
396
- <div class="method-heading attribute-method-heading">
397
- <span class="method-name">hidden_name</span><span
398
- class="attribute-access-type">[RW]</span>
399
- </div>
400
-
401
- <div class="method-description">
402
-
403
-
404
-
405
- </div>
406
- </div>
407
-
408
- <div id="hidden-value-attribute-method" class="method-detail">
409
- <a name="hidden_value"></a>
410
-
411
- <a name="hidden_value="></a>
412
-
413
- <div class="method-heading attribute-method-heading">
414
- <span class="method-name">hidden_value</span><span
415
- class="attribute-access-type">[RW]</span>
416
- </div>
417
-
418
- <div class="method-description">
419
-
420
-
421
-
422
- </div>
423
- </div>
424
-
425
- <div id="file-task-name-attribute-method" class="method-detail">
426
- <a name="file_task_name"></a>
427
-
428
- <a name="file_task_name="></a>
429
-
430
- <div class="method-heading attribute-method-heading">
431
- <span class="method-name">file_task_name</span><span
432
- class="attribute-access-type">[RW]</span>
433
- </div>
434
-
435
- <div class="method-description">
436
-
437
-
438
-
439
- </div>
440
- </div>
441
-
442
- <div id="name-attribute-method" class="method-detail">
443
- <a name="name"></a>
444
-
445
- <a name="name="></a>
446
-
447
- <div class="method-heading attribute-method-heading">
448
- <span class="method-name">name</span><span
449
- class="attribute-access-type">[RW]</span>
450
- </div>
451
-
452
- <div class="method-description">
453
-
454
-
455
-
456
- </div>
457
- </div>
458
-
459
- <div id="prefix-attribute-method" class="method-detail">
460
- <a name="prefix"></a>
461
-
462
- <a name="prefix="></a>
463
-
464
- <div class="method-heading attribute-method-heading">
465
- <span class="method-name">prefix</span><span
466
- class="attribute-access-type">[RW]</span>
467
- </div>
468
-
469
- <div class="method-description">
470
-
471
-
472
-
473
- </div>
474
- </div>
475
-
476
- <div id="reader-attribute-method" class="method-detail">
477
- <a name="reader"></a>
478
-
479
- <a name="reader="></a>
480
-
481
- <div class="method-heading attribute-method-heading">
482
- <span class="method-name">reader</span><span
483
- class="attribute-access-type">[RW]</span>
484
- </div>
485
-
486
- <div class="method-description">
487
-
488
-
489
-
490
- </div>
491
- </div>
492
-
493
- <div id="required-attribute-method" class="method-detail">
494
- <a name="required"></a>
495
-
496
- <a name="required="></a>
497
-
498
- <div class="method-heading attribute-method-heading">
499
- <span class="method-name">required</span><span
500
- class="attribute-access-type">[RW]</span>
501
- </div>
502
-
503
- <div class="method-description">
504
-
505
-
506
-
507
- </div>
508
- </div>
509
-
510
- <div id="to-shell-proc-attribute-method" class="method-detail">
511
- <a name="to_shell_proc"></a>
512
-
513
- <a name="to_shell_proc="></a>
514
-
515
- <div class="method-heading attribute-method-heading">
516
- <span class="method-name">to_shell_proc</span><span
517
- class="attribute-access-type">[RW]</span>
518
- </div>
519
-
520
- <div class="method-description">
521
-
522
-
523
-
524
- </div>
525
- </div>
526
-
527
- <div id="type-attribute-method" class="method-detail">
528
- <a name="type"></a>
529
-
530
- <a name="type="></a>
531
-
532
- <div class="method-heading attribute-method-heading">
533
- <span class="method-name">type</span><span
534
- class="attribute-access-type">[RW]</span>
535
- </div>
536
-
537
- <div class="method-description">
538
-
539
-
540
-
541
- </div>
542
- </div>
543
-
544
- <div id="validator-attribute-method" class="method-detail">
545
- <a name="validator"></a>
546
-
547
- <a name="validator="></a>
548
-
549
- <div class="method-heading attribute-method-heading">
550
- <span class="method-name">validator</span><span
551
- class="attribute-access-type">[RW]</span>
552
- </div>
553
-
554
- <div class="method-description">
555
-
556
-
557
-
558
- </div>
559
- </div>
560
-
561
- <div id="value-attribute-method" class="method-detail">
562
- <a name="value"></a>
563
-
564
- <a name="value="></a>
565
-
566
- <div class="method-heading attribute-method-heading">
567
- <span class="method-name">value</span><span
568
- class="attribute-access-type">[RW]</span>
569
- </div>
570
-
571
- <div class="method-description">
572
-
573
-
574
-
575
- </div>
576
- </div>
577
-
578
- <div id="visible-attribute-method" class="method-detail">
579
- <a name="visible"></a>
580
-
581
- <a name="visible="></a>
582
-
583
- <div class="method-heading attribute-method-heading">
584
- <span class="method-name">visible</span><span
585
- class="attribute-access-type">[RW]</span>
586
- </div>
587
-
588
- <div class="method-description">
589
-
590
-
591
-
592
- </div>
593
- </div>
594
-
595
- <div id="writer-attribute-method" class="method-detail">
596
- <a name="writer"></a>
597
-
598
- <a name="writer="></a>
599
-
600
- <div class="method-heading attribute-method-heading">
601
- <span class="method-name">writer</span><span
602
- class="attribute-access-type">[RW]</span>
603
- </div>
604
-
605
- <div class="method-description">
606
-
607
-
608
-
609
- </div>
610
- </div>
611
-
612
- <div id="delimiter-attribute-method" class="method-detail">
613
- <a name="delimiter"></a>
614
-
615
- <a name="delimiter="></a>
616
-
617
- <div class="method-heading attribute-method-heading">
618
- <span class="method-name">delimiter</span><span
619
- class="attribute-access-type">[RW]</span>
620
- </div>
621
-
622
- <div class="method-description">
623
-
624
- <p>
625
- Executable::Params join their name/value pair with an equals sign by
626
- default, this can be modified To a space or whatever you wish.
627
- </p>
628
-
629
- </div>
630
- </div>
631
-
632
- <div id="file-expression-attribute-method" class="method-detail">
633
- <a name="file_expression"></a>
634
-
635
- <a name="file_expression="></a>
636
-
637
- <div class="method-heading attribute-method-heading">
638
- <span class="method-name">file_expression</span><span
639
- class="attribute-access-type">[W]</span>
640
- </div>
641
-
642
- <div class="method-description">
643
-
644
- <p>
645
- Set the <a href="Param.html#method-i-file_expression">file_expression</a>
646
- (blob) to append to each path in order to build the prerequisites FileList.
647
- </p>
648
- <p>
649
- Defaults to the parent Executable.default_file_expression
650
- </p>
651
- <p>
652
- NOTE: We should add support for file_expressionS since these are really
653
- just blobs that are sent to the FileList[expr] and that interface accepts
654
- an array.
655
- </p>
656
-
657
- </div>
658
- </div>
659
-
660
- <div id="shell-name-attribute-method" class="method-detail">
661
- <a name="shell_name"></a>
662
-
663
- <a name="shell_name="></a>
664
-
665
- <div class="method-heading attribute-method-heading">
666
- <span class="method-name">shell_name</span><span
667
- class="attribute-access-type">[W]</span>
668
- </div>
669
-
670
- <div class="method-description">
671
-
672
- <p>
673
- Return the name with a single leading dash and underscores replaced with
674
- dashes
675
- </p>
676
-
677
- </div>
678
- </div>
679
-
680
- </div>
681
-
682
-
683
- <!-- Methods -->
684
-
685
- <div id="public-class-method-details" class="method-section section">
686
- <h3 class="section-header">Public Class Methods</h3>
687
-
688
-
689
- <div id="new-method" class="method-detail ">
690
- <a name="method-c-new"></a>
691
-
692
- <div class="method-heading">
693
-
694
- <span class="method-name">new</span><span
695
- class="method-args">()</span>
696
- <span class="method-click-advice">click to toggle source</span>
697
-
698
- </div>
699
-
700
- <div class="method-description">
701
-
702
-
703
-
704
-
705
-
706
- <div class="method-source-code"
707
- id="new-source">
708
- <pre>
709
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 57</span>
710
- 57: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
711
- 58: <span class="ruby-ivar">@description</span> = <span class="ruby-value str">'Default Description'</span>
712
- 59: <span class="ruby-ivar">@hidden_value</span> = <span class="ruby-keyword kw">false</span>
713
- 60: <span class="ruby-ivar">@hidden_name</span> = <span class="ruby-keyword kw">false</span>
714
- 61: <span class="ruby-ivar">@delimiter</span> = <span class="ruby-constant">DEFAULT_DELIMITER</span>
715
- 62: <span class="ruby-ivar">@option_parser_type_name</span> = <span class="ruby-constant">DEFAULT_OPTION_PARSER_TYPE_NAME</span>
716
- 63: <span class="ruby-keyword kw">end</span></pre>
717
- </div>
718
-
719
- </div>
720
-
721
-
722
-
723
-
724
- </div>
725
-
726
-
727
- </div>
728
-
729
- <div id="public-instance-method-details" class="method-section section">
730
- <h3 class="section-header">Public Instance Methods</h3>
731
-
732
-
733
- <div id="default-method" class="method-detail ">
734
- <a name="method-i-default"></a>
735
-
736
- <div class="method-heading">
737
-
738
- <span class="method-name">default</span><span
739
- class="method-args">()</span>
740
- <span class="method-click-advice">click to toggle source</span>
741
-
742
- </div>
743
-
744
- <div class="method-description">
745
-
746
-
747
-
748
-
749
-
750
- <div class="method-source-code"
751
- id="default-source">
752
- <pre>
753
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 94</span>
754
- 94: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">default</span>
755
- 95: <span class="ruby-ivar">@default</span>
756
- 96: <span class="ruby-keyword kw">end</span></pre>
757
- </div>
758
-
759
- </div>
760
-
761
-
762
-
763
-
764
- </div>
765
-
766
-
767
- <div id="default--method" class="method-detail ">
768
- <a name="method-i-default%3D"></a>
769
-
770
- <div class="method-heading">
771
-
772
- <span class="method-name">default=</span><span
773
- class="method-args">(value)</span>
774
- <span class="method-click-advice">click to toggle source</span>
775
-
776
- </div>
777
-
778
- <div class="method-description">
779
-
780
- <p>
781
- Set the default value of the parameter.
782
- </p>
783
-
784
-
785
-
786
- <div class="method-source-code"
787
- id="default--source">
788
- <pre>
789
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 89</span>
790
- 89: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">default=</span>(<span class="ruby-identifier">value</span>)
791
- 90: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>
792
- 91: <span class="ruby-ivar">@default</span> = <span class="ruby-identifier">value</span>
793
- 92: <span class="ruby-keyword kw">end</span></pre>
794
- </div>
795
-
796
- </div>
797
-
798
-
799
-
800
-
801
- </div>
802
-
803
-
804
- <div id="file-expression-method" class="method-detail ">
805
- <a name="method-i-file_expression"></a>
806
-
807
- <div class="method-heading">
808
-
809
- <span class="method-name">file_expression</span><span
810
- class="method-args">()</span>
811
- <span class="method-click-advice">click to toggle source</span>
812
-
813
- </div>
814
-
815
- <div class="method-description">
816
-
817
-
818
-
819
-
820
-
821
- <div class="method-source-code"
822
- id="file-expression-source">
823
- <pre>
824
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 163</span>
825
- 163: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file_expression</span>
826
- 164: <span class="ruby-ivar">@file_expression</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">default_file_expression</span>
827
- 165: <span class="ruby-keyword kw">end</span></pre>
828
- </div>
829
-
830
- </div>
831
-
832
-
833
-
834
-
835
- </div>
836
-
837
-
838
- <div id="hidden-name--method" class="method-detail ">
839
- <a name="method-i-hidden_name%3F"></a>
840
-
841
- <div class="method-heading">
842
-
843
- <span class="method-name">hidden_name?</span><span
844
- class="method-args">()</span>
845
- <span class="method-click-advice">click to toggle source</span>
846
-
847
- </div>
848
-
849
- <div class="method-description">
850
-
851
- <p>
852
- Should the param name be hidden from the shell? Used for params like
853
- &#8216;input&#8217; on mxmlc
854
- </p>
855
-
856
-
857
-
858
- <div class="method-source-code"
859
- id="hidden-name--source">
860
- <pre>
861
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 115</span>
862
- 115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hidden_name?</span>
863
- 116: <span class="ruby-ivar">@hidden_name</span>
864
- 117: <span class="ruby-keyword kw">end</span></pre>
865
- </div>
866
-
867
- </div>
868
-
869
-
870
-
871
-
872
- </div>
873
-
874
-
875
- <div id="hidden-value--method" class="method-detail ">
876
- <a name="method-i-hidden_value%3F"></a>
877
-
878
- <div class="method-heading">
879
-
880
- <span class="method-name">hidden_value?</span><span
881
- class="method-args">()</span>
882
- <span class="method-click-advice">click to toggle source</span>
883
-
884
- </div>
885
-
886
- <div class="method-description">
887
-
888
- <p>
889
- Should the param value be hidden from the shell? Usually used for <a
890
- href="Boolean.html">Boolean</a> toggles like &#8217;-debug&#8217;
891
- </p>
892
-
893
-
894
-
895
- <div class="method-source-code"
896
- id="hidden-value--source">
897
- <pre>
898
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 122</span>
899
- 122: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hidden_value?</span>
900
- 123: <span class="ruby-ivar">@hidden_value</span>
901
- 124: <span class="ruby-keyword kw">end</span></pre>
902
- </div>
903
-
904
- </div>
905
-
906
-
907
-
908
-
909
- </div>
910
-
911
-
912
- <div id="option-parser-declaration-method" class="method-detail ">
913
- <a name="method-i-option_parser_declaration"></a>
914
-
915
- <div class="method-heading">
916
-
917
- <span class="method-name">option_parser_declaration</span><span
918
- class="method-args">()</span>
919
- <span class="method-click-advice">click to toggle source</span>
920
-
921
- </div>
922
-
923
- <div class="method-description">
924
-
925
-
926
-
927
-
928
-
929
- <div class="method-source-code"
930
- id="option-parser-declaration-source">
931
- <pre>
932
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 139</span>
933
- 139: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option_parser_declaration</span>
934
- 140: <span class="ruby-identifier">declaration</span> = [ <span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">option_parser_name</span> ]
935
- 141: <span class="ruby-comment cmt"># TODO: Need to figure out how to support hidden name inputs...</span>
936
- 142: <span class="ruby-comment cmt">#if(hidden_name?)</span>
937
- 143: <span class="ruby-comment cmt">#declaration = [option_parser_type_output]</span>
938
- 144: <span class="ruby-comment cmt">#</span>
939
- 145: <span class="ruby-keyword kw">if</span>(<span class="ruby-operator">!</span><span class="ruby-identifier">hidden_value?</span>)
940
- 146: <span class="ruby-identifier">declaration</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">delimiter</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">option_parser_type_output</span>
941
- 147: <span class="ruby-keyword kw">end</span>
942
- 148: <span class="ruby-identifier">declaration</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>)
943
- 149: <span class="ruby-keyword kw">end</span></pre>
944
- </div>
945
-
946
- </div>
947
-
948
-
949
-
950
-
951
- </div>
952
-
953
-
954
- <div id="option-parser-short-name-method" class="method-detail ">
955
- <a name="method-i-option_parser_short_name"></a>
956
-
957
- <div class="method-heading">
958
-
959
- <span class="method-name">option_parser_short_name</span><span
960
- class="method-args">()</span>
961
- <span class="method-click-advice">click to toggle source</span>
962
-
963
- </div>
964
-
965
- <div class="method-description">
966
-
967
-
968
-
969
-
970
-
971
- <div class="method-source-code"
972
- id="option-parser-short-name-source">
973
- <pre>
974
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 151</span>
975
- 151: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option_parser_short_name</span>
976
- 152: [ <span class="ruby-identifier">short_prefix</span>, <span class="ruby-identifier">short_name</span> ].<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>)
977
- 153: <span class="ruby-keyword kw">end</span></pre>
978
- </div>
979
-
980
- </div>
981
-
982
-
983
-
984
-
985
- </div>
986
-
987
-
988
- <div id="prefix-method" class="method-detail ">
989
- <a name="method-i-prefix"></a>
990
-
991
- <div class="method-heading">
992
-
993
- <span class="method-name">prefix</span><span
994
- class="method-args">()</span>
995
- <span class="method-click-advice">click to toggle source</span>
996
-
997
- </div>
998
-
999
- <div class="method-description">
1000
-
1001
- <p>
1002
- Leading character for each parameter Can sometimes be an empty string,
1003
- other times it&#8217;s a double dash &#8217;&#8212;&#8217; but usually
1004
- it&#8217;s just a single dash &#8217;-&#8217;
1005
- </p>
1006
-
1007
-
1008
-
1009
- <div class="method-source-code"
1010
- id="prefix-source">
1011
- <pre>
1012
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 131</span>
1013
- 131: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prefix</span>
1014
- 132: <span class="ruby-ivar">@prefix</span> <span class="ruby-operator">||=</span> (<span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">DEFAULT_PREFIX</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">default_prefix</span>
1015
- 133: <span class="ruby-keyword kw">end</span></pre>
1016
- </div>
1017
-
1018
- </div>
1019
-
1020
-
1021
-
1022
-
1023
- </div>
1024
-
1025
-
1026
- <div id="prepare-method" class="method-detail ">
1027
- <a name="method-i-prepare"></a>
1028
-
1029
- <div class="method-heading">
1030
-
1031
- <span class="method-name">prepare</span><span
1032
- class="method-args">()</span>
1033
- <span class="method-click-advice">click to toggle source</span>
1034
-
1035
- </div>
1036
-
1037
- <div class="method-description">
1038
-
1039
- <p>
1040
- Prepare the parameter for execution or delegation, depending on what
1041
- context we&#8217;re in.
1042
- </p>
1043
-
1044
-
1045
-
1046
- <div class="method-source-code"
1047
- id="prepare-source">
1048
- <pre>
1049
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 101</span>
1050
- 101: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare</span>
1051
- 102: <span class="ruby-identifier">prepare_prerequisites</span>
1052
- 103: <span class="ruby-ivar">@prepared</span> = <span class="ruby-keyword kw">true</span>
1053
- 104: <span class="ruby-keyword kw">end</span></pre>
1054
- </div>
1055
-
1056
- </div>
1057
-
1058
-
1059
-
1060
-
1061
- </div>
1062
-
1063
-
1064
- <div id="prepared--method" class="method-detail ">
1065
- <a name="method-i-prepared%3F"></a>
1066
-
1067
- <div class="method-heading">
1068
-
1069
- <span class="method-name">prepared?</span><span
1070
- class="method-args">()</span>
1071
- <span class="method-click-advice">click to toggle source</span>
1072
-
1073
- </div>
1074
-
1075
- <div class="method-description">
1076
-
1077
- <p>
1078
- Returns true if this parameter has already been prepared.
1079
- </p>
1080
-
1081
-
1082
-
1083
- <div class="method-source-code"
1084
- id="prepared--source">
1085
- <pre>
1086
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 108</span>
1087
- 108: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepared?</span>
1088
- 109: <span class="ruby-ivar">@prepared</span>
1089
- 110: <span class="ruby-keyword kw">end</span></pre>
1090
- </div>
1091
-
1092
- </div>
1093
-
1094
-
1095
-
1096
-
1097
- </div>
1098
-
1099
-
1100
- <div id="required--method" class="method-detail ">
1101
- <a name="method-i-required%3F"></a>
1102
-
1103
- <div class="method-heading">
1104
-
1105
- <span class="method-name">required?</span><span
1106
- class="method-args">()</span>
1107
- <span class="method-click-advice">click to toggle source</span>
1108
-
1109
- </div>
1110
-
1111
- <div class="method-description">
1112
-
1113
- <p>
1114
- Raise an exception if a required parameter is nil.
1115
- </p>
1116
-
1117
-
1118
-
1119
- <div class="method-source-code"
1120
- id="required--source">
1121
- <pre>
1122
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 74</span>
1123
- 74: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">required?</span>
1124
- 75: (<span class="ruby-identifier">required</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">true</span>)
1125
- 76: <span class="ruby-keyword kw">end</span></pre>
1126
- </div>
1127
-
1128
- </div>
1129
-
1130
-
1131
-
1132
-
1133
- </div>
1134
-
1135
-
1136
- <div id="shell-name-method" class="method-detail ">
1137
- <a name="method-i-shell_name"></a>
1138
-
1139
- <div class="method-heading">
1140
-
1141
- <span class="method-name">shell_name</span><span
1142
- class="method-args">()</span>
1143
- <span class="method-click-advice">click to toggle source</span>
1144
-
1145
- </div>
1146
-
1147
- <div class="method-description">
1148
-
1149
-
1150
-
1151
-
1152
-
1153
- <div class="method-source-code"
1154
- id="shell-name-source">
1155
- <pre>
1156
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 167</span>
1157
- 167: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shell_name</span>
1158
- 168: <span class="ruby-ivar">@shell_name</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">prefix</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'_'</span>).<span class="ruby-identifier">join</span>(<span class="ruby-value str">'-'</span>)
1159
- 169: <span class="ruby-keyword kw">end</span></pre>
1160
- </div>
1161
-
1162
- </div>
1163
-
1164
-
1165
-
1166
-
1167
- </div>
1168
-
1169
-
1170
- <div id="shell-value-method" class="method-detail ">
1171
- <a name="method-i-shell_value"></a>
1172
-
1173
- <div class="method-heading">
1174
-
1175
- <span class="method-name">shell_value</span><span
1176
- class="method-args">()</span>
1177
- <span class="method-click-advice">click to toggle source</span>
1178
-
1179
- </div>
1180
-
1181
- <div class="method-description">
1182
-
1183
-
1184
-
1185
-
1186
-
1187
- <div class="method-source-code"
1188
- id="shell-value-source">
1189
- <pre>
1190
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 159</span>
1191
- 159: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shell_value</span>
1192
- 160: <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
1193
- 161: <span class="ruby-keyword kw">end</span></pre>
1194
- </div>
1195
-
1196
- </div>
1197
-
1198
-
1199
-
1200
-
1201
- </div>
1202
-
1203
-
1204
- <div id="short-name-method" class="method-detail ">
1205
- <a name="method-i-short_name"></a>
1206
-
1207
- <div class="method-heading">
1208
-
1209
- <span class="method-name">short_name</span><span
1210
- class="method-args">()</span>
1211
- <span class="method-click-advice">click to toggle source</span>
1212
-
1213
- </div>
1214
-
1215
- <div class="method-description">
1216
-
1217
-
1218
-
1219
-
1220
-
1221
- <div class="method-source-code"
1222
- id="short-name-source">
1223
- <pre>
1224
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 155</span>
1225
- 155: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">short_name</span>
1226
- 156: <span class="ruby-ivar">@short_name</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">''</span>).<span class="ruby-identifier">shift</span>
1227
- 157: <span class="ruby-keyword kw">end</span></pre>
1228
- </div>
1229
-
1230
- </div>
1231
-
1232
-
1233
-
1234
-
1235
- </div>
1236
-
1237
-
1238
- <div id="short-prefix-method" class="method-detail ">
1239
- <a name="method-i-short_prefix"></a>
1240
-
1241
- <div class="method-heading">
1242
-
1243
- <span class="method-name">short_prefix</span><span
1244
- class="method-args">()</span>
1245
- <span class="method-click-advice">click to toggle source</span>
1246
-
1247
- </div>
1248
-
1249
- <div class="method-description">
1250
-
1251
-
1252
-
1253
-
1254
-
1255
- <div class="method-source-code"
1256
- id="short-prefix-source">
1257
- <pre>
1258
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 135</span>
1259
- 135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">short_prefix</span>
1260
- 136: <span class="ruby-ivar">@short_prefix</span> <span class="ruby-operator">||=</span> (<span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">DEFAULT_SHORT_PREFIX</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">default_short_prefix</span>
1261
- 137: <span class="ruby-keyword kw">end</span></pre>
1262
- </div>
1263
-
1264
- </div>
1265
-
1266
-
1267
-
1268
-
1269
- </div>
1270
-
1271
-
1272
- <div id="to-rdoc-method" class="method-detail ">
1273
- <a name="method-i-to_rdoc"></a>
1274
-
1275
- <div class="method-heading">
1276
-
1277
- <span class="method-name">to_rdoc</span><span
1278
- class="method-args">()</span>
1279
- <span class="method-click-advice">click to toggle source</span>
1280
-
1281
- </div>
1282
-
1283
- <div class="method-description">
1284
-
1285
- <p>
1286
- Create a string that can be turned into a file that rdoc can parse to
1287
- describe the customized or generated task using param name, type and
1288
- description
1289
- </p>
1290
-
1291
-
1292
-
1293
- <div class="method-source-code"
1294
- id="to-rdoc-source">
1295
- <pre>
1296
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 185</span>
1297
- 185: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_rdoc</span>
1298
- 186: <span class="ruby-identifier">result</span> = <span class="ruby-value str">''</span>
1299
- 187: <span class="ruby-identifier">parts</span> = <span class="ruby-identifier">description</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;\n&quot;</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">description</span>.<span class="ruby-identifier">nil?</span>
1300
- 188: <span class="ruby-identifier">result</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;# #{parts.join(&quot;\n# &quot;)}\n&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">description</span>.<span class="ruby-identifier">nil?</span>
1301
- 189: <span class="ruby-identifier">result</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;def #{name}=(#{type})\n @#{name} = #{type}\nend\n\n&quot;</span>
1302
- 190: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>
1303
- 191: <span class="ruby-keyword kw">end</span></pre>
1304
- </div>
1305
-
1306
- </div>
1307
-
1308
-
1309
-
1310
-
1311
- </div>
1312
-
1313
-
1314
- <div id="to-shell-method" class="method-detail ">
1315
- <a name="method-i-to_shell"></a>
1316
-
1317
- <div class="method-heading">
1318
-
1319
- <span class="method-name">to_shell</span><span
1320
- class="method-args">()</span>
1321
- <span class="method-click-advice">click to toggle source</span>
1322
-
1323
- </div>
1324
-
1325
- <div class="method-description">
1326
-
1327
-
1328
-
1329
-
1330
-
1331
- <div class="method-source-code"
1332
- id="to-shell-source">
1333
- <pre>
1334
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 171</span>
1335
- 171: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_shell</span>
1336
- 172: <span class="ruby-identifier">prepare</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">prepared?</span>
1337
- 173: <span class="ruby-identifier">validate</span>
1338
- 174: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">visible?</span>
1339
- 175: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@to_shell_proc</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@to_shell_proc</span>.<span class="ruby-identifier">nil?</span>
1340
- 176: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">shell_value</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">hidden_name?</span>
1341
- 177: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">shell_name</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">hidden_value?</span>
1342
- 178: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">shell_name</span>, <span class="ruby-identifier">delimiter</span>, <span class="ruby-identifier">shell_value</span>].<span class="ruby-identifier">join</span>
1343
- 179: <span class="ruby-keyword kw">end</span></pre>
1344
- </div>
1345
-
1346
- </div>
1347
-
1348
-
1349
-
1350
-
1351
- </div>
1352
-
1353
-
1354
- <div id="validate-method" class="method-detail ">
1355
- <a name="method-i-validate"></a>
1356
-
1357
- <div class="method-heading">
1358
-
1359
- <span class="method-name">validate</span><span
1360
- class="method-args">()</span>
1361
- <span class="method-click-advice">click to toggle source</span>
1362
-
1363
- </div>
1364
-
1365
- <div class="method-description">
1366
-
1367
- <p>
1368
- Ensure this parameter is in a valid state, raise an appropriate exception
1369
- if it is not.
1370
- </p>
1371
-
1372
-
1373
-
1374
- <div class="method-source-code"
1375
- id="validate-source">
1376
- <pre>
1377
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 81</span>
1378
- 81: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>
1379
- 82: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">required?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>)
1380
- 83: <span class="ruby-identifier">raise</span> <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">MissingArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;#{name} is required and must not be nil&quot;</span>)
1381
- 84: <span class="ruby-keyword kw">end</span>
1382
- 85: <span class="ruby-keyword kw">end</span></pre>
1383
- </div>
1384
-
1385
- </div>
1386
-
1387
-
1388
-
1389
-
1390
- </div>
1391
-
1392
-
1393
- <div id="visible--method" class="method-detail ">
1394
- <a name="method-i-visible%3F"></a>
1395
-
1396
- <div class="method-heading">
1397
-
1398
- <span class="method-name">visible?</span><span
1399
- class="method-args">()</span>
1400
- <span class="method-click-advice">click to toggle source</span>
1401
-
1402
- </div>
1403
-
1404
- <div class="method-description">
1405
-
1406
- <p>
1407
- By default, Executable::Params only appear in the shell output when they
1408
- are not nil
1409
- </p>
1410
-
1411
-
1412
-
1413
- <div class="method-source-code"
1414
- id="visible--source">
1415
- <pre>
1416
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 68</span>
1417
- 68: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">visible?</span>
1418
- 69: <span class="ruby-operator">!</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
1419
- 70: <span class="ruby-keyword kw">end</span></pre>
1420
- </div>
1421
-
1422
- </div>
1423
-
1424
-
1425
-
1426
-
1427
- </div>
1428
-
1429
-
1430
- </div>
1431
-
1432
- <div id="protected-instance-method-details" class="method-section section">
1433
- <h3 class="section-header">Protected Instance Methods</h3>
1434
-
1435
-
1436
- <div id="clean-path-method" class="method-detail ">
1437
- <a name="method-i-clean_path"></a>
1438
-
1439
- <div class="method-heading">
1440
-
1441
- <span class="method-name">clean_path</span><span
1442
- class="method-args">(path)</span>
1443
- <span class="method-click-advice">click to toggle source</span>
1444
-
1445
- </div>
1446
-
1447
- <div class="method-description">
1448
-
1449
-
1450
-
1451
-
1452
-
1453
- <div class="method-source-code"
1454
- id="clean-path-source">
1455
- <pre>
1456
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 211</span>
1457
- 211: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clean_path</span> <span class="ruby-identifier">path</span>
1458
- 212: <span class="ruby-constant">Sprout</span><span class="ruby-operator">::</span><span class="ruby-constant">System</span>.<span class="ruby-identifier">create</span>.<span class="ruby-identifier">clean_path</span> <span class="ruby-identifier">path</span>
1459
- 213: <span class="ruby-keyword kw">end</span></pre>
1460
- </div>
1461
-
1462
- </div>
1463
-
1464
-
1465
-
1466
-
1467
- </div>
1468
-
1469
-
1470
- <div id="file-is-output--method" class="method-detail ">
1471
- <a name="method-i-file_is_output%3F"></a>
1472
-
1473
- <div class="method-heading">
1474
-
1475
- <span class="method-name">file_is_output?</span><span
1476
- class="method-args">(file)</span>
1477
- <span class="method-click-advice">click to toggle source</span>
1478
-
1479
- </div>
1480
-
1481
- <div class="method-description">
1482
-
1483
-
1484
-
1485
-
1486
-
1487
- <div class="method-source-code"
1488
- id="file-is-output--source">
1489
- <pre>
1490
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 215</span>
1491
- 215: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file_is_output?</span> <span class="ruby-identifier">file</span>
1492
- 216: <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:output</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">output</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">file</span>
1493
- 217: <span class="ruby-keyword kw">end</span></pre>
1494
- </div>
1495
-
1496
- </div>
1497
-
1498
-
1499
-
1500
-
1501
- </div>
1502
-
1503
-
1504
- <div id="option-parser-name-method" class="method-detail ">
1505
- <a name="method-i-option_parser_name"></a>
1506
-
1507
- <div class="method-heading">
1508
-
1509
- <span class="method-name">option_parser_name</span><span
1510
- class="method-args">()</span>
1511
- <span class="method-click-advice">click to toggle source</span>
1512
-
1513
- </div>
1514
-
1515
- <div class="method-description">
1516
-
1517
-
1518
-
1519
-
1520
-
1521
- <div class="method-source-code"
1522
- id="option-parser-name-source">
1523
- <pre>
1524
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 195</span>
1525
- 195: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option_parser_name</span>
1526
- 196: <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'_'</span>, <span class="ruby-value str">'-'</span>)
1527
- 197: <span class="ruby-keyword kw">end</span></pre>
1528
- </div>
1529
-
1530
- </div>
1531
-
1532
-
1533
-
1534
-
1535
- </div>
1536
-
1537
-
1538
- <div id="option-parser-type-name-method" class="method-detail ">
1539
- <a name="method-i-option_parser_type_name"></a>
1540
-
1541
- <div class="method-heading">
1542
-
1543
- <span class="method-name">option_parser_type_name</span><span
1544
- class="method-args">()</span>
1545
- <span class="method-click-advice">click to toggle source</span>
1546
-
1547
- </div>
1548
-
1549
- <div class="method-description">
1550
-
1551
-
1552
-
1553
-
1554
-
1555
- <div class="method-source-code"
1556
- id="option-parser-type-name-source">
1557
- <pre>
1558
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 199</span>
1559
- 199: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option_parser_type_name</span>
1560
- 200: <span class="ruby-ivar">@option_parser_type_name</span>
1561
- 201: <span class="ruby-keyword kw">end</span></pre>
1562
- </div>
1563
-
1564
- </div>
1565
-
1566
-
1567
-
1568
-
1569
- </div>
1570
-
1571
-
1572
- <div id="option-parser-type-output-method" class="method-detail ">
1573
- <a name="method-i-option_parser_type_output"></a>
1574
-
1575
- <div class="method-heading">
1576
-
1577
- <span class="method-name">option_parser_type_output</span><span
1578
- class="method-args">()</span>
1579
- <span class="method-click-advice">click to toggle source</span>
1580
-
1581
- </div>
1582
-
1583
- <div class="method-description">
1584
-
1585
-
1586
-
1587
-
1588
-
1589
- <div class="method-source-code"
1590
- id="option-parser-type-output-source">
1591
- <pre>
1592
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 203</span>
1593
- 203: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">option_parser_type_output</span>
1594
- 204: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">hidden_value?</span> <span class="ruby-operator">?</span> <span class="ruby-value str">''</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">option_parser_type_name</span>
1595
- 205: <span class="ruby-identifier">required?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">:</span> <span class="ruby-node">&quot;[#{type}]&quot;</span>
1596
- 206: <span class="ruby-keyword kw">end</span></pre>
1597
- </div>
1598
-
1599
- </div>
1600
-
1601
-
1602
-
1603
-
1604
- </div>
1605
-
1606
-
1607
- <div id="prepare-prerequisites-method" class="method-detail ">
1608
- <a name="method-i-prepare_prerequisites"></a>
1609
-
1610
- <div class="method-heading">
1611
-
1612
- <span class="method-name">prepare_prerequisites</span><span
1613
- class="method-args">()</span>
1614
- <span class="method-click-advice">click to toggle source</span>
1615
-
1616
- </div>
1617
-
1618
- <div class="method-description">
1619
-
1620
-
1621
-
1622
-
1623
-
1624
- <div class="method-source-code"
1625
- id="prepare-prerequisites-source">
1626
- <pre>
1627
- <span class="ruby-comment cmt"># File lib/sprout/executable/param.rb, line 208</span>
1628
- 208: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare_prerequisites</span>
1629
- 209: <span class="ruby-keyword kw">end</span></pre>
1630
- </div>
1631
-
1632
- </div>
1633
-
1634
-
1635
-
1636
-
1637
- </div>
1638
-
1639
-
1640
- </div>
1641
-
1642
-
1643
- </div>
1644
-
1645
-
1646
- <div id="rdoc-debugging-section-dump" class="debugging-section">
1647
-
1648
- <p>Disabled; run with --debug to generate this.</p>
1649
-
1650
- </div>
1651
-
1652
- <div id="validator-badges">
1653
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1654
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
1655
- Rdoc Generator</a> 1.1.6</small>.</p>
1656
- </div>
1657
-
1658
- </body>
1659
- </html>
1660
-