[Abtlinux-svn] SF.net SVN: abtlinux: [217] src/trunk/doc

[<esc...@us...>]

Revision: 217
          http://svn.sourceforge.net/abtlinux/?rev=217&view=rev
Author:   eschabell
Date:     2006-11-19 02:57:29 -0800 (Sun, 19 Nov 2006)

Log Message:
-----------
Regenerated api docs.

Modified Paths:
--------------
    src/trunk/doc/classes/AbtDownloadManager.html
    src/trunk/doc/classes/AbtPackage.html
    src/trunk/doc/classes/TestAbtDownloadManager.html
    src/trunk/doc/created.rid
    src/trunk/doc/files/AbtDownloadManager_rb.html
    src/trunk/doc/files/AbtPackage_rb.html
    src/trunk/doc/files/TestAbtDownloadManager_rb.html

Modified: src/trunk/doc/classes/AbtDownloadManager.html
===================================================================
--- src/trunk/doc/classes/AbtDownloadManager.html	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/classes/AbtDownloadManager.html	2006-11-19 10:57:29 UTC (rev 217)
@@ -160,24 +160,56 @@
 <div class="sectiontitle">Public Instance methods</div>
 <div class="method">
   <div class="title">
-    <a name="M000014"></a><b>retrieveNewsFeed</b>()
+    <a name="M000014"></a><b>retrieveNewsFeed</b>( uri )
   </div>
   <div class="description">
   <p>
-Retrieves the AbTLinux news feed.
+Retrieves the given feed and displays the news items.
 </p>
 <p>
-<b>RETURN</b> <em>boolean</em> - True if the AbTLinux news feed has been
-retrieved, otherwise false.
+<b>PARAM</b> <em>String</em> - the uri of the rss news feed to be
+retrieved. <b>RETURN</b> <em>boolean</em> - True if the AbTLinux news feed
+has been retrieved, otherwise false.
 </p>
   </div>
 <div class="sourcecode">
   <p class="source-link">[ <a href="javascript:toggleSource('M000014_source')" id="l_M000014_source">show source</a> ]</p>
   <div id="M000014_source" class="dyn-source">
 <pre>
-    <span class="ruby-comment cmt"># File AbtDownloadManager.rb, line 91</span>
-91:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">retrieveNewsFeed</span>
-92:   <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File AbtDownloadManager.rb, line 92</span>
+ 92:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">retrieveNewsFeed</span>( <span class="ruby-identifier">uri</span> )
+ 93:                 <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/http'</span>
+ 94:                 <span class="ruby-identifier">require</span> <span class="ruby-value str">'uri'</span>
+ 95:                 <span class="ruby-identifier">require</span> <span class="ruby-value str">'rss/1.0'</span>
+ 96:                 <span class="ruby-identifier">require</span> <span class="ruby-value str">'rss/2.0'</span>
+ 97:                 
+ 98:                 <span class="ruby-comment cmt"># pick up the abtlinux.org news feed.</span>
+ 99:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-identifier">news</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get</span>( <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>( <span class="ruby-identifier">uri</span> ) ) )
+100:                         <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">logToJournal</span>( <span class="ruby-node">&quot;Failed to retrieve news feed #{uri}.&quot;</span> )
+101:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+102:                 <span class="ruby-keyword kw">end</span>
+103: 
+104:                 <span class="ruby-comment cmt"># display the feeds.</span>
+105:                 <span class="ruby-identifier">rss</span> = <span class="ruby-keyword kw">nil</span>
+106:                 <span class="ruby-keyword kw">begin</span>
+107:                         <span class="ruby-identifier">rss</span>  = <span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">news</span>, <span class="ruby-keyword kw">false</span>)
+108:                 <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
+109:                 <span class="ruby-keyword kw">end</span> 
+110:                 
+111:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-identifier">rss</span>.<span class="ruby-identifier">nil?</span> )
+112:                         <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">logToJournal</span>( <span class="ruby-node">&quot;Failed to display news feed as feed #{uri} is not RSS 1.0/2.0.&quot;</span> )
+113:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+114:                 <span class="ruby-keyword kw">else</span>
+115:                         <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*** #{rss.channel.title} ***&quot;</span>
+116:                         
+117:                         <span class="ruby-identifier">rss</span>.<span class="ruby-identifier">items</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">item</span>, <span class="ruby-identifier">itemCount</span><span class="ruby-operator">|</span>
+118:                                 <span class="ruby-identifier">itemCount</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+119:                                 <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#{itemCount}  #{item.link}  #{item.title}&quot;</span> 
+120:                         <span class="ruby-keyword kw">end</span>
+121:                 <span class="ruby-keyword kw">end</span>
+122: 
+123:                 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+124:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -276,9 +308,9 @@
   <p class="source-link">[ <a href="javascript:toggleSource('M000015_source')" id="l_M000015_source">show source</a> ]</p>
   <div id="M000015_source" class="dyn-source">
 <pre>
