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