naether 0.9.2-java → 0.10.0-java

data/doc/Naether/Bootstrap.html

@@ -6,7 +6,7 @@
 <title>
   Class: Naether::Bootstrap
   
-    &mdash; Documentation by YARD 0.8.2.1
+    &mdash; Documentation by YARD 0.8.3
   
 </title>
 
@@ -102,19 +102,29 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>:title:Naether::Bootstrap</p>
-
 <p>Helper for bootstrapping Naether</p>
 
-<h1 id="label-Authors">Authors</h1>
-
-<p>Michael Guymon</p>
-
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Author:</p>
+<ul class="author">
+  
+    <li>
+      
+      
+      
+      
+        
+        <div class='inline'>
+<p>Michael Guymon</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div>
   <h2>Constant Summary</h2>
@@ -161,7 +171,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Bootstrap the local repo by downloading Naether's dependencies.</p>
+</div></span>
   
 </li>
 
@@ -169,7 +181,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#check_local_repo_for_deps-class_method" title="check_local_repo_for_deps (class method)">+ (Object) <strong>check_local_repo_for_deps</strong>(local_repo = nil, opts = {}) </a>
+      <a href="#check_local_repo_for_deps-class_method" title="check_local_repo_for_deps (class method)">+ (Hash) <strong>check_local_repo_for_deps</strong>(local_repo = nil, opts = {}) </a>
     
 
     
@@ -183,7 +195,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Check local_repo for Naether dependencies.</p>
+</div></span>
   
 </li>
 
@@ -191,7 +205,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#default_local_repo-class_method" title="default_local_repo (class method)">+ (Object) <strong>default_local_repo</strong> </a>
+      <a href="#default_local_repo-class_method" title="default_local_repo (class method)">+ (String) <strong>default_local_repo</strong> </a>
     
 
     
@@ -205,7 +219,10 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Default local repo of <a href="http://'M2_REPO'">ENV</a> or
+~/.m2/repository.</p>
+</div></span>
   
 </li>
 
@@ -213,7 +230,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#dependencies-class_method" title="dependencies (class method)">+ (Object) <strong>dependencies</strong>(dep_file = nil) </a>
+      <a href="#dependencies-class_method" title="dependencies (class method)">+ (List) <strong>dependencies</strong>(dep_file = nil) </a>
     
 
     
@@ -228,7 +245,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>List of Java dependencies for Naether.</p>
+<p>List of Java dependencies for Naether from yaml dependency file.</p>
 </div></span>
   
 </li>
@@ -237,7 +254,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#download_dependencies-class_method" title="download_dependencies (class method)">+ (Object) <strong>download_dependencies</strong>(dest, opts = {}) </a>
+      <a href="#download_dependencies-class_method" title="download_dependencies (class method)">+ (Hash) <strong>download_dependencies</strong>(dest, opts = {}) </a>
     
 
     
@@ -251,7 +268,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Download Naether dependencies.</p>
+</div></span>
   
 </li>
 
@@ -259,7 +278,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#install_dependencies_to_local_repo-class_method" title="install_dependencies_to_local_repo (class method)">+ (Object) <strong>install_dependencies_to_local_repo</strong>(install_jars, naether_jars, opts = {}) </a>
+      <a href="#install_dependencies_to_local_repo-class_method" title="install_dependencies_to_local_repo (class method)">+ (Naether) <strong>install_dependencies_to_local_repo</strong>(install_jars, naether_jars, opts = {}) </a>
     
 
     
@@ -273,7 +292,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Install Naether Dependencies to local_repo.</p>
+</div></span>
   
 </li>
 
@@ -296,7 +317,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>write bootstrap dependencies to yaml file.</p>
+<p>Write bootstrap dependencies to yaml file.</p>
 </div></span>
   
 </li>
