ronn-ng 0.7.4 → 0.8.0.SNAPSHOT

data/test/middle_paragraph.html

@@ -1,9 +1,9 @@
 <div class='mp'>
+
 <h2 id="NAME">NAME</h2>
 <p class="man-name">
-  <code>test</code> - <span class="man-whatis">just a ron test</span>
+  <code>test</code> - <span class="man-whatis">just a ronn test</span>
 </p>
-
 <h2 id="TEST">TEST</h2>
 
 <p>Foo</p>
@@ -11,5 +11,4 @@
 <p>Always use <code>attr_reader</code>, <code>attr_writer</code> or <code>attr_accessor</code>. Do not use <code>for...in</code>; use each instead. Do not use <code>and</code>/<code>or</code>; use <code>&amp;&amp;</code>/<code>||</code> instead.</p>
 
 <p>Bar</p>
-
 </div>

data/test/middle_paragraph.roff

@@ -1,13 +1,9 @@
 .TH "TEST" "1" "January 1979" "" ""
-.
 .SH "NAME"
-\fBtest\fR \- just a ron test
-.
+\fBtest\fR \- just a ronn test
 .SH "TEST"
 Foo
-.
 .P
 Always use \fBattr_reader\fR, \fBattr_writer\fR or \fBattr_accessor\fR\. Do not use \fBfor\|\.\|\.\|\.in\fR; use each instead\. Do not use \fBand\fR/\fBor\fR; use \fB&&\fR/\fB||\fR instead\.
-.
 .P
 Bar

data/test/middle_paragraph.ronn

@@ -1,4 +1,4 @@
-test(1) -- just a ron test
+test(1) -- just a ronn test
 ==========================
 
 ## TEST

data/test/missing_spaces.roff

@@ -1,8 +1,6 @@
 .TH "MISSING_SPACES" "" "January 1979" "" ""
-.
 .SH "NAME"
 \fBmissing_spaces\fR
-.
 .TP
 \fB\-S\fR \fItext\fR, \fBsearch\fR \fItext\fR
 Performs a substring search of formula names for \fItext\fR\.

data/test/nested_list.ronn

@@ -0,0 +1,19 @@
+nested_list test
+================
+
+## TEST
+
+* foo:
+  Blablabla.
+
+* bar:
+  Blablabla.
+
+  - bar-foo:
+    Bububu.
+
+  - bar-baz:
+    Bububu.
+
+* baz:
+  Blablabla.

data/test/nested_list_with_code.html

@@ -0,0 +1,15 @@
+<div class='mp'>
+
+<h1 id="a-1-">a(1)</h1>
+<ul>
+<li>
+<code>toggle_status</code>
+
+<ul>
+<li>Toggle the display of the status bar.</li>
+</ul>
+</li>
+<li>
+<code>spawn &lt;executable&gt; &lt;additional args&gt;</code> TODO explain path-alike expansion</li>
+</ul>
+</div>

data/test/nested_list_with_code.roff

@@ -0,0 +1,11 @@
+.TH "NESTED_LIST_WITH_CODE" "" "January 1979" "" ""
+.IP "\[ci]" 4
+\fBtoggle_status\fR
+.IP "\[ci]" 4
+Toggle the display of the status bar\.
+.IP "" 0
+
+.IP "\[ci]" 4
+\fBspawn <executable> <additional args>\fR TODO explain path\-alike expansion
+.IP "" 0
+

data/test/nested_list_with_code.ronn

@@ -0,0 +1,6 @@
+a(1)
+====
+
+* `toggle_status`
+  - Toggle the display of the status bar.
+* `spawn <executable> <additional args>` TODO explain path-alike expansion

data/test/page.with.periods.in.name.5.ronn

@@ -0,0 +1,4 @@
+Example
+=======
+
+Hello, world!

data/test/pre_block_with_quotes.roff

@@ -1,13 +1,8 @@
 .TH "T" "1" "January 1979" "" ""
-.
 .SH "NAME"
 \fBt\fR \- test
-.
 .SH "test"
