ronn 0.6.6 → 0.7.0

data/lib/ronn/index.rb

@@ -0,0 +1,183 @@
+require 'ronn'
+
+module Ronn
+
+  # Maintains a list of links / references to manuals and other resources.
+  class Index
+    include Enumerable
+
+    attr_reader :path
+    attr_reader :references
+
+    # Retrieve an Index for <path>, where <path> is a directory or normal
+    # file. The index is loaded from the corresponding index.txt file if
+    # one exists.
+    def self.[](path)
+      (@indexes ||= {})[index_path_for_file(path)] ||=
+        Index.new(index_path_for_file(path))
+    end
+
+    def self.index_path_for_file(file)
+      File.expand_path(
+        if File.directory?(file)
+          File.join(file, 'index.txt')
+        else
+          File.join(File.dirname(file), 'index.txt')
+        end
+      )
+    end
+
+    def initialize(path, &bk)
+      @path = path
+      @references = []
+      @manuals    = {}
+
+      if block_given?
+        read! yield
+      elsif exist?
+        read! File.read(path)
+      end
+    end
+
+    # Determine whether the index file exists.
+    def exist?
+      File.exist?(path)
+    end
+
+    # Load index data from a string.
+    def read!(data)
+      data.each_line do |line|
+        line = line.strip.gsub(/\s*#.*$/, '')
+        if !line.empty?
+          name, url = line.split(/ +/, 2)
+          @references << reference(name, url)
+        end
+      end
+    end
+
+    ##
+    # Enumerable and friends
+
+    def each(&bk)
+      references.each(&bk)
+    end
+
+    def size
+      references.size
+    end
+
+    def first
+      references.first
+    end
+
+    def last
+      references.last
+    end
+
+    def empty?
+      references.empty?
+    end
+
+    def [](name)
+      references.find { |ref| ref.name == name }
+    end
+
+    def reference(name, path)
+      Reference.new(self, name, path)
+    end
+
+    def <<(path)
+      raise ArgumentError, "local paths only" if path =~ /(https?|mailto):/
+      return self if any? { |ref| ref.path == File.expand_path(path) }
+      relative_path = relative_to_index(path)
+      @references << \
+        if path =~ /\.ronn?$/
+          reference manual(path).reference_name, relative_path
+        else
+          reference File.basename(path), relative_path
+        end
+      self
+    end
+
+    def add_manual(manual)
+      @manuals[File.expand_path(manual.path)] = manual
+      self << manual.path
+    end
+
+    def manual(path)
+      @manuals[File.expand_path(path)] ||= Document.new(path)
+    end
+
+    def manuals
+      select { |ref| ref.relative? && ref.ronn? }.
+      map    { |ref| manual(ref.path) }
+    end
+
+    ##
+    # Converting
+
+    def to_text
+      map { |ref| [ref.name, ref.location].join(' ') }.join("\n")
+    end
+
+    def to_a
+      references
+    end
+
+    def to_h
+      to_a.map { |doc| doc.to_hash }
+    end
+
+    def relative_to_index(path)
+      path = File.expand_path(path)
+      index_dir = File.dirname(File.expand_path(self.path))
+      path.sub(/^#{index_dir}\//, '')
+    end
+  end
+
+  # An individual index reference. A reference can point to one of a few types
+  # of locations:
+  #
+  #   - URLs: "http://man.cx/crontab(5)"
+  #   - Relative paths to ronn manuals: "crontab.5.ronn"
+  #
+  # The #url method should be used to obtain the href value for HTML.
+  class Reference
+    attr_reader :name
+    attr_reader :location
+
+    def initialize(index, name, location)
+      @index = index
+      @name = name
+      @location = location
+    end
+
+    def manual?
+      name =~ /\([0-9]\w*\)$/
+    end
+
+    def ronn?
+      location =~ /\.ronn?$/
+    end
+
+    def remote?
+      location =~ /^(?:https?|mailto):/
+    end
+
+    def relative?
+      !remote?
+    end
+
+    def url
+      if remote?
+        location
+      else
+        location.chomp('.ronn') + '.html'
+      end
+    end
+
+    def path
+      File.expand_path(location, File.dirname(@index.path)) if relative?
+    end
+  end
+end

data/lib/ronn/roff.rb

@@ -29,20 +29,9 @@ module Ronn
       end
     end
 
-    def child_of?(node, tag)
-      while node
-        if node.name && node.name.downcase == tag
-          return true
-        else
-          node = node.parent
-        end
-      end
-      false
-    end
-
     def title_heading(name, section, tagline, manual, version, date)
-      comment "generated with Ronn/v#{Ronn::VERSION}"
-      comment "http://github.com/rtomayko/ronn/"
+      comment "generated with Ronn/v#{Ronn.version}"
+      comment "http://github.com/rtomayko/ronn/tree/#{Ronn.revision}"
       return if name.nil?
       macro "TH", %["#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}"]
     end
@@ -50,7 +39,6 @@ module Ronn
     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
@@ -85,7 +73,7 @@ module Ronn
       when node.doc?
         normalize_whitespace! node.children
       else
-        warn "unexpected node during whitespace normalization: %p", node.name
+        warn "unexpected node during whitespace normalization: %p", node
       end
     end
 
@@ -101,6 +89,10 @@ module Ronn
 
       elsif node.elem?
         case node.name
+        when 'div'
+          block_filter(node.children)
+        when 'h1'
+          # discard
         when 'h2'
           macro "SH", quote(escape(node.html))
         when 'h3'
@@ -134,7 +126,7 @@ module Ronn
           inline_filter(node.children)
           write "\n"
         when 'dd'
-          if node.search('p').any?
+          if node.at('p')
             block_filter(node.children)
           else
             inline_filter(node.children)
@@ -151,7 +143,7 @@ module Ronn
           when 'ul'
             macro "IP", %w["\(bu" 4]
           end
-          if node.search('p|ol|ul|dl|div').any?
+          if node.at('p|ol|ul|dl|div')
             block_filter(node.children)
           else
             inline_filter(node.children)
@@ -174,12 +166,13 @@ module Ronn
         node.each { |ch| inline_filter(ch) }
 
       elsif node.text?
-        prev = previous(node)
         text = node.to_html.dup
         write escape(text)
 
       elsif node.elem?
         case node.name
+        when 'span'
+          inline_filter(node.children)
         when 'code'
           if child_of?(node, 'pre')
             inline_filter(node.children)
@@ -201,8 +194,11 @@ module Ronn
 
         when 'br'
           macro 'br'
+
         when 'a'
-          if node.has_attribute?('data-bare-link')
+          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'
@@ -226,15 +222,33 @@ module Ronn
       writeln ".\n.#{[name, value].compact.join(' ')}"
     end
 
+    HTML_ROFF_ENTITIES = {
+      '•'  => '\(bu',
+      '&lt;'    => '<',
+      '&gt;'    => '>',
+      '&nbsp;'  => '\~',
+      '&copy;'  => '\(co',
+      '&rdquo;' => '\(rs',
+      '&mdash;' => '\(em',
+      '&reg;'   => '\(rg',
+      '&sec;'   => '\(sc',
+      '&ge;'    => '\(>=',
+      '&le;'    => '\(<=',
+      '&ne;'    => '\(!=',
+      '&equiv;' => '\(=='
+    }
+
     def escape(text)
-      text.
-        gsub('&nbsp;', ' ').
-        gsub('&lt;',   '<').
-        gsub('&gt;',   '>').
-        gsub(/&#x([0-9A-Fa-f]+);/) { $1.to_i(16).chr }.
-        gsub(/&#(\d+);/)           { $1.to_i.chr }.
-        gsub('&amp;',  '&').
-        gsub(/[\\'".-]/)            { |m| "\\#{m}" }
+      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!(/['".-]/) { |m| "\\#{m}" }                 # control chars
+      text.gsub!(/(&[A-Za-z]+;)/) { ent[$1] || $1 }         # named entities
+      text.gsub!('&amp;',  '&')                             # amps
+      text
     end
 
     def quote(text)
@@ -243,7 +257,13 @@ module Ronn
 
     # write text to output buffer
     def write(text)
-      @buf << text unless text.nil? || text.empty?
+      return if text.nil? || text.empty?
+      # lines cannot start with a '.'. insert zero-width character before.
+      if text[0,2] == '\.' &&
+        (@buf.last && @buf.last[-1] == ?\n)
+        @buf << '\&'
+      end
+      @buf << text
     end
 
     # write text to output buffer on a new line.

data/lib/ronn/template.rb

@@ -28,9 +28,22 @@ module Ronn
     def tagline
       @document.tagline
     end
+    alias tagline? tagline
+
+    def name_and_section?
+      name && section
+    end
 
     def title
-      [page_name, tagline].compact.join(' - ')
+      if !name_and_section? && tagline
+        tagline
+      else
+        [page_name, tagline].compact.join(' - ')
+      end
+    end
+
+    def custom_title?
+      !name_and_section? && tagline
     end
 
     def page_name
@@ -42,7 +55,7 @@ module Ronn
     end
 
     def generator
-      "Ronn/v#{Ronn::VERSION} (http://github.com/rtomayko/ronn)"
+      "Ronn/v#{Ronn.version} (http://github.com/rtomayko/ronn/tree/#{Ronn.revision})"
     end
 
     def manual
@@ -57,8 +70,8 @@ module Ronn
       @document.date.strftime('%B %Y')
     end
 
-    def html
-      @document.to_html_fragment(wrap_class=nil)
+    def wrap_class_name
+      'mp'
     end
 
     ##
@@ -130,12 +143,13 @@ module Ronn
 
     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/m, '\1') # end-of-line whitespace
       data.gsub!(/\n{2,}/m, "\n")      # collapse lines
-      data.gsub!(/^/, '  ')
+      data.gsub!(/[; ]+\}/, '}')       # superfluous trailing semi-colons
+      data.gsub!(/([{;,+])[ ]+/, '\1') # whitespace around things
+      data.gsub!(/[ \t]+/m, ' ')       # coalescing whitespace elsewhere
+      data.gsub!(/^/, '  ')            # indent
       data.strip!
       [
         "<style type='text/css' media='#{media}'>",

data/lib/ronn/template/dark.css

@@ -11,10 +11,7 @@
 
 .mp em, .mp var, .mp u              { color:#ddd }
 
-.mp pre {
-    background:#333;
-    border-left:1ex solid #1a1a1a;
-}
+.mp pre code                        { color:#ddd }
 
 .mp a, .mp a:link, .mp a:hover,
 .mp a code, .mp a pre, .mp a tt,

data/lib/ronn/template/default.html

@@ -22,8 +22,6 @@
     {{/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>

data/lib/ronn/template/man.css

@@ -55,33 +55,33 @@ body#manpage                        { margin:0 }
 .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 u                               { text-decoration:underline; }
 
 .mp code, .mp strong, .mp b {
     font-weight:bold;
     color:#131211;
 }
 
-.mp em, .mp var, .mp u {
+.mp em, .mp var {
     font-style:italic;
-    color:#434241;
+    color:#232221;
     text-decoration:none;
 }
 
-.mp pre {
-    background:#edeceb;
-    padding:5px 1ex;
-    border-left:1ex solid #ddd;
-}
-.mp pre code {
-    font-weight:normal;
-    background:inherit;
-}
+/* 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 {