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 2017/04/02 23:37:44 UTC
svn commit: r19013 [29/44] - in /dev/buildr/1.5.2: ./ 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.2/site/rdoc/Buildr/Repositories.html
==============================================================================
--- dev/buildr/1.5.2/site/rdoc/Buildr/Repositories.html (added)
+++ dev/buildr/1.5.2/site/rdoc/Buildr/Repositories.html Sun Apr 2 23:37:43 2017
@@ -0,0 +1,834 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::Repositories - 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>
+
+ <div id="includes-section" class="nav-section">
+ <h3>Included Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><span class="include">Singleton</span>
+
+
+ </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-local">#local</a>
+
+ <li ><a href="#method-i-local-3D">#local=</a>
+
+ <li ><a href="#method-i-locate">#locate</a>
+
+ <li ><a href="#method-i-mirrors">#mirrors</a>
+
+ <li ><a href="#method-i-mirrors-3D">#mirrors=</a>
+
+ <li ><a href="#method-i-release_to">#release_to</a>
+
+ <li ><a href="#method-i-release_to-3D">#release_to=</a>
+
+ <li ><a href="#method-i-remote">#remote</a>
+
+ <li ><a href="#method-i-remote-3D">#remote=</a>
+
+ <li ><a href="#method-i-remote_uri">#remote_uri</a>
+
+ <li ><a href="#method-i-snapshot_to">#snapshot_to</a>
+
+ <li ><a href="#method-i-snapshot_to-3D">#snapshot_to=</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::Repositories">
+ <h1 id="class-Buildr::Repositories" class="class">
+ class Buildr::Repositories
+ </h1>
+
+ <section class="description">
+
+<p>Holds the path to the local repository, URLs for remote repositories, and
+settings for release server.</p>
+
+<p>You can access this object from the repositories method. For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">puts</span> <span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">local</span>
+<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">remote</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'http://example.com/repo'</span>
+<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">release_to</span> = <span class="ruby-string">'sftp://example.com/var/www/public/repo'</span>
+</pre>
+
+ </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-local" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ local → path
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns the path to the local repository.</p>
+
+<p>The default path is .m2/repository relative to the home directory. You can
+set this using the M2_REPO environment variable or the repositories/local
+value in your settings.yaml file.</p>
+
+
+
+
+ <div class="method-source-code" id="local-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 641</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">local</span>
+ <span class="ruby-ivar">@local</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'M2_REPO'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'local_repo'</span>] <span class="ruby-operator">||</span>
+ (<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>[<span class="ruby-string">'repositories'</span>][<span class="ruby-string">'local'</span>]) <span class="ruby-operator">||</span>
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'HOME'</span>], <span class="ruby-string">'.m2/repository'</span>))
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-local-3D" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ local = path
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Sets the path to the local repository.</p>
+
+<p>The best place to set the local repository path is from a buildr.rb file
+located in the .buildr directory under your home directory. That way all
+your projects will share the same path, without affecting other developers
+collaborating on these projects.</p>
+
+
+
+
+ <div class="method-source-code" id="local-3D-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 656</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">local=</span>(<span class="ruby-identifier">dir</span>)
+ <span class="ruby-ivar">@local</span> = <span class="ruby-identifier">dir</span> <span class="ruby-operator">?</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-locate" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ locate(spec) → path
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Locates an artifact in the local repository based on its specification, and
+returns a file path.</p>
+
+<p>For example:</p>
+
+<pre>locate :group=>'log4j', :id=>'log4j', :version=>'1.1'
+ => ~/.m2/repository/log4j/log4j/1.1/log4j-1.1.jar</pre>
+
+
+
+
+ <div class="method-source-code" id="locate-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 669</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">locate</span>(<span class="ruby-identifier">spec</span>)
+ <span class="ruby-identifier">spec</span> = <span class="ruby-constant">Artifact</span>.<span class="ruby-identifier">to_hash</span>(<span class="ruby-identifier">spec</span>)
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">local</span>, <span class="ruby-identifier">spec</span>[<span class="ruby-value">:group</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">'.'</span>), <span class="ruby-identifier">spec</span>[<span class="ruby-value">:id</span>], <span class="ruby-identifier">spec</span>[<span class="ruby-value">:version</span>], <span class="ruby-constant">Artifact</span>.<span class="ruby-identifier">hash_to_file_name</span>(<span class="ruby-identifier">spec</span>))
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-mirrors" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ mirrors → Array
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns an array of all the mirror repository URLs.</p>
+
+<p>Mirrors override remote repositories defined in the project. The best way
+is to add repositories to the user settings file under
+'$HOME/.buildr/settings.yaml'. For example:</p>
+
+<pre>repositories:
+ mirrors:
+ - http://example.com/repository</pre>
+
+
+
+
+ <div class="method-source-code" id="mirrors-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 685</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">mirrors</span>
+ <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@mirrors</span>
+ <span class="ruby-ivar">@mirrors</span> = [<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>, <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>].<span class="ruby-identifier">inject</span>([]) { <span class="ruby-operator">|</span><span class="ruby-identifier">repos</span>, <span class="ruby-identifier">hash</span><span class="ruby-operator">|</span>
+ <span class="ruby-identifier">repos</span> <span class="ruby-operator">|</span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">hash</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">hash</span>[<span class="ruby-string">'repositories'</span>][<span class="ruby-string">'mirrors'</span>])
+ }
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-ivar">@mirrors</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-mirrors-3D" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote = Array
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote = url
+ </span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote = nil
+ </span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>With a String argument, clears the array and set it to that single URL.</p>
+
+<p>With an Array argument, clears the array and set it to these specific URLs.</p>
+
+<p>With nil, clears the array.</p>
+
+
+
+
+ <div class="method-source-code" id="mirrors-3D-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 704</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">mirrors=</span>(<span class="ruby-identifier">urls</span>)
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">urls</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@mirrors</span> = <span class="ruby-keyword">nil</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@mirrors</span> = <span class="ruby-identifier">urls</span>.<span class="ruby-identifier">dup</span>
+ <span class="ruby-keyword">else</span> <span class="ruby-ivar">@mirrors</span> = [<span class="ruby-identifier">urls</span>.<span class="ruby-identifier">to_s</span>]
+ <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-release_to" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ release_to → hash
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns the current release server setting as a <a
+href="../Hash.html">Hash</a>. This is a more convenient way to configure
+the settings, as it allows you to specify the settings progressively.</p>
+
+<p>For example, the Buildfile will contain the repository URL used by all
+developers:</p>
+
+<pre class="ruby"><span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">release_to</span>[:<span class="ruby-identifier">url</span>] <span class="ruby-operator">||=</span> <span class="ruby-string">'sftp://example.com/var/www/repo'</span>
+</pre>
+
+<p>Your private buildr.rb will contain your credentials:</p>
+
+<pre class="ruby"><span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">release_to</span>[:<span class="ruby-identifier">username</span>] = <span class="ruby-string">'john'</span>
+<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">release_to</span>[:<span class="ruby-identifier">password</span>] = <span class="ruby-string">'secret'</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="release_to-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 846</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">release_to</span>
+ <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@release_to</span>
+ <span class="ruby-identifier">value</span> = (<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>[<span class="ruby-string">'repositories'</span>][<span class="ruby-string">'release_to'</span>]) <span class="ruby-operator">||</span> (<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>[<span class="ruby-string">'repositories'</span>]
[<span class="ruby-string">'release_to'</span>])
+ <span class="ruby-ivar">@release_to</span> = <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">inject</span>({}) { <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, (<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)<span class="ruby-operator">|</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>=<span class="ruby-operator">></span><span class="ruby-identifier">value</span>) } <span class="ruby-operator">:</span> { <span class="ruby-value">:url=</span><span class="ruby-operator">></span><span class="ruby-constant">Array</span>(<span class="ruby-identifier">value</span>).<span class="ruby-identifier">first</s
pan> }
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-ivar">@release_to</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-release_to-3D" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ release_to = url
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ release_to = hash
+ </span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Specifies the release server. Accepts a <a href="../Hash.html">Hash</a>
+with different repository settings (e.g. url, username, password), or a
+String to only set the repository URL.</p>
+
+<p>Besides the URL, all other settings depend on the transport protocol in
+use.</p>
+
+<p>For example:</p>
+
+<pre>repositories.release_to = 'sftp://john:secret@example.com/var/www/repo/'
+
+repositories.release_to = { :url=>'sftp://example.com/var/www/repo/',
+ :username='john', :password=>'secret' }</pre>
+
+<p>Or in the settings.yaml file:</p>
+
+<pre>repositories:
+ release_to: sftp://john:secret@example.com/var/www/repo/
+
+repositories:
+ release_to:
+ url: sftp://example.com/var/www/repo/
+ username: john
+ password: secret</pre>
+
+
+
+
+ <div class="method-source-code" id="release_to-3D-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 830</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">release_to=</span>(<span class="ruby-identifier">options</span>)
+ <span class="ruby-identifier">options</span> = { <span class="ruby-value">:url=</span><span class="ruby-operator">></span><span class="ruby-identifier">options</span> } <span class="ruby-keyword">unless</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">options</span>
+ <span class="ruby-ivar">@release_to</span> = <span class="ruby-identifier">options</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-remote" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote → Array
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns an array of all the remote repository URLs.</p>
+
+<p>When downloading artifacts, repositories are accessed in the order in which
+they appear here. The best way is to add repositories individually, for
+example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">remote</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'http://example.com/repo'</span>
+</pre>
+
+<p>You can also specify remote repositories in the settings.yaml (per user)
+and build.yaml (per build) files. Both sets of URLs are loaded by default
+into this array, URLs from the personal setting showing first.</p>
+
+<p>For example:</p>
+
+<pre>repositories:
+ remote:
+ - http://example.com/repo
+ - http://elsewhere.com/repo</pre>
+
+
+
+
+ <div class="method-source-code" id="remote-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 730</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote</span>
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">mirrors</span>.<span class="ruby-identifier">empty?</span>
+ <span class="ruby-identifier">info</span> <span class="ruby-node">"Remote repositories overridden by mirrors #{mirrors.map(&:to_s).join(", ")}"</span>
+ <span class="ruby-identifier">mirrors</span>
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@remote</span>
+ <span class="ruby-ivar">@remote</span> = [<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>, <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>].<span class="ruby-identifier">inject</span>([]) { <span class="ruby-operator">|</span><span class="ruby-identifier">repos</span>, <span class="ruby-identifier">hash</span><span class="ruby-operator">|</span>
+ <span class="ruby-identifier">repos</span> <span class="ruby-operator">|</span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">hash</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">hash</span>[<span class="ruby-string">'repositories'</span>][<span class="ruby-string">'remote'</span>])
+ }
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-ivar">@remote</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-remote-3D" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote = Array
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote = url
+ </span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote = nil
+ </span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>With a String argument, clears the array and set it to that single URL.</p>
+
+<p>With an Array argument, clears the array and set it to these specific URLs.</p>
+
+<p>With nil, clears the array.</p>
+
+
+
+
+ <div class="method-source-code" id="remote-3D-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 799</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote=</span>(<span class="ruby-identifier">urls</span>)
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">urls</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@remote</span> = <span class="ruby-keyword">nil</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-keyword">then</span> <span class="ruby-ivar">@remote</span> = <span class="ruby-identifier">urls</span>.<span class="ruby-identifier">dup</span>
+ <span class="ruby-keyword">else</span> <span class="ruby-ivar">@remote</span> = [<span class="ruby-identifier">urls</span>.<span class="ruby-identifier">to_s</span>]
+ <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-remote_uri" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ remote_uri → Array
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns an array of all the remote repositories as instances of <a
+href="../URI.html">URI</a></p>
+
+<p>Supports</p>
+
+<pre>* String urls: "http://example.com/repo"
+* URI: URI.parse( "http://example.com/repo" )
+* Hash: { :url => "http://example.com/repo", :user => "user", :pass => "pass" }</pre>
+
+
+
+
+ <div class="method-source-code" id="remote_uri-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 753</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_uri</span>
+ <span class="ruby-identifier">remote</span>
+
+ <span class="ruby-identifier">uris</span> = []
+ <span class="ruby-ivar">@remote</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">repo</span><span class="ruby-operator">|</span>
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">repo</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span>
+ <span class="ruby-comment"># ignore nil</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">URI</span> <span class="ruby-keyword">then</span>
+ <span class="ruby-identifier">uris</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">repo</span>
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> <span class="ruby-keyword">then</span>
+ <span class="ruby-identifier">url</span> = (<span class="ruby-identifier">repo</span>[<span class="ruby-value">:url</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-string">'url'</span>] )
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">url</span>
+ <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">url</span>)
+ <span class="ruby-keyword">if</span> ( <span class="ruby-identifier">username</span> = (<span class="ruby-identifier">repo</span>[<span class="ruby-value">:username</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-string">'username'</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-value">:user</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-string">'user'</span>]) )
+ <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">username</span>
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-keyword">if</span> ( <span class="ruby-identifier">password</span> = (<span class="ruby-identifier">repo</span>[<span class="ruby-value">:password</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-string">'password'</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-value">:pass</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">repo</span>[<span class="ruby-string">'pass'</span>]) )
+ <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">password</span>
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-identifier">uris</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">uri</span>
+ <span class="ruby-keyword">else</span>
+ <span class="ruby-identifier">fail</span>( <span class="ruby-node">"Repository Hash format missing url: #{repo}"</span> )
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span>
+ <span class="ruby-identifier">uris</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">repo</span>)
+ <span class="ruby-keyword">else</span>
+ <span class="ruby-identifier">fail</span>( <span class="ruby-node">"Unsupported Repository format: #{repo}"</span> )
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-keyword">end</span>
+
+ <span class="ruby-identifier">uris</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-snapshot_to" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ snapshot_to → hash
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns the current snapshot release server setting as a <a
+href="../Hash.html">Hash</a>. This is a more convenient way to configure
+the settings, as it allows you to specify the settings progressively.</p>
+
+<p>For example, the Buildfile will contain the repository URL used by all
+developers:</p>
+
+<pre class="ruby"><span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">snapshot_to</span>[:<span class="ruby-identifier">url</span>] <span class="ruby-operator">||=</span> <span class="ruby-string">'sftp://example.com/var/www/repo'</span>
+</pre>
+
+<p>Your private buildr.rb will contain your credentials:</p>
+
+<pre class="ruby"><span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">snapshot_to</span>[:<span class="ruby-identifier">username</span>] = <span class="ruby-string">'john'</span>
+<span class="ruby-identifier">repositories</span>.<span class="ruby-identifier">snapshot_to</span>[:<span class="ruby-identifier">password</span>] = <span class="ruby-string">'secret'</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="snapshot_to-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 894</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">snapshot_to</span>
+ <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@snapshot_to</span>
+ <span class="ruby-identifier">value</span> = (<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">user</span>[<span class="ruby-string">'repositories'</span>][<span class="ruby-string">'snapshot_to'</span>]) <span class="ruby-operator">||</span> (<span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>[<span class="ruby-string">'repositories'</span>] <span class="ruby-operator">&&</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>[<span class="ruby-string">'repositories'</span>
][<span class="ruby-string">'snapshot_to'</span>])
+ <span class="ruby-ivar">@snapshot_to</span> = <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">inject</span>({}) { <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, (<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)<span class="ruby-operator">|</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>=<span class="ruby-operator">></span><span class="ruby-identifier">value</span>) } <span class="ruby-operator">:</span> { <span class="ruby-value">:url=</span><span class="ruby-operator">></span><span class="ruby-constant">Array</span>(<span class="ruby-identifier">value</span>).<span class="ruby-identifier">first</
span> }
+ <span class="ruby-keyword">end</span>
+ <span class="ruby-ivar">@snapshot_to</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-snapshot_to-3D" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ snapshot_to = url
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ snapshot_to = hash
+ </span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Specifies the release server. Accepts a <a href="../Hash.html">Hash</a>
+with different repository settings (e.g. url, username, password), or a
+String to only set the repository URL.</p>
+
+<p>Besides the URL, all other settings depend on the transport protocol in
+use.</p>
+
+<p>For example:</p>
+
+<pre>repositories.snapshot_to = 'sftp://john:secret@example.com/var/www/repo/'
+
+repositories.snapshot_to = { :url=>'sftp://example.com/var/www/repo/',
+ :username='john', :password=>'secret' }</pre>
+
+<p>Or in the settings.yaml file:</p>
+
+<pre>repositories:
+ snapshot_to: sftp://john:secret@example.com/var/www/repo/
+
+repositories:
+ snapshot_to:
+ url: sftp://example.com/var/www/repo/
+ username: john
+ password: secret</pre>
+
+
+
+
+ <div class="method-source-code" id="snapshot_to-3D-source">
+ <pre><span class="ruby-comment"># File lib/buildr/packaging/artifact.rb, line 878</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">snapshot_to=</span>(<span class="ruby-identifier">options</span>)
+ <span class="ruby-identifier">options</span> = { <span class="ruby-value">:url=</span><span class="ruby-operator">></span><span class="ruby-identifier">options</span> } <span class="ruby-keyword">unless</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">options</span>
+ <span class="ruby-ivar">@snapshot_to</span> = <span class="ruby-identifier">options</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.2/site/rdoc/Buildr/ResourcesTask.html
==============================================================================
--- dev/buildr/1.5.2/site/rdoc/Buildr/ResourcesTask.html (added)
+++ dev/buildr/1.5.2/site/rdoc/Buildr/ResourcesTask.html Sun Apr 2 23:37:43 2017
@@ -0,0 +1,345 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::ResourcesTask - 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-exclude">#exclude</a>
+
+ <li ><a href="#method-i-from">#from</a>
+
+ <li ><a href="#method-i-include">#include</a>
+
+ <li ><a href="#method-i-sources">#sources</a>
+
+ <li ><a href="#method-i-target">#target</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::ResourcesTask">
+ <h1 id="class-Buildr::ResourcesTask" class="class">
+ class Buildr::ResourcesTask
+ </h1>
+
+ <section class="description">
+
+<p>The resources task is executed by the compile task to copy resource files
+over to the target directory. You can enhance this task in the normal way,
+but mostly you will use the task's filter.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">resources</span>.<span class="ruby-identifier">filter</span>.<span class="ruby-identifier">using</span> <span class="ruby-string">'Copyright'</span>=<span class="ruby-operator">></span><span class="ruby-string">'Acme Inc, 2007'</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-filter" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">filter</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Returns the filter used to copy resources over. See <a
+href="Filter.html">Buildr::Filter</a>.</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-exclude" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ exclude(*files) → self
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Excludes the specified files in the filter and returns self.</p>
+
+
+
+
+ <div class="method-source-code" id="exclude-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 441</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">exclude</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">files</span>)
+ <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">exclude</span> <span class="ruby-operator">*</span><span class="ruby-identifier">files</span>
+ <span class="ruby-keyword">self</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-from" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ from(*sources) → self
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Adds additional directories from which to copy resources.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">resources</span>.<span class="ruby-identifier">from</span> <span class="ruby-identifier">_</span>(<span class="ruby-string">'src/etc'</span>)
+</pre>
+
+
+
+
+ <div class="method-source-code" id="from-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 453</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">from</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sources</span>)
+ <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">from</span> <span class="ruby-operator">*</span><span class="ruby-identifier">sources</span>
+ <span class="ruby-keyword">self</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-include" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ include(*files) → self
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Includes the specified files in the filter and returns self.</p>
+
+
+
+
+ <div class="method-source-code" id="include-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 432</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">include</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">files</span>)
+ <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">include</span> <span class="ruby-operator">*</span><span class="ruby-identifier">files</span>
+ <span class="ruby-keyword">self</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-sources" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">sources</span><span
+ class="method-args">()</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Returns the list of source directories (each being a file task).</p>
+
+
+
+
+ <div class="method-source-code" id="sources-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 459</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">sources</span>
+ <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">sources</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-target" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ target → task
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Returns the filter's target directory as a file task.</p>
+
+
+
+
+ <div class="method-source-code" id="target-source">
+ <pre><span class="ruby-comment"># File lib/buildr/core/compile.rb, line 467</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">target</span>
+ <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">into</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">path_to</span>(<span class="ruby-value">:target</span>, <span class="ruby-ivar">@usage</span>, <span class="ruby-value">:resources</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">target</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">sources</span>.<span class="ruby-identifier">empty?</span>
+ <span class="ruby-identifier">filter</span>.<span class="ruby-identifier">target</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.2/site/rdoc/Buildr/Run.html
==============================================================================
--- dev/buildr/1.5.2/site/rdoc/Buildr/Run.html (added)
+++ dev/buildr/1.5.2/site/rdoc/Buildr/Run.html Sun Apr 2 23:37:43 2017
@@ -0,0 +1,312 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>module Buildr::Run - 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>
+
+
+ <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
+
+ <ul class="link-list" role="directory">
+
+ <li ><a href="#method-c-runners">::runners</a>
+
+ <li ><a href="#method-c-select">::select</a>
+
+ <li ><a href="#method-c-select_by_lang">::select_by_lang</a>
+
+ <li ><a href="#method-c-select_by_name">::select_by_name</a>
+
+ <li ><a href="#method-i-run">#run</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="module-Buildr::Run">
+ <h1 id="module-Buildr::Run" class="module">
+ module Buildr::Run
+ </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-runners" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">runners</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="runners-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 21</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">runners</span>
+ <span class="ruby-ivar">@runners</span> <span class="ruby-operator">||=</span> []
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-select" class="method-detail method-alias">
+
+ <div class="method-heading">
+ <span class="method-name">select</span><span
+ class="method-args">(lang)</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ </div>
+
+
+
+
+ <div class="aliases">
+ Alias for: <a href="Run.html#method-c-select_by_lang">select_by_lang</a>
+ </div>
+
+ </div>
+
+
+ <div id="method-c-select_by_lang" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">select_by_lang</span><span
+ class="method-args">(lang)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="select_by_lang-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 25</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">select_by_lang</span>(<span class="ruby-identifier">lang</span>)
+ <span class="ruby-identifier">fail</span> <span class="ruby-string">'Unable to define run task for nil language'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">lang</span>.<span class="ruby-identifier">nil?</span>
+ <span class="ruby-identifier">runners</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">languages</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">languages</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">lang</span>.<span class="ruby-identifier">to_sym</span>) }
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+ <div class="aliases">
+ Also aliased as: <a href="Run.html#method-c-select">select</a>
+ </div>
+
+
+
+ </div>
+
+
+ <div id="method-c-select_by_name" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">select_by_name</span><span
+ class="method-args">(name)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="select_by_name-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 32</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">select_by_name</span>(<span class="ruby-identifier">name</span>)
+ <span class="ruby-identifier">fail</span> <span class="ruby-string">'Unable to define run task for nil'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span>
+ <span class="ruby-identifier">runners</span>.<span class="ruby-identifier">detect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</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>
+
+
+ </section>
+
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
+
+
+ <div id="method-i-run" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ run(&block) → RunTask
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>This method returns the project's run task. It also accepts a block to
+be executed when the run task is invoked.</p>
+
+
+
+
+ <div class="method-source-code" id="run-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 184</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+ <span class="ruby-identifier">task</span>(<span class="ruby-string">'run'</span>).<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
+ <span class="ruby-identifier">t</span>.<span class="ruby-identifier">enhance</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>
+<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.2/site/rdoc/Buildr/Run/Base.html
==============================================================================
--- dev/buildr/1.5.2/site/rdoc/Buildr/Run/Base.html (added)
+++ dev/buildr/1.5.2/site/rdoc/Buildr/Run/Base.html Sun Apr 2 23:37:43 2017
@@ -0,0 +1,352 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::Run::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-new">::new</a>
+
+ <li ><a href="#method-c-specify">::specify</a>
+
+ <li ><a href="#method-c-to_sym">::to_sym</a>
+
+ <li ><a href="#method-i-build-3F">#build?</a>
+
+ <li ><a href="#method-i-launch">#launch</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::Run::Base">
+ <h1 id="class-Buildr::Run::Base" class="class">
+ class Buildr::Run::Base
+ </h1>
+
+ <section class="description">
+
+<p><a href="Base.html">Base</a> class for any run provider. Defines most
+common functionality (things like @lang@, @build?@ and friends).</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-c-languages" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">languages</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+
+
+ </div>
+ </div>
+
+ <div id="attribute-c-runner_name" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">runner_name</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+
+
+ </div>
+ </div>
+
+ <div id="attribute-i-project" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">project</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+
+
+ </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">(project)</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/run.rb, line 57</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project</span>)
+ <span class="ruby-ivar">@project</span> = <span class="ruby-identifier">project</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-c-specify" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">specify</span><span
+ class="method-args">(options)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+
+
+
+
+
+ <div class="method-source-code" id="specify-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 47</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">specify</span>(<span class="ruby-identifier">options</span>)
+ <span class="ruby-ivar">@runner_name</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:name</span>]
+ <span class="ruby-ivar">@languages</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:languages</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">
+
+
+
+
+
+
+ <div class="method-source-code" id="to_sym-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_sym</span>
+ <span class="ruby-ivar">@runner_name</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-build-3F" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">build?</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="build-3F-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 61</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">build?</span>
+ <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-launch" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">launch</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="launch-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 65</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">launch</span>
+ <span class="ruby-identifier">fail</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>
+
Added: dev/buildr/1.5.2/site/rdoc/Buildr/Run/JavaRunner.html
==============================================================================
--- dev/buildr/1.5.2/site/rdoc/Buildr/Run/JavaRunner.html (added)
+++ dev/buildr/1.5.2/site/rdoc/Buildr/Run/JavaRunner.html Sun Apr 2 23:37:43 2017
@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::Run::JavaRunner - 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">Base
+
+</div>
+
+ <div id="includes-section" class="nav-section">
+ <h3>Included Modules</h3>
+
+ <ul class="link-list">
+
+
+ <li><a class="include" href="../JRebel.html">Buildr::JRebel</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-run">#run</a>
+
+ </ul>
+</div>
+
+ </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Buildr::Run::JavaRunner">
+ <h1 id="class-Buildr::Run::JavaRunner" class="class">
+ class Buildr::Run::JavaRunner
+ </h1>
+
+ <section class="description">
+
+ </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-run" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">run</span><span
+ class="method-args">(task)</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/core/run.rb, line 24</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">task</span>)
+ <span class="ruby-identifier">fail</span> <span class="ruby-string">"Missing :main option"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:main</span>]
+ <span class="ruby-identifier">cp</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">dependencies</span> <span class="ruby-operator">+</span> [<span class="ruby-identifier">project</span>.<span class="ruby-identifier">path_to</span>(<span class="ruby-value">:target</span>, <span class="ruby-value">:classes</span>), <span class="ruby-identifier">project</span>.<span class="ruby-identifier">path_to</span>(<span class="ruby-value">:target</span>, <span class="ruby-value">:resources</span>)] <span class="ruby-operator">+</span> <span class="ruby-identifier">task</span>.<span class="ruby-identifier">classpath</span>
+ <span class="ruby-constant">Java</span><span class="ruby-operator">::</span><span class="ruby-constant">Commands</span>.<span class="ruby-identifier">java</span>(<span class="ruby-identifier">task</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:main</span>], {
+ <span class="ruby-value">:properties</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">jrebel_props</span>(<span class="ruby-identifier">project</span>).<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">task</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:properties</span>] <span class="ruby-operator">||</span> {}),
+ <span class="ruby-value">:classpath</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">cp</span>,
+ <span class="ruby-value">:java_args</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">jrebel_args</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">task</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:java_args</span>] <span class="ruby-operator">||</span> [])
+ })
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ </section>
+
+ </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+
Added: dev/buildr/1.5.2/site/rdoc/Buildr/Run/RunTask.html
==============================================================================
--- dev/buildr/1.5.2/site/rdoc/Buildr/Run/RunTask.html (added)
+++ dev/buildr/1.5.2/site/rdoc/Buildr/Run/RunTask.html Sun Apr 2 23:37:43 2017
@@ -0,0 +1,404 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Buildr::Run::RunTask - 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-requires">#requires</a>
+
+ <li ><a href="#method-i-run">#run</a>
+
+ <li ><a href="#method-i-runner">#runner</a>
+
+ <li ><a href="#method-i-runner-3F">#runner?</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::Run::RunTask">
+ <h1 id="class-Buildr::Run::RunTask" class="class">
+ class Buildr::Run::RunTask
+ </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-files" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">files</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Returns file 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>
+
+ </section>
+
+
+
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Instance Methods</h3>
+ </header>
+
+
+ <div id="method-i-requires" class="method-detail ">
+
+
+ <div class="method-heading">
+ <span class="method-callseq">
+ requires(*files) → self
+ </span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+
+ <div class="method-description">
+
+ <p>Adds additional files and directories as dependencies to the task and
+returns self. When specifying a directory, includes all files in that
+directory.</p>
+
+
+
+
+ <div class="method-source-code" id="requires-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 121</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">requires</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">files</span>)
+ <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">include</span> <span class="ruby-operator">*</span><span class="ruby-identifier">files</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span>
+ <span class="ruby-keyword">self</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/run.rb, line 138</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>
+ <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">run</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">runner?</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-runner" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">runner</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="runner-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 126</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">runner</span>
+ <span class="ruby-ivar">@runner</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">guess_runner</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
+ <div id="method-i-runner-3F" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">runner?</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="runner-3F-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 130</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">runner?</span>
+ <span class="ruby-ivar">@runner</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
+ <span class="ruby-identifier">guess_runner</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">language</span>
+ <span class="ruby-keyword">rescue</span>
+ <span class="ruby-keyword">nil</span>
+ <span class="ruby-keyword">end</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">run</span>.<span class="ruby-identifier">using</span> :<span class="ruby-identifier">main=</span><span class="ruby-operator">></span><span class="ruby-string">'org.example.Main'</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="using-source">
+ <pre><span class="ruby-comment"># File lib/buildr/run.rb, line 105</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-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">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-keyword">until</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
+ <span class="ruby-identifier">new_runner</span> = <span class="ruby-constant">Run</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">@runner</span> = <span class="ruby-identifier">new_runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_runner</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/run.rb, line 93</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>
+