-.
 .nf
-
 [ "$11" ]
-.
 .fi
 

data/test/section_reference_links.html

@@ -1,9 +1,9 @@
 <div class='mp'>
+
 <h2 id="NAME">NAME</h2>
 <p class="man-name">
   <code>section_reference_links</code> - <span class="man-whatis">linking to sections</span>
 </p>
-
 <h2 id="SECTION-1">SECTION 1</h2>
 
 <p>See the following section.</p>
@@ -12,6 +12,5 @@
 
 <p>See <a href="#SECTION-1" title="SECTION 1" data-bare-link="true">SECTION 1</a>
 or <a href="#SECTION-1" title="SECTION 1" data-bare-link="true">to put it another way</a>
-or even <a href="#SECTION-1" data-bare-link="true">link this</a></p>
-
+or even <a href="#SECTION-1" data-bare-link="true">like this</a></p>
 </div>

data/test/section_reference_links.roff

@@ -1,10 +1,7 @@
 .TH "SECTION_REFERENCE_LINKS" "1" "January 1979" "" ""
-.
 .SH "NAME"
 \fBsection_reference_links\fR \- linking to sections
-.
 .SH "SECTION 1"
 See the following section\.
-.
 .SH "SECTION 2"
-See \fISECTION 1\fR or \fIto put it another way\fR or even \fIlink this\fR
+See \fISECTION 1\fR or \fIto put it another way\fR or even \fIlike this\fR

data/test/section_reference_links.ronn

@@ -9,4 +9,4 @@ See the following section.
 
 See [SECTION 1][]
 or [to put it another way][SECTION 1]
