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/Specification.html ADDED
@@ -0,0 +1,838 @@
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::Specification
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 (S)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Sprout.html" title="Sprout (module)">Sprout</a></span></span>
38
+ &raquo;
39
+ <span class="title">Specification</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::Specification
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">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Sprout::Specification</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">lib/sprout/specification.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ Sprouts provides us with the ability to distribute source files,
99
+ precompiled libraries, and remote executables. It does all of this by
100
+ (ab)using RubyGems.
101
+ </p>
102
+ <p>
103
+ RubyGems gives us the ability to version-manage, and distribute arbitrary
104
+ text and binary payloads.
105
+ </p>
106
+ <p>
107
+ In order to support Flash development, we have one major problem that
108
+ RubyGems does not solve for us. This is the fact that many elements of our
109
+ executable chain are not open-source, and we do not have the rights to
110
+ directly distribute them.
111
+ </p>
112
+ <p>
113
+ This restriction means that many of our tools and dependencies cannot be
114
+ packaged and distributed <em>directly</em> within a RubyGem (or from any
115
+ server other than Adobe&#8217;s as a matter of fact).
116
+ </p>
117
+ <p>
118
+ In order to overcome this restriction, we have introduced a
119
+ Sprout::Specification. This is a regular Ruby file with regular Ruby code
120
+ in it. The main idea behind this file, is that it needs to be given a name
121
+ and available in your load path.
122
+ </p>
123
+ <p>
124
+ Whenever a rake build task (Sprout::Executable) or library task,
125
+ (Sprout::Library) is encountered, it will call Sprout::Executable.load or
126
+ Sprout::Library.load (respectively).
127
+ </p>
128
+ <p>
129
+ These methods will attempt to <tt>require</tt> the provided specification
130
+ and - if it&#8217;s in your load path - the specification will be loaded,
131
+ and any relevant file targets will be returned.
132
+ </p>
133
+ <p>
134
+ There are many ways to get Ruby code into your load path. One of the
135
+ easiest to package it up in a RubyGem and configure the
136
+ <tt>require_paths</tt> parameter of your Gem::Specification.
137
+ </p>
138
+ <p>
139
+ <a
140
+ href="http://docs.rubygems.org/read/chapter/20#require_paths">docs.rubygems.org/read/chapter/20#require_paths</a>
141
+ </p>
142
+ <p>
143
+ To learn more about packaging RubyGems:
144
+ </p>
145
+ <p>
146
+ <a
147
+ href="http://docs.rubygems.org/read/chapter/20#page85">docs.rubygems.org/read/chapter/20#page85</a>
148
+ <a
149
+ href="http://rubygems.rubyforge.org/rdoc/Gem/Specification.html">rubygems.rubyforge.org/rdoc/Gem/Specification.html</a>
150
+ </p>
151
+ <p>
152
+ To learn more about published RubyGems:
153
+ </p>
154
+ <p>
155
+ <a
156
+ href="http://rubygems.org/pages/gem_docs">rubygems.org/pages/gem_docs</a>
157
+ </p>
158
+ <p>
159
+ To package a SWC library into a Sprout RubyGem, you would create a file
160
+ (usually) named [project_name.spec] in the root of the project.
161
+ </p>
162
+ <p>
163
+ This is your Gem::Specification.
164
+ </p>
165
+ <p>
166
+ You would also create a file named [projet_name.rb] and put that into the
167
+ root of the project or some other folder that you have added to the
168
+ Gem::Specification.require_paths parameter.
169
+ </p>
170
+ <h2>Example: Include a file directly in the RubyGem</h2>
171
+ <p>
172
+ In the case of AsUnit, this file would be named asunit4.rb and it&#8217;s
173
+ contents are as follows:
174
+ </p>
175
+ <pre class="code ruby"><code>
176
+ :include:../../test/fixtures/specification/asunit4.rb
177
+ </code></pre>
178
+ <h2>Example: Refer to files that are not in the RubyGem</h2>
179
+ <p>
180
+ For projects like the Flex SDK, we can&#8217;t distribute many of the
181
+ required files, so we can refer to these files in our Sprout::Specification
182
+ as <tt>remote_file_targets</tt>.
183
+ </p>
184
+ <pre class="code ruby"><code>
185
+ :include:../../test/fixtures/specification/flex4sdk.rb
186
+ </code></pre>
187
+ <h2>Example: Create custom downloads for each supported platform</h2>
188
+ <p>
189
+ For projects like the Flash Player itself, we need to refer to different
190
+ downloadable content for each supported platform.
191
+ </p>
192
+ <pre class="code ruby"><code>
193
+ :include:../../test/fixtures/specification/flashplayer.rb
194
+ </code></pre>
195
+ <h2>Packaging and Sharing</h2>
196
+ <p>
197
+ Public RubyGems are hosted at <a
198
+ href="http://rubygems.org">rubygems.org</a>.
199
+ </p>
200
+
201
+
202
+ </div>
203
+ </div>
204
+ <div class="tags">
205
+
206
+
207
+ </div>
208
+
209
+
210
+
211
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
212
+ <ul class="summary">
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#file_targets-instance_method" title="#file_targets (instance method)">- (Object) <strong>file_targets</strong> </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+ <span class="note title readonly">readonly</span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'><p>
234
+ Returns the value of attribute file_targets.
235
+ </p>
236
+ </div></span>
237
+
238
+ </li>
239
+
240
+
241
+ <li class="public ">
242
+ <span class="summary_signature">
243
+
244
+ <a href="#load_path-instance_method" title="#load_path (instance method)">- (Object) <strong>load_path</strong> </a>
245
+
246
+
247
+
248
+ </span>
249
+
250
+
251
+ <span class="note title readonly">readonly</span>
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+ <span class="summary_desc"><div class='inline'><p>
261
+ Returns the value of attribute load_path.
262
+ </p>
263
+ </div></span>
264
+
265
+ </li>
266
+
267
+
268
+ <li class="public ">
269
+ <span class="summary_signature">
270
+
271
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
272
+
273
+
274
+
275
+ </span>
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+ <span class="summary_desc"><div class='inline'><p>
288
+ Returns the value of attribute name.
289
+ </p>
290
+ </div></span>
291
+
292
+ </li>
293
+
294
+
295
+ <li class="public ">
296
+ <span class="summary_signature">
297
+
298
+ <a href="#version-instance_method" title="#version (instance method)">- (Object) <strong>version</strong> </a>
299
+
300
+
301
+
302
+ </span>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+ <span class="summary_desc"><div class='inline'><p>
315
+ Returns the value of attribute version.
316
+ </p>
317
+ </div></span>
318
+
319
+ </li>
320
+
321
+
322
+ </ul>
323
+
324
+
325
+
326
+
327
+
328
+ <h2>
329
+ Instance Method Summary
330
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
331
+ </h2>
332
+
333
+ <ul class="summary">
334
+
335
+ <li class="public ">
336
+ <span class="summary_signature">
337
+
338
+ <a href="#add_file_target-instance_method" title="#add_file_target (instance method)">- (Object) <strong>add_file_target</strong>(&amp;block) </a>
339
+
340
+
341
+
342
+ </span>
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+ <span class="summary_desc"><div class='inline'><p>
352
+ Add a file to the RubyGem itself.
353
+ </p>
354
+ </div></span>
355
+
356
+ </li>
357
+
358
+
359
+ <li class="public ">
360
+ <span class="summary_signature">
361
+
362
+ <a href="#add_remote_file_target-instance_method" title="#add_remote_file_target (instance method)">- (Object) <strong>add_remote_file_target</strong>(&amp;block) </a>
363
+
364
+
365
+
366
+ </span>
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+ <span class="summary_desc"><div class='inline'><p>
376
+ Add a remote file target to this RubyGem so that when it is loaded, Sprouts
377
+ will go fetch this file from the network.
378
+ </p>
379
+ </div></span>
380
+
381
+ </li>
382
+
383
+
384
+ <li class="public ">
385
+ <span class="summary_signature">
386
+
387
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Specification) <strong>initialize</strong> {|_self| ... }</a>
388
+
389
+
390
+
391
+ </span>
392
+
393
+ <span class="note title constructor">constructor</span>
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+ <span class="summary_desc"><div class='inline'><p>
403
+ Create a new Sprout::Specification.
404
+ </p>
405
+ </div></span>
406
+
407
+ </li>
408
+
409
+
410
+ </ul>
411
+
412
+
413
+ <div id="constructor_details" class="method_details_list">
414
+ <h2>Constructor Details</h2>
415
+
416
+ <div class="method_details first">
417
+ <p class="signature first" id="initialize-instance_method">
418
+
419
+ - (<tt><span class='object_link'><a href="" title="Sprout::Specification (class)">Specification</a></span></tt>) <strong>initialize</strong> {|_self| ... }
420
+
421
+
422
+
423
+ </p><div class="docstring">
424
+ <div class="discussion">
425
+ <p>
426
+ Create a new Sprout::Specification.
427
+ </p>
428
+ <p>
429
+ This method will yield the new Sprout::Specification to the provided block,
430
+ and delegate most configuration parameters to a <a
431
+ href="http://rubygems.rubyforge.org/rdoc/Gem/Specification.html">Gem::Specification</a>.
432
+ </p>
433
+ <p>
434
+ To learn more about what parameters are available and/or required, please
435
+ check out RubyGems documentation for their <a
436
+ href="http://rubygems.rubyforge.org/rdoc/Gem/Specification.html">Gem::Specification</a>.
437
+ </p>
438
+
439
+
440
+ </div>
441
+ </div>
442
+ <div class="tags">
443
+
444
+ <h3>Yields:</h3>
445
+ <ul class="yield">
446
+
447
+ <li>
448
+
449
+
450
+ <span class='type'>(<tt>_self</tt>)</span>
451
+
452
+
453
+
454
+ </li>
455
+
456
+ </ul>
457
+ <h3>Yield Parameters:</h3>
458
+ <ul class="yieldparam">
459
+
460
+ <li>
461
+
462
+ <span class='name'>_self</span>
463
+
464
+
465
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Sprout::Specification (class)">Sprout::Specification</a></span></tt>)</span>
466
+
467
+
468
+
469
+ &mdash;
470
+ <div class='inline'><p>
471
+ the object that the method was called on
472
+ </p>
473
+ </div>
474
+
475
+ </li>
476
+
477
+ </ul>
478
+
479
+ </div><table class="source_code">
480
+ <tr>
481
+ <td>
482
+ <pre class="lines">
483
+
484
+
485
+ 99
486
+ 100
487
+ 101
488
+ 102
489
+ 103
490
+ 104</pre>
491
+ </td>
492
+ <td>
493
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 99</span>
494
+
495
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
496
+ <span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='const'>Sprout</span><span class='period'>.</span><span class='id identifier rubyid_file_from_caller'>file_from_caller</span> <span class='id identifier rubyid_caller'>caller</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
497
+ <span class='ivar'>@load_path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span> <span class='id identifier rubyid_filename'>filename</span>
498
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.rb</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
499
+ <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
500
+ <span class='kw'>end</span></pre>
501
+ </td>
502
+ </tr>
503
+ </table>
504
+ </div>
505
+
506
+ </div>
507
+
508
+ <div id="instance_attr_details" class="attr_details">
509
+ <h2>Instance Attribute Details</h2>
510
+
511
+
512
+ <span id=""></span>
513
+ <span id="file_targets-instance_method"></span>
514
+ <div class="method_details first">
515
+ <p class="signature first" id="file_targets-instance_method">
516
+
517
+ - (<tt>Object</tt>) <strong>file_targets</strong> <span class="extras">(readonly)</span>
518
+
519
+
520
+
521
+ </p><div class="docstring">
522
+ <div class="discussion">
523
+ <p>
524
+ Returns the value of attribute file_targets
525
+ </p>
526
+
527
+
528
+ </div>
529
+ </div>
530
+ <div class="tags">
531
+
532
+
533
+ </div><table class="source_code">
534
+ <tr>
535
+ <td>
536
+ <pre class="lines">
537
+
538
+
539
+ 87
540
+ 88
541
+ 89</pre>
542
+ </td>
543
+ <td>
544
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 87</span>
545
+
546
+ <span class='kw'>def</span> <span class='id identifier rubyid_file_targets'>file_targets</span>
547
+ <span class='ivar'>@file_targets</span>
548
+ <span class='kw'>end</span></pre>
549
+ </td>
550
+ </tr>
551
+ </table>
552
+ </div>
553
+
554
+
555
+ <span id=""></span>
556
+ <span id="load_path-instance_method"></span>
557
+ <div class="method_details ">
558
+ <p class="signature " id="load_path-instance_method">
559
+
560
+ - (<tt>Object</tt>) <strong>load_path</strong> <span class="extras">(readonly)</span>
561
+
562
+
563
+
564
+ </p><div class="docstring">
565
+ <div class="discussion">
566
+ <p>
567
+ Returns the value of attribute load_path
568
+ </p>
569
+
570
+
571
+ </div>
572
+ </div>
573
+ <div class="tags">
574
+
575
+
576
+ </div><table class="source_code">
577
+ <tr>
578
+ <td>
579
+ <pre class="lines">
580
+
581
+
582
+ 88
583
+ 89
584
+ 90</pre>
585
+ </td>
586
+ <td>
587
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 88</span>
588
+
589
+ <span class='kw'>def</span> <span class='id identifier rubyid_load_path'>load_path</span>
590
+ <span class='ivar'>@load_path</span>
591
+ <span class='kw'>end</span></pre>
592
+ </td>
593
+ </tr>
594
+ </table>
595
+ </div>
596
+
597
+
598
+ <span id="name=-instance_method"></span>
599
+ <span id="name-instance_method"></span>
600
+ <div class="method_details ">
601
+ <p class="signature " id="name-instance_method">
602
+
603
+ - (<tt>Object</tt>) <strong>name</strong>
604
+
605
+
606
+
607
+ </p><div class="docstring">
608
+ <div class="discussion">
609
+ <p>
610
+ Returns the value of attribute name
611
+ </p>
612
+
613
+
614
+ </div>
615
+ </div>
616
+ <div class="tags">
617
+
618
+
619
+ </div><table class="source_code">
620
+ <tr>
621
+ <td>
622
+ <pre class="lines">
623
+
624
+
625
+ 84
626
+ 85
627
+ 86</pre>
628
+ </td>
629
+ <td>
630
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 84</span>
631
+
632
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
633
+ <span class='ivar'>@name</span>
634
+ <span class='kw'>end</span></pre>
635
+ </td>
636
+ </tr>
637
+ </table>
638
+ </div>
639
+
640
+
641
+ <span id="version=-instance_method"></span>
642
+ <span id="version-instance_method"></span>
643
+ <div class="method_details ">
644
+ <p class="signature " id="version-instance_method">
645
+
646
+ - (<tt>Object</tt>) <strong>version</strong>
647
+
648
+
649
+
650
+ </p><div class="docstring">
651
+ <div class="discussion">
652
+ <p>
653
+ Returns the value of attribute version
654
+ </p>
655
+
656
+
657
+ </div>
658
+ </div>
659
+ <div class="tags">
660
+
661
+
662
+ </div><table class="source_code">
663
+ <tr>
664
+ <td>
665
+ <pre class="lines">
666
+
667
+
668
+ 85
669
+ 86
670
+ 87</pre>
671
+ </td>
672
+ <td>
673
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 85</span>
674
+
675
+ <span class='kw'>def</span> <span class='id identifier rubyid_version'>version</span>
676
+ <span class='ivar'>@version</span>
677
+ <span class='kw'>end</span></pre>
678
+ </td>
679
+ </tr>
680
+ </table>
681
+ </div>
682
+
683
+ </div>
684
+
685
+
686
+ <div id="instance_method_details" class="method_details_list">
687
+ <h2>Instance Method Details</h2>
688
+
689
+
690
+ <div class="method_details first">
691
+ <p class="signature first" id="add_file_target-instance_method">
692
+
693
+ - (<tt>Object</tt>) <strong>add_file_target</strong>(&amp;block)
694
+
695
+
696
+
697
+ </p><div class="docstring">
698
+ <div class="discussion">
699
+ <p>
700
+ Add a file to the RubyGem itself. This is a great way to package smallish
701
+ libraries in either source or already-packaged form. For example, one might
702
+ add a SWC to a RubyGem library.
703
+ </p>
704
+ <p>
705
+ Each time this method is called, a new Sprout::FileTarget instance will be
706
+ yielded to the provided block, and added to a collection for packaging.
707
+ </p>
708
+ <pre class="code ruby"><code>
709
+ Sprout::Specification.new do |s|
710
+ ...
711
+ s.add_file_target do |t|
712
+ t.platform = :universal
713
+ t.add_executable :asdoc, 'bin/asdoc'
714
+ end
715
+ end</code></pre>
716
+
717
+
718
+ </div>
719
+ </div>
720
+ <div class="tags">
721
+
722
+
723
+ </div><table class="source_code">
724
+ <tr>
725
+ <td>
726
+ <pre class="lines">
727
+
728
+
729
+ 156
730
+ 157
731
+ 158
732
+ 159</pre>
733
+ </td>
734
+ <td>
735
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 156</span>
736
+
737
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_file_target'>add_file_target</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
738
+ <span class='id identifier rubyid_target'>target</span> <span class='op'>=</span> <span class='const'>FileTarget</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
739
+ <span class='id identifier rubyid_configure_target'>configure_target</span> <span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
740
+ <span class='kw'>end</span></pre>
741
+ </td>
742
+ </tr>
743
+ </table>
744
+ </div>
745
+
746
+ <div class="method_details ">
747
+ <p class="signature " id="add_remote_file_target-instance_method">
748
+
749
+ - (<tt>Object</tt>) <strong>add_remote_file_target</strong>(&amp;block)
750
+
751
+
752
+
753
+ </p><div class="docstring">
754
+ <div class="discussion">
755
+ <p>
756
+ Add a remote file target to this RubyGem so that when it is loaded, Sprouts
757
+ will go fetch this file from the network.
758
+ </p>
759
+ <p>
760
+ Each time this method is called, a new Sprout::RemoteFiletarget instance
761
+ will be yielded to the provided block and resolved after the block
762
+ completes.
763
+ </p>
764
+ <p>
765
+ After this block is evaluated, Sprouts will first check the collection of
766
+ env_names to see if the expected paths are available. If a valid env_name
767
+ is found, Sprouts will return the path to the requested executable from the
768
+ environment variable.
769
+ </p>
770
+ <p>
771
+ If no env_names are set, or the requested executable is not found within
772
+ any that are identified, Sprouts will check to see if the archive has
773
+ already been unpacked into the expected location:
774
+ </p>
775
+ <pre class="code ruby"><code>
776
+ <span class='comment'>#{SPROUT_HOME}/cache/#{SPROUT_VERSION}/flex4sdk/#{md5}/4.0.pre
777
+ </span></code></pre>
778
+ <p>
779
+ If the archive been unpacked, Sprouts will return the path to the
780
+ requested executable.
781
+ </p>
782
+ <p>
783
+ If the archive has not been unpacked, Sprouts will check to see if the
784
+ archive has been downloaded to:
785
+ </p>
786
+ <pre class="code ruby"><code>
787
+ <span class='comment'>#{SPROUT_HOME}/cache/#{SPROUT_VERSION}/flex4sdk/#{md5}.zip
788
+ </span></code></pre>
789
+ <p>
790
+ If the archive has been downloaded, it will be unpacked and the path to the
791
+ requested executable will be returned.
792
+ </p>
793
+ <p>
794
+ If the archive has not been downloaded, it will be downloaded, unpacked and
795
+ the path to the requested executable will be returned.
796
+ </p>
797
+
798
+
799
+ </div>
800
+ </div>
801
+ <div class="tags">
802
+
803
+
804
+ </div><table class="source_code">
805
+ <tr>
806
+ <td>
807
+ <pre class="lines">
808
+
809
+
810
+ 137
811
+ 138
812
+ 139
813
+ 140</pre>
814
+ </td>
815
+ <td>
816
+ <pre class="code"><span class="info file"># File 'lib/sprout/specification.rb', line 137</span>
817
+
818
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_remote_file_target'>add_remote_file_target</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
819
+ <span class='id identifier rubyid_target'>target</span> <span class='op'>=</span> <span class='const'>RemoteFileTarget</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
820
+ <span class='id identifier rubyid_configure_target'>configure_target</span> <span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
821
+ <span class='kw'>end</span></pre>
822
+ </td>
823
+ </tr>
824
+ </table>
825
+ </div>
826
+
827
+ </div>
828
+
829
+ </div>
830
+
831
+ <div id="footer">
832
+ Generated on Sun Mar 11 14:30:33 2012 by
833
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
834
+ 0.7.5 (ruby-1.9.2).
835
+ </div>
836
+
837
+ </body>
838
+ </html>