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/Boolean.html DELETED
@@ -1,445 +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::Boolean</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/boolean_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
- class="thickbox" title="lib/sprout/executable/boolean.rb">lib/sprout/executable/boolean.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-value%3D">#value=</a></li>
75
-
76
- <li><a href="#method-i-visible%3F">#visible?</a></li>
77
-
78
- </ul>
79
- </div>
80
-
81
-
82
- <!-- Included Modules -->
83
-
84
- </div>
85
-
86
- <div id="project-metadata">
87
-
88
-
89
-
90
- <div id="classindex-section" class="section project-section">
91
- <h3 class="section-header">Class Index
92
- <span class="search-toggle"><img src="../../images/find.png"
93
- height="16" width="16" alt="[+]"
94
- title="show/hide quicksearch" /></span></h3>
95
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
96
- <fieldset>
97
- <legend>Quicksearch</legend>
98
- <input type="text" name="quicksearch" value=""
99
- class="quicksearch-field" />
100
- </fieldset>
101
- </form>
102
-
103
- <ul class="link-list">
104
-
105
- <li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
106
-
107
- <li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
108
-
109
- <li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
110
-
111
- <li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
112
-
113
- <li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
114
-
115
- <li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
116
-
117
- <li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
118
-
119
- <li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
120
-
121
- <li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
122
-
123
- <li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
124
-
125
- <li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
126
-
127
- <li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
128
-
129
- <li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
130
-
131
- <li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
132
-
133
- <li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
134
-
135
- <li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
136
-
137
- <li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
138
-
139
- <li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
140
-
141
- <li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
142
-
143
- <li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
144
-
145
- <li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
146
-
147
- <li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
148
-
149
- <li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
150
-
151
- <li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
152
-
153
- <li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
154
-
155
- <li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
156
-
157
- <li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
158
-
159
- <li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
160
-
161
- <li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
162
-
163
- <li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
164
-
165
- <li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
166
-
167
- <li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
168
-
169
- <li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
170
-
171
- <li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
172
-
173
- <li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
174
-
175
- <li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
176
-
177
- <li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
178
-
179
- <li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
180
-
181
- <li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
182
-
183
- <li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
184
-
185
- <li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
186
-
187
- <li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
188
-
189
- <li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
190
-
191
- <li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
192
-
193
- <li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
194
-
195
- <li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
196
-
197
- <li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
198
-
199
- <li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
200
-
201
- <li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
202
-
203
- <li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
204
-
205
- <li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
206
-
207
- <li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
208
-
209
- <li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
210
-
211
- <li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
212
-
213
- <li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
214
-
215
- <li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
216
-
217
- <li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
218
-
219
- <li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
220
-
221
- <li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
222
-
223
- <li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
224
-
225
- <li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
226
-
227
- <li><a href="../../Sprout/System.html">Sprout::System</a></li>
228
-
229
- <li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
230
-
231
- <li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
232
-
233
- <li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
234
-
235
- <li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
236
-
237
- <li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
238
-
239
- <li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
240
-
241
- <li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
242
-
243
- <li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
244
-
245
- <li><a href="../../<.html"><</a></li>
246
-
247
- <li><a href="../../Dir.html">Dir</a></li>
248
-
249
- <li><a href="../../Object.html">Object</a></li>
250
-
251
- <li><a href="../../String.html">String</a></li>
252
-
253
- </ul>
254
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
255
- </div>
256
-
257
-
258
- </div>
259
- </div>
260
-
261
- <div id="documentation">
262
- <h1 class="class">Sprout::Executable::Boolean</h1>
263
-
264
- <div id="description">
265
- <p>
266
- Concrete param object for :boolean values
267
- </p>
268
-
269
- </div>
270
-
271
- <!-- Constants -->
272
-
273
-
274
- <!-- Attributes -->
275
-
276
- <div id="attribute-method-details" class="method-section section">
277
- <h3 class="section-header">Attributes</h3>
278
-
279
-
280
- <div id="show-on-false-attribute-method" class="method-detail">
281
- <a name="show_on_false"></a>
282
-
283
- <a name="show_on_false="></a>
284
-
285
- <div class="method-heading attribute-method-heading">
286
- <span class="method-name">show_on_false</span><span
287
- class="attribute-access-type">[RW]</span>
288
- </div>
289
-
290
- <div class="method-description">
291
-
292
-
293
-
294
- </div>
295
- </div>
296
-
297
- </div>
298
-
299
-
300
- <!-- Methods -->
301
-
302
- <div id="public-class-method-details" class="method-section section">
303
- <h3 class="section-header">Public Class Methods</h3>
304
-
305
-
306
- <div id="new-method" class="method-detail ">
307
- <a name="method-c-new"></a>
308
-
309
- <div class="method-heading">
310
-
311
- <span class="method-name">new</span><span
312
- class="method-args">()</span>
313
- <span class="method-click-advice">click to toggle source</span>
314
-
315
- </div>
316
-
317
- <div class="method-description">
318
-
319
-
320
-
321
-
322
-
323
- <div class="method-source-code"
324
- id="new-source">
325
- <pre>
326
- <span class="ruby-comment cmt"># File lib/sprout/executable/boolean.rb, line 9</span>
327
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
328
- 10: <span class="ruby-keyword kw">super</span>
329
- 11: <span class="ruby-ivar">@delimiter</span> = <span class="ruby-value str">' '</span>
330
- 12: <span class="ruby-ivar">@option_parser_type_name</span> = <span class="ruby-value str">'BOOL'</span>
331
- 13: <span class="ruby-ivar">@show_on_false</span> = <span class="ruby-keyword kw">false</span>
332
- 14: <span class="ruby-ivar">@value</span> = <span class="ruby-keyword kw">false</span>
333
- 15: <span class="ruby-ivar">@hidden_value</span> = <span class="ruby-keyword kw">true</span>
334
- 16: <span class="ruby-keyword kw">end</span></pre>
335
- </div>
336
-
337
- </div>
338
-
339
-
340
-
341
-
342
- </div>
343
-
344
-
345
- </div>
346
-
347
- <div id="public-instance-method-details" class="method-section section">
348
- <h3 class="section-header">Public Instance Methods</h3>
349
-
350
-
351
- <div id="value--method" class="method-detail ">
352
- <a name="method-i-value%3D"></a>
353
-
354
- <div class="method-heading">
355
-
356
- <span class="method-name">value=</span><span
357
- class="method-args">(value)</span>
358
- <span class="method-click-advice">click to toggle source</span>
359
-
360
- </div>
361
-
362
- <div class="method-description">
363
-
364
-
365
-
366
-
367
-
368
- <div class="method-source-code"
369
- id="value--source">
370
- <pre>
371
- <span class="ruby-comment cmt"># File lib/sprout/executable/boolean.rb, line 18</span>
372
- 18: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">value=</span>(<span class="ruby-identifier">value</span>)
373
- 19: <span class="ruby-identifier">value</span> = (<span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;true&quot;</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">===</span> <span class="ruby-keyword kw">true</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">false</span>
374
- 20: <span class="ruby-keyword kw">super</span> <span class="ruby-identifier">value</span>
375
- 21: <span class="ruby-keyword kw">end</span></pre>
376
- </div>
377
-
378
- </div>
379
-
380
-
381
-
382
-
383
- </div>
384
-
385
-
386
- <div id="visible--method" class="method-detail ">
387
- <a name="method-i-visible%3F"></a>
388
-
389
- <div class="method-heading">
390
-
391
- <span class="method-name">visible?</span><span
392
- class="method-args">()</span>
393
- <span class="method-click-advice">click to toggle source</span>
394
-
395
- </div>
396
-
397
- <div class="method-description">
398
-
399
-
400
-
401
-
402
-
403
- <div class="method-source-code"
404
- id="visible--source">
405
- <pre>
406
- <span class="ruby-comment cmt"># File lib/sprout/executable/boolean.rb, line 23</span>
407
- 23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">visible?</span>
408
- 24: <span class="ruby-ivar">@visible</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">value</span>
409
- 25: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">show_on_false</span>)
410
- 26: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">value</span>
411
- 27: <span class="ruby-keyword kw">else</span>
412
- 28: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@visible</span>
413
- 29: <span class="ruby-keyword kw">end</span>
414
- 30: <span class="ruby-keyword kw">end</span></pre>
415
- </div>
416
-
417
- </div>
418
-
419
-
420
-
421
-
422
- </div>
423
-
424
-
425
- </div>
426
-
427
-
428
- </div>
429
-
430
-
431
- <div id="rdoc-debugging-section-dump" class="debugging-section">
432
-
433
- <p>Disabled; run with --debug to generate this.</p>
434
-
435
- </div>
436
-
437
- <div id="validator-badges">
438
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
439
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
440
- Rdoc Generator</a> 1.1.6</small>.</p>
441
- </div>
442
-
443
- </body>
444
- </html>
445
-
data/rdoc/Sprout/Executable/ClassMethods.html DELETED
@@ -1,713 +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>Module: Sprout::Executable::ClassMethods</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="module">
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_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
- class="thickbox" title="lib/sprout/executable.rb">lib/sprout/executable.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
-
56
- <!-- Namespace Contents -->
57
-
58
-
59
- <!-- Method Quickref -->
60
-
61
- <div id="method-list-section" class="section">
62
- <h3 class="section-header">Methods</h3>
63
- <ul class="link-list">
64
-
65
- <li><a href="#method-i-accessor_can_be_defined_at">#accessor_can_be_defined_at</a></li>
66
-
67
- <li><a href="#method-i-add_param">#add_param</a></li>
68
-
69
- <li><a href="#method-i-add_param_alias">#add_param_alias</a></li>
70
-
71
- <li><a href="#method-i-create_param_accessors">#create_param_accessors</a></li>
72
-
73
- <li><a href="#method-i-instance_defines%3F">#instance_defines?</a></li>
74
-
75
- <li><a href="#method-i-set">#set</a></li>
76
-
77
- <li><a href="#method-i-set_default_value">#set_default_value</a></li>
78
-
79
- <li><a href="#method-i-static_default_value_collection">#static_default_value_collection</a></li>
80
-
81
- <li><a href="#method-i-static_parameter_collection">#static_parameter_collection</a></li>
82
-
83
- </ul>
84
- </div>
85
-
86
-
87
- <!-- Included Modules -->
88
-
89
- </div>
90
-
91
- <div id="project-metadata">
92
-
93
-
94
-
95
- <div id="classindex-section" class="section project-section">
96
- <h3 class="section-header">Class Index
97
- <span class="search-toggle"><img src="../../images/find.png"
98
- height="16" width="16" alt="[+]"
99
- title="show/hide quicksearch" /></span></h3>
100
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
101
- <fieldset>
102
- <legend>Quicksearch</legend>
103
- <input type="text" name="quicksearch" value=""
104
- class="quicksearch-field" />
105
- </fieldset>
106
- </form>
107
-
108
- <ul class="link-list">
109
-
110
- <li><a href="../../Sprout/ArchiveUnpacker.html">Sprout::ArchiveUnpacker</a></li>
111
-
112
- <li><a href="../../Sprout/Base.html">Sprout::Base</a></li>
113
-
114
- <li><a href="../../Sprout/Base/ClassMethods.html">Sprout::Base::ClassMethods</a></li>
115
-
116
- <li><a href="../../Sprout/Concern.html">Sprout::Concern</a></li>
117
-
118
- <li><a href="../../Sprout/Errors.html">Sprout::Errors</a></li>
119
-
120
- <li><a href="../../Sprout/Errors/ArchiveUnpackerError.html">Sprout::Errors::ArchiveUnpackerError</a></li>
121
-
122
- <li><a href="../../Sprout/Errors/DestinationExistsError.html">Sprout::Errors::DestinationExistsError</a></li>
123
-
124
- <li><a href="../../Sprout/Errors/DuplicateMemberError.html">Sprout::Errors::DuplicateMemberError</a></li>
125
-
126
- <li><a href="../../Sprout/Errors/ExecutableError.html">Sprout::Errors::ExecutableError</a></li>
127
-
128
- <li><a href="../../Sprout/Errors/ExecutableRegistrationError.html">Sprout::Errors::ExecutableRegistrationError</a></li>
129
-
130
- <li><a href="../../Sprout/Errors/ExecutionError.html">Sprout::Errors::ExecutionError</a></li>
131
-
132
- <li><a href="../../Sprout/Errors/GeneratorError.html">Sprout::Errors::GeneratorError</a></li>
133
-
134
- <li><a href="../../Sprout/Errors/InvalidArgumentError.html">Sprout::Errors::InvalidArgumentError</a></li>
135
-
136
- <li><a href="../../Sprout/Errors/LoadError.html">Sprout::Errors::LoadError</a></li>
137
-
138
- <li><a href="../../Sprout/Errors/MissingArgumentError.html">Sprout::Errors::MissingArgumentError</a></li>
139
-
140
- <li><a href="../../Sprout/Errors/MissingExecutableError.html">Sprout::Errors::MissingExecutableError</a></li>
141
-
142
- <li><a href="../../Sprout/Errors/MissingGeneratorError.html">Sprout::Errors::MissingGeneratorError</a></li>
143
-
144
- <li><a href="../../Sprout/Errors/MissingTemplateError.html">Sprout::Errors::MissingTemplateError</a></li>
145
-
146
- <li><a href="../../Sprout/Errors/ProcessRunnerError.html">Sprout::Errors::ProcessRunnerError</a></li>
147
-
148
- <li><a href="../../Sprout/Errors/RemoteFileLoaderError.html">Sprout::Errors::RemoteFileLoaderError</a></li>
149
-
150
- <li><a href="../../Sprout/Errors/SproutError.html">Sprout::Errors::SproutError</a></li>
151
-
152
- <li><a href="../../Sprout/Errors/UnknownArchiveType.html">Sprout::Errors::UnknownArchiveType</a></li>
153
-
154
- <li><a href="../../Sprout/Errors/UsageError.html">Sprout::Errors::UsageError</a></li>
155
-
156
- <li><a href="../../Sprout/Errors/ValidationError.html">Sprout::Errors::ValidationError</a></li>
157
-
158
- <li><a href="../../Sprout/Errors/VersionRequirementNotMetError.html">Sprout::Errors::VersionRequirementNotMetError</a></li>
159
-
160
- <li><a href="../../Sprout/Executable.html">Sprout::Executable</a></li>
161
-
162
- <li><a href="../../Sprout/Executable/Boolean.html">Sprout::Executable::Boolean</a></li>
163
-
164
- <li><a href="../../Sprout/Executable/ClassMethods.html">Sprout::Executable::ClassMethods</a></li>
165
-
166
- <li><a href="../../Sprout/Executable/CollectionParam.html">Sprout::Executable::CollectionParam</a></li>
167
-
168
- <li><a href="../../Sprout/Executable/FileParam.html">Sprout::Executable::FileParam</a></li>
169
-
170
- <li><a href="../../Sprout/Executable/Files.html">Sprout::Executable::Files</a></li>
171
-
172
- <li><a href="../../Sprout/Executable/InstanceMethods.html">Sprout::Executable::InstanceMethods</a></li>
173
-
174
- <li><a href="../../Sprout/Executable/Number.html">Sprout::Executable::Number</a></li>
175
-
176
- <li><a href="../../Sprout/Executable/Param.html">Sprout::Executable::Param</a></li>
177
-
178
- <li><a href="../../Sprout/Executable/ParameterFactory.html">Sprout::Executable::ParameterFactory</a></li>
179
-
180
- <li><a href="../../Sprout/Executable/Path.html">Sprout::Executable::Path</a></li>
181
-
182
- <li><a href="../../Sprout/Executable/Paths.html">Sprout::Executable::Paths</a></li>
183
-
184
- <li><a href="../../Sprout/Executable/StringParam.html">Sprout::Executable::StringParam</a></li>
185
-
186
- <li><a href="../../Sprout/Executable/Strings.html">Sprout::Executable::Strings</a></li>
187
-
188
- <li><a href="../../Sprout/Executable/Url.html">Sprout::Executable::Url</a></li>
189
-
190
- <li><a href="../../Sprout/Executable/Urls.html">Sprout::Executable::Urls</a></li>
191
-
192
- <li><a href="../../Sprout/FileTarget.html">Sprout::FileTarget</a></li>
193
-
194
- <li><a href="../../Sprout/Generator.html">Sprout::Generator</a></li>
195
-
196
- <li><a href="../../Sprout/Generator/Base.html">Sprout::Generator::Base</a></li>
197
-
198
- <li><a href="../../Sprout/Generator/Command.html">Sprout::Generator::Command</a></li>
199
-
200
- <li><a href="../../Sprout/Generator/DirectoryManifest.html">Sprout::Generator::DirectoryManifest</a></li>
201
-
202
- <li><a href="../../Sprout/Generator/FileManifest.html">Sprout::Generator::FileManifest</a></li>
203
-
204
- <li><a href="../../Sprout/Generator/Manifest.html">Sprout::Generator::Manifest</a></li>
205
-
206
- <li><a href="../../Sprout/Generator/TemplateManifest.html">Sprout::Generator::TemplateManifest</a></li>
207
-
208
- <li><a href="../../Sprout/GeneratorGenerator.html">Sprout::GeneratorGenerator</a></li>
209
-
210
- <li><a href="../../Sprout/Library.html">Sprout::Library</a></li>
211
-
212
- <li><a href="../../Sprout/LibraryGenerator.html">Sprout::LibraryGenerator</a></li>
213
-
214
- <li><a href="../../Sprout/Platform.html">Sprout::Platform</a></li>
215
-
216
- <li><a href="../../Sprout/ProcessRunner.html">Sprout::ProcessRunner</a></li>
217
-
218
- <li><a href="../../Sprout/RDocParser.html">Sprout::RDocParser</a></li>
219
-
220
- <li><a href="../../Sprout/RemoteFileLoader.html">Sprout::RemoteFileLoader</a></li>
221
-
222
- <li><a href="../../Sprout/RemoteFileTarget.html">Sprout::RemoteFileTarget</a></li>
223
-
224
- <li><a href="../../Sprout/RubyFeature.html">Sprout::RubyFeature</a></li>
225
-
226
- <li><a href="../../Sprout/RubyFeature/ClassMethods.html">Sprout::RubyFeature::ClassMethods</a></li>
227
-
228
- <li><a href="../../Sprout/RubyGenerator.html">Sprout::RubyGenerator</a></li>
229
-
230
- <li><a href="../../Sprout/Specification.html">Sprout::Specification</a></li>
231
-
232
- <li><a href="../../Sprout/System.html">Sprout::System</a></li>
233
-
234
- <li><a href="../../Sprout/System/BaseSystem.html">Sprout::System::BaseSystem</a></li>
235
-
236
- <li><a href="../../Sprout/System/JavaSystem.html">Sprout::System::JavaSystem</a></li>
237
-
238
- <li><a href="../../Sprout/System/OSXSystem.html">Sprout::System::OSXSystem</a></li>
239
-
240
- <li><a href="../../Sprout/System/UnixSystem.html">Sprout::System::UnixSystem</a></li>
241
-
242
- <li><a href="../../Sprout/System/VistaSystem.html">Sprout::System::VistaSystem</a></li>
243
-
244
- <li><a href="../../Sprout/System/WinNixSystem.html">Sprout::System::WinNixSystem</a></li>
245
-
246
- <li><a href="../../Sprout/System/WinSystem.html">Sprout::System::WinSystem</a></li>
247
-
248
- <li><a href="../../Sprout/ToolGenerator.html">Sprout::ToolGenerator</a></li>
249
-
250
- <li><a href="../../<.html"><</a></li>
251
-
252
- <li><a href="../../Dir.html">Dir</a></li>
253
-
254
- <li><a href="../../Object.html">Object</a></li>
255
-
256
- <li><a href="../../String.html">String</a></li>
257
-
258
- </ul>
259
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
260
- </div>
261
-
262
-
263
- </div>
264
- </div>
265
-
266
- <div id="documentation">
267
- <h1 class="module">Sprout::Executable::ClassMethods</h1>
268
-
269
- <div id="description">
270
-
271
- </div>
272
-
273
- <!-- Constants -->
274
-
275
-
276
- <!-- Attributes -->
277
-
278
-
279
- <!-- Methods -->
280
-
281
- <div id="public-instance-method-details" class="method-section section">
282
- <h3 class="section-header">Public Instance Methods</h3>
283
-
284
-
285
- <div id="add-param-method" class="method-detail ">
286
- <a name="method-i-add_param"></a>
287
-
288
- <div class="method-heading">
289
-
290
- <span class="method-name">add_param</span><span
291
- class="method-args">(name, type, options=nil)</span>
292
- <span class="method-click-advice">click to toggle source</span>
293
-
294
- </div>
295
-
296
- <div class="method-description">
297
-
298
- <p>
299
- <tt><a href="ClassMethods.html#method-i-add_param">add_param</a></tt> is
300
- the workhorse of the Task. This method is used to add new shell parameters
301
- to the executable interface.
302
- </p>
303
- <p>
304
- <tt>name</tt> is a symbol or string that represents the parameter that you
305
- would like to add such as :debug or :source_path.
306
- </p>
307
- <p>
308
- <tt>type</tt> is a class reference of the <a
309
- href="Param.html">Executable::Param</a> that you&#8217;d like to use. At
310
- the time of this writing, <a
311
- href="ClassMethods.html#method-i-add_param">add_param</a> will accept 2
312
- class references that do not extend <a href="Param.html">Param</a> - <a
313
- href="../../String.html">String</a> and File. The <a
314
- href="ParameterFactory.html">ParameterFactory</a> will automatically
315
- resolve these to the correct data type when they are created.
316
- </p>
317
- <pre>
318
- Boolean true or false
319
- File Path to a file
320
- Number Any number
321
- Path Path to a directory
322
- String Any string value
323
- Url Basic URL
324
-
325
- Files Collection of files
326
- Paths Collection of directories
327
- Strings Collection of arbitrary strings
328
- Urls Collection of URLs
329
- </pre>
330
- <p>
331
- Be sure to check out the <a href="Param.html">Sprout::Executable::Param</a>
332
- class to learn more about working with executable parameters.
333
- </p>
334
- <p>
335
- Once parameters have been added using the <tt><a
336
- href="ClassMethods.html#method-i-add_param">add_param</a></tt> method,
337
- clients can set and get those parameters from any newly created executable
338
- instance, or from the command line.
339
- </p>
340
- <p>
341
- In the case of an executable delegate, parameter values will be sent to the
342
- command line executable in the order they are added using <tt><a
343
- href="ClassMethods.html#method-i-add_param">add_param</a></tt>.
344
- </p>
345
- <p>
346
- In the case of a Ruby executable, command line parameters will be
347
- interpreted in the order they are defined using <tt><a
348
- href="ClassMethods.html#method-i-add_param">add_param</a></tt>.
349
- </p>
350
-
351
-
352
-
353
- <div class="method-source-code"
354
- id="add-param-source">
355
- <pre>
356
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 78</span>
357
- 78: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_param</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword kw">nil</span>) <span class="ruby-comment cmt"># :yields: Sprout::Executable::Param</span>
358
- 79: <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">UsageError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;[DEPRECATED] add_param no longer uses closures, you can provide the same values as a hash in the optional last argument.&quot;</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
359
- 80: <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">UsageError</span>.<span class="ruby-identifier">new</span> <span class="ruby-value str">&quot;The first parameter (name:SymbolOrString) is required&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span>
360
- 81: <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">UsageError</span>.<span class="ruby-identifier">new</span> <span class="ruby-value str">&quot;The second parameter (type:Class) is required&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">nil?</span>
361
- 82: <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">UsageError</span>.<span class="ruby-identifier">new</span> <span class="ruby-value str">&quot;The type parameter must be a Class by reference&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">type</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Class</span>)
362
- 83:
363
- 84: <span class="ruby-identifier">options</span> <span class="ruby-operator">||=</span> {}
364
- 85: <span class="ruby-identifier">options</span>[<span class="ruby-value">:name</span>] = <span class="ruby-identifier">name</span>
365
- 86: <span class="ruby-identifier">options</span>[<span class="ruby-value">:type</span>] = <span class="ruby-identifier">type</span>
366
- 87: <span class="ruby-comment cmt">#options[:description] ||= Sprout::RDocParser.description_for_caller caller.shift</span>
367
- 88:
368
- 89: <span class="ruby-identifier">create_param_accessors</span> <span class="ruby-identifier">options</span>
369
- 90: <span class="ruby-identifier">static_parameter_collection</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">options</span>
370
- 91: <span class="ruby-identifier">options</span>
371
- 92: <span class="ruby-keyword kw">end</span></pre>
372
- </div>
373
-
374
- </div>
375
-
376
-
377
-
378
-
379
- </div>
380
-
381
-
382
- <div id="add-param-alias-method" class="method-detail ">
383
- <a name="method-i-add_param_alias"></a>
384
-
385
- <div class="method-heading">
386
-
387
- <span class="method-name">add_param_alias</span><span
388
- class="method-args">(new_name, old_name)</span>
389
- <span class="method-click-advice">click to toggle source</span>
390
-
391
- </div>
392
-
393
- <div class="method-description">
394
-
395
-
396
-
397
-
398
-
399
- <div class="method-source-code"
400
- id="add-param-alias-source">
401
- <pre>
402
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 94</span>
403
- 94: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_param_alias</span> <span class="ruby-identifier">new_name</span>, <span class="ruby-identifier">old_name</span>
404
- 95: <span class="ruby-identifier">create_param_accessors</span> <span class="ruby-value">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">new_name</span>, <span class="ruby-value">:real_name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">old_name</span>
405
- 96: <span class="ruby-keyword kw">end</span></pre>
406
- </div>
407
-
408
- </div>
409
-
410
-
411
-
412
-
413
- </div>
414
-
415
-
416
- <div id="set-method" class="method-detail ">
417
- <a name="method-i-set"></a>
418
-
419
- <div class="method-heading">
420
-
421
- <span class="method-name">set</span><span
422
- class="method-args">(key, value)</span>
423
- <span class="method-click-advice">click to toggle source</span>
424
-
425
- </div>
426
-
427
- <div class="method-description">
428
-
429
-
430
-
431
-
432
-
433
- <div class="method-source-code"
434
- id="set-source">
435
- <pre>
436
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 106</span>
437
- 106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>
438
- 107: <span class="ruby-identifier">set_default_value</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>
439
- 108: <span class="ruby-keyword kw">end</span></pre>
440
- </div>
441
-
442
- </div>
443
-
444
-
445
-
446
-
447
- </div>
448
-
449
-
450
- <div id="static-default-value-collection-method" class="method-detail ">
451
- <a name="method-i-static_default_value_collection"></a>
452
-
453
- <div class="method-heading">
454
-
455
- <span class="method-name">static_default_value_collection</span><span
456
- class="method-args">()</span>
457
- <span class="method-click-advice">click to toggle source</span>
458
-
459
- </div>
460
-
461
- <div class="method-description">
462
-
463
-
464
-
465
-
466
-
467
- <div class="method-source-code"
468
- id="static-default-value-collection-source">
469
- <pre>
470
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 102</span>
471
- 102: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">static_default_value_collection</span>
472
- 103: <span class="ruby-ivar">@static_default_value_collection</span> <span class="ruby-operator">||=</span> []
473
- 104: <span class="ruby-keyword kw">end</span></pre>
474
- </div>
475
-
476
- </div>
477
-
478
-
479
-
480
-
481
- </div>
482
-
483
-
484
- <div id="static-parameter-collection-method" class="method-detail ">
485
- <a name="method-i-static_parameter_collection"></a>
486
-
487
- <div class="method-heading">
488
-
489
- <span class="method-name">static_parameter_collection</span><span
490
- class="method-args">()</span>
491
- <span class="method-click-advice">click to toggle source</span>
492
-
493
- </div>
494
-
495
- <div class="method-description">
496
-
497
-
498
-
499
-
500
-
501
- <div class="method-source-code"
502
- id="static-parameter-collection-source">
503
- <pre>
504
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 98</span>
505
- 98: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">static_parameter_collection</span>
506
- 99: <span class="ruby-ivar">@static_parameter_collection</span> <span class="ruby-operator">||=</span> []
507
- 100: <span class="ruby-keyword kw">end</span></pre>
508
- </div>
509
-
510
- </div>
511
-
512
-
513
-
514
-
515
- </div>
516
-
517
-
518
- </div>
519
-
520
- <div id="private-instance-method-details" class="method-section section">
521
- <h3 class="section-header">Private Instance Methods</h3>
522
-
523
-
524
- <div id="accessor-can-be-defined-at-method" class="method-detail ">
525
- <a name="method-i-accessor_can_be_defined_at"></a>
526
-
527
- <div class="method-heading">
528
-
529
- <span class="method-name">accessor_can_be_defined_at</span><span
530
- class="method-args">(name)</span>
531
- <span class="method-click-advice">click to toggle source</span>
532
-
533
- </div>
534
-
535
- <div class="method-description">
536
-
537
-
538
-
539
-
540
-
541
- <div class="method-source-code"
542
- id="accessor-can-be-defined-at-source">
543
- <pre>
544
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 112</span>
545
- 112: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">accessor_can_be_defined_at</span> <span class="ruby-identifier">name</span>
546
- 113: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">instance_defines?</span> <span class="ruby-identifier">name</span>)
547
- 114: <span class="ruby-identifier">message</span> = <span class="ruby-node">&quot;add_param called with a name that is already in use (#{name}=) on (#{self})&quot;</span>
548
- 115: <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">DuplicateMemberError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>)
549
- 116: <span class="ruby-keyword kw">end</span>
550
- 117: <span class="ruby-keyword kw">end</span></pre>
551
- </div>
552
-
553
- </div>
554
-
555
-
556
-
557
-
558
- </div>
559
-
560
-
561
- <div id="create-param-accessors-method" class="method-detail ">
562
- <a name="method-i-create_param_accessors"></a>
563
-
564
- <div class="method-heading">
565
-
566
- <span class="method-name">create_param_accessors</span><span
567
- class="method-args">(options)</span>
568
- <span class="method-click-advice">click to toggle source</span>
569
-
570
- </div>
571
-
572
- <div class="method-description">
573
-
574
-
575
-
576
-
577
-
578
- <div class="method-source-code"
579
- id="create-param-accessors-source">
580
- <pre>
581
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 119</span>
582
- 119: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_param_accessors</span> <span class="ruby-identifier">options</span>
583
- 120: <span class="ruby-identifier">name</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:name</span>]
584
- 121: <span class="ruby-identifier">real_name</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:real_name</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">name</span>
585
- 122: <span class="ruby-identifier">accessor_can_be_defined_at</span> <span class="ruby-identifier">name</span>
586
- 123:
587
- 124: <span class="ruby-comment cmt"># define the writer:</span>
588
- 125: <span class="ruby-identifier">define_method</span>(<span class="ruby-node">&quot;#{name}=&quot;</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
589
- 126: <span class="ruby-keyword kw">if</span>(<span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value">:writer</span>].<span class="ruby-identifier">nil?</span>)
590
- 127: <span class="ruby-identifier">value</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:writer</span>], <span class="ruby-identifier">value</span>)
591
- 128: <span class="ruby-keyword kw">end</span>
592
- 129: <span class="ruby-identifier">param_hash</span>[<span class="ruby-identifier">real_name</span>].<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>
593
- 130: <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">&quot;@#{name}&quot;</span>, <span class="ruby-identifier">value</span>)
594
- 131: <span class="ruby-keyword kw">end</span>
595
- 132:
596
- 133: <span class="ruby-comment cmt"># define the reader:</span>
597
- 134: <span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">do</span>
598
- 135: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:reader</span>].<span class="ruby-identifier">nil?</span>)
599
- 136: <span class="ruby-keyword kw">if</span>(<span class="ruby-identifier">param_hash</span>[<span class="ruby-identifier">real_name</span>].<span class="ruby-identifier">nil?</span>)
600
- 137: <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">UsageError</span>.<span class="ruby-identifier">new</span> <span class="ruby-node">&quot;Unable to use requested parameter (#{real_name}) try adding it using:\n\n add_param :#{real_name}, String\n\n&quot;</span>
601
- 138: <span class="ruby-keyword kw">end</span>
602
- 139: <span class="ruby-identifier">param_hash</span>[<span class="ruby-identifier">real_name</span>].<span class="ruby-identifier">value</span>
603
- 140: <span class="ruby-keyword kw">else</span>
604
- 141: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:reader</span>])
605
- 142: <span class="ruby-keyword kw">end</span>
606
- 143: <span class="ruby-keyword kw">end</span>
607
- 144: <span class="ruby-keyword kw">end</span></pre>
608
- </div>
609
-
610
- </div>
611
-
612
-
613
-
614
-
615
- </div>
616
-
617
-
618
- <div id="instance-defines--method" class="method-detail ">
619
- <a name="method-i-instance_defines%3F"></a>
620
-
621
- <div class="method-heading">
622
-
623
- <span class="method-name">instance_defines?</span><span
624
- class="method-args">(name)</span>
625
- <span class="method-click-advice">click to toggle source</span>
626
-
627
- </div>
628
-
629
- <div class="method-description">
630
-
631
-
632
-
633
-
634
-
635
- <div class="method-source-code"
636
- id="instance-defines--source">
637
- <pre>
638
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 146</span>
639
- 146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">instance_defines?</span> <span class="ruby-identifier">name</span>
640
- 147: <span class="ruby-comment cmt"># In Ruby 1.9.1 instance_methods are symbols,</span>
641
- 148: <span class="ruby-comment cmt"># In Ruby 1.8.7 instance_methods are strings.</span>
642
- 149: <span class="ruby-comment cmt"># Boo.</span>
643
- 150: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance_methods</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-operator">||</span>
644
- 151: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">instance_methods</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">name</span>)
645
- 152: <span class="ruby-keyword kw">end</span></pre>
646
- </div>
647
-
648
- </div>
649
-
650
-
651
-
652
-
653
- </div>
654
-
655
-
656
- <div id="set-default-value-method" class="method-detail ">
657
- <a name="method-i-set_default_value"></a>
658
-
659
- <div class="method-heading">
660
-
661
- <span class="method-name">set_default_value</span><span
662
- class="method-args">(key, value)</span>
663
- <span class="method-click-advice">click to toggle source</span>
664
-
665
- </div>
666
-
667
- <div class="method-description">
668
-
669
-
670
-
671
-
672
-
673
- <div class="method-source-code"
674
- id="set-default-value-source">
675
- <pre>
676
- <span class="ruby-comment cmt"># File lib/sprout/executable.rb, line 154</span>
677
- 154: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_default_value</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>
678
- 155: <span class="ruby-keyword kw">if</span>(<span class="ruby-operator">!</span><span class="ruby-keyword kw">defined?</span> <span class="ruby-identifier">key</span>)
679
- 156: <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">UsageError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;Cannot set default value (#{value}) for unknown parameter (#{key})&quot;</span>)
680
- 157: <span class="ruby-keyword kw">end</span>
681
- 158: <span class="ruby-identifier">static_default_value_collection</span> <span class="ruby-operator">&lt;&lt;</span> { <span class="ruby-value">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">key</span>, <span class="ruby-value">:value</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">value</span> }
682
- 159: <span class="ruby-keyword kw">end</span></pre>
683
- </div>
684
-
685
- </div>
686
-
687
-
688
-
689
-
690
- </div>
691
-
692
-
693
- </div>
694
-
695
-
696
- </div>
697
-
698
-
699
- <div id="rdoc-debugging-section-dump" class="debugging-section">
700
-
701
- <p>Disabled; run with --debug to generate this.</p>
702
-
703
- </div>
704
-
705
- <div id="validator-badges">
706
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
707
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
708
- Rdoc Generator</a> 1.1.6</small>.</p>
709
- </div>
710
-
711
- </body>
712
- </html>
713
-