ronn 0.4

data/ronn.gemspec

@@ -0,0 +1,69 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name = 'ronn'
+  s.version = '0.4'
+  s.date = '2010-03-08'
+
+  s.description = "The opposite of roff"
+  s.summary     = "The opposite of roff"
+
+  s.authors = ["Ryan Tomayko"]
+  s.email = "rtomayko@gmail.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    COPYING
+    README.md
+    Rakefile
+    bin/ron
+    bin/ronn
+    lib/ronn.rb
+    lib/ronn/document.rb
+    lib/ronn/layout.html
+    lib/ronn/roff.rb
+    man/markdown.5
+    man/markdown.5.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
+    test/basic_document.html
+    test/basic_document.ronn
+    test/custom_title_document.html
+    test/custom_title_document.ronn
+    test/definition_list_syntax.html
+    test/definition_list_syntax.ronn
+    test/document_test.rb
+    test/entity_encoding_test.html
+    test/entity_encoding_test.roff
+    test/entity_encoding_test.ronn
+    test/middle_paragraph.html
+    test/middle_paragraph.roff
+    test/middle_paragraph.ronn
+    test/ronn_test.rb
+    test/titleless_document.html
+    test/titleless_document.ronn
+  ]
+  # = MANIFEST =
+
+  s.executables = ['ronn', 'ron']
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
+
+  s.extra_rdoc_files = %w[COPYING]
+  s.add_dependency 'hpricot',    '~> 0.8.2'
+  s.add_dependency 'rdiscount',   '~> 1.5.8'
+  s.add_development_dependency 'contest', '~> 0.1'
+
+  s.has_rdoc = true
+  s.homepage = "http://rtomayko.github.com/ronn/"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ronn"]
+  s.require_paths = %w[lib]
+  s.rubygems_version = '1.1.1'
+end

data/test/angle_bracket_syntax.html

@@ -0,0 +1,13 @@
+<h2 id='NAME'>NAME</h2>
+<p><code>angle_bracket_syntax</code> -- angle bracket syntax test</p>
+
+<p>A <var>WORD</var> in angle brackets is converted to <var>WORD</var>,</p>
+
+<pre><code>except when &lt;WORD> is
+part of a preformatted
+code block,
+</code></pre>
+
+<p>or when <code>&lt;WORD></code> is enclosed in backticks.</p>
+
+<p>or when <var>WORD</var> has a &lt;dot.> or &lt;foo:colon>.</p>

data/test/angle_bracket_syntax.ronn

@@ -0,0 +1,12 @@
+angle_bracket_syntax(5) -- angle bracket syntax test
+====================================================
+
+A <WORD> in angle brackets is converted to <var>WORD</var>,
+
+    except when <WORD> is
+    part of a preformatted
+    code block,
+
+or when `<WORD>` is enclosed in backticks.
+
+or when <WORD> has a <dot.> or <foo:colon>.

data/test/basic_document.html

@@ -0,0 +1,4 @@
+<h2 id='NAME'>NAME</h2>
+<p><code>simple</code> -- a simple ron example</p>
+
+<p>This document created by ron.</p>

data/test/basic_document.ronn

@@ -0,0 +1,4 @@
+simple(7) -- a simple ron example
+=================================
+
+This document created by ron.

data/test/custom_title_document.html

@@ -0,0 +1,4 @@
+<h1>custom_title_document -- This is a custom title</h1>
+
+<p>It doesn't define the name or section of this manual page and is
+output as a simple <code>&lt;h1&gt;</code> instead of a <code>NAME</code> section.</p>

data/test/custom_title_document.ronn

@@ -0,0 +1,5 @@
+This is a custom title
+======================
+
+It doesn't define the name or section of this manual page and is
+output as a simple `<h1>` instead of a `NAME` section.

data/test/definition_list_syntax.html

@@ -0,0 +1,16 @@
+<h2 id='NAME'>NAME</h2>
+<p><code>defition_list_syntax</code> -- hiya</p>
+
+<p>Definition lists look like unordered lists:</p>
+
+<dl>
+<dt class="flush">term</dt><dd><p>definition</p></dd>
+<dt>another one</dt><dd><p>The definition may span
+multiple lines and even</p>
+
+<p>start</p>
+
+<p>new paragraphs</p></dd>
+<dt><code>--somearg</code>=<var>VALUE</var></dt><dd><p>We can do that too.</p></dd>
+</dl>
+

data/test/definition_list_syntax.ronn

