sprout 1.0.32.pre → 1.0.35.pre

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

Potentially problematic release.


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

Files changed (208) hide show
  1. data/Gemfile +2 -1
  2. data/Gemfile.lock +4 -2
  3. data/README.textile +12 -13
  4. data/VERSION +1 -0
  5. data/doc/Dir.html +288 -0
  6. data/doc/Rake/Task.html +184 -0
  7. data/doc/Sprout.html +144 -0
  8. data/doc/Sprout/ArchiveUnpacker.html +1246 -0
  9. data/doc/Sprout/Base.html +126 -0
  10. data/doc/Sprout/Base/ClassMethods.html +434 -0
  11. data/doc/Sprout/Concern.html +353 -0
  12. data/doc/Sprout/Daemon.html +166 -0
  13. data/doc/Sprout/Daemon/ClassMethods.html +244 -0
  14. data/doc/Sprout/Daemon/InstanceMethods.html +601 -0
  15. data/doc/Sprout/Errors.html +101 -0
  16. data/doc/Sprout/Errors/ArchiveUnpackerError.html +125 -0
  17. data/doc/Sprout/Errors/DestinationExistsError.html +133 -0
  18. data/doc/Sprout/Errors/DuplicateMemberError.html +132 -0
  19. data/doc/Sprout/Errors/ExecutableError.html +125 -0
  20. data/doc/Sprout/Errors/ExecutableRegistrationError.html +132 -0
  21. data/doc/Sprout/Errors/ExecutionError.html +121 -0
  22. data/doc/Sprout/Errors/GeneratorError.html +125 -0
  23. data/doc/Sprout/Errors/InvalidArgumentError.html +132 -0
  24. data/doc/Sprout/Errors/LoadError.html +121 -0
  25. data/doc/Sprout/Errors/MissingArgumentError.html +132 -0
  26. data/doc/Sprout/Errors/MissingExecutableError.html +132 -0
  27. data/doc/Sprout/Errors/MissingGeneratorError.html +132 -0
  28. data/doc/Sprout/Errors/MissingTemplateError.html +132 -0
  29. data/doc/Sprout/Errors/ProcessRunnerError.html +121 -0
  30. data/doc/Sprout/Errors/RemoteFileLoaderError.html +110 -0
  31. data/doc/Sprout/Errors/SproutError.html +114 -0
  32. data/doc/Sprout/Errors/UnknownArchiveType.html +122 -0
  33. data/doc/Sprout/Errors/UsageError.html +121 -0
  34. data/doc/Sprout/Errors/ValidationError.html +121 -0
  35. data/doc/Sprout/Errors/VersionRequirementNotMetError.html +121 -0
  36. data/doc/Sprout/Executable.html +173 -0
  37. data/doc/Sprout/Executable/Boolean.html +483 -0
  38. data/doc/Sprout/Executable/ClassMethods.html +417 -0
  39. data/doc/Sprout/Executable/CollectionParam.html +483 -0
  40. data/doc/Sprout/Executable/FileParam.html +484 -0
  41. data/doc/Sprout/Executable/Files.html +292 -0
  42. data/doc/Sprout/Executable/InstanceMethods.html +2006 -0
  43. data/doc/Sprout/Executable/Number.html +141 -0
  44. data/doc/Sprout/Executable/Param.html +2818 -0
  45. data/doc/Sprout/Executable/ParameterFactory.html +232 -0
  46. data/doc/Sprout/Executable/Path.html +223 -0
  47. data/doc/Sprout/Executable/Paths.html +253 -0
  48. data/doc/Sprout/Executable/StringParam.html +213 -0
  49. data/doc/Sprout/Executable/Strings.html +167 -0
  50. data/doc/Sprout/Executable/Url.html +160 -0
  51. data/doc/Sprout/Executable/Urls.html +170 -0
  52. data/doc/Sprout/FileTarget.html +1109 -0
  53. data/doc/Sprout/Generator.html +689 -0
  54. data/doc/Sprout/Generator/Base.html +1626 -0
  55. data/doc/Sprout/Generator/Command.html +690 -0
  56. data/doc/Sprout/Generator/DirectoryManifest.html +476 -0
  57. data/doc/Sprout/Generator/FileManifest.html +572 -0
  58. data/doc/Sprout/Generator/Manifest.html +377 -0
  59. data/doc/Sprout/Generator/TemplateManifest.html +196 -0
  60. data/doc/Sprout/GeneratorGenerator.html +1018 -0
  61. data/doc/Sprout/Library.html +1141 -0
  62. data/doc/Sprout/LibraryGenerator.html +309 -0
  63. data/doc/Sprout/Log.html +496 -0
  64. data/doc/Sprout/MXMLC.html +6373 -0
  65. data/doc/Sprout/Platform.html +714 -0
  66. data/doc/Sprout/ProcessRunner.html +1352 -0
  67. data/doc/Sprout/ProgressBar.html +376 -0
  68. data/doc/Sprout/ProgressBarImpl.html +2119 -0
  69. data/doc/Sprout/ProgressBarManager.html +434 -0
  70. data/doc/Sprout/ProgressBarOutputStream.html +416 -0
  71. data/doc/Sprout/RDocParser.html +211 -0
  72. data/doc/Sprout/RemoteFileLoader.html +172 -0
  73. data/doc/Sprout/RemoteFileTarget.html +679 -0
  74. data/doc/Sprout/ReversedProgressBar.html +194 -0
  75. data/doc/Sprout/RubyFeature.html +155 -0
  76. data/doc/Sprout/RubyFeature/ClassMethods.html +1065 -0
  77. data/doc/Sprout/RubyGenerator.html +764 -0
  78. data/doc/Sprout/Specification.html +767 -0
  79. data/doc/Sprout/System.html +191 -0
  80. data/doc/Sprout/System/BaseSystem.html +1455 -0
  81. data/doc/Sprout/System/JavaSystem.html +122 -0
  82. data/doc/Sprout/System/OSXSystem.html +335 -0
  83. data/doc/Sprout/System/ThreadMock.html +193 -0
  84. data/doc/Sprout/System/UnixSystem.html +584 -0
  85. data/doc/Sprout/System/VistaSystem.html +251 -0
  86. data/doc/Sprout/System/WinNixSystem.html +325 -0
  87. data/doc/Sprout/System/WinSystem.html +571 -0
  88. data/doc/Sprout/ToolGenerator.html +931 -0
  89. data/doc/Sprout/VERSION.html +128 -0
  90. data/doc/SproutTestCase.html +1412 -0
  91. data/doc/String.html +286 -0
  92. data/doc/_index.html +1035 -0
  93. data/doc/class_list.html +36 -0
  94. data/doc/css/common.css +1 -0
  95. data/doc/css/full_list.css +53 -0
  96. data/doc/css/style.css +310 -0
  97. data/doc/file.README.html +96 -0
  98. data/doc/file.archive_unpacker.html +288 -0
  99. data/doc/file.base.html +208 -0
  100. data/doc/file.base_system.html +278 -0
  101. data/doc/file.boolean.html +135 -0
  102. data/doc/file.collection_param.html +139 -0
  103. data/doc/file.command.html +126 -0
  104. data/doc/file.concern.html +136 -0
  105. data/doc/file.daemon.html +309 -0
  106. data/doc/file.dir.html +76 -0
  107. data/doc/file.directory_manifest.html +122 -0
  108. data/doc/file.errors.html +147 -0
  109. data/doc/file.executable.html +638 -0
  110. data/doc/file.file_manifest.html +109 -0
  111. data/doc/file.file_param.html +120 -0
  112. data/doc/file.file_target.html +140 -0
  113. data/doc/file.files.html +85 -0
  114. data/doc/file.generator.html +296 -0
  115. data/doc/file.generator_class.html +72 -0
  116. data/doc/file.generator_generator.html +137 -0
  117. data/doc/file.generator_test.html +92 -0
  118. data/doc/file.generator_test_helper.html +67 -0
  119. data/doc/file.java_system.html +62 -0
  120. data/doc/file.library.html +291 -0
  121. data/doc/file.library_generator.html +74 -0
  122. data/doc/file.log.html +100 -0
  123. data/doc/file.manifest.html +67 -0
  124. data/doc/file.mxmlc.html +740 -0
  125. data/doc/file.number.html +67 -0
  126. data/doc/file.osx_system.html +79 -0
  127. data/doc/file.param.html +491 -0
  128. data/doc/file.parameter_factory.html +119 -0
  129. data/doc/file.path.html +81 -0
  130. data/doc/file.paths.html +80 -0
  131. data/doc/file.platform.html +124 -0
  132. data/doc/file.process_runner.html +224 -0
  133. data/doc/file.progress_bar.html +390 -0
  134. data/doc/file.rdoc_parser.html +145 -0
  135. data/doc/file.remote_file_loader.html +117 -0
  136. data/doc/file.remote_file_target.html +176 -0
  137. data/doc/file.ruby_base.html +64 -0
  138. data/doc/file.ruby_feature.html +244 -0
  139. data/doc/file.ruby_generator.html +118 -0
  140. data/doc/file.ruby_input.html +62 -0
  141. data/doc/file.ruby_test_case.html +78 -0
  142. data/doc/file.ruby_test_helper.html +61 -0
  143. data/doc/file.specification.html +248 -0
  144. data/doc/file.sprout.html +64 -0
  145. data/doc/file.sprout_test_case.html +280 -0
  146. data/doc/file.string.html +72 -0
  147. data/doc/file.string_param.html +76 -0
  148. data/doc/file.strings.html +71 -0
  149. data/doc/file.system.html +86 -0
  150. data/doc/file.template_manifest.html +67 -0
  151. data/doc/file.tool.html +92 -0
  152. data/doc/file.tool_generator.html +90 -0
  153. data/doc/file.unix_system.html +128 -0
  154. data/doc/file.url.html +71 -0
  155. data/doc/file.urls.html +70 -0
  156. data/doc/file.version.html +71 -0
  157. data/doc/file.vista_system.html +69 -0
  158. data/doc/file.win_nix_system.html +88 -0
  159. data/doc/file.win_system.html +129 -0
  160. data/doc/file_list.html +230 -0
  161. data/doc/frames.html +13 -0
  162. data/doc/index.html +96 -0
  163. data/doc/js/app.js +202 -0
  164. data/doc/js/full_list.js +149 -0
  165. data/doc/js/jquery.js +154 -0
  166. data/doc/method_list.html +3355 -0
  167. data/doc/top-level-namespace.html +192 -0
  168. data/lib/sprout/archive_unpacker.rb +203 -137
  169. data/lib/sprout/base.rb +38 -11
  170. data/lib/sprout/concern.rb +51 -0
  171. data/lib/sprout/daemon.rb +256 -0
  172. data/lib/sprout/executable.rb +40 -11
  173. data/lib/sprout/executable/boolean.rb +47 -1
  174. data/lib/sprout/executable/collection_param.rb +33 -1
  175. data/lib/sprout/executable/file_param.rb +16 -3
  176. data/lib/sprout/executable/files.rb +5 -0
  177. data/lib/sprout/executable/number.rb +5 -1
  178. data/lib/sprout/executable/param.rb +232 -16
  179. data/lib/sprout/executable/parameter_factory.rb +39 -1
  180. data/lib/sprout/executable/path.rb +7 -1
  181. data/lib/sprout/executable/paths.rb +6 -1
  182. data/lib/sprout/executable/string_param.rb +8 -1
  183. data/lib/sprout/executable/strings.rb +7 -1
  184. data/lib/sprout/executable/url.rb +8 -1
  185. data/lib/sprout/executable/urls.rb +7 -1
  186. data/lib/sprout/file_target.rb +11 -11
  187. data/lib/sprout/generator.rb +244 -0
  188. data/lib/sprout/generator/base.rb +0 -94
  189. data/lib/sprout/generators/generator/generator_generator.rb +35 -1
  190. data/lib/sprout/generators/generator/templates/generator_class.rb +3 -3
  191. data/lib/sprout/library.rb +75 -0
  192. data/lib/sprout/log.rb +11 -12
  193. data/lib/sprout/process_runner.rb +29 -9
  194. data/lib/sprout/remote_file_target.rb +20 -9
  195. data/lib/sprout/system/base_system.rb +11 -3
  196. data/lib/sprout/test/sprout_test_case.rb +1 -0
  197. data/lib/sprout/version.rb +7 -11
  198. data/rakefile.rb +7 -12
  199. data/script/add_param_handler.rb +43 -0
  200. data/sprout.gemspec +2 -3
  201. data/test/fixtures/executable/fdb.rb +764 -0
  202. data/test/fixtures/executable/flex3sdk_gem/fdb +60 -0
  203. data/test/fixtures/executable/mxmlc.rb +9 -11
  204. data/test/unit/daemon_test.rb +61 -0
  205. data/test/unit/process_runner_test.rb +21 -0
  206. data/test/unit/remote_file_target_test.rb +45 -11
  207. data/test/unit/sprout_test_helper.rb +1 -1
  208. metadata +210 -29
