sprout 1.1.17.pre → 1.1.18.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 (111) hide show
  1. data/VERSION +1 -1
  2. data/doc/Dir.html +313 -0
  3. data/doc/Rake/Task.html +206 -0
  4. data/doc/Sprout.html +778 -0
  5. data/doc/Sprout/ArchiveUnpacker.html +1313 -0
  6. data/doc/Sprout/CommandLine.html +521 -0
  7. data/doc/Sprout/Concern.html +382 -0
  8. data/doc/Sprout/Errors.html +120 -0
  9. data/doc/Sprout/Errors/ArchiveUnpackerError.html +139 -0
  10. data/doc/Sprout/Errors/DestinationExistsError.html +143 -0
  11. data/doc/Sprout/Errors/DuplicateMemberError.html +142 -0
  12. data/doc/Sprout/Errors/ExecutableError.html +139 -0
  13. data/doc/Sprout/Errors/ExecutableRegistrationError.html +142 -0
  14. data/doc/Sprout/Errors/ExecutionError.html +135 -0
  15. data/doc/Sprout/Errors/GeneratorError.html +139 -0
  16. data/doc/Sprout/Errors/InvalidArgumentError.html +142 -0
  17. data/doc/Sprout/Errors/LoadError.html +135 -0
  18. data/doc/Sprout/Errors/MissingArgumentError.html +142 -0
  19. data/doc/Sprout/Errors/MissingExecutableError.html +142 -0
  20. data/doc/Sprout/Errors/MissingGeneratorError.html +142 -0
  21. data/doc/Sprout/Errors/MissingTemplateError.html +142 -0
  22. data/doc/Sprout/Errors/ProcessRunnerError.html +135 -0
  23. data/doc/Sprout/Errors/RemoteFileLoaderError.html +128 -0
  24. data/doc/Sprout/Errors/SproutError.html +132 -0
  25. data/doc/Sprout/Errors/UnknownArchiveType.html +136 -0
  26. data/doc/Sprout/Errors/UsageError.html +135 -0
  27. data/doc/Sprout/Errors/ValidationError.html +135 -0
  28. data/doc/Sprout/Errors/VersionRequirementNotMetError.html +135 -0
  29. data/doc/Sprout/Executable.html +183 -0
  30. data/doc/Sprout/Executable/Base.html +2986 -0
  31. data/doc/Sprout/Executable/Boolean.html +577 -0
  32. data/doc/Sprout/Executable/CollectionParam.html +521 -0
  33. data/doc/Sprout/Executable/FileParam.html +517 -0
  34. data/doc/Sprout/Executable/Files.html +311 -0
  35. data/doc/Sprout/Executable/Number.html +164 -0
  36. data/doc/Sprout/Executable/Param.html +3011 -0
  37. data/doc/Sprout/Executable/ParameterFactory.html +262 -0
  38. data/doc/Sprout/Executable/Path.html +247 -0
  39. data/doc/Sprout/Executable/Paths.html +268 -0
  40. data/doc/Sprout/Executable/Session.html +1587 -0
  41. data/doc/Sprout/Executable/StringParam.html +237 -0
  42. data/doc/Sprout/Executable/Strings.html +186 -0
  43. data/doc/Sprout/Executable/Url.html +180 -0
  44. data/doc/Sprout/Executable/Urls.html +185 -0
  45. data/doc/Sprout/FileTarget.html +1170 -0
  46. data/doc/Sprout/Generator.html +800 -0
  47. data/doc/Sprout/Generator/Base.html +1834 -0
  48. data/doc/Sprout/Generator/Command.html +716 -0
  49. data/doc/Sprout/Generator/DirectoryManifest.html +503 -0
  50. data/doc/Sprout/Generator/FileManifest.html +667 -0
  51. data/doc/Sprout/Generator/Manifest.html +403 -0
  52. data/doc/Sprout/Generator/TemplateManifest.html +213 -0
  53. data/doc/Sprout/GeneratorGenerator.html +990 -0
  54. data/doc/Sprout/Library.html +1259 -0
  55. data/doc/Sprout/LibraryGenerator.html +326 -0
  56. data/doc/Sprout/OutputBuffer.html +461 -0
  57. data/doc/Sprout/Platform.html +758 -0
  58. data/doc/Sprout/ProcessRunner.html +1801 -0
  59. data/doc/Sprout/ProgressBar.html +384 -0
  60. data/doc/Sprout/ProgressBarImpl.html +2151 -0
  61. data/doc/Sprout/ProgressBarManager.html +443 -0
  62. data/doc/Sprout/ProgressBarOutputStream.html +429 -0
  63. data/doc/Sprout/RDocParser.html +228 -0
  64. data/doc/Sprout/RemoteFileLoader.html +191 -0
  65. data/doc/Sprout/RemoteFileTarget.html +710 -0
  66. data/doc/Sprout/ReversedProgressBar.html +200 -0
  67. data/doc/Sprout/RubyFeature.html +176 -0
  68. data/doc/Sprout/RubyFeature/ClassMethods.html +1099 -0
  69. data/doc/Sprout/RubyGenerator.html +712 -0
  70. data/doc/Sprout/Specification.html +838 -0
  71. data/doc/Sprout/System.html +212 -0
  72. data/doc/Sprout/System/BaseSystem.html +1732 -0
  73. data/doc/Sprout/System/JavaSystem.html +137 -0
  74. data/doc/Sprout/System/OSXSystem.html +345 -0
  75. data/doc/Sprout/System/ThreadMock.html +201 -0
  76. data/doc/Sprout/System/UnixSystem.html +610 -0
  77. data/doc/Sprout/System/VistaSystem.html +263 -0
  78. data/doc/Sprout/System/WinNixSystem.html +340 -0
  79. data/doc/Sprout/System/WinSystem.html +590 -0
  80. data/doc/Sprout/TestHelper.html +2280 -0
  81. data/doc/Sprout/ToolGenerator.html +995 -0
  82. data/doc/Sprout/VERSION.html +135 -0
  83. data/doc/String.html +313 -0
  84. data/doc/_index.html +829 -0
  85. data/doc/class_list.html +47 -0
  86. data/doc/css/common.css +1 -0
  87. data/doc/css/full_list.css +55 -0
  88. data/doc/css/style.css +322 -0
  89. data/doc/file.README.html +109 -0
  90. data/doc/file_list.html +49 -0
  91. data/doc/frames.html +13 -0
  92. data/doc/index.html +109 -0
  93. data/doc/js/app.js +205 -0
  94. data/doc/js/full_list.js +173 -0
  95. data/doc/js/jquery.js +16 -0
  96. data/doc/method_list.html +3622 -0
  97. data/doc/top-level-namespace.html +220 -0
  98. data/lib/sprout/generators/generator/generator_generator.rb +3 -3
  99. data/lib/sprout/generators/generator/templates/{generator_class.rb → generator_class.erb} +0 -0
  100. data/lib/sprout/generators/generator/templates/{generator_test.rb → generator_test.erb} +0 -0
  101. data/lib/sprout/generators/generator/templates/{generator_test_helper.rb → generator_test_helper.erb} +0 -0
  102. data/lib/sprout/generators/library/library_generator.rb +1 -1
  103. data/lib/sprout/generators/library/templates/{library.rb → library.erb} +0 -0
  104. data/lib/sprout/generators/ruby/ruby_generator.rb +4 -5
  105. data/lib/sprout/generators/ruby/templates/{ruby_base.rb → ruby_base.erb} +0 -0
  106. data/lib/sprout/generators/ruby/templates/{ruby_input.rb → ruby_input.erb} +0 -0
  107. data/lib/sprout/generators/ruby/templates/{ruby_test_case.rb → ruby_test_case.erb} +0 -0
  108. data/lib/sprout/generators/ruby/templates/{ruby_test_helper.rb → ruby_test_helper.erb} +0 -0
  109. data/lib/sprout/generators/tool/templates/{tool.rb → tool.erb} +0 -2
  110. data/lib/sprout/generators/tool/tool_generator.rb +1 -1
  111. metadata +128 -32