@@ -0,0 +1,18 @@
+defition_list_syntax(5) -- hiya
+===============================
+
+Definition lists look like unordered lists:
+
+  * term:
+    definition
+
+  * another one:
+    The definition may span
+    multiple lines and even
+
+    start
+
+    new paragraphs
+
+  * `--somearg`=<VALUE>:
+    We can do that too.

data/test/document_test.rb

@@ -0,0 +1,88 @@
+require 'contest'
+require 'ronn/document'
+
+class DocumentTest < Test::Unit::TestCase
+  SIMPLE_FILE = "#{File.dirname(__FILE__)}/basic_document.ronn"
+
+  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
+
+  context "simple conventionally named document" do
+    setup do
+      @doc = Ronn::Document.new('hello.1.ronn') { "# hello(1) -- hello world" }
+    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" do
+      assert_equal %[<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> -- hello world</p>\n],
+        @doc.to_html_fragment
+    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
+    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
+  end
+end

data/test/entity_encoding_test.html

@@ -0,0 +1,10 @@
+<h2 id='NAME'>NAME</h2>
+<p><code>hello</code> -- hello world</p>
+
+<p>Your output &lt;i&gt;might&lt;/i&gt; look like this:</p>
+
+<pre><code>* Chris
+*
+* &amp;lt;b&amp;gt;GitHub&amp;lt;/b&amp;gt;
+* &lt;b&gt;GitHub&lt;/b&gt;
+</code></pre>

data/test/entity_encoding_test.roff

@@ -0,0 +1,19 @@
+.TH "HELLO" "1" "January 1979" "" ""
+.
+.SH "NAME"
+\fBhello\fR \-\- hello world
+.
+.P
+Your output <i>might</i> look like this:
+.
+.IP "" 4
+.
+.nf
+* Chris
+*
+* &lt;b&gt;GitHub&lt;/b&gt;
+* <b>GitHub</b>
+.
+.fi
+.
+.IP "" 0

data/test/entity_encoding_test.ronn

@@ -0,0 +1,8 @@
+# hello(1) -- hello world
+
+Your output <i>might</i> look like this:
+
+    * Chris
+    *
+    * <b>GitHub</b>
+    * <b>GitHub</b>

data/test/middle_paragraph.html

@@ -0,0 +1,10 @@
+<h2 id='NAME'>NAME</h2>
+<p><code>test</code> -- just a ron test</p>
+
+<h2>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>

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/ronn_test.rb

@@ -0,0 +1,78 @@
+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/v#{Ronn::VERSION}], lines.shift 
+    assert_equal %[.\\" http://github.com/rtomayko/ronn/], 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
+
+  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)
+  end
+
+  test "produces html fragment with the --fragment argument" do
+    output = `echo '# hello(1) -- hello world' | ronn --fragment`
+    assert_equal "<h2 id='NAME'>NAME</h2>\n<p><code>hello</code> -- hello world</p>\n",
+      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 --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 --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/titleless_document.html

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

data/test/titleless_document.ronn

@@ -0,0 +1,2 @@
+This is a document without a level 1 heading. It doesn't output
+a `NAME` section or custom `<h1>`.

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: ronn
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  version: "0.4"
+platform: ruby
+authors: 
+- Ryan Tomayko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 8
+        version: 1.5.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :development
+  version_requirements: *id003
+description: The opposite of roff
+email: rtomayko@gmail.com
+executables: 
+- ronn
+- ron
+extensions: []
+
+extra_rdoc_files: 
+- COPYING
+files: 
+- COPYING
+- README.md
+- Rakefile
+- bin/ron
+- bin/ronn
+- lib/ronn.rb
+- lib/ronn/document.rb
+- lib/ronn/layout.html
+- lib/ronn/roff.rb
+- man/markdown.5
+- man/markdown.5.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
+- test/basic_document.html
+- test/basic_document.ronn
+- test/custom_title_document.html
+- test/custom_title_document.ronn
+- test/definition_list_syntax.html
+- test/definition_list_syntax.ronn
+- test/document_test.rb
+- test/entity_encoding_test.html
+- test/entity_encoding_test.roff
+- test/entity_encoding_test.ronn
+- test/middle_paragraph.html
+- test/middle_paragraph.roff
+- test/middle_paragraph.ronn
+- test/ronn_test.rb
+- test/titleless_document.html
+- test/titleless_document.ronn
+has_rdoc: true
+homepage: http://rtomayko.github.com/ronn/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ronn
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: The opposite of roff
+test_files: 
+- test/document_test.rb
+- test/ronn_test.rb