polytexnic 0.5.0

data/spec/markdown_to_polytex_spec.rb

@@ -0,0 +1,192 @@
+# 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_polytex' do
+    subject(:processed_text) do
+      Polytexnic::Pipeline.new(source, source: :markdown).polytex
+    end
+
+    context "for vanilla Markdown" do
+      let(:source) { '*foo* **bar**' }
+      it { should include '\emph{foo} \textbf{bar}' }
+      it { should_not include '\begin{document}' }
+    end
+
+    context "for multiline Markdown" do
+      let(:source) do <<-EOS
+# A chapter
+
+Hello, *world*!
+
+## A section
+
+Lorem ipsum
+        EOS
+      end
+      it { should include '\chapter{A chapter}' }
+      it { should include '\section{A section}' }
+      it { should_not include '\hypertarget' }
+    end
+
+    describe "with math" do
+      subject do
+        Polytexnic::Pipeline.new(markdown, source: :markdown).polytex
+      end
+
+      context "inline math" do
+        let(:markdown) do <<-'EOS'
+This is inline math: {$$} x^2 {/$$}.
+          EOS
+        end
+
+        it { should include '\( x^2 \)' }
+      end
+
+      context "block math" do
+        let(:markdown) do <<-'EOS'
+This is block math:
+{$$}
+x^2
+{/$$}.
+          EOS
+        end
+
+        it { should resemble '\[ x^2 \]' }
+      end
+    end
+
+    describe "footnotes" do
+      subject do
+        Polytexnic::Pipeline.new(markdown, source: :markdown).polytex
+      end
+
+      context "first chapter with footnotes" do
+        let(:markdown) do <<-'EOS'
+To add a footnote, you insert a footnote tag like this.[^foo]
+
+Then you add the footnote content later in the text, using the same tag,
+with a colon and a space:[^foo2]
+
+[^foo]: This is the footnote content.
+
+That is it.  You can keep writing your text after the footnote content.
+
+[^foo2]: This is the footnote text. We are now going to add a second line
+    after typing in four spaces.
+          EOS
+        end
+
+        it { should include '\footnote{This is the footnote content.}' }
+        it { should include 'after typing in four spaces.}' }
+      end
+    end
+
+    describe "source code" do
+      context "without highlighting" do
+        let(:source) do <<-EOS
+    def foo
+      "bar"
+    end
+          EOS
+        end
+        let(:output) do <<-'EOS'
+\begin{verbatim}
+def foo
+  "bar"
+end
+\end{verbatim}
+          EOS
+        end
+        it { should eq output }
+      end
+
+      context "with highlighting" do
+        let(:source) do <<-EOS
+{lang="ruby"}
+    def foo
+      "bar"
+    end
+lorem
+          EOS
+        end
+        let(:output) do <<-'EOS'
+%= lang:ruby
+\begin{code}
+def foo
+  "bar"
+end
+\end{code}
+lorem
+          EOS
+        end
+        it { should resemble output }
+      end
+
+      describe "code inclusion" do
+        let(:source) { '<<(/path/to/code)' }
+        it { should resemble '%= <<(/path/to/code)' }
+
+        context "with an alternate lang" do
+          let(:source) { '<<(/path/to/code.md, lang: text)' }
+          it { should resemble '%= <<(/path/to/code.md, lang: text)' }
+        end
+      end
+
+      describe "GitHub-flavored code fencing" do
+
+        context "without highlighting" do
+          let(:source) do <<-EOS
+```
+def foo
+  "bar"
+end
+```
+lorem
+            EOS
+          end
+
+          let(:output) do <<-'EOS'
+\begin{verbatim}
+def foo
+  "bar"
+end
+\end{verbatim}
+lorem
+            EOS
+          end
+          it { should resemble output }
+        end
+
+        context "with highlighting" do
+          let(:source) do <<-EOS
+```ruby
+def foo
+  "bar"
+end
+```
+lorem
+            EOS
+          end
+
+          let(:output) do <<-'EOS'
+%= lang:ruby
+\begin{code}
+def foo
+  "bar"
+end
+\end{code}
+lorem
+            EOS
+          end
+          it { should resemble output }
+        end
+      end
+    end
+  end
+end

data/spec/resemble_matcher_spec.rb