@@ -320,23 +341,58 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Bootstrap the local repo by downloading Naether's dependencies</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>local_repo</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>defaults to #default_local_repo</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>opts</span>
+      
+      
+        <span class='type'>(<tt>hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
 67
 68
 69
@@ -346,10 +402,21 @@
 73
 74
 75
-76</pre>
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 67</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_bootstrap_local_repo identifier id'>bootstrap_local_repo</span><span class='lparen token'>(</span><span class='rubyid_local_repo identifier id'>local_repo</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='rubyid_opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span> <span class='rparen token'>)</span>
   <span class='rubyid_local_repo identifier id'>local_repo</span> <span class='assign token'>=</span> <span class='rubyid_local_repo identifier id'>local_repo</span> <span class='orop op'>||</span> <span class='rubyid_default_local_repo identifier id'>default_local_repo</span>
@@ -369,7 +436,7 @@
     <span class='rubyid_install_dependencies_to_local_repo identifier id'>install_dependencies_to_local_repo</span><span class='lparen token'>(</span> <span class='rubyid_deps identifier id'>deps</span><span class='lbrack token'>[</span><span class='symbol val'>:downloaded</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_jars identifier id'>jars</span><span class='comma token'>,</span> <span class='rubyid_opts identifier id'>opts</span> <span class='rparen token'>)</span>
   <span class='rubyid_end end kw'>end</span>
   
-  <span class='comment val'>#raise Naether::Java.instance.java.class_loader.getLoadedPaths().map { |x| x.toString() }.sort.inspect</span>
+  <span class='comment val'>#raise Naether::Java.internal_loaded_paths.inspect</span>
   
 <span class='rubyid_end end kw'>end</span>
 </pre>
@@ -381,50 +448,109 @@
       <div class="method_details ">
   <h3 class="signature " id="check_local_repo_for_deps-class_method">
   
-    + (<tt>Object</tt>) <strong>check_local_repo_for_deps</strong>(local_repo = nil, opts = {}) 
+    + (<tt>Hash</tt>) <strong>check_local_repo_for_deps</strong>(local_repo = nil, opts = {}) 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Check local_repo for Naether dependencies</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>local_repo</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>opts</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>with status of missing, downloaded, exists dependencies</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-124
-125
-126
-127
-128
-129
-130
-131
-132
-133
-134
-135
-136
-137
-138
-139
-140
-141
-142
-143
-144
-145
-146
 147
 148
 149
 150
 151
-152</pre>
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 124</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 147</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_check_local_repo_for_deps identifier id'>check_local_repo_for_deps</span><span class='lparen token'>(</span><span class='rubyid_local_repo identifier id'>local_repo</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='rubyid_opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span> <span class='rparen token'>)</span>
   
@@ -464,24 +590,49 @@
       <div class="method_details ">
   <h3 class="signature " id="default_local_repo-class_method">
   
-    + (<tt>Object</tt>) <strong>default_local_repo</strong> 
+    + (<tt>String</tt>) <strong>default_local_repo</strong> 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Default local repo of <a href="http://'M2_REPO'">ENV</a> or
+~/.m2/repository</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-21
-22
-23</pre>
+23
+24
+25</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 23</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_default_local_repo identifier id'>default_local_repo</span>
   <span class='rubyid_ENV constant id'>ENV</span><span class='lbrack token'>[</span><span class='string val'>'M2_REPO'</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='rubyid_File constant id'>File</span><span class='dot token'>.</span><span class='rubyid_expand_path identifier id'>expand_path</span><span class='lparen token'>(</span><span class='string val'>'~/.m2/repository'</span><span class='rparen token'>)</span>
@@ -495,7 +646,7 @@
       <div class="method_details ">
   <h3 class="signature " id="dependencies-class_method">
   
-    + (<tt>Object</tt>) <strong>dependencies</strong>(dep_file = nil) 
+    + (<tt>List</tt>) <strong>dependencies</strong>(dep_file = nil) 
   
 
   
@@ -504,13 +655,49 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>List of Java dependencies for Naether</p>
+<p>List of Java dependencies for Naether from yaml dependency file. Caches
+result after first run.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>dep_file</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>path, defaults to Naether::Configuration.dependencies_yml</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>List</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -518,22 +705,22 @@
       <pre class="lines">
 
 
-41
-42
-43
-44
-45
-46
 47
 48
 49
 50
 51
 52
-53</pre>
+53
+54
+55
+56
+57
+58
+59</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 41</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 47</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_dependencies identifier id'>dependencies</span><span class='lparen token'>(</span> <span class='rubyid_dep_file identifier id'>dep_file</span><span class='assign token'>=</span><span class='rubyid_nil nil kw'>nil</span> <span class='rparen token'>)</span>
   
@@ -557,35 +744,80 @@
       <div class="method_details ">
   <h3 class="signature " id="download_dependencies-class_method">
   
-    + (<tt>Object</tt>) <strong>download_dependencies</strong>(dest, opts = {}) 
+    + (<tt>Hash</tt>) <strong>download_dependencies</strong>(dest, opts = {}) 
+  
+
+  
+
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Download Naether dependencies</p>
 
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>dest</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>to download dependencies t</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>opts</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+    </li>
+  
+</ul>
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
   
-</h3><table class="source_code">
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>with status of missing, downloaded, exists dependencies</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-78
-79
-80
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91
-92
-93
-94
 95
 96
 97
@@ -613,10 +845,27 @@
 119
 120
 121
-122</pre>
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 78</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 95</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_download_dependencies identifier id'>download_dependencies</span><span class='lparen token'>(</span> <span class='rubyid_dest identifier id'>dest</span><span class='comma token'>,</span> <span class='rubyid_opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span> <span class='rparen token'>)</span>
    
@@ -672,38 +921,106 @@
       <div class="method_details ">
   <h3 class="signature " id="install_dependencies_to_local_repo-class_method">
   
-    + (<tt>Object</tt>) <strong>install_dependencies_to_local_repo</strong>(install_jars, naether_jars, opts = {}) 
+    + (<tt><span class='object_link'><a href="../Naether.html" title="Naether (class)">Naether</a></span></tt>) <strong>install_dependencies_to_local_repo</strong>(install_jars, naether_jars, opts = {}) 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Install Naether Dependencies to local_repo</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>install_jars</span>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>naether_jars</span>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>to bootstrap Naether. These may overlap with install_jars.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>opts</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Naether.html" title="Naether (class)">Naether</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-154
-155
-156
-157
-158
-159
-160
-161
-162
-163
-164
-165
-166
-167
-168
-169
-170</pre>
+185
+186
+187
+188
+189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 154</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 185</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_install_dependencies_to_local_repo identifier id'>install_dependencies_to_local_repo</span><span class='lparen token'>(</span> <span class='rubyid_install_jars identifier id'>install_jars</span><span class='comma token'>,</span> <span class='rubyid_naether_jars identifier id'>naether_jars</span><span class='comma token'>,</span> <span class='rubyid_opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>  <span class='rparen token'>)</span>
     
@@ -740,7 +1057,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>write bootstrap dependencies to yaml file</p>
+<p>Write bootstrap dependencies to yaml file</p>
 
 
   </div>
@@ -754,8 +1071,6 @@
       <pre class="lines">
 
 
-26
-27
 28
 29
 30
@@ -766,10 +1081,12 @@
 35
 36
 37
-38</pre>
+38
+39
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/naether/bootstrap.rb', line 28</span>
 
 <span class='rubyid_def def kw'>def</span> <span class='rubyid_write_dependencies identifier id'>write_dependencies</span><span class='lparen token'>(</span> <span class='rubyid_dest identifier id'>dest</span> <span class='assign token'>=</span> <span class='string val'>'jar_dependencies.yml'</span> <span class='rparen token'>)</span>
   <span class='rubyid_deps identifier id'>deps</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='semicolon token'>;</span>
@@ -795,9 +1112,9 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Sep 17 22:57:18 2012 by
+  Generated on Mon Oct 15 14:44:01 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.2.1 (ruby-1.8.7).
+  0.8.3 (ruby-1.9.2).
 </div>
 
   </body>