polytexnic 0.5.0

data/spec/to_html/chapters_and_sections_spec.rb

@@ -0,0 +1,268 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe '\chapter' do
+    context "with a name" do
+      let(:polytex) do <<-'EOS'
+          \chapter{Foo \emph{bar}}
+          \label{cha:foo}
+        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>
+        EOS
+      end
+      it { should resemble output }
+    end
+
+    context "with no name" do
+      let(:polytex) do <<-'EOS'
+          \chapter{}
+          \label{cha:foo}
+        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></a></h1>
+        </div>
+        EOS
+      end
+      it { should resemble output }
+    end
+
+  end
+
+  describe '\section' do
+    let(:polytex) do <<-'EOS'
+        \section{Foo}
+        \label{sec:foo}
+      EOS
+    end
+    let(:output) do <<-'EOS'
+      <div id="sec-foo" data-tralics-id="cid1" class="section" data-number="1">
+        <h2><a href="#sec-foo" class="heading"><span class="number">1 </span>Foo</a></h2>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+
+  describe '\subsection' do
+    let(:polytex) do <<-'EOS'
+        \section{Foo}
+        \label{sec:foo}
+
+        \subsection{Bar}
+        \label{sec:bar}
+      EOS
+    end
+
+    let(:output) do <<-'EOS'
+      <div id="sec-foo" data-tralics-id="cid1" class="section" data-number="1">
+        <h2><a href="#sec-foo" class="heading"><span class="number">1 </span>Foo</a></h2>
+        <div id="sec-bar" data-tralics-id="uid1" class="subsection" data-number="1.1">
+          <h3><a href="#sec-bar" class="heading"><span class="number">1.1 </span>Bar</a></h3>
+        </div>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+
+  describe '\subsubsection' do
+    let(:polytex) do <<-'EOS'
+        \chapter{The Chapter}
+        \label{cha:the_chapter}
+
+        \section{Foo}
+        \label{sec:foo}
+
+        \subsection{Bar}
+        \label{sec:bar}
+
+        \subsubsection{Baz}
+        \label{sec:baz}
+      EOS
+    end
+
+    let(:output) do <<-'EOS'
+      <div id="cha-the_chapter" data-tralics-id="cid1" class="chapter" data-number="1"><h1><a href="#cha-the_chapter" class="heading"><span class="number">Chapter 1 </span>The Chapter</a></h1>
+       </div>
+       <div id="sec-foo" data-tralics-id="cid2" class="section" data-number="1.1"><h2><a href="#sec-foo" class="heading"><span class="number">1.1 </span>Foo</a></h2>
+
+       <div id="sec-bar" data-tralics-id="uid1" class="subsection" data-number="1.1.1"><h3><a href="#sec-bar" class="heading"><span class="number">1.1.1 </span>Bar</a></h3>
+
+       <div id="sec-baz" data-tralics-id="uid2" class="subsubsection" data-number="1.1.1.1"><h4><a href="#sec-baz" class="heading">Baz</a></h4>
+       </div>
+       </div>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+
+  describe '\chapter*' do
+    let(:polytex) do <<-'EOS'
+        \chapter*{Preface}
+        Lorem ipsum
+      EOS
+    end
+    it { should resemble '<div class="chapter-star">' }
+  end
+
+  describe '\section*, etc.' do
+    let(:polytex) do <<-'EOS'
+        \section*{Foo}
+
+        \subsection*{Bar}
+
+        Lorem ipsum
+
+        \section{Baz}
+      EOS
+    end
+    let(:output) do <<-'EOS'
+      <div class="section-star">
+        <h2><a class="heading">Foo</a></h2>
+        <div class="subsection-star">
+          <h3><a class="heading">Bar</a></h3>
+          <p>Lorem ipsum</p>
+        </div>
+      </div>
+      <div id="cid1" data-tralics-id="cid1" class="section" data-number="1">
+        <h2><a href="#cid1" class="heading"><span class="number">1 </span>Baz</a></h2>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+
+  describe 'chapter cross-references' do
+    let(:polytex) do <<-'EOS'
+        \chapter{Foo}
+        \label{cha:foo_bar}
+
+        Chapter~\ref{cha:foo_bar} and
+        Chapter \ref{cha:foo_baz}
+
+        \chapter{Baz}
+        \label{cha:foo_baz}
+
+        Chapter~\ref{cha:foo_baz} and
+        Chapter \ref{cha:foo_bar}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+        <div id="cha-foo_bar" data-tralics-id="cid1" class="chapter" data-number="1">
+          <h1><a href="#cha-foo_bar" class="heading"><span class="number">Chapter 1 </span>Foo</a></h1>
+          <p><a href="#cha-foo_bar" class="hyperref">Chapter <span class="ref">1</span></a>
+          and
+          <a href="#cha-foo_baz" class="hyperref">Chapter <span class="ref">2</span></a>
+          </p>
+        </div>
+
+        <div id="cha-foo_baz" data-tralics-id="cid2" class="chapter" data-number="2">
+          <h1><a href="#cha-foo_baz" class="heading"><span class="number">Chapter 2 </span>Baz</a></h1>
+          <p><a href="#cha-foo_baz" class="hyperref">Chapter <span class="ref">2</span></a>
+          and
+          <a href="#cha-foo_bar" class="hyperref">Chapter <span class="ref">1</span></a>
+          </p>
+        </div>
+      EOS
+    end
+  end
+
+  describe "section cross-references" do
+    let(:polytex) do <<-'EOS'
+        \section{Foo}
+        \label{sec:foo}
+
+        Section~\ref{sec:bar} and Section~\ref{sec:baz}
+
+        \subsection{Bar}
+        \label{sec:bar}
+
+        Section~\ref{sec:foo}
+
+        \subsubsection{Baz}
+        \label{sec:baz}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+        <div id="sec-foo" data-tralics-id="cid1" class="section" data-number="1"><h2><a href="#sec-foo" class="heading"><span class="number">1 </span>Foo</a></h2>
+        <p>
+          <a href="#sec-bar" class="hyperref">Section <span class="ref">1.1</span></a>
+          and
+          <a href="#sec-baz" class="hyperref">Section <span class="ref">1.1.1</span></a>
+        </p>
+        <div id="sec-bar" data-tralics-id="uid1" class="subsection" data-number="1.1"><h3><a href="#sec-bar" class="heading"><span class="number">1.1 </span>Bar</a></h3>
+        <p><a href="#sec-foo" class="hyperref">Section <span class="ref">1</span></a>
+        </p>
+        <div id="sec-baz" data-tralics-id="uid2" class="subsubsection" data-number="1.1.1">
+          <h4><a href="#sec-baz" class="heading">Baz</a></h4>
+        </div></div></div>
+      EOS
+    end
+  end
+
+  describe 'missing cross-references' do
+    let(:polytex) do <<-'EOS'
+      \chapter{Foo}
+      \label{cha:foo}
+
+      Chapter~\ref{cha:bar}
+      EOS
+    end
+
+    it do
+      should resemble <<-'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</a></h1>
+        <p><a href="#cha-bar" class="hyperref">Chapter <span class="undefined_ref">cha:bar</span></a>
+        </p>
+        </div>
+      EOS
+    end
+  end
+
+  describe "frontmatter and mainmatter" do
+    let(:polytex) do <<-'EOS'
+      \frontmatter
+      \chapter{Foo}
+
+      Lorem ipsum.\footnote{Foo bar.}
+
+      \mainmatter
+      \chapter{Bar}
+      \label{cha:bar}
+
+      Chapter~\ref{cha:bar}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+<div id="frontmatter" data-number="0">
+<div class="chapter-star"><h1><a class="heading">Foo</a></h1>
+<p>Lorem ipsum.<sup id="cha-0_footnote-ref-1" class="footnote"><a href="#cha-0_footnote-1">1</a></sup></p>
+</div></div>
+<div id="cha-0_footnotes">
+         <ol class="footnotes"><li id="cha-0_footnote-1">Foo bar. <a class="arrow" href="#cha-0_footnote-ref-1">↑</a></li>
+         </ol></div>
+<div id="cha-bar" data-tralics-id="cid1" class="chapter" data-number="1"><h1><a href="#cha-bar" class="heading"><span class="number">Chapter 1 </span>Bar</a></h1>
+<p><a href="#cha-bar" class="hyperref">Chapter <span class="ref">1</span></a>
+</p></div>
+      EOS
+    end
+  end
+end

