Added: dev/buildr/1.5.4/site/rdoc/Buildr/ActsAsArtifact.html ============================================================================== --- dev/buildr/1.5.4/site/rdoc/Buildr/ActsAsArtifact.html (added) +++ dev/buildr/1.5.4/site/rdoc/Buildr/ActsAsArtifact.html Wed Nov 29 05:25:13 2017 @@ -0,0 +1,1006 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::ActsAsArtifact - 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"> + + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-i-apply_spec">#apply_spec</a> + + <li ><a href="#method-i-extract_type">#extract_type</a> + + <li ><a href="#method-i-final_version">#final_version</a> + + <li ><a href="#method-i-group_path">#group_path</a> + + <li ><a href="#method-i-install">#install</a> + + <li ><a href="#method-i-javadoc_artifact">#javadoc_artifact</a> + + <li ><a href="#method-i-maven_metadata_xml">#maven_metadata_xml</a> + + <li ><a href="#method-i-pom">#pom</a> + + <li ><a href="#method-i-pom_xml">#pom_xml</a> + + <li ><a href="#method-i-snapshot-3F">#snapshot?</a> + + <li ><a href="#method-i-sources_artifact">#sources_artifact</a> + + <li ><a href="#method-i-to_hash">#to_hash</a> + + <li ><a href="#method-i-to_spec">#to_spec</a> + + <li ><a href="#method-i-to_spec_hash">#to_spec_hash</a> + + <li ><a href="#method-i-uninstall">#uninstall</a> + + <li ><a href="#method-i-upload">#upload</a> + + <li ><a href="#method-i-upload_name">#upload_name</a> + + <li ><a href="#method-i-upload_task">#upload_task</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::ActsAsArtifact"> + <h1 id="module-Buildr::ActsAsArtifact" class="module"> + module Buildr::ActsAsArtifact + </h1> + + <section class="description"> + +<p>Mixin with a task to make it behave like an artifact. Implemented by the +packaging tasks.</p> + +<p>An artifact has an identifier, group identifier, type, version number and +optional classifier. All can be used to locate it in the local repository, +download from or upload to a remote repository.</p> + +<p>The <a href="ActsAsArtifact.html#method-i-to_spec">to_spec</a> and <a +href="ActsAsArtifact.html#method-i-to_hash">to_hash</a> methods allow it to +be used everywhere an artifact is accepted.</p> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="ARTIFACT_ATTRIBUTES">ARTIFACT_ATTRIBUTES + + <dd> + + + <dt id="MAVEN_METADATA">MAVEN_METADATA + + <dd> + + + </dl> + </section> + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-buildr_project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">buildr_project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-classifier" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">classifier</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p>Optional artifact classifier.</p> + + </div> + </div> + + <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">[R]</span> + </div> + + <div class="method-description"> + + <p>The group identifier.</p> + + </div> + </div> + + <div id="attribute-i-id" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">id</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p>The artifact identifier.</p> + + </div> + </div> + + <div id="attribute-i-type" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">type</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p>The file type. (Symbol)</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">[R]</span> + </div> + + <div class="method-description"> + + <p>The version number.</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-final_version" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">final_version</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="final_version-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 82</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">final_version</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">version</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">snapshot?</span> + <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">"%Y%m%d.%H%M%S"</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-install" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">install</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="install-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 188</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">install</span> + <span class="ruby-identifier">invoke</span> + <span class="ruby-identifier">in_local_repository</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">locate</span>(<span class="ruby-keyword">self</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">self</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">classifier</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">pom</span>.<span class="ruby-identifier">invoke</span> + <span class="ruby-identifier">pom</span>.<span class="ruby-identifier">install</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">in_local_repository</span> + <span class="ruby-identifier">mkpath</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">in_local_repository</span>) + <span class="ruby-identifier">cp</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">in_local_repository</span>, <span class="ruby-value">:preserve</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">false</span> + <span class="ruby-identifier">info</span> <span class="ruby-node">"Installed #{name} to #{in_local_repository}"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-javadoc_artifact" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + javadoc_artifact → Artifact + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Convenience method that returns the associated javadoc artifact</p> + + + + + <div class="method-source-code" id="javadoc_artifact-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 138</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">javadoc_artifact</span> + <span class="ruby-identifier">javadoc_spec</span> = <span class="ruby-identifier">to_spec_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:classifier=</span><span class="ruby-operator">></span><span class="ruby-string">'javadoc'</span>) + <span class="ruby-identifier">javadoc_task</span> = <span class="ruby-constant">OptionalArtifact</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">locate</span>(<span class="ruby-identifier">javadoc_spec</span>)) + <span class="ruby-identifier">javadoc_task</span>.<span class="ruby-identifier">send</span> <span class="ruby-value">:apply_spec</span>, <span class="ruby-identifier">javadoc_spec</span> + <span class="ruby-identifier">javadoc_task</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-maven_metadata_xml" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + maven_metadata_xml → string + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Creates Maven Metadata XML content for this artifact.</p> + + + + + <div class="method-source-code" id="maven_metadata_xml-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 171</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">maven_metadata_xml</span> + <span class="ruby-identifier">xml</span> = <span class="ruby-constant">Builder</span><span class="ruby-operator">::</span><span class="ruby-constant">XmlMarkup</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:indent=</span><span class="ruby-operator">></span><span class="ruby-value">2</span>) + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">instruct!</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">metadata</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">groupId</span> <span class="ruby-identifier">group</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">artifactId</span> <span class="ruby-identifier">id</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">version</span> <span class="ruby-identifier">version</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">versioning</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">snapshot</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">timestamp</span> <span class="ruby-identifier">final_version</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">buildNumber</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">lastupdated</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">"%Y%m%d%H%M%S"</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-pom" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + pom → Artifact + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Convenience method that returns a <a href="POM.html">POM</a> artifact.</p> + + + + + <div class="method-source-code" id="pom-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">pom</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:pom</span> + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifact</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-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-pom_xml" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + pom_xml → string + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Creates <a href="POM.html">POM</a> XML for this artifact.</p> + + + + + <div class="method-source-code" id="pom_xml-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 149</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">pom_xml</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">buildr_project</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">else</span> + <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span> = <span class="ruby-constant">Builder</span><span class="ruby-operator">::</span><span class="ruby-constant">XmlMarkup</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:indent</span> =<span class="ruby-operator">></span> <span class="ruby-value">2</span>) + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">instruct!</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">project</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">modelVersion</span> <span class="ruby-string">'4.0.0'</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">groupId</span> <span class="ruby-identifier">group</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">artifactId</span> <span class="ruby-identifier">id</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">version</span> <span class="ruby-identifier">version</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">classifier</span> <span class="ruby-identifier">classifier</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">classifier</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-snapshot-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">snapshot?</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="snapshot-3F-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 78</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">snapshot?</span> + <span class="ruby-identifier">version</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/-SNAPSHOT$/</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-sources_artifact" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + sources_artifact → Artifact + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Convenience method that returns a sources artifact.</p> + + + + + <div class="method-source-code" id="sources_artifact-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 127</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">sources_artifact</span> + <span class="ruby-identifier">sources_spec</span> = <span class="ruby-identifier">to_spec_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:classifier=</span><span class="ruby-operator">></span><span class="ruby-string">'sources'</span>) + <span class="ruby-identifier">sources_task</span> = <span class="ruby-constant">OptionalArtifact</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">locate</span>(<span class="ruby-identifier">sources_spec</span>)) + <span class="ruby-identifier">sources_task</span>.<span class="ruby-identifier">send</span> <span class="ruby-value">:apply_spec</span>, <span class="ruby-identifier">sources_spec</span> + <span class="ruby-identifier">sources_task</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-to_hash" class="method-detail method-alias"> + + <div class="method-heading"> + <span class="method-name">to_hash</span><span + class="method-args">()</span> + + </div> + + + <div class="method-description"> + + + + + + + </div> + + + + + <div class="aliases"> + Alias for: <a href="ActsAsArtifact.html#method-i-to_spec_hash">to_spec_hash</a> + </div> + + </div> + + + <div id="method-i-to_spec" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + to_spec → String + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns the artifact specification, in the structure:</p> + +<pre><group>:<artifact>:<type>:<version></pre> + +<p>or</p> + +<pre><group>:<artifact>:<type>:<classifier>:<version></pre> + + + + + <div class="method-source-code" id="to_spec-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 110</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_spec</span> + <span class="ruby-identifier">classifier</span> <span class="ruby-operator">?</span> <span class="ruby-node">"#{group}:#{id}:#{type}:#{classifier}:#{version}"</span> <span class="ruby-operator">:</span> <span class="ruby-node">"#{group}:#{id}:#{type}:#{version}"</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-to_spec_hash" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + to_spec_hash → Hash + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns the artifact specification as a hash. For example:</p> + +<pre>com.example:app:jar:1.2</pre> + +<p>becomes:</p> + +<pre class="ruby">{ :<span class="ruby-identifier">group=</span><span class="ruby-operator">></span><span class="ruby-string">'com.example'</span>, + :<span class="ruby-identifier">id=</span><span class="ruby-operator">></span><span class="ruby-string">'app'</span>, + :<span class="ruby-identifier">type=</span><span class="ruby-operator">></span>:<span class="ruby-identifier">jar</span>, + :<span class="ruby-identifier">version=</span><span class="ruby-operator">></span><span class="ruby-string">'1.2'</span> } +</pre> + + + + + <div class="method-source-code" id="to_spec_hash-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 97</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_spec_hash</span> + <span class="ruby-identifier">base</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">:type=</span><span class="ruby-operator">></span><span class="ruby-identifier">type</span>, <span class="ruby-value">:version=</span><span class="ruby-operator">></span><span class="ruby-identifier">version</span> } + <span class="ruby-identifier">classifier</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">base</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:classifier=</span><span class="ruby-operator">></span><span class="ruby-identifier">classifier</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">base</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + <div class="aliases"> + Also aliased as: <a href="ActsAsArtifact.html#method-i-to_hash">to_hash</a> + </div> + + + + </div> + + + <div id="method-i-uninstall" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">uninstall</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="uninstall-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 202</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">uninstall</span> + <span class="ruby-identifier">installed</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">locate</span>(<span class="ruby-keyword">self</span>) + <span class="ruby-identifier">rm</span> <span class="ruby-identifier">installed</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">installed</span>) + <span class="ruby-identifier">pom</span>.<span class="ruby-identifier">uninstall</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">self</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">classifier</span>.<span class="ruby-identifier">nil?</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-callseq"> + upload + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + upload(url) + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + upload(options) + </span> + + </div> + + + + <div class="method-description"> + + <p>Uploads the artifact, its <a href="POM.html">POM</a> and digital signatures +to remote server.</p> + +<p>In the first form, uses the upload options specified by +repositories.release_to or repositories.snapshot_to if the subject is a +snapshot artifact. In the second form, uses a URL that includes all the +relevant information. In the third form, uses a hash with the options :url, +:username, :password, and :permissions. All but :url are optional.</p> + + + + + <div class="method-source-code" id="upload-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 220</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">upload</span>(<span class="ruby-identifier">upload_to</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">upload_task</span>(<span class="ruby-identifier">upload_to</span>).<span class="ruby-identifier">invoke</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-upload_task" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">upload_task</span><span + class="method-args">(upload_to = nil)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="upload_task-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 224</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">upload_task</span>(<span class="ruby-identifier">upload_to</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">upload_to</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">snapshot_to</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">snapshot?</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">snapshot_to</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">snapshot_to</span>[<span class="ruby-value">:url</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">upload_to</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">release_to</span> + <span class="ruby-identifier">upload_to</span> = { <span class="ruby-value">:url=</span><span class="ruby-operator">></span><span class="ruby-identifier">upload_to</span> } <span class="ruby-keyword">unless</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">upload_to</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Don\t know where to upload, perhaps you forgot to set repositories.release_to'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:url</span>] + + <span class="ruby-comment"># Set the upload URI, including mandatory slash (we expect it to be the base directory).</span> + <span class="ruby-comment"># Username/password may be part of URI, or separate entities.</span> + <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:url</span>].<span class="ruby-identifier">clone</span>) + <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span> <span class="ruby-operator">+</span> <span class="ruby-string">'/'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'/'</span> + <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:username</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:username</span>] + <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:password</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:password</span>] + + <span class="ruby-identifier">path</span> = <span class="ruby-identifier">group</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'.'</span>, <span class="ruby-string">'/'</span>) <span class="ruby-operator">+</span> <span class="ruby-node">"/#{id}/#{version}/#{upload_name}"</span> + + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">uri</span><span class="ruby-operator">+</span><span class="ruby-identifier">path</span>) + <span class="ruby-identifier">deps</span> = [<span class="ruby-keyword">self</span>] + <span class="ruby-identifier">deps</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">pom</span>.<span class="ruby-identifier">upload_task</span>( <span class="ruby-identifier">upload_to</span> ) <span class="ruby-keyword">if</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">self</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">classifier</span>.<span class="ruby-identifier">nil?</span> + + <span class="ruby-identifier">task</span> = <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">define_task</span> <span class="ruby-identifier">uri</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">deps</span> <span class="ruby-keyword">do</span> + <span class="ruby-comment"># Upload artifact relative to base URL, need to create path before uploading.</span> + <span class="ruby-identifier">options</span> = <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:options</span>] <span class="ruby-operator">||</span> {<span class="ruby-value">:permissions</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:permissions</span>]} + <span class="ruby-identifier">info</span> <span class="ruby-node">"Deploying #{to_spec}"</span> + <span class="ruby-constant">URI</span>.<span class="ruby-identifier">upload</span> <span class="ruby-identifier">uri</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">snapshot?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">pom</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">self</span> + <span class="ruby-identifier">maven_metadata</span> = <span class="ruby-identifier">group</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'.'</span>, <span class="ruby-string">'/'</span>) <span class="ruby-operator">+</span> <span class="ruby-node">"/#{id}/#{version}/#{MAVEN_METADATA}"</span> + <span class="ruby-constant">URI</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">uri</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">maven_metadata</span>, <span class="ruby-identifier">maven_metadata_xml</span>, <span class="ruby-value">:permissions</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">upload_to</span>[<span class="ruby-value">:permissions</span>] + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">task</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Protected Instance Methods</h3> + </header> + + + <div id="method-i-apply_spec" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">apply_spec</span><span + class="method-args">(spec)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Apply specification to this artifact.</p> + + + + + <div class="method-source-code" id="apply_spec-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 260</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">apply_spec</span>(<span class="ruby-identifier">spec</span>) + <span class="ruby-identifier">spec</span> = <span class="ruby-constant">Artifact</span>.<span class="ruby-identifier">to_hash</span>(<span class="ruby-identifier">spec</span>) + <span class="ruby-constant">ARTIFACT_ATTRIBUTES</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{key}"</span>, <span class="ruby-identifier">spec</span>[<span class="ruby-identifier">key</span>]) } + <span class="ruby-keyword">self</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-extract_type" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">extract_type</span><span + class="method-args">(type)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="extract_type-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 275</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">extract_type</span>(<span class="ruby-identifier">type</span>) + <span class="ruby-keyword">return</span> <span class="ruby-value">:jar</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:bundle</span> + <span class="ruby-identifier">type</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-group_path" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">group_path</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="group_path-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 266</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">group_path</span> + <span class="ruby-identifier">group</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-upload_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">upload_name</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_name-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 270</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">upload_name</span> + <span class="ruby-keyword">return</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">snapshot?</span> + <span class="ruby-keyword">return</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/SNAPSHOT/</span>, <span class="ruby-node">"#{final_version}-1"</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.4/site/rdoc/Buildr/Ant.html ============================================================================== --- dev/buildr/1.5.4/site/rdoc/Buildr/Ant.html (added) +++ dev/buildr/1.5.4/site/rdoc/Buildr/Ant.html Wed Nov 29 05:25:13 2017 @@ -0,0 +1,264 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Ant - 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"> + + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-c-dependencies">::dependencies</a> + + <li ><a href="#method-c-version">::version</a> + + <li ><a href="#method-i-ant">#ant</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Ant"> + <h1 id="module-Buildr::Ant" class="module"> + module Buildr::Ant + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="VERSION">VERSION + + <dd><p>Which version of <a href="Ant.html">Ant</a> we're using by default.</p> + + + </dl> + </section> + + + + + + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Class Methods</h3> + </header> + + + <div id="method-c-dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">dependencies</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p><a href="Ant.html">Ant</a> classpath dependencies.</p> + + + + + <div class="method-source-code" id="dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/ant.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">dependencies</span> + <span class="ruby-comment"># Ant-Trax required for running the JUnitReport task, and there's no other place</span> + <span class="ruby-comment"># to put it but the root classpath.</span> + <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator">||=</span> [<span class="ruby-node">"org.apache.ant:ant:jar:#{version}"</span>, <span class="ruby-node">"org.apache.ant:ant-launcher:jar:#{version}"</span>] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-c-version" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">version</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Current version of <a href="Ant.html">Ant</a> being used.</p> + + + + + <div class="method-source-code" id="version-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/ant.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">version</span> + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>[<span class="ruby-string">'ant'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">VERSION</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-ant" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + ant(name) { |AntProject| ... } → AntProject + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Creates a new AntProject with the specified name, yield to the block for +defining various <a href="Ant.html">Ant</a> tasks, and executes each task +as it's defined.</p> + +<p>For example:</p> + +<pre>ant("hibernatedoclet') do |doclet| + doclet.taskdef :name=>'hibernatedoclet', + :classname=>'xdoclet.modules.hibernate.HibernateDocletTask', :classpath=>DOCLET + doclet.hibernatedoclet :destdir=>dest_dir, :force=>'true' do + hibernate :version=>'3.0' + fileset :dir=>source, :includes=>'**/*.java' + end +end</pre> + + + + + <div class="method-source-code" id="ant-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/ant.rb, line 60</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ant</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">options</span> = { <span class="ruby-value">:name=</span><span class="ruby-operator">></span><span class="ruby-identifier">name</span>, <span class="ruby-value">:basedir=</span><span class="ruby-operator">></span><span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>, <span class="ruby-value">:declarative=</span><span class="ruby-operator">></span><span class="ruby-keyword">true</span> } + <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-value">:logger=</span><span class="ruby-operator">></span> <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">STDOUT</span>), <span class="ruby-value">:loglevel=</span><span class="ruby-operator">></span> <span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">trace?</span>(<span class="ruby-value">:ant</span>) + <span class="ruby-constant">Java</span>.<span class="ruby-identifier">load</span> + <span class="ruby-constant">Antwrap</span><span class="ruby-operator">::</span><span class="ruby-constant">AntProject</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-comment"># Set Ant logging level to debug (--trace), info (default) or error only (--quiet).</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">getBuildListeners</span>().<span class="ruby-identifier">get</span>(<span class="ruby-value">0</span>). + <span class="ruby-identifier">setMessageOutputLevel</span>((<span class="ruby-identifier">trace?</span>(<span class="ruby-value">:ant</span>) <span class="ruby-operator">&&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">verbose</span> <span class="ruby-operator">&&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">||</span> <span class="ruby-value">0</span>) + <span class="ruby-keyword">yield</span> <span class="ruby-identifier">project</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</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.4/site/rdoc/Buildr/Apt.html ============================================================================== --- dev/buildr/1.5.4/site/rdoc/Buildr/Apt.html (added) +++ dev/buildr/1.5.4/site/rdoc/Buildr/Apt.html Wed Nov 29 05:25:13 2017 @@ -0,0 +1,171 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Apt - 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"> + + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-i-apt">#apt</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Apt"> + <h1 id="module-Buildr::Apt" class="module"> + module Buildr::Apt + </h1> + + <section class="description"> + +<p>Methods added to <a href="Project.html">Project</a> to support the <a +href="../Java.html">Java</a> Annotation Processor.</p> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-apt" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + apt(*sources) → task + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns a task that will use Java#apt to generate source files in +target/generated/apt, from all the source directories passed as arguments. +Uses the compile.sources list if on arguments supplied.</p> + +<p>For example:</p> + + + + + <div class="method-source-code" id="apt-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/compiler.rb, line 109</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">apt</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sources</span>) + <span class="ruby-identifier">sources</span> = <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">sources</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">sources</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">file</span>(<span class="ruby-identifier">path_to</span>(<span class="ruby-value">:target</span>, <span class="ruby-string">'generated/apt'</span>)=<span class="ruby-operator">></span><span class="ruby-identifier">sources</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">cmd_args</span> = [ <span class="ruby-identifier">trace?</span>(<span class="ruby-value">:apt</span>) <span class="ruby-operator">?</span> <span class="ruby-string">'-verbose'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'-nowarn'</span> ] + <span class="ruby-identifier">cmd_args</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'-nocompile'</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'-s'</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">name</span> + <span class="ruby-identifier">cmd_args</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'-source'</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">source</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">source</span> + <span class="ruby-identifier">classpath</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">dependencies</span>).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>).<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">task</span>(<span class="ruby-identifier">t</span>).<span class="ruby-identifier">invoke</span> } + <span class="ruby-identifier">cmd_args</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'-classpath'</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">classpath</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">classpath</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">cmd_args</span> <span class="ruby-operator">+=</span> (<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>) <span class="ruby-operator">-</span> [<span class="ruby-identifier">task</span>.<span class="ruby-identifier">name</span>]). + <span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">file</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">FileList</span>[<span class="ruby-node">"#{file}/**/*.java"</span>] <span class="ruby-operator">:</span> <span class="ruby-identifier">file</span> }.<span class="ruby-identifier">flatten</span> + <span class="ruby-keyword">unless</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">dryrun</span> + <span class="ruby-identifier">info</span> <span class="ruby-string">'Running apt'</span> + <span class="ruby-identifier">trace</span> ([<span class="ruby-string">'apt'</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">cmd_args</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>) + <span class="ruby-constant">Java</span>.<span class="ruby-identifier">com</span>.<span class="ruby-identifier">sun</span>.<span class="ruby-identifier">tools</span>.<span class="ruby-identifier">apt</span>.<span class="ruby-constant">Main</span>.<span class="ruby-identifier">process</span>(<span class="ruby-identifier">cmd_args</span>.<span class="ruby-identifier">to_java</span>(<span class="ruby-constant">Java</span>.<span class="ruby-identifier">java</span>.<span class="ruby-identifier">lang</span>.<span class="ruby-constant">String</span>)) <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-keyword">or</span> + <span class="ruby-identifier">fail</span> <span class="ruby-string">'Failed to process annotations, see errors above'</span> + <span class="ruby-keyword">end</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> +