ronn 0.6.0 → 0.6.6

data/CHANGES

@@ -1,8 +1,14 @@
 Ronn CHANGES
 ============
 
-Version 0.6 (not yet released)
-------------------------------
+Version 0.6.6 (2010 June 13)
+----------------------------
+
+Small bug fix release fixes whitespace stripping between adjacent
+inline elements in roff output (adamv, rtomayko)
+
+Version 0.6 (2010 June 13)
+--------------------------
 
 Features:
 

data/Rakefile

@@ -82,6 +82,8 @@ task :rev do
   data = File.read('lib/ronn.rb')
   data.gsub!(/^( *)REV *=.*/, "\\1REV = '#{rev}'")
   File.open('lib/ronn.rb', 'wb') { |fd| fd.write(data) }
+  puts "revision: #{rev}"
+  puts "version:  #{`ruby -Ilib -rronn -e 'puts Ronn::VERSION'`}"
 end
 
 require 'rubygems'

data/lib/ronn.rb

@@ -10,7 +10,7 @@ module Ronn
   end
 
   # bring REV up to date with: rake rev
-  REV = '0.6.0'
+  REV = '0.6-6-gd7645f2'
   VERSION = REV[/(?:[\d.]+)(?:-\d+)?/].tr('-', '.')
 
   def self.release?

data/lib/ronn/document.rb

@@ -4,6 +4,7 @@ require 'hpricot'
 require 'rdiscount'
 require 'ronn/roff'
 require 'ronn/template'
+require 'ronn/utils'
 
 module Ronn
   # The Document class can be used to load and inspect a ronn document
@@ -15,6 +16,8 @@ module Ronn
   # generated documentation unless overridden by the information
   # extracted from the document's name section.
   class Document
+    include Ronn::Utils
+
     attr_reader :path, :data
 
     # The man pages name: usually a single word name of
@@ -318,7 +321,7 @@ module Ronn
         contents = $1
         tag, attrs = contents.split(' ', 2)
         if attrs =~ /\/=/ ||