-     <span class="ruby-comment cmt"># File AbtDownloadManager.rb, line 102</span>
-102:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updatePackage</span>
-103:   <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File AbtDownloadManager.rb, line 134</span>
+134:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updatePackage</span>
+135:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -300,9 +332,9 @@
   <p class="source-link">[ <a href="javascript:toggleSource('M000016_source')" id="l_M000016_source">show source</a> ]</p>
   <div id="M000016_source" class="dyn-source">
 <pre>
-     <span class="ruby-comment cmt"># File AbtDownloadManager.rb, line 111</span>
-111:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updatePackageTree</span>
-112:   <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File AbtDownloadManager.rb, line 143</span>
+143:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updatePackageTree</span>
+144:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>

Modified: src/trunk/doc/classes/AbtPackage.html
===================================================================
--- src/trunk/doc/classes/AbtPackage.html	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/classes/AbtPackage.html	2006-11-19 10:57:29 UTC (rev 217)
@@ -573,19 +573,19 @@
   <p class="source-link">[ <a href="javascript:toggleSource('M000032_source')" id="l_M000032_source">show source</a> ]</p>
   <div id="M000032_source" class="dyn-source">
 <pre>
-     <span class="ruby-comment cmt"># File AbtPackage.rb, line 233</span>
-233:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">removeBuildSources</span>
-234:                 <span class="ruby-identifier">buildSourcesLocation</span> = <span class="ruby-node">&quot;#{$BUILD_LOCATION}/#{srcDir}&quot;</span>
-235: 
-236:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>( <span class="ruby-identifier">buildSourcesLocation</span> ) )
-237:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-238:                 <span class="ruby-keyword kw">end</span>
-239: 
-240:                 <span class="ruby-comment cmt"># TODO: system call removal?</span>
-241:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span> <span class="ruby-identifier">buildSourcesLocation</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>  )
-242:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-243:                 <span class="ruby-keyword kw">end</span>
-244:         <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File AbtPackage.rb, line 263</span>
+263:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">removeBuildSources</span>
+264:                 <span class="ruby-identifier">buildSourcesLocation</span> = <span class="ruby-node">&quot;#{$BUILD_LOCATION}/#{srcDir}&quot;</span>
+265: 
+266:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>( <span class="ruby-identifier">buildSourcesLocation</span> ) )
+267:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+268:                 <span class="ruby-keyword kw">end</span>
+269: 
+270:                 <span class="ruby-comment cmt"># TODO: system call removal?</span>
+271:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span> <span class="ruby-identifier">buildSourcesLocation</span>, <span class="ruby-identifier">:verbose</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>  )
+272:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+273:                 <span class="ruby-keyword kw">end</span>
+274:         <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>
@@ -609,19 +609,49 @@
 <pre>
      <span class="ruby-comment cmt"># File AbtPackage.rb, line 213</span>
 213:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unpackSources</span>
