sprout 1.0.11.pre → 1.0.13.pre

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.

This version of sprout might be problematic. Click here for more details.

Files changed (149) hide show
  1. data/lib/sprout/executable.rb +37 -10
  2. data/lib/sprout/generator/base.rb +17 -0
  3. data/lib/sprout/ruby_feature.rb +1 -1
  4. data/lib/sprout/version.rb +1 -1
  5. data/rdoc/<.html +274 -0
  6. data/rdoc/Dir.html +387 -0
  7. data/rdoc/Object.html +344 -0
  8. data/rdoc/Sprout.html +440 -0
  9. data/rdoc/Sprout/ArchiveUnpacker.html +1045 -0
  10. data/rdoc/Sprout/Base.html +283 -0
  11. data/rdoc/Sprout/Base/ClassMethods.html +474 -0
  12. data/rdoc/Sprout/Concern.html +415 -0
  13. data/rdoc/Sprout/Errors.html +324 -0
  14. data/rdoc/Sprout/Errors/ArchiveUnpackerError.html +284 -0
  15. data/rdoc/Sprout/Errors/DestinationExistsError.html +286 -0
  16. data/rdoc/Sprout/Errors/DuplicateMemberError.html +284 -0
  17. data/rdoc/Sprout/Errors/ExecutableError.html +285 -0
  18. data/rdoc/Sprout/Errors/ExecutableRegistrationError.html +284 -0
  19. data/rdoc/Sprout/Errors/ExecutionError.html +284 -0
  20. data/rdoc/Sprout/Errors/GeneratorError.html +284 -0
  21. data/rdoc/Sprout/Errors/InvalidArgumentError.html +284 -0
  22. data/rdoc/Sprout/Errors/LoadError.html +284 -0
  23. data/rdoc/Sprout/Errors/MissingArgumentError.html +284 -0
  24. data/rdoc/Sprout/Errors/MissingExecutableError.html +284 -0
  25. data/rdoc/Sprout/Errors/MissingGeneratorError.html +285 -0
  26. data/rdoc/Sprout/Errors/MissingTemplateError.html +285 -0
  27. data/rdoc/Sprout/Errors/ProcessRunnerError.html +284 -0
  28. data/rdoc/Sprout/Errors/RemoteFileLoaderError.html +284 -0
  29. data/rdoc/Sprout/Errors/SproutError.html +284 -0
  30. data/rdoc/Sprout/Errors/UnknownArchiveType.html +285 -0
  31. data/rdoc/Sprout/Errors/UsageError.html +284 -0
  32. data/rdoc/Sprout/Errors/ValidationError.html +284 -0
  33. data/rdoc/Sprout/Errors/VersionRequirementNotMetError.html +284 -0
  34. data/rdoc/Sprout/Executable.html +549 -0
  35. data/rdoc/Sprout/Executable/Boolean.html +445 -0
  36. data/rdoc/Sprout/Executable/ClassMethods.html +713 -0
  37. data/rdoc/Sprout/Executable/CollectionParam.html +501 -0
  38. data/rdoc/Sprout/Executable/FileParam.html +512 -0
  39. data/rdoc/Sprout/Executable/Files.html +385 -0
  40. data/rdoc/Sprout/Executable/InstanceMethods.html +1597 -0
  41. data/rdoc/Sprout/Executable/Number.html +284 -0
  42. data/rdoc/Sprout/Executable/Param.html +1660 -0
  43. data/rdoc/Sprout/Executable/ParameterFactory.html +345 -0
  44. data/rdoc/Sprout/Executable/Path.html +339 -0
  45. data/rdoc/Sprout/Executable/Paths.html +339 -0
  46. data/rdoc/Sprout/Executable/StringParam.html +333 -0
  47. data/rdoc/Sprout/Executable/Strings.html +295 -0
  48. data/rdoc/Sprout/Executable/Url.html +284 -0
  49. data/rdoc/Sprout/Executable/Urls.html +284 -0
  50. data/rdoc/Sprout/FileTarget.html +660 -0
  51. data/rdoc/Sprout/Generator.html +643 -0
  52. data/rdoc/Sprout/Generator/Base.html +1143 -0
  53. data/rdoc/Sprout/Generator/Command.html +604 -0
  54. data/rdoc/Sprout/Generator/DirectoryManifest.html +561 -0
  55. data/rdoc/Sprout/Generator/FileManifest.html +545 -0
  56. data/rdoc/Sprout/Generator/Manifest.html +387 -0
  57. data/rdoc/Sprout/Generator/TemplateManifest.html +331 -0
  58. data/rdoc/Sprout/GeneratorGenerator.html +358 -0
  59. data/rdoc/Sprout/Library.html +646 -0
  60. data/rdoc/Sprout/LibraryGenerator.html +368 -0
  61. data/rdoc/Sprout/Log.html +281 -0
  62. data/rdoc/Sprout/Platform.html +610 -0
  63. data/rdoc/Sprout/ProcessRunner.html +1145 -0
  64. data/rdoc/Sprout/ProgressBar.html +281 -0
  65. data/rdoc/Sprout/ProgressBarImpl.html +281 -0
  66. data/rdoc/Sprout/ProgressBarManager.html +281 -0
  67. data/rdoc/Sprout/ProgressBarOutputStream.html +281 -0
  68. data/rdoc/Sprout/RDocParser.html +702 -0
  69. data/rdoc/Sprout/RemoteFileLoader.html +537 -0
  70. data/rdoc/Sprout/RemoteFileTarget.html +741 -0
  71. data/rdoc/Sprout/ReversedProgressBar.html +281 -0
  72. data/rdoc/Sprout/RubyFeature.html +324 -0
  73. data/rdoc/Sprout/RubyFeature/ClassMethods.html +821 -0
  74. data/rdoc/Sprout/RubyGenerator.html +576 -0
  75. data/rdoc/Sprout/Specification.html +915 -0
  76. data/rdoc/Sprout/System.html +383 -0
  77. data/rdoc/Sprout/System/BaseSystem.html +1173 -0
  78. data/rdoc/Sprout/System/JavaSystem.html +284 -0
  79. data/rdoc/Sprout/System/OSXSystem.html +419 -0
  80. data/rdoc/Sprout/System/ThreadMock.html +281 -0
  81. data/rdoc/Sprout/System/UnixSystem.html +583 -0
  82. data/rdoc/Sprout/System/VistaSystem.html +367 -0
  83. data/rdoc/Sprout/System/WinNixSystem.html +417 -0
  84. data/rdoc/Sprout/System/WinSystem.html +672 -0
  85. data/rdoc/Sprout/ToolGenerator.html +376 -0
  86. data/rdoc/Sprout/VERSION.html +274 -0
  87. data/rdoc/SproutTestCase.html +279 -0
  88. data/rdoc/String.html +411 -0
  89. data/rdoc/created.rid +61 -0
  90. data/rdoc/index.html +795 -0
  91. data/rdoc/lib/sprout/archive_unpacker_rb.html +56 -0
  92. data/rdoc/lib/sprout/base_rb.html +111 -0
  93. data/rdoc/lib/sprout/concern_rb.html +52 -0
  94. data/rdoc/lib/sprout/dir_rb.html +52 -0
  95. data/rdoc/lib/sprout/errors_rb.html +52 -0
  96. data/rdoc/lib/sprout/executable/boolean_rb.html +52 -0
  97. data/rdoc/lib/sprout/executable/collection_param_rb.html +52 -0
  98. data/rdoc/lib/sprout/executable/file_param_rb.html +52 -0
  99. data/rdoc/lib/sprout/executable/files_rb.html +52 -0
  100. data/rdoc/lib/sprout/executable/number_rb.html +52 -0
  101. data/rdoc/lib/sprout/executable/param_rb.html +52 -0
  102. data/rdoc/lib/sprout/executable/parameter_factory_rb.html +52 -0
  103. data/rdoc/lib/sprout/executable/path_rb.html +52 -0
  104. data/rdoc/lib/sprout/executable/paths_rb.html +52 -0
  105. data/rdoc/lib/sprout/executable/string_param_rb.html +52 -0
  106. data/rdoc/lib/sprout/executable/strings_rb.html +52 -0
  107. data/rdoc/lib/sprout/executable/url_rb.html +52 -0
  108. data/rdoc/lib/sprout/executable/urls_rb.html +52 -0
  109. data/rdoc/lib/sprout/executable_rb.html +78 -0
  110. data/rdoc/lib/sprout/file_target_rb.html +52 -0
  111. data/rdoc/lib/sprout/generator/base_rb.html +54 -0
  112. data/rdoc/lib/sprout/generator/command_rb.html +52 -0
  113. data/rdoc/lib/sprout/generator/directory_manifest_rb.html +52 -0
  114. data/rdoc/lib/sprout/generator/file_manifest_rb.html +52 -0
  115. data/rdoc/lib/sprout/generator/manifest_rb.html +52 -0
  116. data/rdoc/lib/sprout/generator/template_manifest_rb.html +52 -0
  117. data/rdoc/lib/sprout/generators/generator/generator_generator_rb.html +52 -0
  118. data/rdoc/lib/sprout/generators/generator/templates/generator_test_helper_rb.html +64 -0
  119. data/rdoc/lib/sprout/generators/library/library_generator_rb.html +52 -0
  120. data/rdoc/lib/sprout/generators/ruby/ruby_generator_rb.html +52 -0
  121. data/rdoc/lib/sprout/generators/ruby/templates/ruby_base_rb.html +54 -0
  122. data/rdoc/lib/sprout/generators/tool/tool_generator_rb.html +52 -0
  123. data/rdoc/lib/sprout/library_rb.html +52 -0
  124. data/rdoc/lib/sprout/log_rb.html +52 -0
  125. data/rdoc/lib/sprout/platform_rb.html +52 -0
  126. data/rdoc/lib/sprout/process_runner_rb.html +58 -0
  127. data/rdoc/lib/sprout/progress_bar_rb.html +72 -0
  128. data/rdoc/lib/sprout/rdoc_parser_rb.html +54 -0
  129. data/rdoc/lib/sprout/remote_file_loader_rb.html +54 -0
  130. data/rdoc/lib/sprout/remote_file_target_rb.html +52 -0
  131. data/rdoc/lib/sprout/ruby_feature_rb.html +52 -0
  132. data/rdoc/lib/sprout/specification_rb.html +52 -0
  133. data/rdoc/lib/sprout/string_rb.html +52 -0
  134. data/rdoc/lib/sprout/system/base_system_rb.html +52 -0
  135. data/rdoc/lib/sprout/system/java_system_rb.html +52 -0
  136. data/rdoc/lib/sprout/system/osx_system_rb.html +52 -0
  137. data/rdoc/lib/sprout/system/unix_system_rb.html +52 -0
  138. data/rdoc/lib/sprout/system/vista_system_rb.html +52 -0
  139. data/rdoc/lib/sprout/system/win_nix_system_rb.html +52 -0
  140. data/rdoc/lib/sprout/system/win_system_rb.html +52 -0
  141. data/rdoc/lib/sprout/system_rb.html +66 -0
  142. data/rdoc/lib/sprout/test/sprout_test_case_rb.html +57 -0
  143. data/rdoc/lib/sprout/version_rb.html +52 -0
  144. data/rdoc/lib/sprout_rb.html +54 -0
  145. data/rdoc/rdoc.css +706 -0
  146. data/test/fixtures/executable/mxmlc.rb +2 -2
  147. data/test/unit/executable_test.rb +13 -0
  148. data/test/unit/generator_test.rb +25 -2
  149. metadata +144 -3
