You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildr.apache.org by do...@apache.org on 2019/07/14 11:16:57 UTC
svn commit: r34874 [33/45] - in /dev/buildr/1.5.8: ./ dist/ site/ site/css/
site/images/ site/rdoc/ site/rdoc/Buildr/ site/rdoc/Buildr/ArchiveTask/
site/rdoc/Buildr/ArtifactNamespace/ site/rdoc/Buildr/Assets/
site/rdoc/Buildr/CPom/ site/rdoc/Buildr/Che...
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Shell/ShellTask.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Shell/ShellTask.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Shell/ShellTask.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,363 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::Shell::ShellTask - 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>
+
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-i-java_args">#java_args</a>
+
+ <li ><a href="#method-i-properties">#properties</a>
+
+ <li ><a href="#method-i-run">#run</a>
+
+ <li ><a href="#method-i-using">#using</a>
+
+ <li ><a href="#method-i-with">#with</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::Shell::ShellTask">
+ <h1 id="class-Buildr::Shell::ShellTask" class="class">
+ class Buildr::Shell::ShellTask
+ </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-classpath" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">classpath</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Classpath dependencies.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-options" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">options</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Returns the run options.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-provider" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">provider</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Underlying shell provider</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-java_args" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">java_args</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="java_args-source">
+ <pre><span class="ruby-comment"># File lib/buildr/shell.rb, line 154</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">java_args</span>
+ <span class="ruby-ivar">@options</span>[<span class="ruby-value">:java_args</span>] <span class="ruby-operator">||</span> (<span class="ruby-constant">ENV</span>[<span class="ruby-string">'JAVA_OPTS'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'JAVA_OPTIONS'</span>]).<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</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-name">properties</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="properties-source">
+ <pre><span class="ruby-comment"># File lib/buildr/shell.rb, line 158</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">properties</span>
+ <span class="ruby-ivar">@options</span>[<span class="ruby-value">:properties</span>] <span class="ruby-operator">||</span> {}
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-run" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">run</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="run-source">
+ <pre><span class="ruby-comment"># File lib/buildr/shell.rb, line 145</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>
+ <span class="ruby-identifier">fail</span> <span class="ruby-node">"No shell provider defined in project '#{project.name}' for language '#{project.compile.language.inspect}'"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">provider</span>
+ <span class="ruby-identifier">provider</span>.<span class="ruby-identifier">launch</span>(<span class="ruby-keyword">self</span>)
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-using" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ using(options) → self
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Sets the run options from a hash and returns self.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">shell</span>.<span class="ruby-identifier">using</span> :<span class="ruby-identifier">properties</span> =<span class="ruby-operator">></span> {<span class="ruby-string">'foo'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'bar'</span>}
+<span class="ruby-identifier">shell</span>.<span class="ruby-identifier">using</span> :<span class="ruby-identifier">bsh</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="using-source">
+ <pre><span class="ruby-comment"># File lib/buildr/shell.rb, line 132</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">using</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">args</span>.<span class="ruby-identifier">pop</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">value</span> }
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-keyword">until</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
+ <span class="ruby-identifier">new_shell</span> = <span class="ruby-constant">Shell</span>.<span class="ruby-identifier">select_by_name</span>(<span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span>)
+ <span class="ruby-ivar">@provider</span> = <span class="ruby-identifier">new_shell</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_shell</span>.<span class="ruby-identifier">nil?</span>
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-keyword">self</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-with" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ with(*artifacts) → self
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Adds files and artifacts as classpath dependencies, and returns self.</p>
+
+
+
+
+ <div class="method-source-code" id="with-source">
+ <pre><span class="ruby-comment"># File lib/buildr/shell.rb, line 119</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">with</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">specs</span>)
+ <span class="ruby-ivar">@classpath</span> <span class="ruby-operator">|=</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">specs</span>.<span class="ruby-identifier">flatten</span>).<span class="ruby-identifier">uniq</span>
+ <span class="ruby-keyword">self</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/SvnRelease.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/SvnRelease.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/SvnRelease.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,283 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::SvnRelease - 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::Release
+
+</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-applies_to-3F">::applies_to?</a>
+
+ <li class="calls-super" ><a href="#method-i-check">#check</a>
+
+ <li ><a href="#method-i-tag_release">#tag_release</a>
+
+ <li class="calls-super" ><a href="#method-i-update_version_to_next">#update_version_to_next</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::SvnRelease">
+ <h1 id="class-Buildr::SvnRelease" class="class">
+ class Buildr::SvnRelease
+ </h1>
+
+ <section class="description">
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+
+
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Class Methods</h3>
+ </header>
+
+
+ <div id="method-c-applies_to-3F" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">applies_to?</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="applies_to-3F-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/build.rb, line 557</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">applies_to?</span>
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">'.svn'</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-check" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">check</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="check-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/build.rb, line 562</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">check</span>
+ <span class="ruby-keyword">super</span>
+ <span class="ruby-identifier">fail</span> <span class="ruby-string">"Uncommitted files violate the First Principle Of Release!\n"</span><span class="ruby-operator">+</span><span class="ruby-constant">Svn</span>.<span class="ruby-identifier">uncommitted_files</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">Svn</span>.<span class="ruby-identifier">uncommitted_files</span>.<span class="ruby-identifier">empty?</span>
+ <span class="ruby-identifier">fail</span> <span class="ruby-string">"SVN URL must contain 'trunk' or 'branches/...'"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Svn</span>.<span class="ruby-identifier">repo_url</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/(trunk)|(branches.*)$/</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-tag_release" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">tag_release</span><span
+ class="method-args">(tag)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="tag_release-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/build.rb, line 568</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">tag_release</span>(<span class="ruby-identifier">tag</span>)
+ <span class="ruby-comment"># Unlike Git, committing the buildfile with the released version is not necessary.</span>
+ <span class="ruby-comment"># svn tag does commit & tag.</span>
+ <span class="ruby-identifier">info</span> <span class="ruby-node">"Tagging release #{tag}"</span>
+ <span class="ruby-constant">Svn</span>.<span class="ruby-identifier">tag</span> <span class="ruby-identifier">tag</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-update_version_to_next" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">update_version_to_next</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="update_version_to_next-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/build.rb, line 575</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_version_to_next</span>
+ <span class="ruby-keyword">super</span>
+ <span class="ruby-identifier">info</span> <span class="ruby-node">"Current version is now #{extract_version}"</span>
+ <span class="ruby-constant">Svn</span>.<span class="ruby-identifier">commit</span> <span class="ruby-identifier">version_file</span>, <span class="ruby-identifier">message</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/TarTask.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/TarTask.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/TarTask.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,255 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::TarTask - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+ <div id="parent-class-section" class="nav-section">
+ <h3>Parent</h3>
+
+
+ <p class="link"><a href="ArchiveTask.html">Buildr::ArchiveTask</a>
+
+</div>
+
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-i-entry">#entry</a>
+
+ <li ><a href="#method-i-with_uncompressed_tar">#with_uncompressed_tar</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::TarTask">
+ <h1 id="class-Buildr::TarTask" class="class">
+ class Buildr::TarTask
+ </h1>
+
+ <section class="description">
+
+<p>The <a href="TarTask.html">TarTask</a> creates a new Tar file. You can
+include any number of files and and directories, use exclusion patterns,
+and include files into specific directories.</p>
+
+<p>To create a GZipped Tar, either set the gzip option to true, or use the
+.tgz or .gz suffix.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">tar</span>(<span class="ruby-string">"test.tgz"</span>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span>
+ <span class="ruby-identifier">task</span>.<span class="ruby-identifier">include</span> <span class="ruby-string">"srcs"</span>
+ <span class="ruby-identifier">task</span>.<span class="ruby-identifier">include</span> <span class="ruby-string">"README"</span>, <span class="ruby-string">"LICENSE"</span>
+<span class="ruby-keyword">end</span>
+</pre>
+
+<p>See Buildr#tar and <a href="ArchiveTask.html">ArchiveTask</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-gzip" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">gzip</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>To create a GZipped Tar, either set this option to true, or use the
+.tgz/.gz suffix.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-mode" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">mode</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Permission mode for files contained in the Tar. Defaults to 0755.</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-entry" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ entry(name) → Entry
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns a Tar file entry. You can use this to check if the entry exists and
+its contents, for example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">package</span>(:<span class="ruby-identifier">tar</span>).<span class="ruby-identifier">entry</span>(<span class="ruby-string">"src/LICENSE"</span>).<span class="ruby-identifier">should</span> <span class="ruby-identifier">contain</span>(<span class="ruby-regexp">/Apache Software License/</span>)
+</pre>
+
+
+
+
+ <div class="method-source-code" id="entry-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/tar.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">entry</span>(<span class="ruby-identifier">entry_name</span>)
+ <span class="ruby-constant">Buildr</span><span class="ruby-operator">::</span><span class="ruby-constant">TarEntry</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">entry_name</span>)
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-with_uncompressed_tar" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ with_uncompressed_tar { |tar_entries| ... }
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Yields an Archive::Tar::Minitar::Input object to the provided block.
+Opening, closing and Gzip-decompressing is automatically taken care of.</p>
+
+
+
+
+ <div class="method-source-code" id="with_uncompressed_tar-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/tar.rb, line 67</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">with_uncompressed_tar</span> <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">gzip</span>
+ <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">GzipReader</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">name</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">tar</span><span class="ruby-operator">|</span> <span class="ruby-constant">Archive</span><span class="ruby-operator">::</span><span class="ruby-constant">Tar</span><span class="ruby-operator">::</span><span class="ruby-constant">Minitar</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">tar</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) }
+ <span class="ruby-keyword">else</span>
+ <span class="ruby-constant">Archive</span><span class="ruby-operator">::</span><span class="ruby-constant">Tar</span><span class="ruby-operator">::</span><span class="ruby-constant">Minitar</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">name</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>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Test.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Test.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Test.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,260 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::Test - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+ <div id="includes-section" class="nav-section">
+ <h3>Included Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="include" href="Extension.html">Buildr::Extension</a>
+
+
+ </ul>
+</div>
+
+ <div id="extends-section" class="nav-section">
+ <h3>Extended With Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="extend" href="Test/SkipIfNoTest.html">Buildr::Test::SkipIfNoTest</a>
+
+
+ </ul>
+</div>
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-i-integration">#integration</a>
+
+ <li ><a href="#method-i-test">#test</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::Test">
+ <h1 id="module-Buildr::Test" class="module">
+ module Buildr::Test
+ </h1>
+
+ <section class="description">
+
+<p>Methods added to <a href="Project.html">Project</a> to support compilation
+and running of tests.</p>
+
+ </section>
+
+
+
+
+ <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+
+
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
+
+
+ <div id="method-i-integration" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ integration { |task| .... }
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ integration → IntegrationTestTask
+ </span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Use this method to return the integration tests task, or enhance it with a
+block to execute.</p>
+
+<p>There is one integration tests task you can execute directly, or as a
+result of running the package task (or tasks that depend on it, like
+install and upload). It contains all the tests marked with
+:integration=>true, all other tests are considered unit tests and run by
+the test task before packaging. So essentially:
+build=>test=>packaging=>integration=>install/upload.</p>
+
+<p>You add new tests from projects that define integration tests using the
+regular test task, but with the following addition:</p>
+
+<pre class="ruby"><span class="ruby-identifier">test</span>.<span class="ruby-identifier">using</span> :<span class="ruby-identifier">integration</span>
+</pre>
+
+<p>Use this method to enhance the setup and teardown tasks that are executed
+before (and after) all integration tests are run, for example, to start a
+Web server or create a database.</p>
+
+
+
+
+ <div class="method-source-code" id="integration-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 764</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">integration</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">deps</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+ <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>[<span class="ruby-string">'rake:integration'</span>].<span class="ruby-identifier">enhance</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-test" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ test(*prereqs) → TestTask
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ test(*prereqs) { |task| .. } → TestTask
+ </span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns the test task. The test task controls the entire test lifecycle.</p>
+
+<p>You can use the test task in three ways. You can access and configure
+specific test tasks, e.g. enhance the compile task by calling test.compile,
+setup for the tests by enhancing test.setup and so forth.</p>
+
+<p>You can use convenient methods that handle the most common settings. For
+example, add dependencies using test.with, or include only specific tests
+using test.include.</p>
+
+<p>You can also enhance this task directly. This method accepts a list of
+arguments that are used as prerequisites and an optional block that will be
+executed by the test task.</p>
+
+<p>This task compiles the project and the tests (in that order) before running
+any tests. It execute the setup task, runs all the tests, any enhancements,
+and ends with the teardown tasks.</p>
+
+
+
+
+ <div class="method-source-code" id="test-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 743</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">test</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">prereqs</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+ <span class="ruby-identifier">task</span>(<span class="ruby-string">'test'</span>).<span class="ruby-identifier">enhance</span> <span class="ruby-identifier">prereqs</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Test/SkipIfNoTest.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/Test/SkipIfNoTest.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/Test/SkipIfNoTest.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::Test::SkipIfNoTest - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../../";
+</script>
+
+<script src="../../js/jquery.js"></script>
+<script src="../../js/darkfish.js"></script>
+
+<link href="../../css/fonts.css" rel="stylesheet">
+<link href="../../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+ <h2>
+ <a href="../../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../../table_of_contents.html#pages">Pages</a>
+ <a href="../../table_of_contents.html#classes">Classes</a>
+ <a href="../../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-c-extended">::extended</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::Test::SkipIfNoTest">
+ <h1 id="module-Buildr::Test::SkipIfNoTest" class="module">
+ module Buildr::Test::SkipIfNoTest
+ </h1>
+
+ <section class="description">
+
+<p>We define a module inline that will inject cancelling the task if tests are
+skipped.</p>
+
+ </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-extended" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">extended</span><span
+ class="method-args">(base)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="extended-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 677</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">extended</span>(<span class="ruby-identifier">base</span>)
+ <span class="ruby-identifier">base</span>.<span class="ruby-identifier">instance_eval</span> {<span class="ruby-keyword">alias</span> <span class="ruby-value">:execute_before_skip_if_no_test</span> <span class="ruby-operator">:</span><span class="ruby-identifier">execute</span>}
+ <span class="ruby-identifier">base</span>.<span class="ruby-identifier">instance_eval</span> {<span class="ruby-keyword">alias</span> <span class="ruby-value">:execute</span> <span class="ruby-operator">:</span><span class="ruby-identifier">execute_after_skip_if_no_test</span>}
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/TestFramework.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/TestFramework.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/TestFramework.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,339 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::TestFramework - buildr</title>
+
+<script type="text/javascript">
+ var rdoc_rel_prefix = "../";
+</script>
+
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+ <h2>
+ <a href="../index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="../table_of_contents.html#pages">Pages</a>
+ <a href="../table_of_contents.html#classes">Classes</a>
+ <a href="../table_of_contents.html#methods">Methods</a>
+ </div>
+</div>
+
+ <div id="search-section" role="search" class="project-section initially-hidden">
+ <form action="#" method="get" accept-charset="utf-8">
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
+ title="Type to search, Up and Down to navigate, Enter to load">
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
+ </form>
+</div>
+
+ </div>
+
+
+
+ <div id="class-metadata">
+
+
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-c-3C-3C">::<<</a>
+
+ <li ><a href="#method-c-add">::add</a>
+
+ <li ><a href="#method-c-frameworks">::frameworks</a>
+
+ <li ><a href="#method-c-has-3F">::has?</a>
+
+ <li ><a href="#method-c-select">::select</a>
+
+ <li ><a href="#method-c-select_from">::select_from</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::TestFramework">
+ <h1 id="module-Buildr::TestFramework" class="module">
+ module Buildr::TestFramework
+ </h1>
+
+ <section class="description">
+
+<p>The underlying test framework used by <a href="TestTask.html">TestTask</a>.
+To add a new test framework, extend <a
+href="TestFramework/Base.html">TestFramework::Base</a> and add your
+framework using:</p>
+
+<pre class="ruby"><span class="ruby-constant">Buildr</span><span class="ruby-operator">::</span><span class="ruby-constant">TestFramework</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">MyFramework</span>
+</pre>
+
+ </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-3C-3C" class="method-detail method-alias">
+
+ <div class="method-heading">
+ <span class="method-name"><<</span><span
+ class="method-args">(framework)</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ </div>
+
+
+
+
+ <div class="aliases">
+ Alias for: <a href="TestFramework.html#method-c-add">add</a>
+ </div>
+
+ </div>
+
+
+ <div id="method-c-add" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">add</span><span
+ class="method-args">(framework)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Adds a test framework to the list of supported frameworks.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-constant">Buildr</span><span class="ruby-operator">::</span><span class="ruby-constant">TestFramework</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Buildr</span><span class="ruby-operator">::</span><span class="ruby-constant">JUnit</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="add-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 49</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">framework</span>)
+ <span class="ruby-ivar">@frameworks</span> <span class="ruby-operator">||=</span> []
+ <span class="ruby-ivar">@frameworks</span> <span class="ruby-operator">|=</span> [<span class="ruby-identifier">framework</span>]
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+ <div class="aliases">
+ Also aliased as: <a href="TestFramework.html#method-c-3C-3C"><<</a>
+ </div>
+
+
+
+ </div>
+
+
+ <div id="method-c-frameworks" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">frameworks</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Returns a list of available test frameworks.</p>
+
+
+
+
+ <div class="method-source-code" id="frameworks-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 56</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">frameworks</span>
+ <span class="ruby-ivar">@frameworks</span> <span class="ruby-operator">||=</span> []
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-has-3F" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">has?</span><span
+ class="method-args">(name)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Returns true if the specified test framework exists.</p>
+
+
+
+
+ <div class="method-source-code" id="has-3F-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 26</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">has?</span>(<span class="ruby-identifier">name</span>)
+ <span class="ruby-identifier">frameworks</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">framework</span><span class="ruby-operator">|</span> <span class="ruby-identifier">framework</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span> }
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-select" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">select</span><span
+ class="method-args">(name)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Select a test framework by its name.</p>
+
+
+
+
+ <div class="method-source-code" id="select-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 31</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">select</span>(<span class="ruby-identifier">name</span>)
+ <span class="ruby-identifier">frameworks</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">framework</span><span class="ruby-operator">|</span> <span class="ruby-identifier">framework</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span> }
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-select_from" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">select_from</span><span
+ class="method-args">(project)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Identify which test framework applies for this project.</p>
+
+
+
+
+ <div class="method-source-code" id="select_from-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 36</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">select_from</span>(<span class="ruby-identifier">project</span>)
+ <span class="ruby-comment"># Look for a suitable test framework based on the compiled language,</span>
+ <span class="ruby-comment"># which may return multiple candidates, e.g. JUnit and TestNG for Java.</span>
+ <span class="ruby-comment"># Pick the one used in the parent project, if not, whichever comes first.</span>
+ <span class="ruby-identifier">candidates</span> = <span class="ruby-identifier">frameworks</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">framework</span><span class="ruby-operator">|</span> <span class="ruby-identifier">framework</span>.<span class="ruby-identifier">applies_to?</span>(<span class="ruby-identifier">project</span>) }
+ <span class="ruby-identifier">parent</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">parent</span>
+ <span class="ruby-identifier">parent</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">candidates</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">framework</span><span class="ruby-operator">|</span> <span class="ruby-identifier">framework</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">test</span>.<span class="ruby-identifier">framework</span> } <span class="ruby-operator">||</span> <span class="ruby-identifier">candidates</span>.<span class="ruby-identifier">first</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.8/site/rdoc/Buildr/TestFramework/Base.html
==============================================================================
--- dev/buildr/1.5.8/site/rdoc/Buildr/TestFramework/Base.html (added)
+++ dev/buildr/1.5.8/site/rdoc/Buildr/TestFramework/Base.html Sun Jul 14 11:16:56 2019
@@ -0,0 +1,429 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::TestFramework::Base - 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-applies_to-3F">::applies_to?</a>
+
+ <li ><a href="#method-c-dependencies">::dependencies</a>
+
+ <li ><a href="#method-c-new">::new</a>
+
+ <li ><a href="#method-c-to_sym">::to_sym</a>
+
+ <li ><a href="#method-i-dependencies">#dependencies</a>
+
+ <li ><a href="#method-i-run">#run</a>
+
+ <li ><a href="#method-i-tests">#tests</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::TestFramework::Base">
+ <h1 id="class-Buildr::TestFramework::Base" class="class">
+ class Buildr::TestFramework::Base
+ </h1>
+
+ <section class="description">
+
+<p><a href="Base.html">Base</a> class for all test frameworks, with common
+functionality. Extend and over-ride as you see fit (see <a
+href="../JUnit.html">JUnit</a> as an example).</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-options" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">options</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p><a href="../Options.html">Options</a> for this test framework.</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-i-task" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">task</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>The test task we belong to</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-applies_to-3F" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">applies_to?</span><span
+ class="method-args">(project)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Returns true if this framework applies to the current project. For
+example, <a href="../JUnit.html">JUnit</a> returns true if the tests are
+written in <a href="Java.html">Java</a>.</p>
+
+
+
+
+ <div class="method-source-code" id="applies_to-3F-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 75</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">applies_to?</span>(<span class="ruby-identifier">project</span>)
+ <span class="ruby-identifier">raise</span> <span class="ruby-string">'Not implemented'</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-dependencies" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">dependencies</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Returns a list of dependencies for this framework. Default is an empty
+list, override to add dependencies.</p>
+
+
+
+
+ <div class="method-source-code" id="dependencies-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 81</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">dependencies</span>
+ <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator">||=</span> []
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-new" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">new</span><span
+ class="method-args">(test_task, options)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Construct a new test framework with the specified options. Note that
+options may change before the framework is run.</p>
+
+
+
+
+ <div class="method-source-code" id="new-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 89</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">test_task</span>, <span class="ruby-identifier">options</span>)
+ <span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
+ <span class="ruby-ivar">@task</span> = <span class="ruby-identifier">test_task</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-to_sym" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">to_sym</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>The framework's identifier (e.g. :junit). Inferred from the class
+name.</p>
+
+
+
+
+ <div class="method-source-code" id="to_sym-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 69</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_sym</span>
+ <span class="ruby-ivar">@symbol</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">last</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">to_sym</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-name">dependencies</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Returns a list of dependenices for this framework. Defaults to calling the
+<a href="Base.html#method-i-dependencies">dependencies</a> method on the
+class.</p>
+
+
+
+
+ <div class="method-source-code" id="dependencies-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 101</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">dependencies</span>
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">dependencies</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-run" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">run</span><span
+ class="method-args">(tests, dependencies)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p><a href="../TestTask.html">TestTask</a> calls this method to run the named
+(and only those) tests. This method returns the list of tests that ran
+successfully.</p>
+
+
+
+
+ <div class="method-source-code" id="run-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 118</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">tests</span>, <span class="ruby-identifier">dependencies</span>)
+ <span class="ruby-identifier">raise</span> <span class="ruby-string">'Not implemented'</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <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">
+
+ <p><a href="../TestTask.html">TestTask</a> calls this method to return a list
+of test names that can be run in this project. It then applies the
+include/exclude patterns to arrive at the list of tests that will be run,
+and call the <a href="Base.html#method-i-run">run</a> method with that
+list.</p>
+
+<p>This method should return a list suitable for using with the <a
+href="Base.html#method-i-run">run</a> method, but also suitable for the
+user to manage. For example, <a href="../JUnit.html">JUnit</a> locates all
+the tests in the test.compile.target directory, and returns the class
+names, which are easier to work with than file names.</p>
+
+
+
+
+ <div class="method-source-code" id="tests-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/test.rb, line 112</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">tests</span>(<span class="ruby-identifier">dependencies</span>)
+ <span class="ruby-identifier">raise</span> <span class="ruby-string">'Not implemented'</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>
+