-214:                 <span class="ruby-identifier">sourcesToUnpack</span>    = <span class="ruby-node">&quot;#{$SOURCES_REPOSITORY}/#{File.basename( srcUrl )}&quot;</span>
-215: 
-216:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>( <span class="ruby-identifier">sourcesToUnpack</span> ) )
-217:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-218:                 <span class="ruby-keyword kw">end</span> 
-219: 
-220:                 <span class="ruby-comment cmt"># TODO: system call removal?</span>
-221:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-identifier">system</span>( <span class="ruby-node">&quot;cd #{$BUILD_LOCATION}; tar xzvf #{sourcesToUnpack}&quot;</span> ) )
-222:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-223:                 <span class="ruby-keyword kw">end</span>
-224: 
-225:                 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-226:         <span class="ruby-keyword kw">end</span>
+214:                 <span class="ruby-identifier">srcFile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>( <span class="ruby-identifier">srcUrl</span> )
+215:                 <span class="ruby-identifier">sourcesToUnpack</span> = <span class="ruby-node">&quot;#{$SOURCES_REPOSITORY}/#{srcFile}&quot;</span>
+216:                 <span class="ruby-identifier">unpackTool</span>      = <span class="ruby-value str">&quot;&quot;</span>
+217:                 <span class="ruby-identifier">logger</span> = <span class="ruby-constant">AbtLogManager</span>.<span class="ruby-identifier">new</span>
+218: 
+219:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>( <span class="ruby-identifier">sourcesToUnpack</span> ) )
+220:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+221:                 <span class="ruby-keyword kw">end</span> 
+222: 
+223:                 <span class="ruby-comment cmt"># determine which supported compression used [gz, tar, tgz, bz2, zip].</span>
+224:                 <span class="ruby-identifier">compressionType</span> = <span class="ruby-identifier">srcFile</span>.<span class="ruby-identifier">split</span>( <span class="ruby-value str">'.'</span> )
+225: 
+226:                 <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">compressionType</span>.<span class="ruby-identifier">last</span>
+227: 
+228:                 <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;gz&quot;</span>
+229:                         <span class="ruby-identifier">unpackTool</span> = <span class="ruby-value str">&quot;tar xzvf&quot;</span>
+230: 
+231:                 <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;tar&quot;</span>
+232:                         <span class="ruby-identifier">unpackTool</span> = <span class="ruby-value str">&quot;tar xvf&quot;</span>
+233: 
+234:                 <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;bz2&quot;</span>
+235:                         <span class="ruby-identifier">unpackTool</span> = <span class="ruby-value str">&quot;tar xjvf&quot;</span>
+236: 
+237:                 <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;tgz&quot;</span> 
+238:                         <span class="ruby-identifier">unpackTool</span> = <span class="ruby-value str">&quot;tar xzvf&quot;</span>
+239:                 
+240:                 <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;zip&quot;</span>
+241:                         <span class="ruby-identifier">unpackTool</span> = <span class="ruby-value str">&quot;unizp&quot;</span>
+242: 
+243:                 <span class="ruby-keyword kw">else</span>
+244:                         <span class="ruby-comment cmt"># unsupported format.</span>
+245:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+246:                 <span class="ruby-keyword kw">end</span>
+247:                 
+248:                 <span class="ruby-comment cmt">#logger.logToJournal( &quot;DEBUG: unpack tool will be '#{unpackTool}'.&quot; )</span>
+249: 
+250:                 <span class="ruby-comment cmt"># TODO: system call removal?</span>
+251:                 <span class="ruby-keyword kw">if</span> ( <span class="ruby-operator">!</span><span class="ruby-identifier">system</span>( <span class="ruby-node">&quot;cd #{$BUILD_LOCATION}; #{unpackTool} #{sourcesToUnpack}&quot;</span> ) )
+252:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+253:                 <span class="ruby-keyword kw">end</span>
+254: 
+255:                 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+256:         <span class="ruby-keyword kw">end</span>
 </pre>
   </div>
 </div>

Modified: src/trunk/doc/classes/TestAbtDownloadManager.html
===================================================================
--- src/trunk/doc/classes/TestAbtDownloadManager.html	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/classes/TestAbtDownloadManager.html	2006-11-19 10:57:29 UTC (rev 217)
@@ -169,7 +169,7 @@
 <pre>
     <span class="ruby-comment cmt"># File TestAbtDownloadManager.rb, line 57</span>
 57:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">testRetrieveNewsFeed</span>()
-58:     <span class="ruby-identifier">assert</span>( <span class="ruby-ivar">@download</span>.<span class="ruby-identifier">retrieveNewsFeed</span>(), <span class="ruby-value str">&quot;testRetrieveNewsFeed()&quot;</span> )
+58:     <span class="ruby-identifier">assert</span>( <span class="ruby-ivar">@download</span>.<span class="ruby-identifier">retrieveNewsFeed</span>( <span class="ruby-identifier">$ABTNEWS</span> ), <span class="ruby-value str">&quot;testRetrieveNewsFeed()&quot;</span> )
 59:   <span class="ruby-keyword kw">end</span>
 </pre>
   </div>

Modified: src/trunk/doc/created.rid
===================================================================
--- src/trunk/doc/created.rid	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/created.rid	2006-11-19 10:57:29 UTC (rev 217)
@@ -1 +1 @@
-Sat Nov 18 20:20:36 CET 2006
+Sun Nov 19 11:56:14 CET 2006

Modified: src/trunk/doc/files/AbtDownloadManager_rb.html
===================================================================
--- src/trunk/doc/files/AbtDownloadManager_rb.html	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/files/AbtDownloadManager_rb.html	2006-11-19 10:57:29 UTC (rev 217)
@@ -63,7 +63,7 @@
           </tr>
           <tr>
             <td>Modified:</td>
-            <td>Wed Nov 15 15:38:44 CET 2006</td>
+            <td>Sun Nov 19 11:56:11 CET 2006</td>
           </tr>
         </table>
       </td></tr>
@@ -113,6 +113,13 @@
 </p>
 </div>
 
+  <div class="sectiontitle">Required Files</div>
+  <ul>
+  <li>net/http</li>
+  <li>uri</li>
+  <li>rss/1.0</li>
+  <li>rss/2.0</li>
+  </ul>
 
 
 

Modified: src/trunk/doc/files/AbtPackage_rb.html
===================================================================
--- src/trunk/doc/files/AbtPackage_rb.html	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/files/AbtPackage_rb.html	2006-11-19 10:57:29 UTC (rev 217)
@@ -63,7 +63,7 @@
           </tr>
           <tr>
             <td>Modified:</td>
-            <td>Sat Nov 18 20:20:34 CET 2006</td>
+            <td>Sun Nov 19 11:56:11 CET 2006</td>
           </tr>
         </table>
       </td></tr>

Modified: src/trunk/doc/files/TestAbtDownloadManager_rb.html
===================================================================
--- src/trunk/doc/files/TestAbtDownloadManager_rb.html	2006-11-19 10:56:42 UTC (rev 216)
+++ src/trunk/doc/files/TestAbtDownloadManager_rb.html	2006-11-19 10:57:29 UTC (rev 217)
@@ -63,7 +63,7 @@
           </tr>
           <tr>
             <td>Modified:</td>
-            <td>Wed Nov 15 15:38:44 CET 2006</td>
+            <td>Sun Nov 19 11:56:11 CET 2006</td>
           </tr>
         </table>
       </td></tr>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.