Added: dev/buildr/1.5.8/site/rdoc/Buildr/Package.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Package.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Package.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,452 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::Package - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation"
class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section
initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+ <div id="includes-section" class="nav-section">
+ <h3>Included Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="include" href="Extension.html">Buildr::Extension</a>
+
+
+ </ul>
+</div>
+
+ <div id="extends-section" class="nav-section">
+ <h3>Extended With Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="extend" href="ActsAsArtifact.html">Buildr::ActsAsArtifact</a>
+
+
+ </ul>
+</div>
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-i-id">#id</a>
+
+ <li ><a href="#method-i-package">#package</a>
+
+ <li ><a href="#method-i-packages">#packages</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::Package">
+ <h1 id="module-Buildr::Package" class="module">
+ module Buildr::Package
+ </h1>
+
+ <section class="description">
+
+<p>Methods added to <a href="Project.html">Project</a> to support packaging
+and tasks for packaging, installing and uploading packages.</p>
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+ <section class="attribute-method-details" class="method-section">
+ <header>
+ <h3>Attributes</h3>
+ </header>
+
+
+ <div id="attribute-i-group" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">group</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Group used for packaging. Inherited from parent project. Defaults
to the
+top-level project name.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-version" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">version</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Version used for packaging. Inherited from parent project.</p>
+
+ </div>
+ </div>
+
+ </section>
+
+
+
+ <section id="public-instance-5Buntitled-5D-method-details"
class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
+
+
+ <div id="method-i-id" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">id</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>The project's identifier. Same as the project name, with
colons
+replaced by dashes. The ID for project foo:bar is foo-bar.</p>
+
+
+
+
+ <div class="method-source-code" id="id-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/packaging/package.rb, line 53</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">id</span>
+ <span class="ruby-identifier">name</span>.<span
class="ruby-identifier">gsub</span>(<span
class="ruby-string">':'</span>, <span
class="ruby-string">'-'</span>)
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-package" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ package(type, spec?) → task
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Defines and returns a package created by this project.</p>
+
+<p>The first argument declares the package type. For example, :jar to create a
+JAR file. The package is an artifact that takes its artifact specification
+from the project. You can override the artifact specification by passing
+various options in the second argument, for example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">package</span>(:<span
class="ruby-identifier">zip</span>, :<span
class="ruby-identifier">classifier=</span><span
class="ruby-operator">></span><span
class="ruby-string">'sources'</span>)
+</pre>
+
+<p>Packages that are ZIP files provides various ways to include additional
+files, directories, and even merge ZIPs together. Have a look at <a
+href="ZipTask.html">ZipTask</a> for more information. In case you're
+wondering, JAR and WAR packages are ZIP files.</p>
+
+<p>You can also enhance a JAR package using the <a
+href="ArchiveTask.html#method-i-with">Buildr::ArchiveTask#with</a> method
+that accepts the following options:</p>
+<ul><li>
+<p>:manifest â Specifies how to create the MANIFEST.MF. By default, uses the
+project's manifest property.</p>
+</li><li>
+<p>:meta_inf â Specifies files to be included in the META-INF directory. By
+default, uses the project's meta-inf property.</p>
+</li></ul>
+
+<p>The WAR package supports the same options and adds a few more:</p>
+<ul><li>
+<p>:classes â Directories of class files to include in WEB-INF/classes.
+Includes the compile target directory by default.</p>
+</li><li>
+<p>:libs â Artifacts and files to include in WEB-INF/libs. Includes the
+compile classpath dependencies by default.</p>
+</li></ul>
+
+<p>For example:</p>
+
+<pre class="ruby"> <span class="ruby-identifier">define</span> <span
class="ruby-string">'project'</span> <span
class="ruby-keyword">do</span>
+ <span class="ruby-identifier">define</span> <span
class="ruby-string">'beans'</span> <span class="ruby-keyword">do</span>
+ <span class="ruby-identifier">package</span> :<span
class="ruby-identifier">jar</span>
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-identifier">define</span> <span
class="ruby-string">'webapp'</span> <span class="ruby-keyword">do</span>
+ <span class="ruby-identifier">compile</span>.<span
class="ruby-identifier">with</span> <span
class="ruby-identifier">project</span>(<span
class="ruby-string">'beans'</span>)
+ <span class="ruby-identifier">package</span>(:<span
class="ruby-identifier">war</span>).<span class="ruby-identifier">with</span>
:<span class="ruby-identifier">libs=</span><span
class="ruby-operator">></span><span class="ruby-constant">MYSQL_JDBC</span>
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-identifier">package</span>(:<span
class="ruby-identifier">zip</span>, :<span
class="ruby-identifier">classifier=</span><span
class="ruby-operator">></span><span
class="ruby-string">'sources'</span>).<span
class="ruby-identifier">include</span> <span
class="ruby-identifier">path_to</span>(<span
class="ruby-string">'.'</span>)
+<span class="ruby-keyword">end</span>
+</pre>
+
+<p>Two other packaging types are:</p>
+<ul><li>
+<p>package :sources â Creates a JAR file with the source code and classifier
+'sources', for use by IDEs.</p>
+</li><li>
+<p>package :javadoc â Creates a ZIP file with the Javadocs and classifier
+'javadoc'. You can use the javadoc method to further customize it.</p>
+</li></ul>
+
+<p>A package is also an artifact. The following tasks operate on packages
+created by the project:</p>
+
+<pre class="ruby"><span class="ruby-identifier">buildr</span> <span
class="ruby-identifier">upload</span> <span class="ruby-comment"># Upload
packages created by the project</span>
+<span class="ruby-identifier">buildr</span> <span
class="ruby-identifier">install</span> <span class="ruby-comment"># Install
packages created by the project</span>
+<span class="ruby-identifier">buildr</span> <span
class="ruby-identifier">package</span> <span class="ruby-comment"># Create
packages</span>
+<span class="ruby-identifier">buildr</span> <span
class="ruby-identifier">uninstall</span> <span class="ruby-comment"># Remove
previously installed packages</span>
+</pre>
+
+<p>If you want to add additional packaging types, implement a method with the
+name <a href="type">package_as_</a> that accepts a file name and returns an
+appropriate <a href="../Rake.html">Rake</a> task. For example:</p>
+
+<pre class="ruby"><span class="ruby-keyword">def</span> <span
class="ruby-identifier">package_as_zip</span>(<span
class="ruby-identifier">file_name</span>) <span
class="ruby-comment">#:nodoc:</span>
+ <span class="ruby-constant">ZipTask</span>.<span
class="ruby-identifier">define_task</span>(<span
class="ruby-identifier">file_name</span>)
+<span class="ruby-keyword">end</span>
+</pre>
+
+<p>The file name is determined from the specification passed to the package
+method, however, some packagers need to override this. For example,
+package(:sources) produces a file with the extension 'jar' and the
+classifier 'sources'. If you need to overwrite the default
+implementation, you should also include a method named <a
+href="type">package_as_</a>_spec. For example:</p>
+
+<pre class="ruby"><span class="ruby-keyword">def</span> <span
class="ruby-identifier">package_as_sources_spec</span>(<span
class="ruby-identifier">spec</span>) <span class="ruby-comment">#:nodoc:</span>
+ <span class="ruby-comment"># Change the source distribution to .zip
extension</span>
+ <span class="ruby-identifier">spec</span>.<span
class="ruby-identifier">merge</span>({ :<span
class="ruby-identifier">type=</span><span
class="ruby-operator">></span>:<span class="ruby-identifier">zip</span>,
:<span class="ruby-identifier">classifier=</span><span
class="ruby-operator">></span><span
class="ruby-string">'sources'</span> })
+<span class="ruby-keyword">end</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="package-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/packaging/package.rb, line 127</span>
+<span class="ruby-keyword">def</span> <span
class="ruby-identifier">package</span>(<span
class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+ <span class="ruby-identifier">spec</span> = <span
class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span
class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>
<span class="ruby-operator">?</span> <span
class="ruby-identifier">args</span>.<span
class="ruby-identifier">pop</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-operator">:</span> {}
+ <span class="ruby-identifier">no_options</span> = <span
class="ruby-identifier">spec</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-comment"># since spec is mutated</span>
+ <span class="ruby-keyword">if</span> <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:file</span>]
+ <span class="ruby-identifier">rake_check_options</span> <span
class="ruby-identifier">spec</span>, <span class="ruby-value">:file</span>,
<span class="ruby-value">:type</span>
+ <span class="ruby-identifier">spec</span>[<span
class="ruby-value">:type</span>] = <span
class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-operator">||</span> <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:type</span>]
<span class="ruby-operator">||</span> <span
class="ruby-identifier">spec</span>[<span
class="ruby-value">:file</span>].<span
class="ruby-identifier">split</span>(<span
class="ruby-string">'.'</span>).<span
class="ruby-identifier">last</span>.<span class="ruby-identifier">to_sym</span>
+ <span class="ruby-identifier">file_name</span> = <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:file</span>]
+ <span class="ruby-keyword">else</span>
+ <span class="ruby-identifier">rake_check_options</span> <span
class="ruby-identifier">spec</span>, <span class="ruby-operator">*</span><span
class="ruby-constant">ActsAsArtifact</span><span
class="ruby-operator">::</span><span
class="ruby-constant">ARTIFACT_ATTRIBUTES</span>
+ <span class="ruby-identifier">spec</span>[<span
class="ruby-value">:id</span>] <span class="ruby-operator">||=</span> <span
class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>
+ <span class="ruby-identifier">spec</span>[<span
class="ruby-value">:group</span>] <span class="ruby-operator">||=</span> <span
class="ruby-keyword">self</span>.<span class="ruby-identifier">group</span>
+ <span class="ruby-identifier">spec</span>[<span
class="ruby-value">:version</span>] <span class="ruby-operator">||=</span>
<span class="ruby-keyword">self</span>.<span
class="ruby-identifier">version</span>
+ <span class="ruby-identifier">spec</span>[<span
class="ruby-value">:type</span>] = <span
class="ruby-identifier">args</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-operator">||</span> <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:type</span>]
<span class="ruby-operator">||</span> <span
class="ruby-identifier">compile</span>.<span
class="ruby-identifier">packaging</span> <span class="ruby-operator">||</span>
<span class="ruby-value">:zip</span>
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-identifier">packager</span> = <span
class="ruby-identifier">method</span>(<span
class="ruby-node">"package_as_#{spec[:type]}"</span>) <span
class="ruby-keyword">rescue</span> <span
class="ruby-identifier">fail</span>(<span class="ruby-node">"Don't
know how to create a package of type #{spec[:type]}"</span>)
+ <span class="ruby-keyword">if</span> <span
class="ruby-identifier">packager</span>.<span
class="ruby-identifier">arity</span> <span class="ruby-operator">==</span>
<span class="ruby-value">1</span>
+ <span class="ruby-keyword">unless</span> <span
class="ruby-identifier">file_name</span>
+ <span class="ruby-identifier">spec</span> = <span
class="ruby-identifier">send</span>(<span
class="ruby-node">"package_as_#{spec[:type]}_spec"</span>, <span
class="ruby-identifier">spec</span>) <span class="ruby-keyword">if</span> <span
class="ruby-identifier">respond_to?</span>(<span
class="ruby-node">"package_as_#{spec[:type]}_spec"</span>)
+ <span class="ruby-identifier">file_name</span> = <span
class="ruby-identifier">path_to</span>(<span class="ruby-value">:target</span>,
<span class="ruby-constant">Artifact</span>.<span
class="ruby-identifier">hash_to_file_name</span>(<span
class="ruby-identifier">spec</span>))
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-identifier">package</span> = (<span
class="ruby-identifier">no_options</span> <span
class="ruby-operator">&&</span> <span
class="ruby-identifier">packages</span>.<span
class="ruby-identifier">detect</span> { <span
class="ruby-operator">|</span><span class="ruby-identifier">pkg</span><span
class="ruby-operator">|</span> <span class="ruby-identifier">pkg</span>.<span
class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:type</span>]
<span class="ruby-operator">&&</span> (<span
class="ruby-identifier">pkg</span>.<span
class="ruby-identifier">id</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-operator">||</span> <span
class="ruby-identifier">pkg</span>.<span class="ruby-identifier">id</span>
<span class="ruby-operator">==</span> <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:id</span>]) <span
class="ruby-operator">&&
;</span>
+ (<span class="ruby-identifier">pkg</span>.<span
class="ruby-identifier">respond_to?</span>(<span
class="ruby-value">:classifier</span>) <span class="ruby-operator">?</span>
<span class="ruby-identifier">pkg</span>.<span
class="ruby-identifier">classifier</span> <span class="ruby-operator">:</span>
<span class="ruby-keyword">nil</span>) <span class="ruby-operator">==</span>
<span class="ruby-identifier">spec</span>[<span
class="ruby-value">:classifier</span>]}) <span class="ruby-operator">||</span>
+ <span class="ruby-identifier">packages</span>.<span
class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span
class="ruby-identifier">pkg</span><span class="ruby-operator">|</span> <span
class="ruby-identifier">pkg</span>.<span class="ruby-identifier">name</span>
<span class="ruby-operator">==</span> <span
class="ruby-identifier">file_name</span> } <span class="ruby-operator">||</span>
+ <span class="ruby-identifier">packager</span>.<span
class="ruby-identifier">call</span>(<span
class="ruby-identifier">file_name</span>)
+ <span class="ruby-keyword">else</span>
+ <span class="ruby-constant">Buildr</span>.<span
class="ruby-identifier">application</span>.<span
class="ruby-identifier">deprecated</span> <span class="ruby-string">"We
changed the way package_as methods are implemented. See the package method
documentation for more details."</span>
+ <span class="ruby-identifier">file_name</span> <span
class="ruby-operator">||=</span> <span
class="ruby-identifier">path_to</span>(<span class="ruby-value">:target</span>,
<span class="ruby-constant">Artifact</span>.<span
class="ruby-identifier">hash_to_file_name</span>(<span
class="ruby-identifier">spec</span>))
+ <span class="ruby-identifier">package</span> = <span
class="ruby-identifier">packager</span>.<span
class="ruby-identifier">call</span>(<span
class="ruby-identifier">file_name</span>, <span
class="ruby-identifier">spec</span>)
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-comment"># First time: prepare package for install,
uninstall and upload tasks.</span>
+ <span class="ruby-keyword">unless</span> <span
class="ruby-identifier">packages</span>.<span
class="ruby-identifier">include?</span>(<span
class="ruby-identifier">package</span>)
+ <span class="ruby-comment"># We already run build before package, but we
also need to do so if the package itself is</span>
+ <span class="ruby-comment"># used as a dependency, before we get to run
the package task.</span>
+ <span class="ruby-identifier">task</span> <span
class="ruby-string">'package'</span>=<span
class="ruby-operator">></span><span class="ruby-identifier">package</span>
+ <span class="ruby-identifier">package</span>.<span
class="ruby-identifier">enhance</span> [<span
class="ruby-identifier">task</span>(<span
class="ruby-string">'build'</span>)]
+ <span class="ruby-identifier">package</span>.<span
class="ruby-identifier">enhance</span> { <span
class="ruby-identifier">info</span> <span class="ruby-node">"Packaging
#{File.basename(file_name)}"</span> }
+ <span class="ruby-keyword">if</span> <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:file</span>]
+ <span class="ruby-keyword">class</span> <span
class="ruby-operator"><<</span> <span
class="ruby-identifier">package</span> ; <span class="ruby-keyword">self</span>
; <span class="ruby-keyword">end</span>.<span
class="ruby-identifier">send</span>(<span
class="ruby-value">:define_method</span>, <span
class="ruby-value">:type</span>) { <span
class="ruby-identifier">spec</span>[<span class="ruby-value">:type</span>] }
+ <span class="ruby-keyword">class</span> <span
class="ruby-operator"><<</span> <span
class="ruby-identifier">package</span> ; <span class="ruby-keyword">self</span>
; <span class="ruby-keyword">end</span>.<span
class="ruby-identifier">send</span>(<span
class="ruby-value">:define_method</span>, <span class="ruby-value">:id</span>)
{ <span class="ruby-keyword">nil</span> }
+ <span class="ruby-keyword">else</span>
+ <span class="ruby-comment"># Make it an artifact using the
specifications, and tell it how to create a POM.</span>
+ <span class="ruby-identifier">package</span>.<span
class="ruby-identifier">extend</span> <span
class="ruby-constant">ActsAsArtifact</span>
+ <span class="ruby-identifier">package</span>.<span
class="ruby-identifier">buildr_project</span> = <span
class="ruby-keyword">self</span>
+ <span class="ruby-identifier">package</span>.<span
class="ruby-identifier">send</span> <span
class="ruby-value">:apply_spec</span>, <span
class="ruby-identifier">spec</span>.<span
class="ruby-identifier">only</span>(<span class="ruby-operator">*</span><span
class="ruby-constant">Artifact</span><span class="ruby-operator">::</span><span
class="ruby-constant">ARTIFACT_ATTRIBUTES</span>)
+
+ <span class="ruby-comment"># Create pom associated with package</span>
+ <span class="ruby-keyword">class</span> <span
class="ruby-operator"><<</span> <span
class="ruby-identifier">package</span>
+ <span class="ruby-keyword">def</span> <span
class="ruby-identifier">pom</span>
+ <span class="ruby-keyword">unless</span> <span
class="ruby-ivar">@pom</span>
+ <span class="ruby-identifier">pom_filename</span> = <span
class="ruby-constant">Util</span>.<span
class="ruby-identifier">replace_extension</span>(<span
class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span>,
<span class="ruby-string">'pom'</span>)
+ <span class="ruby-identifier">spec</span> = {<span
class="ruby-value">:group=</span><span class="ruby-operator">></span><span
class="ruby-identifier">group</span>, <span class="ruby-value">:id=</span><span
class="ruby-operator">></span><span class="ruby-identifier">id</span>, <span
class="ruby-value">:version=</span><span class="ruby-operator">></span><span
class="ruby-identifier">version</span>, <span
class="ruby-value">:type=</span><span class="ruby-operator">></span><span
class="ruby-value">:pom</span>}
+ <span class="ruby-ivar">@pom</span> = <span
class="ruby-constant">Buildr</span>.<span
class="ruby-identifier">artifact</span>(<span
class="ruby-identifier">spec</span>, <span
class="ruby-identifier">pom_filename</span>)
+ <span class="ruby-ivar">@pom</span>.<span
class="ruby-identifier">content</span> <span
class="ruby-constant">Buildr</span><span class="ruby-operator">::</span><span
class="ruby-constant">CustomPom</span>.<span
class="ruby-identifier">pom_xml</span>(<span
class="ruby-keyword">self</span>.<span
class="ruby-identifier">buildr_project</span>, <span
class="ruby-keyword">self</span>)
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-ivar">@pom</span>
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-keyword">end</span> <span
class="ruby-keyword">if</span> <span
class="ruby-identifier">package</span>.<span
class="ruby-identifier">classifier</span>.<span
class="ruby-identifier">nil?</span>
+
+ <span class="ruby-identifier">file</span>(<span
class="ruby-constant">Buildr</span>.<span
class="ruby-identifier">repositories</span>.<span
class="ruby-identifier">locate</span>(<span
class="ruby-identifier">package</span>)=<span
class="ruby-operator">></span><span class="ruby-identifier">package</span>)
{ <span class="ruby-identifier">package</span>.<span
class="ruby-identifier">install</span> }
+
+ <span class="ruby-comment"># Add the package to the list of packages
created by this project, and</span>
+ <span class="ruby-comment"># register it as an artifact. The later is
required so if we look up the spec</span>
+ <span class="ruby-comment"># we find the package in the project's
target directory, instead of finding it</span>
+ <span class="ruby-comment"># in the local repository and attempting to
install it.</span>
+ <span class="ruby-constant">Artifact</span>.<span
class="ruby-identifier">register</span> <span
class="ruby-identifier">package</span>
+ <span class="ruby-constant">Artifact</span>.<span
class="ruby-identifier">register</span> <span
class="ruby-identifier">package</span>.<span class="ruby-identifier">pom</span>
<span class="ruby-keyword">if</span> <span
class="ruby-identifier">package</span>.<span
class="ruby-identifier">classifier</span>.<span
class="ruby-identifier">nil?</span>
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-identifier">task</span>(<span
class="ruby-string">'install'</span>) { <span
class="ruby-identifier">package</span>.<span
class="ruby-identifier">install</span> <span class="ruby-keyword">if</span>
<span class="ruby-identifier">package</span>.<span
class="ruby-identifier">respond_to?</span>(<span
class="ruby-value">:install</span>) }
+ <span class="ruby-identifier">task</span>(<span
class="ruby-string">'uninstall'</span>) { <span
class="ruby-identifier">package</span>.<span
class="ruby-identifier">uninstall</span> <span class="ruby-keyword">if</span>
<span class="ruby-identifier">package</span>.<span
class="ruby-identifier">respond_to?</span>(<span
class="ruby-value">:uninstall</span>) }
+ <span class="ruby-identifier">task</span>(<span
class="ruby-string">'upload'</span>) { <span
class="ruby-identifier">package</span>.<span
class="ruby-identifier">upload</span> <span class="ruby-keyword">if</span>
<span class="ruby-identifier">package</span>.<span
class="ruby-identifier">respond_to?</span>(<span
class="ruby-value">:upload</span>) }
+
+ <span class="ruby-identifier">packages</span> <span
class="ruby-operator"><<</span> <span
class="ruby-identifier">package</span>
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-identifier">package</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-packages" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ packages → tasks
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns all packages created by this project. A project may
create any
+number of packages.</p>
+
+<p>This method is used whenever you pass a project to Buildr#artifact or any
+other method that accepts artifact specifications and projects. You can use
+it to list all packages created by the project. If you want to return a
+specific package, it is often more convenient to call <a
+href="Package.html#method-i-package">package</a> with the type.</p>
+
+
+
+
+ <div class="method-source-code" id="packages-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/packaging/package.rb, line 215</span>
+<span class="ruby-keyword">def</span> <span
class="ruby-identifier">packages</span>
+ <span class="ruby-ivar">@packages</span> <span
class="ruby-operator">||=</span> []
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer";>Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2.
+ <p>Based on <a
href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a
href="http://deveiate.org";>Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/PackageAsTestJar.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/PackageAsTestJar.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/PackageAsTestJar.html Sun Jul 14 11:16:56
2019
@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::PackageAsTestJar - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation"
class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section
initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+
+
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::PackageAsTestJar">
+ <h1 id="module-Buildr::PackageAsTestJar" class="module">
+ module Buildr::PackageAsTestJar
+ </h1>
+
+ <section class="description">
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer";>Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2.
+ <p>Based on <a
href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a
href="http://deveiate.org";>Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/PackageGemTask.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/PackageGemTask.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/PackageGemTask.html Sun Jul 14 11:16:56
2019
@@ -0,0 +1,237 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::PackageGemTask - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation"
class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section
initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+ <div id="parent-class-section" class="nav-section">
+ <h3>Parent</h3>
+
+
+ <p class="link"><a href="ArchiveTask.html">Buildr::ArchiveTask</a>
+
+</div>
+
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li class="calls-super" ><a href="#method-c-new">::new</a>
+
+ <li ><a href="#method-i-spec">#spec</a>
+
+ <li ><a href="#method-i-upload">#upload</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::PackageGemTask">
+ <h1 id="class-Buildr::PackageGemTask" class="class">
+ class Buildr::PackageGemTask
+ </h1>
+
+ <section class="description">
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+
+
+ <section id="public-class-5Buntitled-5D-method-details"
class="method-section">
+ <header>
+ <h3>Public Class Methods</h3>
+ </header>
+
+
+ <div id="method-c-new" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">new</span><span
+ class="method-args">(*args)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+ <div class="method-calls-super">
+ Calls superclass method
+
+ </div>
+
+
+
+ <div class="method-source-code" id="new-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/packaging/gems.rb, line 22</span>
+<span class="ruby-keyword">def</span> <span
class="ruby-identifier">initialize</span>(<span
class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+ <span class="ruby-keyword">super</span>
+ <span class="ruby-ivar">@spec</span> = <span
class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span
class="ruby-constant">Specification</span>.<span
class="ruby-identifier">new</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ <section id="public-instance-5Buntitled-5D-method-details"
class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
+
+
+ <div id="method-i-spec" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">spec</span><span
+ class="method-args">() { |spec| ... }</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="spec-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/packaging/gems.rb, line 27</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">spec</span>
+ <span class="ruby-keyword">yield</span> <span class="ruby-ivar">@spec</span>
<span class="ruby-keyword">if</span> <span
class="ruby-identifier">block_given?</span>
+ <span class="ruby-ivar">@spec</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-upload" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">upload</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="upload-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/packaging/gems.rb, line 32</span>
+<span class="ruby-keyword">def</span> <span
class="ruby-identifier">upload</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer";>Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2.
+ <p>Based on <a
href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a
href="http://deveiate.org";>Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Packaging.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Packaging.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Packaging.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::Packaging - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation"
class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section
initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+
+
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::Packaging">
+ <h1 id="module-Buildr::Packaging" class="module">
+ module Buildr::Packaging
+ </h1>
+
+ <section class="description">
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer";>Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2.
+ <p>Based on <a
href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a
href="http://deveiate.org";>Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Packaging/Java.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Packaging/Java.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Packaging/Java.html Sun Jul 14 11:16:56
2019
@@ -0,0 +1,293 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::Packaging::Java - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../../";
+</script>
+
+<script src="../../js/jquery.js"></script>
+<script src="../../js/darkfish.js"></script>
+
+<link href="../../css/fonts.css" rel="stylesheet">
+<link href="../../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation"
class="nav-section">
+ <h2>
+ <a href="../../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../../table_of_contents.html#pages">Pages</a>
+ <a href="../../table_of_contents.html#classes">Classes</a>
+ <a href="../../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section
initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+ <div id="includes-section" class="nav-section">
+ <h3>Included Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="include" href="../Extension.html">Buildr::Extension</a>
+
+
+ </ul>
+</div>
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-i-package_with_javadoc">#package_with_javadoc</a>
+
+ <li ><a href="#method-i-package_with_sources">#package_with_sources</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::Packaging::Java">
+ <h1 id="module-Buildr::Packaging::Java" class="module">
+ module Buildr::Packaging::Java
+ </h1>
+
+ <section class="description">
+
+<p>Adds packaging for <a href="Java.html">Java</a> projects: JAR, WAR, AAR,
+EAR, Javadoc.</p>
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+ <section class="attribute-method-details" class="method-section">
+ <header>
+ <h3>Attributes</h3>
+ </header>
+
+
+ <div id="attribute-i-manifest" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">manifest</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p><a href="Java/Manifest.html">Manifest</a> used for packaging.
Inherited
+from parent project. The default value is a hash that includes the
+Build-By, Build-Jdk, Implementation-Title and Implementation-Version
+values. The later are taken from the project's comment (or name) and
+version number.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-meta_inf" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">meta_inf</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Files to always include in the package META-INF directory. The
default
+value include the <a href="../../LICENSE.html">LICENSE</a> file if one
+exists in the project's base directory.</p>
+
+ </div>
+ </div>
+
+ </section>
+
+
+
+ <section id="public-instance-5Buntitled-5D-method-details"
class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
+
+
+ <div id="method-i-package_with_javadoc" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ package_with_javadoc(options?)
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Call this when you want the project (and all its sub-projects) to
create a
+JavaDoc distribution. You can use the JavaDoc distribution in an IDE when
+coding against the API.</p>
+
+<p>A JavaDoc distribution is a ZIP package with the classifier
+'javadoc', which includes all the sources used by the compile task.</p>
+
+<p>Packages use the project's manifest and <a
+href="Java.html#attribute-i-meta_inf">#meta_inf</a> properties, which you
+can override by passing different values (e.g. false to exclude the
+manifest) in the options.</p>
+
+<p>To create JavaDoc distributions only for specific projects, use the :only
+and :except options, for example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">package_with_javadoc</span>
:<span class="ruby-identifier">only=</span><span
class="ruby-operator">></span>[<span
class="ruby-string">'foo:bar'</span>, <span
class="ruby-string">'foo:baz'</span>]
+</pre>
+
+<p>(Same as calling package :javadoc on each project/sub-project that has
+source directories.)</p>
+
+
+
+
+ <div class="method-source-code" id="package_with_javadoc-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/java/packaging.rb, line 661</span>
+<span class="ruby-keyword">def</span> <span
class="ruby-identifier">package_with_javadoc</span>(<span
class="ruby-identifier">options</span> = <span class="ruby-keyword">nil</span>)
+ <span class="ruby-identifier">options</span> <span
class="ruby-operator">||=</span> {}
+ <span class="ruby-identifier">enhance</span> <span
class="ruby-keyword">do</span>
+ <span class="ruby-identifier">selected</span> = <span
class="ruby-identifier">options</span>[<span class="ruby-value">:only</span>]
<span class="ruby-operator">?</span> <span
class="ruby-identifier">projects</span>(<span
class="ruby-identifier">options</span>[<span class="ruby-value">:only</span>])
<span class="ruby-operator">:</span>
+ <span class="ruby-identifier">options</span>[<span
class="ruby-value">:except</span>] <span class="ruby-operator">?</span> ([<span
class="ruby-keyword">self</span>] <span class="ruby-operator">+</span> <span
class="ruby-identifier">projects</span> <span class="ruby-operator">-</span>
<span class="ruby-identifier">projects</span>(<span
class="ruby-identifier">options</span>[<span
class="ruby-value">:except</span>])) <span class="ruby-operator">:</span>
+ [<span class="ruby-keyword">self</span>] <span
class="ruby-operator">+</span> <span class="ruby-identifier">projects</span>
+ <span class="ruby-identifier">selected</span>.<span
class="ruby-identifier">reject</span> { <span
class="ruby-operator">|</span><span class="ruby-identifier">project</span><span
class="ruby-operator">|</span> <span
class="ruby-identifier">project</span>.<span
class="ruby-identifier">compile</span>.<span
class="ruby-identifier">sources</span>.<span
class="ruby-identifier">empty?</span> }.
+ <span class="ruby-identifier">each</span> { <span
class="ruby-operator">|</span><span class="ruby-identifier">project</span><span
class="ruby-operator">|</span> <span
class="ruby-identifier">project</span>.<span
class="ruby-identifier">package</span>(<span
class="ruby-value">:javadoc</span>) }
+ <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-package_with_sources" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ package_with_sources(options?)
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Call this when you want the project (and all its sub-projects) to
create a
+source distribution. You can use the source distribution in an IDE when
+debugging.</p>
+
+<p>A source distribution is a jar package with the classifier
+'sources', which includes all the sources used by the compile task.</p>
+
+<p>Packages use the project's manifest and <a
+href="Java.html#attribute-i-meta_inf">#meta_inf</a> properties, which you
+can override by passing different values (e.g. false to exclude the
+manifest) in the options.</p>
+
+<p>To create source distributions only for specific projects, use the :only
+and :except options, for example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">package_with_sources</span>
:<span class="ruby-identifier">only=</span><span
class="ruby-operator">></span>[<span
class="ruby-string">'foo:bar'</span>, <span
class="ruby-string">'foo:baz'</span>]
+</pre>
+
+<p>(Same as calling package :sources on each project/sub-project that has
+source directories.)</p>
+
+
+
+
+ <div class="method-source-code" id="package_with_sources-source">
+ <pre><span class="ruby-comment"># File
lib/buildr/java/packaging.rb, line 633</span>
+<span class="ruby-keyword">def</span> <span
class="ruby-identifier">package_with_sources</span>(<span
class="ruby-identifier">options</span> = <span class="ruby-keyword">nil</span>)
+ <span class="ruby-identifier">options</span> <span
class="ruby-operator">||=</span> {}
+ <span class="ruby-identifier">enhance</span> <span
class="ruby-keyword">do</span>
+ <span class="ruby-identifier">selected</span> = <span
class="ruby-identifier">options</span>[<span class="ruby-value">:only</span>]
<span class="ruby-operator">?</span> <span
class="ruby-identifier">projects</span>(<span
class="ruby-identifier">options</span>[<span class="ruby-value">:only</span>])
<span class="ruby-operator">:</span>
+ <span class="ruby-identifier">options</span>[<span
class="ruby-value">:except</span>] <span class="ruby-operator">?</span> ([<span
class="ruby-keyword">self</span>] <span class="ruby-operator">+</span> <span
class="ruby-identifier">projects</span> <span class="ruby-operator">-</span>
<span class="ruby-identifier">projects</span>(<span
class="ruby-identifier">options</span>[<span
class="ruby-value">:except</span>])) <span class="ruby-operator">:</span>
+ [<span class="ruby-keyword">self</span>] <span
class="ruby-operator">+</span> <span class="ruby-identifier">projects</span>
+ <span class="ruby-identifier">selected</span>.<span
class="ruby-identifier">reject</span> { <span
class="ruby-operator">|</span><span class="ruby-identifier">project</span><span
class="ruby-operator">|</span> <span
class="ruby-identifier">project</span>.<span
class="ruby-identifier">compile</span>.<span
class="ruby-identifier">sources</span>.<span
class="ruby-identifier">empty?</span> <span
class="ruby-operator">&&</span> <span
class="ruby-identifier">project</span>.<span
class="ruby-identifier">resources</span>.<span
class="ruby-identifier">target</span>.<span class="ruby-identifier">nil?</span>
}.
+ <span class="ruby-identifier">each</span> { <span
class="ruby-operator">|</span><span class="ruby-identifier">project</span><span
class="ruby-operator">|</span> <span
class="ruby-identifier">project</span>.<span
class="ruby-identifier">package</span>(<span
class="ruby-value">:sources</span>) }
+ <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer";>Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2.
+ <p>Based on <a
href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a
href="http://deveiate.org";>Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Packaging/Java/AarTask.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Packaging/Java/AarTask.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Packaging/Java/AarTask.html Sun Jul 14
11:16:56 2019
@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::Packaging::Java::AarTask - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../../../";
+</script>
+
+<script src="../../../js/jquery.js"></script>
+<script src="../../../js/darkfish.js"></script>
+
+<link href="../../../css/fonts.css" rel="stylesheet">
+<link href="../../../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation"
class="nav-section">
+ <h2>
+ <a href="../../../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../../../table_of_contents.html#pages">Pages</a>
+ <a href="../../../table_of_contents.html#classes">Classes</a>
+ <a href="../../../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section
initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+ <div id="parent-class-section" class="nav-section">
+ <h3>Parent</h3>
+
+
+ <p class="link"><a href="JarTask.html">Buildr::Packaging::Java::JarTask</a>
+
+</div>
+
+ <div id="includes-section" class="nav-section">
+ <h3>Included Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="include" href="../../../Buildr.html">Buildr</a>
+
+
+ </ul>
+</div>
+
+
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::Packaging::Java::AarTask">
+ <h1 id="class-Buildr::Packaging::Java::AarTask" class="class">
+ class Buildr::Packaging::Java::AarTask
+ </h1>
+
+ <section class="description">
+
+<p>Extends the <a href="JarTask.html">JarTask</a> to create an AAR file (Axis2
+service archive).</p>
+
+<p>Supports all the same options as <a href="JarTask.html">JarTask</a>, with
+the addition of :wsdls, :services_xml and :libs.</p>
+<ul><li>
+<p>:wsdls â WSDL files to include (under META-INF). By default packaging
will
+include all WSDL files found under src/main/axis2.</p>
+</li><li>
+<p>:services_xml â Location of services.xml file (included under META-INF).
+By default packaging takes this from src/main/axis2/services.xml. Use a
+different path if you genereate the services.xml file as part of the build.</p>
+</li><li>
+<p>:libs â Array of files, tasks, artifact specifications, etc that will be
+added to the /lib directory.</p>
+</li></ul>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">package</span>(:<span
class="ruby-identifier">aar</span>).<span
class="ruby-identifier">with</span>(:<span
class="ruby-identifier">libs=</span><span
class="ruby-operator">></span><span
class="ruby-string">'log4j:log4j:jar:1.1'</span>)
+
+<span class="ruby-identifier">filter</span>.<span
class="ruby-identifier">from</span>(<span
class="ruby-string">'src/main/axis2'</span>).<span
class="ruby-identifier">into</span>(<span
class="ruby-string">'target'</span>).<span
class="ruby-identifier">include</span>(<span
class="ruby-string">'services.xml'</span>, <span
class="ruby-string">'*.wsdl'</span>).<span
class="ruby-identifier">using</span>(<span
class="ruby-string">'http_port'</span>=<span
class="ruby-operator">></span><span
class="ruby-string">'8080'</span>)
+<span class="ruby-identifier">package</span>(:<span
class="ruby-identifier">aar</span>).<span
class="ruby-identifier">wsdls</span>.<span class="ruby-identifier">clear</span>
+<span class="ruby-identifier">package</span>(:<span
class="ruby-identifier">aar</span>).<span
class="ruby-identifier">with</span>(:<span
class="ruby-identifier">services_xml=</span><span
class="ruby-operator">></span><span class="ruby-identifier">_</span>(<span
class="ruby-string">'target/services.xml'</span>), :<span
class="ruby-identifier">wsdls=</span><span
class="ruby-operator">></span><span class="ruby-identifier">_</span>(<span
class="ruby-string">'target/*.wsdl'</span>))
+</pre>
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+ <section class="attribute-method-details" class="method-section">
+ <header>
+ <h3>Attributes</h3>
+ </header>
+
+
+ <div id="attribute-i-libs" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">libs</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Artifacts to include under /lib.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-services_xml" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">services_xml</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Location of services.xml file (defaults to
src/main/axis2/services.xml).</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-wsdls" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">wsdls</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>WSDLs to include under META-INF (defaults to all WSDLs under
+src/main/axis2).</p>
+
+ </div>
+ </div>
+
+ </section>
+
+
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer";>Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2.
+ <p>Based on <a
href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a
href="http://deveiate.org";>Michael Granger</a>.
+</footer>
+
