<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Naether::sMav
— Documentation by YARD 0.8.7.2
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (s)</a> »
<span class='title'><span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span></span>
»
<span class="title">sMav</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Naether::sMav
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Naether::sMav</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/naether/maven.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#create_from_notation-class_method" title="create_from_notation (class method)">+ (Object) <strong>create_from_notation</strong>(f create) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_from_pom-class_method" title="create_from_pom (class method)">+ (Naether::Maven) <strong>create_from_pom</strong>(e_from_p) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#build_pom-instance_method" title="#build_pom (instance method)">- (String) <strong>build_pom</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Pom xml.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dependencies%3D-instance_method" title="#dependencies= (instance method)">- (Object) <strong>dependencies=</strong>(pe # ) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#final_name-instance_method" title="#final_name (instance method)">- (Object) <strong>final_name</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#invoke-instance_method" title="#invoke (instance method)">- (Object) <strong>invoke</strong>(* ) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_naether-instance_method" title="#load_naether (instance method)">- (Object) <strong>load_naether</strong>(tories ) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Load dependencies and remote repo from a <span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span> instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#notation%3D-instance_method" title="#notation= (instance method)">- (Object) <strong>notation=</strong>(tion ) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#repositories%3D-instance_method" title="#repositories= (instance method)">- (Object) <strong>repositories=</strong>(@param [Arra) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#version-instance_method" title="#version (instance method)">- (Object) <strong>version</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>return [String] version.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write_pom-instance_method" title="#write_pom (instance method)">- (Object) <strong>write_pom</strong>(er.getRem) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create_from_notation-class_method">
+ (<tt>Object</tt>) <strong>create_from_notation</strong>(f create)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://github.com/mguymon/naether/wiki/Notations" target="_parent" title="https://github.com/mguymon/naether/wiki/Notations">https://github.com/mguymon/naether/wiki/Notations</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 41</span>
er/wiki/Notations
def create_from_notation( notation )
maven = Maven.new
mav</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_from_pom-class_method">
+ (<tt>Naether::Maven</tt>) <strong>create_from_pom</strong>(e_from_p)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Naether::Maven</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 32</span>
aven]
def create_from_pom( pom_path )
maven = Maven.new( po</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="build_pom-instance_method">
- (<tt>String</tt>) <strong>build_pom</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns pom xml</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>pom xml</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
137
138</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 137</span>
<span class='id identifier rubyid_oad_naether'>oad_naether</span><span class='lparen'>(</span> <span class='id identifier rubyid_naether'>naether</span> <span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_dependen'>dependen</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dependencies=-instance_method">
- (<tt>Object</tt>) <strong>dependencies=</strong>(pe
#
)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>dependencies</span>
<span class='type'>(<tt>Array</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
110
111
112
113</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 110</span>
param [String] scope
#
def add_dependency( notation, scope = nil )
@</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="final_name-instance_method">
- (<tt>Object</tt>) <strong>final_name</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
171
172
173
174
175</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 171</span>
p )
end
goals = opts
po</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="invoke-instance_method">
- (<tt>Object</tt>) <strong>invoke</strong>(* )
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 152</span>
build_pom()
@project.toXml()
end
# Write Maven Pom
#
# @param [String] file_path
def write_pom( file_path )
@project.writePom( file_path )
end
# Invoke a Maven goal
#
# @params [Array] Goals names
def invoke( *opts )
#defaults
config = {
# Checks ENV for maven home, otherwise defaults /usr/share/maven
:maven_home => ENV['maven.home'] || ENV['MAVEN_HOME'] || '/usr/share/maven',
:local_repo => File.expand_path('~/.m2/repository')
}
if opts.last.is_a? Hash
config = config.merge( o</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_naether-instance_method">
- (<tt>Object</tt>) <strong>load_naether</strong>(tories )
</h3><div class="docstring">
<div class="discussion">
<p>Load dependencies and remote repo from a <span class='object_link'><a href="../Naether.html" title="Naether (module)">Naether</a></span> instance</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
129
130
131
132
133
134
135
136
137</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 129</span>
positories( repositories )
end
# Get the version
#
# return [String] version
def version()
return @project.getVersion()
end</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="notation=-instance_method">
- (<tt>Object</tt>) <strong>notation=</strong>(tion
)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://github.com/mguymon/naether/wiki/Notations" target="_parent" title="https://github.com/mguymon/naether/wiki/Notations">https://github.com/mguymon/naether/wiki/Notations</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 64</span>
[String] notation
# @see https://github.com/mguymon/naether/wiki/Not</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="repositories=-instance_method">
- (<tt>Object</tt>) <strong>repositories=</strong>(@param [Arra)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>repositories</span>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>of urls</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119
120</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 117</span>
encies
#
# @param [Array] dependencies
def dependencies=(dependencies)</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="version-instance_method">
- (<tt>Object</tt>) <strong>version</strong>
</h3><div class="docstring">
<div class="discussion">
<p>return [String] version</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 124</span>
<span class='const'>Set</span> <span class='id identifier rubyid_repositories'>repositories</span>
<span class='comment'>#
</span><span class='comment'># @param [Array] reposit</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="write_pom-instance_method">
- (<tt>Object</tt>) <strong>write_pom</strong>(er.getRem)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>file_path</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
145
146
147
148</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/naether/maven.rb', line 145</span>
naether.resolver.getRemoteRepositoryUrls()
end
# Crea</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Oct 02 21:56:40 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.2 (ruby-1.9.3).
</div>
</body>
</html>