polytexnic 0.5.0

data/spec/to_html/literal_environments/code_spec.rb

@@ -0,0 +1,141 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe Polytexnic::Pipeline do
+  before(:all) do
+    FileUtils.rm('.highlight_cache') if File.exist?('.highlight_cache')
+  end
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "code blocks" do
+
+    context "without syntax highlighting" do
+      let(:polytex) do <<-'EOS'
+        \begin{code}
+        def foo
+          "bar"
+        end
+        \end{code}
+        EOS
+      end
+
+      it { should resemble 'def foo' }
+      it { should resemble '<div class="code">' }
+      it { should_not resemble '\begin{code}' }
+    end
+
+    context "with syntax highlighting" do
+      let(:polytex) do <<-'EOS'
+        %= lang:ruby
+        \begin{code}
+        def foo
+          "bar"
+        end
+        \end{code}
+        EOS
+      end
+
+      it do
+        should resemble <<-'EOS'
+          <div class="code">
+            <div class="highlight">
+              <pre>
+                <span class="k">def</span> <span class="nf">foo</span>
+                <span class="s2">"bar"</span>
+                <span class="k">end</span>
+              </pre>
+            </div>
+          </div>
+        EOS
+      end
+
+      it { should resemble '<div class="code">' }
+      it "should not have repeated code divs" do
+        expect(processed_text.scan(/<div class="code">/).length).to eq 1
+      end
+      it { should resemble '<div class="highlight">' }
+      it { should resemble '<pre>' }
+    end
+  end
+
+  context "with a space after 'lang'" do
+    let(:polytex) do <<-'EOS'
+      %= lang: ruby
+      \begin{code}
+      def foo
+        "bar"
+      end
+      \end{code}
+      EOS
+    end
+
+    it do
+      should resemble <<-'EOS'
+        <div class="code">
+          <div class="highlight">
+            <pre>
+              <span class="k">def</span> <span class="nf">foo</span>
+              <span class="s2">"bar"</span>
+              <span class="k">end</span>
+            </pre>
+          </div>
+        </div>
+      EOS
+    end
+  end
+
+  describe "code inclusion" do
+    context "for an existing file" do
+
+      context "with no extension" do
+        let(:polytex) do <<-'EOS'
+          %= <<(Rakefile)
+          EOS
+        end
+        let(:output) do <<-'EOS'
+          <span class="n">require</span>
+          EOS
+        end
+        it { should resemble output }
+      end
+
+      context "with an extension" do
+        let(:polytex) do <<-'EOS'
+          %= <<(spec/to_html/literal_environments/code_spec.rb)
+          EOS
+        end
+        let(:output) do <<-'EOS'
+          <div class="code">
+            <div class="highlight">
+              <pre><span class="c1"># encoding=utf-8</span>
+          EOS
+        end
+        it { should resemble output }
+        it { should_not include '<p></p>' }
+      end
+
+      context "with a custom language override" do
+        let(:polytex) do <<-'EOS'
+          %= << (polytexnic_commands.sty, lang: tex)
+          EOS
+        end
+        let(:output) do <<-'EOS'
+          <span class="c">% Add some custom commands needed by PolyTeXnic.</span>
+          EOS
+        end
+        it { should resemble output }
+        it { should_not include '<p></p>' }
+      end
+    end
+
+
+
+    context "for a nonexistent file" do
+      let(:polytex) do <<-'EOS'
+        %= <<(foobar.rb)
+        EOS
+      end
+      it { should include "ERROR: File 'foobar.rb' does not exist" }
+    end
+  end
+end

data/spec/to_html/literal_environments/math_spec.rb

