RubyGems - gerbil - Versions diffs - 1.1.0 → 2.0.0 - Mend

gerbil 1.1.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/Rakefile +2 -1
data/bin/gerbil +2 -2
data/doc/api/classes/RDoc.html +2 -54
data/doc/api/classes/RDoc/{DummyOptions.html → AnyMethod.html} +64 -13
data/doc/api/classes/RDoc/AnyMethod.src/M000004.html +18 -0
data/doc/api/classes/RDoc/AnyMethod.src/M000005.html +23 -0
data/doc/api/classes/RDoc/{DummyMixin.src → AnyMethod.src}/M000006.html +4 -4
data/doc/api/classes/RDoc/AnyMethod.src/M000007.html +22 -0
data/doc/api/classes/RDoc/TopLevel.html +250 -0
data/doc/api/classes/RDoc/{DummyOptions.src/M000007.html → TopLevel.src/M000008.html} +4 -4
data/doc/api/classes/RDoc/TopLevel.src/M000009.html +18 -0
data/doc/api/classes/RDoc/TopLevel.src/M000010.html +18 -0
data/doc/api/classes/RDoc/TopLevel.src/M000011.html +29 -0
data/doc/api/classes/RDoc/TopLevel.src/M000012.html +25 -0
data/doc/api/classes/RDoc/TopLevel.src/M000013.html +18 -0
data/doc/api/created.rid +1 -1
data/doc/api/files/lib/gerbil/rdoc_rb.html +1 -1
data/doc/api/files/lib/gerbil_rb.html +2 -2
data/doc/api/fr_class_index.html +2 -3
data/doc/api/fr_method_index.html +10 -4
data/doc/guide.erb +5 -11
data/doc/guide.html +118 -124
data/fmt/html.yaml +23 -9
data/lib/gerbil.rb +12 -2
data/lib/gerbil/rdoc.rb +104 -66
metadata +16 -12
data/doc/api/classes/RDoc.src/M000004.html +0 -26
data/doc/api/classes/RDoc.src/M000005.html +0 -59
data/doc/api/classes/RDoc/DummyMarkup.html +0 -119
data/doc/api/classes/RDoc/DummyMixin.html +0 -131

data/Rakefile CHANGED

@@ -55,5 +55,6 @@ require 'rake/gempackagetask'
 # utility
   desc 'Upload to project website.'
   task :upload => :doc do
-    sh 'rsync -av doc/ ~/www/lib/gerbil'
+    sh "rsync -av doc/ ~/www/lib/#{spec.name}"
+    sh "rsync -av doc/api/ ~/www/lib/#{spec.name}/api/ --delete"
   end

data/bin/gerbil CHANGED

@@ -251,10 +251,10 @@ if __FILE__ == $0 or File.basename(__FILE__) == File.basename($0)
         # replace node with output
         if nodeDefs[n.type]['silent']
-          buf.sub! n.digest, ''
+          buf[n.digest] = ''
           buf = n.output
         else
-          buf.sub! n.digest, n.output
+          buf[n.digest] = n.output
         end
         # repeat for all child nodes

data/doc/api/classes/RDoc.html CHANGED

@@ -76,14 +76,6 @@
    </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000005">gen_method_infos</a>&nbsp;&nbsp;
-      <a href="#M000004">gen_parse_trees</a>&nbsp;&nbsp;
-      </div>
-    </div>
   </div>
@@ -95,9 +87,8 @@
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
-      Module <a href="RDoc/DummyMixin.html" class="link">RDoc::DummyMixin</a><br />
-Class <a href="RDoc/DummyMarkup.html" class="link">RDoc::DummyMarkup</a><br />
-Class <a href="RDoc/DummyOptions.html" class="link">RDoc::DummyOptions</a><br />
+      Class <a href="RDoc/AnyMethod.html" class="link">RDoc::AnyMethod</a><br />
+Class <a href="RDoc/TopLevel.html" class="link">RDoc::TopLevel</a><br />
     </div>
@@ -108,49 +99,6 @@ Class <a href="RDoc/DummyOptions.html" class="link">RDoc::DummyOptions</a><br />
     <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
