RubyGems - autobuild - Versions diffs - 0.5.1 → 0.6 - Mend

autobuild 0.5.1 → 0.6

Files changed (345) hide show

data/doc/classes/Autobuild/PackageException.html CHANGED Viewed

@@ -80,6 +80,12 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+An error occured in a package
+</p>
+    </div>
    </div>
@@ -88,7 +94,7 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000059">mail?</a>&nbsp;&nbsp;
+      <a href="#M000050">mail?</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -110,12 +116,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000059" class="method-detail">
-        <a name="M000059"></a>
+      <div id="method-M000050" class="method-detail">
+        <a name="M000050"></a>
         <div class="method-heading">
-          <a href="PackageException.src/M000059.html" target="Code" class="method-signature"
-            onclick="popupCode('PackageException.src/M000059.html');return false;">
+          <a href="PackageException.src/M000050.html" target="Code" class="method-signature"
+            onclick="popupCode('PackageException.src/M000050.html');return false;">
           <span class="method-name">mail?</span><span class="method-args">()</span>
           </a>
         </div>

data/doc/classes/Autobuild/PackageException.src/{M000059.html → M000050.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/exceptions.rb, line 20</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/exceptions.rb, line 32</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mail?</span>; <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Autobuild/PackageException.src/M000078.html ADDED Viewed

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>mail? (Autobuild::PackageException)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/exceptions.rb, line 32</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mail?</span>; <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Autobuild/Reporter.html CHANGED Viewed

@@ -78,6 +78,12 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+Base class for reporters
+</p>
+    </div>
    </div>
@@ -86,8 +92,8 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000074">error</a>&nbsp;&nbsp;
-      <a href="#M000075">success</a>&nbsp;&nbsp;
+      <a href="#M000053">error</a>&nbsp;&nbsp;
+      <a href="#M000054">success</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -109,12 +115,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000074" class="method-detail">
-        <a name="M000074"></a>
+      <div id="method-M000053" class="method-detail">
+        <a name="M000053"></a>
         <div class="method-heading">
-          <a href="Reporter.src/M000074.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporter.src/M000074.html');return false;">
+          <a href="Reporter.src/M000053.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporter.src/M000053.html');return false;">
           <span class="method-name">error</span><span class="method-args">(error)</span>
           </a>
         </div>
@@ -123,12 +129,12 @@
         </div>
       </div>
-      <div id="method-M000075" class="method-detail">
-        <a name="M000075"></a>
+      <div id="method-M000054" class="method-detail">
+        <a name="M000054"></a>
         <div class="method-heading">
-          <a href="Reporter.src/M000075.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporter.src/M000075.html');return false;">
+          <a href="Reporter.src/M000054.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporter.src/M000054.html');return false;">
           <span class="method-name">success</span><span class="method-args">()</span>
           </a>
         </div>

data/doc/classes/Autobuild/Reporter.src/{M000074.html → M000053.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 41</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 56</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>); <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Autobuild/Reporter.src/{M000075.html → M000054.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 42</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 57</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">success</span>; <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Autobuild/Reporter.src/M000081.html ADDED Viewed

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>error (Autobuild::Reporter)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 56</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>); <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Autobuild/Reporter.src/M000082.html ADDED Viewed

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>success (Autobuild::Reporter)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 57</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">success</span>; <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Autobuild/Reporting.html CHANGED Viewed

@@ -5,7 +5,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>Class: Autobuild::Reporting</title>
+  <title>Module: Autobuild::Reporting</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
@@ -49,7 +49,7 @@
     <div id="classHeader">
         <table class="header-table">
         <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
+          <td><strong>Module</strong></td>
           <td class="class-name-in-header">Autobuild::Reporting</td>
         </tr>
         <tr class="top-aligned-row">
@@ -62,12 +62,6 @@
             </td>
         </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
         </table>
     </div>
   <!-- banner header -->
@@ -78,6 +72,18 @@
   <div id="contextContent">
+    <div id="description">
+      <pre>
+ The reporting module provides the framework
+</pre>
+<p>
+to run commands in autobuild and report errors to the user
+</p>
+<p>
+It does not use a logging framework like Log4r, but it should ;-)
+</p>
+    </div>
    </div>
@@ -86,11 +92,11 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000098">&lt;&lt;</a>&nbsp;&nbsp;
-      <a href="#M000099">each_log</a>&nbsp;&nbsp;
-      <a href="#M000097">error</a>&nbsp;&nbsp;
-      <a href="#M000095">report</a>&nbsp;&nbsp;
-      <a href="#M000096">success</a>&nbsp;&nbsp;
+      <a href="#M000028">&lt;&lt;</a>&nbsp;&nbsp;
+      <a href="#M000029">each_log</a>&nbsp;&nbsp;
+      <a href="#M000027">error</a>&nbsp;&nbsp;
+      <a href="#M000025">report</a>&nbsp;&nbsp;
+      <a href="#M000026">success</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -112,73 +118,94 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
-      <div id="method-M000098" class="method-detail">
-        <a name="M000098"></a>
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
         <div class="method-heading">