data/rdoc/Sprout/Executable/FileParam.html ADDED
@@ -0,0 +1,512 @@
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::FileParam</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/file_param_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
+ class="thickbox" title="lib/sprout/executable/file_param.rb">lib/sprout/executable/file_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="Param.html">Sprout::Executable::Param</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-prepare_prerequisites">#prepare_prerequisites</a></li>
75
+
76
+ <li><a href="#method-i-prerequisite%3F">#prerequisite?</a></li>
77
+
78
+ <li><a href="#method-i-shell_value">#shell_value</a></li>
79
+
80
+ <li><a href="#method-i-validate">#validate</a></li>
81
+
82
+ </ul>
83
+ </div>
84
+
85
+
86
+ <!-- Included Modules -->
87
+
88
+ </div>
89
+
90
+ <div id="project-metadata">
91
+
92
+
93
+
94
+ <div id="classindex-section" class="section project-section">
95
+ <h3 class="section-header">Class Index
96
+ <span class="search-toggle"><img src="../../images/find.png"
97
+ height="16" width="16" alt="[+]"
98
+ title="show/hide quicksearch" /></span></h3>
99
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
100
+ <fieldset>
101
+ <legend>Quicksearch</legend>
102
+ <input type="text" name="quicksearch" value=""
103
+ class="quicksearch-field" />
104
+ </fieldset>
105
+ </form>
106
+
107
+ <ul class="link-list">
108
+
109
+ <li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
110
+
111
+ <li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
112
+
113
+ <li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
114
+
115
+ <li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
116
+
117
+ <li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
118
+
119
+ <li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
120
+
121
+ <li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
122
+
123
+ <li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
124
+
125
+ <li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
126
+
127
+ <li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
128
+
129
+ <li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
130
+
131
+ <li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
132
+
133
+ <li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
134
+
135
+ <li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
136
+
137
+ <li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
138
+
139
+ <li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
140
+
141
+ <li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
142
+
143
+ <li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
144
+
145
+ <li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
146
+
147
+ <li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
148
+
149
+ <li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
150
+
151
+ <li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
152
+
153
+ <li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
154
+
155
+ <li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
156
+
157
+ <li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
158
+
159
+ <li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
160
+
161
+ <li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
162
+
163
+ <li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
164
+
165
+ <li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
166
+
167
+ <li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
168
+
169
+ <li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
170
+
171
+ <li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
172
+
173
+ <li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
174
+
175
+ <li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
176
+
177
+ <li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
178
+
179
+ <li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
180
+
181
+ <li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
182
+
183
+ <li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
184
+
185
+ <li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
186
+
187
+ <li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
188
+
189
+ <li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
190
+
191
+ <li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
192
+
193
+ <li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
194
+
195
+ <li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
196
+
197
+ <li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
198
+
199
+ <li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
200
+
201
+ <li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
202
+
203
+ <li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
204
+
205
+ <li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
206
+
207
+ <li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
208
+
209
+ <li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
210
+
211
+ <li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
212
+
213
+ <li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
214
+
215
+ <li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
216
+
217
+ <li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
218
+
219
+ <li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
220
+
221
+ <li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
222
+
223
+ <li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
224
+
225
+ <li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
226
+
227
+ <li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
228
+
229
+ <li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
230
+
231
+ <li><a href="../../Sprout/System.html">Sprout::System</a></li>
232
+
233
+ <li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
234
+
235
+ <li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
236
+
237
+ <li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
238
+
239
+ <li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
240
+
241
+ <li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
242
+
243
+ <li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
244
+
245
+ <li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
246
+
247
+ <li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
248
+
249
+ <li><a href="../../<.html"><</a></li>
250
+
251
+ <li><a href="../../Dir.html">Dir</a></li>
252
+
253
+ <li><a href="../../Object.html">Object</a></li>
254
+
255
+ <li><a href="../../String.html">String</a></li>
256
+
257
+ </ul>
258
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
259
+ </div>
260
+
261
+
262
+ </div>
263
+ </div>
264
+
265
+ <div id="documentation">
266
+ <h1 class="class">Sprout::Executable::FileParam</h1>
267
+
268
+ <div id="description">
269
+ <p>
270
+ Concrete param object for :file values
271
+ </p>
272
+ <p>
273
+ This class is actually referenced in Excecutables with:
274
+ </p>
275
+ <pre>
276
+ add_param :some_name, File
277
+ </pre>
278
+ <p>
279
+ @see <a
280
+ href="ParameterFactory.html">Sprout::Executable::ParameterFactory</a>
281
+ </p>
282
+
283
+ </div>
284
+
285
+ <!-- Constants -->
286
+
287
+
288
+ <!-- Attributes -->
289
+
290
+
291
+ <!-- Methods -->
292
+
293
+ <div id="public-class-method-details" class="method-section section">
294
+ <h3 class="section-header">Public Class Methods</h3>
295
+
296
+
297
+ <div id="new-method" class="method-detail ">
298
+ <a name="method-c-new"></a>
299
+
300
+ <div class="method-heading">
301
+
302
+ <span class="method-name">new</span><span
303
+ class="method-args">()</span>
304
+ <span class="method-click-advice">click to toggle source</span>
305
+
306
+ </div>
307
+
308
+ <div class="method-description">
309
+
310
+
311
+
312
+
313
+
314
+ <div class="method-source-code"
315
+ id="new-source">
316
+ <pre>
317
+ <span class="ruby-comment cmt"># File lib/sprout/executable/file_param.rb, line 16</span>
318
+ 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
319
+ 17: <span class="ruby-keyword kw">super</span>
320
+ 18: <span class="ruby-ivar">@option_parser_type_name</span> = <span class="ruby-value str">'FILE'</span>
321
+ 19: <span class="ruby-keyword kw">end</span></pre>
322
+ </div>
323
+
324
+ </div>
325
+
326
+
327
+
328
+
329
+ </div>
330
+
331
+
332
+ </div>
333
+
334
+ <div id="public-instance-method-details" class="method-section section">
335
+ <h3 class="section-header">Public Instance Methods</h3>
336
+
337
+
338
+ <div id="prepare-prerequisites-method" class="method-detail ">
339
+ <a name="method-i-prepare_prerequisites"></a>
340
+
341
+ <div class="method-heading">
342
+
343
+ <span class="method-name">prepare_prerequisites</span><span
344
+ class="method-args">()</span>
345
+ <span class="method-click-advice">click to toggle source</span>
346
+
347
+ </div>
348
+
349
+ <div class="method-description">
350
+
351
+
352
+
353
+
354
+
355
+ <div class="method-source-code"
356
+ id="prepare-prerequisites-source">
357
+ <pre>
358
+ <span class="ruby-comment cmt"># File lib/sprout/executable/file_param.rb, line 25</span>
359
+ 25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare_prerequisites</span>
360
+ 26: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">file_task_name</span>
361
+ 27: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">value</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">rake_task_name</span>
362
+ 28: <span class="ruby-keyword kw">return</span>
363
+ 29: <span class="ruby-keyword kw">end</span>
364
+ 30:
365
+ 31: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">prerequisite?</span>(<span class="ruby-identifier">value</span>)
366
+ 32: <span class="ruby-identifier">file</span> <span class="ruby-identifier">value</span>
367
+ 33: <span class="ruby-identifier">belongs_to</span>.<span class="ruby-identifier">prerequisites</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">value</span>
368
+ 34: <span class="ruby-keyword kw">end</span>
369
+ 35: <span class="ruby-keyword kw">end</span></pre>
370
+ </div>
371
+
372
+ </div>
373
+
374
+
375
+
376
+
377
+ </div>
378
+
379
+
380
+ <div id="shell-value-method" class="method-detail ">
381
+ <a name="method-i-shell_value"></a>
382
+
383
+ <div class="method-heading">
384
+
385
+ <span class="method-name">shell_value</span><span
386
+ class="method-args">()</span>
387
+ <span class="method-click-advice">click to toggle source</span>
388
+
389
+ </div>
390
+
391
+ <div class="method-description">
392
+
393
+
394
+
395
+
396
+
397
+ <div class="method-source-code"
398
+ id="shell-value-source">
399
+ <pre>
400
+ <span class="ruby-comment cmt"># File lib/sprout/executable/file_param.rb, line 21</span>
401
+ 21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">shell_value</span>
402
+ 22: <span class="ruby-identifier">clean_path</span> <span class="ruby-identifier">value</span>
403
+ 23: <span class="ruby-keyword kw">end</span></pre>
404
+ </div>
405
+
406
+ </div>
407
+
408
+
409
+
410
+
411
+ </div>
412
+
413
+
414
+ <div id="validate-method" class="method-detail ">
415
+ <a name="method-i-validate"></a>
416
+
417
+ <div class="method-heading">
418
+
419
+ <span class="method-name">validate</span><span
420
+ class="method-args">()</span>
421
+ <span class="method-click-advice">click to toggle source</span>
422
+
423
+ </div>
424
+
425
+ <div class="method-description">
426
+
427
+
428
+
429
+
430
+
431
+ <div class="method-source-code"
432
+ id="validate-source">
433
+ <pre>
434
+ <span class="ruby-comment cmt"># File lib/sprout/executable/file_param.rb, line 37</span>
435
+ 37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>
436
+ 38: <span class="ruby-keyword kw">super</span>
437
+ 39:
438
+ 40: <span class="ruby-keyword kw">if</span>(<span class="ruby-operator">!</span><span class="ruby-identifier">file_task_name</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">value</span>))
439
+ 41: <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">InvalidArgumentError</span>.<span class="ruby-identifier">new</span> <span class="ruby-node">&quot;No such file or directory - #{value}&quot;</span>
440
+ 42: <span class="ruby-keyword kw">end</span>
441
+ 43: <span class="ruby-keyword kw">end</span></pre>
442
+ </div>
443
+
444
+ </div>
445
+
446
+
447
+
448
+
449
+ </div>
450
+
451
+
452
+ </div>
453
+
454
+ <div id="private-instance-method-details" class="method-section section">
455
+ <h3 class="section-header">Private Instance Methods</h3>
456
+
457
+
458
+ <div id="prerequisite--method" class="method-detail ">
459
+ <a name="method-i-prerequisite%3F"></a>
460
+
461
+ <div class="method-heading">
462
+
463
+ <span class="method-name">prerequisite?</span><span
464
+ class="method-args">(file)</span>
465
+ <span class="method-click-advice">click to toggle source</span>
466
+
467
+ </div>
468
+
469
+ <div class="method-description">
470
+
471
+
472
+
473
+
474
+
475
+ <div class="method-source-code"
476
+ id="prerequisite--source">
477
+ <pre>
478
+ <span class="ruby-comment cmt"># File lib/sprout/executable/file_param.rb, line 47</span>
479
+ 47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prerequisite?</span>(<span class="ruby-identifier">file</span>)
480
+ 48: <span class="ruby-identifier">file</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">file_is_output?</span>(<span class="ruby-identifier">file</span>)
481
+ 49: <span class="ruby-keyword kw">end</span></pre>
482
+ </div>
483
+
484
+ </div>
485
+
486
+
487
+
488
+
489
+ </div>
490
+
491
+
492
+ </div>
493
+
494
+
495
+ </div>
496
+
497
+
498
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
499
+
500
+ <p>Disabled; run with --debug to generate this.</p>
501
+
502
+ </div>
503
+
504
+ <div id="validator-badges">
505
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
506
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
507
+ Rdoc Generator</a> 1.1.6</small>.</p>
508
+ </div>
509
+
510
+ </body>
511
+ </html>
512
+