ronn 0.6.6 → 0.7.0

data/test/missing_spaces.roff

@@ -1,5 +1,8 @@
 .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/section_reference_links.html

@@ -1,6 +1,8 @@
 <div class='mp'>
-<h2 id='NAME'>NAME</h2>
-<p><code>section_reference_links</code> - linking to sections</p>
+<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>
 

data/test/{ronn_test.rb → test_ronn.rb}

@@ -18,8 +18,8 @@ class RonnTest < Test::Unit::TestCase
     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/v#{Ronn::VERSION}], lines.shift 
-    assert_equal %[.\\" http://github.com/rtomayko/ronn/], lines.shift
+    assert_equal %[.\\" generated with Ronn/v#{Ronn::version}], lines.shift
+    assert_equal %[.\\" http://github.com/rtomayko/ronn/tree/#{Ronn::revision}], lines.shift
     assert_equal %[.], lines.shift
     assert_equal %[.TH "HELLO" "1" "November 2009" "" ""], lines.shift
     assert_equal %[.], lines.shift
@@ -28,15 +28,28 @@ class RonnTest < Test::Unit::TestCase
     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`
-    assert_match(/<h2 id='NAME'>NAME<\/h2>/, output)
+    assert_match(/<h2 id='NAME'>NAME<\/h2>/, canonicalize(output))
   end
 
   test "produces html fragment with the --fragment argument" do
     output = `echo '# hello(1) -- hello world' | ronn --fragment`
-    assert_equal "<div class='mp'>\n<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> - hello world</p>\n\n</div>\n",
-      output
+    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 "abbides by the RONN_MANUAL environment variable" do

data/test/{document_test.rb → test_ronn_document.rb}

@@ -4,6 +4,14 @@ 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
@@ -70,7 +78,9 @@ class DocumentTest < Test::Unit::TestCase
 
   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
@@ -86,19 +96,19 @@ class DocumentTest < Test::Unit::TestCase
     end
 
     should "convert to an HTML fragment with no wrap div" do
-      assert_equal %[<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> - hello world</p>\n],
-        @doc.to_html_fragment(wrap=nil)
+      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'>\n<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> - hello world</p>\n\n</div>],
-        @doc.to_html_fragment(wrap_class='pm')
+      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>\n<p><code>hello</code> - hello world</p>],
-        @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
@@ -111,9 +121,50 @@ class DocumentTest < Test::Unit::TestCase
     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 section heads' do
+  test 'extracting toc' do
     @doc = Ronn::Document.new(File.expand_path('../markdown_syntax.ronn', __FILE__))
     expected = [
       ["NAME", "NAME"],
@@ -125,7 +176,7 @@ class DocumentTest < Test::Unit::TestCase
       ["AUTHOR", "AUTHOR"],
       ["SEE-ALSO", "SEE ALSO"]
     ]
-    assert_equal expected, @doc.section_heads
+    assert_equal expected, @doc.toc
   end
 
   test "passing a list of styles" do

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

data/test/titleless_document.html

@@ -1,5 +1,10 @@
 <div class='mp'>
-<p>This is a document without a level 1 heading. It doesn't output
-a <code>NAME</code> section or custom <code>&lt;h1&gt;</code>.</p>
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>titleless_document</code>
+</p>
+<p>This is a document without a level 1 heading. It generates
+a <code>NAME</code> section from the filename but does not include an
+<code>&lt;h1&gt;</code> element.</p>
 
 </div>

data/test/titleless_document.ronn

@@ -1,2 +1,3 @@
-This is a document without a level 1 heading. It doesn't output
-a `NAME` section or custom `<h1>`.
+This is a document without a level 1 heading. It generates
+a `NAME` section from the filename but does not include an
+`<h1>` element.

data/test/underline_spacing_test.roff

@@ -1,4 +1,9 @@
 .TH "UNDERLINE_SPACING_TEST" "" "January 1979" "" ""
+.
+.SH "NAME"
+\fBunderline_spacing_test\fR
+.
+.P
 This input
 .
 .TP

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ronn
 version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 6
-  version: 0.6.6
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-13 00:00:00 -07:00
+date: 2010-06-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 59
         segments: 
         - 0
         - 8
@@ -35,9 +38,11 @@ dependencies:
   name: rdiscount
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 1
         - 5
@@ -49,9 +54,11 @@ dependencies:
   name: mustache
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         - 7
@@ -72,12 +79,14 @@ files:
 - AUTHORS
 - CHANGES
 - COPYING
+- INSTALLING
 - README.md
 - Rakefile
 - bin/ronn
 - config.ru
 - lib/ronn.rb
 - lib/ronn/document.rb
+- lib/ronn/index.rb
 - lib/ronn/roff.rb
 - lib/ronn/server.rb
 - lib/ronn/template.rb
@@ -90,12 +99,12 @@ files:
 - lib/ronn/template/screen.css
 - lib/ronn/template/toc.css
 - lib/ronn/utils.rb
+- man/index.html
+- man/index.txt
+- man/ronn-format.7
+- man/ronn-format.7.ronn
 - man/ronn.1
 - man/ronn.1.ronn
-- man/ronn.5
-- man/ronn.5.ronn
-- man/ronn.7
-- man/ronn.7.ronn
 - ronn.gemspec
 - test/angle_bracket_syntax.html
 - test/angle_bracket_syntax.ronn
@@ -107,10 +116,12 @@ files:
 - test/definition_list_syntax.html
 - test/definition_list_syntax.roff
 - test/definition_list_syntax.ronn
-- test/document_test.rb
+- test/dots_at_line_start_test.roff
+- test/dots_at_line_start_test.ronn
 - test/entity_encoding_test.html
 - test/entity_encoding_test.roff
 - test/entity_encoding_test.ronn
+- test/index.txt
 - test/markdown_syntax.html
 - test/markdown_syntax.roff
 - test/markdown_syntax.ronn
@@ -119,10 +130,12 @@ files:
 - test/middle_paragraph.ronn
 - test/missing_spaces.roff
 - test/missing_spaces.ronn
-- test/ronn_test.rb
 - test/section_reference_links.html
 - test/section_reference_links.roff
 - test/section_reference_links.ronn
+- test/test_ronn.rb
+- test/test_ronn_document.rb
+- test/test_ronn_index.rb
 - test/titleless_document.html
 - test/titleless_document.ronn
 - test/underline_spacing_test.roff
@@ -140,26 +153,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: The opposite of roff
-test_files: 
-- test/document_test.rb
-- test/ronn_test.rb
+test_files: []
+

data/man/ronn.7

@@ -1,168 +0,0 @@
-.\" generated with Ronn/v0.6.6
-.\" http://github.com/rtomayko/ronn/
-.
-.TH "RONN" "7" "June 2010" "0.6-6-gd7645f2" "Ronn 0.6.6"
-.
-.SH "NAME"
-\fBronn\fR \- the opposite of roff
-.
-.SH "DESCRIPTION"
-Ronn is a text format and toolchain for creating UNIX manpages\. It converts markdown to standard UNIX roff manpages and formatted HTML manuals for the web\.
-.
-.P
-The source format includes all of Markdown but has a more rigid structure and includes extensions that provide features commonly found in manpages (definition lists, link notation, etc\.)\. The ronn(5) manual page defines the format in detail\.
-.
-.SH "DOCUMENTATION"
-The \fB\.ronn\fR files located under the \fBman/\fR directory show off a wide range of ronn capabilities and are the source of Ronn\'s own documentation\. The source files and generated HTML / roff output files are available at:
-.
-.IP "\(bu" 4
-ronn(1) \fIhttp://rtomayko\.github\.com/ronn/ronn\.1\fR \- convert markdown files to manpages\.
-.
-.br
-source file \fIhttp://github\.com/rtomayko/ronn/blob/master/man/ronn\.1\.ronn\fR, roff output \fIhttp://github\.com/rtomayko/ronn/blob/master/man/ronn\.1\fR
-.
-.IP "\(bu" 4
-ronn(5) \fIhttp://rtomayko\.github\.com/ronn/ronn\.5\fR \- markdown\-based text format for authoring manpages
-.
-.br
-source file \fIhttp://github\.com/rtomayko/ronn/blob/master/man/ronn\.5\.ronn\fR, roff output \fIhttp://github\.com/rtomayko/ronn/blob/master/man/ronn\.5\fR
-.
-.IP "" 0
-.
-.SH "INSTALL"
-Install with Rubygems:
-.
-.IP "" 4
-.
-.nf
-
-$ [sudo] gem install ronn
-$ ronn \-\-help
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Or, clone the git repository:
-.
-.IP "" 4
-.
-.nf
-
-$ git clone git://github\.com/rtomayko/ronn\.git
-$ PATH=ronn/bin:$PATH
-$ ronn \-\-help
-.
-.fi
-.
-.IP "" 0
-.
-.SH "BASIC USAGE"
-Build roff and HTML output files for one or more input files:
-.
-.IP "" 4
-.
-.nf
-
-$ ronn man/ronn\.5\.ronn
-roff: man/ronn\.5
-html: man/ronn\.5\.html
-.
-.fi
-.
-.IP "" 0
-.
-.P
-View a roff manpage with man(1):
-.
-.IP "" 4
-.
-.nf
-
-$ man man/ronn\.5
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Generate only a standalone HTML version of one or more files:
-.
-.IP "" 4
-.
-.nf
-
-$ ronn \-\-html man/markdown\.5\.ronn
-html: man/markdown\.5\.html
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Build roff versions of all ronn files in a directory:
-.
-.IP "" 4
-.
-.nf
-
-$ ronn \-\-roff man/*\.ronn
-.
-.fi
-.
-.IP "" 0
-.
-.P
-View a ronn file as if it were a manpage without building intermediate files:
-.
-.IP "" 4
-.
-.nf
-
-$ ronn \-\-man man/markdown\.5\.ronn
-.
-.fi
-.
-.IP "" 0
-.
-.P
-The ronn(1) \fIhttp://rtomayko\.github\.com/ronn/ronn\.1\fR manual page includes comprehensive documentation on \fBronn\fR command line options\.
-.
-.SH "ABOUT"
-Some people say UNIX manual pages are a poor and outdated style of documentation\. I disagree:
-.
-.IP "\(bu" 4
-Man pages follow a well defined structure that\'s immediately familiar\. This provides developers with a useful starting point when documenting new tools, libraries, and formats\.
-.
-.IP "\(bu" 4
-Man pages get to the point\. Because they\'re written in an inverted style, with a SYNOPSIS section followed by additional detail, prose and references to other sources of information, man pages provide the best of both cheat sheet and reference style documentation\.
-.
-.IP "\(bu" 4
-Man pages have extremely \-\- unbelievably \-\- limited text formatting capabilities\. You get a couple of headings, lists, bold, underline and no more\. This is a feature\.
-.
-.IP "\(bu" 4
-Although two levels of section hierarchy are technically supported, most man pages use only a single level\. Unwieldy document hierarchies complicate otherwise good documentation\. Feynman covered all of physics \-\- heavenly bodies through QED \-\- with only two levels of document hierarchy (\fIThe Feynman Lectures on Physics\fR, 1970)\.
-.
-.IP "\(bu" 4
-Man pages have a simple referencing syntax; e\.g\., sh(1), fork(2), markdown(7)\. HTML versions can use this to generate links between pages\.
-.
-.IP "\(bu" 4
-The classical terminal man page display is typographically well thought out\. Big bold section headings, justified monospace text, nicely indented paragraphs, intelligently aligned definition lists, and an informational header and footer\.
-.
-.IP "" 0
-.
-.P
-Unfortunately, figuring out how to create a manpage is a fairly tedious process\. The roff/man macro languages are highly extensible, fractured between multiple dialects, and include a bunch of device specific stuff irrelevant to modern publishing tools\.
-.
-.P
-Ronn aims to address many of the issues with manpage creation while preserving the things that makes manpages a great form of documentation\.
-.
-.SH "COPYING"
-Ronn is Copyright (C) 2009 Ryan Tomayko \fIhttp://tomayko\.com/about\fR
-.
-.br
-See the file COPYING for information of licensing and distribution\.
-.
-.SH "SEE ALSO"
-ronn(1) \fIhttp://rtomayko\.github\.com/ronn/ronn\.1\fR, ronn(5) \fIhttp://rtomayko\.github\.com/ronn/ronn\.5\fR, markdown(5)