Added: dev/buildr/1.5.8/site/rdoc/Buildr/CustomPom.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/CustomPom.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/CustomPom.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,1411 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::CustomPom - 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-pom_xml">::pom_xml</a> + + <li ><a href="#method-i-add_apache_v2_license">#add_apache_v2_license</a> + + <li ><a href="#method-i-add_bsd_2_license">#add_bsd_2_license</a> + + <li ><a href="#method-i-add_bsd_3_license">#add_bsd_3_license</a> + + <li ><a href="#method-i-add_cddl_v1_license">#add_cddl_v1_license</a> + + <li ><a href="#method-i-add_developer">#add_developer</a> + + <li ><a href="#method-i-add_epl_v1_license">#add_epl_v1_license</a> + + <li ><a href="#method-i-add_github_project">#add_github_project</a> + + <li ><a href="#method-i-add_gpl_v1_license">#add_gpl_v1_license</a> + + <li ><a href="#method-i-add_gpl_v2_license">#add_gpl_v2_license</a> + + <li ><a href="#method-i-add_gpl_v3_license">#add_gpl_v3_license</a> + + <li ><a href="#method-i-add_lgpl_v2_license">#add_lgpl_v2_license</a> + + <li ><a href="#method-i-add_lgpl_v3_license">#add_lgpl_v3_license</a> + + <li ><a href="#method-i-add_mit_license">#add_mit_license</a> + + <li ><a href="#method-i-additional_dependencies">#additional_dependencies</a> + + <li ><a href="#method-i-additional_dependencies-3D">#additional_dependencies=</a> + + <li ><a href="#method-i-associate_project">#associate_project</a> + + <li ><a href="#method-i-description">#description</a> + + <li ><a href="#method-i-developers">#developers</a> + + <li ><a href="#method-i-include_transitive_dependencies">#include_transitive_dependencies</a> + + <li ><a href="#method-i-include_transitive_dependencies-3D">#include_transitive_dependencies=</a> + + <li ><a href="#method-i-licenses">#licenses</a> + + <li ><a href="#method-i-name">#name</a> + + <li ><a href="#method-i-optional_dependencies">#optional_dependencies</a> + + <li ><a href="#method-i-optional_dependencies-3D">#optional_dependencies=</a> + + <li ><a href="#method-i-provided_dependencies">#provided_dependencies</a> + + <li ><a href="#method-i-provided_dependencies-3D">#provided_dependencies=</a> + + <li ><a href="#method-i-runtime_dependencies">#runtime_dependencies</a> + + <li ><a href="#method-i-runtime_dependencies-3D">#runtime_dependencies=</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::CustomPom"> + <h1 id="class-Buildr::CustomPom" class="class"> + class Buildr::CustomPom + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="Developer">Developer + + <dd> + + + </dl> + </section> + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-dependency_filter" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">dependency_filter</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + <p>Property that accepts a proc that accepts a dependency and returns a +boolean to determine whether dependency is included in pom or not.</p> + + </div> + </div> + + <div id="attribute-i-description" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">description</span><span + class="attribute-access-type">[W]</span> + </div> + + <div class="method-description"> + + <p>Specify a project description</p> + + </div> + </div> + + <div id="attribute-i-issues_system" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">issues_system</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-issues_url" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">issues_url</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-name" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">name</span><span + class="attribute-access-type">[W]</span> + </div> + + <div class="method-description"> + + <p>Specify the name of the project</p> + + </div> + </div> + + <div id="attribute-i-scm_connection" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">scm_connection</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-scm_developer_connection" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">scm_developer_connection</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-scm_url" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">scm_url</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-url" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">url</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + <p>Property for the projects url</p> + + </div> + </div> + + </section> + + + + <section id="protected-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Protected Class Methods</h3> + </header> + + + <div id="method-c-pom_xml" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">pom_xml</span><span + class="method-args">(project, package)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="pom_xml-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 165</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">pom_xml</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">package</span>) + <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span> = <span class="ruby-constant">Builder</span><span class="ruby-operator">::</span><span class="ruby-constant">XmlMarkup</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:indent</span> =<span class="ruby-operator">></span> <span class="ruby-value">2</span>) + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">instruct!</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">project</span>(<span class="ruby-string">'xmlns'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'http://maven.apache.org/POM/4.0.0'</span>, + <span class="ruby-string">'xmlns:xsi'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'http://www.w3.org/2001/XMLSchema-instance'</span>, + <span class="ruby-string">'xsi:schemaLocation'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd'</span>) <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">modelVersion</span> <span class="ruby-string">'4.0.0'</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">groupId</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">group</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">artifactId</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">id</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">version</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">version</span> + <span class="ruby-identifier">candidates</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">packages</span>.<span class="ruby-identifier">select</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">classifier</span>.<span class="ruby-identifier">nil?</span> }.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span><span class="ruby-identifier">p</span>.<span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>} + <span class="ruby-identifier">packaging</span> = <span class="ruby-operator">!</span><span class="ruby-identifier">candidates</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">candidates</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">:</span> (<span class="ruby-identifier">project</span>.<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">packaging</span> <span class="ruby-operator">||</span> <span class="ruby-value">:zip</span>).<span class="ruby-identifier">to_s</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">packaging</span> <span class="ruby-identifier">packaging</span> + + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">name</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">name</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">name</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">description</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">description</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">description</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">url</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">url</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">url</span> + + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">licenses</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">licenses</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">license</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">name</span> <span class="ruby-identifier">name</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">url</span> <span class="ruby-identifier">url</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">distribution</span> <span class="ruby-string">'repo'</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">licenses</span>.<span class="ruby-identifier">empty?</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_url</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_connection</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_developer_connection</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">scm</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">connection</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_connection</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_connection</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">developerConnection</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_developer_connection</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_developer_connection</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">url</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_url</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">scm_url</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">issues_url</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">issueManagement</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">url</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">issues_url</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">system</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">issues_system</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">issues_system</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">developers</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">developers</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">developer</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">developer</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">id</span> <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">id</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">name</span> <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">name</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">name</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">email</span> <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">email</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">email</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">roles</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">roles</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">developer</span>.<span class="ruby-identifier">roles</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">role</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">role</span> <span class="ruby-identifier">role</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">developers</span>.<span class="ruby-identifier">empty?</span> + + <span class="ruby-identifier">provided_deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">provided_dependencies</span>) + <span class="ruby-identifier">runtime_deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">runtime_dependencies</span>) + <span class="ruby-identifier">additional_deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">additional_dependencies</span>) + <span class="ruby-identifier">include_transitive_deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">include_transitive_dependencies</span>).<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>} + <span class="ruby-identifier">optional_deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">optional_dependencies</span>).<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>} + + <span class="ruby-identifier">done</span> = [] + + <span class="ruby-identifier">deps</span> = [] + <span class="ruby-identifier">deps</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">provided_deps</span>. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">ActsAsArtifact</span>)}. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">done</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>)}. + <span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">done</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>; <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:scope</span> =<span class="ruby-operator">></span> <span class="ruby-string">'provided'</span>, <span class="ruby-value">:optional</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">optional_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:include_transitive</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">include_tr ansitive_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:artifact</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">dep</span>)} + <span class="ruby-identifier">deps</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">runtime_deps</span>. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">ActsAsArtifact</span>)}. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">done</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>)}. + <span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">done</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>; <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:scope</span> =<span class="ruby-operator">></span> <span class="ruby-string">'runtime'</span>, <span class="ruby-value">:optional</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">optional_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:include_transitive</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">include_tra nsitive_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:artifact</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">dep</span>)} + <span class="ruby-identifier">deps</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">additional_deps</span>. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">ActsAsArtifact</span>)}. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">done</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>)}. + <span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">done</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>; <span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:scope</span> =<span class="ruby-operator">></span> <span class="ruby-string">'compile'</span>, <span class="ruby-value">:optional</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">optional_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:include_transitive</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">include_tra nsitive_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">dep</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:artifact</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">dep</span>)} + + <span class="ruby-identifier">deps</span> <span class="ruby-operator">+=</span> + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">dependencies</span>). + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">ActsAsArtifact</span>)}. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">done</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>)}. + <span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">done</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>; <span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:scope</span> =<span class="ruby-operator">></span> <span class="ruby-string">'compile'</span>, <span class="ruby-value">:optional</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">optional_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:include_transitive</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">include_transitiv e_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:artifact</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">d</span>)} + + <span class="ruby-identifier">deps</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">test</span>.<span class="ruby-identifier">compile</span>.<span class="ruby-identifier">dependencies</span>). + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">ActsAsArtifact</span>)}. + <span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">done</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>)}. + <span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:scope</span> =<span class="ruby-operator">></span> <span class="ruby-string">'test'</span>, <span class="ruby-value">:include_transitive</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">include_transitive_deps</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:artifact</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">d</span>)} + + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">dependencies</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">deps</span>.<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">dependency_filter</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">pom</span>.<span class="ruby-identifier">dependency_filter</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">dependency</span>)}.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">dependency</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">groupId</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:group</span>] + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">artifactId</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:id</span>] + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">version</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:version</span>] + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">classifier</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:classifier</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:classifier</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:classifier</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-operator">!=</span> <span class="ruby-string">'jar'</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">scope</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:scope</span>] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:scope</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'compile'</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">optional</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:optional</span>] + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-value">:include_transitive</span>] + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">exclusions</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">exclusion</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">groupId</span> <span class="ruby-string">'*'</span> + <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">artifactId</span> <span class="ruby-string">'*'</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">deps</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-add_apache_v2_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_apache_v2_license</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Add Apache2 to the list of licenses</p> + + + + + <div class="method-source-code" id="add_apache_v2_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 45</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_apache_v2_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'The Apache Software License, Version 2.0'</span>] = <span class="ruby-string">'http://www.apache.org/licenses/LICENSE-2.0.txt'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_bsd_2_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_bsd_2_license</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="add_bsd_2_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_bsd_2_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'The BSD 2-Clause License'</span>] = <span class="ruby-string">'http://opensource.org/licenses/BSD-2-Clause'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_bsd_3_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_bsd_3_license</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="add_bsd_3_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_bsd_3_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'The BSD 3-Clause License'</span>] = <span class="ruby-string">'http://opensource.org/licenses/BSD-3-Clause'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_cddl_v1_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_cddl_v1_license</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="add_cddl_v1_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 57</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_cddl_v1_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'Common Development and Distribution License (CDDL-1.0)'</span>] = <span class="ruby-string">'http://opensource.org/licenses/CDDL-1.0'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_developer" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_developer</span><span + class="method-args">(id, name = nil, email = nil, roles = nil)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="add_developer-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 111</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_developer</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">email</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">roles</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">developers</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Developer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">email</span>, <span class="ruby-identifier">roles</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_epl_v1_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_epl_v1_license</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="add_epl_v1_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_epl_v1_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'Eclipse Public License - v 1.0'</span>] = <span class="ruby-string">'http://www.eclipse.org/legal/epl-v10.html'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_github_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_github_project</span><span + class="method-args">(project_spec)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Add a project like <a +href="CustomPom.html#method-i-add_github_project">#add_github_project</a>('realityforge/gwt-appcache')</p> + + + + + <div class="method-source-code" id="add_github_project-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 97</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_github_project</span>(<span class="ruby-identifier">project_spec</span>) + <span class="ruby-identifier">git_url</span> = <span class="ruby-node">"g...@github.com:#{project_spec}.git"</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">scm_connection</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">scm_developer_connection</span> = <span class="ruby-node">"scm:git:#{git_url}"</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">scm_url</span> = <span class="ruby-identifier">git_url</span> + <span class="ruby-identifier">web_url</span> = <span class="ruby-node">"https://github.com/#{project_spec}"</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">url</span> = <span class="ruby-identifier">web_url</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issues_url</span> = <span class="ruby-node">"#{web_url}/issues"</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issues_system</span> = <span class="ruby-string">'GitHub Issues'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_gpl_v1_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_gpl_v1_license</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="add_gpl_v1_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_gpl_v1_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'GNU General Public License (GPL) version 1.0'</span>] = <span class="ruby-string">'http://www.gnu.org/licenses/gpl-1.0.html'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_gpl_v2_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_gpl_v2_license</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="add_gpl_v2_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 69</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_gpl_v2_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'GNU General Public License (GPL) version 2.0'</span>] = <span class="ruby-string">'http://www.gnu.org/licenses/gpl-2.0.html'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_gpl_v3_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_gpl_v3_license</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="add_gpl_v3_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 73</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_gpl_v3_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'GNU General Public License (GPL) version 3.0'</span>] = <span class="ruby-string">'http://www.gnu.org/licenses/gpl-3.0.html'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_lgpl_v2_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_lgpl_v2_license</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="add_lgpl_v2_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_lgpl_v2_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'GNU General Lesser Public License (LGPL) version 2.1'</span>] = <span class="ruby-string">'http://www.gnu.org/licenses/lgpl-2.1.html'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_lgpl_v3_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_lgpl_v3_license</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="add_lgpl_v3_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 81</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_lgpl_v3_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'GNU General Lesser Public License (LGPL) version 3.0'</span>] = <span class="ruby-string">'http://www.gnu.org/licenses/lgpl-3.0.html'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-add_mit_license" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_mit_license</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="add_mit_license-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_mit_license</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">licenses</span>[<span class="ruby-string">'The MIT License'</span>] = <span class="ruby-string">'http://opensource.org/licenses/MIT'</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-additional_dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">additional_dependencies</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="additional_dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 131</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">additional_dependencies</span> + <span class="ruby-ivar">@additional_dependencies</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-additional_dependencies-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">additional_dependencies=</span><span + class="method-args">(additional_dependencies)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="additional_dependencies-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 135</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">additional_dependencies=</span>(<span class="ruby-identifier">additional_dependencies</span>) + <span class="ruby-ivar">@additional_dependencies</span> = <span class="ruby-identifier">additional_dependencies</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-description" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">description</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Retrieve the project description, defaulting to the name if not specified</p> + + + + + <div class="method-source-code" id="description-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">description</span> + <span class="ruby-ivar">@description</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">name</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-developers" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">developers</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="developers-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 107</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">developers</span> + <span class="ruby-ivar">@developers</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-include_transitive_dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">include_transitive_dependencies</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="include_transitive_dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 139</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">include_transitive_dependencies</span> + <span class="ruby-ivar">@include_transitive_dependencies</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-include_transitive_dependencies-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">include_transitive_dependencies=</span><span + class="method-args">(include_transitive_dependencies)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="include_transitive_dependencies-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 143</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">include_transitive_dependencies=</span>(<span class="ruby-identifier">include_transitive_dependencies</span>) + <span class="ruby-ivar">@include_transitive_dependencies</span> = <span class="ruby-identifier">include_transitive_dependencies</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-licenses" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">licenses</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Return the map of licenses for project</p> + + + + + <div class="method-source-code" id="licenses-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">licenses</span> + <span class="ruby-ivar">@licenses</span> <span class="ruby-operator">||=</span> {} +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">name</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>Retrieve the name of the project, defaulting to the project description or +the name if not specified</p> + + + + + <div class="method-source-code" id="name-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">name</span> + <span class="ruby-ivar">@name</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@buildr_project</span>.<span class="ruby-identifier">comment</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@buildr_project</span>.<span class="ruby-identifier">name</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-optional_dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">optional_dependencies</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="optional_dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 147</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">optional_dependencies</span> + <span class="ruby-ivar">@optional_dependencies</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-optional_dependencies-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">optional_dependencies=</span><span + class="method-args">(optional_dependencies)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="optional_dependencies-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 151</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">optional_dependencies=</span>(<span class="ruby-identifier">optional_dependencies</span>) + <span class="ruby-ivar">@optional_dependencies</span> = <span class="ruby-identifier">optional_dependencies</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-provided_dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">provided_dependencies</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="provided_dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 115</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">provided_dependencies</span> + <span class="ruby-ivar">@provided_dependencies</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-provided_dependencies-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">provided_dependencies=</span><span + class="method-args">(provided_dependencies)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="provided_dependencies-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 119</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">provided_dependencies=</span>(<span class="ruby-identifier">provided_dependencies</span>) + <span class="ruby-ivar">@provided_dependencies</span> = <span class="ruby-identifier">provided_dependencies</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-runtime_dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">runtime_dependencies</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="runtime_dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 123</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">runtime_dependencies</span> + <span class="ruby-ivar">@runtime_dependencies</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-runtime_dependencies-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">runtime_dependencies=</span><span + class="method-args">(runtime_dependencies)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="runtime_dependencies-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 127</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">runtime_dependencies=</span>(<span class="ruby-identifier">runtime_dependencies</span>) + <span class="ruby-ivar">@runtime_dependencies</span> = <span class="ruby-identifier">runtime_dependencies</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Protected Instance Methods</h3> + </header> + + + <div id="method-i-associate_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">associate_project</span><span + class="method-args">(buildr_project)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="associate_project-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/custom_pom.rb, line 161</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">associate_project</span>(<span class="ruby-identifier">buildr_project</span>) + <span class="ruby-ivar">@buildr_project</span> = <span class="ruby-identifier">buildr_project</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/Doc.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Doc.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Doc.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,358 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Doc - 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-engines">::engines</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-doc">#doc</a> + + <li ><a href="#method-i-javadoc">#javadoc</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Doc"> + <h1 id="module-Buildr::Doc" class="module"> + module Buildr::Doc + </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-engines" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">engines</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="engines-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/doc.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">engines</span> + <span class="ruby-ivar">@engines</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="Doc.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/core/doc.rb, line 21</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 doc 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">engines</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">language</span>.<span class="ruby-identifier">to_sym</span> <span class="ruby-operator">==</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="Doc.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/core/doc.rb, line 28</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 doc 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">engines</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-doc" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + doc(*sources) → JavadocTask + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + + <div class="method-description"> + + <p>This method returns the project's documentation task. It also accepts a +list of source files, directories and projects to include when generating +the docs.</p> + +<p>By default the doc task uses all the source directories from +compile.sources and generates documentation in the target/doc directory. +This method accepts sources and adds them by calling +Buildr::Doc::Base#from.</p> + +<p>For example, if you want to generate documentation for a given project that +includes all source files in two of its sub-projects:</p> + +<pre class="ruby"><span class="ruby-identifier">doc</span> <span class="ruby-identifier">projects</span>(<span class="ruby-string">'myapp:foo'</span>, <span class="ruby-string">'myapp:bar'</span>).<span class="ruby-identifier">using</span>(:<span class="ruby-identifier">windowtitle=</span><span class="ruby-operator">></span><span class="ruby-string">'Docs for foo and bar'</span>) +</pre> + + + + + <div class="method-source-code" id="doc-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/doc.rb, line 268</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">doc</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sources</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">task</span>(<span class="ruby-string">'doc'</span>).<span class="ruby-identifier">from</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sources</span>).<span class="ruby-identifier">enhance</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-javadoc" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">javadoc</span><span + class="method-args">(*sources, &block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="javadoc-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/doc.rb, line 272</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">javadoc</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sources</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">warn</span> <span class="ruby-string">'The javadoc method is deprecated and will be removed in a future release.'</span> + <span class="ruby-identifier">doc</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">sources</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> +