polytexnic 0.5.0

data/spec/to_html/table_of_contents_spec.rb

@@ -0,0 +1,93 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe '\chapter' do
+    let(:polytex) do <<-'EOS'
+        \tableofcontents
+        \chapter{Foo}
+        \label{cha:foo}
+
+        \section{Bar}
+        \label{sec:bar}
+
+        \subsection{Baz}
+        \label{sec:baz}
+
+        \subsubsection{Null}
+        \label{sec:null}
+
+        \section{Quux}
+        \label{sec:quux}
+
+        \chapter{Lorem}
+        \label{cha:lorem}
+
+      EOS
+    end
+
+    let(:output) do <<-'EOS'
+<h1 class="contents">Contents</h1>
+<div id="table_of_contents">
+<ul>
+  <li class="chapter"><a href="#cha-foo" class="heading hyperref"><span class="number">Chapter 1 </span>Foo</a></li>
+  <li>
+    <ul>
+      <li class="section"><a href="#sec-bar" class="heading hyperref"><span class="number">1.1 </span>Bar</a></li>
+      <li>
+        <ul>
+          <li class="subsection"><a href="#sec-baz" class="heading hyperref"><span class="number">1.1.1 </span>Baz</a></li>
+        </ul>
+      </li>
+      <li class="section">
+       <a href="#sec-quux" class="heading hyperref"><span class="number">1.2 </span>Quux</a></li>
+    </ul>
+  </li>
+  <li class="chapter"><a href="#cha-lorem" class="heading hyperref"><span class="number">Chapter 2 </span>Lorem</a></li>
+</ul>
+</div>
+      EOS
+    end
+
+    it { should resemble output }
+
+    describe "HTML structure" do
+      subject(:toc) do
+        Nokogiri::HTML(processed_text).css('div#table_of_contents')
+      end
+
+      it { should_not be_empty }
+
+      it "should have a 'depth' attribute" do
+        expect(toc.first['depth']).to be_nil
+      end
+
+      it "should have a link to the first chapter" do
+        expect(toc.css('li>a')[0]['href']).to eq '#cha-foo'
+      end
+
+      it "should have a link to the first section" do
+        expect(toc.css('li>a')[1]['href']).to eq '#sec-bar'
+      end
+
+      it "should have a link to the first subsection" do
+        expect(toc.css('li>a')[2]['href']).to eq '#sec-baz'
+      end
+
+      it "should have a link to the second section" do
+        expect(toc.css('li>a')[3]['href']).to eq '#sec-quux'
+      end
+
+      it "should have a link to the second chapter" do
+        expect(toc.css('li>a')[4]['href']).to eq '#cha-lorem'
+      end
+
+      it "should have the right number of lists" do
+        expect(toc.css('ul').length).to eq 3
+      end
+    end
+  end
+end

data/spec/to_html/table_spec.rb

