RbST 0.0.1 → 0.0.2

data/.document

@@ -1,4 +1,4 @@
-README.rdoc
+README.markdown
 lib/**/*.rb
 bin/*
 features/**/*.feature

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 rdoc
 pkg
+*.pyc

data/README.markdown

@@ -1,13 +1,12 @@
 # RbST
 
-A simple Ruby wrapper for processing reStructuredText via
-Python's Docutils.
+A simple Ruby wrapper for processing reStructuredText via Python's Docutils.
 
 ## Installation
 
 Python 2.3+ is required.
 
-RbST is available on gemcutter.
+RbST is available on [gemcutter](http://gemcutter.org/gems/RbST).
 
     gem install gemcutter
     gem tumble
@@ -18,35 +17,40 @@ RbST is available on gemcutter.
     require 'RbST'
     ...
     @html = RbST.new('/some/file.rst').to_html
+    # or
+    @latex = RbST.new('*hello*').to_latex
 
-This takes the reStructuredText formatted file and converts it to
-HTML. The first argument can be either a file or a string.
+This takes the reStructuredText formatted file and converts it to either HTML or LaTeX. 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.
+When no options are passed, the default behavior converts reStructuredText to html using the default settings. Other arguments are simply converted into command line options, accepting symbols or strings for options without arguments and hashes of strings or symbols for options with arguments.
 
-    puts RbST.convert(".. a comment", :strip_comments) # => '<div class="document">\n</div>'
+    puts RbST.convert(".. a comment", 'strip-comments')
+    # => '<div class="document">\n</div>'
+
+Options passed as string use hyphens while symbols use underscores. For instance, the above could also be written as:
+
+    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>'
+    puts RbST.convert("hello world", :part => :fragment)
+    # => '<p>hello world</p>'
+
+By default, RbST uses the `html_body` part for HTML and the `whole` part for LaTeX.
 
-By default, RbST uses the `html_body` part.
+Available options can be viewed using the `RbST.html_options` and `RbST.latex_options` class methods.
 
 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.
+-   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. In other words, this isn't the sort of thing you'd want to be using directly in a Rails view helper.
 -   This has only been tested on \*nix systems.
 -   Python 3 has not been tested.
 
@@ -54,11 +58,8 @@ For more information on reStructuredText, see the
 
 -   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)
+-   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

data/Rakefile

@@ -8,9 +8,10 @@ begin
     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.homepage = "http://rdoc.info/projects/autodata/rbst"
     gem.authors = ["William Melody"]
     gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "mocha"
     gem.add_dependency "open4"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/RbST.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{RbST}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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.date = %q{2009-11-04}
   s.description = %q{A simple Ruby wrapper for processing reStructuredText via Python's Docutils}
   s.email = %q{wmelody@gmail.com}
   s.extra_rdoc_files = [
@@ -25,13 +25,17 @@ Gem::Specification.new do |s|
      "RbST.gemspec",
      "VERSION",
      "lib/rbst.rb",
-     "lib/rst2parts.py",
+     "lib/rst2parts/__init__.py",
+     "lib/rst2parts/rst2html.py",
+     "lib/rst2parts/rst2latex.py",
+     "lib/rst2parts/transform.py",
      "test/files/test.html",
+     "test/files/test.latex",
      "test/files/test.rst",
      "test/test_helper.rb",
      "test/test_rbst.rb"
   ]
-  s.homepage = %q{http://github.com/autodata/rbst}
+  s.homepage = %q{http://rdoc.info/projects/autodata/rbst}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
@@ -47,13 +51,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_runtime_dependency(%q<open4>, [">= 0"])
     else
       s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<open4>, [">= 0"])
     end
   else
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<open4>, [">= 0"])
   end
 end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rbst.rb

@@ -1,30 +1,66 @@
 require 'open4'
 
 class RbST
-
+  
+  # Takes a string or file path plus any additional options and converts the input.
   def self.convert(*args)
     new(*args).convert
   end
-
+  
+  # Print LaTeX-Specific Options, General Docutils Options and reStructuredText Parser Options.
+  def self.latex_options
+    new.print_options(:latex)
+  end
+  
+  # Print HTML-Specific Options, General Docutils Options and reStructuredText Parser Options.
+  def self.html_options
+    new.print_options(:html)
+  end
+  
+  # Takes a string or file path plus any additional options and creates a new converter object.
   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
+  def convert(writer = :html) # :nodoc:
+    execute "python #{RbST.executable(writer)}" + convert_options
   end
   alias_method :to_s, :convert
   
+  # Converts the object's input to HTML.
   def to_html
-    @options << {:writer_name => :html}
-    convert
+    convert(:html)
+  end
+  
+  # Converts the object's input to LaTeX.
+  def to_latex
+    convert(:latex)
+  end
+  
+  # Formats and prints the options from the docutils help in the way they'd be specified in RbST: strings, symbols and hashes.
+  def print_options(format)
+    help = execute("python #{RbST.executable(format)} --help")
+    # non-hyphenated long options to symbols
+    help.gsub!(/(\-\-)([A-Za-z0-9]+)([=|\s])/, ':\2\3')
+    # hyphenated long options to quoted strings
+    help.gsub!(/(\-\-)([\w|\-]+)(\n)?[^$|^=|\]]?/, '\'\2\'\3')
+    # equal to hashrocket
+    help.gsub!(/\=/, ' => ')
+    # hort options to symbols
+    help.gsub!(/([^\w])\-(\w)([^\w])/, '\1:\2\1')
+    # short options with args get a hashrocket
+    help.gsub!(/(:\w) </, '\1 => <')
+    puts help
   end
   
 private
