ronn 0.5 → 0.6.0

data/lib/ronn/roff.rb

@@ -7,7 +7,7 @@ module Ronn
       @buf = []
       title_heading name, section, tagline, manual, version, date
       html = Hpricot(html)
-      block_filter(html)
+      block_filter(normalize_whitespace(html))
       write "\n"
     end
 
@@ -41,6 +41,29 @@ module Ronn
       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 = ''
+        else
+          node.content = node.content.lstrip if node_prev.nil?
+          node.content = node.content.rstrip if node.next.nil?
+        end
+      elsif node.elem? || node.text?
+      else
+        warn "unrecognized tag: %p", node.name
+      end
+      node
+    end
+
     def block_filter(node)
       if node.kind_of?(Array) || node.kind_of?(Hpricot::Elements)
         node.each { |ch| block_filter(ch) }
@@ -94,14 +117,13 @@ module Ronn
           end
           write "\n"
 
-        # when 'ol'
-        #   macro "IP", '1.'
-        #   block_filter(node.children)
-        when 'ul'
+        when 'ol', 'ul'
           block_filter(node.children)
           macro "IP", %w["" 0]
         when 'li'
           case node.parent.name
+          when 'ol'
+            macro "IP", %W["#{node.position + 1}." 4]
           when 'ul'
             macro "IP", %w["\(bu" 4]
           end
@@ -122,20 +144,14 @@ module Ronn
     end
 
     def inline_filter(node)
+      return unless node # is an empty node
+
       if node.kind_of?(Array) || node.kind_of?(Hpricot::Elements)
         node.each { |ch| inline_filter(ch) }
 
       elsif node.text?
         prev = previous(node)
         text = node.to_html.dup
-        text.sub!(/^\n+/m, '') if prev && prev.name == 'br'
-        if child_of?(node, 'pre')
-          # leave the text alone
-        elsif node.previous.nil? && node.next.nil?
-          text.sub!(/\n+$/m, '')
-        else
-          text.sub!(/\n+$/m, ' ')
-        end
         write escape(text)
 
       elsif node.elem?
@@ -162,9 +178,17 @@ module Ronn
         when 'br'
           macro 'br'
         when 'a'
-          write '\fI'
-          inline_filter(node.children)
-          write '\fR'
+          if 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'])
+            write '\fR'
+          end
         else
           warn "unrecognized inline tag: %p", node.name
         end
@@ -180,13 +204,14 @@ module Ronn
 
     def escape(text)
       text.
-        gsub(/[\\-]/)  { |m| "\\#{m}" }.
         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;',  '&')