data/doc/Sprout/Executable/Boolean.html ADDED
@@ -0,0 +1,577 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Sprout::Executable::Boolean
8
+
9
+ &mdash; Sprouts v.1.0.34.pre
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '../..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../../_index.html">Index (B)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Sprout.html" title="Sprout (module)">Sprout</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Executable.html" title="Sprout::Executable (module)">Executable</a></span></span>
38
+ &raquo;
39
+ <span class="title">Boolean</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: Sprout::Executable::Boolean
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName"><span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next"><span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></li>
75
+
76
+ <li class="next">Sprout::Executable::Boolean</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/sprout/executable/boolean.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+ <h2>Overview</h2><div class="docstring">
98
+ <div class="discussion">
99
+ <p>
100
+ Concrete Sprout::Executable::Param object for Boolean values.
101
+ </p>
102
+ <p>
103
+ By default Boolean parameters have their value set to false and
104
+ :hidden_value set to true. This means that when they are serialized to the
105
+ shell, they will usually be represented like:
106
+ </p>
107
+ <pre class="code ruby"><code>
108
+ <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_name'>name</span>
109
+ </code></pre>
110
+ <p>
111
+ Rather than:
112
+ </p>
113
+ <pre class="code ruby"><code>
114
+ <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_name'>name</span><span class='op'>=</span><span class='kw'>true</span>
115
+ </code></pre>
116
+ <p>
117
+ The following example demonstrates a simple use of the Boolean parameter:
118
+ </p>
119
+ <pre class="code ruby"><code>
120
+ <span class='kw'>class</span> <span class='const'>Foo</span>
121
+ <span class='id identifier rubyid_include'>include</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Executable</span>
122
+
123
+ <span class='id identifier rubyid_add_param'>add_param</span> <span class='symbol'>:visible</span><span class='comma'>,</span> <span class='const'>Boolean</span>
124
+ <span class='kw'>end</span></code></pre>
125
+
126
+
127
+ </div>
128
+ </div>
129
+ <div class="tags">
130
+
131
+
132
+ <h3>See Also:</h3>
133
+ <ul class="see">
134
+
135
+ <li><span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></li>
136
+
137
+ </ul>
138
+
139
+ </div>
140
+ <h2>Constant Summary</h2>
141
+
142
+
143
+
144
+
145
+ <h2>Constant Summary</h2>
146
+
147
+ <h3 class="inherited">Constants inherited
148
+ from <span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></h3>
149
+ <p class="inherited"><span class='object_link'><a href="Param.html#DEFAULT_DELIMITER-constant" title="Sprout::Executable::Param::DEFAULT_DELIMITER (constant)">Param::DEFAULT_DELIMITER</a></span>, <span class='object_link'><a href="Param.html#DEFAULT_OPTION_PARSER_TYPE_NAME-constant" title="Sprout::Executable::Param::DEFAULT_OPTION_PARSER_TYPE_NAME (constant)">Param::DEFAULT_OPTION_PARSER_TYPE_NAME</a></span>, <span class='object_link'><a href="Param.html#DEFAULT_PREFIX-constant" title="Sprout::Executable::Param::DEFAULT_PREFIX (constant)">Param::DEFAULT_PREFIX</a></span>, <span class='object_link'><a href="Param.html#DEFAULT_SHORT_PREFIX-constant" title="Sprout::Executable::Param::DEFAULT_SHORT_PREFIX (constant)">Param::DEFAULT_SHORT_PREFIX</a></span></p>
150
+
151
+
152
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
153
+ <ul class="summary">
154
+
155
+ <li class="public ">
156
+ <span class="summary_signature">
157
+
158
+ <a href="#show_on_false-instance_method" title="#show_on_false (instance method)">- (Object) <strong>show_on_false</strong> </a>
159
+
160
+
161
+
162
+ </span>
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'><p>
175
+ By default, the Boolean parameter will only be displayed when it&#8217;s
176
+ value is <tt>true</tt>.
177
+ </p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ </ul>
184
+
185
+
186
+
187
+
188
+
189
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></h3>
190
+ <p class="inherited"><span class='object_link'><a href="Param.html#belongs_to-instance_method" title="Sprout::Executable::Param#belongs_to (method)">#belongs_to</a></span>, <span class='object_link'><a href="Param.html#delimiter-instance_method" title="Sprout::Executable::Param#delimiter (method)">#delimiter</a></span>, <span class='object_link'><a href="Param.html#description-instance_method" title="Sprout::Executable::Param#description (method)">#description</a></span>, <span class='object_link'><a href="Param.html#file_expression-instance_method" title="Sprout::Executable::Param#file_expression (method)">#file_expression</a></span>, <span class='object_link'><a href="Param.html#hidden_name-instance_method" title="Sprout::Executable::Param#hidden_name (method)">#hidden_name</a></span>, <span class='object_link'><a href="Param.html#hidden_value-instance_method" title="Sprout::Executable::Param#hidden_value (method)">#hidden_value</a></span>, <span class='object_link'><a href="Param.html#name-instance_method" title="Sprout::Executable::Param#name (method)">#name</a></span>, <span class='object_link'><a href="Param.html#prefix-instance_method" title="Sprout::Executable::Param#prefix (method)">#prefix</a></span>, <span class='object_link'><a href="Param.html#reader-instance_method" title="Sprout::Executable::Param#reader (method)">#reader</a></span>, <span class='object_link'><a href="Param.html#required-instance_method" title="Sprout::Executable::Param#required (method)">#required</a></span>, <span class='object_link'><a href="Param.html#shell_name-instance_method" title="Sprout::Executable::Param#shell_name (method)">#shell_name</a></span>, <span class='object_link'><a href="Param.html#short_name-instance_method" title="Sprout::Executable::Param#short_name (method)">#short_name</a></span>, <span class='object_link'><a href="Param.html#to_shell_proc-instance_method" title="Sprout::Executable::Param#to_shell_proc (method)">#to_shell_proc</a></span>, <span class='object_link'><a href="Param.html#type-instance_method" title="Sprout::Executable::Param#type (method)">#type</a></span>, <span class='object_link'><a href="Param.html#value-instance_method" title="Sprout::Executable::Param#value (method)">#value</a></span>, <span class='object_link'><a href="Param.html#writer-instance_method" title="Sprout::Executable::Param#writer (method)">#writer</a></span></p>
191
+
192
+
193
+
194
+ <h2>
195
+ Instance Method Summary
196
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
197
+ </h2>
198
+
199
+ <ul class="summary">
200
+
201
+ <li class="public ">
202
+ <span class="summary_signature">
203
+
204
+ <a href="#default_option_parser_declaration-instance_method" title="#default_option_parser_declaration (instance method)">- (Object) <strong>default_option_parser_declaration</strong> </a>
205
+
206
+
207
+
208
+ </span>
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+ <span class="summary_desc"><div class='inline'></div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Boolean) <strong>initialize</strong> </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+ <span class="note title constructor">constructor</span>
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+ <span class="summary_desc"><div class='inline'><p>
241
+ A new instance of Boolean.
242
+ </p>
243
+ </div></span>
244
+
245
+ </li>
246
+
247
+
248
+ <li class="public ">
249
+ <span class="summary_signature">
250
+
251
+ <a href="#value%3D-instance_method" title="#value= (instance method)">- (Object) <strong>value=</strong>(value) </a>
252
+
253
+
254
+
255
+ </span>
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+ <span class="summary_desc"><div class='inline'><p>
265
+ Convert string representations of falsiness to something more Booleaney.
266
+ </p>
267
+ </div></span>
268
+
269
+ </li>
270
+
271
+
272
+ <li class="public ">
273
+ <span class="summary_signature">
274
+
275
+ <a href="#visible%3F-instance_method" title="#visible? (instance method)">- (Boolean) <strong>visible?</strong> </a>
276
+
277
+
278
+
279
+ </span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ <span class="summary_desc"><div class='inline'></div></span>
289
+
290
+ </li>
291
+
292
+
293
+ </ul>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Param.html" title="Sprout::Executable::Param (class)">Param</a></span></h3>
305
+ <p class="inherited"><span class='object_link'><a href="Param.html#clean_path-instance_method" title="Sprout::Executable::Param#clean_path (method)">#clean_path</a></span>, <span class='object_link'><a href="Param.html#default-instance_method" title="Sprout::Executable::Param#default (method)">#default</a></span>, <span class='object_link'><a href="Param.html#default%3D-instance_method" title="Sprout::Executable::Param#default= (method)">#default=</a></span>, <span class='object_link'><a href="Param.html#file_is_output%3F-instance_method" title="Sprout::Executable::Param#file_is_output? (method)">#file_is_output?</a></span>, <span class='object_link'><a href="Param.html#hidden_name%3F-instance_method" title="Sprout::Executable::Param#hidden_name? (method)">#hidden_name?</a></span>, <span class='object_link'><a href="Param.html#hidden_value%3F-instance_method" title="Sprout::Executable::Param#hidden_value? (method)">#hidden_value?</a></span>, <span class='object_link'><a href="Param.html#option_parser_declaration-instance_method" title="Sprout::Executable::Param#option_parser_declaration (method)">#option_parser_declaration</a></span>, <span class='object_link'><a href="Param.html#option_parser_name-instance_method" title="Sprout::Executable::Param#option_parser_name (method)">#option_parser_name</a></span>, <span class='object_link'><a href="Param.html#option_parser_short_name-instance_method" title="Sprout::Executable::Param#option_parser_short_name (method)">#option_parser_short_name</a></span>, <span class='object_link'><a href="Param.html#option_parser_type_name-instance_method" title="Sprout::Executable::Param#option_parser_type_name (method)">#option_parser_type_name</a></span>, <span class='object_link'><a href="Param.html#option_parser_type_output-instance_method" title="Sprout::Executable::Param#option_parser_type_output (method)">#option_parser_type_output</a></span>, <span class='object_link'><a href="Param.html#prepare-instance_method" title="Sprout::Executable::Param#prepare (method)">#prepare</a></span>, <span class='object_link'><a href="Param.html#prepare_prerequisites-instance_method" title="Sprout::Executable::Param#prepare_prerequisites (method)">#prepare_prerequisites</a></span>, <span class='object_link'><a href="Param.html#prepared%3F-instance_method" title="Sprout::Executable::Param#prepared? (method)">#prepared?</a></span>, <span class='object_link'><a href="Param.html#required%3F-instance_method" title="Sprout::Executable::Param#required? (method)">#required?</a></span>, <span class='object_link'><a href="Param.html#shell_value-instance_method" title="Sprout::Executable::Param#shell_value (method)">#shell_value</a></span>, <span class='object_link'><a href="Param.html#short_prefix-instance_method" title="Sprout::Executable::Param#short_prefix (method)">#short_prefix</a></span>, <span class='object_link'><a href="Param.html#to_rdoc-instance_method" title="Sprout::Executable::Param#to_rdoc (method)">#to_rdoc</a></span>, <span class='object_link'><a href="Param.html#to_shell-instance_method" title="Sprout::Executable::Param#to_shell (method)">#to_shell</a></span>, <span class='object_link'><a href="Param.html#validate-instance_method" title="Sprout::Executable::Param#validate (method)">#validate</a></span></p>
306
+ <div id="constructor_details" class="method_details_list">
307
+ <h2>Constructor Details</h2>
308
+
309
+ <div class="method_details first">
310
+ <p class="signature first" id="initialize-instance_method">
311
+
312
+ - (<tt><span class='object_link'><a href="" title="Sprout::Executable::Boolean (class)">Boolean</a></span></tt>) <strong>initialize</strong>
313
+
314
+
315
+
316
+ </p><div class="docstring">
317
+ <div class="discussion">
318
+ <p>
319
+ A new instance of Boolean
320
+ </p>
321
+
322
+
323
+ </div>
324
+ </div>
325
+ <div class="tags">
326
+
327
+
328
+ </div><table class="source_code">
329
+ <tr>
330
+ <td>
331
+ <pre class="lines">
332
+
333
+
334
+ 52
335
+ 53
336
+ 54
337
+ 55
338
+ 56
339
+ 57
340
+ 58
341
+ 59</pre>
342
+ </td>
343
+ <td>
344
+ <pre class="code"><span class="info file"># File 'lib/sprout/executable/boolean.rb', line 52</span>
345
+
346
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
347
+ <span class='kw'>super</span>
348
+ <span class='ivar'>@delimiter</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span>
349
+ <span class='ivar'>@option_parser_type_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BOOL</span><span class='tstring_end'>'</span></span>
350
+ <span class='ivar'>@show_on_false</span> <span class='op'>=</span> <span class='kw'>false</span>
351
+ <span class='ivar'>@value</span> <span class='op'>=</span> <span class='kw'>false</span>
352
+ <span class='ivar'>@hidden_value</span> <span class='op'>=</span> <span class='kw'>true</span>
353
+ <span class='kw'>end</span></pre>
354
+ </td>
355
+ </tr>
356
+ </table>
357
+ </div>
358
+
359
+ </div>
360
+
361
+ <div id="instance_attr_details" class="attr_details">
362
+ <h2>Instance Attribute Details</h2>
363
+
364
+
365
+ <span id="show_on_false=-instance_method"></span>
366
+ <span id="show_on_false-instance_method"></span>
367
+ <div class="method_details first">
368
+ <p class="signature first" id="show_on_false-instance_method">
369
+
370
+ - (<tt>Object</tt>) <strong>show_on_false</strong>
371
+
372
+
373
+
374
+ </p><div class="docstring">
375
+ <div class="discussion">
376
+ <p>
377
+ By default, the Boolean parameter will only be displayed when it&#8217;s
378
+ value is <tt>true</tt>.
379
+ </p>
380
+ <p>
381
+ Set :show_on_false to true in order to reverse this rule.
382
+ </p>
383
+ <pre class="code ruby"><code>
384
+ <span class='id identifier rubyid_add_param'>add_param</span> <span class='symbol'>:visible</span><span class='comma'>,</span> <span class='const'>Boolean</span><span class='comma'>,</span> <span class='symbol'>:show_on_false</span> <span class='op'>=&gt;</span> <span class='kw'>true</span>
385
+ </code></pre>
386
+ <p>
387
+ Will make the following:
388
+ </p>
389
+ <pre class="code ruby"><code>
390
+ <span class='id identifier rubyid_foo'>foo</span> <span class='symbol'>:name</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
391
+ <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_visible'>visible</span> <span class='op'>=</span> <span class='kw'>false</span>
392
+ <span class='kw'>end</span>
393
+ </code></pre>
394
+ <p>
395
+ Serialize to the shell with:
396
+ </p>
397
+ <pre class="code ruby"><code>
398
+ <span class='id identifier rubyid_foo'>foo</span> <span class='op'>-</span><span class='id identifier rubyid_visible'>visible</span><span class='op'>=</span><span class='kw'>false</span></code></pre>
399
+
400
+
401
+ </div>
402
+ </div>
403
+ <div class="tags">
404
+
405
+
406
+ </div><table class="source_code">
407
+ <tr>
408
+ <td>
409
+ <pre class="lines">
410
+
411
+
412
+ 50
413
+ 51
414
+ 52</pre>
415
+ </td>
416
+ <td>
417
+ <pre class="code"><span class="info file"># File 'lib/sprout/executable/boolean.rb', line 50</span>
418
+
419
+ <span class='kw'>def</span> <span class='id identifier rubyid_show_on_false'>show_on_false</span>
420
+ <span class='ivar'>@show_on_false</span>
421
+ <span class='kw'>end</span></pre>
422
+ </td>
423
+ </tr>
424
+ </table>
425
+ </div>
426
+
427
+ </div>
428
+
429
+
430
+ <div id="instance_method_details" class="method_details_list">
431
+ <h2>Instance Method Details</h2>
432
+
433
+
434
+ <div class="method_details first">
435
+ <p class="signature first" id="default_option_parser_declaration-instance_method">
436
+
437
+ - (<tt>Object</tt>) <strong>default_option_parser_declaration</strong>
438
+
439
+
440
+
441
+ </p><table class="source_code">
442
+ <tr>
443
+ <td>
444
+ <pre class="lines">
445
+
446
+
447
+ 61
448
+ 62
449
+ 63
450
+ 64</pre>
451
+ </td>
452
+ <td>
453
+ <pre class="code"><span class="info file"># File 'lib/sprout/executable/boolean.rb', line 61</span>
454
+
455
+ <span class='kw'>def</span> <span class='id identifier rubyid_default_option_parser_declaration'>default_option_parser_declaration</span>
456
+ <span class='kw'>return</span> <span class='lbracket'>[</span><span class='id identifier rubyid_prefix'>prefix</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>[no-]</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_option_parser_name'>option_parser_name</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>==</span> <span class='kw'>true</span>
457
+ <span class='kw'>super</span>
458
+ <span class='kw'>end</span></pre>
459
+ </td>
460
+ </tr>
461
+ </table>
462
+ </div>
463
+
464
+ <div class="method_details ">
465
+ <p class="signature " id="value=-instance_method">
466
+
467
+ - (<tt>Object</tt>) <strong>value=</strong>(value)
468
+
469
+
470
+
471
+ </p><div class="docstring">
472
+ <div class="discussion">
473
+ <p>
474
+ Convert string representations of falsiness to something more Booleaney.
475
+ </p>
476
+
477
+
478
+ </div>
479
+ </div>
480
+ <div class="tags">
481
+
482
+
483
+ </div><table class="source_code">
484
+ <tr>
485
+ <td>
486
+ <pre class="lines">
487
+
488
+
489
+ 69
490
+ 70
491
+ 71
492
+ 72</pre>
493
+ </td>
494
+ <td>
495
+ <pre class="code"><span class="info file"># File 'lib/sprout/executable/boolean.rb', line 69</span>
496
+
497
+ <span class='kw'>def</span> <span class='id identifier rubyid_value='>value=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
498
+ <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>false</span><span class='tstring_end'>&quot;</span></span> <span class='op'>||</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='kw'>true</span>
499
+ <span class='kw'>super</span> <span class='id identifier rubyid_value'>value</span>
500
+ <span class='kw'>end</span></pre>
501
+ </td>
502
+ </tr>
503
+ </table>
504
+ </div>
505
+
506
+ <div class="method_details ">
507
+ <p class="signature " id="visible?-instance_method">
508
+
509
+ - (<tt><span class='object_link'><a href="" title="Sprout::Executable::Boolean (class)">Boolean</a></span></tt>) <strong>visible?</strong>
510
+
511
+
512
+
513
+ </p><div class="docstring">
514
+ <div class="discussion">
515
+
516
+
517
+ </div>
518
+ </div>
519
+ <div class="tags">
520
+
521
+ <h3>Returns:</h3>
522
+ <ul class="return">
523
+
524
+ <li>
525
+
526
+
527
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Sprout::Executable::Boolean (class)">Boolean</a></span></tt>)</span>
528
+
529
+
530
+
531
+ </li>
532
+
533
+ </ul>
534
+
535
+ </div><table class="source_code">
536
+ <tr>
537
+ <td>
538
+ <pre class="lines">
539
+
540
+
541
+ 74
542
+ 75
543
+ 76
544
+ 77
545
+ 78
546
+ 79
547
+ 80
548
+ 81</pre>
549
+ </td>
550
+ <td>
551
+ <pre class="code"><span class="info file"># File 'lib/sprout/executable/boolean.rb', line 74</span>
552
+
553
+ <span class='kw'>def</span> <span class='id identifier rubyid_visible?'>visible?</span>
554
+ <span class='ivar'>@visible</span> <span class='op'>||=</span> <span class='id identifier rubyid_value'>value</span>
555
+ <span class='kw'>if</span><span class='lparen'>(</span><span class='id identifier rubyid_show_on_false'>show_on_false</span><span class='rparen'>)</span>
556
+ <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span>
557
+ <span class='kw'>else</span>
558
+ <span class='kw'>return</span> <span class='ivar'>@visible</span>
559
+ <span class='kw'>end</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+ </div>
567
+
568
+ </div>
569
+
570
+ <div id="footer">
571
+ Generated on Sun Mar 11 14:30:34 2012 by
572
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
573
+ 0.7.5 (ruby-1.9.2).
574
+ </div>
575
+
576
+ </body>
577
+ </html>