Added: dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Options.html ============================================================================== --- dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Options.html (added) +++ dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Options.html Sat Sep 24 05:13:50 2016 @@ -0,0 +1,391 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Options - 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="../Object.html">Object</a> + +</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-debug">#debug</a> + + <li ><a href="#method-i-debug-3D">#debug=</a> + + <li ><a href="#method-i-proxy">#proxy</a> + + <li ><a href="#method-i-test">#test</a> + + <li ><a href="#method-i-test-3D">#test=</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Options"> + <h1 id="class-Buildr::Options" class="class"> + class Buildr::Options + </h1> + + <section class="description"> + +<p>Collection of options for controlling <a href="../Buildr.html">Buildr</a>.</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-parallel" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">parallel</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + <p>Runs the build in parallel when true (defaults to false). You can force a +parallel build by setting this option directly, or by running the parallel +task ahead of the build task.</p> + +<p>This option only affects recursive tasks. For example:</p> + +<pre class="ruby"><span class="ruby-identifier">buildr</span> <span class="ruby-identifier">parallel</span> <span class="ruby-identifier">package</span> +</pre> + +<p>will run all package tasks (from the sub-projects) in parallel, but each +sub-project's package task runs its child tasks (prepare, compile, +resources, etc) in sequence.</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-debug" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">debug</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns the debug option (environment variable DEBUG).</p> + + + + + <div class="method-source-code" id="debug-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 581</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">debug</span> + (<span class="ruby-constant">ENV</span>[<span class="ruby-string">'DEBUG'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'debug'</span>]) <span class="ruby-operator">!~</span> <span class="ruby-regexp">/(no|off|false)/</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-debug-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">debug=</span><span + class="method-args">(flag)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Sets the debug option (environment variable DEBUG).</p> + +<p>You can turn this option off directly, or by setting the environment +variable DEBUG to <code>no</code>. For example:</p> + +<pre class="ruby"><span class="ruby-identifier">buildr</span> <span class="ruby-identifier">build</span> <span class="ruby-constant">DEBUG</span>=<span class="ruby-identifier">no</span> +</pre> + +<p>The release tasks runs a build with <code>DEBUG=no</code>.</p> + + + + + <div class="method-source-code" id="debug-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 592</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">debug=</span>(<span class="ruby-identifier">flag</span>) + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'debug'</span>] = <span class="ruby-keyword">nil</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'DEBUG'</span>] = <span class="ruby-identifier">flag</span>.<span class="ruby-identifier">to_s</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-proxy" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + proxy → options + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns the proxy options. Currently supported options are:</p> +<ul><li> +<p>:http â HTTP proxy for use when downloading.</p> +</li><li> +<p>:exclude â Do not use proxy for these hosts/domains.</p> +</li></ul> + +<p>For example:</p> + +<pre class="ruby"><span class="ruby-identifier">options</span>.<span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">http</span> = <span class="ruby-string">'http://proxy.acme.com:8080'</span> +</pre> + +<p>You can also set it using the environment variable HTTP_PROXY.</p> + +<p>You can exclude individual hosts from being proxied, or entire domains, for +example:</p> + +<pre class="ruby"><span class="ruby-identifier">options</span>.<span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">exclude</span> = <span class="ruby-string">'optimus'</span> +<span class="ruby-identifier">options</span>.<span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">exclude</span> = [<span class="ruby-string">'optimus'</span>, <span class="ruby-string">'prime'</span>] +<span class="ruby-identifier">options</span>.<span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">exclude</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'*.internal'</span> +</pre> + + + + + <div class="method-source-code" id="proxy-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 101</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">proxy</span> + <span class="ruby-ivar">@proxy</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Proxies</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-test" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">test</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns the test option (environment variable TEST). Possible values are:</p> +<ul><li> +<p>:false â Do not run any tests (also accepts 'no' and +'skip').</p> +</li><li> +<p>:true â <a href="Run.html">Run</a> all tests, stop on failure (default if +not set).</p> +</li><li> +<p>:all â <a href="Run.html">Run</a> all tests, ignore failures.</p> +</li></ul> + + + + + <div class="method-source-code" id="test-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 793</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">test</span> + <span class="ruby-keyword">case</span> <span class="ruby-identifier">value</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'TEST'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'test'</span>] + <span class="ruby-keyword">when</span> <span class="ruby-regexp">/^(no|off|false|skip)$/i</span> + <span class="ruby-keyword">false</span> + <span class="ruby-keyword">when</span> <span class="ruby-regexp">/^all$/i</span> + <span class="ruby-value">:all</span> + <span class="ruby-keyword">when</span> <span class="ruby-regexp">/^only$/i</span> + <span class="ruby-value">:only</span> + <span class="ruby-keyword">when</span> <span class="ruby-regexp">/^(yes|on|true)$/i</span>, <span class="ruby-keyword">nil</span> + <span class="ruby-keyword">true</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">warn</span> <span class="ruby-node">"Expecting the environment variable test to be 'no' or 'all', not sure what to do with #{value}, so I'm just going to run all the tests and stop at failure."</span> + <span class="ruby-keyword">true</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-test-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">test=</span><span + class="method-args">(flag)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Sets the test option (environment variable TEST). Possible values are true, +false or :all.</p> + +<p>You can also set this from the environment variable, e.g.:</p> + +<pre class="ruby"><span class="ruby-identifier">buildr</span> <span class="ruby-comment"># With tests</span> +<span class="ruby-identifier">buildr</span> <span class="ruby-identifier">test</span>=<span class="ruby-identifier">no</span> <span class="ruby-comment"># Without tests</span> +<span class="ruby-identifier">buildr</span> <span class="ruby-identifier">test</span>=<span class="ruby-identifier">all</span> <span class="ruby-comment"># Ignore failures</span> +<span class="ruby-identifier">set</span> <span class="ruby-constant">TEST</span>=<span class="ruby-identifier">no</span> +<span class="ruby-identifier">buildr</span> <span class="ruby-comment"># Without tests</span> +</pre> + + + + + <div class="method-source-code" id="test-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 818</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">test=</span>(<span class="ruby-identifier">flag</span>) + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'test'</span>] = <span class="ruby-keyword">nil</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'TEST'</span>] = <span class="ruby-identifier">flag</span>.<span class="ruby-identifier">to_s</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.0.RC2/site/rdoc/Buildr/Options/Proxies.html ============================================================================== --- dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Options/Proxies.html (added) +++ dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Options/Proxies.html Sat Sep 24 05:13:50 2016 @@ -0,0 +1,342 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Options::Proxies - 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="../../Object.html">Object</a> + +</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-exclude">#exclude</a> + + <li ><a href="#method-i-exclude-3D">#exclude=</a> + + <li ><a href="#method-i-http">#http</a> + + <li ><a href="#method-i-http-3D">#http=</a> + + <li ><a href="#method-i-https">#https</a> + + <li ><a href="#method-i-https-3D">#https=</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Options::Proxies"> + <h1 id="class-Buildr::Options::Proxies" class="class"> + class Buildr::Options::Proxies + </h1> + + <section class="description"> + +<p>Wraps around the proxy environment variables:</p> +<ul><li> +<p>:http â HTTP_PROXY</p> +</li><li> +<p>:https â HTTPS_PROXY</p> +</li><li> +<p>:exclude â NO_PROXY</p> +</li></ul> + + </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-exclude" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">exclude</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns list of hosts to exclude from proxying (NO_PROXY).</p> + + + + + <div class="method-source-code" id="exclude-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 72</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">exclude</span> + <span class="ruby-ivar">@exclude</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">EnvArray</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'NO_PROXY'</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-exclude-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">exclude=</span><span + class="method-args">(url)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Sets list of hosts to exclude from proxy (NO_PROXY). Accepts host name, +array of names, or nil to clear the list.</p> + + + + + <div class="method-source-code" id="exclude-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 78</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">exclude=</span>(<span class="ruby-identifier">url</span>) + <span class="ruby-identifier">exclude</span>.<span class="ruby-identifier">clear</span> + <span class="ruby-identifier">exclude</span>.<span class="ruby-identifier">concat</span> [<span class="ruby-identifier">url</span>].<span class="ruby-identifier">flatten</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">url</span> + <span class="ruby-identifier">exclude</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-http" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">http</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns the HTTP_PROXY URL.</p> + + + + + <div class="method-source-code" id="http-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 50</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">http</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'HTTP_PROXY'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'http_proxy'</span>] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-http-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">http=</span><span + class="method-args">(url)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Sets the HTTP_PROXY URL.</p> + + + + + <div class="method-source-code" id="http-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 55</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">http=</span>(<span class="ruby-identifier">url</span>) + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'http_proxy'</span>] = <span class="ruby-keyword">nil</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'HTTP_PROXY'</span>] = <span class="ruby-identifier">url</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-https" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">https</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns the HTTPS_PROXY URL.</p> + + + + + <div class="method-source-code" id="https-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">https</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'HTTPS_PROXY'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'https_proxy'</span>] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-https-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">https=</span><span + class="method-args">(url)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Sets the HTTPS_PROXY URL.</p> + + + + + <div class="method-source-code" id="https-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/environment.rb, line 66</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">https=</span>(<span class="ruby-identifier">url</span>) + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'https_proxy'</span>] = <span class="ruby-keyword">nil</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'HTTPS_PROXY'</span>] = <span class="ruby-identifier">url</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.0.RC2/site/rdoc/Buildr/POM.html ============================================================================== --- dev/buildr/1.5.0.RC2/site/rdoc/Buildr/POM.html (added) +++ dev/buildr/1.5.0.RC2/site/rdoc/Buildr/POM.html Sat Sep 24 05:13:50 2016 @@ -0,0 +1,442 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::POM - 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="../Object.html">Object</a> + +</div> + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-c-load">::load</a> + + <li ><a href="#method-i-dependencies">#dependencies</a> + + <li ><a href="#method-i-managed">#managed</a> + + <li ><a href="#method-i-properties">#properties</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::POM"> + <h1 id="class-Buildr::POM" class="class"> + class Buildr::POM + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="POM_TO_SPEC_MAP">POM_TO_SPEC_MAP + + <dd> + + + <dt id="SCOPES_TRANSITIVE">SCOPES_TRANSITIVE + + <dd> + + + <dt id="SCOPES_WE_USE">SCOPES_WE_USE + + <dd> + + + </dl> + </section> + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-parent" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">parent</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p>Parent <a href="POM.html">POM</a> if referenced by this <a +href="POM.html">POM</a>.</p> + + </div> + </div> + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p><a href="POM.html">POM</a> project as <a href="../Hash.html">Hash</a> +(using XmlSimple).</p> + + </div> + </div> + + </section> + + + + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Class Methods</h3> + </header> + + + <div id="method-c-load" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + load(arg) + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Load new <a href="POM.html">POM</a> object form various kind of sources +such as artifact, hash representing spec, filename, XML.</p> + + + + + <div class="method-source-code" id="load-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/pom.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">load</span>(<span class="ruby-identifier">source</span>) + <span class="ruby-keyword">case</span> <span class="ruby-identifier">source</span> + <span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> + <span class="ruby-identifier">load</span>(<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifact</span>(<span class="ruby-identifier">source</span>).<span class="ruby-identifier">pom</span>) + <span class="ruby-keyword">when</span> <span class="ruby-constant">Artifact</span> + <span class="ruby-identifier">pom</span> = <span class="ruby-identifier">source</span>.<span class="ruby-identifier">pom</span> + <span class="ruby-identifier">pom</span>.<span class="ruby-identifier">invoke</span> + <span class="ruby-identifier">load</span>(<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">to_s</span>) + <span class="ruby-keyword">when</span> <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">FileTask</span> + <span class="ruby-identifier">source</span>.<span class="ruby-identifier">invoke</span> + <span class="ruby-identifier">load</span>(<span class="ruby-identifier">source</span>.<span class="ruby-identifier">to_s</span>) + <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> + <span class="ruby-identifier">filename</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">source</span>) + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">pom</span> = <span class="ruby-identifier">cache</span>[<span class="ruby-identifier">filename</span>] + <span class="ruby-identifier">trace</span> <span class="ruby-node">"Loading m2 pom file from #{filename}"</span> + <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">pom</span> = <span class="ruby-constant">POM</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">IO</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">filename</span>)) + <span class="ruby-keyword">rescue</span> <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseException</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span> + <span class="ruby-identifier">fail</span> <span class="ruby-node">"Could not parse #{filename}, #{e.continued_exception}"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">cache</span>[<span class="ruby-identifier">filename</span>] = <span class="ruby-identifier">pom</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">pom</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Expecting Hash spec, Artifact, file name or file task'</span> + <span class="ruby-keyword">end</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-dependencies" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + dependencies(scopes?) → artifacts + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + dependencies(:scopes = [:runtime, :test, ...], :optional = true) → artifacts + </span> + + </div> + + + + <div class="method-description"> + + <p>Returns list of required dependencies as specified by the <a +href="POM.html">POM</a>. You can specify which scopes to use (e.g. +âcompileâ, âruntimeâ); use <code>nil</code> for dependencies with +unspecified scope. The default scopes are <code>nil</code>, âcompileâ and +âruntimeâ (aka <a href="POM.html#SCOPES_WE_USE">SCOPES_WE_USE</a>) and no +optional dependencies. Specifying optional = true will return all optional +dependencies matching the given scopes.</p> + + + + + <div class="method-source-code" id="dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/pom.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">dependencies</span>(<span class="ruby-identifier">options</span> = {}) + <span class="ruby-comment"># backward compatibility</span> + <span class="ruby-identifier">options</span> = { <span class="ruby-value">:scopes</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span> } <span class="ruby-keyword">if</span> <span class="ruby-constant">Array</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">options</span> + + <span class="ruby-comment"># support symbols, but don't fidget with nil</span> + <span class="ruby-identifier">options</span>[<span class="ruby-value">:scopes</span>] = (<span class="ruby-identifier">options</span>[<span class="ruby-value">:scopes</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">SCOPES_WE_USE</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span> } + + <span class="ruby-comment"># try to cache dependencies also</span> + <span class="ruby-ivar">@depends_for_scopes</span> <span class="ruby-operator">||=</span> {} + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">depends</span> = <span class="ruby-ivar">@depends_for_scopes</span>[<span class="ruby-identifier">options</span>] + <span class="ruby-identifier">declared</span> = <span class="ruby-identifier">project</span>[<span class="ruby-string">'dependencies'</span>].<span class="ruby-identifier">first</span>[<span class="ruby-string">'dependency'</span>] <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">depends</span> = (<span class="ruby-identifier">declared</span> <span class="ruby-operator">||</span> []) + <span class="ruby-identifier">depends</span> = <span class="ruby-identifier">depends</span>.<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">value_of</span>(<span class="ruby-identifier">dep</span>[<span class="ruby-string">'optional'</span>]) <span class="ruby-operator">=~</span> <span class="ruby-regexp">/true/</span> } <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:optional</span>] + <span class="ruby-identifier">depends</span> = <span class="ruby-identifier">depends</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">pom_to_hash</span>(<span class="ruby-identifier">dep</span>, <span class="ruby-identifier">properties</span>) + <span class="ruby-identifier">apply</span> = <span class="ruby-identifier">managed</span>(<span class="ruby-identifier">spec</span>) + <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">apply</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">spec</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">apply</span> + + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:exclusions</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:exclusions</span>].<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">ex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dep</span>[<span class="ruby-string">'groupId'</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">ex</span>[<span class="ruby-string">'groupId'</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">dep</span>[<span class="ruby-string">'artifactId'</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">ex</span>[<span class="ruby-string">'artifactId'</span>] } + + <span class="ruby-comment"># calculate transitive dependencies</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:scopes</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">spec</span>[<span class="ruby-value">:scope</span>]) + <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:scope</span>) + + <span class="ruby-identifier">exclusions</span> = <span class="ruby-identifier">dep</span>[<span class="ruby-string">'exclusions'</span>].<span class="ruby-identifier">first</span>[<span class="ruby-string">'exclusion'</span>] <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">transitive_deps</span> = <span class="ruby-constant">POM</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">spec</span>).<span class="ruby-identifier">dependencies</span>(<span class="ruby-value">:exclusions</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exclusions</span>, <span class="ruby-value">:scopes</span> =<span class="ruby-operator">></span> (<span class="ruby-identifier">options</span>[<span class="ruby-value">:scopes_transitive</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">SCOPES_TRANSITIVE</span>) ) <span class="ruby-keyword">rescue</span> [] + + [<span class="ruby-constant">Artifact</span>.<span class="ruby-identifier">to_spec</span>(<span class="ruby-identifier">spec</span>)] <span class="ruby-operator">+</span> <span class="ruby-identifier">transitive_deps</span> + <span class="ruby-keyword">end</span> + }.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span> <span class="ruby-comment">#.uniq_by{|spec| art = spec.split(':'); "#{art[0]}:#{art[1]}"}</span> + <span class="ruby-ivar">@depends_for_scopes</span>[<span class="ruby-identifier">options</span>] = <span class="ruby-identifier">depends</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">depends</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-managed" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + managed() → hash + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + managed(hash) → hash + </span> + + </div> + + + + <div class="method-description"> + + <p>The first form returns all the managed dependencies specified by this <a +href="POM.html">POM</a> in dependencyManagement. The second form uses a +single spec hash and expands it from the current/parent <a +href="POM.html">POM</a>. Used to determine the version number if specified +in dependencyManagement instead of dependencies.</p> + + + + + <div class="method-source-code" id="managed-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/pom.rb, line 150</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">managed</span>(<span class="ruby-identifier">spec</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span> + <span class="ruby-identifier">managed</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> [<span class="ruby-value">:group</span>, <span class="ruby-value">:id</span>, <span class="ruby-value">:type</span>, <span class="ruby-value">:classifier</span>].<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">spec</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">dep</span>[<span class="ruby-identifier">key</span>] } } <span class="ruby-operator">||</span> + (<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">managed</span>(<span class="ruby-identifier">spec</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@managed</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">managed</span> = <span class="ruby-identifier">project</span>[<span class="ruby-string">'dependencyManagement'</span>].<span class="ruby-identifier">first</span>[<span class="ruby-string">'dependencies'</span>].<span class="ruby-identifier">first</span>[<span class="ruby-string">'dependency'</span>] <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">managed</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">managed</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">pom_to_hash</span>(<span class="ruby-identifier">dep</span>, <span class="ruby-identifier">properties</span>) } <span class="ruby-operator">:</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-properties" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + properties() → hash + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns properties available to this <a href="POM.html">POM</a> as hash. +Includes explicit properties and pom.xxx/project.xxx properties for +groupId, artifactId, version and packaging.</p> + + + + + <div class="method-source-code" id="properties-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/pom.rb, line 125</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">properties</span>() + <span class="ruby-ivar">@properties</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">pom</span> = <span class="ruby-node">%w(groupId artifactId version packaging)</span>.<span class="ruby-identifier">inject</span>({}) { <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, <span class="ruby-identifier">key</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">value</span> = <span class="ruby-identifier">project</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">||</span> (<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">project</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">hash</span>[<span class="ruby-node">"pom.#{key}"</span>] = <span class="ruby-identifier">hash</span>[<span class="ruby-node">"project.#{key}"</span>] = <span class="ruby-identifier">value_of</span>(<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> + <span class="ruby-identifier">hash</span> + } + <span class="ruby-identifier">pom</span> = <span class="ruby-node">%w(groupId artifactId version)</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-identifier">pom</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, <span class="ruby-identifier">key</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">value</span> = <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">project</span>[<span class="ruby-identifier">key</span>] + <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">hash</span>[<span class="ruby-node">"pom.parent.#{key}"</span>] = <span class="ruby-identifier">hash</span>[<span class="ruby-node">"project.parent.#{key}"</span>] = <span class="ruby-identifier">value_of</span>(<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> + <span class="ruby-identifier">hash</span> + } <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span> + <span class="ruby-identifier">props</span> = <span class="ruby-identifier">project</span>[<span class="ruby-string">'properties'</span>].<span class="ruby-identifier">first</span> <span class="ruby-keyword">rescue</span> {} + <span class="ruby-identifier">props</span> = <span class="ruby-identifier">props</span>.<span class="ruby-identifier">inject</span>({}) { <span class="ruby-operator">|</span><span class="ruby-identifier">mapped</span>, <span class="ruby-identifier">pair</span><span class="ruby-operator">|</span> <span class="ruby-identifier">mapped</span>[<span class="ruby-identifier">pair</span>.<span class="ruby-identifier">first</span>] = <span class="ruby-identifier">value_of</span>(<span class="ruby-identifier">pair</span>.<span class="ruby-identifier">last</span>, <span class="ruby-identifier">props</span>) ; <span class="ruby-identifier">mapped</span> } + (<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">properties</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">props</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">props</span>).<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">pom</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.0.RC2/site/rdoc/Buildr/Package.html ============================================================================== --- dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Package.html (added) +++ dev/buildr/1.5.0.RC2/site/rdoc/Buildr/Package.html Sat Sep 24 05:13:50 2016 @@ -0,0 +1,450 @@ +<!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">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-ivar">@pom</span>.<span class="ruby-identifier">pom_xml</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-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-identifier">package</span>.<span class="ruby-identifier">pom</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 213</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.0.RC2/site/rdoc/Buildr/PackageAsTestJar.html ============================================================================== --- dev/buildr/1.5.0.RC2/site/rdoc/Buildr/PackageAsTestJar.html (added) +++ dev/buildr/1.5.0.RC2/site/rdoc/Buildr/PackageAsTestJar.html Sat Sep 24 05:13:50 2016 @@ -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.0.RC2/site/rdoc/Buildr/PackageGemTask.html ============================================================================== --- dev/buildr/1.5.0.RC2/site/rdoc/Buildr/PackageGemTask.html (added) +++ dev/buildr/1.5.0.RC2/site/rdoc/Buildr/PackageGemTask.html Sat Sep 24 05:13:50 2016 @@ -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> +