data/spec/to_html/characters_and_punctuation_spec.rb

@@ -0,0 +1,138 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "quoted strings" do
+    context "with single quotes" do
+      let(:polytex) { "``foo bar''" }
+      it { should resemble '“foo bar”' }
+    end
+
+    context "with single quotes" do
+      let(:polytex) { "`foo bar'" }
+      it { should resemble '‘foo bar’' }
+    end
+
+    context "with an apostrophe" do
+      let(:polytex) { "don't stop believin'" }
+      it { should resemble 'don’t stop believin’' }
+    end
+  end
+
+  describe "dashes" do
+
+    context "em" do
+      let(:polytex) { '---' }
+      it { should resemble '—' }
+    end
+
+    context "en" do
+      let(:polytex) { '--' }
+      it { should resemble '–' }
+    end
+  end
+
+  describe '\ldots' do
+    let(:polytex) { '\ldots' }
+    it { should resemble '…' }
+  end
+
+  describe 'end-of-sentence punctuation' do
+
+
+    describe "spaces" do
+
+      context "thin" do
+        let(:polytex) { 'a\,b' }
+        it { should resemble 'a<span class="thinspace">&thinsp;</span>b' }
+      end
+
+      context "normal" do
+        let(:polytex) { 'Dr.\ No' }
+        it { should resemble 'Dr. No' }
+      end
+
+      context "intersentence" do
+        let(:intsp) { '<span class="intersentencespace"></span>' }
+
+        context "separated by a space" do
+          let(:polytex) { 'I am. You are.' }
+          it { should resemble "I am.#{intsp} You are." }
+        end
+
+        context "separated by n spaces" do
+          let(:polytex) { 'I am!     You are.' }
+          it { should resemble "I am!#{intsp} You are." }
+        end
+
+        context "separated by a newline" do
+          let(:polytex) { "I am?\nYou are." }
+          it { should resemble "I am?#{intsp} You are." }
+        end
+
+        context "separated by two newlines" do
+          let(:polytex) { "I am.\n\nYou are." }
+          it { should resemble 'I am.</p><p>You are.' }
+        end
+
+        context "with a sentence ending in a closing parenthesis" do
+          let(:polytex) { "(Or otherwise.) A new sentence." }
+          it { should resemble "(Or otherwise.)#{intsp} A new sentence." }
+        end
+
+        context "with a sentence ending in a closing quote" do
+          let(:polytex) { "``Yes, indeed!'' A new sentence." }
+          it { should resemble "“Yes, indeed!”#{intsp} A new sentence." }
+        end
+
+        context "forced inter-sentence override" do
+          let(:polytex) { 'Superman II\@. Lorem ipsum.' }
+          it { should resemble "Superman II.#{intsp} Lorem ipsum." }
+        end
+      end
+    end
+  end
+
+  describe 'unbreakable interword space' do
+    let(:polytex) { 'foo~bar' }
+    it { should resemble 'foo bar' }
+  end
+
+ describe "(La)TeX logos" do
+
+    describe "TeX logo" do
+      let(:polytex) { '\TeX' }
+      let(:output) do
+        %(<span class="texhtml" style="font-family: 'CMU Serif', cmr10, LMRoman10-Regular, 'Times New Roman', 'Nimbus Roman No9 L', Times, serif;">T<span style="text-transform: uppercase; vertical-align: -0.5ex; margin-left: -0.1667em; margin-right: -0.125em;">E</span>X</span>)
+      end
+      it { should include(output) }
+    end
+
+    describe "LaTeX logo" do
+      let(:polytex) { '\LaTeX' }
+      let(:output) do
+        %(<span class="texhtml" style="font-family: 'CMU Serif', cmr10, LMRoman10-Regular, 'Times New Roman', 'Nimbus Roman No9 L', Times, serif;">L<span style="text-transform: uppercase; font-size: 70%; margin-left: -0.36em; vertical-align: 0.3em; line-height: 0; margin-right: -0.15em;">A</span>T<span style="text-transform: uppercase; margin-left: -0.1667em; vertical-align: -0.5ex; line-height: 0; margin-right: -0.125em;">E</span>X</span>)
+      end
+      it { should include(output) }
+    end
+
+    describe "PolyTeX logo" do
+      let(:polytex) { '\PolyTeX' }
+      let(:output) do
+        %(Poly<span class="texhtml" style="font-family: 'CMU Serif', cmr10, LMRoman10-Regular, 'Times New Roman', 'Nimbus Roman No9 L', Times, serif;">T<span style="text-transform: uppercase; vertical-align: -0.5ex; margin-left: -0.1667em; margin-right: -0.125em;">E</span>X</span>)
+      end
+      it { should include(output) }
+    end
+
+    describe "PolyTeXnic logo" do
+      let(:polytex) { '\PolyTeXnic' }
+      let(:output) do
+        %(Poly<span class="texhtml" style="font-family: 'CMU Serif', cmr10, LMRoman10-Regular, 'Times New Roman', 'Nimbus Roman No9 L', Times, serif;">T<span style="text-transform: uppercase; vertical-align: -0.5ex; margin-left: -0.1667em; margin-right: -0.125em;">E</span>X</span>nic)
+      end
+      it { should include(output) }
+    end
+  end
+end

