papyrus 0.0.1

data/VERSION.txt

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

data/data/main.tex.erb

@@ -0,0 +1,186 @@
+\documentclass[a4paper,11pt]{article}
+
+% This file is part of RDoc PDF LaTeX.
+% 
+% RDoc PDF LaTeX is a RDoc plugin for generating PDF files.
+% Copyright © 2011  Pegasus Alpha
+% 
+% RDoc PDF LaTeX is free software; you can redistribute it and/or modify
+% it under the terms of the GNU General Public License as published by
+% the Free Software Foundation; either version 2 of the License, or
+% (at your option) any later version.
+% 
+% RDoc PDF LaTeX is distributed in the hope that it will be useful,
+% but WITHOUT ANY WARRANTY; without even the implied warranty of
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+% GNU General Public License for more details.
+% 
+% You should have received a copy of the GNU General Public License
+% along with RDoc PDF LaTeX; if not, write to the Free Software
+% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+% Variables used for the ERB template:
+%
+% babel_lang:              Something like "ngerman", determines the babel language
+%                          to load.
+% doc_title:               Title of the documentation.
+% @rdoc_files:             List of RDoc::TopLevel objects for all found files 
+%                          (first one will become the title file).
+% @classes_and_modules:    List of RDoc::ClassModule objects for all found classes 
+%                          and modules.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Packages
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\usepackage[<%= babel_lang %>]{babel} %Hyphenation, etc.
+\usepackage[utf8]{inputenc} %Input encoding: UTF-8
+\usepackage[T1]{fontenc} %Output encoding: T1
+\usepackage{lmodern} %Pretty fonts for T1
+\usepackage{textcomp} %Useful things like \textdegree
+\usepackage[official]{eurosym} %Official \euro symbol
+\usepackage{lastpage} %Get a reference on the last page
+\usepackage[lmargin=3cm,rmargin=3cm,bmargin=2cm]{geometry}
+\usepackage{fancyhdr} %Headers and footers
+\usepackage{fancyvrb} %Better verbatim text
+\usepackage{longtable}
+%\usepackage{amsmath} %For math
+%\usepackage{amsfonts} %Math fonts
+%\usepackage[retainorgcmds]{IEEEtrantools} %For equations
+%\usepackage{listings} %Syntax hightlighting
+\usepackage{xcolor} %Colored text
+%\usepackage{graphicx} %Graphics
+\usepackage{titlesec} %Easily define new heading styles
+\usepackage{titletoc} %For telling LaTeX where to put the new headings in the TOC
+\usepackage[unicode=true,pdftex]{hyperref} %For hyperlinks
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% General information
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\author{\LaTeX PDF generator for RDoc}
+\title{<%= doc_title %>}
+\date{\today}
+
+%Generate TOC only till level 2
+\setcounter{tocdepth}{2}
+%Disable section numbering
+\setcounter{secnumdepth}{-2}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% New commands and environments
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% TODO: Make this a LaTeX package?
+
+\titleclass{\subsubsubsection}{straight}[\subsubsection]
+\titleformat{\subsubsubsection}[hang]{\raggedleft\sffamily\bfseries}{%
+  \thesubsubsubsection}{1em}{}[\vspace{-3mm}\rule{\textwidth}{1pt}]
+\titlespacing{\subsubsubsection}{0pt}{*1}{\baselineskip}
+\newcounter{subsubsubsection}
+\renewcommand{\thesubsubsubsection}{\thesubsubsection.\arabic{subsubsubsection}}
+\titlecontents{subsubsubsection}[0pt]{}{\thecontentslabel}{}{\titlerule*[8pt]{.}\contentspage}
+
+\titleclass{\microsection}{straight}[\subsubsubsection]
+\titleformat{\microsection}[hang]{\vspace{\baselineskip}\sffamily\small\bfseries\slshape}{%
+  \themicrosection}{1em}{}
+\titlespacing{\microsection}{0pt}{*1}{\baselineskip}
+\newcounter{microsection}
+\renewcommand{\themicrosection}{\thesubsubsubsection.\arabic{microsection}}
+\titlecontents{microsection}[0pt]{}{\thecontentslabel}{}{\titlerule*[8pt]{.}\contentspage}
+
+\titleformat{\part}[hang]{\normalfont\LARGE\scshape\color{blue}}{\thepart}{1em}{}[\vspace{-3mm}\rule{0.6\textwidth}{1mm}]
+\titlespacing{\part}{-1cm}{0pt}{\baselineskip}
+
+\newcommand{\class}[2]{\subsection[#1]{{\normalfont\textsc{Class}} {#1}}\vspace{-3mm}{\footnotesize Parent: \texttt{#2}\par\vspace{\baselineskip}}}
+\newcommand{\module}[1]{\subsection[#1]{{\normalfont\textsc{Module}} {#1}}}
+\newcommand{\method}[1]{\subsubsubsection*{#1}}
+
+
+%Code without specification
+\newcommand{\code}[1]{\texttt{#1}}
+
+%Environments for RDoc’s lists
+%1. Completely lower-alpha list
+\newenvironment{lalphaenum}{
+  \renewcommand{\theenumi}{\alph{enumi}}
+  \renewcommand{\theenumii}{\alph{enumii}}
+  \renewcommand{\theenumiii}{\alph{enumiii}}
+  \renewcommand{\theenumiv}{\alph{enumiv}}
+  \begin{enumerate}}{
+  \end{enumerate}
+}
+
+%2. Completely upper-alpha list
+\newenvironment{ualphaenum}{
+  \renewcommand{\theenumi}{\Alph{enumi}}
+  \renewcommand{\theenumii}{\Alph{enumii}}
+  \renewcommand{\theenumiii}{\Alph{enumiii}}
+  \renewcommand{\theenumiv}{\Alph{enumiv}}
+  \begin{enumerate}}{
+  \end{enumerate}
+}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Package-specific settings
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% fancyvrb
+\fvset{fontsize=\scriptsize}
+
+% hyperref
+\hypersetup{colorlinks=true,urlcolor=blue}
+\hypersetup{pdfauthor={Papyrus generator for RDoc},pdftitle={<%= doc_title %>}}
+
+% fancyhdr
+\pagestyle{fancy}
+\fancyhf{} %Delete everything
+\fancyhead[L]{\rightmark}
+\fancyhead[R]{\thepage{} / \pageref*{LastPage}}
+\setlength{\headheight}{14.5pt} %Otherwise LaTeX complains
+\renewcommand{\headrulewidth}{0.4pt}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Document start
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{document}
+
+\begin{titlepage}
+  \begin{center}
+    \Huge <%= doc_title %>
+  \end{center}
+  \begin{flushright}
+    \rule{4.5cm}{0.1cm}\\
+    \normalsize Generated \today\\
+    \tiny by the Papyrus generator for RDoc
+  \end{flushright}
+\end{titlepage}
+
+% Typeset the title page (if any) before the TOC
+%<% if (title_file = @rdoc_files.shift) %>
+\input{<%= render_rdoc_file(title_file) %>}
+%<% end %>
+
+\hypersetup{linkcolor=black} %Red TOC looks absolutely awful
+\tableofcontents
+\hypersetup{linkcolor=red} %Restore original link color
+\clearpage
+%
+%Typeset the other RDOc files after the TOC
+%<% @rdoc_files.each do |file| %>
+\input{<%= render_rdoc_file(file) %>}
+%<% end %>
+
+\part{Generated Documentation}
+
+\section{Methods overview}
+<%= generate_method_toc_table %>
+
+\clearpage
+
+\section{Class and module reference}
+<% @classes_and_modules.each do |mod| %>
+  \input{<%= render_module(mod) %>}\clearpage %Always start a new page for a new class/module
+<% end %>
+
+\end{document}

data/data/module.tex.erb

@@ -0,0 +1,110 @@
+% This file is part of RDoc PDF LaTeX.
+% 
+% RDoc PDF LaTeX is a RDoc plugin for generating PDF files.
+% Copyright © 2011  Pegasus Alpha
+% 
+% RDoc PDF LaTeX is free software; you can redistribute it and/or modify
+% it under the terms of the GNU General Public License as published by
+% the Free Software Foundation; either version 2 of the License, or
+% (at your option) any later version.
+% 
+% RDoc PDF LaTeX is distributed in the hope that it will be useful,
+% but WITHOUT ANY WARRANTY; without even the implied warranty of
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+% GNU General Public License for more details.
+% 
+% You should have received a copy of the GNU General Public License
+% along with RDoc PDF LaTeX; if not, write to the Free Software
+% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+% This ERB template takes the following variables:
+% mod: The module or class (RDoc::ClassModule) to document
+%
+%<% if mod.module? %>
+\module{<%= mod.latexized :full_name %>}\label{<%= mod.latex_label %>}
+% <% else %>
+\class{<%= mod.latexized :full_name %>}{<%= superclass_string(mod.superclass) %>}\label{<%= mod.latex_label %>}
+%<% end %>
+
+<%= mod.description %>
+
+%<% unless mod.method_list.empty? %>
+\subsubsection*{Method list}
+<%= generate_method_table(mod.method_list) %>
+%<% end %>
+
+%<% unless mod.includes.empty? %>
+\subsubsection*{Included Modules}
+\begin{itemize}
+%  <% mod.includes.sort_by{|i| i.name}.each do |inc| %>
+\item \texttt{<%= inc.latexized :full_name %>}
+%  <% end %>
+\end{itemize}
+%<% end %>
+
+%<% consts = mod.constants.sort_by{|c| c.name} %>
+%<% unless consts.empty? %>
+\subsubsection*{Constants}
+
+\begin{longtable}{p{0.3\textwidth}|p{0.2\textwidth}|p{0.4\textwidth}}
+  \bfseries Name & \bfseries Value & \bfseries Description \\
+  \hline
+\endhead
+%  <% consts.each do |const| %>
+\label{<%= const.latex_label %>}%
+\small{\code{<%= const.latexized :name %>}} & %
+\small{\code{<%= const.latexized_value %>}} & %
+<%= const.description %> \\
+& & \\ %Empty row for readability
+%  <%  end %>
+\end{longtable}
+%<% end %>
+
+%<% unless mod.attributes.empty? %>
+\subsubsection*{Attributes}
+\begin{description}
+%  <% mod.attributes.sort_by{|a| a.name}.each do |att| %>
+\item[\texttt{<%= att.latexized :name %>}]
+    \textsf{[<%= att.rw %>]} \label{<%= att.latex_label %>}<%= att.description %>
+%  <% end %>
+\end{description}
+%<% end %>
+
+%<% unless mod.aliases.empty? %>
+\subsubsection*{Aliases}
+\begin{itemize}
+%  <% mod.aliases.sort_by{|a| a.name}.each do |al| %>
+\item \texttt{<%= al.latexized :old_name %>} $\to$ \texttt{<%= al.latexized :new_name %>}
+%  <% end %>
+\end{itemize}
+%<% end %>
+
+%<% [["Public class methods", true, :public],
+   ["Protected class methods", true, :protected],
+   ["Private class methods", true, :private],
+   ["Public instance methods", false, :public],
+   ["Protected instance methods", false, :protected],
+   ["Private instance methods", false, :private]].each do |caption, is_singleton, visibility| %>
+% <% meths = mod.method_list.select{|m|m.singleton == is_singleton && m.visibility == visibility}.sort_by{|m| m.name}%>
+%
+% <% unless meths.empty? %>
+\subsubsection*{<%= caption %>}
+%   <% meths.each do |meth| %>
+\method{<%= meth.latexized :pretty_name %>}
+\label{<%= meth.latex_label %>}
+
+\begin{Verbatim}
+<%= meth.arglists %>
+\end{Verbatim}
+
+%     <% unless meth.aliases.empty? %>
+\marginpar{\footnotesize\emph{Aliases: <%= meth.aliases.map{|m| hyperref_method(m, false)}.join(", ") %>}}
+%     <% end %>
+%     <% if meth.is_alias_for %>
+\noindent \emph{Alias for <%= hyperref(meth.latex_label, meth.is_alias_for.latexized(:pretty_name)) %>}
+%     <% else %>
+\noindent <%= meth.description %>
+%     <% end %>
+%   <% end %>
+% <% end %>
+%<% end %>

data/data/rdoc_file.tex.erb

@@ -0,0 +1,26 @@
+% This file is part of RDoc PDF LaTeX.
+% 
+% RDoc PDF LaTeX is a RDoc plugin for generating PDF files.
+% Copyright © 2011  Pegasus Alpha
+% 
+% RDoc PDF LaTeX is free software; you can redistribute it and/or modify
+% it under the terms of the GNU General Public License as published by
+% the Free Software Foundation; either version 2 of the License, or
+% (at your option) any later version.
+% 
+% RDoc PDF LaTeX is distributed in the hope that it will be useful,
+% but WITHOUT ANY WARRANTY; without even the implied warranty of
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+% GNU General Public License for more details.
+% 
+% You should have received a copy of the GNU General Public License
+% along with RDoc PDF LaTeX; if not, write to the Free Software
+% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+% This ERB template takes the following variables:
+% rdoc_file: The RDoc::TopLevel do document
+%
+\part{<%= rdoc_file.latexized :name %>}
+
+<%= rdoc_file.description %>
+\clearpage

data/lib/rdoc/discover.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Papyrus.
+# 
+# Papyrus is a RDoc plugin for generating PDF files.
+# Copyright © 2011  Pegasus Alpha
+# 
+# Papyrus is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+# 
+# Papyrus is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Papyrus; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require_relative "generator/papyrus"

data/lib/rdoc/generator/latex_markup.rb

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Papyrus.
+# 
+# Papyrus is a RDoc plugin for generating PDF files.
+# Copyright © 2011  Pegasus Alpha
+# 
+# Papyrus is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+# 
+# Papyrus is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Papyrus; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+#Mixin module mixed into RDoc::CodeObject subclasses in order
+#to overwrite RDoc’s standard RDoc::Generator::Markup mixin module that
+#forces RDoc to HTML output. This module forces RDoc to LaTeX output ;-).
+#
+#Note that just mixing this into RDoc::CodeObject isn’t enough as the
+#RDoc::Generator::Markup module is mixed into the subclasses and
+#would therefore take precedence during method lookup.
+module RDoc::Generator::LaTeX_Markup
+
+  #Create an unique label for this CodeObject.
+  #==Return value
+  #A string (hopefully) uniquely identifying this CodeObject. Intended for
+  #use as the reference in a <tt>\href</tt> command.
+  #==Raises
+  #[PapyrusError] +self+ isn’t a CodeObject (→ Context::Section).
+  def latex_label
+    case self
+    when RDoc::Context then "class-module-#{full_name}"
+    when RDoc::MethodAttr then "method-attr-#{full_name.gsub('#', '+')}" # '#' doesn’t work in references
+    when RDoc::Constant then "const-#{parent.full_name}::#{name}"
+    else
+      raise(RDoc::Generator::Papyrus::PapyrusError, "Unrecognized token: #{self.inspect}!")
+    end
+  end
+
+  #Calls a method of this CodeObject and passes the return value
+  #to RDoc::Markup::ToLaTeX#escape.
+  #==Parameter
+  #[symbol] The symbol of the method (or attribute getter, same in Ruby) to call.
+  #[*args]  Any arguments to pass to the method.
+  #[&block] A block to pass to the method.
+  #==Return value
+  #A string from which everything LaTeXnically dangerous has been escaped.
+  #==Raises
+  #[NoMethodError] You passed a +symbol+ of an undefined method.
+  def latexized(symbol, *args, &block)
+    if respond_to?(symbol)
+      formatter.escape(send(symbol, *args, &block).to_s) #formatter method defined below
+    else
+      raise(NoMethodError, "Requested call to unknown method #{self.class}##{symbol} to be latexized!")
+    end
+  end
+  
+  #Instanciates the LaTeX formatter if it is necessary and stores it
+  #in an instance variable @formatter. This method is automatically
+  #called by RDoc to obtain the formatter this generator wants
+  #to use.
+  #==Return value
+  #Returns the newly instanciated or already stored LaTeX formatter.
+  def formatter
+    return @formatter if defined?(@formatter)
+
+    @formatter = RDoc::Markup::ToLaTeX_Crossref.new(self.kind_of?(RDoc::Context) ? self : @parent, #Thanks to RDoc for this
+                                                    current_heading_level,
+                                                    RDoc::RDoc.current.options.show_hash,
+                                                    RDoc::RDoc.current.options.show_pages,
+                                                    RDoc::RDoc.current.options.hyperlink_all)
+  end
+  
+  #Heading depth the formatter is currently in. This is added to
+  #any heading request the processed markup mades in order to ensure
+  #that the correct LaTeX heading order is always preserved. For example,
+  #if the user orders a level 2 heading in a file (the README for instance),
+  #he gets a larger heading as if he had ordered a level 2 heading inside a
+  #method description.
+  def current_heading_level
+    case self
+    when RDoc::TopLevel then 0
+    when RDoc::ClassModule then 1 #Never-ever use level 1 headings apart from TopLevels...
+    when RDoc::MethodAttr, RDoc::Alias, RDoc::Constant, RDoc::Include then 3
+    else
+      0
+    end
+  end
+end
+
+#FIXME:
+#This *doesn't* overwrite the inclusion in the subclasses that
+#RDoc::Generator::Markup does!! Therefore I need to monkeypatch
+#the subclasses affected by the monkeypatch in markup.rb (RDoc::
+#Generator::Markup) as well! YEAH, workarounds for the workarounds!
+
+#class RDoc::CodeObject
+#  include RDoc::Generator::LaTeX_Markup
+#end
+
+#Note that RDoc::Context::Section is special, as it doesn't inherit
+#from RDoc::CodeObject. For the rest, refer to the comment above.
+[RDoc::Context::Section, RDoc::AnyMethod, RDoc::Attr, RDoc::Include, RDoc::Alias, RDoc::Constant, RDoc::Context].each do |klass|
+  klass.send(:include, RDoc::Generator::LaTeX_Markup) #private method
+end
+
+class RDoc::Constant
+
+  #No more characters than specified here will be shown
+  #as a constant’s value. If the content is longer, an
+  #ellipsis will be put at the end of the value.
+  LATEX_VALUE_LENGTH = 10
+
+  #Shortens the value to LATEX_VALUE_LENGTH characters (plus ellipsis ...)
+  #and escapes all LaTeX control characters.
+  def latexized_value
+    if value.chars.count > LATEX_VALUE_LENGTH
+      str = formatter.escape(value.chars.first(LATEX_VALUE_LENGTH).join) + "\\ldots"
+    else
+      str = formatter.escape(value)
+    end
+    str
+  end
+end
+
+class RDoc::AnyMethod
+  include Comparable
+  
+  #Compares two methods with each other. A method is considered smaller
+  #than another if it is a class method. If +self+ and +other+ are both
+  #of the same type (either "class" or "instance"), they’re compared
+  #alphabetically.
+  #==Parameter
+  #[other] The other method to compare with.
+  #==Return value
+  #-1 if +self+ is smaller than +other+, 0 if they’re equal and
+  #+1 if +self+ is bigger than +other+. +nil+ if +other+ isn’t
+  #a RDoc::AnyMethod.
+  #==Example
+  #  m1.name #=> foo
+  #  m1.type #=> instance
+  #  m2.name #=> bar
+  #  m2.type #=> instance
+  #  m3.name #=> foo
+  #  m3.type #=> class
+  #  
+  #  m1 <=> m2 #=> 1
+  #  m2 <=> m1 #=> -1
+  #  m1 <=> m3 #=> 1
+  #  m3 <=> m1 #=> -1
+  #  m2 <=> m2 #=> 0
+  def <=>(other)
+    return nil unless other.kind_of?(RDoc::AnyMethod)
+    
+    if type == "class" and other.type == "class" #RDoc uses strings, not symbols?
+      name <=> other.name
+    elsif type == "class" and other.type == "instance"
+      -1
+    elsif type == "instance" and other.type == "class"
+        1
+    elsif type == "instance" and other.type == "instance"
+      name <=> other.name
+    else #Shouldn’t be
+      nil
+    end
+  end
+end