@@ -0,0 +1,255 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe Polytexnic::Pipeline do
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "display and inline math" do
+    let(:math) do <<-'EOS'
+      \begin{bmatrix}
+      1 & \cdots & 0 \\
+      \vdots & \ddots & \vdots \\
+      2 & \cdots & 0
+      \end{bmatrix}
+      EOS
+    end
+
+    let(:result) do <<-'EOS'
+      \begin{bmatrix}
+      1 &amp; \cdots &amp; 0 \\
+      \vdots &amp; \ddots &amp; \vdots \\
+      2 &amp; \cdots &amp; 0
+      \end{bmatrix}
+      EOS
+    end
+
+    context "TeX displaystyle" do
+      let(:equation) { "$$ #{math} $$"}
+      let(:polytex)  { equation }
+      let(:contents) { "\\[ #{result} \\]"}
+
+      it { should resemble contents }
+    end
+
+    context "LaTeX displaystyle" do
+      let(:equation) { "\\[ #{math} \\]"}
+      let(:polytex)  { equation }
+      let(:contents) { "\\[ #{result} \\]"}
+
+      it { should resemble contents }
+
+      context "with surrounding text" do
+        let(:polytex) { "lorem\n\\[ #{math} \\]\nipsum" }
+        it { should resemble '<p class="noindent">' }
+      end
+    end
+
+    context "TeX inline" do
+      let(:equation) { "$#{math}$"}
+      let(:polytex)  { equation }
+      let(:contents) { "\\( #{result} \\)"}
+
+      it { should resemble contents }
+    end
+
+    context "TeX inline with a dollar sign" do
+      let(:equation) { "$#{math} \\mbox{\\$2 bill}$"}
+      let(:polytex)  { equation }
+      let(:contents) { "\\( #{result} \\mbox{\\$2 bill} \\)"}
+
+      it { should resemble contents }
+    end
+
+    context "LaTeX inline" do
+      let(:equation) { "\\( #{math} \\)"}
+      let(:polytex)  { equation }
+      let(:contents) { "\\( #{result} \\)"}
+
+      it { should resemble contents }
+    end
+
+    context "with a space before a dollar sign" do
+      let(:polytex) { "foo $x$ bar" }
+      let(:contents) { "<p>foo <span class=\"inline_math\">\\( x \\)</span> bar" }
+      it { should include contents }
+    end
+  end
+
+  describe "multiple occurrences of inline math on one line" do
+    let(:polytex) { '$\Omega > 0$ and \( x^2 - 2 \equiv 0 \) should work.' }
+
+    it { should resemble '\Omega' }
+    it { should resemble '\equiv' }
+    it { should resemble '<span class="inline_math">' }
+    it { should resemble '\(' }
+  end
+
+  describe "equation environments" do
+
+    shared_examples "an equation environment" do
+      it { should resemble contents }
+      it { should resemble '<div' }
+      it { should resemble 'class="equation"' }
+    end
+
+    context "alone" do
+      let(:equation) do <<-'EOS'
+        \begin{equation}
+        \int_\Omega d\omega = \int_{\partial\Omega} \omega
+        \end{equation}
+      EOS
+      end
+      let(:polytex)  { equation }
+      let(:contents) { equation }
+
+      it_behaves_like "an equation environment"
+    end
+
+    context "with a label and cross-reference" do
+      let(:equation) do <<-'EOS'
+        \chapter{Foo}
+        \begin{equation}
+        \label{stokes_theorem}
+        \int_\Omega d\omega = \int_{\partial\Omega} \omega
+        \end{equation}
+
+        Eq.~\eqref{stokes_theorem} or \eqref{stokes_theorem}
+      EOS
+      end
+      let(:polytex)  { equation }
+      let(:contents) do <<-'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</a></h1>
+        <div id="stokes_theorem" data-tralics-id="uid1" data-number="1.1" class="equation">
+               \begin{equation}
+               \label{stokes_theorem}
+               \int_\Omega d\omega = \int_{\partial\Omega} \omega
+               \end{equation}
+        </div>
+        <p class="noindent"><a href="#stokes_theorem" class="hyperref">Eq. (<span class="ref">1.1</span>)</a>
+        or
+        <a href="#stokes_theorem" class="hyperref">(<span class="ref">1.1</span>)</a>
+        </p>
+      EOS
+      end
+
+      it_behaves_like "an equation environment"
+    end
+
+    context "surrounded by text" do
+      let(:equation) do <<-'EOS'
+        \begin{equation}
+        \int_\Omega d\omega = \int_{\partial\Omega} \omega
+        \end{equation}
+        EOS
+      end
+      let(:polytex)  { "lorem\n" + equation + "\nipsum" }
+      let(:contents) { equation }
+
+      it_behaves_like "an equation environment"
+      it { should resemble '<p>lorem' }
+      it { should resemble '<p class="noindent">ipsum' }
+    end
+
+    describe "align" do
+      let(:equation) do <<-'EOS'
+        \begin{align}
+        x^2 + y^2 & = 1 \\
+        y & = \sqrt{1 - x^2}.
+        \end{align}
+        EOS
+      end
+      let(:polytex) { equation }
+      let(:contents) do <<-'EOS'
+        \begin{align}
+        x^2 + y^2 &amp; = 1 \\
+        y &amp; = \sqrt{1 - x^2}.
+        \end{align}
+        EOS
+      end
+
+      it_behaves_like "an equation environment"
+    end
+
+    describe "align*" do
+      let(:equation) do <<-'EOS'
+        \begin{align*}
+        x^2 + y^2 & = 1 \\
+        y & = \sqrt{1 - x^2}.
+        \end{align*}
+        EOS
+      end
+      let(:polytex) { equation }
+      let(:contents) do <<-'EOS'
+        \begin{align*}
+        x^2 + y^2 &amp; = 1 \\
+        y &amp; = \sqrt{1 - x^2}.
+        \end{align*}
+      EOS
+      end
+
+      it_behaves_like "an equation environment"
+    end
+
+    describe "aligned" do
+      let(:equation) do <<-'EOS'
+        \begin{equation}
+        \begin{aligned}
+        \nabla \times \vec{\mathbf{B}} -\, \frac1c\,
+        \frac{\partial\vec{\mathbf{E}}}{\partial t} & =
+        \frac{4\pi}{c}\vec{\mathbf{j}} \\   \nabla \cdot \vec{\mathbf{E}} & =
+        4 \pi \rho \\
+        \nabla \times \vec{\mathbf{E}}\, +\, \frac1c\,
+        \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\
+        \nabla \cdot \vec{\mathbf{B}} & = 0
+        \end{aligned}
+        \end{equation}
+        EOS
+      end
+      let(:polytex) { equation }
+      let(:contents) do <<-'EOS'
+        \begin{equation}
+        \begin{aligned}
+        \nabla \times \vec{\mathbf{B}} -\, \frac1c\,
+        \frac{\partial\vec{\mathbf{E}}}{\partial t} &amp; =
+        \frac{4\pi}{c}\vec{\mathbf{j}} \\   \nabla \cdot \vec{\mathbf{E}} &amp;
+        = 4 \pi \rho \\
+        \nabla \times \vec{\mathbf{E}}\, +\, \frac1c\,
+        \frac{\partial\vec{\mathbf{B}}}{\partial t} &amp; = \vec{\mathbf{0}} \\
+        \nabla \cdot \vec{\mathbf{B}} &amp; = 0
+        \end{aligned}
+        \end{equation}
+        EOS
+      end
+
+      it_behaves_like "an equation environment"
+    end
+
+    describe "equation*" do
+      let(:equation) do <<-'EOS'
+        \begin{equation*}
+        \left.\begin{aligned}
+        dE  &= \rho \\
+        d*B &= J + \dot{E}
+        \end{aligned}
+        \right\}
+        \qquad \text{Maxwell}
+        \end{equation*}
+        EOS
+      end
+      let(:polytex) { equation }
+      let(:contents) do <<-'EOS'
+        \begin{equation*}
+        \left.\begin{aligned}
+        dE  &amp;= \rho \\
+        d*B &amp;= J + \dot{E}
+        \end{aligned}
+        \right\}
+        \qquad \text{Maxwell}
+        \end{equation*}
+        EOS
+      end
+
+      it_behaves_like "an equation environment"
+    end
+  end
+end