-          <a href="Reporting.src/M000098.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporting.src/M000098.html');return false;">
+          <a href="Reporting.src/M000028.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporting.src/M000028.html');return false;">
           <span class="method-name">&lt;&lt;</span><span class="method-args">(reporter)</span>
           </a>
         </div>
         <div class="method-description">
+          <p>
+Add a new reporter
+</p>
         </div>
       </div>
-      <div id="method-M000099" class="method-detail">
-        <a name="M000099"></a>
+      <div id="method-M000029" class="method-detail">
+        <a name="M000029"></a>
         <div class="method-heading">
-          <a href="Reporting.src/M000099.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporting.src/M000099.html');return false;">
+          <a href="Reporting.src/M000029.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporting.src/M000029.html');return false;">
           <span class="method-name">each_log</span><span class="method-args">(&amp;iter)</span>
           </a>
         </div>
         <div class="method-description">
+          <p>
+Iterate on all log files
+</p>
         </div>
       </div>
-      <div id="method-M000097" class="method-detail">
-        <a name="M000097"></a>
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
         <div class="method-heading">
-          <a href="Reporting.src/M000097.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporting.src/M000097.html');return false;">
+          <a href="Reporting.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporting.src/M000027.html');return false;">
           <span class="method-name">error</span><span class="method-args">(error)</span>
           </a>
         </div>
         <div class="method-description">
+          <p>
+Reports that the build failed to the user
+</p>
         </div>
       </div>
-      <div id="method-M000095" class="method-detail">
-        <a name="M000095"></a>
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
         <div class="method-heading">
-          <a href="Reporting.src/M000095.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporting.src/M000095.html');return false;">
+          <a href="Reporting.src/M000025.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporting.src/M000025.html');return false;">
           <span class="method-name">report</span><span class="method-args">() {|| ...}</span>
           </a>
         </div>
         <div class="method-description">
+          <pre>
+ Run a block and report known exception
+</pre>
+<p>
+If an exception is fatal, the program is terminated using exit()
+</p>
+<p>
+:yield:
+</p>
         </div>
       </div>
-      <div id="method-M000096" class="method-detail">
-        <a name="M000096"></a>
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
         <div class="method-heading">
-          <a href="Reporting.src/M000096.html" target="Code" class="method-signature"
-            onclick="popupCode('Reporting.src/M000096.html');return false;">
+          <a href="Reporting.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('Reporting.src/M000026.html');return false;">
           <span class="method-name">success</span><span class="method-args">()</span>
           </a>
         </div>
         <div class="method-description">
+          <p>
+Reports a successful build to the user
+</p>
         </div>
       </div>

data/doc/classes/Autobuild/Reporting.src/{M000095.html → M000025.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 13</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 23</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">report</span>
             <span class="ruby-keyword kw">begin</span>
                 <span class="ruby-keyword kw">yield</span>

data/doc/classes/Autobuild/Reporting.src/{M000096.html → M000026.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 23</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 34</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">success</span>
             <span class="ruby-ivar">@@reporters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">rep</span>.<span class="ruby-identifier">success</span> <span class="ruby-keyword kw">end</span>
         <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/Autobuild/Reporting.src/{M000097.html → M000027.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 27</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 39</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>)
             <span class="ruby-ivar">@@reporters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">rep</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>) <span class="ruby-keyword kw">end</span>
         <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/Autobuild/Reporting.src/{M000098.html → M000028.html} RENAMED Viewed

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 31</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 44</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">&lt;&lt;</span>(<span class="ruby-identifier">reporter</span>)
             <span class="ruby-ivar">@@reporters</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">reporter</span>
         <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/Autobuild/Reporting.src/{M000099.html → M000029.html} RENAMED Viewed

@@ -10,9 +10,9 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 35</span>
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 49</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each_log</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">iter</span>)
-            <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-node">&quot;#{$LOGDIR}/*.log&quot;</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">iter</span>)
+            <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-node">&quot;#{Autobuild.logdir}/*.log&quot;</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">iter</span>)
         <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Autobuild/Reporting.src/M000053.html ADDED Viewed

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>report (Autobuild::Reporting)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 23</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">report</span>
+            <span class="ruby-keyword kw">begin</span>
+                <span class="ruby-keyword kw">yield</span>
+            <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Autobuild</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+                <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Autobuild</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>)
+                <span class="ruby-identifier">error</span>(<span class="ruby-identifier">e</span>)
+                <span class="ruby-identifier">exit</span>(<span class="ruby-value">1</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">fatal?</span>
+            <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Autobuild/Reporting.src/M000054.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>success (Autobuild::Reporting)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/autobuild/reporting.rb, line 34</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">success</span>
+            <span class="ruby-ivar">@@reporters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rep</span><span class="ruby-operator">|</span> <span class="ruby-identifier">rep</span>.<span class="ruby-identifier">success</span> <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>