-           HTML.include?(tag.sub(/^\//, '')) ||
+           html_element?(tag.sub(/^\//, '')) ||
            data.include?("</#{tag}>")
           match.to_s
         else
@@ -340,16 +343,6 @@ module Ronn
       end
       data
     end
-
-    HTML = %w[
-      a abbr acronym b bdo big br cite code dfn
-      em i img input kbd label q samp select
-      small span strong sub sup textarea tt var
-      address blockquote div dl fieldset form
-      h1 h2 h3 h4 h5 h6 hr noscript ol p pre
-      table ul
-    ].to_set
-
   private
     def parse_html(html)
       if html.respond_to?(:doc?) && html.doc?

data/lib/ronn/roff.rb

@@ -1,13 +1,18 @@
 require 'hpricot'
+require 'ronn/utils'
 
 module Ronn
   class RoffFilter
+    include Ronn::Utils
+
     # Convert Ronn HTML to roff.
     def initialize(html, name, section, tagline, manual=nil, version=nil, date=nil)
       @buf = []
       title_heading name, section, tagline, manual, version, date
-      html = Hpricot(html)
-      block_filter(normalize_whitespace(html))
+      doc = Hpricot(html)
+      remove_extraneous_elements! doc
+      normalize_whitespace! doc
+      block_filter doc
       write "\n"
     end
 
@@ -38,30 +43,50 @@ module Ronn
     def title_heading(name, section, tagline, manual, version, date)
       comment "generated with Ronn/v#{Ronn::VERSION}"
       comment "http://github.com/rtomayko/ronn/"
+      return if name.nil?
       macro "TH", %["#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}"]
     end
 
-    def normalize_whitespace(node)
-      if node.kind_of?(Array) || node.kind_of?(Hpricot::Elements)
-        node.each { |ch| normalize_whitespace(ch) }
-      elsif node.doc? || (node.elem? && node.children)
-        normalize_whitespace(node.children)
-      elsif node.text? && !child_of?(node, 'pre')
-        node.content = node.content.gsub(/[\n ]+/m, ' ')
-        node_prev = previous(node)
-        if (node.previous && node.previous.elem?) &&
-           (node.next && node.next.elem?) &&
-           (node.content.strip == '')
-          node.content = ''
+    def remove_extraneous_elements!(doc)
+      doc.traverse_all_element do |node|
+        if node.comment? || node.procins? || node.doctype? || node.xmldecl?
+          warn 'removing: %p' % [node]
+          node.parent.children.delete(node)
+        end
+      end
+    end
+
+    def normalize_whitespace!(node)
+      case
+      when node.kind_of?(Array) || node.kind_of?(Hpricot::Elements)
+        node.to_a.dup.each { |ch| normalize_whitespace! ch }
+      when node.text?
+        preceding, following = node.previous, node.next
+        content = node.content.gsub(/[\n ]+/m, ' ')
+        if preceding.nil? || block_element?(preceding.name) ||
+           preceding.name == 'br'
+          content.lstrip!
+        end
+        if following.nil? || block_element?(following.name) ||
+           following.name == 'br'
+          content.rstrip!
+        end
+        if content.empty?
+          node.parent.children.delete(node)
         else
-          node.content = node.content.lstrip if node_prev.nil?
-          node.content = node.content.rstrip if node.next.nil?
+          node.content = content
         end
-      elsif node.elem? || node.text?
+      when node.elem? && node.name == 'pre'
+        # stop traversing
+      when node.elem? && node.children
+        normalize_whitespace! node.children
+      when node.elem?
+        # element has no children
+      when node.doc?
+        normalize_whitespace! node.children
       else
-        warn "unrecognized tag: %p", node.name
+        warn "unexpected node during whitespace normalization: %p", node.name
       end
-      node
     end
 
     def block_filter(node)
@@ -72,7 +97,6 @@ module Ronn
         block_filter(node.children)
 
       elsif node.text?
-        return if node.to_html =~ /^\s*$/m
         warn "unexpected text: %p",  node
 
       elsif node.elem?
@@ -207,7 +231,6 @@ module Ronn
         gsub(' ', ' ').
         gsub('&lt;',   '<').
         gsub('&gt;',   '>').
-        gsub('&gt;',   '>').
         gsub(/&#x([0-9A-Fa-f]+);/) { $1.to_i(16).chr }.
         gsub(/&#(\d+);/)           { $1.to_i.chr }.
         gsub('&amp;',  '&').

data/lib/ronn/utils.rb

@@ -0,0 +1,47 @@
+require 'set'
+require 'cgi'
+
+module Ronn
+  module Utils
+
+    # All HTML 4 elements and some that are in common use.
+    HTML = %w[
+      a abbr acronym address applet area b base basefont bdo big blockquote body br
+      button caption center cite code col colgroup dd del dfn dir div dl dt em
+      fieldset font form frame frameset h1 h2 h3 h4 h5 h6 head hr html i iframe img
+      input ins isindex kbd label legend li link map menu meta noframes noscript
+      object ol optgroup option p param pre q s samp script select small span strike
+      strong style sub sup table tbody td textarea tfoot th thead title tr tt u ul var
+    ].to_set
+
+    # Block elements.
+    HTML_BLOCK = %w[
+      blockquote body colgroup dd div dl dt fieldset form frame frameset
+      h1 h2 h3 h4 h5 h6 hr head html iframe li noframes noscript
+      object ol optgroup option p param pre script select
+      style table tbody td textarea tfoot th thead title tr tt ul
+    ].to_set
+
+    # Inline elements
+    HTML_INLINE = HTML - HTML_BLOCK
+
+    # Elements that don't have a closing tag.
+    HTML_EMPTY  = %w[area base basefont br col hr input link meta].to_set
+
+    def block_element?(name)
+      HTML_BLOCK.include?(name)
+    end
+
+    def inline_element?(name)
+      HTML_INLINE.include?(name)
+    end
+
+    def empty_element?(name)
+      HTML_EMPTY.include?(name)
+    end
+
+    def html_element?(name)
+      HTML.include?(name)
+    end
+  end
+end

data/man/ronn.1

@@ -1,7 +1,7 @@
-.\" generated with Ronn/v0.6.0
+.\" generated with Ronn/v0.6.6
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "RONN" "1" "June 2010" "0.6.0" "Ronn 0.6.0"
+.TH "RONN" "1" "June 2010" "0.6-6-gd7645f2" "Ronn 0.6.6"
 .
 .SH "NAME"
 \fBronn\fR \- convert markdown files to manpages
@@ -10,16 +10,16 @@
 \fBronn\fR [\fIoptions\fR] \fIfile\fR\.\.\.
 .
 .br
-\fBronn\fR\fB\-m\fR|\fB\-\-man\fR\fIfile\fR\.\.\.
+\fBronn\fR \fB\-m\fR|\fB\-\-man\fR \fIfile\fR\.\.\.
 .
 .br
-\fBronn\fR\fB\-S\fR|\fB\-\-server\fR\fIfile\fR\.\.\.
+\fBronn\fR \fB\-S\fR|\fB\-\-server\fR \fIfile\fR\.\.\.
 .
 .br
-\fBronn\fR\fB\-\-pipe\fR\fIfile\fR
+\fBronn\fR \fB\-\-pipe\fR \fIfile\fR
 .
 .br
-\fBronn\fR\fI<file\fR
+\fBronn\fR < \fIfile\fR
 .
 .SH "DESCRIPTION"
 \fBRonn\fR converts Markdown input to standard roff\-formatted UNIX manpages or manpage styled HTML\. The ronn(5) source format is based on markdown(7) but includes additional rules and syntax geared toward authoring manuals\.

data/man/ronn.1.ronn

@@ -7,7 +7,7 @@ ronn(1) -- convert markdown files to manpages
 `ronn` `-m`|`--man` <file>...<br>
 `ronn` `-S`|`--server` <file>...<br>
 `ronn` `--pipe` <file><br>
-`ronn` < <file>
+`ronn` &lt; <file>
 
 ## DESCRIPTION
 

data/man/ronn.5

@@ -1,7 +1,7 @@
-.\" generated with Ronn/v0.6.0
+.\" generated with Ronn/v0.6.6
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "RONN" "5" "June 2010" "0.6.0" "Ronn 0.6.0"
+.TH "RONN" "5" "June 2010" "0.6-6-gd7645f2" "Ronn 0.6.6"
 .
 .SH "NAME"
 \fBronn\fR \- markdown\-based text format for authoring manpages

data/man/ronn.7

@@ -1,7 +1,7 @@
-.\" generated with Ronn/v0.6.0
+.\" generated with Ronn/v0.6.6
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "RONN" "7" "June 2010" "0.6.0" "Ronn 0.6.0"
+.TH "RONN" "7" "June 2010" "0.6-6-gd7645f2" "Ronn 0.6.6"
 .
 .SH "NAME"
 \fBronn\fR \- the opposite of roff
@@ -162,7 +162,7 @@ Ronn aims to address many of the issues with manpage creation while preserving t
 Ronn is Copyright (C) 2009 Ryan Tomayko \fIhttp://tomayko\.com/about\fR
 .
 .br
- See the file COPYING for information of licensing and distribution\.
+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)

data/ronn.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'ronn'
-  s.version = '0.6.0'
+  s.version = '0.6.6'
   s.date = '2010-06-13'
 
   s.description = "The opposite of roff"
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     lib/ronn/template/print.css
     lib/ronn/template/screen.css
     lib/ronn/template/toc.css
+    lib/ronn/utils.rb
     man/ronn.1
     man/ronn.1.ronn
     man/ronn.5
@@ -58,12 +59,16 @@ Gem::Specification.new do |s|
     test/middle_paragraph.html
     test/middle_paragraph.roff
     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/titleless_document.html
     test/titleless_document.ronn
+    test/underline_spacing_test.roff
+    test/underline_spacing_test.ronn
   ]
   # = MANIFEST =
 

data/test/markdown_syntax.html

@@ -98,7 +98,7 @@ This is another regular paragraph.
 HTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code> inside an
 HTML block.</p>
 
-<p>Span-level HTML tags -- e.g. <code>&lt;span&gt;</code>, <code>&lt;cite&gt;</code>, or <code>&lt;del></code> -- can be
+<p>Span-level HTML tags -- e.g. <code>&lt;span&gt;</code>, <code>&lt;cite&gt;</code>, or <code>&lt;del&gt;</code> -- can be
 used anywhere in a Markdown paragraph, list item, or header. If you
 want, you can even use HTML tags instead of Markdown formatting; e.g. if
 you'd prefer to use HTML <code>&lt;a&gt;</code> or <code>&lt;img&gt;</code> tags instead of Markdown's

data/test/missing_spaces.roff

@@ -0,0 +1,6 @@
+.TH "MISSING_SPACES" "" "January 1979" "" ""
+.
+.TP
+\fB\-S\fR \fItext\fR, \fBsearch\fR \fItext\fR
+Performs a substring search of formula names for \fItext\fR\.
+

data/test/missing_spaces.ronn

@@ -0,0 +1,2 @@
+ * `-S` <text>, `search` <text>:
+   Performs a substring search of formula names for <text>.

data/test/underline_spacing_test.roff

@@ -0,0 +1,16 @@
+.TH "UNDERLINE_SPACING_TEST" "" "January 1979" "" ""
+This input
+.
+.TP
+\fB\-S\fR \fItext\fR, \fBsearch\fR \fItext\fR
+Performs a substring search of formula names for \fItext\fR\.
+.
+.TP
+\fB\-O\fR \fItext\fR, \fBother\fR \fItext\fR
+Does something else\.
+.
+.P
+Should space text properly\.
+.
+.P
+\fI!\-\- this is a comment \-\-\fR

data/test/underline_spacing_test.ronn

@@ -0,0 +1,11 @@
+This input
+
+ * `-S` _text_, `search` _text_:
+    Performs a substring search of formula names for _text_.
+
+ * `-O` <text>, `other` <text>:
+    Does something else.
+
+Should space text properly.
+
+<!-- this is a comment -->

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 6
+  version: 0.6.6
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -89,6 +89,7 @@ files:
 - lib/ronn/template/print.css
 - lib/ronn/template/screen.css
 - lib/ronn/template/toc.css
+- lib/ronn/utils.rb
 - man/ronn.1
 - man/ronn.1.ronn
 - man/ronn.5
@@ -116,12 +117,16 @@ files:
 - test/middle_paragraph.html
 - test/middle_paragraph.roff
 - 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/titleless_document.html
 - test/titleless_document.ronn
+- test/underline_spacing_test.roff
+- test/underline_spacing_test.ronn
 has_rdoc: true
 homepage: http://github.com/rtomayko/ronn/
 licenses: []