nronn 0.10.1.pre2

data/lib/ronn/roff.rb

@@ -0,0 +1,393 @@
+require 'nokogiri'
+require 'ronn/utils'
+
+module Ronn
+  # Filter for converting HTML to ROFF
+  class RoffFilter
+    include Ronn::Utils
+
+    # Convert Ronn HTML to roff.
+    # The html input is an HTML fragment, not a complete document
+    def initialize(html_fragment, name, section, tagline, manual = nil,
+                   version = nil, date = nil)
+      @buf = []
+      title_heading name, section, tagline, manual, version, date
+      doc = Nokogiri::HTML.fragment(html_fragment)
+      remove_extraneous_elements! doc
+      normalize_whitespace! doc
+      block_filter doc
+      write "\n"
+    end
+
+    def to_s
+      @buf.join.gsub(/[ \t]+$/, '')
+    end
+
+    protected
+
+    def previous(node)
+      return unless node.respond_to?(:previous)
+      prev = node.previous
+      prev = prev.previous until prev.nil? || prev.elem?
+      prev
+    end
+
+    def title_heading(name, section, _tagline, manual, version, date)
+      comment "generated with nRonn/v#{Ronn.version}"
+      comment "https://github.com/n-ronn/nronn/tree/#{Ronn.revision}"
+      return if name.nil?
+      if manual
+        macro 'TH', %("#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}")
+      else
+        macro 'TH', %("#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}")
+      end
+    end
+
+    def remove_extraneous_elements!(doc)
+      doc.traverse do |node|
+        node.parent.children.delete(node) if node.comment?
+      end
+    end
+
+    def normalize_whitespace!(node)
+      if node.is_a?(Array) || node.is_a?(Nokogiri::XML::NodeSet)
+        node.to_a.dup.each { |ch| normalize_whitespace! ch }
+      elsif node.text?
+        preceding = node.previous
+        following = 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.remove
+        else
+          node.content = content
+        end
+      elsif node.elem? && node.name == 'pre'
+        # stop traversing
+      elsif node.elem? && node.children
+        normalize_whitespace! node.children
+      elsif node.elem?
+        # element has no children
+      elsif node.document? || node.fragment?
+        normalize_whitespace! node.children
+      elsif node.is_a?(Nokogiri::XML::DTD) || node.is_a?(Nokogiri::XML::Comment)
+        # ignore
+        nop
+      else
+        warn 'unexpected node during whitespace normalization: %p', node
+      end
+    end
+
+    def block_filter(node)
+      return if node.nil?
+
+      if node.is_a?(Array) || node.is_a?(Nokogiri::XML::NodeSet)
+        node.each { |ch| block_filter(ch) }
+
+      elsif node.document? || node.fragment?
+        block_filter(node.children)
+
+      elsif node.text?
+        # This hack is necessary to support mixed-child-type dd's
+        inline_filter(node)
+
+      elsif node.elem?
+        case node.name
+        when 'html', 'body'
+          block_filter(node.children)
+        when 'div'
+          block_filter(node.children)
+        when 'h1'
+          # discard
+          nop
+        when 'h2'
+          macro 'SH', quote(escape(node.inner_html))
+        when 'h3'
+          macro 'SS', quote(escape(node.inner_html))
+        when 'h4', 'h5', 'h6'
+          # Ronn discourages use of this many heading levels, but if they are used,
+          # we should make them legible instead of ignoring them.
+          macro 'SS', quote(escape(node.inner_html))
+
+        when 'p'
+          prev = previous(node)
+          if prev && %w[dd li blockquote].include?(node.parent.name)
+            macro 'IP'
+          elsif prev && !%w[h1 h2 h3].include?(prev.name)
+            macro 'P'
+          elsif node.previous&.text?
+            macro 'IP'
+          end
+          inline_filter(node.children)
+
+        when 'blockquote'
+          prev = previous(node)
+          indent = prev.nil? || !%w[h1 h2 h3].include?(prev.name)
+          macro 'IP', %w["" 4] if indent
+          block_filter(node.children)
+          macro 'IP', %w["" 0] if indent
+
+        when 'pre'
+          prev = previous(node)
+          indent = prev.nil? || !%w[h1 h2 h3].include?(prev.name)
+          macro 'IP', %w["" 4] if indent
+          macro 'nf'
+          # HACK: strip an initial \n to avoid extra spacing
+          if node.children && node.children[0].text?
+            text = node.children[0].to_s
+            node.children[0].replace(text[1..-1]) if text.start_with? "\n"
+          end
+          inline_filter(node.children)
+          macro 'fi'
+          macro 'IP', %w["" 0] if indent
+
+        when 'dl'
+          macro 'TP'
+          block_filter(node.children)
+        when 'dt'
+          prev = previous(node)
+          macro 'TP' unless prev.nil?
+          inline_filter(node.children)
+          write "\n"
+        when 'dd'
+          if node.at('p')
+            block_filter(node.children)
+          else
+            inline_filter(node.children)
+          end
+          write "\n"
+
+        when 'ol', 'ul'
+          block_filter(node.children)
+          macro 'IP', %w["" 0]
+        when 'li'
+          case node.parent.name
+          when 'ol'
+            macro 'IP', %W["#{node.parent.children.index(node) + 1}." 4]
+          when 'ul'
+            macro 'IP', ['"\(bu"', '4']
+          else
+            raise "List element found as a child of non-list parent element: #{node.inspect}"
+          end
+          if node.at('p,ol,ul,dl,div')
+            block_filter(node.children)
+          else
+            inline_filter(node.children)
+          end
+          write "\n"
+
+        when 'span', 'code', 'b', 'strong', 'kbd', 'samp', 'var', 'em', 'i',
+             'u', 'br', 'a'
+          inline_filter(node)
+
+        when 'table'
+          macro 'TS'
+          write "allbox;\n"
+          block_filter(node.children)
+          macro 'TE'
+        when 'thead'
+          # Convert to format section and first row
+          tr = node.children[0]
+          header_contents = []
+          cell_formats = []
+          tr.children.each do |th|
+            style = th['style']
+            cell_format = case style
+                          when 'text-align:left;'
+                            'l'
+                          when 'text-align:right;'
+                            'r'
+                          when 'text-align:center;'
+                            'c'
+                          else
+                            'l'
+                          end
+            header_contents << th.inner_html
+            cell_formats << cell_format
+          end
+          write cell_formats.join(' ') + ".\n"
+          write header_contents.join("\t") + "\n"
+        when 'th'
+          raise 'internal error: unexpected <th> element'
+        when 'tbody'
+          # Let the 'tr' handle it
+          block_filter(node.children)
+        when 'tr'
+          # Convert to a table data row
+          node.children.each do |child|
+            block_filter(child)
+            write "\t"
+          end
+          write "\n"
+        when 'td'
+          inline_filter(node.children)
+
+        else
+          warn 'unrecognized block tag: %p', node.name
+        end
+
+      elsif node.is_a?(Nokogiri::XML::DTD)
+        # Ignore
+        nop
+      elsif node.is_a?(Nokogiri::XML::Comment)
+        # Ignore
+        nop
+      else
+        raise "unexpected node: #{node.inspect}"
+      end
+    end
+
+    def inline_filter(node)
+      return unless node # is an empty node
+
+      if node.is_a?(Array) || node.is_a?(Nokogiri::XML::NodeSet)
+        node.each { |ch| inline_filter(ch) }
+
+      elsif node.text?
+        text = node.to_html.dup
+        write escape(text)
+
+      elsif node.comment?
+        # ignore HTML comments
+
+      elsif node.elem?
+        case node.name
+        when 'span'
+          inline_filter(node.children)
+
+        when 'code'
+          if child_of?(node, 'pre')
+            inline_filter(node.children)
+          else
+            write '\fB'
+            inline_filter(node.children)
+            write '\fR'
+          end
+
+        when 'b', 'strong', 'kbd', 'samp'
+          write '\fB'
+          inline_filter(node.children)
+          write '\fR'
+
+        when 'var', 'em', 'i', 'u'
+          write '\fI'
+          inline_filter(node.children)
+          write '\fR'
+
+        when 'br'
+          macro 'br'
+
+        when 'a'
+          if node.classes.include?('man-ref')
+            inline_filter(node.children)
+          elsif node.has_attribute?('data-bare-link')
+            write '\fI'
+            inline_filter(node.children)
+            write '\fR'
+          else
+            inline_filter(node.children)
+            write ' '
+            write '\fI'
+            write escape(node.attributes['href'].content)
+            write '\fR'
+          end
+
+        when 'sup'
+          # This superscript equivalent is a big ugly hack.
+          write '^('
+          inline_filter(node.children)
+          write ')'
+
+        else
+          warn 'unrecognized inline tag: %p', node.name
+        end
+
+      else
+        raise "unexpected node: #{node.inspect}"
+      end
+    end
+
+    def maybe_new_line
+      write "\n" if @buf.last && @buf.last[-1] != "\n"
+    end
+
+    def macro(name, value = nil)
+      maybe_new_line
+      writeln ".#{[name, value].compact.join(' ')}"
+    end
+
+    HTML_ROFF_ENTITIES = {
+      '•' => '\(bu',
+      '&lt;' => '<',
+      '&gt;' => '>',
+      ' ' => '\~', # That's a literal non-breaking space character there
+      '©' => '\(co',
+      '”' => '\(rs',
+      '—' => '\(em',
+      '®' => '\(rg',
+      '§' => '\(sc',
+      '≥' => '\(>=',
+      '≤' => '\(<=',
+      '≠' => '\(!=',
+      '≡' => '\(=='
+    }.freeze
+
+    def escape(text)
+      return text.to_s if text.nil? || text.empty?
+      ent = HTML_ROFF_ENTITIES
+      text = text.dup
+      text.gsub!(/&#x([0-9A-Fa-f]+);/) { $1.to_i(16).chr }  # hex entities
+      text.gsub!(/&#(\d+);/) { $1.to_i.chr }                # dec entities
+      text.gsub!('\\', '\e')                                # backslash
+      text.gsub!('...', '\|.\|.\|.')                        # ellipses
+      text.gsub!(/[.-]/) { |m| "\\#{m}" }                   # control chars
+      ent.each do |key, val|
+        text.gsub!(key, val)
+      end
+      text.gsub!('&amp;', '&')                              # amps
+      text
+    end
+
+    def quote(text)
+      "\"#{text.gsub(/"/, '\\"')}\""
+    end
+
+    # write text to output buffer
+    def write(text)
+      return if text.nil? || text.empty?
+      # lines cannot start with a '.' or "'". insert zero-width character before.
+      text = text.gsub(/\n\\\./, "\n\\\\&\\.")
+      text = text.gsub(/\n'/, "\n\\&\\'")
+      buf_ends_in_newline = @buf.last && @buf.last[-1] == "\n"
+      @buf << '\&' if text[0, 2] == '\.' && buf_ends_in_newline
+      @buf << '\&' if text[0, 1] == "'" && buf_ends_in_newline
+      @buf << text
+    end
+
+    # write text to output buffer on a new line.
+    def writeln(text)
+      maybe_new_line
+      write text
+      write "\n"
+    end
+
+    def comment(text)
+      writeln %(.\\" #{text})
+    end
+
+    def warn(text, *args)
+      Kernel.warn format("warn: #{text}", args)
+    end
+
+    def nop
+      # Do nothing
+    end
+  end
+end

data/lib/ronn/server.rb

@@ -0,0 +1,67 @@
+require 'ronn'
+require 'rack'
+require 'sinatra/base'
+
+module Ronn
+  # Ronn HTTP server. Serves a list of .ronn files as HTML. The options Hash is
+  # passed to Ronn::Document.new on each invocation.
+  #
+  # Use Ronn::Server.new to create a Rack app. See the config.ru file in the
+  # root of the Ronn distribution for example usage.
+  #
+  # Ronn::Server.run starts a server on port 1207.
+  module Server
+    def self.new(files, options = {})
+      files = Dir[files] if files.respond_to?(:to_str)
+      raise ArgumentError, 'no files' if files.empty?
+      Sinatra.new do
+        set :show_exceptions, true
+        set :public_dir, File.expand_path(__FILE__, '../templates')
+        set :static, false
+        set :views, File.expand_path(__FILE__, '../templates')
+
+        get '/' do
+          files.map do |f|
+            base = File.basename(f, '.ronn')
+            "<li><a href='./#{base}.html'>#{escape_html(base)}</a></li>"
+          end
+        end
+
+        options[:styles] ||= options[:style]
+        my_styles = if options[:styles].respond_to?(:to_ary)
+                      options[:styles]
+                    elsif options[:styles]
+                      options[:styles].split(/[, ]+/)
+                    else
+                      []
+                    end
+
+        files.each do |file|
+          basename = File.basename(file, '.ronn')
+
+          get "/#{basename}.html" do
+            options = options.merge(styles: my_styles)
+            %w[date manual organization].each do |attribute|
+              next unless params[attribute]
+              options[attribute] = params[attribute]
+            end
+            Ronn::Document.new(file, options).to_html
+          end
+          get "/#{basename}.roff" do
+            content_type 'text/plain+roff'
+            Ronn::Document.new(file, options.dup).to_roff
+          end
+        end
+      end
+    end
+
+    def self.run(files, options = {})
+      port_number = options['port'] || 1207
+      new(files, options).run!(
+        server:  %w[mongrel thin webrick],
+        port:    port_number,
+        logging: true
+      )
+    end
+  end
+end

data/lib/ronn/template/80c.css

@@ -0,0 +1,6 @@
+/* 80c.css - condense width to emulate a classical 80 character terminal */
+
+.mp                       { max-width:86ex }
+
+ /* .mp width + padding */
+.man-navigation           { left:101ex }

data/lib/ronn/template/dark.css

@@ -0,0 +1,18 @@
+.mp, body#manpage {
+  background:#080706;
+  color:#888;
+}
+.mp, .mp code, .mp pre,
+.mp pre code, .mp tt, .mp kbd,
+.mp samp                            { color:#aaa }
+.mp h1, .mp h2, .mp h3, .mp h4      { color:#fff }
+.man-decor, .man-decor ol li        { color:#666 }
+.mp code, .mp strong, .mp b         { color:#fff }
+
+.mp em, .mp var, .mp u              { color:#ddd }
+
+.mp pre code                        { color:#ddd }
+
+.mp a, .mp a:link, .mp a:hover,
+.mp a code, .mp a pre, .mp a tt,
+.mp a kbd, .mp a samp              { color:#fff }

data/lib/ronn/template/darktoc.css

@@ -0,0 +1,17 @@
+/* darktoc.css - enable table of contents */
+
+.man-navigation {
+    border-left:2px solid #222;
+    background-color:#131211;
+}
+.man-navigation a,
+.man-navigation a:hover,
+.man-navigation a:link,
+.man-navigation a:visited {
+    color:#777;
+    text-decoration:none;
+}
+.man-navigation a:hover {
+    color:#fff;
+    text-decoration:underline;
+}

data/lib/ronn/template/default.html

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' content='text/html;charset=utf8'>
+  <meta name='generator' content='{{ generator }}'>
+  <title>{{ title }}</title>
+  {{{ stylesheet_tags }}}
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    {{#section_heads}}
+    <a href="#{{id}}">{{text}}</a>
+    {{/section_heads}}
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>{{ page_name }}</li>
+    <li class='tc'>{{ manual }}</li>
+    <li class='tr'>{{ page_name }}</li>
+  </ol>
+
+  {{{ html }}}
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>{{ organization }}</li>
+    <li class='tc'>{{ date }}</li>
+    <li class='tr'>{{ page_name }}</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/lib/ronn/template/man.css

@@ -0,0 +1,100 @@
+/* man.css - core manpage styles */
+
+/* STRUCTURE, INDENT, MARGINS */
+
+body#manpage                        { margin:0 }
+.mp {
+    max-width:100ex;
+    padding:0 9ex 1ex 4ex;
+}
+
+.mp p,  .mp pre,
+.mp ul, .mp ol, .mp dl              { margin:0 0 20px 0 }
+.mp h2                              { margin:10px 0 0 0 }
+
+.mp > p, .mp > pre, .mp > ul,
+.mp > ol, .mp > dl                  { margin-left:8ex }
+.mp h3                              { margin:0 0 0 4ex }
+
+.mp dt                              { margin:0; clear:left }
+.mp dt.flush                        { float:left; width:8ex }
+.mp dd                              { margin:0 0 0 9ex }
+.mp h1, .mp h2, .mp h3, .mp h4      { clear:left }
+
+.mp pre                             { margin-bottom:20px }
+.mp pre+h2, .mp pre+h3              { margin-top:22px }
+.mp h2+pre, .mp h3+pre              { margin-top:5px }
+
+.mp img                             { display:block;margin:auto }
+.mp h1.man-title                    { display:none }
+
+/* FONTS */
+
+.mp, .mp code, .mp pre, .mp tt,
+.mp kbd, .mp samp, .mp h3, .mp h4 {
+    font-family:monospace;
+    font-size:14px;
+    line-height:1.42857142857143;
+}
+.mp h2 {
+  font-size:16px;
+  line-height:1.25;
+}
+.mp h1 {
+  font-size:20px;
+  line-height:2;
+}
+
+/* TEXT STYLES */
+
+.mp {
+  text-align:justify;
+  background:#fff;
+}
+.mp, .mp code, .mp pre,
+.mp pre code, .mp tt, .mp kbd,
+.mp samp                            { color:#131211 }
+.mp h1, .mp h2, .mp h3, .mp h4      { color:#030201 }
+.mp u                               { text-decoration:underline; }
+
+.mp code, .mp strong, .mp b {
+    font-weight:bold;
+    color:#131211;
+}
+
+.mp em, .mp var {
+    font-style:italic;
+    color:#232221;
+    text-decoration:none;
+}
+
+/* LINKS */
+
+.mp a, .mp a:link, .mp a:hover,
+.mp a code, .mp a pre, .mp a tt,
+.mp a kbd, .mp a samp              { color:#0000ff }
+
+.mp b.man-ref                      { font-weight:normal;color:#434241 }
+
+/* PREFORMATTED BLOCKS */
+
+.mp pre                            { padding:0 4ex }
+.mp pre code                       { font-weight:normal;color:#434241 }
+.mp h2+pre, h3+pre                 { padding-left:0 }
+
+/* DOCUMENT HEADER AND FOOTER AREAS */
+
+ol.man-decor, ol.man-decor li {
+    margin:3px 0 10px 0;
+    padding:0;
+    float:left;
+    width:33%;
+    list-style-type:none;
+    text-transform:uppercase;
+    color:#999;
+    letter-spacing:1px;
+}
+ol.man-decor                  { width:100% }
+ol.man-decor li.tl            { text-align:left }
+ol.man-decor li.tc            { text-align:center; letter-spacing:4px }
+ol.man-decor li.tr            { text-align:right; float:right }

data/lib/ronn/template/print.css

@@ -0,0 +1,5 @@
+.mp { max-width:none }
+.man-navigation { display:none !important }
+.mp a[href]:not([href^="#"]):not([data-bare-link]):after {
+  content:" " attr(href);
+}