+        gsub('&amp;',  '&').
+        gsub(/[\\'".-]/)            { |m| "\\#{m}" }
     end
 
     def quote(text)

data/lib/ronn/server.rb

@@ -0,0 +1,70 @@
+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 
+  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, 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
+
+        def styles
+          params[:styles] ||= params[:style]
+          case
+          when params[:styles].respond_to?(:to_ary)
+            params[:styles]
+          when params[:styles]
+            params[:styles].split(/[, ]+/)
+          else
+            []
+          end
+        end
+
+        files.each do |file|
+          basename = File.basename(file, '.ronn')
+
+          get "/#{basename}.html" do
+            options = options.merge(:styles => styles)
+            %w[date manual organization].each do |attribute|
+              next if !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={})
+      new(files, options).run!(
+        :server  => %w[mongrel thin webrick],
+        :port    => 1207,
+        :logging => true
+      )
+    end
+  end
+end

data/lib/ronn/template.rb

@@ -0,0 +1,157 @@
+require 'mustache'
+
+module Ronn
+  class Template < Mustache
+    self.template_path = File.dirname(__FILE__) + '/template'
+    self.template_extension = 'html'
+
+    def initialize(document, style_path=ENV['RONN_STYLE'].to_s.split(':'))
+      @document = document
+      @style_path = style_path + [Template.template_path]
+    end
+
+    def render(template='default')
+      super template[0,1] == '/' ? File.read(template) : partial(template)
+    end
+
+    ##
+    # Basic document attributes
+
+    def name
+      @document.name
+    end
+
+    def section
+      @document.section
+    end
+
+    def tagline
+      @document.tagline
+    end
+
+    def title
+      [page_name, tagline].compact.join(' - ')
+    end
+
+    def page_name
+      if section
+        "#{name}(#{section})"
+      else
+        name
+      end
+    end
+
+    def generator
+      "Ronn/v#{Ronn::VERSION} (http://github.com/rtomayko/ronn)"
+    end
+
+    def manual
+      @document.manual
+    end
+
+    def organization
+      @document.organization
+    end
+
+    def date
+      @document.date.strftime('%B %Y')
+    end
+
+    def html
+      @document.to_html_fragment(wrap_class=nil)
+    end
+
+    ##
+    # Section TOCs
+
+    def section_heads
+      @document.section_heads.map do |id, text|
+        {
+          :id   => id,
+          :text => text
+        }
+      end
+    end
+
+    ##
+    # Styles
+
+    # Array of style module names as given on the command line.
+    def styles
+      @document.styles
+    end
+
+    # Array of stylesheet info hashes.
+    def stylesheets
+      styles.zip(style_files).map do |name, path|
+        base = File.basename(path, '.css')
+        fail "style not found: #{style.inspect}" if path.nil?
+        {
+          :name  => name,
+          :path  => path,
+          :base  => File.basename(path, '.css'),
+          :media => (base =~ /(print|screen)$/) ? $1 : 'all'
+        }
+      end
+    end
+
+    # All embedded stylesheets.
+    def stylesheet_tags
+      stylesheets.
+        map { |style| inline_stylesheet(style[:path], style[:media]) }.
+        join("\n  ")
+    end
+
+    attr_accessor :style_path
+
+    # Array of expanded stylesheet file names. If a file cannot be found, the
+    # resulting array will include nil elements in positions corresponding to
+    # the stylesheets array.
+    def style_files
+      styles.map do |name|
+        next name if name.include?('/')
+        style_path.
+          reject  { |p| p.strip.empty? }.
+          map     { |p| File.join(p, "#{name}.css") }.
+          detect  { |file| File.exist?(file) }
+      end
+    end
+
+    # Array of style names for which no file could be found.
+    def missing_styles
+      style_files.
+        zip(files).
+        select { |style, file| file.nil? }.
+        map    { |style, file| style }
+    end
+
+    ##
+    # TEMPLATE CSS LOADING
+
+    def inline_stylesheet(path, media='all')
+      data = File.read(path)
+      data.gsub!(/([;{]) *\n/m, '\1')  # end-of-line whitespace
+      data.gsub!(/([;{]) +/m, '\1')    # coalescing whitespace elsewhere
+      data.gsub!(/[; ]+\}/, '}')       # remove superfluous trailing semi-colons
+      data.gsub!(%r|/\*.+?\*/|m, '')   # comments
+      data.gsub!(/\n{2,}/m, "\n")      # collapse lines
+      data.gsub!(/^/, '  ')
+      data.strip!
+      [
+        "<style type='text/css' media='#{media}'>",
+        "/* style: #{File.basename(path, '.css')} */",
+        data,
+        "</style>"
+      ].join("\n  ")
+    end
+
+    def remote_stylesheet(name, media='all')
+      path = File.expand_path("../template/#{name}.css", __FILE__)
+      "<link rel='stylesheet' type='text/css' media='#{media}' href='#{path}'>"
+    end
+
+    def stylesheet(path, media='all')
+      inline_stylesheet(name, media)
+    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,21 @@
+.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 {
+    background:#333;
+    border-left:1ex solid #1a1a1a;
+}
+
+.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,43 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='{{ 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>
+
+  <h1 class='man-title'>{{ page_name }}</h1>
+
+  <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 ol.man, .mp ol.man li           { color:#636261 }
+
+.mp code, .mp strong, .mp b {
+    font-weight:bold;
+    color:#131211;
+}
+
+.mp em, .mp var, .mp u {
+    font-style:italic;
+    color:#434241;
+    text-decoration:none;
+}
+
+.mp pre {
+    background:#edeceb;
+    padding:5px 1ex;
+    border-left:1ex solid #ddd;
+}
+.mp pre code {
+    font-weight:normal;
+    background:inherit;
+}
+
+.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 }
+
+/* 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 }