nronn 0.10.1.pre3 → 0.10.2

data/test/middle_paragraph.html

@@ -1,14 +0,0 @@
-<div class='mp'>
-
-<h2 id="NAME">NAME</h2>
-<p class="man-name">
-  <code>test</code> - <span class="man-whatis">just a ronn test</span>
-</p>
-<h2 id="TEST">TEST</h2>
-
-<p>Foo</p>
-
-<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,9 +0,0 @@
-.TH "TEST" "1" "January 1979" ""
-.SH "NAME"
-\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,10 +0,0 @@
-test(1) -- just a ronn test
-==========================
-
-## TEST
-
-Foo
-
-Always use `attr_reader`, `attr_writer` or `attr_accessor`. Do not use `for...in`; use each instead. Do not use `and`/`or`; use `&&`/`||` instead.
-
-Bar

data/test/missing_spaces.roff

@@ -1,7 +0,0 @@
-.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/missing_spaces.ronn

@@ -1,2 +0,0 @@
- * `-S` <text>, `search` <text>:
-   Performs a substring search of formula names for <text>.

data/test/nested_list.ronn

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

data/test/nested_list_with_code.html

@@ -1,14 +0,0 @@
-<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

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

data/test/nested_list_with_code.ronn

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

data/test/ordered_list.html

@@ -1,28 +0,0 @@
-<div class='mp'>
-
-<h1 id="Ordered-Lists">Ordered Lists</h1>
-<h2 id="Simple-ordered-lists">Simple ordered lists</h2>
-
-<h3 id="One-item-list">One-item list</h3>
-
-<ol>
-  <li>Hello, world!</li>
-</ol>
-
-<h3 id="Three-item-list">Three-item list</h3>
-
-<ol>
-  <li>Hello, world!</li>
-  <li>Item 2</li>
-  <li>Item 3</li>
-</ol>
-
-<h3 id="Four-item-list-with-all-1s">Four-item list with all 1s</h3>
-
-<ol>
-  <li>Item 1</li>
-  <li>Item 2</li>
-  <li>Item 3</li>
-  <li>Item 4</li>
-</ol>
-</div>

data/test/ordered_list.roff

@@ -1,25 +0,0 @@
-.TH "ORDERED_LIST" "" "January 1979" ""
-.SH "Simple ordered lists"
-.SS "One\-item list"
-.IP "1." 4
-Hello, world!
-.IP "" 0
-.SS "Three\-item list"
-.IP "1." 4
-Hello, world!
-.IP "2." 4
-Item 2
-.IP "3." 4
-Item 3
-.IP "" 0
-.SS "Four\-item list with all 1s"
-.IP "1." 4
-Item 1
-.IP "2." 4
-Item 2
-.IP "3." 4
-Item 3
-.IP "4." 4
-Item 4
-.IP "" 0
-

data/test/ordered_list.ronn

@@ -1,21 +0,0 @@
-Ordered Lists
-=============
-
-## Simple ordered lists
-
-### One-item list
-
-1. Hello, world!
-
-### Three-item list
-
-1. Hello, world!
-2. Item 2
-3. Item 3
-
-### Four-item list with all 1s
-
-1. Item 1
-1. Item 2
-1. Item 3
-1. Item 4

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

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

data/test/pre_block_with_quotes.roff

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

data/test/pre_block_with_quotes.ronn

@@ -1,6 +0,0 @@
-t(1) - test
-===========
-
-## test
-
-    [ "$11" ]

data/test/section_reference_links.html

@@ -1,16 +0,0 @@
-<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>
-
-<h2 id="SECTION-2">SECTION 2</h2>
-
-<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">like this</a></p>
-</div>

data/test/section_reference_links.roff

@@ -1,7 +0,0 @@
-.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 \fIlike this\fR

data/test/section_reference_links.ronn

@@ -1,12 +0,0 @@
-section_reference_links(1) - linking to sections
-================================================
-
-## SECTION 1
-
-See the following section.
-
-## SECTION 2
-
-See [SECTION 1][]
-or [to put it another way][SECTION 1]
-or even [like this](#SECTION-1)

data/test/single_quotes.html

@@ -1,11 +0,0 @@
-<div class='mp'>
-
-<h1 id="Single-quotes">Single quotes</h1>
-<h2 id="Single-quote-at-beginning-of-line">Single quote at beginning of line</h2>
-
-<p>'This phrase should appear as normal, starting with a single quote.'</p>
-
-<h2 id="Quotes-in-middle-of-line">Quotes in middle of line</h2>
-
-<p>When you've got single quotes (') in a line, they're regular quotes.</p>
-</div>

data/test/single_quotes.roff

@@ -1,5 +0,0 @@
-.TH "SINGLE_QUOTES" "" "January 1979" ""
-.SH "Single quote at beginning of line"
-\&'This phrase should appear as normal, starting with a single quote\.'
-.SH "Quotes in middle of line"
-When you've got single quotes (') in a line, they're regular quotes\.

