nronn 0.10.1.pre2

data/test/code_blocks_regression

@@ -0,0 +1,19 @@
+.\" generated with nRonn/v0.9.1
+.\" https://github.com/n-ronn/nronn/tree/0.9.1
+.TH "CODE_BLOCKS_REGRESSION" "" "July 2020" ""
+.SH "In the text:"
+This is Renzo\'s code\.
+.P
+Debian\'s lintian returns the following warning: acute\-accent\-in\-manual\-page
+.P
+This manual page uses the \' groff sequence\. Usually, the intent to generate an apostrophe, but that sequence actually renders as a an acute accent\.
+.P
+For an apostrophe or a single closing quote, use plain \'\. For single opening quote, i\.e\. a straight downward line \' like the one used in shell commands, use \e(aq\.
+.SH "Basic code block"
+The situation is even worse when there are code blocks, mainly code chunks or commands\. E\.g\., copy\-paste fails\.
+.P
+Type the following command \fBecho \'Hello World\'\fR\.
+.P
+\fBbash $ echo \'hello world\'\fR
+.P
+The following code cannot be compiled: \fBC int main() { 	int example = 42; 	switch (example) { 		case \'a\': return 10; 		default: return 42; 	} }\fR

data/test/code_blocks_regression.html

@@ -0,0 +1,38 @@
+<div class='mp'>
+
+<h1 id="Example-Quote-Error">Example Quote Error</h1>
+<h2 id="In-the-text-">In the text:</h2>
+
+<p>This is Renzo's code.</p>
+
+<p>Debian's lintian returns the following warning:
+acute-accent-in-manual-page</p>
+
+<p>This manual page uses the ' groff sequence. Usually, the intent to
+generate an apostrophe, but that sequence actually renders as a an acute
+accent.</p>
+
+<p>For an apostrophe or a single closing quote, use plain '. For single
+opening quote, i.e. a straight downward line ' like the one used in
+shell commands, use \(aq.</p>
+
+<h2 id="Basic-code-block">Basic code block</h2>
+
+<p>The situation is even worse when there are code blocks, mainly code
+chunks or commands. E.g., copy-paste fails.</p>
+
+<p>Type the following command <code>echo 'Hello World'</code>.</p>
+
+<pre><code class="language-bash">$ echo 'hello world'
+</code></pre>
+
+<p>The following code cannot be compiled:</p>
+<pre><code class="language-C">int main() {
+	int example = 42;
+	switch (example) {
+		case 'a': return 10;
+		default: return 42;
+	}
+}
+</code></pre>
+</div>

data/test/code_blocks_regression.ronn

@@ -0,0 +1,40 @@
+Example Quote Error
+===================
+
+## In the text:
+
+This is Renzo's code.
+
+Debian's lintian returns the following warning:
+acute-accent-in-manual-page 
+
+This manual page uses the \' groff sequence. Usually, the intent to
+generate an apostrophe, but that sequence actually renders as a an acute
+accent.
+    
+For an apostrophe or a single closing quote, use plain '. For single
+opening quote, i.e. a straight downward line ' like the one used in
+shell commands, use \(aq.
+
+## Basic code block
+
+The situation is even worse when there are code blocks, mainly code
+chunks or commands. E.g., copy-paste fails.
+
+Type the following command `echo 'Hello World'`.
+
+``` bash
+$ echo 'hello world'
+```
+
+The following code cannot be compiled:
+``` C
+int main() {
+	int example = 42;
+	switch (example) {
+		case 'a': return 10;
+		default: return 42;
+	}
+}
+```
+

data/test/contest.rb

@@ -0,0 +1,70 @@
+require 'test/unit'
+
+module Test
+  module Unit
+    # TestSuite 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 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 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 should test
+        alias describe context
+      end
+
+      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
+  end
+end

data/test/custom_title_document.html

@@ -0,0 +1,6 @@
+<div class='mp'>
+
+<h1 id="This-is-a-custom-title">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,25 @@
+<div class='mp'>
+
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>definition_list_syntax</code> - <span class="man-whatis">hiya</span>
+</p>
+<p>Definition lists look like unordered lists:</p>
+
+<dl>
+<dt>term</dt>
+<dd>definition</dd>
+<dt>another one</dt>
+<dd>The definition may span
+multiple lines and even
+
+    <p>start</p>
+
+    <p>new paragraphs</p>
+</dd>
+<dt>
+<code>--somearg</code>=<var>VALUE</var>
+</dt>
+<dd>We can do that too.</dd>
+</dl>
+</div>

data/test/definition_list_syntax.roff

@@ -0,0 +1,19 @@
+.TH "DEFINITION_LIST_SYNTAX" "5" "January 1979" ""
+.SH "NAME"
+\fBdefinition_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 @@
+definition_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,19 @@
+.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\.
+.IP "" 4
+.nf
+\&\. A dot on an indented line
+
+\&\. Another dot on an indented line
+
+some text
+some more text
+\&\. A dot on an indented line as part of a paragraph
+.fi
+.IP "" 0
+

data/test/dots_at_line_start_test.ronn

@@ -0,0 +1,12 @@
+There's a weird issue where dots at the beginning of a line
+generate troff warnings due to escaping.
+
+.. let's see what happens.
+
+    . A dot on an indented line
+
+    . Another dot on an indented line
+
+    some text
+    some more text
+    . A dot on an indented line as part of a paragraph

data/test/ellipses.roff

@@ -0,0 +1,7 @@
+.TH "ELLIPSES" "7" "January 1979" ""
+.SH "NAME"
+\fBellipses\fR \- testing ellipses
+.P
+Ellipses should be replaced\|\.\|\.\|\.
+.P
+\|\.\|\.\|\.also, they shouldn't interfere with regular dots at the beginning of a line\.

data/test/ellipses.ronn

@@ -0,0 +1,7 @@
+ellipses(7) -- testing ellipses
+===============================
+
+Ellipses should be replaced...
+
+...also, they shouldn't interfere with regular dots at the beginning
+of a line.

data/test/entity_encoding_test.html

@@ -0,0 +1,42 @@
+<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;       •</li>
+  <li>&amp;nbsp;        </li>
+  <li>&amp;copy;       ©</li>
+  <li>&amp;rdquo;      ”</li>
+  <li>&amp;mdash;      —</li>
+  <li>&amp;reg;        ®</li>
+  <li>&amp;sect;       §</li>
+  <li>&amp;ge;         ≥</li>
+  <li>&amp;le;         ≤</li>
+  <li>&amp;ne;         ≠</li>
+  <li>&amp;equiv;      ≡</li>
+</ul>
+
+<p>Here's a line that uses non-breaking spaces to force the
+last few words to wrap together.</p>
+
+<p>And stuff like this:</p>
+
+<p>git bulk [-g] ([-a]|[-w <ws-name>]) <git command> </git></ws-name><br>
+git bulk --addworkspace <ws-name> <ws-root-directory> (--from <url or file>) </url></ws-root-directory></ws-name><br>
+git bulk --removeworkspace &lt;ws-name&gt; <br></p>
+
+<p>Should have the <code>&amp;lt;</code>/<code>&amp;gt;</code> entities stay as <code>&amp;lt;</code>/<code>&amp;gt;</code> in HTML, but be
+turned into literal brackets in the ROFF.</p>
+</div>

data/test/entity_encoding_test.roff

@@ -0,0 +1,51 @@
+.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 "\(bu" 4
+&bull; \(bu
+.IP "\(bu" 4
+&nbsp; \~
+.IP "\(bu" 4
+&copy; \(co
+.IP "\(bu" 4
+&rdquo; \(rs
+.IP "\(bu" 4
+&mdash; \(em
+.IP "\(bu" 4
+&reg; \(rg
+.IP "\(bu" 4
+&sect; \(sc
+.IP "\(bu" 4
+&ge; \(>=
+.IP "\(bu" 4
+&le; \(<=
+.IP "\(bu" 4
+&ne; \(!=
+.IP "\(bu" 4
+&equiv; \(==
+.IP "" 0
+.P
+Here's a line that uses non\-breaking spaces to force the last\~few\~words\~to\~wrap\~together\.
+.P
+And stuff like this:
+.P
+git bulk [\-g] ([\-a]|[\-w
+.br
+git bulk \-\-addworkspace
+.br
+git bulk \-\-removeworkspace <ws\-name>
+.br
+.P
+Should have the \fB&lt;\fR/\fB&gt;\fR entities stay as \fB&lt;\fR/\fB&gt;\fR in HTML, but be turned into literal brackets in the ROFF\.

data/test/entity_encoding_test.ronn

@@ -0,0 +1,34 @@
+# 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;sect;       &sect;
+  * &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.
+
+And stuff like this:
+
+git bulk [-g] ([-a]|[-w &lt;ws-name&gt;]) &lt;git command&gt; <br/>
+git bulk --addworkspace &lt;ws-name&gt; &lt;ws-root-directory&gt; (--from &lt;URL or file&gt;) <br/>
+git bulk --removeworkspace &lt;ws-name&gt; <br/>
+
+Should have the `&lt;`/`&gt;` entities stay as `&lt;`/`&gt;` in HTML, but be
+turned into literal brackets in the ROFF.

data/test/index.txt

@@ -0,0 +1,8 @@
+# test ronn index
+
+# local manuals
+basic_document(7)             basic_document.ronn
+definition_list_syntax(5)     definition_list_syntax.ronn
+
+# see also
+grep(1)                       http://man.cx/grep(1)