ronn-ng 0.7.4

data/ronn-ng.gemspec

@@ -0,0 +1,97 @@
+Gem::Specification.new do |s|
+  s.name = 'ronn-ng'
+  s.version = '0.7.4'
+  s.date = '2018-12-22'
+
+  s.summary     = "Builds manuals"
+  s.description = "Ronn-NG builds manuals in HTML and Unix man page format from Markdown."
+  s.homepage    = "https://github.com/apjanke/ronn-ng"
+  s.license     = "MIT"
+
+  s.authors     = ["Andrew Janke"]
+  s.email       = "floss@apjanke.net"
+
+  # = MANIFEST =
+  s.files = %w[
+    AUTHORS
+    CHANGES
+    LICENSE.txt
+    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
+    lib/ronn/template/80c.css
+    lib/ronn/template/dark.css
+    lib/ronn/template/darktoc.css
+    lib/ronn/template/default.html
+    lib/ronn/template/man.css
+    lib/ronn/template/print.css
+    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
+    ronn-ng.gemspec
+    test/angle_bracket_syntax.html
+    test/angle_bracket_syntax.ronn
+    test/basic_document.html
+    test/basic_document.ronn
+    test/contest.rb
+    test/custom_title_document.html
+    test/custom_title_document.ronn
+    test/definition_list_syntax.html
+    test/definition_list_syntax.roff
+    test/definition_list_syntax.ronn
+    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
+    test/middle_paragraph.html
+    test/middle_paragraph.roff
+    test/middle_paragraph.ronn
+    test/missing_spaces.roff
+    test/missing_spaces.ronn
+    test/pre_block_with_quotes.roff
+    test/pre_block_with_quotes.ronn
+    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
+    test/underline_spacing_test.ronn
+  ]
+  # = MANIFEST =
+
+  s.executables = ['ronn']
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
+
+  s.extra_rdoc_files = %w[LICENSE.txt AUTHORS]
+  s.add_dependency 'hpricot',     '~> 0.8', '>= 0.8.2'
+  s.add_dependency 'rdiscount',   '~> 1.5', '>= 1.5.8'
+  s.add_dependency 'mustache',    '~> 0.7', '>= 0.7.0'
+
+  s.has_rdoc = true
+  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,18 @@
+<div class='mp'>
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>angle_bracket_syntax</code> - <span class="man-whatis">angle bracket syntax test</span>
+</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>
+
+</div>

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,9 @@
+<div class='mp'>
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>simple</code> - <span class="man-whatis">a simple ron example</span>
+</p>
+
+<p>This document created by ron.</p>
+
+</div>

data/test/basic_document.ronn

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

data/test/contest.rb

@@ -0,0 +1,68 @@
+require "test/unit"
+
+# Test::Unit loads a default test if the suite is empty, whose purpose is to
+# fail. Since having empty contexts is a common practice, we decided to
+# overwrite TestSuite#empty? in order to allow them. Having a failure when no
+# tests have been defined seems counter-intuitive.
+class Test::Unit::TestSuite
+  def empty?
+    false
+  end
+end
+
+# Contest adds +teardown+, +test+ and +context+ as class methods, and the
+# instance methods +setup+ and +teardown+ now iterate on the corresponding
+# blocks. Note that all setup and teardown blocks must be defined with the
+# block syntax. Adding setup or teardown instance methods defeats the purpose
+# of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    define_method :setup do
+      super(&block)
+      instance_eval(&block)
+    end
+  end
+
+  def self.teardown(&block)
+    define_method :teardown do
+      instance_eval(&block)
+      super(&block)
+    end
+  end
+
+  def self.context(name, &block)
+    subclass = Class.new(self)
+    remove_tests(subclass)
+    subclass.class_eval(&block) if block_given?
+    const_set(context_name(name), subclass)
+  end
+
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+
+private
+
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+
+  def self.remove_tests(subclass)
+    subclass.public_instance_methods.grep(/^test_/).each do |meth|
+      subclass.send(:undef_method, meth.to_sym)
+    end
+  end
+end

data/test/custom_title_document.html

@@ -0,0 +1,6 @@
+<div class='mp'>
+<h1>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>
+
+</div>

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,21 @@
+<div class='mp'>
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>defition_list_syntax</code> - <span class="man-whatis">hiya</span>
+</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>
+
+
+</div>