data/test/single_quotes.ronn

@@ -1,9 +0,0 @@
-# Single quotes
-
-## Single quote at beginning of line
-
-'This phrase should appear as normal, starting with a single quote.'
-
-## Quotes in middle of line
-
-When you've got single quotes (') in a line, they're regular quotes.

data/test/tables.ronn

@@ -1,24 +0,0 @@
-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

@@ -1,124 +0,0 @@
-require 'contest'
-
-class RonnTest < Test::Unit::TestCase
-  testdir = File.dirname(__FILE__)
-
-  # setup PATH so that we execute the right ronn command
-  bindir = File.dirname(testdir) + '/bin'
-  ENV['PATH'] = "#{bindir}:#{ENV['PATH']}"
-
-  # make sure the load path is setup correctly
-  libdir = File.expand_path("#{testdir}/../lib")
-  $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
-    output = `echo '# hello(1) -- hello world' | ronn --date=2009-11-23`
-    lines = output.split("\n")
-    assert_equal 5, lines.size
-    assert_equal %(.\\" generated with nRonn/v#{Ronn.version}), lines.shift
-    assert_equal %(.\\" https://github.com/n-ronn/nronn/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(/ +/, ' ')
-      .tr('"', "'")
-  end
-
-  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='nRonn/v" + Ronn.version +
-                  ' (https://github.com/n-ronn/nronn/tree/' + Ronn.revision + ")'>"
-    assert_match(/#{Regexp.escape(advertising)}/, output)
-  end
-
-  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>'
-    ].join, canonicalize(output)
-  end
-
-  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
-    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
-    output = `echo '# hello(1) -- hello world' | RONN_ORGANIZATION='GitHub' ronn --html`
-    assert_match(/GitHub/, output)
-  end
-
-  # ronn -> HTML file based tests
-  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 = begin
-        File.read(dest)
-      rescue IOError
-        ''
-      end
-      if expected != output
-        flunk_with_diff(dest, wrong, output)
-      elsif File.exist?(wrong)
-        File.unlink(wrong)
-      end
-    end
-  end
-
-  # ronn -> roff file based tests
-  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", 3).last # remove ronn version comments
-      expected = begin
-        File.read(dest)
-      rescue IOError
-        ''
-      end
-      if expected != output
-        flunk_with_diff(dest, wrong, output)
-      elsif File.exist?(wrong)
-        File.unlink(wrong)
-      end
-    end
-  end
-end

data/test/test_ronn_document.rb

@@ -1,186 +0,0 @@
-require 'contest'
-require 'ronn/document'
-
-class DocumentTest < Test::Unit::TestCase
-  SIMPLE_FILE = "#{File.dirname(__FILE__)}/basic_document.ronn".freeze
-
-  def canonicalize(text)
-    text
-      .gsub(/^ +/, '')
-      .gsub(/\n/m, '')
-      .gsub(/ +/, ' ')
-      .tr('"', "'")
-  end
-
-  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
-  end
-
-  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
-    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)
-  end
-
-  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
-    assert_equal '3', doc.section
-    assert_equal '7', doc.path_section
-    assert_equal 'rick.7', doc.basename
-    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' }
-    assert_equal nil, doc.path_name
-    assert_equal nil, doc.path_section
-    assert_equal 'brandy', doc.name
-    assert_equal '5', doc.section
-    assert_equal 'brandy.5', doc.basename
-    assert_equal 'brandy.5.foo', doc.path_for(:foo)
-  end
-
-  1.upto(5) do |i|
-    dashes = '-' * i
-
-    test "new with no path and #{i} dashes in name" do
-      doc = Ronn::Document.new { "# brandy #{dashes} wootderitis" }
-      assert_equal 'brandy', doc.name
-      assert_equal nil, doc.section
-      assert_equal 'wootderitis', doc.tagline
-    end
-
-    test "new with no path and a name section and #{i} dashes in name" do
-      doc = Ronn::Document.new { "# brandy(5) #{dashes} wootderitis" }
-      assert_equal 'brandy', doc.name
-      assert_equal '5', doc.section
-      assert_equal 'wootderitis', doc.tagline
-    end
-  end
-
-  context 'simple conventionally named document' do
-    setup do
-      @now = Time.now
-      @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
-    end
-
-    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
-      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(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('pm'))
-    end
-
-    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)
-    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)
-    end
-
-    test 'uses default styles' do
-      assert_equal %w[man], @doc.styles
-    end
-
-    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)
-    end
-
-    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))
-    end
-
-    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))
-    end
-  end
-
-  test 'extracting toc' do
-    @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']
-    ]
-    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]) { '' }
-    assert_equal %w[man test boom], @doc.styles
-  end
-end