@@ -0,0 +1,1109 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Class: Sprout::FileTarget</title>
7
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="../_index.html">Index (F)</a> &raquo;
27
+ <span class='title'><span class='object_link'><a href="../Sprout.html" title="Sprout (module)">Sprout</a></span></span>
28
+ &raquo;
29
+ <span class="title">FileTarget</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Class: Sprout::FileTarget
47
+
48
+
49
+
50
+ </h1>
51
+
52
+ <dl class="box">
53
+
54
+ <dt class="r1">Inherits:</dt>
55
+ <dd class="r1">
56
+ <span class="inheritName">Object</span>
57
+
58
+ <ul class="fullTree">
59
+ <li>Object</li>
60
+
61
+ <li class="next">Sprout::FileTarget</li>
62
+
63
+ </ul>
64
+ <a href="#" class="inheritanceTree">show all</a>
65
+
66
+ </dd>
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+ <dt class="r2 last">Defined in:</dt>
77
+ <dd class="r2 last">lib/sprout/file_target.rb</dd>
78
+
79
+ </dl>
80
+ <div class="clear"></div>
81
+
82
+ <h2>Overview</h2><div class="docstring">
83
+ <div class="discussion">
84
+
85
+ <p>This is a class that is generally used by the
86
+ Sprout::Specification::add_file_target method.</p>
87
+
88
+ <p>File targets are files that are embedded into (or referred to by) a RubyGem
89
+ in such a way that Sprouts can use them as a library or executable.</p>
90
+
91
+ <p>A given FileTarget may be configured to work on a specific platform, or it
92
+ may be universal.</p>
93
+
94
+
95
+ </div>
96
+ </div>
97
+ <div class="tags">
98
+
99
+ </div><div id="subclasses">
100
+ <h2>Direct Known Subclasses</h2>
101
+ <p class="children"><span class='object_link'><a href="RemoteFileTarget.html" title="Sprout::RemoteFileTarget (class)">RemoteFileTarget</a></span></p>
102
+ </div>
103
+
104
+
105
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
106
+ <ul class="summary">
107
+
108
+ <li class="public ">
109
+ <span class="summary_signature">
110
+
111
+ <a href="#executables-instance_method" title="#executables (instance method)">- (Object) <strong>executables</strong> </a>
112
+
113
+
114
+
115
+ </span>
116
+
117
+
118
+ <span class="note title readonly">readonly</span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ <span class="summary_desc"><div class='inline'>
128
+ <p>Returns the value of attribute executables.</p>
129
+ </div></span>
130
+
131
+ </li>
132
+
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#libraries-instance_method" title="#libraries (instance method)">- (Object) <strong>libraries</strong> </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+ <span class="note title readonly">readonly</span>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <span class="summary_desc"><div class='inline'>
154
+ <p>Returns the value of attribute libraries.</p>
155
+ </div></span>
156
+
157
+ </li>
158
+
159
+
160
+ <li class="public ">
161
+ <span class="summary_signature">
162
+
163
+ <a href="#load_path-instance_method" title="#load_path (instance method)">- (Object) <strong>load_path</strong> </a>
164
+
165
+
166
+
167
+ </span>
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+ <span class="summary_desc"><div class='inline'>
180
+ <p>Returns the value of attribute load_path.</p>
181
+ </div></span>
182
+
183
+ </li>
184
+
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#pkg_name-instance_method" title="#pkg_name (instance method)">- (Object) <strong>pkg_name</strong> </a>
190
+
191
+
192
+
193
+ </span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'>
206
+ <p>Returns the value of attribute pkg_name.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ <li class="public ">
213
+ <span class="summary_signature">
214
+
215
+ <a href="#pkg_version-instance_method" title="#pkg_version (instance method)">- (Object) <strong>pkg_version</strong> </a>
216
+
217
+
218
+
219
+ </span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'>
232
+ <p>Returns the value of attribute pkg_version.</p>
233
+ </div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#platform-instance_method" title="#platform (instance method)">- (Object) <strong>platform</strong> </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <span class="summary_desc"><div class='inline'>
258
+ <p>Returns the value of attribute platform.</p>
259
+ </div></span>
260
+
261
+ </li>
262
+
263
+
264
+ </ul>
265
+
266
+
267
+
268
+ <h2>
269
+ Instance Method Summary
270
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
271
+ </h2>
272
+
273
+ <ul class="summary">
274
+
275
+ <li class="public ">
276
+ <span class="summary_signature">
277
+
278
+ <a href="#add_executable-instance_method" title="#add_executable (instance method)">- (Object) <strong>add_executable</strong>(name, path) </a>
279
+
280
+
281
+
282
+ </span>
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ <span class="summary_desc"><div class='inline'>
292
+ <p>Add an executable to the RubyGem package.</p>
293
+ </div></span>
294
+
295
+ </li>
296
+
297
+
298
+ <li class="public ">
299
+ <span class="summary_signature">
300
+
301
+ <a href="#add_library-instance_method" title="#add_library (instance method)">- (Sprout::Library) <strong>add_library</strong>(name, path) </a>
302
+
303
+
304
+
305
+ </span>
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+ <span class="summary_desc"><div class='inline'>
315
+ <p>Add a library to the package.</p>
316
+ </div></span>
317
+
318
+ </li>
319
+
320
+
321
+ <li class="public ">
322
+ <span class="summary_signature">
323
+
324
+ <a href="#expand_local_path-instance_method" title="#expand_local_path (instance method)">- (Object) <strong>expand_local_path</strong>(path) </a>
325
+
326
+
327
+
328
+ </span>
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+ <span class="summary_desc"><div class='inline'>
338
+ <p>This is a template method that is overridden by RemoteFileTarget.</p>
339
+ </div></span>
340
+
341
+ </li>
342
+
343
+
344
+ <li class="public ">
345
+ <span class="summary_signature">
346
+
347
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (FileTarget) <strong>initialize</strong> {|_self| ... }</a>
348
+
349
+
350
+
351
+ </span>
352
+
353
+ <span class="note title constructor">constructor</span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+ <span class="summary_desc"><div class='inline'>
363
+ <p>A new instance of FileTarget.</p>
364
+ </div></span>
365
+
366
+ </li>
367
+
368
+
369
+ <li class="public ">
370
+ <span class="summary_signature">
371
+
372
+ <a href="#resolve-instance_method" title="#resolve (instance method)">- (Object) <strong>resolve</strong> </a>
373
+
374
+
375
+
376
+ </span>
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+ <span class="summary_desc"><div class='inline'>
386
+ <p>This is a template method that will be called so that RemoteFileTarget
387
+ subclasses and load the appropriate files at the appropriate time.</p>
388
+ </div></span>
389
+
390
+ </li>
391
+
392
+
393
+ <li class="public ">
394
+ <span class="summary_signature">
395
+
396
+ <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
397
+
398
+
399
+
400
+ </span>
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+ <span class="summary_desc"><div class='inline'></div></span>
410
+
411
+ </li>
412
+
413
+
414
+ <li class="public ">
415
+ <span class="summary_signature">
416
+
417
+ <a href="#validate-instance_method" title="#validate (instance method)">- (Object) <strong>validate</strong> </a>
418
+
419
+
420
+
421
+ </span>
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+ <span class="summary_desc"><div class='inline'></div></span>
431
+
432
+ </li>
433
+
434
+
435
+ </ul>
436
+
437
+
438
+ <div id="constructor_details" class="method_details_list">
439
+ <h2>Constructor Details</h2>
440
+
441
+ <div class="method_details first">
442
+ <p class="signature first" id="initialize-instance_method">
443
+
444
+ - (<tt><span class='object_link'><a href="" title="Sprout::FileTarget (class)">FileTarget</a></span></tt>) <strong>initialize</strong> {|_self| ... }
445
+
446
+
447
+
448
+ </p><div class="docstring">
449
+ <div class="discussion">
450
+
451
+ <p>A new instance of FileTarget</p>
452
+
453
+
454
+ </div>
455
+ </div>
456
+ <div class="tags">
457
+ <h3>Yields:</h3>
458
+ <ul class="yield">
459
+
460
+ <li>
461
+
462
+ <span class='type'>(<tt>_self</tt>)</span>
463
+
464
+
465
+
466
+
467
+ </li>
468
+
469
+ </ul>
470
+ <h3>Yield Parameters:</h3>
471
+ <ul class="yieldparam">
472
+
473
+ <li>
474
+
475
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Sprout::FileTarget (class)">Sprout::FileTarget</a></span></tt>)</span>
476
+
477
+
478
+ <span class='name'>_self</span>
479
+
480
+
481
+
482
+ &mdash;
483
+ <div class='inline'>
484
+ <p>the object that the method was called on</p>
485
+ </div>
486
+
487
+ </li>
488
+
489
+ </ul>
490
+
491
+ </div><table class="source_code">
492
+ <tr>
493
+ <td>
494
+ <pre class="lines">
495
+
496
+
497
+ 22
498
+ 23
499
+ 24
500
+ 25
501
+ 26
502
+ 27
503
+ 28</pre>
504
+ </td>
505
+ <td>
506
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 22</span>
507
+
508
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span>
509
+ <span class='ivar'>@executables</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
510
+ <span class='ivar'>@libraries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
511
+ <span class='ivar'>@load_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></span>
512
+ <span class='ivar'>@platform</span> <span class='op'>=</span> <span class='symbol'>:universal</span>
513
+ <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
514
+ <span class='kw'>end</span></pre>
515
+ </td>
516
+ </tr>
517
+ </table>
518
+ </div>
519
+
520
+ </div>
521
+
522
+ <div id="instance_attr_details" class="attr_details">
523
+ <h2>Instance Attribute Details</h2>
524
+
525
+
526
+ <span id=""></span>
527
+ <span id="executables-instance_method"></span>
528
+ <div class="method_details first">
529
+ <p class="signature first" id="executables-instance_method">
530
+
531
+ - (<tt>Object</tt>) <strong>executables</strong> <span class="extras">(readonly)</span>
532
+
533
+
534
+
535
+ </p><div class="docstring">
536
+ <div class="discussion">
537
+
538
+ <p>Returns the value of attribute executables</p>
539
+
540
+
541
+ </div>
542
+ </div>
543
+ <div class="tags">
544
+
545
+ </div><table class="source_code">
546
+ <tr>
547
+ <td>
548
+ <pre class="lines">
549
+
550
+
551
+ 19
552
+ 20
553
+ 21</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 19</span>
557
+
558
+ <span class='kw'>def</span> <span class='id executables'>executables</span>
559
+ <span class='ivar'>@executables</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+
567
+ <span id=""></span>
568
+ <span id="libraries-instance_method"></span>
569
+ <div class="method_details ">
570
+ <p class="signature " id="libraries-instance_method">
571
+
572
+ - (<tt>Object</tt>) <strong>libraries</strong> <span class="extras">(readonly)</span>
573
+
574
+
575
+
576
+ </p><div class="docstring">
577
+ <div class="discussion">
578
+
579
+ <p>Returns the value of attribute libraries</p>
580
+
581
+
582
+ </div>
583
+ </div>
584
+ <div class="tags">
585
+
586
+ </div><table class="source_code">
587
+ <tr>
588
+ <td>
589
+ <pre class="lines">
590
+
591
+
592
+ 20
593
+ 21
594
+ 22</pre>
595
+ </td>
596
+ <td>
597
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 20</span>
598
+
599
+ <span class='kw'>def</span> <span class='id libraries'>libraries</span>
600
+ <span class='ivar'>@libraries</span>
601
+ <span class='kw'>end</span></pre>
602
+ </td>
603
+ </tr>
604
+ </table>
605
+ </div>
606
+
607
+
608
+ <span id="load_path=-instance_method"></span>
609
+ <span id="load_path-instance_method"></span>
610
+ <div class="method_details ">
611
+ <p class="signature " id="load_path-instance_method">
612
+
613
+ - (<tt>Object</tt>) <strong>load_path</strong>
614
+
615
+
616
+
617
+ </p><div class="docstring">
618
+ <div class="discussion">
619
+
620
+ <p>Returns the value of attribute load_path</p>
621
+
622
+
623
+ </div>
624
+ </div>
625
+ <div class="tags">
626
+
627
+ </div><table class="source_code">
628
+ <tr>
629
+ <td>
630
+ <pre class="lines">
631
+
632
+
633
+ 14
634
+ 15
635
+ 16</pre>
636
+ </td>
637
+ <td>
638
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 14</span>
639
+
640
+ <span class='kw'>def</span> <span class='id load_path'>load_path</span>
641
+ <span class='ivar'>@load_path</span>
642
+ <span class='kw'>end</span></pre>
643
+ </td>
644
+ </tr>
645
+ </table>
646
+ </div>
647
+
648
+
649
+ <span id="pkg_name=-instance_method"></span>
650
+ <span id="pkg_name-instance_method"></span>
651
+ <div class="method_details ">
652
+ <p class="signature " id="pkg_name-instance_method">
653
+
654
+ - (<tt>Object</tt>) <strong>pkg_name</strong>
655
+
656
+
657
+
658
+ </p><div class="docstring">
659
+ <div class="discussion">
660
+
661
+ <p>Returns the value of attribute pkg_name</p>
662
+
663
+
664
+ </div>
665
+ </div>
666
+ <div class="tags">
667
+
668
+ </div><table class="source_code">
669
+ <tr>
670
+ <td>
671
+ <pre class="lines">
672
+
673
+
674
+ 15
675
+ 16
676
+ 17</pre>
677
+ </td>
678
+ <td>
679
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 15</span>
680
+
681
+ <span class='kw'>def</span> <span class='id pkg_name'>pkg_name</span>
682
+ <span class='ivar'>@pkg_name</span>
683
+ <span class='kw'>end</span></pre>
684
+ </td>
685
+ </tr>
686
+ </table>
687
+ </div>
688
+
689
+
690
+ <span id="pkg_version=-instance_method"></span>
691
+ <span id="pkg_version-instance_method"></span>
692
+ <div class="method_details ">
693
+ <p class="signature " id="pkg_version-instance_method">
694
+
695
+ - (<tt>Object</tt>) <strong>pkg_version</strong>
696
+
697
+
698
+
699
+ </p><div class="docstring">
700
+ <div class="discussion">
701
+
702
+ <p>Returns the value of attribute pkg_version</p>
703
+
704
+
705
+ </div>
706
+ </div>
707
+ <div class="tags">
708
+
709
+ </div><table class="source_code">
710
+ <tr>
711
+ <td>
712
+ <pre class="lines">
713
+
714
+
715
+ 16
716
+ 17
717
+ 18</pre>
718
+ </td>
719
+ <td>
720
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 16</span>
721
+
722
+ <span class='kw'>def</span> <span class='id pkg_version'>pkg_version</span>
723
+ <span class='ivar'>@pkg_version</span>
724
+ <span class='kw'>end</span></pre>
725
+ </td>
726
+ </tr>
727
+ </table>
728
+ </div>
729
+
730
+
731
+ <span id="platform=-instance_method"></span>
732
+ <span id="platform-instance_method"></span>
733
+ <div class="method_details ">
734
+ <p class="signature " id="platform-instance_method">
735
+
736
+ - (<tt>Object</tt>) <strong>platform</strong>
737
+
738
+
739
+
740
+ </p><div class="docstring">
741
+ <div class="discussion">
742
+
743
+ <p>Returns the value of attribute platform</p>
744
+
745
+
746
+ </div>
747
+ </div>
748
+ <div class="tags">
749
+
750
+ </div><table class="source_code">
751
+ <tr>
752
+ <td>
753
+ <pre class="lines">
754
+
755
+
756
+ 17
757
+ 18
758
+ 19</pre>
759
+ </td>
760
+ <td>
761
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 17</span>
762
+
763
+ <span class='kw'>def</span> <span class='id platform'>platform</span>
764
+ <span class='ivar'>@platform</span>
765
+ <span class='kw'>end</span></pre>
766
+ </td>
767
+ </tr>
768
+ </table>
769
+ </div>
770
+
771
+ </div>
772
+
773
+
774
+ <div id="instance_method_details" class="method_details_list">
775
+ <h2>Instance Method Details</h2>
776
+
777
+
778
+ <div class="method_details first">
779
+ <p class="signature first" id="add_executable-instance_method">
780
+
781
+ - (<tt>Object</tt>) <strong>add_executable</strong>(name, path)
782
+
783
+
784
+
785
+ </p><div class="docstring">
786
+ <div class="discussion">
787
+
788
+ <p>Add an executable to the RubyGem package.</p>
789
+
790
+ <p>with this name.</p>
791
+
792
+
793
+ </div>
794
+ </div>
795
+ <div class="tags">
796
+ <h3>Parameters:</h3>
797
+ <ul class="param">
798
+
799
+ <li>
800
+
801
+ <span class='type'>(<tt>Symbol</tt>)</span>
802
+
803
+
804
+ <span class='name'>name</span>
805
+
806
+
807
+
808
+ &mdash;
809
+ <div class='inline'>
810
+ <p>that will be used to retrieve this executable later.</p>
811
+ </div>
812
+
813
+ </li>
814
+
815
+ <li>
816
+
817
+ <span class='type'>(<tt>File</tt>)</span>
818
+
819
+
820
+ <span class='name'>path</span>
821
+
822
+
823
+
824
+ &mdash;
825
+ <div class='inline'>
826
+ <p>relative path to the executable that will be associated</p>
827
+ </div>
828
+
829
+ </li>
830
+
831
+ </ul>
832
+
833
+ </div><table class="source_code">
834
+ <tr>
835
+ <td>
836
+ <pre class="lines">
837
+
838
+
839
+ 64
840
+ 65
841
+ 66
842
+ 67</pre>
843
+ </td>
844
+ <td>
845
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 64</span>
846
+
847
+ <span class='kw'>def</span> <span class='id add_executable'>add_executable</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id path'>path</span>
848
+ <span class='id path'>path</span> <span class='op'>=</span> <span class='id expand_local_path'>expand_local_path</span> <span class='id path'>path</span>
849
+ <span class='id executables'>executables</span> <span class='op'>&lt;&lt;</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span> <span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id path'>path</span><span class='comma'>,</span> <span class='symbol'>:file_target</span> <span class='op'>=&gt;</span> <span class='kw'>self</span> <span class='rparen'>)</span>
850
+ <span class='kw'>end</span></pre>
851
+ </td>
852
+ </tr>
853
+ </table>
854
+ </div>
855
+
856
+ <div class="method_details ">
857
+ <p class="signature " id="add_library-instance_method">
858
+
859
+ - (<tt><span class='object_link'><a href="Library.html" title="Sprout::Library (class)">Sprout::Library</a></span></tt>) <strong>add_library</strong>(name, path)
860
+
861
+
862
+
863
+ </p><div class="docstring">
864
+ <div class="discussion">
865
+
866
+ <p>Add a library to the package.</p>
867
+
868
+
869
+ </div>
870
+ </div>
871
+ <div class="tags">
872
+ <h3>Parameters:</h3>
873
+ <ul class="param">
874
+
875
+ <li>
876
+
877
+ <span class='type'>(<tt>Symbol</tt>)</span>
878
+
879
+
880
+ <span class='name'>name</span>
881
+
882
+
883
+
884
+ &mdash;
885
+ <div class='inline'>
886
+ <p>Name that will be used to retrieve this library on <tt>load</tt>.</p>
887
+ </div>
888
+
889
+ </li>
890
+
891
+ <li>
892
+
893
+ <span class='type'>(<tt>File</tt>, <tt>Path</tt>, <tt>Array</tt>)</span>
894
+
895
+
896
+ <span class='name'>path</span>
897
+
898
+
899
+
900
+ &mdash;
901
+ <div class='inline'>
902
+ <p>File or files that will be associated with this library and copied into
903
+ the target project library folder when loaded. (If the path is a
904
+ directory, all files forward of that directory will be included.)</p>
905
+ </div>
906
+
907
+ </li>
908
+
909
+ </ul>
910
+ <h3>Returns:</h3>
911
+ <ul class="return">
912
+
913
+ <li>
914
+
915
+ <span class='type'>(<tt><span class='object_link'><a href="Library.html" title="Sprout::Library (class)">Sprout::Library</a></span></tt>)</span>
916
+
917
+
918
+
919
+
920
+ &mdash;
921
+ <div class='inline'>
922
+ <p>The newly created library that was added.</p>
923
+ </div>
924
+
925
+ </li>
926
+
927
+ </ul>
928
+
929
+ </div><table class="source_code">
930
+ <tr>
931
+ <td>
932
+ <pre class="lines">
933
+
934
+
935
+ 46
936
+ 47
937
+ 48
938
+ 49
939
+ 50
940
+ 51
941
+ 52
942
+ 53
943
+ 54
944
+ 55</pre>
945
+ </td>
946
+ <td>
947
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 46</span>
948
+
949
+ <span class='kw'>def</span> <span class='id add_library'>add_library</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id path'>path</span>
950
+ <span class='kw'>if</span> <span class='id path'>path</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
951
+ <span class='id path'>path</span> <span class='op'>=</span> <span class='id path'>path</span><span class='period'>.</span><span class='id collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id p'>p</span><span class='op'>|</span> <span class='id expand_local_path'>expand_local_path</span><span class='lparen'>(</span><span class='id p'>p</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
952
+ <span class='kw'>else</span>
953
+ <span class='id path'>path</span> <span class='op'>=</span> <span class='id expand_local_path'>expand_local_path</span> <span class='id path'>path</span>
954
+ <span class='kw'>end</span>
955
+ <span class='id library'>library</span> <span class='op'>=</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Library</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span> <span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id path'>path</span><span class='comma'>,</span> <span class='symbol'>:file_target</span> <span class='op'>=&gt;</span> <span class='kw'>self</span> <span class='rparen'>)</span>
956
+ <span class='id libraries'>libraries</span> <span class='op'>&lt;&lt;</span> <span class='id library'>library</span>
957
+ <span class='id library'>library</span>
958
+ <span class='kw'>end</span></pre>
959
+ </td>
960
+ </tr>
961
+ </table>
962
+ </div>
963
+
964
+ <div class="method_details ">
965
+ <p class="signature " id="expand_local_path-instance_method">
966
+
967
+ - (<tt>Object</tt>) <strong>expand_local_path</strong>(path)
968
+
969
+
970
+
971
+ </p><div class="docstring">
972
+ <div class="discussion">
973
+
974
+ <p>This is a template method that is overridden by RemoteFileTarget.</p>
975
+
976
+
977
+ </div>
978
+ </div>
979
+ <div class="tags">
980
+
981
+ </div><table class="source_code">
982
+ <tr>
983
+ <td>
984
+ <pre class="lines">
985
+
986
+
987
+ 81
988
+ 82
989
+ 83</pre>
990
+ </td>
991
+ <td>
992
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 81</span>
993
+
994
+ <span class='kw'>def</span> <span class='id expand_local_path'>expand_local_path</span> <span class='id path'>path</span>
995
+ <span class='const'>File</span><span class='period'>.</span><span class='id join'>join</span> <span class='id load_path'>load_path</span><span class='comma'>,</span> <span class='id path'>path</span>
996
+ <span class='kw'>end</span></pre>
997
+ </td>
998
+ </tr>
999
+ </table>
1000
+ </div>
1001
+
1002
+ <div class="method_details ">
1003
+ <p class="signature " id="resolve-instance_method">
1004
+
1005
+ - (<tt>Object</tt>) <strong>resolve</strong>
1006
+
1007
+
1008
+
1009
+ </p><div class="docstring">
1010
+ <div class="discussion">
1011
+
1012
+ <p>This is a template method that will be called so that RemoteFileTarget
1013
+ subclasses and load the appropriate files at the appropriate time.
1014
+ Admittedly kind of smelly, other ideas welcome...</p>
1015
+
1016
+
1017
+ </div>
1018
+ </div>
1019
+ <div class="tags">
1020
+
1021
+ </div><table class="source_code">
1022
+ <tr>
1023
+ <td>
1024
+ <pre class="lines">
1025
+
1026
+
1027
+ 35
1028
+ 36</pre>
1029
+ </td>
1030
+ <td>
1031
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 35</span>
1032
+
1033
+ <span class='kw'>def</span> <span class='id resolve'>resolve</span>
1034
+ <span class='kw'>end</span></pre>
1035
+ </td>
1036
+ </tr>
1037
+ </table>
1038
+ </div>
1039
+
1040
+ <div class="method_details ">
1041
+ <p class="signature " id="to_s-instance_method">
1042
+
1043
+ - (<tt>Object</tt>) <strong>to_s</strong>
1044
+
1045
+
1046
+
1047
+ </p><table class="source_code">
1048
+ <tr>
1049
+ <td>
1050
+ <pre class="lines">
1051
+
1052
+
1053
+ 69
1054
+ 70
1055
+ 71</pre>
1056
+ </td>
1057
+ <td>
1058
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 69</span>
1059
+
1060
+ <span class='kw'>def</span> <span class='id to_s'>to_s</span>
1061
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[FileTarget pkg_name=</span><span class='embexpr_beg'>#{</span><span class='id pkg_name'>pkg_name</span><span class='rbrace'>}</span><span class='tstring_content'> pkg_version=</span><span class='embexpr_beg'>#{</span><span class='id pkg_version'>pkg_version</span><span class='rbrace'>}</span><span class='tstring_content'> platform=</span><span class='embexpr_beg'>#{</span><span class='id platform'>platform</span><span class='rbrace'>}</span><span class='tstring_content'>]</span><span class='tstring_end'>&quot;</span></span>
1062
+ <span class='kw'>end</span></pre>
1063
+ </td>
1064
+ </tr>
1065
+ </table>
1066
+ </div>
1067
+
1068
+ <div class="method_details ">
1069
+ <p class="signature " id="validate-instance_method">
1070
+
1071
+ - (<tt>Object</tt>) <strong>validate</strong>
1072
+
1073
+
1074
+
1075
+ </p><table class="source_code">
1076
+ <tr>
1077
+ <td>
1078
+ <pre class="lines">
1079
+
1080
+
1081
+ 73
1082
+ 74
1083
+ 75
1084
+ 76</pre>
1085
+ </td>
1086
+ <td>
1087
+ <pre class="code"><span class="info file"># File 'lib/sprout/file_target.rb', line 73</span>
1088
+
1089
+ <span class='kw'>def</span> <span class='id validate'>validate</span>
1090
+ <span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>UsageError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>FileTarget.pkg_name is required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id pkg_name'>pkg_name</span><span class='period'>.</span><span class='id nil?'>nil?</span>
1091
+ <span class='id raise'>raise</span> <span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>UsageError</span><span class='period'>.</span><span class='id new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>FileTarget.pkg_version is required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id pkg_version'>pkg_version</span><span class='period'>.</span><span class='id nil?'>nil?</span>
1092
+ <span class='kw'>end</span></pre>
1093
+ </td>
1094
+ </tr>
1095
+ </table>
1096
+ </div>
1097
+
1098
+ </div>
1099
+
1100
+ </div>
1101
+
1102
+ <div id="footer">
1103
+ Generated on Wed Dec 22 11:58:34 2010 by
1104
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1105
+ 0.6.3 (ruby-1.9.2).
1106
+ </div>
1107
+
1108
+ </body>
1109
+ </html>