Added: dev/buildr/1.5.0/site/rdoc/Buildr/Packaging/Java/WarTask.html ============================================================================== --- dev/buildr/1.5.0/site/rdoc/Buildr/Packaging/Java/WarTask.html (added) +++ dev/buildr/1.5.0/site/rdoc/Buildr/Packaging/Java/WarTask.html Sat Sep 17 06:23:20 2016 @@ -0,0 +1,164 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Packaging::Java::WarTask - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../../"; +</script> + +<script src="../../../js/jquery.js"></script> +<script src="../../../js/darkfish.js"></script> + +<link href="../../../css/fonts.css" rel="stylesheet"> +<link href="../../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="class"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../../table_of_contents.html#pages">Pages</a> + <a href="../../../table_of_contents.html#classes">Classes</a> + <a href="../../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + <div id="parent-class-section" class="nav-section"> + <h3>Parent</h3> + + + <p class="link"><a href="JarTask.html">Buildr::Packaging::Java::JarTask</a> + +</div> + + <div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="../../../Buildr.html">Buildr</a> + + + </ul> +</div> + + + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Packaging::Java::WarTask"> + <h1 id="class-Buildr::Packaging::Java::WarTask" class="class"> + class Buildr::Packaging::Java::WarTask + </h1> + + <section class="description"> + +<p>Extends the <a href="JarTask.html">JarTask</a> to create a WAR file.</p> + +<p>Supports all the same options as <a href="JarTask.html">JarTask</a>, in +additon to these two options:</p> +<ul><li> +<p>:libs â An array of files, tasks, artifact specifications, etc that will be +added to the WEB-INF/lib directory.</p> +</li><li> +<p>:classes â A directory containing class files for inclusion in the +WEB-INF/classes directory.</p> +</li></ul> + +<p>For example:</p> + +<pre class="ruby"><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-string">'log4j:log4j:jar:1.1'</span>) +</pre> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-classes" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">classes</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + <p>Directories with class files to include under WEB-INF/classes.</p> + + </div> + </div> + + <div id="attribute-i-libs" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">libs</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + <p>Artifacts to include under WEB-INF/libs.</p> + + </div> + </div> + + </section> + + + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer";>Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/";>RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/";>Darkfish</a> by <a href="http://deveiate.org";>Michael Granger</a>. +</footer> +
Added: dev/buildr/1.5.0/site/rdoc/Buildr/Packaging/Scala.html ============================================================================== --- dev/buildr/1.5.0/site/rdoc/Buildr/Packaging/Scala.html (added) +++ dev/buildr/1.5.0/site/rdoc/Buildr/Packaging/Scala.html Sat Sep 17 06:23:20 2016 @@ -0,0 +1,95 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Packaging::Scala - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + + + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Packaging::Scala"> + <h1 id="module-Buildr::Packaging::Scala" class="module"> + module Buildr::Packaging::Scala + </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/site/rdoc/Buildr/ProcessStatus.html ============================================================================== --- dev/buildr/1.5.0/site/rdoc/Buildr/ProcessStatus.html (added) +++ dev/buildr/1.5.0/site/rdoc/Buildr/ProcessStatus.html Sat Sep 17 06:23:20 2016 @@ -0,0 +1,576 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::ProcessStatus - 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-new">::new</a> + + <li ><a href="#method-i-26">#&</a> + + <li ><a href="#method-i-3D-3D">#==</a> + + <li ><a href="#method-i-3E-3E">#>></a> + + <li ><a href="#method-i-coredump-3F">#coredump?</a> + + <li ><a href="#method-i-exited-3F">#exited?</a> + + <li ><a href="#method-i-stopped-3F">#stopped?</a> + + <li ><a href="#method-i-success-3F">#success?</a> + + <li ><a href="#method-i-to_i">#to_i</a> + + <li ><a href="#method-i-to_int">#to_int</a> + + <li ><a href="#method-i-to_s">#to_s</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::ProcessStatus"> + <h1 id="class-Buildr::ProcessStatus" class="class"> + class Buildr::ProcessStatus + </h1> + + <section class="description"> + + </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-exitstatus" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">exitstatus</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-pid" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">pid</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-stopsig" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">stopsig</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-termsig" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">termsig</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </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-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(pid, success, exitstatus)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 300</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">pid</span>, <span class="ruby-identifier">success</span>, <span class="ruby-identifier">exitstatus</span>) + <span class="ruby-ivar">@pid</span> = <span class="ruby-identifier">pid</span> + <span class="ruby-ivar">@success</span> = <span class="ruby-identifier">success</span> + <span class="ruby-ivar">@exitstatus</span> = <span class="ruby-identifier">exitstatus</span> + + <span class="ruby-ivar">@termsig</span> = <span class="ruby-keyword">nil</span> + <span class="ruby-ivar">@stopsig</span> = <span class="ruby-keyword">nil</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-26" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">&</span><span + class="method-args">(num)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="26-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 309</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">&</span>(<span class="ruby-identifier">num</span>) + <span class="ruby-identifier">pid</span> <span class="ruby-operator">&</span> <span class="ruby-identifier">num</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-3D-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">==</span><span + class="method-args">(other)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="3D-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 313</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">other</span>) + <span class="ruby-identifier">pid</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">pid</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-3E-3E" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">>></span><span + class="method-args">(num)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="3E-3E-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 317</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">>></span>(<span class="ruby-identifier">num</span>) + <span class="ruby-identifier">pid</span> <span class="ruby-operator">>></span> <span class="ruby-identifier">num</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-coredump-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">coredump?</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="coredump-3F-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 321</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">coredump?</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-exited-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">exited?</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="exited-3F-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 325</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">exited?</span> + <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-stopped-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">stopped?</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="stopped-3F-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 329</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">stopped?</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-success-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">success?</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="success-3F-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 333</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">success?</span> + <span class="ruby-ivar">@success</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-to_i" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_i</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="to_i-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 337</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_i</span> + <span class="ruby-identifier">pid</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-to_int" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_int</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="to_int-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 341</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_int</span> + <span class="ruby-identifier">pid</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-to_s" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_s</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="to_s-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/util.rb, line 345</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span> + <span class="ruby-identifier">pid</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/site/rdoc/Buildr/Project.html ============================================================================== --- dev/buildr/1.5.0/site/rdoc/Buildr/Project.html (added) +++ dev/buildr/1.5.0/site/rdoc/Buildr/Project.html Sat Sep 17 06:23:20 2016 @@ -0,0 +1,1210 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Project - 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">Rake::Task + +</div> + + <div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="CC.html">Buildr::CC</a> + + + + <li><a class="include" href="Compile.html">Buildr::Compile</a> + + + + <li><a class="include" href="../Buildr.html">Buildr</a> + + + + <li><a class="include" href="Test.html">Buildr::Test</a> + + + + <li><a class="include" href="Eclipse.html">Buildr::Eclipse</a> + + + + <li><a class="include" href="Eclipse/Plugin.html">Buildr::Eclipse::Plugin</a> + + + + <li><a class="include" href="Eclipse/Scala.html">Buildr::Eclipse::Scala</a> + + + + <li><a class="include" href="Eclipse/Java.html">Buildr::Eclipse::Java</a> + + + + <li><a class="include" href="IntellijIdea/ProjectExtension.html">Buildr::IntellijIdea::ProjectExtension</a> + + + + <li><a class="include" href="Ant.html">Buildr::Ant</a> + + + + <li><span class="include">CoberturaExtension</span> + + + + <li><span class="include">EmmaExtension</span> + + + + <li><a class="include" href="Package.html">Buildr::Package</a> + + + + <li><a class="include" href="PackageAsTestJar.html">Buildr::PackageAsTestJar</a> + + + + <li><a class="include" href="Run.html">Buildr::Run</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-c-clear">::clear</a> + + <li ><a href="#method-c-local_task">::local_task</a> + + <li ><a href="#method-c-on_define">::on_define</a> + + <li ><a href="#method-i-_">#_</a> + + <li ><a href="#method-i-base_dir">#base_dir</a> + + <li ><a href="#method-i-base_dir-3D">#base_dir=</a> + + <li ><a href="#method-i-define">#define</a> + + <li ><a href="#method-i-define-21">#define!</a> + + <li ><a href="#method-i-defined-3F">#defined?</a> + + <li ><a href="#method-i-file">#file</a> + + <li ><a href="#method-i-layout">#layout</a> + + <li ><a href="#method-i-layout-3D">#layout=</a> + + <li ><a href="#method-i-path_to">#path_to</a> + + <li ><a href="#method-i-project">#project</a> + + <li ><a href="#method-i-projects">#projects</a> + + <li ><a href="#method-i-recursive_task">#recursive_task</a> + + <li ><a href="#method-i-root_project">#root_project</a> + + <li ><a href="#method-i-task">#task</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Project"> + <h1 id="class-Buildr::Project" class="class"> + class Buildr::Project + </h1> + + <section class="description"> + +<p>A project definition is where you define all the tasks associated with the +project you're building.</p> + +<p>The project itself will define several life cycle tasks for you. For +example, it automatically creates a compile task that will compile all the +source files found in src/main/java into target/classes, a test task that +will compile source files from src/test/java and run all the <a +href="JUnit.html">JUnit</a> tests found there, and a build task to compile +and then run the tests.</p> + +<p>You use the project definition to enhance these tasks, for example, telling +the compile task which class path dependencies to use. Or telling the +project how to package an artifact, e.g. creating a JAR using <code>package +:jar</code>.</p> + +<p>You can also define additional tasks that are executed by project tasks, or +invoked from rake.</p> + +<p>Tasks created by the project are all prefixed with the project name, e.g. +the project foo creates the task foo:compile. If foo contains a sub-project +bar, the later will define the task foo:bar:compile. Since the compile task +is recursive, compiling foo will also compile foo:bar.</p> + +<p>If you run:</p> + +<pre class="ruby"><span class="ruby-identifier">buildr</span> <span class="ruby-identifier">compile</span> +</pre> + +<p>from the command line, it will execute the compile task of the current +project.</p> + +<p>Projects and sub-projects follow a directory heirarchy. The Buildfile is +assumed to reside in the same directory as the top-level project, and each +sub-project is contained in a sub-directory in the same name. For example:</p> + +<pre>/home/foo +|__ Buildfile +|__ src/main/java +|__ foo + |__ src/main/java</pre> + +<p>The default structure of each project is assumed to be:</p> + +<pre>src +|__main +| |__java <-- Source files to compile +| |__resources <-- Resources to copy +| |__webapp <-- For WARs +|__test +| |__java <-- Source files to compile (tests) +| |__resources <-- Resources to copy (tests) +|__target <-- Packages created here +| |__classes <-- Generated when compiling +| |__resources <-- Copied (and filtered) from resources +| |__test/classes <-- Generated when compiling tests +| |__test/resources <-- Copied (and filtered) from resources +|__reports <-- Test, coverage and other reports</pre> + +<p>You can change the project layout by passing a new <a +href="Layout.html">Layout</a> to the project definition.</p> + +<p>You can only define a project once using <a +href="Project.html#method-i-define">define</a>. Afterwards, you can obtain +the project definition using <a +href="Project.html#method-i-project">project</a>. The order in which you +define projects is not important, project definitions are evaluated when +you ask for them. Circular dependencies will not work. <a +href="../Rake.html">Rake</a> tasks are only created after the project is +evaluated, so if you need to access a task (e.g. compile) use +<code>project('foo').compile</code> instead of +<code>task('foo:compile')</code>.</p> + +<p>For example:</p> + +<pre>define 'myapp', :version=>'1.1' do + + define 'wepapp' do + compile.with project('myapp:beans') + package :war + end + + define 'beans' do + compile.with DEPENDS + package :jar + end +end + +puts projects.map(&:name) +=> [ 'myapp', 'myapp:beans', 'myapp:webapp' ] +puts project('myapp:webapp').parent.name +=> 'myapp' +puts project('myapp:webapp').compile.classpath.map(&:to_spec) +=> 'myapp:myapp-beans:jar:1.1'</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-name" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">name</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p>The project name. For example, 'foo' for the top-level project, and +'foo:bar' for its sub-project.</p> + + </div> + </div> + + <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>The parent project if this is a sub-project.</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-clear" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + clear + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Discard all project definitions.</p> + + + + + <div class="method-source-code" id="clear-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 298</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">clear</span> + <span class="ruby-ivar">@projects</span>.<span class="ruby-identifier">clear</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@projects</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-c-local_task" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + local_task(name) + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + local_task(name) { |name| ... } + </span> + + </div> + + + + <div class="method-description"> + + <p>Defines a local task with an optional execution message.</p> + +<p>A local task is a task that executes a task with the same name, defined in +the current project, the project's with a base directory that is the +same as the current directory.</p> + +<p>Complicated? Try this:</p> + +<pre class="ruby"><span class="ruby-identifier">buildr</span> <span class="ruby-identifier">build</span> +</pre> + +<p>is the same as:</p> + +<pre class="ruby"><span class="ruby-identifier">buildr</span> <span class="ruby-identifier">foo</span>:<span class="ruby-identifier">build</span> +</pre> + +<p>But:</p> + +<pre class="ruby"><span class="ruby-identifier">cd</span> <span class="ruby-identifier">bar</span> +<span class="ruby-identifier">buildr</span> <span class="ruby-identifier">build</span> +</pre> + +<p>is the same as:</p> + +<pre>buildr foo:bar:build</pre> + +<p>The optional block is called with the project name when the task executes +and returns a message that, for example âBuilding project #{name}â.</p> + + + + + <div class="method-source-code" id="local_task-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 324</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">local_task</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">task</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span>, <span class="ruby-identifier">args</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">args</span> = <span class="ruby-identifier">task</span>.<span class="ruby-identifier">arg_names</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">args</span>[<span class="ruby-identifier">n</span>]} + <span class="ruby-identifier">local_projects</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">info</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">name</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span> + <span class="ruby-identifier">task</span>(<span class="ruby-node">"#{project.name}:#{task.name}"</span>).<span class="ruby-identifier">invoke</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</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-c-on_define" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">on_define</span><span + class="method-args">(&block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p><strong>Deprecated</strong> Check the <a +href="Extension.html">Extension</a> module to see how extensions are +handled.</p> + + + + + <div class="method-source-code" id="on_define-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 335</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_define</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">deprecated</span> <span class="ruby-string">'This method is deprecated, see Extension'</span> + (<span class="ruby-ivar">@on_define</span> <span class="ruby-operator">||=</span> []) <span class="ruby-operator"><<</span> <span class="ruby-identifier">block</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</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-_" class="method-detail method-alias"> + + <div class="method-heading"> + <span class="method-name">_</span><span + class="method-args">(*names)</span> + + </div> + + + <div class="method-description"> + + + + + + + </div> + + + + + <div class="aliases"> + Alias for: <a href="Project.html#method-i-path_to">path_to</a> + </div> + + </div> + + + <div id="method-i-base_dir" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + base_dir → path + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns the project's base directory.</p> + +<p>The Buildfile defines top-level project, so it's logical that the +top-level project's base directory is the one in which we find the +Buildfile. And each sub-project has a base directory that is one level +down, with the same name as the sub-project.</p> + +<p>For example:</p> + +<pre>/home/foo/ <-- base_directory of project 'foo' +/home/foo/Buildfile <-- builds 'foo' +/home/foo/bar <-- sub-project 'foo:bar'</pre> + + + + + <div class="method-source-code" id="base_dir-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 444</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">base_dir</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@base_dir</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span> + <span class="ruby-comment"># For sub-project, a good default is a directory in the parent's base_dir,</span> + <span class="ruby-comment"># using the same name as the project.</span> + <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>).<span class="ruby-identifier">last</span>, <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">base_dir</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-comment"># For top-level project, a good default is the directory where we found the Buildfile.</span> + <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-ivar">@base_dir</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-defined-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">defined?</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="defined-3F-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 619</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">defined?</span> + <span class="ruby-ivar">@defined</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-file" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + file(path) → Task + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + file(path=>prereqs) → Task + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + file(path) { |task| ... } → Task + </span> + + </div> + + + + <div class="method-description"> + + <p>Creates and returns a new file task in the project. Similar to calling +Rake's file method, but the path is expanded relative to the +project's base directory, and the task executes in the project's +base directory.</p> + +<p>For example:</p> + +<pre>define 'foo' do + define 'bar' do + file('src') { ... } + end +end + +puts project('foo:bar').file('src').to_s +=> '/home/foo/bar/src'</pre> + + + + + <div class="method-source-code" id="file-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 506</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">file</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">arg_names</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) + <span class="ruby-identifier">task</span> = <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">FileTask</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-identifier">path_to</span>(<span class="ruby-identifier">task_name</span>)) + <span class="ruby-identifier">task</span>.<span class="ruby-identifier">set_arg_names</span>(<span class="ruby-identifier">arg_names</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">arg_names</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">task</span>.<span class="ruby-identifier">enhance</span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">deps</span>), <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-layout" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">layout</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns the layout associated with this project.</p> + + + + + <div class="method-source-code" id="layout-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 459</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">layout</span> + <span class="ruby-ivar">@layout</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">layout</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Layout</span>.<span class="ruby-identifier">default</span>).<span class="ruby-identifier">clone</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-path_to" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + path_to(*names) → path + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Returns a path from a combination of name, relative to the project's +base directory. Essentially, joins all the supplied names and expands the +path relative to <a href="Project.html#method-i-base_dir">base_dir</a>. +Symbol arguments are converted to paths based on the layout, so whenever +possible stick to these. For example:</p> + +<pre>path_to(:source, :main, :java) +=> 'src/main/java'</pre> + +<p>Keep in mind that all tasks are defined and executed relative to the +Buildfile directory, so you want to use <a +href="Project.html#method-i-path_to">path_to</a> to get the actual path +within the project as a matter of practice.</p> + +<p>For example:</p> + +<pre>path_to('foo', 'bar') +=> foo/bar +path_to('/tmp') +=> /tmp +path_to(:base_dir, 'foo') # same as path_to('foo") +=> /home/project1/foo</pre> + + + + + <div class="method-source-code" id="path_to-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 483</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">path_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>) + <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">layout</span>.<span class="ruby-identifier">expand</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>), <span class="ruby-identifier">base_dir</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + <div class="aliases"> + Also aliased as: <a href="Project.html#method-i-_">_</a> + </div> + + + + </div> + + + <div id="method-i-project" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + project(name) → project + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + project → self + </span> + + </div> + + + + <div class="method-description"> + + <p>Same as Buildr#project. This method is called on a project, so a relative +name is sufficient to find a sub-project.</p> + +<p>When called on a project without a name, returns the project itself. You +can use that when setting project properties, for example:</p> + +<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'foo'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">version</span> = <span class="ruby-string">'1.0'</span> +<span class="ruby-keyword">end</span> +</pre> + + + + + <div class="method-source-code" id="project-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 578</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-keyword">if</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-identifier">options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">options</span> = {} + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-keyword">self</span> + <span class="ruby-keyword">else</span> + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">project</span> <span class="ruby-operator">*</span>(<span class="ruby-identifier">args</span> <span class="ruby-operator">+</span> [{ <span class="ruby-value">:scope=</span><span class="ruby-operator">></span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span> }.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)]), <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-projects" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + projects(*names) → projects + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Same as Buildr#projects. This method is called on a project, so relative +names are sufficient to find sub-projects.</p> + + + + + <div class="method-source-code" id="projects-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 596</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">projects</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-keyword">if</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-identifier">options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">options</span> = {} + <span class="ruby-keyword">end</span> + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">projects</span> <span class="ruby-operator">*</span>(<span class="ruby-identifier">args</span> <span class="ruby-operator">+</span> [{ <span class="ruby-value">:scope=</span><span class="ruby-operator">></span><span class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span> }.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)]) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-recursive_task" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + recursive_task(name→prereqs) { |task| ... } + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Define a recursive task. A recursive task executes itself and the same task +in all the sub-projects.</p> + + + + + <div class="method-source-code" id="recursive_task-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 558</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">recursive_task</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">arg_names</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) + <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">parallel</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">multitask</span>(<span class="ruby-identifier">task_name</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">task</span>(<span class="ruby-identifier">task_name</span>) + <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">task</span>(<span class="ruby-identifier">task_name</span>).<span class="ruby-identifier">enhance</span> [<span class="ruby-identifier">task</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span> + <span class="ruby-identifier">task</span>.<span class="ruby-identifier">set_arg_names</span>(<span class="ruby-identifier">arg_names</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">arg_names</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">task</span>.<span class="ruby-identifier">enhance</span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">deps</span>), <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-root_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">root_project</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Returns the root project for this project.</p> + +<p>If this project is a subproject it will find the top level project and +return it, else it will return itself.</p> + + + + + <div class="method-source-code" id="root_project-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 423</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">root_project</span> + <span class="ruby-identifier">p</span> = <span class="ruby-identifier">project</span> + <span class="ruby-keyword">while</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">parent</span> + <span class="ruby-identifier">p</span> = <span class="ruby-identifier">p</span>.<span class="ruby-identifier">parent</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">p</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-task" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + task(name) → Task + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + task(name=>prereqs) → Task + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + task(name) { |task| ... } → Task + </span> + + </div> + + + + <div class="method-description"> + + <p>Creates and returns a new task in the project. Similar to calling +Rake's task method, but prefixes the task name with the project name +and executes the task in the project's base directory.</p> + +<p>For example:</p> + +<pre>define 'foo' do + task 'doda' +end + +puts project('foo').task('doda').name +=> 'foo:doda'</pre> + +<p>When called from within the project definition, creates a new task if the +task does not already exist. If called from outside the project definition, +returns the named task and raises an exception if the task is not defined.</p> + +<p>As with Rake's task method, calling this method enhances the task with +the prerequisites and optional block.</p> + + + + + <div class="method-source-code" id="task-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 536</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">task</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">arg_names</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">task_name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^:/</span> + <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">switch_to_namespace</span> [] <span class="ruby-keyword">do</span> + <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-identifier">task_name</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">current_scope</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>) + <span class="ruby-identifier">task</span> = <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">define_task</span>(<span class="ruby-identifier">task_name</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">task</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">task_name</span>, <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>)) + <span class="ruby-identifier">raise</span> <span class="ruby-node">"You cannot define a project task outside the project definition, and no task #{name}:#{task_name} defined in the project"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">task</span>.<span class="ruby-identifier">set_arg_names</span>(<span class="ruby-identifier">arg_names</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">arg_names</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">task</span>.<span class="ruby-identifier">enhance</span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">deps</span>), <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Protected Instance Methods</h3> + </header> + + + <div id="method-i-base_dir-3D" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + base_dir = dir + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Sets the project's base directory. Allows you to specify a base +directory by calling this accessor, or with the :base_dir property when +calling <a href="Project.html#method-i-define">define</a>.</p> + +<p>You can only set the base directory once for a given project, and only +before accessing the base directory (for example, by calling <a +href="Project.html#method-i-file">file</a> or <a +href="Project.html#method-i-path_to">path_to</a>). Set the base directory. +Note: you can only do this once for a project, and only before accessing +the base directory. If you try reading the value with <a +href="Project.html#method-i-base_dir">base_dir</a>, the base directory +cannot be set again.</p> + + + + + <div class="method-source-code" id="base_dir-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 640</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">base_dir=</span>(<span class="ruby-identifier">dir</span>) + <span class="ruby-identifier">raise</span> <span class="ruby-string">'Cannot set base directory twice, or after reading its value'</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@base_dir</span> + <span class="ruby-ivar">@base_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">dir</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-define" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + define(name, properties?) { |project| ... } → project + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>Define a new sub-project within this project. See Buildr#define.</p> + + + + + <div class="method-source-code" id="define-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 656</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">define</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">properties</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">define</span> <span class="ruby-node">"#{self.name}:#{name}"</span>, <span class="ruby-identifier">properties</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-define-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">define!</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="define-21-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 624</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">define!</span> + <span class="ruby-ivar">@defined</span> = <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-layout-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">layout=</span><span + class="method-args">(layout)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Sets the project layout. Accepts <a href="Layout.html">Layout</a> object +or class (or for that matter, anything that can expand).</p> + + + + + <div class="method-source-code" id="layout-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 647</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">layout=</span>(<span class="ruby-identifier">layout</span>) + <span class="ruby-identifier">raise</span> <span class="ruby-string">'Cannot set directory layout twice, or after reading its value'</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@layout</span> + <span class="ruby-ivar">@layout</span> = <span class="ruby-identifier">layout</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Class</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">layout</span>.<span class="ruby-identifier">new</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">layout</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/site/rdoc/Buildr/RSpec.html ============================================================================== --- dev/buildr/1.5.0/site/rdoc/Buildr/RSpec.html (added) +++ dev/buildr/1.5.0/site/rdoc/Buildr/RSpec.html Sat Sep 17 06:23:20 2016 @@ -0,0 +1,279 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::RSpec - 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">Buildr::TestFramework::JavaBDD + +</div> + + <div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="TestFramework/JRubyBased.html">Buildr::TestFramework::JRubyBased</a> + + + </ul> +</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-runner_config">#runner_config</a> + + <li ><a href="#method-i-runner_content">#runner_content</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::RSpec"> + <h1 id="class-Buildr::RSpec" class="class"> + class Buildr::RSpec + </h1> + + <section class="description"> + +<p><a href=â<a +href="http://rspec.info";>RSpec</a">rspec.infoâ>RSpec</a</a>> is the +defacto BDD framework for ruby. To test your project with <a +href="RSpec.html">RSpec</a> use:</p> + +<pre class="ruby"><span class="ruby-identifier">test</span>.<span class="ruby-identifier">using</span> :<span class="ruby-identifier">rspec</span> +</pre> + +<p>Support the following options:</p> +<ul><li> +<p>:gems â A hash of gems to install before running the tests.</p> + +<pre>The keys of this hash are the gem name, the value must be the required version.</pre> +</li><li> +<p>:requires â A list of ruby files to require before running the specs</p> + +<pre>Mainly used if an rspec format needs to require some file.</pre> +</li><li> +<p>:format â A list of valid Rspec âformat option values. (defaults to +'progress')</p> +</li><li> +<p>:output â <a href="../File.html">File</a> path to output dump. @false@ +to suppress output</p> +</li><li> +<p>:fork â Create a new JavaVM to run the tests on</p> +</li><li> +<p>:properties â <a href="../Hash.html">Hash</a> of properties passed to the +test suite.</p> +</li><li> +<p>:java_args â Arguments passed to the JVM.</p> +</li></ul> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="OPTIONS">OPTIONS + + <dd> + + + <dt id="TESTS_PATTERN">TESTS_PATTERN + + <dd> + + + </dl> + </section> + + + + + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-runner_config" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">runner_config</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 + <a href="TestFramework/JRubyBased.html#method-i-runner_config">Buildr::TestFramework::JRubyBased#runner_config</a> + </div> + + + + <div class="method-source-code" id="runner_config-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/bdd.rb, line 241</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">runner_config</span> + <span class="ruby-identifier">runner</span> = <span class="ruby-keyword">super</span> + <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">gems</span>.<span class="ruby-identifier">update</span> <span class="ruby-string">'rspec'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'~> 2.9.0'</span> + <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">requires</span>.<span class="ruby-identifier">unshift</span> <span class="ruby-string">'rspec'</span> + <span class="ruby-identifier">runner</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-runner_content" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">runner_content</span><span + class="method-args">(binding)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="runner_content-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/bdd.rb, line 248</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">runner_content</span>(<span class="ruby-identifier">binding</span>) + <span class="ruby-identifier">runner_erb</span> = <span class="ruby-string">%q{ + <%= jruby_gem %> + <%= dependencies.inspect %>.each { |dep| $CLASSPATH << dep } + <%= runner.gems.inspect %>.each { |ary| JRuby.gem(*ary.flatten) } + <%= runner.requires.inspect %>.each { |rb| Kernel.require rb } + <% if runner.output == false %> + output = StringIO.new + <% elsif runner.output.kind_of?(String) %> + output = File.open(<%= result.output.inspect %>, 'w') + <% else %> + output = STDOUT + <% end %> + parser = ::RSpec::Core::Parser.new + argv = <%= runner.rspec.inspect %> || [] + argv.push *<%= tests.inspect %> + + Buildr::TestFramework::TestResult::Error.guard('<%= runner.result %>') do + ::RSpec::Core::CommandLine.new(argv).run(output, output) + end + exit 0 # let buildr figure the result from the yaml file + }</span> + <span class="ruby-constant">Filter</span><span class="ruby-operator">::</span><span class="ruby-constant">Mapper</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:erb</span>, <span class="ruby-identifier">binding</span>).<span class="ruby-identifier">transform</span>(<span class="ruby-identifier">runner_erb</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> +
