sprout 1.1.11.pre → 1.1.13.pre

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

Potentially problematic release.

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

Files changed (105) hide show
  1. data/Gemfile.lock +3 -4
  2. data/VERSION +1 -1
  3. data/doc/Dir.html +288 -0
  4. data/doc/Rake/Task.html +184 -0
  5. data/doc/Sprout.html +740 -0
  6. data/doc/Sprout/ArchiveUnpacker.html +1246 -0
  7. data/doc/Sprout/CommandLine.html +520 -0
  8. data/doc/Sprout/Concern.html +351 -0
  9. data/doc/Sprout/Errors.html +101 -0
  10. data/doc/Sprout/Errors/ArchiveUnpackerError.html +125 -0
  11. data/doc/Sprout/Errors/DestinationExistsError.html +133 -0
  12. data/doc/Sprout/Errors/DuplicateMemberError.html +132 -0
  13. data/doc/Sprout/Errors/ExecutableError.html +125 -0
  14. data/doc/Sprout/Errors/ExecutableRegistrationError.html +132 -0
  15. data/doc/Sprout/Errors/ExecutionError.html +121 -0
  16. data/doc/Sprout/Errors/GeneratorError.html +125 -0
  17. data/doc/Sprout/Errors/InvalidArgumentError.html +132 -0
  18. data/doc/Sprout/Errors/LoadError.html +121 -0
  19. data/doc/Sprout/Errors/MissingArgumentError.html +132 -0
  20. data/doc/Sprout/Errors/MissingExecutableError.html +132 -0
  21. data/doc/Sprout/Errors/MissingGeneratorError.html +132 -0
  22. data/doc/Sprout/Errors/MissingTemplateError.html +132 -0
  23. data/doc/Sprout/Errors/ProcessRunnerError.html +121 -0
  24. data/doc/Sprout/Errors/RemoteFileLoaderError.html +110 -0
  25. data/doc/Sprout/Errors/SproutError.html +114 -0
  26. data/doc/Sprout/Errors/UnknownArchiveType.html +122 -0
  27. data/doc/Sprout/Errors/UsageError.html +121 -0
  28. data/doc/Sprout/Errors/ValidationError.html +121 -0
  29. data/doc/Sprout/Errors/VersionRequirementNotMetError.html +121 -0
  30. data/doc/Sprout/Executable.html +169 -0
  31. data/doc/Sprout/Executable/Base.html +2813 -0
  32. data/doc/Sprout/Executable/Boolean.html +534 -0
  33. data/doc/Sprout/Executable/CollectionParam.html +483 -0
  34. data/doc/Sprout/Executable/FileParam.html +484 -0
  35. data/doc/Sprout/Executable/Files.html +292 -0
  36. data/doc/Sprout/Executable/Number.html +141 -0
  37. data/doc/Sprout/Executable/Param.html +2874 -0
  38. data/doc/Sprout/Executable/ParameterFactory.html +232 -0
  39. data/doc/Sprout/Executable/Path.html +223 -0
  40. data/doc/Sprout/Executable/Paths.html +253 -0
  41. data/doc/Sprout/Executable/Session.html +1513 -0
  42. data/doc/Sprout/Executable/StringParam.html +213 -0
  43. data/doc/Sprout/Executable/Strings.html +167 -0
  44. data/doc/Sprout/Executable/Url.html +160 -0
  45. data/doc/Sprout/Executable/Urls.html +170 -0
  46. data/doc/Sprout/FileTarget.html +1109 -0
  47. data/doc/Sprout/Generator.html +750 -0
  48. data/doc/Sprout/Generator/Base.html +1902 -0
  49. data/doc/Sprout/Generator/Command.html +690 -0
  50. data/doc/Sprout/Generator/DirectoryManifest.html +476 -0
  51. data/doc/Sprout/Generator/FileManifest.html +643 -0
  52. data/doc/Sprout/Generator/Manifest.html +377 -0
  53. data/doc/Sprout/Generator/TemplateManifest.html +194 -0
  54. data/doc/Sprout/GeneratorGenerator.html +1115 -0
  55. data/doc/Sprout/Library.html +1146 -0
  56. data/doc/Sprout/LibraryGenerator.html +331 -0
  57. data/doc/Sprout/OutputBuffer.html +445 -0
  58. data/doc/Sprout/Platform.html +714 -0
  59. data/doc/Sprout/ProcessRunner.html +1707 -0
  60. data/doc/Sprout/ProgressBar.html +366 -0
  61. data/doc/Sprout/ProgressBarImpl.html +2109 -0
  62. data/doc/Sprout/ProgressBarManager.html +424 -0
  63. data/doc/Sprout/ProgressBarOutputStream.html +406 -0
  64. data/doc/Sprout/RDocParser.html +211 -0
  65. data/doc/Sprout/RemoteFileLoader.html +172 -0
  66. data/doc/Sprout/RemoteFileTarget.html +679 -0
  67. data/doc/Sprout/ReversedProgressBar.html +184 -0
  68. data/doc/Sprout/RubyFeature.html +155 -0
  69. data/doc/Sprout/RubyFeature/ClassMethods.html +1065 -0
  70. data/doc/Sprout/RubyGenerator.html +786 -0
  71. data/doc/Sprout/Specification.html +767 -0
  72. data/doc/Sprout/System.html +191 -0
  73. data/doc/Sprout/System/BaseSystem.html +1660 -0
  74. data/doc/Sprout/System/JavaSystem.html +122 -0
  75. data/doc/Sprout/System/OSXSystem.html +335 -0
  76. data/doc/Sprout/System/ThreadMock.html +183 -0
  77. data/doc/Sprout/System/UnixSystem.html +584 -0
  78. data/doc/Sprout/System/VistaSystem.html +251 -0
  79. data/doc/Sprout/System/WinNixSystem.html +325 -0
  80. data/doc/Sprout/System/WinSystem.html +571 -0
  81. data/doc/Sprout/TestHelper.html +2165 -0
  82. data/doc/Sprout/ToolGenerator.html +953 -0
  83. data/doc/Sprout/VERSION.html +118 -0
  84. data/doc/String.html +290 -0
  85. data/doc/_index.html +820 -0
  86. data/doc/class_list.html +36 -0
  87. data/doc/css/common.css +1 -0
  88. data/doc/css/full_list.css +53 -0
  89. data/doc/css/style.css +310 -0
  90. data/doc/file.README.html +96 -0
  91. data/doc/file_list.html +41 -0
  92. data/doc/frames.html +13 -0
  93. data/doc/index.html +96 -0
  94. data/doc/js/app.js +202 -0
  95. data/doc/js/full_list.js +149 -0
  96. data/doc/js/jquery.js +154 -0
  97. data/doc/method_list.html +3603 -0
  98. data/doc/top-level-namespace.html +192 -0
  99. data/lib/sprout.rb +1 -0
  100. data/lib/sprout/executable/base.rb +2 -5
  101. data/lib/sprout/executable/param.rb +15 -8
  102. data/lib/sprout/executable/session.rb +1 -1
  103. data/lib/sprout/library.rb +44 -2
  104. data/test/unit/executable_test.rb +3 -5
  105. metadata +99 -3
