282 lines
16 KiB
HTML
282 lines
16 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="content-type" content="text/html;charset=utf-8">
|
||
|
|
<title>rocco.rb</title>
|
||
|
|
<link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id='container'>
|
||
|
|
<table cellspacing=0 cellpadding=0>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class=docs><h1>rocco.rb</h1></th>
|
||
|
|
<th class=code></th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr id='section-1'>
|
||
|
|
<td class=docs><p><strong>Rocco</strong> is a Ruby port of <a href="http://jashkenas.github.com/docco/">Docco</a>, the quick-and-dirty,
|
||
|
|
hundred-line-long, literate-programming-style documentation generator.</p>
|
||
|
|
|
||
|
|
<p>Rocco reads Ruby source files and produces annotated source documentation
|
||
|
|
in HTML format. Comments are formatted with <a href="http://daringfireball.net/projects/markdown/">Markdown</a> and presented
|
||
|
|
alongside syntax highlighted code so as to give an annotation effect.
|
||
|
|
This page is the result of running Rocco against its own source file.</p>
|
||
|
|
|
||
|
|
<p>Most of this was written while waiting for <a href="http://nodejs.org/">node.js</a> to build (so I
|
||
|
|
could use Docco!). Docco’s gorgeous HTML and CSS are taken verbatim.
|
||
|
|
The main difference is that Rocco is written in Ruby instead of
|
||
|
|
<a href="http://coffeescript.org/">CoffeeScript</a> and may be a bit easier to obtain and install in
|
||
|
|
existing Ruby environments or where node doesn’t run yet.</p>
|
||
|
|
|
||
|
|
<p>Rocco can be installed with rubygems:</p>
|
||
|
|
|
||
|
|
<pre><code>gem install rocco
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<p>Once installed, the <code>rocco</code> command can be used to generate documentation
|
||
|
|
for a set of Ruby source files:</p>
|
||
|
|
|
||
|
|
<pre><code>rocco lib/*.rb
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<p>The HTML files are written to the current working directory.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-2'>
|
||
|
|
<td class=docs>
|
||
|
|
<h3>Prerequisites</h3>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-3'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>The <a href="http://github.com/rtomayko/rdiscount">rdiscount</a> library is
|
||
|
|
required for Markdown processing.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre><span class="nb">require</span> <span class="s1">'rdiscount'</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-4'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>We use <a href="http://defunkt.github.com/mustache/">{{ mustache }}</a> for
|
||
|
|
templating.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre><span class="nb">require</span> <span class="s1">'mustache'</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-5'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Code is run through <a href="http://pygments.org/">Pygments</a> for syntax
|
||
|
|
highlighting. Fail fast if we can’t find the <code>pygmentize</code> program.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre><span class="k">if</span> <span class="o">!</span> <span class="no">ENV</span><span class="o">[</span><span class="s1">'PATH'</span><span class="o">].</span><span class="n">split</span><span class="p">(</span><span class="s1">':'</span><span class="p">)</span><span class="o">.</span><span class="n">any?</span> <span class="p">{</span> <span class="o">|</span><span class="n">dir</span><span class="o">|</span> <span class="no">File</span><span class="o">.</span><span class="n">exist?</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">dir</span><span class="si">}</span><span class="s2">/pygmentize"</span><span class="p">)</span> <span class="p">}</span>
|
||
|
|
<span class="nb">fail</span> <span class="s2">"Pygments is required for syntax highlighting"</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-6'>
|
||
|
|
<td class=docs>
|
||
|
|
<h3>Public Interface</h3>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-7'>
|
||
|
|
<td class=docs>
|
||
|
|
<p><code>Rocco.new</code> takes a source <code>filename</code> and an optional <code>block</code>.
|
||
|
|
When <code>block</code> is given, it must read the contents of the file using
|
||
|
|
whatever means necessary and return it as a string. With no <code>block</code>, the
|
||
|
|
file is read to retrieve data.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre><span class="k">class</span> <span class="nc">Rocco</span>
|
||
|
|
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="o">&</span><span class="n">block</span><span class="p">)</span>
|
||
|
|
<span class="vi">@file</span> <span class="o">=</span> <span class="n">filename</span>
|
||
|
|
<span class="vi">@data</span> <span class="o">=</span>
|
||
|
|
<span class="k">if</span> <span class="nb">block_given?</span>
|
||
|
|
<span class="k">yield</span>
|
||
|
|
<span class="k">else</span>
|
||
|
|
<span class="no">File</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
||
|
|
<span class="k">end</span></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-8'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Parsing and highlighting</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="vi">@sections</span> <span class="o">=</span> <span class="n">highlight</span><span class="p">(</span><span class="n">parse</span><span class="p">(</span><span class="vi">@data</span><span class="p">))</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-9'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>The filename as given to <code>Rocco.new</code>.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="kp">attr_reader</span> <span class="ss">:file</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-10'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>A list of two-tuples representing each <em>section</em> of the source file. Each
|
||
|
|
item in the list has the form: <code>[docs_html, code_html]</code>, where both
|
||
|
|
elements are strings containing the documentation and source code HTML,
|
||
|
|
respectively.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="kp">attr_reader</span> <span class="ss">:sections</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-11'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Generate HTML output for the entire document.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="nb">require</span> <span class="s1">'rocco/layout'</span>
|
||
|
|
<span class="k">def</span> <span class="nf">to_html</span>
|
||
|
|
<span class="no">Rocco</span><span class="o">::</span><span class="no">Layout</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">self</span><span class="p">)</span><span class="o">.</span><span class="n">render</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-12'>
|
||
|
|
<td class=docs>
|
||
|
|
<h3>Internal Parsing and Highlighting</h3>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-13'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Parse the raw file data into a list of two-tuples.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||
|
|
<span class="n">sections</span> <span class="o">=</span> <span class="o">[]</span>
|
||
|
|
<span class="n">docs</span><span class="p">,</span> <span class="n">code</span> <span class="o">=</span> <span class="o">[]</span><span class="p">,</span> <span class="o">[]</span>
|
||
|
|
<span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">line</span><span class="o">|</span>
|
||
|
|
<span class="k">case</span> <span class="n">line</span>
|
||
|
|
<span class="k">when</span><span class="sr"> /^\s*#/</span>
|
||
|
|
<span class="k">if</span> <span class="n">code</span><span class="o">.</span><span class="n">any?</span>
|
||
|
|
<span class="n">sections</span> <span class="o"><<</span> <span class="o">[</span><span class="n">docs</span><span class="p">,</span> <span class="n">code</span><span class="o">]</span>
|
||
|
|
<span class="n">docs</span><span class="p">,</span> <span class="n">code</span> <span class="o">=</span> <span class="o">[]</span><span class="p">,</span> <span class="o">[]</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
<span class="n">docs</span> <span class="o"><<</span> <span class="n">line</span>
|
||
|
|
<span class="k">when</span><span class="sr"> /^\s*$/</span>
|
||
|
|
<span class="n">code</span> <span class="o"><<</span> <span class="n">line</span>
|
||
|
|
<span class="k">else</span>
|
||
|
|
<span class="n">code</span> <span class="o"><<</span> <span class="n">line</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
<span class="n">sections</span> <span class="o"><<</span> <span class="o">[</span><span class="n">docs</span><span class="p">,</span> <span class="n">code</span><span class="o">]</span> <span class="k">if</span> <span class="n">docs</span><span class="o">.</span><span class="n">any?</span> <span class="o">||</span> <span class="n">code</span><span class="o">.</span><span class="n">any?</span>
|
||
|
|
<span class="n">sections</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-14'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Take the raw section data and apply markdown formatting and syntax
|
||
|
|
highlighting.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="k">def</span> <span class="nf">highlight</span><span class="p">(</span><span class="n">sections</span><span class="p">)</span></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-15'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Start by splitting the docs and codes blocks into two separate lists.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="n">docs_blocks</span><span class="p">,</span> <span class="n">code_blocks</span> <span class="o">=</span> <span class="o">[]</span><span class="p">,</span> <span class="o">[]</span>
|
||
|
|
<span class="n">sections</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">docs</span><span class="p">,</span><span class="n">code</span><span class="o">|</span>
|
||
|
|
<span class="n">docs_blocks</span> <span class="o"><<</span> <span class="n">docs</span><span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">line</span><span class="o">|</span> <span class="n">line</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sr">/^\s*#\s?/</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="p">}</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
||
|
|
<span class="n">code_blocks</span> <span class="o"><<</span> <span class="n">code</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-16'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Combine all docs blocks into a single big markdown document and run
|
||
|
|
through RDiscount. Then split it back out into separate sections.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="n">markdown</span> <span class="o">=</span> <span class="n">docs_blocks</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">##### DIVIDER</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
||
|
|
<span class="n">docs_html</span> <span class="o">=</span> <span class="no">Markdown</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">markdown</span><span class="p">,</span> <span class="ss">:smart</span><span class="p">)</span><span class="o">.</span>
|
||
|
|
<span class="n">to_html</span><span class="o">.</span>
|
||
|
|
<span class="nb">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2"><h5>DIVIDER</h5></span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-17'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Combine all code blocks into a single big stream and run through
|
||
|
|
pygments. We <code>popen</code> a pygmentize process and then fork off a
|
||
|
|
writer process.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="n">code_html</span> <span class="o">=</span> <span class="kp">nil</span>
|
||
|
|
<span class="nb">open</span><span class="p">(</span><span class="s2">"|pygmentize -l ruby -f html"</span><span class="p">,</span> <span class="s1">'r+'</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">fd</span><span class="o">|</span>
|
||
|
|
<span class="nb">fork</span> <span class="p">{</span>
|
||
|
|
<span class="n">fd</span><span class="o">.</span><span class="n">close_read</span>
|
||
|
|
<span class="n">fd</span><span class="o">.</span><span class="n">write</span> <span class="n">code_blocks</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2"># DIVIDER</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
||
|
|
<span class="n">fd</span><span class="o">.</span><span class="n">close_write</span>
|
||
|
|
<span class="nb">exit!</span>
|
||
|
|
<span class="p">}</span>
|
||
|
|
|
||
|
|
<span class="n">fd</span><span class="o">.</span><span class="n">close_write</span>
|
||
|
|
<span class="n">code_html</span> <span class="o">=</span> <span class="n">fd</span><span class="o">.</span><span class="n">read</span>
|
||
|
|
<span class="n">fd</span><span class="o">.</span><span class="n">close_read</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-18'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Do some post-processing on the pygments output to remove
|
||
|
|
partial <code><pre></code> blocks. We’ll add these back when we build to main
|
||
|
|
document.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="n">code_html</span> <span class="o">=</span> <span class="n">code_html</span><span class="o">.</span>
|
||
|
|
<span class="nb">split</span><span class="p">(</span><span class="sr">/\n?<span class="c1"># DIVIDER<\/span>\n?/m</span><span class="p">)</span><span class="o">.</span>
|
||
|
|
<span class="n">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">code</span><span class="o">|</span> <span class="n">code</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sr">/\n?<div class="highlight"><pre>/m</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="p">}</span><span class="o">.</span>
|
||
|
|
<span class="n">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">code</span><span class="o">|</span> <span class="n">code</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sr">/\n?<\/pre><\/div>\n/m</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="p">}</span>
|
||
|
|
</pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id='section-19'>
|
||
|
|
<td class=docs>
|
||
|
|
<p>Combine the docs and code lists into the same sections style list we
|
||
|
|
started with.</p>
|
||
|
|
</td>
|
||
|
|
<td class=code>
|
||
|
|
<div class='highlight'><pre> <span class="n">docs_html</span><span class="o">.</span><span class="n">zip</span><span class="p">(</span><span class="n">code_html</span><span class="p">)</span>
|
||
|
|
<span class="k">end</span>
|
||
|
|
<span class="k">end</span></pre></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</body>
|