@@ -0,0 +1,69 @@
+# encoding=utf-8
+require 'spec_helper'
+
+describe String do
+  let(:string) { "foo\t    bar\n\nbaz    quux\nderp" }
+  let(:compressed_string) { "foo bar baz quux derp" }
+  subject { string }
+
+  it { should respond_to(:compress) }
+
+  describe '#compress' do
+    subject { string.compress }
+    it { should eq compressed_string }
+  end
+end
+
+describe "custom 'resemble' matcher" do
+
+  it "should pass if two strings agree up to whitespace" do
+    expect("foo      bar").to resemble " foo   \t\tbar "
+  end
+
+  it "should work for regexes" do
+    expect("foo 628_tau bar").to resemble /foo \d+\w*        bar/
+  end
+
+  it "should work if the actual string contains the right substring" do
+    expect("baz quux foo      bar derp").to resemble " foo   \t\tbar "
+  end
+
+  it "should work with backslashes" do
+    expect('\emph{foo bar}').to resemble '\emph{foo bar}'
+  end
+
+  let(:nbsp) { ' ' }
+
+  it "should work with Unicode nonbreak spaces" do
+    expect('foo' + nbsp + nbsp + 'bar').to resemble 'foo bar'
+  end
+
+  it "should work with a mix of characters and codes" do
+    expect('“foo bar”').to resemble '“foo bar”'
+  end
+
+  it "should work with multiline strings" do
+    foo = <<-'EOS'
+  <ul>
+    <li>alpha</li>
+    <li>bravo</li>
+    <li>charlie</li>
+  </ul>
+    EOS
+    bar = <<-'EOS'
+<ul>
+<li>alpha</li>
+<li>bravo</li>
+<li>charlie</li>
+</ul>
+    EOS
+
+    expect(foo).to resemble bar
+  end
+
+  it "should handle HTML fragments identical up to whitespace" do
+    foo = "<em>    foobar\n</em>"
+    bar = "<em>foobar</em>"
+    expect(foo).to resemble bar
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'simplecov'
+require 'json'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'polytexnic'
+
+# Load support files.
+Dir.glob(File.join(File.dirname(__FILE__), "./support/**/*.rb")).each do |f|
+  require_relative(f)
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  Polytexnic::Utils.set_test_mode!
+  config.before do
+    Polytexnic::Utils.set_test_mode!
+  end
+
+  # Disallow the old-style 'object.should' syntax.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/resemble_matcher.rb

@@ -0,0 +1,100 @@
+# encoding=utf-8
+require 'polytexnic'
+
+RSpec::Matchers.define :resemble do |expected|
+  match do |actual|
+    if expected.is_a?(String)
+      regex = %r{#{Regexp.escape(expected.robust)}}
+    elsif expected.is_a?(Regexp)
+      regex = %r{#{expected.to_s.robust}}
+    end
+
+    failure_message_for_should do |actual|
+      debug_output(expected, actual)
+      "expected #{actual} to resemble #{expected}"
+    end
+
+    failure_message_for_should_not do |actual|
+      debug_output(expected, actual)
+      "expected #{actual} not to resemble #{expected}"
+    end
+
+    expect(actual.robust).to match_regex(regex)
+  end
+end
+
+def debug_output(expected, actual)
+  print_output expected, actual if Polytexnic::Utils.debug?
+end
+
+# Prints the robust versions of the two strings
+# The output is hugely useful in visually diffing, e.g., HTML output.
+def print_output(expected, actual)
+  puts "expect: " + expected.robust
+  puts "actual: " + actual.robust
+end
+
+class String
+
+  # Prepares a string for robust comparison.
+  def robust
+    apply_character_equivalences.compress.remove_tag_whitespace
+  end
+
+  # Applies UTF-8 character code equivalences.
+  # For example, '…' and '…' are the same character (horizontal ellipsis),
+  # and depending on the version of Ruby and other factors the string might
+  # contain either or both.
+  # We want to be robust to the differences, to gsub them out.
+  # For clarity, we standardize on the characters that look literally correct,
+  # e.g., '…'.
+  # Rather than be exhaustive, we of course only check the ones actually
+  # used in the tests. Browsers, etc., display them the same.
+  def apply_character_equivalences
+    equivalences = [ ['‘', '‘'],
+                     ['’', '’'],
+                     ['“', '“'],
+                     ['”', '”'],
+                     [' ',  ' '],     # nonbreaking space
+                     [' ',' '],     # thin space
+                     ['…',  '…'],
+                     ['…', '…'],
+                     ['&#8617',  '↩']
+                   ]
+    tap do
+      equivalences.each do |code, character|
+        gsub!(code, character)
+      end
+    end
+  end
+
+  def remove_tag_whitespace
+    gsub(/\s*</, '<').gsub(/>\s*/, '>')
+  end
+
+  # Compress whitespace
+  # Eliminates repeating whitespace (spaces, tabs, or Unicode nbsp),
+  # converting everthing to ordinary spaces, while stripping leading
+  # and trailing whitespace.
+  # >> "foo\t    bar\n\nbaz    quux\nderp".compress
+  # => "foo bar baz quux derp"
+  #
+  # Spaces surround each line are stripped entirely, so that
+  #   <ul>
+  #     <li>alpha</li>
+  #     <li>bravo</li>
+  #     <li>charlie</li>
+  #   </ul>
+  # becomes
+  # <ul>
+  # <li>alpha</li>
+  # <li>bravo</li>
+  # <li>charlie</li>
+  # </ul>
+  def compress
+    unicode_nbsp = ' '
+    result = gsub(unicode_nbsp, ' ')
+    stripped_result = result.split("\n").map(&:strip).join("\n")
+    stripped_result.gsub("\n", ' ').gsub(/[ \t]{2,}/, ' ')
+  end
+end

data/spec/to_html/asides_spec.rb

@@ -0,0 +1,42 @@
+# 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{aside}
+      \heading{Lorem ipsum.}
+      \label{aside:lorem}
+
+      lorem ipsum
+
+      dolor sit amet
+
+      \end{aside}
+
+      Box~\ref{aside:lorem}
+      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="aside" id="aside-lorem" data-tralics-id="uid1" data-number="1.1">
+          <div class="heading">
+            <span class="number">Box 1.1.</span>
+            <span class="description">Lorem ipsum.</span>
+          </div>
+          <p>lorem ipsum</p>
+          <p>dolor sit amet</p>
+        </div>
+        <p><a href="#aside-lorem" class="hyperref">Box <span class="ref">1.1</span></a></p>
+        </div>
+      EOS
+    end
+  end
+end