data/doc/Sprout/Library.html ADDED
@@ -0,0 +1,1146 @@
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::Library</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 (L)</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">Library</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::Library
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::Library</li>
62
+
63
+ </ul>
64
+ <a href="#" class="inheritanceTree">show all</a>
65
+
66
+ </dd>
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dt class="r2">Includes:</dt>
74
+ <dd class="r2"><span class='object_link'><a href="RubyFeature.html" title="Sprout::RubyFeature (module)">RubyFeature</a></span></dd>
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1 last">Defined in:</dt>
81
+ <dd class="r1 last">lib/sprout/library.rb</dd>
82
+
83
+ </dl>
84
+ <div class="clear"></div>
85
+
86
+ <h2>Overview</h2><div class="docstring">
87
+ <div class="discussion">
88
+
89
+ <p>Sprout Libraries provide support for sharing and versioning raw or
90
+ pre-compiled source code across projects.</p>
91
+
92
+ <p>Sprout Libraries give us the ability to include raw (or pre-compiled)
93
+ source code directly within a Ruby Gem, or to refer to an archive somewhere
94
+ on the internet.</p>
95
+
96
+ <p>A Sprout Library is made up of two components:</p>
97
+ <ul><li>
98
+ <p>Specification: The description of the library</p>
99
+ </li><li>
100
+ <p>Source Code: Raw or pre-compiled (swc, jar, abc)</p>
101
+ </li></ul>
102
+
103
+ <h1>Specification</h1>
104
+
105
+ <p>Libraries can be added to local or remote file targets in a
106
+ Sprout::Specification. When calling add_library, one must provide the
107
+ library name (symbol that will be used from Rake) and a relative path (or
108
+ Array of paths) from the Specification to the library file or directory.</p>
109
+
110
+ <p>Following is an example of a Sprout::Specification that registers a SWC
111
+ that will be distributed directly within a Ruby Gem:</p>
112
+
113
+ <pre class="code"><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Specification</span><span class='period'>.</span><span class='id new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id s'>s</span><span class='op'>|</span>
114
+ <span class='id s'>s</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>asunit4</span><span class='tstring_end'>&quot;</span></span>
115
+ <span class='id s'>s</span><span class='period'>.</span><span class='id version'>version</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>4.4.2</span><span class='tstring_end'>&quot;</span></span>
116
+ <span class='id s'>s</span><span class='period'>.</span><span class='id add_file_target'>add_file_target</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id f'>f</span><span class='op'>|</span>
117
+ <span class='id f'>f</span><span class='period'>.</span><span class='id add_library'>add_library</span> <span class='symbol'>:swc</span><span class='comma'>,</span> <span class='const'>File</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bin</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>AsUnit-4.4.2.swc</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
118
+ <span class='kw'>end</span>
119
+ <span class='kw'>end</span></pre>
120
+
121
+ <p>Following is an example of a Sprout::Specification that registers a ZIP
122
+ archive that will be distributed separately from the Ruby Gem:</p>
123
+
124
+ <pre class="code"><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Specification</span><span class='period'>.</span><span class='id new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id s'>s</span><span class='op'>|</span>
125
+ <span class='id s'>s</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>asunit3</span><span class='tstring_end'>&quot;</span></span>
126
+ <span class='id s'>s</span><span class='period'>.</span><span class='id version'>version</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>3.0.0</span><span class='tstring_end'>&quot;</span></span>
127
+ <span class='id s'>s</span><span class='period'>.</span><span class='id add_remote_file_target'>add_remote_file_target</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id f'>f</span><span class='op'>|</span>
128
+ <span class='id f'>f</span><span class='period'>.</span><span class='id url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://github.com/patternpark/asunit/tree/3.0.0</span><span class='tstring_end'>&quot;</span></span>
129
+ <span class='id f'>f</span><span class='period'>.</span><span class='id md5'>md5</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>abcdefghijklmnopqrstuvwxyz</span><span class='tstring_end'>&quot;</span></span>
130
+ <span class='id f'>f</span><span class='period'>.</span><span class='id add_library'>add_library</span> <span class='symbol'>:swc</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bin/AsUnit-3.0.1.zip</span><span class='tstring_end'>&quot;</span></span>
131
+ <span class='kw'>end</span>
132
+ <span class='kw'>end</span></pre>
133
+
134
+ <p>Libraries can be consumed from any Rakefile without concern for how the
135
+ source code is distributed. Following is an example Rake task that uses the
136
+ AsUnit 4.0 Library:</p>
137
+
138
+ <pre class="code"><span class='comment'># Define the library Rake::Task:
139
+ </span><span class='id library'>library</span> <span class='symbol'>:asunit4</span>
140
+
141
+ <span class='comment'># Add the library as a dependency from another task
142
+ </span><span class='comment'># that should know how to properly associate the files:
143
+ </span><span class='id mxmlc'>mxmlc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bin/SomeProject.swf</span><span class='tstring_end'>'</span></span> <span class='op'>=&gt;</span> <span class='symbol'>:asunit4</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id t'>t</span><span class='op'>|</span>
144
+ <span class='id t'>t</span><span class='period'>.</span><span class='id input'>input</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>src/SomeProject.as</span><span class='tstring_end'>'</span></span>
145
+ <span class='kw'>end</span></pre>
146
+
147
+ <p>When the library task is executed, the library should be resolved and
148
+ expanded into the project. When the mxmlc task is executed, the installed
149
+ library should be associated with the compilation command.</p>
150
+
151
+ <h1>Flash Libraries</h1>
152
+
153
+ <p>Following are links to the Specifications for some of the existing
154
+ libraries:</p>
155
+ <hr style="height: 1px">
156
+
157
+ <p>Previous Topic: <span class='object_link'><a href="Generator.html" title="Sprout::Generator (module)">Generator</a></span></p>
158
+
159
+ <p>Next Topic: <span class='object_link'><a href="Executable.html" title="Sprout::Executable (module)">Executable</a></span></p>
160
+ <hr style="height: 1px">
161
+
162
+
163
+ </div>
164
+ </div>
165
+ <div class="tags">
166
+
167
+ <h3>See Also:</h3>
168
+ <ul class="see">
169
+
170
+ <li><span class='object_link'><a href="Generator.html" title="Sprout::Generator (module)">Generator</a></span></li>
171
+
172
+ <li><span class='object_link'><a href="Executable.html" title="Sprout::Executable (module)">Executable</a></span></li>
173
+
174
+ <li><span class='object_link'><a href="Specification.html" title="Sprout::Specification (class)">Specification</a></span></li>
175
+
176
+ <li><span class='object_link'><a href="RubyFeature.html" title="Sprout::RubyFeature (module)">RubyFeature</a></span></li>
177
+
178
+ <li><span class='object_link'><a href="System.html" title="Sprout::System (module)">System</a></span></li>
179
+
180
+ </ul>
181
+
182
+ </div>
183
+ <h2>Constant Summary</h2>
184
+
185
+ <dl class="constants">
186
+
187
+ <dt id="TASK_NAME-constant" class="">TASK_NAME =
188
+
189
+ </dt>
190
+ <dd><pre class="code"><span class='symbol'>:resolve_sprout_libraries</span></pre></dd>
191
+
192
+ </dl>
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
205
+ <ul class="summary">
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#file_target-instance_method" title="#file_target (instance method)">- (Object) <strong>file_target</strong> </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <span class="summary_desc"><div class='inline'>
227
+ <p>Returns the value of attribute file_target.</p>
228
+ </div></span>
229
+
230
+ </li>
231
+
232
+
233
+ <li class="public ">
234
+ <span class="summary_signature">
235
+
236
+ <a href="#installed_project_path-instance_method" title="#installed_project_path (instance method)">- (Object) <strong>installed_project_path</strong> </a>
237
+
238
+
239
+
240
+ </span>
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <span class="summary_desc"><div class='inline'>
253
+ <p>Returns the value of attribute installed_project_path.</p>
254
+ </div></span>
255
+
256
+ </li>
257
+
258
+
259
+ <li class="public ">
260
+ <span class="summary_signature">
261
+
262
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
263
+
264
+
265
+
266
+ </span>
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <span class="summary_desc"><div class='inline'>
279
+ <p>Returns the value of attribute name.</p>
280
+ </div></span>
281
+
282
+ </li>
283
+
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong> </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <span class="summary_desc"><div class='inline'>
305
+ <p>Returns the value of attribute path.</p>
306
+ </div></span>
307
+
308
+ </li>
309
+
310
+
311
+ <li class="public ">
312
+ <span class="summary_signature">
313
+
314
+ <a href="#pkg_name-instance_method" title="#pkg_name (instance method)">- (Object) <strong>pkg_name</strong> </a>
315
+
316
+
317
+
318
+ </span>
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+ <span class="summary_desc"><div class='inline'>
331
+ <p>Returns the value of attribute pkg_name.</p>
332
+ </div></span>
333
+
334
+ </li>
335
+
336
+
337
+ <li class="public ">
338
+ <span class="summary_signature">
339
+
340
+ <a href="#pkg_version-instance_method" title="#pkg_version (instance method)">- (Object) <strong>pkg_version</strong> </a>
341
+
342
+
343
+
344
+ </span>
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+ <span class="summary_desc"><div class='inline'>
357
+ <p>Returns the value of attribute pkg_version.</p>
358
+ </div></span>
359
+
360
+ </li>
361
+
362
+
363
+ <li class="public ">
364
+ <span class="summary_signature">
365
+
366
+ <a href="#platform-instance_method" title="#platform (instance method)">- (Object) <strong>platform</strong> </a>
367
+
368
+
369
+
370
+ </span>
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+ <span class="summary_desc"><div class='inline'>
383
+ <p>Returns the value of attribute platform.</p>
384
+ </div></span>
385
+
386
+ </li>
387
+
388
+
389
+ </ul>
390
+
391
+
392
+
393
+ <h2>
394
+ Class Method Summary
395
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
396
+ </h2>
397
+
398
+ <ul class="summary">
399
+
400
+ <li class="public ">
401
+ <span class="summary_signature">
402
+
403
+ <a href="#define_task-class_method" title="define_task (class method)">+ (Object) <strong>define_task</strong>(name = nil, pkg_name = nil, pkg_version = nil) </a>
404
+
405
+
406
+
407
+ </span>
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+ <span class="summary_desc"><div class='inline'>
417
+ <p>Create Rake tasks that will load and install a particular library into the
418
+ current project.</p>
419
+ </div></span>
420
+
421
+ </li>
422
+
423
+
424
+ <li class="public ">
425
+ <span class="summary_signature">
426
+
427
+ <a href="#project_path-class_method" title="project_path (class method)">+ (Object) <strong>project_path</strong> </a>
428
+
429
+
430
+
431
+ </span>
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+ <span class="summary_desc"><div class='inline'>
441
+ <p>The path within a project where libraries should be added.</p>
442
+ </div></span>
443
+
444
+ </li>
445
+
446
+
447
+ <li class="public ">
448
+ <span class="summary_signature">
449
+
450
+ <a href="#project_path%3D-class_method" title="project_path= (class method)">+ (Object) <strong>project_path=</strong>(path) </a>
451
+
452
+
453
+
454
+ </span>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+ <span class="summary_desc"><div class='inline'>
464
+ <p>Set the path within a project where libraries should be loaded.</p>
465
+ </div></span>
466
+
467
+ </li>
468
+
469
+
470
+ </ul>
471
+
472
+ <h2>
473
+ Instance Method Summary
474
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
475
+ </h2>
476
+
477
+ <ul class="summary">
478
+
479
+ <li class="public ">
480
+ <span class="summary_signature">
481
+
482
+ <a href="#create_installation_tasks-instance_method" title="#create_installation_tasks (instance method)">- (Object) <strong>create_installation_tasks</strong> </a>
483
+
484
+
485
+
486
+ </span>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+ <span class="summary_desc"><div class='inline'>
496
+ <p>Returns the outer Rake::Task which is invokable.</p>
497
+ </div></span>
498
+
499
+ </li>
500
+
501
+
502
+ <li class="public ">
503
+ <span class="summary_signature">
504
+
505
+ <a href="#create_outer_task-instance_method" title="#create_outer_task (instance method)">- (Object) <strong>create_outer_task</strong> </a>
506
+
507
+
508
+
509
+ </span>
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+ <span class="summary_desc"><div class='inline'></div></span>
519
+
520
+ </li>
521
+
522
+
523
+ <li class="public ">
524
+ <span class="summary_signature">
525
+
526
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Library) <strong>initialize</strong>(params = nil) </a>
527
+
528
+
529
+
530
+ </span>
531
+
532
+ <span class="note title constructor">constructor</span>
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+ <span class="summary_desc"><div class='inline'>
542
+ <p>A new instance of Library.</p>
543
+ </div></span>
544
+
545
+ </li>
546
+
547
+
548
+ </ul>
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concern.html" title="Sprout::Concern (module)">Concern</a></span></h3>
565
+ <p class="inherited"><span class='object_link'><a href="Concern.html#append_features-instance_method" title="Sprout::Concern#append_features (method)">#append_features</a></span>, <span class='object_link'><a href="Concern.html#extended-class_method" title="Sprout::Concern.extended (method)">extended</a></span>, <span class='object_link'><a href="Concern.html#included-instance_method" title="Sprout::Concern#included (method)">#included</a></span></p>
566
+ <div id="constructor_details" class="method_details_list">
567
+ <h2>Constructor Details</h2>
568
+
569
+ <div class="method_details first">
570
+ <p class="signature first" id="initialize-instance_method">
571
+
572
+ - (<tt><span class='object_link'><a href="" title="Sprout::Library (class)">Library</a></span></tt>) <strong>initialize</strong>(params = nil)
573
+
574
+
575
+
576
+ </p><div class="docstring">
577
+ <div class="discussion">
578
+
579
+ <p>A new instance of Library</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
+ 142
593
+ 143
594
+ 144
595
+ 145</pre>
596
+ </td>
597
+ <td>
598
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 142</span>
599
+
600
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span> <span class='id params'>params</span><span class='op'>=</span><span class='kw'>nil</span>
601
+ <span class='id params'>params</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id key'>key</span><span class='comma'>,</span><span class='id value'>value</span><span class='op'>|</span> <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id key'>key</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id value'>value</span><span class='rparen'>)</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id params'>params</span><span class='period'>.</span><span class='id nil?'>nil?</span>
602
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
603
+ <span class='kw'>end</span></pre>
604
+ </td>
605
+ </tr>
606
+ </table>
607
+ </div>
608
+
609
+ </div>
610
+
611
+ <div id="instance_attr_details" class="attr_details">
612
+ <h2>Instance Attribute Details</h2>
613
+
614
+
615
+ <span id="file_target=-instance_method"></span>
616
+ <span id="file_target-instance_method"></span>
617
+ <div class="method_details first">
618
+ <p class="signature first" id="file_target-instance_method">
619
+
620
+ - (<tt>Object</tt>) <strong>file_target</strong>
621
+
622
+
623
+
624
+ </p><div class="docstring">
625
+ <div class="discussion">
626
+
627
+ <p>Returns the value of attribute file_target</p>
628
+
629
+
630
+ </div>
631
+ </div>
632
+ <div class="tags">
633
+
634
+ </div><table class="source_code">
635
+ <tr>
636
+ <td>
637
+ <pre class="lines">
638
+
639
+
640
+ 90
641
+ 91
642
+ 92</pre>
643
+ </td>
644
+ <td>
645
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 90</span>
646
+
647
+ <span class='kw'>def</span> <span class='id file_target'>file_target</span>
648
+ <span class='ivar'>@file_target</span>
649
+ <span class='kw'>end</span></pre>
650
+ </td>
651
+ </tr>
652
+ </table>
653
+ </div>
654
+
655
+
656
+ <span id="installed_project_path=-instance_method"></span>
657
+ <span id="installed_project_path-instance_method"></span>
658
+ <div class="method_details ">
659
+ <p class="signature " id="installed_project_path-instance_method">
660
+
661
+ - (<tt>Object</tt>) <strong>installed_project_path</strong>
662
+
663
+
664
+
665
+ </p><div class="docstring">
666
+ <div class="discussion">
667
+
668
+ <p>Returns the value of attribute installed_project_path</p>
669
+
670
+
671
+ </div>
672
+ </div>
673
+ <div class="tags">
674
+
675
+ </div><table class="source_code">
676
+ <tr>
677
+ <td>
678
+ <pre class="lines">
679
+
680
+
681
+ 91
682
+ 92
683
+ 93</pre>
684
+ </td>
685
+ <td>
686
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 91</span>
687
+
688
+ <span class='kw'>def</span> <span class='id installed_project_path'>installed_project_path</span>
689
+ <span class='ivar'>@installed_project_path</span>
690
+ <span class='kw'>end</span></pre>
691
+ </td>
692
+ </tr>
693
+ </table>
694
+ </div>
695
+
696
+
697
+ <span id="name=-instance_method"></span>
698
+ <span id="name-instance_method"></span>
699
+ <div class="method_details ">
700
+ <p class="signature " id="name-instance_method">
701
+
702
+ - (<tt>Object</tt>) <strong>name</strong>
703
+
704
+
705
+
706
+ </p><div class="docstring">
707
+ <div class="discussion">
708
+
709
+ <p>Returns the value of attribute name</p>
710
+
711
+
712
+ </div>
713
+ </div>
714
+ <div class="tags">
715
+
716
+ </div><table class="source_code">
717
+ <tr>
718
+ <td>
719
+ <pre class="lines">
720
+
721
+
722
+ 92
723
+ 93
724
+ 94</pre>
725
+ </td>
726
+ <td>
727
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 92</span>
728
+
729
+ <span class='kw'>def</span> <span class='id name'>name</span>
730
+ <span class='ivar'>@name</span>
731
+ <span class='kw'>end</span></pre>
732
+ </td>
733
+ </tr>
734
+ </table>
735
+ </div>
736
+
737
+
738
+ <span id="path=-instance_method"></span>
739
+ <span id="path-instance_method"></span>
740
+ <div class="method_details ">
741
+ <p class="signature " id="path-instance_method">
742
+
743
+ - (<tt>Object</tt>) <strong>path</strong>
744
+
745
+
746
+
747
+ </p><div class="docstring">
748
+ <div class="discussion">
749
+
750
+ <p>Returns the value of attribute path</p>
751
+
752
+
753
+ </div>
754
+ </div>
755
+ <div class="tags">
756
+
757
+ </div><table class="source_code">
758
+ <tr>
759
+ <td>
760
+ <pre class="lines">
761
+
762
+
763
+ 93
764
+ 94
765
+ 95</pre>
766
+ </td>
767
+ <td>
768
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 93</span>
769
+
770
+ <span class='kw'>def</span> <span class='id path'>path</span>
771
+ <span class='ivar'>@path</span>
772
+ <span class='kw'>end</span></pre>
773
+ </td>
774
+ </tr>
775
+ </table>
776
+ </div>
777
+
778
+
779
+ <span id="pkg_name=-instance_method"></span>
780
+ <span id="pkg_name-instance_method"></span>
781
+ <div class="method_details ">
782
+ <p class="signature " id="pkg_name-instance_method">
783
+
784
+ - (<tt>Object</tt>) <strong>pkg_name</strong>
785
+
786
+
787
+
788
+ </p><div class="docstring">
789
+ <div class="discussion">
790
+
791
+ <p>Returns the value of attribute pkg_name</p>
792
+
793
+
794
+ </div>
795
+ </div>
796
+ <div class="tags">
797
+
798
+ </div><table class="source_code">
799
+ <tr>
800
+ <td>
801
+ <pre class="lines">
802
+
803
+
804
+ 94
805
+ 95
806
+ 96</pre>
807
+ </td>
808
+ <td>
809
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 94</span>
810
+
811
+ <span class='kw'>def</span> <span class='id pkg_name'>pkg_name</span>
812
+ <span class='ivar'>@pkg_name</span>
813
+ <span class='kw'>end</span></pre>
814
+ </td>
815
+ </tr>
816
+ </table>
817
+ </div>
818
+
819
+
820
+ <span id="pkg_version=-instance_method"></span>
821
+ <span id="pkg_version-instance_method"></span>
822
+ <div class="method_details ">
823
+ <p class="signature " id="pkg_version-instance_method">
824
+
825
+ - (<tt>Object</tt>) <strong>pkg_version</strong>
826
+
827
+
828
+
829
+ </p><div class="docstring">
830
+ <div class="discussion">
831
+
832
+ <p>Returns the value of attribute pkg_version</p>
833
+
834
+
835
+ </div>
836
+ </div>
837
+ <div class="tags">
838
+
839
+ </div><table class="source_code">
840
+ <tr>
841
+ <td>
842
+ <pre class="lines">
843
+
844
+
845
+ 95
846
+ 96
847
+ 97</pre>
848
+ </td>
849
+ <td>
850
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 95</span>
851
+
852
+ <span class='kw'>def</span> <span class='id pkg_version'>pkg_version</span>
853
+ <span class='ivar'>@pkg_version</span>
854
+ <span class='kw'>end</span></pre>
855
+ </td>
856
+ </tr>
857
+ </table>
858
+ </div>
859
+
860
+
861
+ <span id="platform=-instance_method"></span>
862
+ <span id="platform-instance_method"></span>
863
+ <div class="method_details ">
864
+ <p class="signature " id="platform-instance_method">
865
+
866
+ - (<tt>Object</tt>) <strong>platform</strong>
867
+
868
+
869
+
870
+ </p><div class="docstring">
871
+ <div class="discussion">
872
+
873
+ <p>Returns the value of attribute platform</p>
874
+
875
+
876
+ </div>
877
+ </div>
878
+ <div class="tags">
879
+
880
+ </div><table class="source_code">
881
+ <tr>
882
+ <td>
883
+ <pre class="lines">
884
+
885
+
886
+ 96
887
+ 97
888
+ 98</pre>
889
+ </td>
890
+ <td>
891
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 96</span>
892
+
893
+ <span class='kw'>def</span> <span class='id platform'>platform</span>
894
+ <span class='ivar'>@platform</span>
895
+ <span class='kw'>end</span></pre>
896
+ </td>
897
+ </tr>
898
+ </table>
899
+ </div>
900
+
901
+ </div>
902
+
903
+
904
+ <div id="class_method_details" class="method_details_list">
905
+ <h2>Class Method Details</h2>
906
+
907
+
908
+ <div class="method_details first">
909
+ <p class="signature first" id="define_task-class_method">
910
+
911
+ + (<tt>Object</tt>) <strong>define_task</strong>(name = nil, pkg_name = nil, pkg_version = nil)
912
+
913
+
914
+
915
+ </p><div class="docstring">
916
+ <div class="discussion">
917
+
918
+ <p>Create Rake tasks that will load and install a particular library into the
919
+ current project.</p>
920
+
921
+ <p>This method is usually accessed from the global library helper.</p>
922
+
923
+ <pre class="code"><span class='id library'>library</span> <span class='symbol'>:asunit4</span></pre>
924
+
925
+
926
+ </div>
927
+ </div>
928
+ <div class="tags">
929
+
930
+ </div><table class="source_code">
931
+ <tr>
932
+ <td>
933
+ <pre class="lines">
934
+
935
+
936
+ 136
937
+ 137
938
+ 138
939
+ 139</pre>
940
+ </td>
941
+ <td>
942
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 136</span>
943
+
944
+ <span class='kw'>def</span> <span class='id define_task'>define_task</span> <span class='id name'>name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id pkg_name'>pkg_name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id pkg_version'>pkg_version</span><span class='op'>=</span><span class='kw'>nil</span>
945
+ <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 load'>load</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id pkg_name'>pkg_name</span><span class='comma'>,</span> <span class='id pkg_version'>pkg_version</span>
946
+ <span class='id library'>library</span><span class='period'>.</span><span class='id create_installation_tasks'>create_installation_tasks</span>
947
+ <span class='kw'>end</span></pre>
948
+ </td>
949
+ </tr>
950
+ </table>
951
+ </div>
952
+
953
+ <div class="method_details ">
954
+ <p class="signature " id="project_path-class_method">
955
+
956
+ + (<tt>Object</tt>) <strong>project_path</strong>
957
+
958
+
959
+
960
+ </p><div class="docstring">
961
+ <div class="discussion">
962
+
963
+ <p>The path within a project where libraries should be added.</p>
964
+
965
+ <p>Defaults to 'lib'</p>
966
+
967
+ <p>From anywhere in your Rakefile, you can output this value with:</p>
968
+
969
+ <pre class="code"><span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&gt;&gt; Library Project Path: </span><span class='embexpr_beg'>#{</span><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Library</span><span class='period'>.</span><span class='id project_path'>project_path</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span></pre>
970
+
971
+
972
+ </div>
973
+ </div>
974
+ <div class="tags">
975
+
976
+ </div><table class="source_code">
977
+ <tr>
978
+ <td>
979
+ <pre class="lines">
980
+
981
+
982
+ 123
983
+ 124
984
+ 125</pre>
985
+ </td>
986
+ <td>
987
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 123</span>
988
+
989
+ <span class='kw'>def</span> <span class='id project_path'>project_path</span>
990
+ <span class='ivar'>@project_path</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span>
991
+ <span class='kw'>end</span></pre>
992
+ </td>
993
+ </tr>
994
+ </table>
995
+ </div>
996
+
997
+ <div class="method_details ">
998
+ <p class="signature " id="project_path=-class_method">
999
+
1000
+ + (<tt>Object</tt>) <strong>project_path=</strong>(path)
1001
+
1002
+
1003
+
1004
+ </p><div class="docstring">
1005
+ <div class="discussion">
1006
+
1007
+ <p>Set the path within a project where libraries should be loaded.</p>
1008
+
1009
+ <p>From top of your Rakefile, you can set this value with:</p>
1010
+
1011
+ <pre class="code"><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Library</span><span class='period'>.</span><span class='id project_path'>project_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>libs</span><span class='tstring_end'>'</span></span></pre>
1012
+
1013
+
1014
+ </div>
1015
+ </div>
1016
+ <div class="tags">
1017
+
1018
+ </div><table class="source_code">
1019
+ <tr>
1020
+ <td>
1021
+ <pre class="lines">
1022
+
1023
+
1024
+ 108
1025
+ 109
1026
+ 110</pre>
1027
+ </td>
1028
+ <td>
1029
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 108</span>
1030
+
1031
+ <span class='kw'>def</span> <span class='id project_path='>project_path=</span><span class='lparen'>(</span><span class='id path'>path</span><span class='rparen'>)</span>
1032
+ <span class='ivar'>@project_path</span> <span class='op'>=</span> <span class='id path'>path</span>
1033
+ <span class='kw'>end</span></pre>
1034
+ </td>
1035
+ </tr>
1036
+ </table>
1037
+ </div>
1038
+
1039
+ </div>
1040
+
1041
+ <div id="instance_method_details" class="method_details_list">
1042
+ <h2>Instance Method Details</h2>
1043
+
1044
+
1045
+ <div class="method_details first">
1046
+ <p class="signature first" id="create_installation_tasks-instance_method">
1047
+
1048
+ - (<tt>Object</tt>) <strong>create_installation_tasks</strong>
1049
+
1050
+
1051
+
1052
+ </p><div class="docstring">
1053
+ <div class="discussion">
1054
+
1055
+ <p>Returns the outer Rake::Task which is invokable.</p>
1056
+
1057
+
1058
+ </div>
1059
+ </div>
1060
+ <div class="tags">
1061
+
1062
+ </div><table class="source_code">
1063
+ <tr>
1064
+ <td>
1065
+ <pre class="lines">
1066
+
1067
+
1068
+ 149
1069
+ 150
1070
+ 151
1071
+ 152
1072
+ 153</pre>
1073
+ </td>
1074
+ <td>
1075
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 149</span>
1076
+
1077
+ <span class='kw'>def</span> <span class='id create_installation_tasks'>create_installation_tasks</span>
1078
+ <span class='id define_lib_dir_task_if_necessary'>define_lib_dir_task_if_necessary</span> <span class='id project_path'>project_path</span>
1079
+ <span class='id create_project_tasks'>create_project_tasks</span>
1080
+ <span class='id create_outer_task'>create_outer_task</span>
1081
+ <span class='kw'>end</span></pre>
1082
+ </td>
1083
+ </tr>
1084
+ </table>
1085
+ </div>
1086
+
1087
+ <div class="method_details ">
1088
+ <p class="signature " id="create_outer_task-instance_method">
1089
+
1090
+ - (<tt>Object</tt>) <strong>create_outer_task</strong>
1091
+
1092
+
1093
+
1094
+ </p><table class="source_code">
1095
+ <tr>
1096
+ <td>
1097
+ <pre class="lines">
1098
+
1099
+
1100
+ 155
1101
+ 156
1102
+ 157
1103
+ 158
1104
+ 159
1105
+ 160
1106
+ 161
1107
+ 162
1108
+ 163
1109
+ 164
1110
+ 165
1111
+ 166
1112
+ 167</pre>
1113
+ </td>
1114
+ <td>
1115
+ <pre class="code"><span class="info file"># File 'lib/sprout/library.rb', line 155</span>
1116
+
1117
+ <span class='kw'>def</span> <span class='id create_outer_task'>create_outer_task</span>
1118
+ <span class='id t'>t</span> <span class='op'>=</span> <span class='id task'>task</span> <span class='id pkg_name'>pkg_name</span>
1119
+ <span class='comment'># This helps executable rake tasks decide if they
1120
+ </span> <span class='comment'># want to do something special for library tasks.
1121
+ </span> <span class='id t'>t</span><span class='period'>.</span><span class='id sprout_entity'>sprout_entity</span> <span class='op'>=</span> <span class='kw'>self</span>
1122
+ <span class='kw'>class</span> <span class='op'>&lt;&lt;</span> <span class='id t'>t</span>
1123
+ <span class='kw'>def</span> <span class='id sprout_library?'>sprout_library?</span>
1124
+ <span class='op'>!</span><span class='id sprout_entity'>sprout_entity</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='op'>&amp;&amp;</span>
1125
+ <span class='id sprout_entity'>sprout_entity</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Sprout</span><span class='op'>::</span><span class='const'>Library</span><span class='rparen'>)</span>
1126
+ <span class='kw'>end</span>
1127
+ <span class='kw'>end</span>
1128
+ <span class='id t'>t</span>
1129
+ <span class='kw'>end</span></pre>
1130
+ </td>
1131
+ </tr>
1132
+ </table>
1133
+ </div>
1134
+
1135
+ </div>
1136
+
1137
+ </div>
1138
+
1139
+ <div id="footer">
1140
+ Generated on Fri Apr 29 18:33:05 2011 by
1141
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1142
+ 0.6.3 (ruby-1.9.2).
1143
+ </div>
1144
+
1145
+ </body>
1146
+ </html>