RubyGems - ronn-ng - Versions diffs - 0.7.4 → 0.8.0.SNAPSHOT - Mend

ronn-ng 0.7.4 → 0.8.0.SNAPSHOT

Files changed (63) hide show

checksums.yaml +4 -4
data/CHANGES +12 -3
data/Gemfile +2 -0
data/INSTALLING.md +100 -0
data/README.md +19 -1
data/Rakefile +39 -49
data/bin/ronn +93 -75
data/completion/bash/ronn +32 -0
data/completion/zsh/_ronn +24 -0
data/config.ru +3 -3
data/lib/ronn/document.rb +127 -106
data/lib/ronn/index.rb +8 -9
data/lib/ronn/roff.rb +153 -76
data/lib/ronn/server.rb +19 -22
data/lib/ronn/template.rb +27 -26
data/lib/ronn/utils.rb +9 -7
data/lib/ronn.rb +5 -3
data/man/ronn-format.7 +6 -62
data/man/ronn.1 +21 -123
data/man/ronn.1.ronn +8 -0
data/ronn-ng.gemspec +38 -13
data/test/angle_bracket_syntax.html +4 -5
data/test/backticks.html +14 -0
data/test/backticks.ronn +10 -0
data/test/basic_document.html +3 -4
data/test/basic_document.ronn +2 -2
data/test/circumflexes.ronn +1 -0
data/test/code_blocks.7.ronn +41 -0
data/test/contest.rb +56 -54
data/test/custom_title_document.html +2 -2
data/test/definition_list_syntax.html +13 -9
data/test/definition_list_syntax.roff +2 -9
data/test/definition_list_syntax.ronn +2 -2
data/test/dots_at_line_start_test.roff +12 -3
data/test/dots_at_line_start_test.ronn +8 -0
data/test/ellipses.roff +7 -0
data/test/ellipses.ronn +7 -0
data/test/entity_encoding_test.html +13 -14
data/test/entity_encoding_test.roff +1 -22
data/test/entity_encoding_test.ronn +1 -1
data/test/markdown_syntax.html +4 -5
data/test/markdown_syntax.roff +1 -561
data/test/middle_paragraph.html +2 -3
data/test/middle_paragraph.roff +1 -5
data/test/middle_paragraph.ronn +1 -1
data/test/missing_spaces.roff +0 -2
data/test/nested_list.ronn +19 -0
data/test/nested_list_with_code.html +15 -0
data/test/nested_list_with_code.roff +11 -0
data/test/nested_list_with_code.ronn +6 -0
data/test/page.with.periods.in.name.5.ronn +4 -0
data/test/pre_block_with_quotes.roff +0 -5
data/test/section_reference_links.html +2 -3
data/test/section_reference_links.roff +1 -4
data/test/section_reference_links.ronn +1 -1
data/test/tables.ronn +24 -0
data/test/test_ronn.rb +49 -35
data/test/test_ronn_document.rb +81 -81
data/test/test_ronn_index.rb +11 -11
data/test/titleless_document.html +0 -1
data/test/underline_spacing_test.roff +0 -8
metadata +140 -22
data/INSTALLING +0 -20

data/test/backticks.ronn ADDED Viewed

@@ -0,0 +1,10 @@
+backticks(7) -- testing the link index with backticks
+=====================================================
+grep(1)
+`grep`(1)
+man(1)
+`man`(1)

data/test/basic_document.html CHANGED Viewed

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

data/test/basic_document.ronn CHANGED Viewed

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

data/test/circumflexes.ronn ADDED Viewed

	@@ -0,0 +1 @@
1	+ y = 2^x

data/test/code_blocks.7.ronn ADDED Viewed

@@ -0,0 +1,41 @@
+Example Code Blocks
+===================
+## Basic code block
+```
+Hello, world!
+```
+## Language-identified code blocks
+```html
+<html>
+  <head>
+    <title>Hello, world!</title>
+  </head>
+  <body>
+    Hello, world!
+  </body>
+</html>
+```
+## Interspersed code blocks and text
+Some text.
+```
+Some code.
+```
+Here's some &lt;pre> text.
+<pre>
+    This is pre text.
+</pre>
+Some more text.
+```
+Some more code.
+```

data/test/contest.rb CHANGED Viewed