data/spec/to_html/literal_environments/unicode_spec.rb

@@ -0,0 +1,12 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe Polytexnic::Pipeline do
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "non-ASCII Unicode" do
+    let(:polytex) { 'Алексей Разуваев' }
+    it { should include %(<span class="unicode">Алексей</span>) }
+    it { should include %(<span class="unicode">Разуваев</span>) }
+  end
+end

data/spec/to_html/literal_environments/verbatim_spec.rb

@@ -0,0 +1,168 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe Polytexnic::Pipeline do
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "\\verb environments" do
+    let(:polytex) { '\verb+\begin{center}+ \verb-$foo-' }
+    let(:output) do
+      '<span class="inline_verbatim">\begin{center}</span>' +
+      '<span class="inline_verbatim">$foo</span>'
+    end
+    it { should resemble output }
+  end
+
+  describe "verbatim environments" do
+
+    context "alone" do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        \label{foo:bar}
+        \emph{foo bar} & \\
+        \end{verbatim}
+        EOS
+      end
+
+      let(:output) { '\emph{foo bar} &amp; \\\\' }
+
+      it { should resemble output }
+      it { should resemble '<pre class="verbatim">' }
+      it { should_not resemble '\begin{verbatim}' }
+    end
+
+    context "with nesting" do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        \begin{verbatim}
+        \emph{foo bar}
+        \end{verbatim}
+        \end{verbatim}
+        lorem ipsum
+        EOS
+      end
+
+      let(:output) do <<-'EOS'
+        \begin{verbatim}
+        \emph{foo bar}
+        \end{verbatim}
+        EOS
+      end
+
+      it { should resemble output }
+      it "should break out of the loop if verbatim count is zero" do
+        expect(processed_text).to resemble 'lorem ipsum'
+      end
+    end
+
+    context 'with missing \end{verbatim}' do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        \emph{foo bar}
+       EOS
+      end
+
+      it "should raise an error" do
+        expect { processed_text }.to raise_error
+      end
+    end
+
+    context "containing a code environment" do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        \begin{code}
+        \emph{foo bar}
+        \end{code}
+        \end{verbatim}
+        lorem ipsum
+        EOS
+      end
+
+      let(:output) do <<-'EOS'
+        \begin{code}
+        \emph{foo bar}
+        \end{code}
+        EOS
+      end
+
+      it { should resemble output }
+    end
+
+    context "containing a highlighted code environment" do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        %= lang:ruby
+        \begin{code}
+        foo ||= bar
+        \end{code}
+        \end{verbatim}
+        lorem ipsum
+        EOS
+      end
+
+      let(:output) do <<-'EOS'
+        %= lang:ruby
+        \begin{code}
+        foo ||= bar
+        \end{code}
+        EOS
+      end
+
+      it { should resemble output }
+    end
+
+    context "containing a code inclusion" do
+      let(:polytex) do <<-'EOS'
+        \begin{verbatim}
+        %= <</path/to/file.rb
+        \end{verbatim}
+        EOS
+      end
+
+      let(:output) do <<-'EOS'
+        %= &lt;&lt;/path/to/file.rb
+        EOS
+      end
+
+      it { should resemble output }
+    end
+
+    context "preceded by a highlighted code environment" do
+      let(:polytex) do <<-'EOS'
+
+        %= lang:scheme
+        \begin{code}
+        (define tau 6.283185)
+        \end{code}
+
+        \begin{verbatim}
+        <start-quote/>
+        \end{verbatim}
+        EOS
+      end
+
+      let(:output) do <<-'EOS'
+        &lt;start-quote/&gt;
+        EOS
+      end
+
+      it { should resemble output }
+    end
+  end
+
+  describe "Verbatim environments" do
+    let(:polytex) do <<-'EOS'
+      \begin{Verbatim}
+      \emph{foo bar}
+      \end{Verbatim}
+      EOS
+    end
+
+    let(:output) { '\emph{foo bar}' }
+
+    it { should resemble output }
+    it { should_not resemble '\begin{Verbatim}' }
+    it { should_not resemble 'rend="tt"' }
+    it { should resemble '<pre class="verbatim">' }
+  end
+end

