RbST 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 William Melody
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,66 @@
+# RbST
+
+A simple Ruby wrapper for processing reStructuredText via
+Python's Docutils.
+
+## Installation
+
+Python 2.3+ is required.
+
+RbST is available on gemcutter.
+
+    gem install gemcutter
+    gem tumble
+    gem install RbST
+
+## Usage
+
+    require 'RbST'
+    ...
+    @html = RbST.new('/some/file.rst').to_html
+
+This takes the reStructuredText formatted file and converts it to
+HTML. The first argument can be either a file or a string.
+
+You can also use the `#convert` class method:
+
+    puts RbST.convert('/some/file.rst')
+
+When no options are passed, the default behavior converts
+reStructuredText to html. Options supported include
+`:cloak_email_addresses` and `:strip_comments`, either of which can
+be simply included as additional arguments.
+
+    puts RbST.convert(".. a comment", :strip_comments) # => '<div class="document">\n</div>'
+
+Document parts can also be specified with the `:parts` option.
+
+    puts RbST.convert("hello world", :part => :fragment) # => '<p>hello world</p>'
+
+By default, RbST uses the `html_body` part.
+
+For more information on reStructuredText, see the
+[ReST documentation](http://docutils.sourceforge.net/rst.html).
+
+## Caveats
+
+-   Docutils is very slow. On my 2.5 GHz Core 2 Duo it takes over
+    half a second to convert the test file to HTML, including about 0.2s
+    to start up and 0.38s to process the input data.
+-   This has only been tested on \*nix systems.
+-   Python 3 has not been tested.
+
+## Note on Patches/Pull Requests
+
+-   Fork the project.
+-   Make your feature addition or bug fix.
+-   Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+-   Commit, do not mess with rakefile, version, or history. (if you
+    want to have your own version, that is fine but bump version in a
+    commit by itself I can ignore when I pull)
+-   Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 William Melody. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "RbST"
+    gem.summary = %Q{A simple Ruby wrapper for processing reStructuredText via Python's Docutils}
+    gem.description = %Q{A simple Ruby wrapper for processing reStructuredText via Python's Docutils}
+    gem.email = "wmelody@gmail.com"
+    gem.homepage = "http://github.com/autodata/rbst"
+    gem.authors = ["William Melody"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "open4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "RbST #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/RbST.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{RbST}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["William Melody"]
+  s.date = %q{2009-11-01}
+  s.description = %q{A simple Ruby wrapper for processing reStructuredText via Python's Docutils}
+  s.email = %q{wmelody@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "RbST.gemspec",
+     "VERSION",
+     "lib/rbst.rb",
+     "lib/rst2parts.py",
+     "test/files/test.html",
+     "test/files/test.rst",
+     "test/test_helper.rb",
+     "test/test_rbst.rb"
+  ]
+  s.homepage = %q{http://github.com/autodata/rbst}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A simple Ruby wrapper for processing reStructuredText via Python's Docutils}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_rbst.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<open4>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<open4>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<open4>, [">= 0"])
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rbst.rb

@@ -0,0 +1,49 @@
+require 'open4'
+
+class RbST
+
+  def self.convert(*args)
+    new(*args).convert
+  end
+
+  def initialize(*args)
+    target = args.shift
+    @target  = File.exists?(target) ? File.read(target) : target rescue target
+    @options = args
+  end
+
+  def convert
+    executable = File.join(File.dirname(__FILE__), 'rst2parts.py')
+    execute "python #{executable}" + convert_options
+  end
+  alias_method :to_s, :convert
+  
+  def to_html
+    @options << {:writer_name => :html}
+    convert
+  end
+  
+private
+
+  def execute(command)
+    output = ''
+    Open4::popen4(command) do |pid, stdin, stdout, stderr| 
+      stdin.puts @target 
+      stdin.close
+      output = stdout.read.strip 
+    end
+    output
+  end
+
+  def convert_options
+    @options.inject('') do |string, opt|
+      string + if opt.respond_to?(:each_pair)
+        opt.inject('') do |s, (flag, val)|
+          s + (flag.to_s.length == 1 ? " -#{flag} #{val}" : " --#{flag}=#{val}")
+        end
+      else
+        opt.to_s.length == 1 ? " -#{opt}" : " --#{opt}"
+      end
+    end
+  end
+end

data/lib/rst2parts.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+
+import sys
+from optparse import OptionParser
+from docutils.core import publish_parts
+
+def main():
+    p = OptionParser()
+    
+    p.add_option('--cloak_email_addresses', action="store_true", default=False)
+    p.add_option('--strip_comments', action="store_true", default=False)
+    p.add_option('--writer_name', default="html")
+    p.add_option('--part', default="html_body")
+    
+    opts, args = p.parse_args()
+    
+    settings = {
+        'file_insertion_enabled': False,
+        'raw_enabled': False,
+        'cloak_email_addresses': opts.cloak_email_addresses,
+        'strip_comments': opts.strip_comments,
+    }
+
+    if len(args) == 1:
+        try:
+            content = open(args[0], 'r').read()
+        except IOError:
+            content = args[0]
+    else:
+        content = sys.stdin.read()
+
+    parts = publish_parts(
+        source=content,
+        settings_overrides=settings,
+        writer_name=opts.writer_name,
+    )
+
+    if opts.part in parts:
+        return parts[opts.part]
+    return ''
+
+if __name__ == '__main__':
+    print(main())

data/test/files/test.html

@@ -0,0 +1,335 @@
+<div class="document" id="the-restructuredtext-cheat-sheet-syntax-reminders">
+<h1 class="title">The <a class="reference external" href="http://docutils.sf.net/rst.html">reStructuredText</a> Cheat Sheet: Syntax Reminders</h1>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr class="field"><th class="docinfo-name">Info:</th><td class="field-body">See &lt;<a class="reference external" href="http://docutils.sf.net/rst.html">http://docutils.sf.net/rst.html</a>&gt; for introductory docs.</td>
+</tr>
+<tr><th class="docinfo-name">Author:</th>
+<td>David Goodger &lt;<a class="reference external" href="mailto:goodger&#64;python.org">goodger&#64;python.org</a>&gt;</td></tr>
+<tr><th class="docinfo-name">Date:</th>
+<td>2006-01-23</td></tr>
+<tr><th class="docinfo-name">Revision:</th>
+<td>4321</td></tr>
+<tr class="field"><th class="docinfo-name">Description:</th><td class="field-body">This is a &quot;docinfo block&quot;, or bibliographic field list</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="section-structure">
+<h1>Section Structure</h1>
+<p>Section titles are underlined or overlined &amp; underlined.</p>
+</div>
+<div class="section" id="body-elements">
+<h1>Body Elements</h1>
+<p>Grid table:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="48%" />
+<col width="52%" />
+</colgroup>
+<tbody valign="top">
+<tr><td><p class="first">Paragraphs are flush-left,
+separated by blank lines.</p>
+<blockquote class="last">
+Block quotes are indented.</blockquote>
+</td>
+<td rowspan="2"><p class="first">Literal block, preceded by &quot;::&quot;:</p>
+<pre class="literal-block">
+Indented
+</pre>
+<p>or:</p>
+<pre class="last literal-block">
+&gt; Quoted
+</pre>
+</td>
+</tr>
+<tr><td><pre class="first last doctest-block">
+&gt;&gt;&gt; print 'Doctest block'
+Doctest block
+</pre>
+</td>
+</tr>
+<tr><td colspan="2"><div class="first last line-block">
+<div class="line">Line blocks preserve line breaks &amp; indents. [new in 0.3.6]</div>
+<div class="line-block">
+<div class="line">Useful for addresses, verse, and adornment-free lists; long
+lines can be wrapped with continuation lines.</div>
+</div>
+</div>
+</td>
+</tr>
+</tbody>
+</table>
+<p>Simple tables:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">List Type</th>
+<th class="head">Examples</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>Bullet list</td>
+<td><ul class="first last simple">
+<li>items begin with &quot;-&quot;, &quot;+&quot;, or &quot;*&quot;</li>
+</ul>
+</td>
+</tr>
+<tr><td>Enumerated list</td>
+<td><ol class="first last arabic simple">
+<li>items use any variation of &quot;1.&quot;, &quot;A)&quot;, and &quot;(i)&quot;</li>
+<li>also auto-enumerated</li>
+</ol>
+</td>
+</tr>
+<tr><td>Definition list</td>
+<td><dl class="first last docutils">
+<dt>Term is flush-left <span class="classifier-delimiter">:</span> <span class="classifier">optional classifier</span></dt>
+<dd>Definition is indented, no blank line between</dd>
+</dl>
+</td>
+</tr>
+<tr><td>Field list</td>
+<td><table class="first last docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">field name:</th><td class="field-body">field body</td>
+</tr>
+</tbody>
+</table>
+</td>
+</tr>
+<tr><td>Option list</td>
+<td><table class="first last docutils option-list" frame="void" rules="none">
+<col class="option" />
+<col class="description" />
+<tbody valign="top">
+<tr><td class="option-group">
+<kbd><span class="option">-o</span></kbd></td>
+<td>at least 2 spaces between option &amp; description</td></tr>
+</tbody>
+</table>
+</td>
+</tr>
+</tbody>
+</table>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Explicit Markup</th>
+<th class="head">Examples (visible in the <a class="reference external" href="cheatsheet.txt">text source</a>)</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>Footnote</td>
+<td><table class="first last docutils footnote" frame="void" id="id1" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id3">[1]</a></td><td>Manually numbered or [#] auto-numbered
+(even [#labelled]) or [*] auto-symbol</td></tr>
+</tbody>
+</table>
+</td>
+</tr>
+<tr><td>Citation</td>
+<td><table class="first last docutils citation" frame="void" id="cit2002" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id4">[CIT2002]</a></td><td>A citation.</td></tr>
+</tbody>
+</table>
+</td>
+</tr>
+<tr><td>Hyperlink Target</td>
+<td></td>
+</tr>
+<tr id="internal-target"><td>Anonymous Target</td>
+<td></td>
+</tr>
+<tr><td>Directive (&quot;::&quot;)</td>
+<td><img alt="images/biohazard.png" class="first last" src="images/biohazard.png" />
+</td>
+</tr>
+<tr><td>Substitution Def</td>
+<td></td>
+</tr>
+<tr><td>Comment</td>
+<td><!-- is anything else -->
+</td>
+</tr>
+<tr><td>Empty Comment</td>
+<td>(&quot;..&quot; on a line by itself, with blank lines before &amp; after,
+used to separate indentation contexts)</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="inline-markup">
+<h1>Inline Markup</h1>
+<p><em>emphasis</em>; <strong>strong emphasis</strong>; <cite>interpreted text</cite>; <em>interpreted text
+with role</em>; <tt class="docutils literal"><span class="pre">inline</span> <span class="pre">literal</span> <span class="pre">text</span></tt>; standalone hyperlink,
+<a class="reference external" href="http://docutils.sourceforge.net">http://docutils.sourceforge.net</a>; named reference, <a class="reference external" href="http://docutils.sf.net/rst.html">reStructuredText</a>;
+<a class="reference external" href="http://docutils.sf.net/docs/ref/rst/restructuredtext.html">anonymous reference</a>; footnote reference, <a class="footnote-reference" href="#id1" id="id3">[1]</a>; citation reference,
+<a class="citation-reference" href="#cit2002" id="id4">[CIT2002]</a>; like an inline directive; <span class="target" id="inline-internal-target">inline internal target</span>.</p>
+</div>
+<div class="section" id="directive-quick-reference">
+<h1>Directive Quick Reference</h1>
+<p>See &lt;<a class="reference external" href="http://docutils.sf.net/docs/ref/rst/directives.html">http://docutils.sf.net/docs/ref/rst/directives.html</a>&gt; for full info.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Directive Name</th>
+<th class="head">Description (Docutils version added to, in [brackets])</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>attention</td>
+<td>Specific admonition; also &quot;caution&quot;, &quot;danger&quot;,
+&quot;error&quot;, &quot;hint&quot;, &quot;important&quot;, &quot;note&quot;, &quot;tip&quot;, &quot;warning&quot;</td>
+</tr>
+<tr><td>admonition</td>
+<td>Generic titled admonition: <tt class="docutils literal"><span class="pre">..</span> <span class="pre">admonition::</span> <span class="pre">By</span> <span class="pre">The</span> <span class="pre">Way</span></tt></td>
+</tr>
+<tr><td>image</td>
+<td><tt class="docutils literal"><span class="pre">..</span> <span class="pre">image::</span> <span class="pre">picture.png</span></tt>; many options possible</td>
+</tr>
+<tr><td>figure</td>
+<td>Like &quot;image&quot;, but with optional caption and legend</td>
+</tr>
+<tr><td>topic</td>
+<td><tt class="docutils literal"><span class="pre">..</span> <span class="pre">topic::</span> <span class="pre">Title</span></tt>; like a mini section</td>
+</tr>
+<tr><td>sidebar</td>
+<td><tt class="docutils literal"><span class="pre">..</span> <span class="pre">sidebar::</span> <span class="pre">Title</span></tt>; like a mini parallel document</td>
+</tr>
+<tr><td>parsed-literal</td>
+<td>A literal block with parsed inline markup</td>
+</tr>
+<tr><td>rubric</td>
+<td><tt class="docutils literal"><span class="pre">..</span> <span class="pre">rubric::</span> <span class="pre">Informal</span> <span class="pre">Heading</span></tt></td>
+</tr>
+<tr><td>epigraph</td>
+<td>Block quote with class=&quot;epigraph&quot;</td>
+</tr>
+<tr><td>highlights</td>
+<td>Block quote with class=&quot;highlights&quot;</td>
+</tr>
+<tr><td>pull-quote</td>
+<td>Block quote with class=&quot;pull-quote&quot;</td>
+</tr>
+<tr><td>compound</td>
+<td>Compound paragraphs [0.3.6]</td>
+</tr>
+<tr><td>container</td>
+<td>Generic block-level container element [0.3.10]</td>
+</tr>
+<tr><td>table</td>
+<td>Create a titled table [0.3.1]</td>
+</tr>
+<tr><td>list-table</td>
+<td>Create a table from a uniform two-level bullet list [0.3.8]</td>
+</tr>
+<tr><td>csv-table</td>
+<td>Create a table from CSV data (requires Python 2.3+) [0.3.4]</td>
+</tr>
+<tr><td>contents</td>
+<td>Generate a table of contents</td>
+</tr>
+<tr><td>sectnum</td>
+<td>Automatically number sections, subsections, etc.</td>
+</tr>
+<tr><td>header, footer</td>
+<td>Create document decorations [0.3.8]</td>
+</tr>
+<tr><td>target-notes</td>
+<td>Create an explicit footnote for each external target</td>
+</tr>
+<tr><td>meta</td>
+<td>HTML-specific metadata</td>
+</tr>
+<tr><td>include</td>
+<td>Read an external reST file as if it were inline</td>
+</tr>
+<tr><td>raw</td>
+<td>Non-reST data passed untouched to the Writer</td>
+</tr>
+<tr><td>replace</td>
+<td>Replacement text for substitution definitions</td>
+</tr>
+<tr><td>unicode</td>
+<td>Unicode character code conversion for substitution defs</td>
+</tr>
+<tr><td>date</td>
+<td>Generates today's date; for substitution defs</td>
+</tr>
+<tr><td>class</td>
+<td>Set a &quot;class&quot; attribute on the next element</td>
+</tr>
+<tr><td>role</td>
+<td>Create a custom interpreted text role [0.3.2]</td>
+</tr>
+<tr><td>default-role</td>
+<td>Set the default interpreted text role [0.3.10]</td>
+</tr>
+<tr><td>title</td>
+<td>Set the metadata document title [0.3.10]</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="interpreted-text-role-quick-reference">
+<h1>Interpreted Text Role Quick Reference</h1>
+<p>See &lt;<a class="reference external" href="http://docutils.sf.net/docs/ref/rst/roles.html">http://docutils.sf.net/docs/ref/rst/roles.html</a>&gt; for full info.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Role Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>emphasis</td>
+<td>Equivalent to <em>emphasis</em></td>
+</tr>
+<tr><td>literal</td>
+<td>Equivalent to <tt class="docutils literal"><span class="pre">literal</span></tt> but processes backslash escapes</td>
+</tr>
+<tr><td>PEP</td>
+<td>Reference to a numbered Python Enhancement Proposal</td>
+</tr>
+<tr><td>RFC</td>
+<td>Reference to a numbered Internet Request For Comments</td>
+</tr>
+<tr><td>raw</td>
+<td>For non-reST data; cannot be used directly (see docs) [0.3.6]</td>
+</tr>
+<tr><td>strong</td>
+<td>Equivalent to <strong>strong</strong></td>
+</tr>
+<tr><td>sub</td>
+<td>Subscript</td>
+</tr>
+<tr><td>sup</td>
+<td>Superscript</td>
+</tr>
+<tr><td>title</td>
+<td>Title reference (book, etc.); standard default role</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>

data/test/files/test.rst

@@ -0,0 +1,127 @@
+=====================================================
+ The reStructuredText_ Cheat Sheet: Syntax Reminders
+=====================================================
+:Info: See <http://docutils.sf.net/rst.html> for introductory docs.
+:Author: David Goodger <goodger@python.org>
+:Date: $Date: 2006-01-23 02:13:55 +0100 (Mon, 23 Jän 2006) $
+:Revision: $Revision: 4321 $
+:Description: This is a "docinfo block", or bibliographic field list
+
+Section Structure
+=================
+Section titles are underlined or overlined & underlined.
+
+Body Elements
+=============
+Grid table:
+
++--------------------------------+-----------------------------------+
+| Paragraphs are flush-left,     | Literal block, preceded by "::":: |
+| separated by blank lines.      |                                   |
+|                                |     Indented                      |
+|     Block quotes are indented. |                                   |
++--------------------------------+ or::                              |
+| >>> print 'Doctest block'      |                                   |
+| Doctest block                  | > Quoted                          |
++--------------------------------+-----------------------------------+
+| | Line blocks preserve line breaks & indents. [new in 0.3.6]       |
+| |     Useful for addresses, verse, and adornment-free lists; long  |
+|       lines can be wrapped with continuation lines.                |
++--------------------------------------------------------------------+
+
+Simple tables:
+
+================  ============================================================
+List Type         Examples
+================  ============================================================
+Bullet list       * items begin with "-", "+", or "*"
+Enumerated list   1. items use any variation of "1.", "A)", and "(i)"
+                  #. also auto-enumerated
+Definition list   Term is flush-left : optional classifier
+                      Definition is indented, no blank line between
+Field list        :field name: field body
+Option list       -o  at least 2 spaces between option & description
+================  ============================================================
+
+================  ============================================================
+Explicit Markup   Examples (visible in the `text source <cheatsheet.txt>`_)
+================  ============================================================
+Footnote          .. [1] Manually numbered or [#] auto-numbered
+                     (even [#labelled]) or [*] auto-symbol
+Citation          .. [CIT2002] A citation.
+Hyperlink Target  .. _reStructuredText: http://docutils.sf.net/rst.html
+                  .. _indirect target: reStructuredText_
+                  .. _internal target:
+Anonymous Target  __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html
+Directive ("::")  .. image:: images/biohazard.png
+Substitution Def  .. |substitution| replace:: like an inline directive
+Comment           .. is anything else
+Empty Comment     (".." on a line by itself, with blank lines before & after,
+                  used to separate indentation contexts)
+================  ============================================================
+
+Inline Markup
+=============
+*emphasis*; **strong emphasis**; `interpreted text`; `interpreted text
+with role`:emphasis:; ``inline literal text``; standalone hyperlink,
+http://docutils.sourceforge.net; named reference, reStructuredText_;
+`anonymous reference`__; footnote reference, [1]_; citation reference,
+[CIT2002]_; |substitution|; _`inline internal target`.
+
+Directive Quick Reference
+=========================
+See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info.
+
+================  ============================================================
+Directive Name    Description (Docutils version added to, in [brackets])
+================  ============================================================
+attention         Specific admonition; also "caution", "danger",
+                  "error", "hint", "important", "note", "tip", "warning"
+admonition        Generic titled admonition: ``.. admonition:: By The Way``
+image             ``.. image:: picture.png``; many options possible
+figure            Like "image", but with optional caption and legend
+topic             ``.. topic:: Title``; like a mini section
+sidebar           ``.. sidebar:: Title``; like a mini parallel document
+parsed-literal    A literal block with parsed inline markup
+rubric            ``.. rubric:: Informal Heading``
+epigraph          Block quote with class="epigraph"
+highlights        Block quote with class="highlights"
+pull-quote        Block quote with class="pull-quote"
+compound          Compound paragraphs [0.3.6]
+container         Generic block-level container element [0.3.10]
+table             Create a titled table [0.3.1]
+list-table        Create a table from a uniform two-level bullet list [0.3.8]
+csv-table         Create a table from CSV data (requires Python 2.3+) [0.3.4]
+contents          Generate a table of contents
+sectnum           Automatically number sections, subsections, etc.
+header, footer    Create document decorations [0.3.8]
+target-notes      Create an explicit footnote for each external target
+meta              HTML-specific metadata
+include           Read an external reST file as if it were inline
+raw               Non-reST data passed untouched to the Writer
+replace           Replacement text for substitution definitions
+unicode           Unicode character code conversion for substitution defs
+date              Generates today's date; for substitution defs
+class             Set a "class" attribute on the next element
+role              Create a custom interpreted text role [0.3.2]
+default-role      Set the default interpreted text role [0.3.10]
+title             Set the metadata document title [0.3.10]
+================  ============================================================
+
+Interpreted Text Role Quick Reference
+=====================================
+See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info.
+
+================  ============================================================
+Role Name         Description
+================  ============================================================
+emphasis          Equivalent to *emphasis*
+literal           Equivalent to ``literal`` but processes backslash escapes
+PEP               Reference to a numbered Python Enhancement Proposal
+RFC               Reference to a numbered Internet Request For Comments
+raw               For non-reST data; cannot be used directly (see docs) [0.3.6]
+strong            Equivalent to **strong**
+sub               Subscript
+sup               Superscript
+title             Title reference (book, etc.); standard default role
+================  ============================================================

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rbst'
+
+class Test::Unit::TestCase
+end

data/test/test_rbst.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'mocha'
+
+class TestRbST < Test::Unit::TestCase
+  def setup
+    @rst_file = File.join(File.dirname(__FILE__), 'files', 'test.rst')
+    @html_file = File.join(File.dirname(__FILE__), 'files', 'test.html')
+  end
+  
+  should "call bare rest2parts when passed no options" do
+    converter = RbST.new(@rst_file)
+    converter.expects(:execute).with('python ./test/../lib/rst2parts.py').returns(true)
+    assert converter.convert
+  end
+  
+  should "convert ReST to html" do
+    html = RbST.new(@rst_file).to_html
+    assert_equal html, File.read(@html_file)
+  end
+  
+  should "recognize strip_comments option" do
+    html_with_comment = RbST.convert(".. comment")
+    assert_equal html_with_comment, %Q{<div class="document">\n<!-- comment -->\n</div>}
+    html_without_comment = RbST.convert(".. comment", :strip_comments)
+    assert_equal html_without_comment, %Q{<div class="document">\n</div>}
+  end
+  
+  should "recognize cloak_email_addresses option" do
+    html_with_uncloaked_email = RbST.convert("steve@mac.com")
+    assert_equal %Q{<div class="document">\n<p><a class="reference external" href="mailto:steve&#64;mac.com">steve&#64;mac.com</a></p>\n</div>}, html_with_uncloaked_email
+    html_with_cloaked_email = RbST.convert("steve@mac.com", :cloak_email_addresses)
+    assert_equal %Q{<div class="document">\n<p><a class="reference external" href="mailto:steve&#37;&#52;&#48;mac&#46;com">steve<span>&#64;</span>mac<span>&#46;</span>com</a></p>\n</div>}, html_with_cloaked_email
+  end
+  
+  should "recognize part option" do
+    html_body = RbST.convert("hello world", :part => :html_body)
+    assert_equal %Q{<div class="document">\n<p>hello world</p>\n</div>}, html_body
+    fragment = RbST.convert("hello world", :part => :fragment)
+    assert_equal %Q{<p>hello world</p>}, fragment
+  end
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: RbST
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- William Melody
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A simple Ruby wrapper for processing reStructuredText via Python's Docutils
+email: wmelody@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- RbST.gemspec
+- VERSION
+- lib/rbst.rb
+- lib/rst2parts.py
+- test/files/test.html
+- test/files/test.rst
+- test/test_helper.rb
+- test/test_rbst.rb
+has_rdoc: true
+homepage: http://github.com/autodata/rbst
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple Ruby wrapper for processing reStructuredText via Python's Docutils
+test_files: 
+- test/test_helper.rb
+- test/test_rbst.rb