@@ -1,68 +1,70 @@
-require "test/unit"
+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)
+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
-  end
-  def self.teardown(&block)
-    define_method :teardown do
-      instance_eval(&block)
-      super(&block)
-    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.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.teardown(&block)
+        define_method :teardown do
+          instance_eval(&block)
+          super(&block)
+        end
+      end
-  def self.test(name, &block)
-    define_method(test_name(name), &block)
-  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
-  class << self
-    alias_method :should, :test
-    alias_method :describe, :context
-  end
+      def self.test(name, &block)
+        define_method(test_name(name), &block)
+      end
-private
+      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.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.test_name(name)
+        "test_#{sanitize_name(name).gsub(/\s+/, '_')}".to_sym
+      end
-  def self.sanitize_name(name)
-    name.gsub(/\W+/, ' ').strip
-  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)
+      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 CHANGED Viewed

@@ -1,6 +1,6 @@
 <div class='mp'>
-<h1>This is a custom title</h1>
+<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/definition_list_syntax.html CHANGED Viewed

@@ -1,21 +1,25 @@
 <div class='mp'>
 <h2 id="NAME">NAME</h2>
 <p class="man-name">
-  <code>defition_list_syntax</code> - <span class="man-whatis">hiya</span>
+  <code>definition_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>
+<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><p>We can do that too.</p></dd>
+<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 CHANGED Viewed

@@ -1,25 +1,18 @@
-.TH "DEFITION_LIST_SYNTAX" "5" "January 1979" "" ""
-.
+.TH "DEFINITION_LIST_SYNTAX" "5" "January 1979" "" ""
 .SH "NAME"
-\fBdefition_list_syntax\fR \- hiya
-.
+\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 CHANGED Viewed

@@ -1,5 +1,5 @@
-defition_list_syntax(5) -- hiya
-===============================
+definition_list_syntax(5) -- hiya
+=================================
 Definition lists look like unordered lists:

data/test/dots_at_line_start_test.roff CHANGED Viewed

@@ -1,10 +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 CHANGED Viewed

@@ -2,3 +2,11 @@ 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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -1,9 +1,9 @@
 <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
@@ -15,21 +15,20 @@
 <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>
+<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&nbsp;few&nbsp;words&nbsp;to&nbsp;wrap&nbsp;together.</p>
+last few words to wrap together.</p>
 </div>

data/test/entity_encoding_test.roff CHANGED Viewed

@@ -1,61 +1,40 @@
 .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
-.
+&sect; \(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 CHANGED Viewed

@@ -15,7 +15,7 @@ Here's some special entities:
   * &amp;rdquo;      &rdquo;
   * &amp;mdash;      &mdash;
   * &amp;reg;        &reg;
-  * &amp;sec;        &sec;
+  * &amp;sect;       &sect;
   * &amp;ge;         &ge;
   * &amp;le;         &le;
   * &amp;ne;         &ne;

data/test/markdown_syntax.html CHANGED Viewed

@@ -1,9 +1,9 @@
 <div class='mp'>
 <h2 id="NAME">NAME</h2>
 <p class="man-name">
   <code>markdown</code> - <span class="man-whatis">humane markup syntax</span>
 </p>
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 <pre><code># Header 1 #
@@ -508,7 +508,7 @@ end tell
 <p>A code block continues until it reaches a line that is not indented
 (or the end of the article).</p>
-<p>Within a code block, ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> and <code>></code>)
+<p>Within a code block, ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> and <code>&gt;</code>)
 are automatically converted into HTML entities. This makes it very
 easy to include example HTML source code using Markdown -- just paste
 it and indent it, and Markdown will handle the hassle of encoding the
@@ -816,7 +816,7 @@ A backtick-delimited string in a code span: `` `foo` ``
 entities automatically, which makes it easy to include example HTML
 tags. Markdown will turn this:</p>
-<pre><code>Please don't use any `&lt;blink>` tags.
+<pre><code>Please don't use any `&lt;blink&gt;` tags.
 </code></pre>
 <p>into:</p>
@@ -951,7 +951,6 @@ also by John Gruber.</p>
 <h2 id="SEE-ALSO">SEE ALSO</h2>
-<p><span class="man-ref">ronn<span class="s">(5)</span></span><br />
+<p><span class="man-ref">ronn<span class="s">(5)</span></span><br>
 <a href="http://daringfireball.net/projects/markdown/" data-bare-link="true">http://daringfireball.net/projects/markdown/</a></p>
 </div>