data/spec/to_html/codelistings_spec.rb

@@ -0,0 +1,70 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "code listings" do
+    let(:polytex) do <<-'EOS'
+      \chapter{Foo bar}
+
+      \begin{codelisting}
+      \codecaption{Creating a \texttt{gem} configuration file. \\ \filepath{path/to/file}}
+      \label{code:create_gemrc}
+      %= lang:console
+      \begin{code}
+$ subl .gemrc
+      \end{code}
+      \end{codelisting}
+
+      Listing~\ref{code:create_gemrc}
+      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>Foo bar</a></h1>
+        <div class="codelisting" id="code-create_gemrc" data-tralics-id="uid1" data-number="1.1">
+          <div class="heading">
+            <span class="number">Listing 1.1:</span>
+            <span class="description">Creating a <span class="tt">gem</span> configuration file.<span class="intersentencespace"></span>
+              <span class="break"></span>
+              <span class="filepath">path/to/file</span>
+            </span>
+          </div>
+          <div class="code">
+            <div class="highlight">
+              <pre><span class="gp">$</span> subl .gemrc</pre>
+            </div>
+          </div>
+        </div>
+        <p><a href="#code-create_gemrc" class="hyperref">Listing <span class="ref">1.1</span></a></p>
+        </div>
+      EOS
+    end
+  end
+
+  describe "metacode listings" do
+    let(:polytex) do <<-'EOS'
+      \begin{codelisting}
+      \label{code:listing}
+      \codecaption{The heading.}
+      %= lang:latex
+      \begin{metacode}
+      %= lang:ruby
+      \begin{code}
+      def foo
+        "bar"
+      end
+      \end{code}
+      \end{metacode}
+      \end{codelisting}
+      EOS
+    end
+
+    it "should not raise an error" do
+      expect { processed_text }.not_to raise_error
+    end
+  end
+end