@@ -0,0 +1,269 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "tabular environments" do
+
+    context "simple table with centered elements" do
+
+      let(:polytex) do <<-'EOS'
+        \begin{tabular}{cc}
+        \hline
+        HTTP request & URL \\
+        \hline
+        GET & /users \\
+        GET & /users/1
+        \end{tabular}
+      EOS
+      end
+
+      let(:output) do <<-'EOS'
+        <table class="tabular">
+        <tr class="top_border bottom_border"><td class="align_center">HTTP request</td>
+        <td class="align_center">URL</td>
+        </tr><tr><td class="align_center">GET</td>
+        <td class="align_center">/users</td>
+        </tr><tr><td class="align_center">GET</td>
+        <td class="align_center">/users/1</td>
+        </tr></table>
+      EOS
+      end
+
+      it { should resemble output }
+
+      context "longtable" do
+
+        let(:polytex) do <<-'EOS'
+          \begin{longtable}{cc}
+          \hline
+          HTTP request & URL \\
+          \hline
+          GET & /users \\
+          GET & /users/1
+          \end{longtable}
+        EOS
+        end
+
+        it { should resemble output }
+      end
+    end
+
+    context "more complicated left-aligned cells with lines" do
+      let(:polytex) do <<-'EOS'
+        \begin{tabular}{|l|lll|}
+        \multicolumn{4}{|c|}{Cell spanning four columns} \\
+        HTTP request & URL & Action & Purpose \\ \hline
+
+        GET & /users & index & page to list all users \\
+        GET & /users/1 & show & page to show user with id 1\\
+        GET & /users/new & new & page to make a new user \\
+        POST & /users & create & create a new user \\
+        GET & /users/1/edit & edit & page to edit user with id 1 \\
+        PATCH & /users/1 & update & update user with id 1  \\
+        DELETE & /users/1 & destroy & delete user with id 1
+        \end{tabular}
+      EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <table class="tabular">
+
+            <tr>
+            <td colspan="4" class="left_border align_center right_border">Cell spanning four columns</td>
+            </tr>
+            <tr class="bottom_border">
+              <td class="left_border align_left right_border">HTTP request</td>
+              <td class="align_left">URL</td>
+              <td class="align_left">Action</td>
+              <td class="align_left right_border">Purpose</td>
+            </tr>
+            <tr>
+              <td class="left_border align_left right_border">GET</td>
+              <td class="align_left">/users</td>
+              <td class="align_left">index</td>
+              <td class="align_left right_border">page to list all users</td>
+            </tr>
+            <tr>
+              <td class="left_border align_left right_border">GET</td>
+              <td class="align_left">/users/1</td>
+              <td class="align_left">show</td>
+              <td class="align_left right_border">page to show user with id 1</td>
+            </tr>
+            <tr>
+              <td class="left_border align_left right_border">GET</td>
+              <td class="align_left">/users/new</td>
+              <td class="align_left">new</td>
+              <td class="align_left right_border">page to make a new user</td>
+            </tr>
+            <tr>
+              <td class="left_border align_left right_border">POST</td>
+              <td class="align_left">/users</td>
+              <td class="align_left">create</td>
+              <td class="align_left right_border">create a new user</td>
+            </tr>
+            <tr>
+              <td class="left_border align_left right_border">GET</td>
+              <td class="align_left">/users/1/edit</td>
+              <td class="align_left">edit</td>
+              <td class="align_left right_border">page to edit user with id 1</td>
+            </tr>
+            <tr>
+              <td class="left_border align_left right_border">PATCH</td>
+              <td class="align_left">/users/1</td>
+              <td class="align_left">update</td>
+              <td class="align_left right_border">update user with id 1</td>
+          </tr>
+          <tr>
+            <td class="left_border align_left right_border">DELETE</td>
+            <td class="align_left">/users/1</td>
+            <td class="align_left">destroy</td>
+            <td class="align_left right_border">delete user with id 1</td>
+          </tr>
+        </table>
+      EOS
+      end
+    end
+
+    context "table whose border used to break for some reason" do
+      let(:polytex) do <<-'EOS'
+        \begin{tabular}{l|l|ll}
+        DELETE & /users/1 & destroy & delete user with id 1
+        \end{tabular}
+
+        \begin{tabular}{|r|l|ll|}
+        DELETE & /users/1 & destroy & delete user with id 1
+        \end{tabular}
+      EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <table class="tabular">
+            <tr>
+              <td class="align_left right_border">DELETE</td>
+              <td class="align_left right_border">/users/1</td>
+              <td class="align_left">destroy</td>
+              <td class="align_left">delete user with id 1</td>
+            </tr>
+          </table>
+          <table class="tabular">
+            <tr>
+              <td class="left_border align_right right_border">DELETE</td>
+              <td class="align_left right_border">/users/1</td>
+              <td class="align_left">destroy</td>
+              <td class="align_left right_border">delete user with id 1</td>
+            </tr>
+          </table>
+        EOS
+      end
+    end
+  end
+
+  describe "table environments" do
+
+    context "with a label and a cross-reference" do
+      let(:polytex) do <<-'EOS'
+        \begin{table}
+        \begin{tabular}{cc}
+        HTTP request & URL \\
+        GET & /users \\
+        GET & /users/1
+        \end{tabular}
+        \label{table:foo}
+        \end{table}
+
+        Table~\ref{table:foo}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="table-foo" data-tralics-id="uid1" data-number="1" class="table">
+          <table class="tabular"><tr><td class="align_center">HTTP request</td>
+          <td class="align_center">URL</td>
+          </tr><tr><td class="align_center">GET</td>
+          <td class="align_center">/users</td>
+          </tr><tr><td class="align_center">GET</td>
+          <td class="align_center">/users/1</td>
+          </tr></table>
+            <div class="caption">
+              <span class="header">Table 1</span>
+            </div>
+          </div>
+          <p><a href="#table-foo" class="hyperref">Table <span class="ref">1</span></a></p>
+        EOS
+      end
+    end
+
+    context "with a caption" do
+      let(:polytex) do <<-'EOS'
+        \begin{table}
+        \begin{tabular}{cc}
+        HTTP request & URL \\
+        GET & /users \\
+        GET & /users/1
+        \end{tabular}
+        \caption{HTTP requests.}
+        \end{table}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="uid1" data-tralics-id="uid1" data-number="1" class="table">
+          <table class="tabular"><tr><td class="align_center">HTTP request</td>
+          <td class="align_center">URL</td>
+          </tr><tr><td class="align_center">GET</td>
+          <td class="align_center">/users</td>
+          </tr><tr><td class="align_center">GET</td>
+          <td class="align_center">/users/1</td>
+          </tr></table>
+            <div class="caption">
+              <span class="header">Table 1:</span>
+              <span class="description">HTTP requests.</span>
+            </div>
+          </div>
+        EOS
+      end
+
+      context "with a caption and a label" do
+        let(:polytex) do <<-'EOS'
+          \begin{table}
+          \begin{tabular}{cc}
+          HTTP request & URL \\
+          GET & /users \\
+          GET & /users/1
+          \end{tabular}
+          \caption{HTTP requests.\label{table:foo}}
+          \end{table}
+
+          Table~\ref{table:foo}
+          EOS
+        end
+
+        it do
+          should resemble <<-'EOS'
+            <div id="table-foo" data-tralics-id="uid1" data-number="1" class="table">
+            <table class="tabular"><tr><td class="align_center">HTTP request</td>
+            <td class="align_center">URL</td>
+            </tr><tr><td class="align_center">GET</td>
+            <td class="align_center">/users</td>
+            </tr><tr><td class="align_center">GET</td>
+            <td class="align_center">/users/1</td>
+            </tr></table>
+              <div class="caption">
+                <span class="header">Table 1: </span>
+                <span class="description">HTTP requests.</span>
+              </div>
+            </div>
+            <p><a href="#table-foo" class="hyperref">Table <span class="ref">1</span></a></p>
+          EOS
+        end
+      end
+    end
+  end
+end