data/test/definition_list_syntax.roff

@@ -0,0 +1,26 @@
+.TH "DEFITION_LIST_SYNTAX" "5" "January 1979" "" ""
+.
+.SH "NAME"
+\fBdefition_list_syntax\fR \- hiya
+.
+.P
+Definition lists look like unordered lists:
+.
+.TP
+term
+definition
+.
+.TP
+another one
+The definition may span multiple lines and even
+.
+.IP
+start
+.
+.IP
+new paragraphs
+.
+.TP
+\fB\-\-somearg\fR=\fIVALUE\fR
+We can do that too\.
+

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/dots_at_line_start_test.roff

@@ -0,0 +1,10 @@
+.TH "DOTS_AT_LINE_START_TEST" "" "January 1979" "" ""
+.
+.SH "NAME"
+\fBdots_at_line_start_test\fR
+.
+.P
+There\'s a weird issue where dots at the beginning of a line generate troff warnings due to escaping\.
+.
+.P
+\&\.\. let\'s see what happens\.

data/test/dots_at_line_start_test.ronn

@@ -0,0 +1,4 @@
+There's a weird issue where dots at the beginning of a line
+generate troff warnings due to escaping.
+
+.. let's see what happens.

data/test/entity_encoding_test.html

@@ -0,0 +1,35 @@
+<div class='mp'>
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>hello</code> - <span class="man-whatis">hello world</span>
+</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>
+
+<p>Here's some special entities:</p>
+
+<ul>
+<li>&amp;bull;       &bull;</li>
+<li>&amp;nbsp;       &nbsp;</li>
+<li>&amp;copy;       &copy;</li>
+<li>&amp;rdquo;      &rdquo;</li>
+<li>&amp;mdash;      &mdash;</li>
+<li>&amp;reg;        &reg;</li>
+<li>&amp;sec;        &sec;</li>
+<li>&amp;ge;         &ge;</li>
+<li>&amp;le;         &le;</li>
+<li>&amp;ne;         &ne;</li>
+<li>&amp;equiv;      &equiv;</li>
+</ul>
+
+
+<p>Here's a line that uses non-breaking spaces to force the
+last&nbsp;few&nbsp;words&nbsp;to&nbsp;wrap&nbsp;together.</p>
+
+</div>

data/test/entity_encoding_test.roff

@@ -0,0 +1,61 @@
+.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
+.
+.P
+Here\'s some special entities:
+.
+.IP "\[ci]" 4
+&bull; \[ci]
+.
+.IP "\[ci]" 4
+&nbsp; \~
+.
+.IP "\[ci]" 4
+&copy; \(co
+.
+.IP "\[ci]" 4
+&rdquo; \(rs
+.
+.IP "\[ci]" 4
+&mdash; \(em
+.
+.IP "\[ci]" 4
+&reg; \(rg
+.
+.IP "\[ci]" 4
+&sec; \(sc
+.
+.IP "\[ci]" 4
+&ge; \(>=
+.
+.IP "\[ci]" 4
+&le; \(<=
+.
+.IP "\[ci]" 4
+&ne; \(!=
+.
+.IP "\[ci]" 4
+&equiv; \(==
+.
+.IP "" 0
+.
+.P
+Here\'s a line that uses non\-breaking spaces to force the last\~few\~words\~to\~wrap\~together\.

data/test/entity_encoding_test.ronn

@@ -0,0 +1,25 @@
+# hello(1) -- hello world
+
+Your output <i>might</i> look like this:
+
+    * Chris
+    *
+    * <b>GitHub</b>
+    * <b>GitHub</b>
+
+Here's some special entities:
+
+  * &amp;bull;       &bull;
+  * &amp;nbsp;       &nbsp;
+  * &amp;copy;       &copy;
+  * &amp;rdquo;      &rdquo;
+  * &amp;mdash;      &mdash;
+  * &amp;reg;        &reg;
+  * &amp;sec;        &sec;
+  * &amp;ge;         &ge;
+  * &amp;le;         &le;
+  * &amp;ne;         &ne;
+  * &amp;equiv;      &equiv;
+
+Here's a line that uses non-breaking spaces to force the
+last&nbsp;few&nbsp;words&nbsp;to&nbsp;wrap&nbsp;together.