polytexnic 0.5.0

data/spec/to_html/eqref_spec.rb

@@ -0,0 +1,32 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe Polytexnic::Pipeline do
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe 'equation \ref' do
+
+      let(:equation) do <<-'EOS'
+        \chapter{Equation test}
+
+        \[ x^2 \]
+
+        \begin{equation}
+        \label{eq:foobar}
+        x
+        \end{equation}
+
+       EOS
+    end
+
+    context 'with \ref{eq:foobar}' do
+      let(:polytex) { equation + '\ref{eq:foobar}' }
+      it { should include '1.1' }
+    end
+
+    context 'with \eqref{eq:foobar}' do
+      let(:polytex) { equation + '\eqref{eq:foobar}' }
+      it { should include '(<span class="ref">1.1</span>)' }
+    end
+  end
+end

data/spec/to_html/footnote_spec.rb

@@ -0,0 +1,164 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "first chapter with footnotes" do
+    let(:polytex) do <<-'EOS'
+        \chapter{Foo \emph{bar}}
+        \label{cha:foo}
+
+        \section{Foobar}
+        \label{sec:foobar}
+
+        Lorem ipsum.\footnote{Cicero}
+
+        \chapter{Bar}
+        \label{cha:bar}
+
+        Dolor sit amet.
+      EOS
+    end
+
+    let(:output) do <<-'EOS'
+      <div id="cha-foo" data-tralics-id="cid1" class="chapter" data-number="1">
+        <h1><a href="#cha-foo" class="heading"><span class="number">Chapter 1 </span>Foo <em>bar</em></a></h1>
+      </div>
+      <div id="sec-foobar" data-tralics-id="cid2" class="section" data-number="1.1">
+        <h2><a href="#sec-foobar" class="heading"><span class="number">1.1 </span>Foobar</a></h2>
+        <p>Lorem ipsum.<sup id="cha-1_footnote-ref-1" class="footnote"><a href="#cha-1_footnote-1">1</a></sup></p>
+      </div>
+      <div id="cha-1_footnotes">
+        <ol class="footnotes">
+          <li id="cha-1_footnote-1">
+            Cicero <a class="arrow" href="#cha-1_footnote-ref-1">↑</a>
+          </li>
+        </ol>
+      </div>
+      <div id="cha-bar" data-tralics-id="cid3" class="chapter" data-number="2">
+        <h1><a href="#cha-bar" class="heading"><span class="number">Chapter 2 </span>Bar</a></h1>
+        <p>Dolor sit amet.</p>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+    it "should display the footnotes only once" do
+      expect(processed_text.scan(/id="cha-1_footnotes"/).length).to eq 1
+    end
+  end
+
+  describe "multiple chapters with footnotes" do
+    let(:polytex) do <<-'EOS'
+        \chapter{Foo \emph{bar}}
+        \label{cha:foo}
+
+        \section{Foobar}
+        \label{sec:foobar}
+
+        Lorem ipsum.\footnote{Cicero}
+
+        \chapter{Bar}
+        \label{cha:bar}
+
+        Dolor sit amet.\footnote{\emph{Still} Cicero}
+
+        Hey Jude.\footnote{Lennon/McCartney}
+      EOS
+    end
+
+    let(:output) do <<-'EOS'
+      <div id="cha-foo" data-tralics-id="cid1" class="chapter" data-number="1">
+        <h1><a href="#cha-foo" class="heading"><span class="number">Chapter 1 </span>Foo <em>bar</em></a></h1>
+      </div>
+      <div id="sec-foobar" data-tralics-id="cid2" class="section" data-number="1.1">
+        <h2><a href="#sec-foobar" class="heading"><span class="number">1.1 </span>Foobar</a></h2>
+        <p>Lorem ipsum.<sup id="cha-1_footnote-ref-1" class="footnote"><a href="#cha-1_footnote-1">1</a></sup></p>
+      </div>
+      <div id="cha-1_footnotes">
+        <ol class="footnotes">
+          <li id="cha-1_footnote-1">
+            Cicero <a class="arrow" href="#cha-1_footnote-ref-1">↑</a>
+          </li>
+        </ol>
+      </div>
+      <div id="cha-bar" data-tralics-id="cid3" class="chapter" data-number="2">
+        <h1><a href="#cha-bar" class="heading"><span class="number">Chapter 2 </span>Bar</a></h1>
+        <p>Dolor sit amet.<sup id="cha-2_footnote-ref-1" class="footnote"><a href="#cha-2_footnote-1">1</a></sup></p>
+        <p>Hey Jude.<sup id="cha-2_footnote-ref-2" class="footnote"><a href="#cha-2_footnote-2">2</a></sup></p>
+      </div>
+      <div id="cha-2_footnotes">
+        <ol class="footnotes">
+          <li id="cha-2_footnote-1">
+            <em>Still</em> Cicero <a class="arrow" href="#cha-2_footnote-ref-1">↑</a>
+          </li>
+          <li id="cha-2_footnote-2">
+            Lennon/McCartney <a class="arrow" href="#cha-2_footnote-ref-2">↑</a>
+          </li>
+        </ol>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+
+  describe "symbols in place of numbers" do
+    let(:polytex) do <<-'EOS'
+        \documentclass{book}
+        \renewcommand{\thefootnote}{\fnsymbol{footnote}}
+        \begin{document}
+        \chapter{Foo \emph{bar}}
+        \label{cha:foo}
+
+        \section{Foobar}
+        \label{sec:foobar}
+
+        Lorem ipsum.\footnote{Cicero}
+
+        \chapter{Bar}
+        \label{cha:bar}
+
+        Dolor sit amet.\footnote{\emph{Still} Cicero}
+
+        Hey Jude!\footnote{Lennon/McCartney} Be afraid.
+        \end{document}
+      EOS
+    end
+
+    let(:output) do <<-'EOS'
+      <div id="cha-foo" data-tralics-id="cid1" class="chapter" data-number="1">
+        <h1><a href="#cha-foo" class="heading"><span class="number">Chapter 1 </span>Foo <em>bar</em></a></h1>
+      </div>
+      <div id="sec-foobar" data-tralics-id="cid2" class="section" data-number="1.1">
+        <h2><a href="#sec-foobar" class="heading"><span class="number">1.1 </span>Foobar</a></h2>
+        <p>Lorem ipsum.<sup id="cha-1_footnote-ref-1" class="footnote"><a href="#cha-1_footnote-1">*</a></sup></p>
+      </div>
+      <div id="cha-1_footnotes">
+        <ul class="footnotes nonumbers">
+          <li id="cha-1_footnote-1">
+            <sup>*</sup> Cicero <a class="arrow" href="#cha-1_footnote-ref-1">↑</a>
+          </li>
+        </ul>
+      </div>
+      <div id="cha-bar" data-tralics-id="cid3" class="chapter" data-number="2">
+        <h1><a href="#cha-bar" class="heading"><span class="number">Chapter 2 </span>Bar</a></h1>
+        <p>Dolor sit amet.<sup id="cha-2_footnote-ref-1" class="footnote"><a href="#cha-2_footnote-1">*</a></sup></p>
+        <p>Hey Jude!<sup id="cha-2_footnote-ref-2" class="footnote intersentence"><a href="#cha-2_footnote-2">†</a></sup><span class="intersentencespace"></span>
+        Be afraid.<span class="intersentencespace"></span></p>
+      </div>
+      <div id="cha-2_footnotes">
+        <ul class="footnotes nonumbers">
+          <li id="cha-2_footnote-1">
+            <sup>*</sup> <em>Still</em> Cicero <a class="arrow" href="#cha-2_footnote-ref-1">↑</a>
+          </li>
+          <li id="cha-2_footnote-2">
+            <sup>†</sup> Lennon/McCartney <a class="arrow" href="#cha-2_footnote-ref-2">↑</a>
+          </li>
+        </ul>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+end

