Added: dev/buildr/1.5.6/site/rdoc/Buildr/Layout.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/Layout.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/Layout.html Wed May 9 23:46:39 2018 @@ -0,0 +1,322 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Layout - 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-5B-5D">#[]</a> + + <li ><a href="#method-i-5B-5D-3D">#[]=</a> + + <li ><a href="#method-i-expand">#expand</a> + + <li ><a href="#method-i-initialize_copy">#initialize_copy</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Layout"> + <h1 id="class-Buildr::Layout" class="class"> + class Buildr::Layout + </h1> + + <section class="description"> + +<p>Symbolic mapping for directory layout. Used for both the default and +custom layouts.</p> + +<p>For example, the default layout maps [:source, :main, :java] to +'src/main/java', and</p> +<dl class="rdoc-list label-list"><dt>:target, :main, :classes +<dd> +<p>to 'target/classes'. You can use this to change the layout</p> +</dd></dl> + +<p>of your projects.</p> + +<p>To map [:source, :main] into the 'sources' directory:</p> + +<pre>my_layout = Layout.new +my_layout[:source, :main] = 'sources' + +define 'foo', :layout=>my_layout do + ... +end</pre> + +<p>To map [:source, :main, :java] to 'java/main':</p> + +<pre>class MainLast < Layout + def expand(*args) + if args[0..1] == [:source, :main] + super args[2], :main, *args[3,] + else + super + end + end +end + +define 'foo', :layout=>MainLast do + ... +end</pre> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-c-default" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">default</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + <p><a href="Layout/Default.html">Default</a> layout used by new projects.</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-5B-5D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">[]</span><span + class="method-args">(*args)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Resolves a list of symbols into a path.</p> + + + + + <div class="method-source-code" id="5B-5D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 70</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-ivar">@mapping</span>[<span class="ruby-identifier">args</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>)] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-5B-5D-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">[]=</span><span + class="method-args">(*args)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Specifies the path resolved from a list of symbols.</p> + + + + + <div class="method-source-code" id="5B-5D-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 75</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-ivar">@mapping</span>[<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>)] = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-expand" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">expand</span><span + class="method-args">(*args)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Expands list of symbols and path names into a full path, for example:</p> + +<pre>puts default.expand(:source, :main, :java) +=> "src/main/java"</pre> + + + + + <div class="method-source-code" id="expand-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 62</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">expand</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-identifier">args</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">reject</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-identifier">empty?</span> }.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_sym</span>) + <span class="ruby-keyword">return</span> <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-ivar">@mapping</span>[<span class="ruby-identifier">args</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-operator">*</span>[<span class="ruby-identifier">expand</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>]), <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">to_s</span>].<span class="ruby-identifier">reject</span>(<span class="ruby-operator">&</span><span class="ruby-value">:empty?</span>)) <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> + <span class="ruby-keyword">return</span> <span class="ruby-ivar">@mapping</span>[<span class="ruby-identifier">args</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">to_s</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-initialize_copy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">initialize_copy</span><span + class="method-args">(copy)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="initialize_copy-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 79</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_copy</span>(<span class="ruby-identifier">copy</span>) + <span class="ruby-identifier">copy</span>.<span class="ruby-identifier">instance_variable_set</span> <span class="ruby-value">:@mapping</span>, <span class="ruby-ivar">@mapping</span>.<span class="ruby-identifier">clone</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.6/site/rdoc/Buildr/Layout/Default.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/Layout/Default.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/Layout/Default.html Wed May 9 23:46:39 2018 @@ -0,0 +1,178 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Layout::Default - 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="../Layout.html">Buildr::Layout</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> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Layout::Default"> + <h1 id="class-Buildr::Layout::Default" class="class"> + class Buildr::Layout::Default + </h1> + + <section class="description"> + +<p><a href="Default.html">Default</a> layout has the following properties:</p> +<ul><li> +<p>:source maps to the 'src' directory.</p> +</li><li> +<p>Anything under :source maps verbatim (e.g. :source, :main becomes +'src/main')</p> +</li><li> +<p>:target maps to the 'target' directory.</p> +</li><li> +<p>:target, :main maps to the 'target' directory as well.</p> +</li><li> +<p>Anything under :target, :main maps verbatim (e.g. :target, :main, :classes +becomes 'target/classes')</p> +</li><li> +<p>Anything else under :target also maps verbatim (e.g. :target, :test becomes +'target/test')</p> +</li></ul> + + </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">()</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/core/project.rb, line 92</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span> + <span class="ruby-keyword">super</span> + <span class="ruby-keyword">self</span>[<span class="ruby-value">:source</span>] = <span class="ruby-string">'src'</span> + <span class="ruby-keyword">self</span>[<span class="ruby-value">:target</span>, <span class="ruby-value">:main</span>] = <span class="ruby-string">'target'</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.6/site/rdoc/Buildr/MultiTest.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/MultiTest.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/MultiTest.html Wed May 9 23:46:39 2018 @@ -0,0 +1,183 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::MultiTest - 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="TestFramework/Java.html">Buildr::TestFramework::Java</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-tests">#tests</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::MultiTest"> + <h1 id="class-Buildr::MultiTest" class="class"> + class Buildr::MultiTest + </h1> + + <section class="description"> + +<p>A composite test framework that runs multiple other test frameworks.</p> + +<p>e.g.,</p> + +<pre>test.using :multitest, :frameworks => [ Buildr::JUnit, Buildr::TestNG ], :options = { + :junit => { :fork => true }, + :testng => { ... } +}</pre> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-frameworks" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">frameworks</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </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-tests" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tests</span><span + class="method-args">(dependencies)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="tests-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/tests.rb, line 385</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tests</span>(<span class="ruby-identifier">dependencies</span>) + <span class="ruby-ivar">@frameworks</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">tests</span>(<span class="ruby-identifier">dependencies</span>) }.<span class="ruby-identifier">flatten</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.6/site/rdoc/Buildr/OptionalArtifact.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/OptionalArtifact.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/OptionalArtifact.html Wed May 9 23:46:39 2018 @@ -0,0 +1,164 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::OptionalArtifact - 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="Artifact.html">Buildr::Artifact</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-i-download">#download</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::OptionalArtifact"> + <h1 id="class-Buildr::OptionalArtifact" class="class"> + class Buildr::OptionalArtifact + </h1> + + <section class="description"> + +<p>An artifact that is optional. If downloading fails, the user will be +informed but it will not raise an exception.</p> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Protected Instance Methods</h3> + </header> + + + <div id="method-i-download" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">download</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>If downloading fails, the user will be informed but it will not raise an +exception.</p> + + + <div class="method-calls-super"> + Calls superclass method + <a href="Artifact.html#method-i-download">Buildr::Artifact#download</a> + </div> + + + + <div class="method-source-code" id="download-source"> + <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 616</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">download</span> + <span class="ruby-keyword">super</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-identifier">info</span> <span class="ruby-node">"Failed to download #{to_spec}. Skipping it."</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.6/site/rdoc/Buildr/Options.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/Options.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/Options.html Wed May 9 23:46:39 2018 @@ -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.6/site/rdoc/Buildr/Options/Proxies.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/Options/Proxies.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/Options/Proxies.html Wed May 9 23:46:39 2018 @@ -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.6/site/rdoc/Buildr/POM.html ============================================================================== --- dev/buildr/1.5.6/site/rdoc/Buildr/POM.html (added) +++ dev/buildr/1.5.6/site/rdoc/Buildr/POM.html Wed May 9 23:46:39 2018 @@ -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> +