ronn-ng 0.7.4

data/test/middle_paragraph.html

@@ -0,0 +1,15 @@
+<div class='mp'>
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>test</code> - <span class="man-whatis">just a ron 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

@@ -0,0 +1,13 @@
+.TH "TEST" "1" "January 1979" "" ""
+.
+.SH "NAME"
+\fBtest\fR \- just a ron 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

@@ -0,0 +1,10 @@
+test(1) -- just a ron 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

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

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

data/test/pre_block_with_quotes.roff

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

data/test/pre_block_with_quotes.ronn

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

data/test/section_reference_links.html

@@ -0,0 +1,17 @@
+<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">link this</a></p>
+
+</div>

data/test/section_reference_links.roff

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

data/test/section_reference_links.ronn

@@ -0,0 +1,12 @@
+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 [link this](#SECTION-1)

data/test/test_ronn.rb

@@ -0,0 +1,110 @@
+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")
+  $:.unshift(libdir) unless $:.any? { |path| File.expand_path(path) == libdir }
+  ENV['RUBYLIB'] = $:.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 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 0, lines.size
+  end
+
+  def canonicalize(text)
+    text.
+    gsub(/^ +/, '').
+    gsub(/\n/m, '').
+    gsub(/ +/, ' ').
+    gsub(/"/, "'")
+  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 + ")'>"
+    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 = File.read(dest) rescue ''
+      if expected != output
+        File.open(wrong, 'wb') { |f| f.write(output) }
+        diff = `diff -u #{dest} #{wrong} 2>/dev/null`
+        flunk diff
+      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", 4).last # remove ronn version comments
+      expected = File.read(dest) rescue ''
+      if expected != output
+        File.open(wrong, 'wb') { |f| f.write(output) }
+        diff = `diff -u #{dest} #{wrong} 2>/dev/null`
+        flunk diff
+      elsif File.exist?(wrong)
+        File.unlink(wrong)
+      end
+    end
+  end
+end

data/test/test_ronn_document.rb

@@ -0,0 +1,186 @@
+require 'contest'
+require 'ronn/document'
+
+class DocumentTest < Test::Unit::TestCase
+  SIMPLE_FILE = "#{File.dirname(__FILE__)}/basic_document.ronn"
+
+  def canonicalize(text)
+    text.
+    gsub(/^ +/, '').
+    gsub(/\n/m, '').
+    gsub(/ +/, ' ').
+    gsub(/"/, "'")
+  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(wrap=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'))
+    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', __FILE__))
+    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

data/test/test_ronn_index.rb

@@ -0,0 +1,73 @@
+require 'contest'
+require 'ronn'
+
+class IndexTest < Test::Unit::TestCase
+  setup do
+    @index_path   = File.expand_path('../index.txt', __FILE__)
+    @missing_path = File.expand_path('../missing-index.txt', __FILE__)
+  end
+
+  def expand_path(path, rel=File.dirname(__FILE__))
+    File.expand_path(path, rel)
+  end
+
+  test "creating with a non-existant file" do
+    index = Ronn::Index.new(@missing_path)
+    assert_equal @missing_path, index.path
+    assert_equal 0, index.size
+    assert index.empty?
+  end
+
+  test "creating with an index file and no block" do
+    index = Ronn::Index.new(@index_path)
+    assert_equal 3, index.size
+    assert_equal 2, index.manuals.size
+
+    ref = index.references[0]
+    assert_equal 'basic_document(7)', ref.name
+    assert_equal 'basic_document.ronn', ref.location
+    assert_equal 'basic_document.html', ref.url
+    assert_equal expand_path('basic_document.ronn'), ref.path
+    assert ref.manual?
+    assert ref.ronn?
+    assert !ref.remote?
+
+    ref = index.references[1]
+    assert_equal 'definition_list_syntax(5)', ref.name
+    assert_equal 'definition_list_syntax.ronn', ref.location
+    assert_equal 'definition_list_syntax.html', ref.url
+    assert_equal expand_path('definition_list_syntax.ronn'), ref.path
+
+    ref = index.references[2]
+    assert_equal 'grep(1)', ref.name
+    assert_equal 'http://man.cx/grep(1)', ref.url
+    assert ref.manual?
+    assert ref.remote?
+    assert !ref.ronn?
+  end
+
+  test "creating with a block reader" do
+    index = Ronn::Index.new(@index_path) { "hello(1) hello.1.ronn" }
+    assert_equal @index_path, index.path
+    assert_equal 1, index.size
+    ref = index.first
+    assert_equal 'hello(1)',     ref.name
+    assert_equal 'hello.1.ronn', ref.location
+    assert_equal 'hello.1.html', ref.url
+    assert_equal expand_path('hello.1.ronn'), ref.path
+  end
+
+  test "adding manual paths" do
+    index = Ronn::Index.new(@index_path)
+    index << expand_path("angle_bracket_syntax.ronn")
+    assert_equal 'angle_bracket_syntax(5)', index.last.name
+    assert_equal expand_path('angle_bracket_syntax.ronn'), index.last.path
+  end
+
+  test "adding manual paths that are already present" do
+    index = Ronn::Index.new(@index_path)
+    size = index.size
+    index << expand_path("basic_document.ronn")
+    assert_equal size, index.size
+  end
+end