data/spec/to_html/graphics_and_figures_spec.rb

@@ -0,0 +1,358 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "graphics" do
+    let(:polytex) do <<-'EOS'
+      \includegraphics{foo.png}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+        <div class="graphics">
+        <img src="foo.png" alt="foo" />
+        </div>
+      EOS
+    end
+    it { should_not resemble 'class="figure"' }
+    it { should_not resemble 'Figure' }
+
+    context "with a PDF image" do
+      let(:polytex) do <<-'EOS'
+        \includegraphics{foo.pdf}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div class="graphics">
+          <img src="foo.png" alt="foo" />
+          </div>
+        EOS
+      end
+    end
+  end
+
+  describe "figures" do
+    let(:polytex) do <<-'EOS'
+      \begin{figure}
+      lorem
+      \end{figure}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+        <div id="uid1" data-tralics-id="uid1" data-number="1" class="figure">
+        <p>lorem</p>
+        <div class="caption">
+          <span class="header">Figure 1</span>
+        </div>
+        </div>
+      EOS
+    end
+
+    context "with an explicit center environment" do
+      let(:polytex) do <<-'EOS'
+        \begin{figure}
+        \begin{center}
+        lorem
+        \end{center}
+        \end{figure}
+        EOS
+      end
+      it do
+        should resemble <<-'EOS'
+          <div class="center figure" id="uid1" data-tralics-id="uid1" data-number="1">
+            <p>lorem</p>
+            <div class="caption">
+              <span class="header">Figure 1</span>
+            </div>
+          </div>
+        EOS
+      end
+    end
+
+    context "with a label and a cross-reference" do
+      let(:polytex) do <<-'EOS'
+        \begin{figure}
+        lorem
+        \label{fig:foo}
+        \end{figure}
+
+        Figure~\ref{fig:foo} or Fig.~\ref{fig:foo}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="fig-foo" data-tralics-id="uid1" data-number="1" class="figure">
+          <p>lorem</p>
+          <div class="caption">
+            <span class="header">Figure 1</span>
+          </div>
+          </div>
+          <p><a href="#fig-foo" class="hyperref">Figure <span class="ref">1</span></a>
+              or
+             <a href="#fig-foo" class="hyperref">Fig. <span class="ref">1</span></a>
+          </p>
+        EOS
+      end
+    end
+
+    context "with included graphics" do
+      let(:polytex) do <<-'EOS'
+        \begin{figure}
+        \includegraphics{images/foo.png}
+        \label{fig:foo}
+        \end{figure}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="fig-foo" data-tralics-id="uid1" data-number="1" class="figure">
+          <div class="graphics">
+            <img src="images/foo.png" alt="foo" />
+          </div>
+          <div class="caption">
+            <span class="header">Figure 1</span>
+          </div>
+          </div>
+        EOS
+      end
+    end
+
+    context "with a caption" do
+      let(:polytex) do <<-'EOS'
+        \chapter{The chapter}
+
+        \begin{figure}
+        \includegraphics{foo.png}
+        \caption{This is a \emph{caption} with $x$.}
+        \end{figure}
+
+        \begin{figure}
+        \includegraphics{bar.png}
+        \caption{This is another caption.}
+        \end{figure}
+         EOS
+       end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="cid1" data-tralics-id="cid1" class="chapter" data-number="1">
+          <h1>
+            <a href="#cid1" class="heading">
+            <span class="number">Chapter 1 </span>The chapter</a>
+          </h1>
+          <div id="uid1" data-tralics-id="uid1" data-number="1.1" class="figure">
+            <div class="graphics">
+              <img src="foo.png" alt="foo" />
+            </div>
+            <div class="caption">
+              <span class="header">Figure 1.1: </span>
+              <span class="description">This is a <em>caption</em> with <span class="inline_math">\( x \)</span>.</span>
+            </div>
+          </div>
+          <div id="uid2" data-tralics-id="uid2" data-number="1.2" class="figure">
+            <div class="graphics">
+              <img src="bar.png" alt="bar" />
+            </div>
+            <div class="caption">
+              <span class="header">Figure 1.2: </span>
+              <span class="description">This is another caption.</span>
+            </div>
+          </div>
+          </div>
+        EOS
+      end
+    end
+
+    context "with labels and cross-reference" do
+      let(:polytex) do <<-'EOS'
+        \chapter{The chapter}
+        \label{cha:lorem_ipsum}
+
+        \begin{figure}
+        \includegraphics{foo.png}
+        \caption{This is a caption.\label{fig:foo}}
+        \end{figure}
+
+        \begin{figure}
+        \includegraphics{bar.png}
+        \caption{This is another caption.\label{fig:bar}}
+        \end{figure}
+
+        Figure~\ref{fig:baz}
+
+        \chapter{A second chapter}
+        \label{cha:two}
+
+        \begin{figure}
+        \includegraphics{baz.png}
+        \caption{Yet another.\label{fig:baz}}
+        \end{figure}
+
+        Figure~\ref{fig:foo} and Figure~\ref{fig:bar}
+        EOS
+       end
+
+       it do
+         should resemble <<-'EOS'
+          <div id="cha-lorem_ipsum" data-tralics-id="cid1" class="chapter" data-number="1">
+          <h1>
+            <a href="#cha-lorem_ipsum" class="heading">
+            <span class="number">Chapter 1 </span>The chapter</a>
+          </h1>
+          <div id="fig-foo" data-tralics-id="uid1" data-number="1.1" class="figure">
+            <div class="graphics">
+              <img src="foo.png" alt="foo" />
+            </div>
+            <div class="caption">
+              <span class="header">Figure 1.1: </span>
+              <span class="description">This is a caption.</span>
+            </div>
+          </div>
+          <div id="fig-bar" data-tralics-id="uid2" data-number="1.2" class="figure">
+            <div class="graphics">
+              <img src="bar.png" alt="bar" />
+            </div>
+            <div class="caption">
+              <span class="header">Figure 1.2: </span>
+              <span class="description">This is another caption.</span>
+            </div>
+          </div>
+          <p>
+            <a href="#fig-baz" class="hyperref">Figure <span class="ref">2.1</span></a>
+          </p>
+          </div>
+          <div id="cha-two" data-tralics-id="cid2" class="chapter" data-number="2">
+          <h1>
+            <a href="#cha-two" class="heading">
+            <span class="number">Chapter 2 </span>A second chapter</a>
+          </h1>
+          <div id="fig-baz" data-tralics-id="uid3" data-number="2.1" class="figure">
+            <div class="graphics">
+              <img src="baz.png" alt="baz" />
+            </div>
+            <div class="caption">
+              <span class="header">Figure 2.1: </span>
+              <span class="description">Yet another.</span>
+            </div>
+          </div>
+          <p>
+            <a href="#fig-foo" class="hyperref">Figure <span class="ref">1.1</span></a>
+            and
+            <a href="#fig-bar" class="hyperref">Figure <span class="ref">1.2</span></a>
+          </p>
+          </div>
+        EOS
+      end
+
+      context "with a centered image" do
+        let(:polytex) do <<-'EOS'
+          \chapter{The chapter}
+          \label{cha:lorem_ipsum}
+
+          \begin{figure}
+          \centering
+          \includegraphics{foo.png}
+          \caption{This is a caption.\label{fig:foo}}
+          \end{figure}
+          EOS
+         end
+
+         it do
+           should resemble <<-'EOS'
+            <div id="cha-lorem_ipsum" data-tralics-id="cid1" class="chapter" data-number="1">
+            <h1>
+              <a href="#cha-lorem_ipsum" class="heading">
+              <span class="number">Chapter 1 </span>The chapter</a>
+            </h1>
+            <div class="center figure" id="fig-foo" data-tralics-id="uid1" data-number="1.1">
+              <div class="graphics">
+                <img src="foo.png" alt="foo" />
+              </div>
+              <div class="caption">
+                <span class="header">Figure 1.1: </span>
+                <span class="description">This is a caption.</span>
+              </div>
+            </div>
+            </div>
+          EOS
+        end
+
+        context "using the \\image command" do
+          let(:polytex) do <<-'EOS'
+            \chapter{The chapter}
+            \label{cha:lorem_ipsum}
+
+            \begin{figure}
+            \image{foo_bar.png}
+            \caption{This is a caption.\label{fig:foo}}
+            \end{figure}
+            EOS
+           end
+
+           it do
+             should resemble <<-'EOS'
+              <div id="cha-lorem_ipsum" data-tralics-id="cid1" class="chapter" data-number="1">
+              <h1>
+                <a href="#cha-lorem_ipsum" class="heading">
+                <span class="number">Chapter 1 </span>The chapter</a>
+              </h1>
+              <div id="fig-foo" data-tralics-id="uid1" data-number="1.1" class="figure">
+                <div class="graphics image">
+                  <img src="foo_bar.png" alt="foo_bar" />
+                </div>
+                <div class="caption">
+                  <span class="header">Figure 1.1: </span>
+                  <span class="description">This is a caption.</span>
+                </div>
+              </div>
+              </div>
+            EOS
+          end
+        end
+
+        context "using the \\imagebox command" do
+          let(:polytex) do <<-'EOS'
+            \chapter{The chapter}
+            \label{cha:lorem_ipsum}
+
+            \begin{figure}
+            \imagebox{foo_bar.png}
+            \caption{This is a caption.\label{fig:foo}}
+            \end{figure}
+            EOS
+           end
+
+           it do
+             should resemble <<-'EOS'
+              <div id="cha-lorem_ipsum" data-tralics-id="cid1" class="chapter" data-number="1">
+              <h1>
+                <a href="#cha-lorem_ipsum" class="heading">
+                <span class="number">Chapter 1 </span>The chapter</a>
+              </h1>
+              <div id="fig-foo" data-tralics-id="uid1" data-number="1.1" class="figure">
+                <div class="graphics image box">
+                  <img src="foo_bar.png" alt="foo_bar" />
+                </div>
+                <div class="caption">
+                  <span class="header">Figure 1.1: </span>
+                  <span class="description">This is a caption.</span>
+                </div>
+              </div>
+              </div>
+            EOS
+          end
+        end
+      end
+    end
+  end
+end