data/spec/to_html/text_formatting_spec.rb

@@ -0,0 +1,50 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "text formatting" do
+
+    describe "italics" do
+      let(:polytex) { '\emph{foo bar}' }
+      it { should resemble '<em>foo bar</em>' }
+
+
+      context "multiple instances" do
+        let(:polytex) do
+          '\emph{foo bar} and also \emph{baz quux}'
+        end
+
+        it { should resemble '<em>foo bar</em>' }
+        it { should resemble '<em>baz quux</em>' }
+      end
+    end
+
+    describe "boldface" do
+      let(:polytex) { '\textbf{boldface}' }
+      it { should resemble '<strong>boldface</strong>' }
+    end
+
+    describe "small caps" do
+      let(:polytex) { '\textsc{small caps}' }
+      it { should resemble '<span class="sc">small caps</span>' }
+    end
+
+    describe "typewriter text" do
+      let(:polytex) { '\texttt{typewriter text}' }
+      it { should resemble '<span class="tt">typewriter text</span>' }
+    end
+
+    describe "strikeout text" do
+      let(:polytex) { '\sout{foo} bar' }
+      it { should resemble '<del>foo</del> bar' }
+    end
+
+    describe "custom kode command" do
+      let(:polytex) { '\kode{function\_name}' }
+      it { should resemble '<code>function_name</code>' }
+    end
+  end
+end

data/spec/to_latex_spec.rb