-or even [link this](#SECTION-1)
+or even [like this](#SECTION-1)

data/test/tables.ronn

@@ -0,0 +1,24 @@
+Hello, world with tables
+========================
+
+
+## Simple table
+
+| Syntax      | Description |
+| ----------- | ----------- |
+| Header      | Title       |
+| Paragraph   | Text        |
+
+## Table with column alignment
+
+| Syntax      | Description | Test Text With A Long Header Name    |
+| :---        |    :----:   |          ---: |
+| Header      | Title       | Here's this   |
+| Paragraph   | Text        | And more      |
+
+## Table with embedded markup
+
+| Header |
+| ------ |
+| Code: `some code` |
+| Emphasis: *foo* and *bar* |

data/test/test_ronn.rb

@@ -4,69 +4,77 @@ class RonnTest < Test::Unit::TestCase
   testdir = File.dirname(__FILE__)
 
   # setup PATH so that we execute the right ronn command
-  bindir = File.dirname(testdir) + "/bin"
+  bindir = File.dirname(testdir) + '/bin'
   ENV['PATH'] = "#{bindir}:#{ENV['PATH']}"
 
   # make sure the load path is setup correctly
   libdir = File.expand_path("#{testdir}/../lib")
-  $:.unshift(libdir) unless $:.any? { |path| File.expand_path(path) == libdir }
-  ENV['RUBYLIB'] = $:.join(':')
+  $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.any? { |path| File.expand_path(path) == libdir }
+  ENV['RUBYLIB'] = $LOAD_PATH.join(':')
 
   require 'ronn'
 
-  test "takes ronn text on stdin and produces roff on stdout" do
+  test 'takes ronn text on stdin and produces roff on stdout' do
     output = `echo '# hello(1) -- hello world' | ronn --date=2009-11-23`
     lines = output.split("\n")
-    assert_equal 7, lines.size
-    assert_equal %[.\\" generated with Ronn-NG/v#{Ronn::version}], lines.shift
-    assert_equal %[.\\" http://github.com/apjanke/ronn-ng/tree/#{Ronn::revision}], lines.shift
-    assert_equal %[.], lines.shift
-    assert_equal %[.TH "HELLO" "1" "November 2009" "" ""], lines.shift
-    assert_equal %[.], lines.shift
-    assert_equal %[.SH "NAME"], lines.shift
-    assert_equal %[\\fBhello\\fR \\- hello world], lines.shift
+    assert_equal 5, lines.size
+    assert_equal %(.\\" generated with Ronn-NG/v#{Ronn.version}), lines.shift
+    assert_equal %(.\\" http://github.com/apjanke/ronn-ng/tree/#{Ronn.revision}), lines.shift
+    assert_equal %(.TH "HELLO" "1" "November 2009" "" ""), lines.shift
+    assert_equal %(.SH "NAME"), lines.shift
+    assert_equal %(\\fBhello\\fR \\- hello world), lines.shift
     assert_equal 0, lines.size
   end
 
   def canonicalize(text)
-    text.
-    gsub(/^ +/, '').
-    gsub(/\n/m, '').
-    gsub(/ +/, ' ').
-    gsub(/"/, "'")
+    text
+      .gsub(/^ +/, '')
+      .gsub(/\n/m, '')
+      .gsub(/ +/, ' ')
+      .tr('"', "'")
   end
 
-  test "produces html instead of roff with the --html argument" do
+  def flunk_with_diff(dest, wrong, output)
+    File.open(wrong, 'wb') { |f| f.write(output) }
+    if ENV['RONN_QUIET_TEST'] == '1'
+      flunk 'Output did not match expected.'
+    else
+      diff = `diff -u #{dest} #{wrong} 2>/dev/null`
+      flunk diff
+    end
+  end
+
+  test 'produces html instead of roff with the --html argument' do
     output = `echo '# hello(1) -- hello world' | ronn --html`
     output = canonicalize(output)
     assert_match(/<h2 id='NAME'>NAME<\/h2>/, output)
-    advertising = "<meta name='generator' content='Ronn-NG/v"    + Ronn::version  +
-                  " (http://github.com/apjanke/ronn-ng/tree/" + Ronn::revision + ")'>"
+    advertising = "<meta name='generator' content='Ronn-NG/v" + Ronn.version +
+                  ' (http://github.com/apjanke/ronn-ng/tree/' + Ronn.revision + ")'>"
     assert_match(/#{Regexp.escape(advertising)}/, output)
   end
 
-  test "produces html fragment with the --fragment argument" do
+  test 'produces html fragment with the --fragment argument' do
     output = `echo '# hello(1) -- hello world' | ronn --fragment`
     assert_equal [
       "<div class='mp'>",
       "<h2 id='NAME'>NAME</h2>",
       "<p class='man-name'><code>hello</code>",
       " - <span class='man-whatis'>hello world</span>",
-      "</p></div>"
+      '</p></div>'
     ].join, canonicalize(output)
   end
 
-  test "abides by the RONN_MANUAL environment variable" do
+  test 'abides by the RONN_MANUAL environment variable' do
     output = `echo '# hello(1) -- hello world' | RONN_MANUAL='Some Manual' ronn --html`
     assert_match(/Some Manual/, output)
   end
 
-  test "abides by the RONN_DATE environment variable" do
+  test 'abides by the RONN_DATE environment variable' do
     output = `echo '# hello(1) -- hello world' | RONN_DATE=1979-01-01 ronn --html`
     assert_match(/January 1979/, output)
   end
 
-  test "abides by the RONN_ORGANIZATION environment variable" do
+  test 'abides by the RONN_ORGANIZATION environment variable' do
     output = `echo '# hello(1) -- hello world' | RONN_ORGANIZATION='GitHub' ronn --html`
     assert_match(/GitHub/, output)
   end
@@ -75,14 +83,17 @@ class RonnTest < Test::Unit::TestCase
   Dir[testdir + '/*.ronn'].each do |source|
     dest = source.sub(/ronn$/, 'html')
     next unless File.exist?(dest)
+
     wrong = dest + '.wrong'
     test File.basename(source, '.ronn') + ' HTML' do
       output = `ronn --pipe --html --fragment #{source}`
-      expected = File.read(dest) rescue ''
+      expected = begin
+                   File.read(dest)
+                 rescue IOError
+                   ''
+                 end
       if expected != output
-        File.open(wrong, 'wb') { |f| f.write(output) }
-        diff = `diff -u #{dest} #{wrong} 2>/dev/null`
-        flunk diff
+        flunk_with_diff(dest, wrong, output)
       elsif File.exist?(wrong)
         File.unlink(wrong)
       end
@@ -93,15 +104,18 @@ class RonnTest < Test::Unit::TestCase
   Dir[testdir + '/*.ronn'].each do |source|
     dest = source.sub(/ronn$/, 'roff')
     next unless File.exist?(dest)
+
     wrong = dest + '.wrong'
     test File.basename(source, '.ronn') + ' roff' do
-      output = `ronn --pipe --roff --date=1979-01-01 #{source}`.
-        split("\n", 4).last # remove ronn version comments
-      expected = File.read(dest) rescue ''
+      output = `ronn --pipe --roff --date=1979-01-01 #{source}`
+               .split("\n", 3).last # remove ronn version comments
+      expected = begin
+                   File.read(dest)
+                 rescue IOError
+                   ''
+                 end
       if expected != output
-        File.open(wrong, 'wb') { |f| f.write(output) }
-        diff = `diff -u #{dest} #{wrong} 2>/dev/null`
-        flunk diff
+        flunk_with_diff(dest, wrong, output)
       elsif File.exist?(wrong)
         File.unlink(wrong)
       end

data/test/test_ronn_document.rb

@@ -2,43 +2,43 @@ require 'contest'
 require 'ronn/document'
 
 class DocumentTest < Test::Unit::TestCase
-  SIMPLE_FILE = "#{File.dirname(__FILE__)}/basic_document.ronn"
+  SIMPLE_FILE = "#{File.dirname(__FILE__)}/basic_document.ronn".freeze
 
   def canonicalize(text)
-    text.
-    gsub(/^ +/, '').
-    gsub(/\n/m, '').
-    gsub(/ +/, ' ').
-    gsub(/"/, "'")
+    text
+      .gsub(/^ +/, '')
+      .gsub(/\n/m, '')
+      .gsub(/ +/, ' ')
+      .tr('"', "'")
   end
 
-  test "new with path" do
+  test 'new with path' do
     doc = Ronn::Document.new(SIMPLE_FILE)
     assert_equal File.read(SIMPLE_FILE), doc.data
   end
 
-  test "new with path and block" do
-    doc = Ronn::Document.new('hello.1.ronn') { "# hello(1) -- hello world" }
-    assert_equal "# hello(1) -- hello world", doc.data
+  test 'new with path and block' do
+    doc = Ronn::Document.new('hello.1.ronn') { '# hello(1) -- hello world' }
+    assert_equal '# hello(1) -- hello world', doc.data
   end
 
-  test "new with path and block but missing name section" do
+  test 'new with path and block but missing name section' do
     doc = Ronn::Document.new('foo.7.ronn') { '' }
     assert_equal 'foo', doc.name
     assert_equal '7', doc.section
   end
 
-  test "new with non conventional path and missing name section" do
+  test 'new with non conventional path and missing name section' do
     doc = Ronn::Document.new('bar.ronn') { '' }
     assert_equal 'bar', doc.name
     assert_equal nil, doc.section
-    assert_equal "./bar.html", doc.path_for('html')
-    assert_equal "./bar", doc.path_for('roff')
-    assert_equal "./bar", doc.path_for('')
-    assert_equal "./bar", doc.path_for(nil)
+    assert_equal './bar.html', doc.path_for('html')
+    assert_equal './bar', doc.path_for('roff')
+    assert_equal './bar', doc.path_for('')
+    assert_equal './bar', doc.path_for(nil)
   end
 
-  test "new with path and name section mismatch" do
+  test 'new with path and name section mismatch' do
     doc = Ronn::Document.new('foo/rick.7.ronn') { "# randy(3) -- I'm confused." }
     assert_equal 'randy', doc.name
     assert_equal 'rick', doc.path_name
@@ -48,8 +48,8 @@ class DocumentTest < Test::Unit::TestCase
     assert_equal 'foo/rick.7.bar', doc.path_for(:bar)
   end
 
-  test "new with no path and a name section" do
-    doc = Ronn::Document.new { "# brandy(5) -- wootderitis" }
+  test 'new with no path and a name section' do
+    doc = Ronn::Document.new { '# brandy(5) -- wootderitis' }
     assert_equal nil, doc.path_name
     assert_equal nil, doc.path_section
     assert_equal 'brandy', doc.name
@@ -76,111 +76,111 @@ class DocumentTest < Test::Unit::TestCase
     end
   end
 
-  context "simple conventionally named document" do
+  context 'simple conventionally named document' do
     setup do
       @now = Time.now
-      @doc = Ronn::Document.new('hello.1.ronn') { "# hello(1) -- hello world" }
+      @doc = Ronn::Document.new('hello.1.ronn') { '# hello(1) -- hello world' }
       @doc.date = @now
     end
 
-    should "load data" do
-      assert_equal "# hello(1) -- hello world", @doc.data
+    should 'load data' do
+      assert_equal '# hello(1) -- hello world', @doc.data
     end
 
-    should "extract the manual page name from the filename or document" do
+    should 'extract the manual page name from the filename or document' do
       assert_equal 'hello', @doc.name
     end
 
-    should "extract the manual page section from the filename or document" do
+    should 'extract the manual page section from the filename or document' do
       assert_equal '1', @doc.section
     end
 
-    should "convert to an HTML fragment with no wrap div" do
-      assert_equal %[<h2 id='NAME'>NAME</h2><p class='man-name'><code>hello</code> - <span class='man-whatis'>hello world</span></p>],
-        canonicalize(@doc.to_html_fragment(wrap=nil))
+    should 'convert to an HTML fragment with no wrap div' do
+      assert_equal %(<h2 id='NAME'>NAME</h2><p class='man-name'><code>hello</code> - <span class='man-whatis'>hello world</span></p>),
+                   canonicalize(@doc.to_html_fragment(nil))
     end
 
-    should "convert to an HTML fragment with a wrap class" do
-      assert_equal %[<div class='pm'><h2 id='NAME'>NAME</h2><p class='man-name'><code>hello</code> - <span class='man-whatis'>hello world</span></p></div>],
-        canonicalize(@doc.to_html_fragment(wrap_class='pm'))
+    should 'convert to an HTML fragment with a wrap class' do
+      assert_equal %(<div class='pm'><h2 id='NAME'>NAME</h2><p class='man-name'><code>hello</code> - <span class='man-whatis'>hello world</span></p></div>),
+                   canonicalize(@doc.to_html_fragment('pm'))
     end
 
-    should "convert to HTML with a layout" do
+    should 'convert to HTML with a layout' do
       assert_match %r{^<!DOCTYPE html.*}m, @doc.to_html
-      assert_match %[<h2 id='NAME'>NAME</h2><p class='man-name'><code>hello</code> - <span class='man-whatis'>hello world</span></p>],
-        canonicalize(@doc.to_html)
+      assert_match %(<h2 id='NAME'>NAME</h2><p class='man-name'><code>hello</code> - <span class='man-whatis'>hello world</span></p>),
+                   canonicalize(@doc.to_html)
     end
 
-    should "construct a path to related documents" do
-      assert_equal "./hello.1.html", @doc.path_for(:html)
-      assert_equal "./hello.1", @doc.path_for(:roff)
-      assert_equal "./hello.1", @doc.path_for('')
-      assert_equal "./hello.1", @doc.path_for(nil)
+    should 'construct a path to related documents' do
+      assert_equal './hello.1.html', @doc.path_for(:html)
+      assert_equal './hello.1', @doc.path_for(:roff)
+      assert_equal './hello.1', @doc.path_for('')
+      assert_equal './hello.1', @doc.path_for(nil)
     end
 
-    test "uses default styles" do
+    test 'uses default styles' do
       assert_equal %w[man], @doc.styles
     end
 
-    test "converting to a hash" do
+    test 'converting to a hash' do
       assert_equal({
-        "section"      => "1",
-        "name"         => "hello",
-        "date"         => @now,
-        "tagline"      => "hello world",
-        "styles"       => ["man"],
-        "toc"          => [["NAME", "NAME"]],
-        "organization" => nil,
-        "manual"       => nil
-      }, @doc.to_h)
+                     'section'      => '1',
+                     'name'         => 'hello',
+                     'date'         => @now,
+                     'tagline'      => 'hello world',
+                     'styles'       => ['man'],
+                     'toc'          => [['NAME', 'NAME']],
+                     'organization' => nil,
+                     'manual'       => nil
+                   }, @doc.to_h)
     end
 
-    test "converting to yaml" do
+    test 'converting to yaml' do
       require 'yaml'
       assert_equal({
-        "section"      => "1",
-        "name"         => "hello",
-        "date"         => @now,
-        "tagline"      => "hello world",
-        "styles"       => ["man"],
-        "toc"          => [["NAME", "NAME"]],
-        "organization" => nil,
-        "manual"       => nil
-      }, YAML.load(@doc.to_yaml))
+                     'section'      => '1',
+                     'name'         => 'hello',
+                     'date'         => @now,
+                     'tagline'      => 'hello world',
+                     'styles'       => ['man'],
+                     'toc'          => [['NAME', 'NAME']],
+                     'organization' => nil,
+                     'manual'       => nil
+                   }, YAML.load(@doc.to_yaml))
     end
 
-    test "converting to json" do
+    test 'converting to json' do
       require 'json'
       assert_equal({
-        "section"      => "1",
-        "name"         => "hello",
-        "date"         => @now.iso8601,
-        "tagline"      => "hello world",
-        "styles"       => ["man"],
-        "toc"          => [["NAME", "NAME"]],
-        "organization" => nil,
-        "manual"       => nil
-      }, JSON.parse(@doc.to_json))
+                     'section'      => '1',
+                     'name'         => 'hello',
+                     'date'         => @now.iso8601,
+                     'tagline'      => 'hello world',
+                     'styles'       => ['man'],
+                     'toc'          => [['NAME', 'NAME']],
+                     'organization' => nil,
+                     'manual'       => nil
+                   }, JSON.parse(@doc.to_json))
     end
   end
 
   test 'extracting toc' do
-    @doc = Ronn::Document.new(File.expand_path('../markdown_syntax.ronn', __FILE__))
+    @doc = Ronn::Document.new(File.expand_path('markdown_syntax.ronn', __dir__))
     expected = [
-      ["NAME", "NAME"],
-      ["SYNOPSIS", "SYNOPSIS"],
-      ["DESCRIPTION", "DESCRIPTION"],
-      ["BLOCK-ELEMENTS", "BLOCK ELEMENTS"],
-      ["SPAN-ELEMENTS", "SPAN ELEMENTS"],
-      ["MISCELLANEOUS", "MISCELLANEOUS"],
-      ["AUTHOR", "AUTHOR"],
-      ["SEE-ALSO", "SEE ALSO"]
+      ['NAME', 'NAME'],
+      ['SYNOPSIS', 'SYNOPSIS'],
+      ['DESCRIPTION', 'DESCRIPTION'],
+      ['BLOCK-ELEMENTS', 'BLOCK ELEMENTS'],
+      ['SPAN-ELEMENTS', 'SPAN ELEMENTS'],
+      ['MISCELLANEOUS', 'MISCELLANEOUS'],
+      ['AUTHOR', 'AUTHOR'],
+      ['SEE-ALSO', 'SEE ALSO']
     ]
     assert_equal expected, @doc.toc
   end
 
-  test "passing a list of styles" do
-    @doc = Ronn::Document.new('hello.1.ronn', :styles => %w[test boom test]) { '' }
+  test 'passing a list of styles' do
+    @doc = Ronn::Document.new('hello.1.ronn', styles: %w[test boom test]) { '' }
     assert_equal %w[man test boom], @doc.styles
   end
 end