-
+  
+  def self.executable(writer = :html)
+    File.join(File.dirname(__FILE__), "rst2parts", "rst2#{writer}.py")
+  end
+  
   def execute(command)
     output = ''
     Open4::popen4(command) do |pid, stdin, stdout, stderr| 
@@ -38,12 +74,17 @@ private
   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
+        convert_opts_with_args(opt)
       else
-        opt.to_s.length == 1 ? " -#{opt}" : " --#{opt}"
+        opt.to_s.length == 1 ? " -#{opt}" : " --#{opt.to_s.gsub(/_/, '-')}"
       end
     end
   end
+  
+  def convert_opts_with_args(opt)
+    opt.inject('') do |string, (flag, val)|
+      flag = flag.to_s.gsub(/_/, '-')
+      string + (flag.length == 1 ? " -#{flag} #{val}" : " --#{flag}=#{val}")
+    end
+  end
 end

data/lib/rst2parts/rst2html.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from transform import transform
+from docutils.writers.html4css1 import Writer
+
+def main():
+    return transform(writer=Writer(), part='html_body')
+
+if __name__ == '__main__':
+    print(main())

data/lib/rst2parts/rst2latex.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from transform import transform
+from docutils.writers.latex2e import Writer
+
+def main():
+    return transform(writer=Writer(), part='whole')
+
+if __name__ == '__main__':
+    print(main())
+

data/lib/rst2parts/transform.py

@@ -0,0 +1,40 @@
+import sys
+from docutils.core import publish_parts
+from optparse import OptionParser
+from docutils.frontend import OptionParser as DocutilsOptionParser
+from docutils.parsers.rst import Parser
+
+def transform(writer=None, part=None):
+    p = OptionParser(add_help_option=False)
+    
+    # Collect all the command line options
+    docutils_parser = DocutilsOptionParser(components=(writer, Parser()))
+    for group in docutils_parser.option_groups:
+        p.add_option_group(group.title, None).add_options(group.option_list)
+    
+    p.add_option('--part', default=part)
+    
+    opts, args = p.parse_args()
+    
+    settings = dict({
+        'file_insertion_enabled': False,
+        'raw_enabled': False,
+    }, **opts.__dict__)
+    
+    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=writer,
+    )
+    
+    if opts.part in parts:
+        return parts[opts.part]
+    return ''

data/test/files/test.latex