-        <div class="method-heading">
-          <a href="RDoc.src/M000005.html" target="Code" class="method-signature"
-            onclick="popupCode('RDoc.src/M000005.html');return false;">
-          <span class="method-name">gen_method_infos</span><span class="method-args">(*aParseTrees)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns an array of hashes describing all methods present in the given
-parse trees (which are produced by RDoc::gen_parse_trees).
-</p>
-        </div>
-      </div>
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
-        <div class="method-heading">
-          <a href="RDoc.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('RDoc.src/M000004.html');return false;">
-          <span class="method-name">gen_parse_trees</span><span class="method-args">(aCode, aFileName = __FILE__)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns an array of <a href="RDoc.html">RDoc</a> parse trees for the given
-code. If the file name (which signifies the origin of the given code) is
-given, it MUST have a &quot;.rb&quot; file extension. Otherwise, <a
-href="RDoc.html">RDoc</a> will give you an empty parse tree! :-(
-</p>
-        </div>
-      </div>
-    </div>
   </div>

data/doc/api/classes/RDoc/{DummyOptions.html → AnyMethod.html} RENAMED

@@ -5,7 +5,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>Class: RDoc::DummyOptions</title>
+  <title>Class: RDoc::AnyMethod</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" />
@@ -50,7 +50,7 @@
         <table class="header-table">
         <tr class="top-aligned-row">
           <td><strong>Class</strong></td>
-          <td class="class-name-in-header">RDoc::DummyOptions</td>
+          <td class="class-name-in-header">RDoc::AnyMethod</td>
         </tr>
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
@@ -86,7 +86,10 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000007">quiet</a>&nbsp;&nbsp;
+      <a href="#M000006">comment_html</a>&nbsp;&nbsp;
+      <a href="#M000005">decl</a>&nbsp;&nbsp;
+      <a href="#M000004">full_name</a>&nbsp;&nbsp;
+      <a href="#M000007">top_level</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -94,13 +97,6 @@
     <!-- if includes -->
-    <div id="includes">
-      <h3 class="section-bar">Included Modules</h3>
-      <div id="includes-list">
-        <span class="include-name"><a href="DummyMixin.html">DummyMixin</a></span>
-      </div>
-    </div>
     <div id="section">
@@ -115,17 +111,72 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="AnyMethod.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('AnyMethod.src/M000006.html');return false;">
+          <span class="method-name">comment_html</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a HTML version of this method&#8216;s comment.
+</p>
+        </div>
+      </div>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+        <div class="method-heading">
+          <a href="AnyMethod.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('AnyMethod.src/M000005.html');return false;">
+          <span class="method-name">decl</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a complete method declaration with block parameters and all.
+</p>
+        </div>
+      </div>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+        <div class="method-heading">
+          <a href="AnyMethod.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('AnyMethod.src/M000004.html');return false;">
+          <span class="method-name">full_name</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the fully qualified name of this method.
+</p>
+        </div>
+      </div>
       <div id="method-M000007" class="method-detail">
         <a name="M000007"></a>
         <div class="method-heading">
-          <a href="DummyOptions.src/M000007.html" target="Code" class="method-signature"
-            onclick="popupCode('DummyOptions.src/M000007.html');return false;">
-          <span class="method-name">quiet</span><span class="method-args">(</span>
+          <a href="AnyMethod.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('AnyMethod.src/M000007.html');return false;">
+          <span class="method-name">top_level</span><span class="method-args">()</span>
           </a>
         </div>
         <div class="method-description">
+          <p>
+Returns the <a href="TopLevel.html">RDoc::TopLevel</a> object which
+contains this method.
+</p>
         </div>
       </div>

data/doc/api/classes/RDoc/AnyMethod.src/M000004.html ADDED

@@ -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>full_name (RDoc::AnyMethod)</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/gerbil/rdoc.rb, line 79</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">full_name</span>
+      [<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">full_name</span>, <span class="ruby-identifier">name</span>].<span class="ruby-identifier">join</span>(<span class="ruby-identifier">singleton</span> <span class="ruby-value">? </span><span class="ruby-value str">'::'</span> <span class="ruby-operator">:</span> <span class="ruby-value str">'#'</span>)
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/api/classes/RDoc/AnyMethod.src/M000005.html ADDED

@@ -0,0 +1,23 @@
+<?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>decl (RDoc::AnyMethod)</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/gerbil/rdoc.rb, line 84</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decl</span>
+      <span class="ruby-identifier">a</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">dup</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">b</span> = <span class="ruby-identifier">block_params</span>
+        <span class="ruby-identifier">a</span>.<span class="ruby-identifier">sub!</span> <span class="ruby-regexp re">%r/\s*\#.*(?=.$)/</span>, <span class="ruby-value str">''</span> <span class="ruby-comment cmt"># remove &quot;# :yields: ...&quot; string</span>
+        <span class="ruby-identifier">a</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; {|#{b}| ... }&quot;</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">full_name</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">a</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/api/classes/RDoc/{DummyMixin.src → AnyMethod.src}/M000006.html RENAMED

@@ -5,14 +5,14 @@
 <html>
 <head>
-  <title>method_missing (RDoc::DummyMixin)</title>
+  <title>comment_html (RDoc::AnyMethod)</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/gerbil/rdoc.rb, line 10</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
-      <span class="ruby-comment cmt"># ignore all messages</span>
+  <pre><span class="ruby-comment cmt"># File lib/gerbil/rdoc.rb, line 94</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">comment_html</span>
+      <span class="ruby-constant">DummyMarkup</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">markup</span> <span class="ruby-identifier">comment</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/api/classes/RDoc/AnyMethod.src/M000007.html ADDED

@@ -0,0 +1,22 @@
+<?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>top_level (RDoc::AnyMethod)</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/gerbil/rdoc.rb, line 99</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">top_level</span>
+      <span class="ruby-identifier">n</span> = <span class="ruby-identifier">parent</span>
+      <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">parent</span>
+        <span class="ruby-identifier">n</span> = <span class="ruby-identifier">n</span>.<span class="ruby-identifier">parent</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">n</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/api/classes/RDoc/TopLevel.html ADDED

@@ -0,0 +1,250 @@
+<?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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: RDoc::TopLevel</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" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">RDoc::TopLevel</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/gerbil/rdoc_rb.html">
+                lib/gerbil/rdoc.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000008">all_classes</a>&nbsp;&nbsp;
+      <a href="#M000010">all_methods</a>&nbsp;&nbsp;
+      <a href="#M000009">all_modules</a>&nbsp;&nbsp;
+      <a href="#M000012">parse</a>&nbsp;&nbsp;
+      <a href="#M000013">parse_file</a>&nbsp;&nbsp;
+      <a href="#M000011">refresh_all_classes_and_modules</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+        <div class="method-heading">
+          <a href="TopLevel.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('TopLevel.src/M000008.html');return false;">
+          <span class="method-name">all_classes</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns an array of all classes recorded thus far.
+</p>
+        </div>
+      </div>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <a href="TopLevel.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('TopLevel.src/M000010.html');return false;">
+          <span class="method-name">all_methods</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns an array of <a href="AnyMethod.html">RDoc::AnyMethod</a> objects
+representing all methods recorded thus far.
+</p>
+        </div>
+      </div>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+        <div class="method-heading">
+          <a href="TopLevel.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('TopLevel.src/M000009.html');return false;">
+          <span class="method-name">all_modules</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns an array of all modules recorded thus far.
+</p>
+        </div>
+      </div>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+        <div class="method-heading">
+          <a href="TopLevel.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('TopLevel.src/M000012.html');return false;">
+          <span class="method-name">parse</span><span class="method-args">(aCodeString, aFileName = __FILE__)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a <a href="TopLevel.html">RDoc::TopLevel</a> object containing
+information parsed from the given code string. This information is also
+added to the global <a href="TopLevel.html">TopLevel</a> class state, so
+you can access it via the class methods of the <a
+href="TopLevel.html">TopLevel</a> class.
+</p>
+<p>
+If the file name (which signifies the origin of the given code) is given,
+it MUST have a &quot;.c&quot; or &quot;.rb&quot; file extension. Otherwise,
+<a href="../RDoc.html">RDoc</a> will ignore the given code string! :-(
+</p>
+        </div>
+      </div>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+        <div class="method-heading">
+          <a href="TopLevel.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('TopLevel.src/M000013.html');return false;">
+          <span class="method-name">parse_file</span><span class="method-args">(aFileName)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a <a href="TopLevel.html">RDoc::TopLevel</a> object containing
+information parsed from the code in the given file. This information is
+also added to the global <a href="TopLevel.html">TopLevel</a> class state,
+so you can access it via the class methods of the <a
+href="TopLevel.html">TopLevel</a> class.
+</p>
+<p>
+The given file name MUST have a &quot;.c&quot; or &quot;.rb&quot; file
+extension. Otherwise, <a href="../RDoc.html">RDoc</a> will ignore the file!
+:-(
+</p>
+        </div>
+      </div>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="TopLevel.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('TopLevel.src/M000011.html');return false;">
+          <span class="method-name">refresh_all_classes_and_modules</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Update the return value of the all_classes_and_modules() method to
+<b>really</b> include every class and every module seen thus far.
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>