data/spec/to_html/quotations_and_verse_spec.rb

@@ -0,0 +1,86 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe 'Polytexnic::Pipeline#to_html' do
+
+  subject(:processed_text) { Polytexnic::Pipeline.new(polytex).to_html }
+
+  describe "quotations and verse" do
+    describe '\begin{quote}...\end{quote}' do
+      let(:polytex) { '\quote{foo}' }
+      it { should resemble "<blockquote class=\"quote\">foo\n</blockquote>" }
+    end
+
+    describe "quote environment" do
+
+      context "alone" do
+        let(:polytex) do <<-'EOS'
+          \begin{quote}
+            lorem ipsum
+
+            dolor sit amet
+          \end{quote}
+          EOS
+        end
+
+        it do
+          should resemble <<-'EOS'
+            <blockquote class="quotation">
+              <p>lorem ipsum</p>
+              <p>dolor sit amet</p>
+            </blockquote>
+          EOS
+        end
+      end
+
+      context "nested" do
+        let(:polytex) do <<-'EOS'
+          \begin{quote}
+            lorem ipsum
+
+            \begin{quote}
+              foo bar
+            \end{quote}
+
+            dolor sit amet
+          \end{quote}
+          EOS
+        end
+        it do
+          should resemble <<-'EOS'
+            <blockquote class="quotation">
+              <p>lorem ipsum</p>
+              <blockquote class="quotation">
+              <p>foo bar</p>
+              </blockquote>
+              <p>dolor sit amet</p>
+            </blockquote>
+          EOS
+        end
+      end
+    end
+
+    describe '\verse' do
+      let(:polytex) { '\verse{foo}' }
+      it { should resemble "<blockquote class=\"verse\">foo\n</blockquote>" }
+    end
+
+    describe "verse environment" do
+      let(:polytex) do <<-'EOS'
+        \begin{verse}
+          lorem ipsum\\
+          dolor sit amet
+        \end{verse}
+        EOS
+      end
+      it do
+        should resemble <<-'EOS'
+          <blockquote class="verse">
+            <p>lorem ipsum<span class="break"></span>
+            dolor sit amet</p>
+          </blockquote>
+        EOS
+      end
+    end
+  end
+end