@@ -0,0 +1,572 @@
+\documentclass[10pt,a4paper,english]{article}
+\usepackage{babel}
+\usepackage{ae}
+\usepackage{aeguill}
+\usepackage{shortvrb}
+\usepackage{ucs}
+\usepackage[utf8x]{inputenc}
+\usepackage{tabularx}
+\usepackage{longtable}
+\setlength{\extrarowheight}{2pt}
+\usepackage{amsmath}
+\usepackage{graphicx}
+\usepackage{color}
+\usepackage{multirow}
+\usepackage{ifthen}
+\usepackage[DIV12]{typearea}
+% generated by Docutils <http://docutils.sourceforge.net/>
+\newlength{\admonitionwidth}
+\setlength{\admonitionwidth}{0.9\textwidth}
+\newlength{\docinfowidth}
+\setlength{\docinfowidth}{0.9\textwidth}
+\newlength{\locallinewidth}
+\newcommand{\optionlistlabel}[1]{\bf #1 \hfill}
+\newenvironment{optionlist}[1]
+{\begin{list}{}
+  {\setlength{\labelwidth}{#1}
+   \setlength{\rightmargin}{1cm}
+   \setlength{\leftmargin}{\rightmargin}
+   \addtolength{\leftmargin}{\labelwidth}
+   \addtolength{\leftmargin}{\labelsep}
+   \renewcommand{\makelabel}{\optionlistlabel}}
+}{\end{list}}
+\newlength{\lineblockindentation}
+\setlength{\lineblockindentation}{2.5em}
+\newenvironment{lineblock}[1]
+{\begin{list}{}
+  {\setlength{\partopsep}{\parskip}
+   \addtolength{\partopsep}{\baselineskip}
+   \topsep0pt\itemsep0.15\baselineskip\parsep0pt
+   \leftmargin#1}
+ \raggedright}
+{\end{list}}
+% begin: floats for footnotes tweaking.
+\setlength{\floatsep}{0.5em}
+\setlength{\textfloatsep}{\fill}
+\addtolength{\textfloatsep}{3em}
+\renewcommand{\textfraction}{0.5}
+\renewcommand{\topfraction}{0.5}
+\renewcommand{\bottomfraction}{0.5}
+\setcounter{totalnumber}{50}
+\setcounter{topnumber}{50}
+\setcounter{bottomnumber}{50}
+% end floats for footnotes
+% some commands, that could be overwritten in the style file.
+\newcommand{\rubric}[1]{\subsection*{~\hfill {\it #1} \hfill ~}}
+\newcommand{\titlereference}[1]{\textsl{#1}}
+% end of "some commands"
+\ifthenelse{\isundefined{\hypersetup}}{
+\usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
+}{}
+\title{The reStructuredText Cheat Sheet: Syntax Reminders}
+\author{}
+\date{}
+\hypersetup{
+pdftitle={The reStructuredText Cheat Sheet: Syntax Reminders},
+pdfauthor={David Goodger {\textless}goodger@python.org{\textgreater}}
+}
+\raggedbottom
+\begin{document}
+\maketitle
+%___________________________________________________________________________
+\begin{center}
+\begin{tabularx}{\docinfowidth}{lX}
+\textbf{Info}: &
+	See {\textless}http://docutils.sf.net/rst.html{\textgreater} for introductory docs. \\
+\textbf{Author}: &
+	David Goodger {\textless}\href{mailto:goodger@python.org}{goodger@python.org}{\textgreater} \\
+\textbf{Date}: &
+	2006-01-23 \\
+\textbf{Revision}: &
+	4321 \\
+\textbf{Description}: &
+	This is a ``docinfo block'', or bibliographic field list \\
+\end{tabularx}
+\end{center}
+
+\setlength{\locallinewidth}{\linewidth}
+
+
+
+
+%___________________________________________________________________________
+
+\hypertarget{section-structure}{}
+\pdfbookmark[0]{Section Structure}{section-structure}
+\section*{Section Structure}
+\label{section-structure}
+
+Section titles are underlined or overlined {\&} underlined.
+
+
+%___________________________________________________________________________
+
+\hypertarget{body-elements}{}
+\pdfbookmark[0]{Body Elements}{body-elements}
+\section*{Body Elements}
+\label{body-elements}
+
+Grid table:
+
+\leavevmode
+\begin{longtable}[c]{|p{0.389\locallinewidth}|p{0.424\locallinewidth}|}
+\hline
+
+Paragraphs are flush-left,
+separated by blank lines.
+\begin{quote}
+
+Block quotes are indented.
+\end{quote}
+ & \multirow{2}{0.42\locallinewidth}{
+Literal block, preceded by ``::'':
+
+{\ttfamily \raggedright \noindent
+Indented
+}
+
+or:
+
+{\ttfamily \raggedright \noindent
+>~Quoted
+}
+} \\
+\cline{1-1}
+\begin{verbatim}>>> print 'Doctest block'
+Doctest block\end{verbatim}
+ &  \\
+\hline
+\multicolumn{2}{|l|}{
+\begin{lineblock}{0em}
+\item[] Line blocks preserve line breaks {\&} indents. {[}new in 0.3.6{]}
+\item[] 
+\begin{lineblock}{\lineblockindentation}
+\item[] Useful for addresses, verse, and adornment-free lists; long
+lines can be wrapped with continuation lines.
+\end{lineblock}
+\end{lineblock}
+} \\
+\hline
+\end{longtable}
+
+Simple tables:
+
+\leavevmode
+\begin{longtable}[c]{|p{0.203\locallinewidth}|p{0.714\locallinewidth}|}
+\hline
+\textbf{
+List Type
+} & \textbf{
+Examples
+} \\
+\hline
+\endhead
+
+Bullet list
+ & \begin{itemize}
+\item {} 
+items begin with ``-'', ``+'', or ``*''
+
+\end{itemize}
+ \\
+\hline
+
+Enumerated list
+ & \newcounter{listcnt0}
+\begin{list}{\arabic{listcnt0}.}
+{
+\usecounter{listcnt0}
+\setlength{\rightmargin}{\leftmargin}
+}
+\item {} 
+items use any variation of ``1.'', ``A)'', and ``(i)''
+
+\item {} 
+also auto-enumerated
+
+\end{list}
+ \\
+\hline
+
+Definition list
+ & \begin{description}
+\item[{Term is flush-left}] \leavevmode (\textbf{optional classifier})
+
+Definition is indented, no blank line between
+
+\end{description}
+ \\
+\hline
+
+Field list
+ & \begin{quote}
+\begin{description}
+\item [field name:]
+field body
+
+
+\end{description}
+\end{quote}
+ \\
+\hline
+
+Option list
+ & \begin{optionlist}{3cm}
+\item [-o]  
+at least 2 spaces between option {\&} description
+\end{optionlist}
+ \\
+\hline
+\end{longtable}
+
+\leavevmode
+\begin{longtable}[c]{|p{0.203\locallinewidth}|p{0.714\locallinewidth}|}
+\hline
+\textbf{
+Explicit Markup
+} & \textbf{
+Examples (visible in the \href{cheatsheet.txt}{text source})
+} \\
+\hline
+\endhead
+
+Footnote
+ & \begin{figure}[b]\hypertarget{id1}$^{1}$
+Manually numbered or {[}{\#}{]} auto-numbered
+(even {[}{\#}labelled{]}) or {[}*{]} auto-symbol
+\end{figure}
+ \\
+\hline
+
+Citation
+ & \begin{figure}[b]\hypertarget{cit2002}[CIT2002]
+A citation.
+\end{figure}
+ \\
+\hline
+
+Hyperlink Target
+ & \hypertarget{internal-target}{} \\
+\hline
+
+Anonymous Target
+ &  \\
+\hline
+
+Directive (``::'')
+ & 
+\includegraphics{images/biohazard.png}
+ \\
+\hline
+
+Substitution Def
+ &  \\
+\hline
+
+Comment
+ & % is anything else 
+ \\
+\hline
+
+Empty Comment
+ & 
+(``..'' on a line by itself, with blank lines before {\&} after,
+used to separate indentation contexts)
+ \\
+\hline
+\end{longtable}
+
+
+%___________________________________________________________________________
+
+\hypertarget{inline-markup}{}
+\pdfbookmark[0]{Inline Markup}{inline-markup}
+\section*{Inline Markup}
+\label{inline-markup}
+
+\emph{emphasis}; \textbf{strong emphasis}; \titlereference{interpreted text}; \emph{interpreted text
+with role}; \texttt{inline literal text}; standalone hyperlink,
+\href{http://docutils.sourceforge.net}{http://docutils.sourceforge.net}; named reference, \href{http://docutils.sf.net/rst.html}{reStructuredText};
+\href{http://docutils.sf.net/docs/ref/rst/restructuredtext.html}{anonymous reference}; footnote reference,\raisebox{.5em}[0em]{\scriptsize\hyperlink{id1}{1}}; citation reference,
+[\hyperlink{cit2002}{CIT2002}]; like an inline directive; \hypertarget{inline-internal-target}{inline internal target}.
+
+
+%___________________________________________________________________________
+
+\hypertarget{directive-quick-reference}{}
+\pdfbookmark[0]{Directive Quick Reference}{directive-quick-reference}
+\section*{Directive Quick Reference}
+\label{directive-quick-reference}
+
+See {\textless}\href{http://docutils.sf.net/docs/ref/rst/directives.html}{http://docutils.sf.net/docs/ref/rst/directives.html}{\textgreater} for full info.
+
+\leavevmode
+\begin{longtable}[c]{|p{0.203\locallinewidth}|p{0.714\locallinewidth}|}
+\hline
+\textbf{
+Directive Name
+} & \textbf{
+Description (Docutils version added to, in {[}brackets{]})
+} \\
+\hline
+\endhead
+
+attention
+ & 
+Specific admonition; also ``caution'', ``danger'',
+``error'', ``hint'', ``important'', ``note'', ``tip'', ``warning''
+ \\
+\hline
+
+admonition
+ & 
+Generic titled admonition: \texttt{.. admonition:: By The Way}
+ \\
+\hline
+
+image
+ & 
+\texttt{.. image:: picture.png}; many options possible
+ \\
+\hline
+
+figure
+ & 
+Like ``image'', but with optional caption and legend
+ \\
+\hline
+
+topic
+ & 
+\texttt{.. topic:: Title}; like a mini section
+ \\
+\hline
+
+sidebar
+ & 
+\texttt{.. sidebar:: Title}; like a mini parallel document
+ \\
+\hline
+
+parsed-literal
+ & 
+A literal block with parsed inline markup
+ \\
+\hline
+
+rubric
+ & 
+\texttt{.. rubric:: Informal Heading}
+ \\
+\hline
+
+epigraph
+ & 
+Block quote with class=``epigraph''
+ \\
+\hline
+
+highlights
+ & 
+Block quote with class=``highlights''
+ \\
+\hline
+
+pull-quote
+ & 
+Block quote with class=``pull-quote''
+ \\
+\hline
+
+compound
+ & 
+Compound paragraphs {[}0.3.6{]}
+ \\
+\hline
+
+container
+ & 
+Generic block-level container element {[}0.3.10{]}
+ \\
+\hline
+
+table
+ & 
+Create a titled table {[}0.3.1{]}
+ \\
+\hline
+
+list-table
+ & 
+Create a table from a uniform two-level bullet list {[}0.3.8{]}
+ \\
+\hline
+
+csv-table
+ & 
+Create a table from CSV data (requires Python 2.3+) {[}0.3.4{]}
+ \\
+\hline
+
+contents
+ & 
+Generate a table of contents
+ \\
+\hline
+
+sectnum
+ & 
+Automatically number sections, subsections, etc.
+ \\
+\hline
+
+header, footer
+ & 
+Create document decorations {[}0.3.8{]}
+ \\
+\hline
+
+target-notes
+ & 
+Create an explicit footnote for each external target
+ \\
+\hline
+
+meta
+ & 
+HTML-specific metadata
+ \\
+\hline
+
+include
+ & 
+Read an external reST file as if it were inline
+ \\
+\hline
+
+raw
+ & 
+Non-reST data passed untouched to the Writer
+ \\
+\hline
+
+replace
+ & 
+Replacement text for substitution definitions
+ \\
+\hline
+
+unicode
+ & 
+Unicode character code conversion for substitution defs
+ \\
+\hline
+
+date
+ & 
+Generates today's date; for substitution defs
+ \\
+\hline
+
+class
+ & 
+Set a ``class'' attribute on the next element
+ \\
+\hline
+
+role
+ & 
+Create a custom interpreted text role {[}0.3.2{]}
+ \\
+\hline
+
+default-role
+ & 
+Set the default interpreted text role {[}0.3.10{]}
+ \\
+\hline
+
+title
+ & 
+Set the metadata document title {[}0.3.10{]}
+ \\
+\hline
+\end{longtable}
+
+
+%___________________________________________________________________________
+
+\hypertarget{interpreted-text-role-quick-reference}{}
+\pdfbookmark[0]{Interpreted Text Role Quick Reference}{interpreted-text-role-quick-reference}
+\section*{Interpreted Text Role Quick Reference}
+\label{interpreted-text-role-quick-reference}
+
+See {\textless}\href{http://docutils.sf.net/docs/ref/rst/roles.html}{http://docutils.sf.net/docs/ref/rst/roles.html}{\textgreater} for full info.
+
+\leavevmode
+\begin{longtable}[c]{|p{0.203\locallinewidth}|p{0.726\locallinewidth}|}
+\hline
+\textbf{
+Role Name
+} & \textbf{
+Description
+} \\
+\hline
+\endhead
+
+emphasis
+ & 
+Equivalent to \emph{emphasis}
+ \\
+\hline
+
+literal
+ & 
+Equivalent to \texttt{literal} but processes backslash escapes
+ \\
+\hline
+
+PEP
+ & 
+Reference to a numbered Python Enhancement Proposal
+ \\
+\hline
+
+RFC
+ & 
+Reference to a numbered Internet Request For Comments
+ \\
+\hline
+
+raw
+ & 
+For non-reST data; cannot be used directly (see docs) {[}0.3.6{]}
+ \\
+\hline
+
+strong
+ & 
+Equivalent to \textbf{strong}
+ \\
+\hline
+
+sub
+ & 
+Subscript
+ \\
+\hline
+
+sup
+ & 
+Superscript
+ \\
+\hline
+
+title
+ & 
+Title reference (book, etc.); standard default role
+ \\
+\hline
+\end{longtable}
+
+\end{document}

data/test/test_rbst.rb

@@ -3,13 +3,17 @@ 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')
+    [:rst, :html, :latex].each do |f|
+      instance_variable_set(
+        :"@#{f}_file",
+        File.join(File.dirname(__FILE__), 'files', "test.#{f}")
+      )
+    end
   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)
+    converter.expects(:execute).with('python ./test/../lib/rst2parts/rst2html.py').returns(true)
     assert converter.convert
   end
   
@@ -18,17 +22,22 @@ class TestRbST < Test::Unit::TestCase
     assert_equal html, File.read(@html_file)
   end
   
+  should "convert ReST to LaTeX" do
+    latex = RbST.new(@rst_file).to_latex
+    assert_equal latex, File.read(@latex_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)
+    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)
+    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
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: RbST
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - William Melody
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-01 00:00:00 -05:00
+date: 2009-11-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  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
@@ -50,13 +60,17 @@ files:
 - RbST.gemspec
 - VERSION
 - lib/rbst.rb
-- lib/rst2parts.py
+- lib/rst2parts/__init__.py
+- lib/rst2parts/rst2html.py
+- lib/rst2parts/rst2latex.py
+- lib/rst2parts/transform.py
 - test/files/test.html
+- test/files/test.latex
 - test/files/test.rst
 - test/test_helper.rb
 - test/test_rbst.rb
 has_rdoc: true
-homepage: http://github.com/autodata/rbst
+homepage: http://rdoc.info/projects/autodata/rbst
 licenses: []
 
 post_install_message: 

data/lib/rst2parts.py

@@ -1,43 +0,0 @@
-#!/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())