@@ -0,0 +1,197 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe Polytexnic::Pipeline do
+
+  before(:all) do
+    FileUtils.rm('.highlight_cache') if File.exist?('.highlight_cache')
+  end
+
+  describe '#to_latex' do
+    subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_latex }
+
+    describe "for vanilla LaTeX" do
+      let(:polytex) { '\emph{foo}' }
+      it { should include(polytex) }
+    end
+
+    describe "with source code highlighting" do
+      let(:polytex) do <<-'EOS'
+%= lang:ruby
+\begin{code}
+def hello
+  "hello, world!"
+end
+\end{code}
+
+Make a code listing as in Listing~\ref{code:hello}.
+
+\begin{codelisting}
+\label{code:hello}
+\codecaption{A hello program in Ruby.}
+%= lang:ruby
+\begin{code}
+def hello
+  "hello, world!"
+end
+\end{code}
+\end{codelisting}
+
+        \noindent lorem ipsum
+      EOS
+      end
+
+      it { should resemble '\begin{framed_shaded}' + "\n" }
+      it { should resemble "\n" + '\end{framed_shaded}' }
+      it { should_not resemble "\n" + '\end{framed_shaded})' }
+      it { should resemble "commandchars=\\\\\\{" }
+      it { should resemble '\begin{Verbatim}' }
+      it { should resemble 'commandchars' }
+      it { should resemble '\end{Verbatim}' }
+      it { should_not resemble 'def hello' }
+      it { should resemble '\noindent lorem ipsum' }
+
+      describe "in the middle of a line" do
+        let(:polytex) { 'Use \verb+%= lang:ruby+ to highlight Ruby code' }
+        it { should resemble '\verb' }
+        it { should_not resemble '<div class="highlight">' }
+      end
+    end
+
+    context "with the metacode environment" do
+      let(:polytex) do <<-'EOS'
+        %= lang:latex
+        \begin{metacode}
+        %= lang:ruby
+        \begin{code}
+        def foo
+          "bar"
+        end
+        \end{code}
+        \end{metacode}
+
+        \noindent lorem ipsum
+        EOS
+      end
+
+      it { should resemble '\begin{framed_shaded}' + "\n" }
+      it { should resemble "\n" + '\end{framed_shaded}' }
+      it { should resemble "commandchars=\\\\\\{" }
+      it { should_not resemble '%= lang:ruby' }
+    end
+
+    describe "verbatim environments" do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        def foo
+          "bar"
+        end
+        \end{verbatim}
+
+        \begin{Verbatim}
+        def foo
+          "bar"
+        end
+        \end{Verbatim}
+
+        \begin{Verbatim}
+          x
+        \end{equation}
+        \end{Verbatim}
+        EOS
+      end
+
+      it { should resemble polytex }
+
+      context "containing an example of highlighted code" do
+        let(:polytex) do <<-'EOS'
+          \begin{verbatim}
+          %= lang:ruby
+          def foo
+            "bar"
+          end
+          \end{verbatim}
+          EOS
+        end
+
+        it { should resemble polytex }
+      end
+
+      context "with an equation" do
+        let(:polytex) do <<-'EOS'
+          \begin{equation}
+          \label{eq:x_y}
+          x_y
+          \end{equation}
+          EOS
+        end
+
+        it { should resemble polytex }
+        it { should_not resemble 'xmlelement' }
+        it { should_not resemble 'xbox' }
+        it "should have only one '\end{equation}'" do
+          n_ends = processed_text.scan(/\\end{equation}/).length
+          expect(n_ends).to eq 1
+        end
+      end
+    end
+
+    describe "hyperref links" do
+      let(:polytex) do <<-'EOS'
+        Chapter~\ref{cha:foo}
+        EOS
+      end
+      let(:output) { '\hyperref[cha:foo]{Chapter~\ref{cha:foo}' }
+      it { should resemble output }
+    end
+
+    describe "asides" do
+
+      context "with headings and labels" do
+        let(:polytex) do <<-'EOS'
+          \begin{aside}
+          \heading{Foo \emph{are} bar.}
+          \label{aside:foo}
+
+          lorem ipsum
+
+          \end{aside}
+          EOS
+        end
+
+        let(:output) do <<-'EOS'
+          \begin{shaded_aside}{Foo \emph{are} bar.}{aside:foo}
+
+          lorem ipsum
+
+          \end{shaded_aside}
+          EOS
+        end
+
+        it { should resemble output }
+      end
+    end
+
+    describe "tables" do
+
+      let(:polytex) do <<-'EOS'
+        \begin{table}
+        lorem ipsum
+        \end{table}
+        EOS
+      end
+
+      let(:output) do <<-'EOS'
+        \begin{table}
+        \begin{center}
+        \small
+        lorem ipsum
+        \end{center}
+        \end{table}
+        EOS
+      end
+
+      it { should resemble output }
+    end
+  end
+end

data/tasks/bin/ruby_tests

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+if hash rbenv 2>/dev/null; then
+  eval "$(rbenv init -)"
+
+  echo "Running tests under Ruby 1.9.3"
+  rbenv shell 1.9.3-p194
+  gem install pivotal-github
+  bundle
+  rspec spec
+  echo "Running tests under Ruby 2.0.0"
+  rbenv shell 2.0.0-p0
+  gem instsll pivotal-github
+  bundle
+  rspec spec
+
+  rbenv shell --unset
+else
+
+  # Load RVM into a shell session *as a function*
+  if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+    # First try to load from a user install
+    source "$HOME/.rvm/scripts/rvm"
+  elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+    # Then try to load from a root install
+    source "/usr/local/rvm/scripts/rvm"
+  else
+    printf "ERROR: An RVM installation was not found.\n"
+  fi
+
+  echo "Running tests under Ruby 1.9.3"
+  rvm use 1.9.3@polytexnic
+  gem install pivotal-github
+  bundle
+  rspec spec
+  echo "Running tests under Ruby 2.0.0"
+  rvm use 2.0.0@polytexnic
+  gem install pivotal-github
+  bundle
+  rspec spec
+fi

data/tasks/run_tests_with_both_rubies.rake

@@ -0,0 +1,5 @@
+task default: [:rubies]
+
+task :rubies do
+  exit system('tasks/bin/ruby_tests')
+end