data/spec/to_html/core_spec.rb

@@ -0,0 +1,227 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "comments" do
+    let(:polytex) { "% A LaTeX comment" }
+    it { should eq '' }
+
+    context "with a section and label" do
+      let(:polytex) do <<-'EOS'
+        % \section{Foo}
+        % \label{sec:foo}
+        EOS
+      end
+      it { should eq '' }
+    end
+
+    context "with a code listing" do
+      let(:polytex) do <<-'EOS'
+        % \begin{codelisting}
+        % \heading{A hello program in Ruby.}
+        % \label{code:hello}
+        % %= lang:ruby
+        % \begin{code}
+        % def hello
+        %   "hello, world!"
+        % end
+        % \end{code}
+        % \end{codelisting}
+        EOS
+      end
+      it { should eq '' }
+    end
+
+    context "with a code inclusion" do
+      let(:polytex) { '% %= << spec/spec_helper.rb' }
+      it { should eq '' }
+    end
+
+    context "with a literal percent" do
+      let(:polytex) { '87.3\% of statistics are made up' }
+      it { should resemble '87.3% of statistics are made up' }
+    end
+
+    context "with characters before the percent" do
+      let(:polytex) { 'foo % bar' }
+      it { should resemble 'foo' }
+    end
+
+    context "with two percent signs" do
+      let(:polytex) { 'foo % bar % baz' }
+      it { should resemble 'foo' }
+    end
+
+    context "with display math" do
+      let(:polytex) do <<-'EOS'
+        % \[
+        % \begin{bmatrix}
+        % 1 & \cdots & 0 \\
+        % \vdots & \ddots & \vdots \\
+        % 2 & \cdots & 0
+        % \end{bmatrix}
+        % \]
+        EOS
+      end
+      it { should eq '' }
+    end
+  end
+
+  describe "a complete document" do
+    let(:polytex) do <<-'EOS'
+      \documentclass{book}
+
+      \begin{document}
+      lorem ipsum
+      \end{document}
+      EOS
+    end
+
+    it { should resemble "<p>lorem ipsum</p>" }
+  end
+
+  describe "paragraphs" do
+    let(:polytex) { 'lorem ipsum' }
+    it { should resemble "<p>lorem ipsum</p>" }
+    it { should_not resemble '<unknown>' }
+  end
+
+  describe '\maketitle' do
+
+    context "with all element filled out explicitly" do
+      let(:polytex) do <<-'EOS'
+          \title{Foo \\ \emph{Bar}}
+          \subtitle{Baz}
+          \author{Michael Hartl}
+          \date{January 1, 2013}
+          \begin{document}
+            \maketitle
+          \end{document}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="title_page">
+          <h1 class="title">Foo <span class="break"></span> <em>Bar</em></h1>
+          <h1 class="subtitle">Baz</h1>
+          <h2 class="author">Michael Hartl</h2>
+          <h2 class="date">January 1, 2013</h2>
+          </div>
+        EOS
+      end
+
+      it "should not have repeated title elements" do
+        expect(processed_text.scan(/Michael Hartl/).length).to eq 1
+      end
+    end
+
+    context "when date is blank" do
+      let(:polytex) do <<-'EOS'
+          \title{Foo \\ \emph{Bar}}
+          \subtitle{Baz}
+          \author{Michael Hartl}
+          \date{}
+          \begin{document}
+            \maketitle
+          \end{document}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div id="title_page">
+          <h1 class="title">Foo <span class="break"></span> <em>Bar</em></h1>
+          <h1 class="subtitle">Baz</h1>
+          <h2 class="author">Michael Hartl</h2>
+          </div>
+        EOS
+      end
+    end
+
+    context "when date is missing" do
+      let(:polytex) do <<-'EOS'
+          \title{Foo \\ \emph{Bar}}
+          \subtitle{Baz}
+          \author{Michael Hartl}
+          \begin{document}
+            \maketitle
+          \end{document}
+        EOS
+      end
+
+      it { should resemble '<h2 class="date">' }
+      it "should include today's date" do
+        expect(processed_text).to resemble Date.today.strftime("%A, %b %e")
+      end
+    end
+  end
+
+  describe "double backslashes" do
+    let(:polytex) { 'foo \\\\ bar' }
+    let(:output) { 'foo <span class="break"></span> bar' }
+    it { should resemble output }
+  end
+
+  describe "unknown command" do
+    let(:polytex) { '\foobar' }
+    let(:output) { '' }
+    it { should resemble output }
+  end
+
+  describe "href" do
+
+    context "standard URL" do
+      let(:polytex) { '\href{http://example.com/}{Example Site}' }
+      let(:output) { '<a href="http://example.com/">Example Site</a>' }
+      it { should resemble output }
+    end
+
+    context "URL containing TeX" do
+      let(:polytex) { '\href{http://example.com/}{\emph{\TeX}}' }
+      let(:output) { '<a href="http://example.com/" class="tex">' }
+      it { should resemble output }
+    end
+  end
+
+  describe "centering" do
+    let(:polytex) do <<-'EOS'
+      \begin{center}
+      Lorem ipsum
+
+      dolor sit amet
+      \end{center}
+      EOS
+    end
+    let(:output) do <<-'EOS'
+      <div class="center">
+      <p>Lorem ipsum</p>
+
+      <p>dolor sit amet</p>
+      </div>
+      EOS
+    end
+    it { should resemble output }
+  end
+
+  describe "skips" do
+
+    context "bigskip" do
+      let(:polytex) { '\bigskip' }
+      it { should resemble '<p style="margin-top: 12.0pt"' }
+    end
+
+    context "medskip" do
+      let(:polytex) { '\medskip' }
+      it { should resemble '<p style="margin-top: 6.0pt"' }
+    end
+
+    context "smallskip" do
+      let(:polytex) { '\smallskip' }
+      it { should resemble '<p style="margin-top: 3.0pt"' }
+    end
+  end
+end