data/spec/to_html/lists_spec.rb

@@ -0,0 +1,103 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "itemize" do
+    let(:polytex) { '\itemize' }
+    it { should resemble '<ul></ul>'}
+  end
+
+  describe "enumerate" do
+    let(:polytex) { '\enumerate' }
+    it { should resemble '<ol></ol>'}
+  end
+
+  describe "item" do
+    let(:polytex) { '\item foo' }
+    it { should resemble "<li>foo\n</li>"}
+  end
+
+  describe "itemized list" do
+
+    context "alone" do
+      let(:polytex) do <<-'EOS'
+        \begin{itemize}
+        \item Foo
+        \item Bar
+        \end{itemize}
+        EOS
+      end
+      it do
+        should resemble <<-'EOS'
+          <ul>
+          <li>Foo</li>
+          <li>Bar</li>
+          </ul>
+        EOS
+      end
+    end
+
+    context "preceded by text" do
+      let(:polytex) do <<-'EOS'
+        lorem ipsum
+
+        \begin{itemize}
+        \item Foo
+        \item Bar
+        \end{itemize}
+        EOS
+      end
+      it do
+        should resemble <<-'EOS'
+          <p>lorem ipsum</p>
+          <ul>
+          <li>Foo</li>
+          <li>Bar</li>
+          </ul>
+        EOS
+      end
+    end
+
+    context "afollowed by text" do
+      let(:polytex) do <<-'EOS'
+        \begin{itemize}
+        \item Foo
+        \item Bar
+        \end{itemize}
+
+        lorem ipsum
+        EOS
+      end
+      it do
+       should resemble <<-'EOS'
+          <ul>
+          <li>Foo</li>
+          <li>Bar</li>
+          </ul><p>lorem ipsum
+          </p>
+        EOS
+      end
+    end
+  end
+
+  describe "enumerated list" do
+    let(:polytex) do <<-'EOS'
+      \begin{enumerate}
+      \item Foo
+      \item Bar
+      \end{enumerate}
+      EOS
+    end
+    it do
+      should resemble <<-'EOS'
+        <ol>
+        <li>Foo</li>
+        <li>Bar</li>
+        </ol>
+      EOS
+    end
+  end
+end