rdoc 6.13.0 → 6.17.0

data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml

@@ -20,46 +20,46 @@
   <h1>Local RDoc Documentation</h1>
 
   <p>Here you can browse local documentation from the ruby standard library and
-  your installed gems.
+  your installed gems.</p>
 
-<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } -%>
-<%- unless extra_dirs.empty? -%>
+<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } %>
+<%- unless extra_dirs.empty? %>
   <h2>Extra Documentation Directories</h2>
 
   <p>The following additional documentation directories are available:</p>
 
   <ol>
-  <%- extra_dirs.each do |name, href, exists, _, path| -%>
+  <%- extra_dirs.each do |name, href, exists, _, path| %>
     <li>
-    <%- if exists -%>
+    <%- if exists %>
       <a href="<%= href %>"><%= h name %></a> (<%= h path %>)
-    <%- else -%>
+    <%- else %>
       <%= h name %> (<%= h path %>; <i>not available</i>)
-    <%- end -%>
+    <%- end %>
     </li>
-  <%- end -%>
+  <%- end %>
   </ol>
-<%- end -%>
+<%- end %>
 
-<%- gems = installed.select { |_, _, _, type,| type == :gem } -%>
-<%- missing = gems.reject { |_, _, exists,| exists } -%>
-<%- unless missing.empty? then -%>
+<%- gems = installed.select { |_, _, _, type,| type == :gem } %>
+<%- missing = gems.reject { |_, _, exists,| exists } %>
+<%- unless missing.empty? %>
   <h2>Missing Gem Documentation</h2>
 
   <p>You are missing documentation for some of your installed gems.
   You can install missing documentation for gems by running
   <kbd>gem rdoc --all</kbd>.  After installing the missing documentation you
   only need to reload this page.  The newly created documentation will
-  automatically appear.
+  automatically appear.</p>
 
   <p>You can also install documentation for a specific gem by running one of
-  the following commands.
+  the following commands.</p>
 
   <ul>
-  <%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq -%>
-  <%- names.each do |name| -%>
-    <li><kbd>gem rdoc <%=h name %></kbd>
-  <%- end -%>
+  <%- missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq.each do |name| %>
+    <li><kbd>gem rdoc <%= h name %></kbd></li>
+  <%- end %>
   </ul>
-<%- end -%>
+<%- end %>
 </main>
+</body>

data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml

@@ -13,11 +13,11 @@
 <main role="main">
 <h1 class="class"><%= h @title %></h1>
 
-<%- simple_files = @files.select { |f| f.text? } -%>
-<%- unless simple_files.empty? then -%>
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- unless simple_files.empty? then %>
 <h2 id="pages">Pages</h2>
 <ul>
-<%- simple_files.sort.each do |file| -%>
+<%- simple_files.sort.each do |file| %>
   <li class="file">
     <a href="<%= h file.path %>"><%= h file.page_name %></a>
 <%
@@ -25,19 +25,19 @@
    table = file.parse(file.comment).table_of_contents
    unless table.empty? then %>
     <ul>
-<%- table.each do |heading| -%>
-      <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
-<%-   end -%>
+    <%- table.each do |heading| %>
+      <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a></li>
+    <%- end %>
     </ul>
-<%- end -%>
+<%- end %>
   </li>
-  <%- end -%>
+  <%- end %>
 </ul>
-<%- end -%>
+<%- end %>
 
 <h2 id="classes">Classes and Modules</h2>
 <ul>
-<%- @modsort.each do |klass| -%>
+<%- @modsort.each do |klass| %>
   <li class="<%= klass.type %>">
     <a href="<%= klass.path %>"><%= klass.full_name %></a>
 <%- table = []
@@ -46,14 +46,14 @@
 
    unless table.empty? then %>
     <ul>
-<%- table.each do |item| -%>
-<%-   label = item.respond_to?(:label) ? item.label(klass) : item.aref -%>
-      <li><a href="<%= klass.path %>#<%= label %>"><%= item.plain_html %></a>
-<%- end -%>
+<%- table.each do |item| %>
+  <%- label = item.respond_to?(:label) ? item.label(klass) : item.aref %>
+      <li><a href="<%= klass.path %>#<%= label %>"><%= item.plain_html %></a></li>
+<%- end %>
     </ul>
-<%- end -%>
+<%- end %>
   </li>
-<%- end -%>
+<%- end %>
 </ul>
 
 <h2 id="methods">Methods</h2>
@@ -65,6 +65,8 @@
     <a href="<%= method.path %>"><%= h method.pretty_name %></a>
     &mdash;
     <span class="container"><%= method.parent.full_name %></span>
-<%- end -%>
+  </li>
+<%- end %>
 </ul>
 </main>
+</body>

data/lib/rdoc/generator/template/json_index/js/searcher.js

@@ -29,7 +29,7 @@ Searcher.prototype = new function() {
 
       var results =
         performSearch(_this.data, regexps, queries, highlighters, state);
-      var hasMore = (state.limit > 0 && state.pass < 4);
+      var hasMore = (state.limit > 0 && state.pass < 6);
 
       triggerResults.call(_this, results, !hasMore);
       if (hasMore) {
@@ -57,8 +57,17 @@ Searcher.prototype = new function() {
   }
 
   function buildRegexps(queries) {
+    // A small minority of older browsers don't have RegExp.escape
+    // but it's not worth including a complex polyfill.
+    var escape = RegExp.escape || function(s) { return s };
+
     return queries.map(function(query) {
-      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+      var pattern = [];
+      for (var i = 0; i < query.length; i++) {
+        var char = escape(query[i]);
+        pattern.push('([' + char + '])([^' + char + ']*?)');
+      }
+      return new RegExp(pattern.join(''), 'i');
     });
   }
 
@@ -80,6 +89,30 @@ Searcher.prototype = new function() {
 
   /*  ----- Mathchers ------  */
 
+  /*
+   * This record matches if both the index and longIndex exactly equal queries[0]
+   * and the record matches all of the regexps. This ensures top-level exact matches
+   * like "String" are prioritized over nested classes like "Gem::Module::String".
+   */
+  function matchPassExact(index, longIndex, queries) {
+    return index == queries[0] && longIndex == queries[0];
+  }
+
+  /*
+   * This record matches if the index without "()" exactly equals queries[0].
+   * This prioritizes methods like "attribute()" when searching for "attribute".
+   */
+  function matchPassExactMethod(index, longIndex, queries, regexps) {
+    var indexWithoutParens = index.replace(/\(\)$/, '');
+    if (indexWithoutParens != queries[0]) return false;
+    if (index === indexWithoutParens) return false; // Not a method (no parens to remove)
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
   /*
    * This record matches if the index starts with queries[0] and the record
    * matches all of the regexps
@@ -187,17 +220,26 @@ Searcher.prototype = new function() {
     var togo = CHUNK_SIZE;
     var matchFunc, hltFunc;
 
-    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+    var isLowercaseQuery = queries[0] === queries[0].toLowerCase();
+
+    while (state.pass < 6 && state.limit > 0 && togo > 0) {
+      // When query is lowercase, prioritize methods over classes
       if (state.pass == 0) {
-        matchFunc = matchPassBeginning;
+        matchFunc = isLowercaseQuery ? matchPassExactMethod : matchPassExact;
         hltFunc = highlightQuery;
       } else if (state.pass == 1) {
-        matchFunc = matchPassLongIndex;
+        matchFunc = isLowercaseQuery ? matchPassExact : matchPassExactMethod;
         hltFunc = highlightQuery;
       } else if (state.pass == 2) {
-        matchFunc = matchPassContains;
+        matchFunc = matchPassBeginning;
         hltFunc = highlightQuery;
       } else if (state.pass == 3) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 4) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 5) {
         matchFunc = matchPassRegexp;
         hltFunc = highlightRegexp;
       }

data/lib/rdoc/generator.rb

@@ -43,6 +43,7 @@ module RDoc::Generator
 
   autoload :Markup,   "#{__dir__}/generator/markup"
 
+  autoload :Aliki,     "#{__dir__}/generator/aliki"
   autoload :Darkfish,  "#{__dir__}/generator/darkfish"
   autoload :JsonIndex, "#{__dir__}/generator/json_index"
   autoload :RI,        "#{__dir__}/generator/ri"

data/lib/rdoc/markdown.kpeg

@@ -496,6 +496,57 @@
       "<s>#{text}</s>"
     end
   end
+
+  ##
+  # Wraps `text` in code markup for rdoc inline formatting
+
+  def code text
+    # trim even spaces
+    text = $2 while /\A( +|\t+)(.*)\1\z/ =~ text
+    # escape unescaped backslash at the end
+    backslash_at_end = "\\" if /(?<!\\)(?:\\\\)*\\\z/.match?(text)
+    "<code>#{text}#{backslash_at_end}</code>"
+  end
+
+  ##
+  # Parses inline markdown in table cells
+
+  def parse_table_cells(table)
+    # Parse header cells
+    table.header = table.header.map { |cell| parse_cell_inline(cell) }
+
+    # Parse body cells
+    table.body = table.body.map do |row|
+      row.map { |cell| parse_cell_inline(cell) }
+    end
+
+    table
+  end
+
+  ##
+  # Parses inline markdown in a single table cell
+
+  def parse_cell_inline(text)
+    return text if text.nil? || text.empty?
+
+    # Create a new parser instance for the cell
+    cell_parser = RDoc::Markdown.new(@extensions, @debug)
+
+    # Parse the cell content
+    doc = cell_parser.parse(text)
+
+    # Extract the parsed content
+    if doc && doc.parts && !doc.parts.empty?
+      para = doc.parts.first
+      if para.is_a?(RDoc::Markup::Paragraph)
+        para.parts.join
+      else
+        text
+      end
+    else
+      text
+    end
+  end
 }
 
 root = Doc
@@ -1064,32 +1115,32 @@ Ticks3 = "```" !"`"
 Ticks4 = "````" !"`"
 Ticks5 = "`````" !"`"
 
-Code = ( Ticks1 @Sp < (
+Code = ( Ticks1 < (
            ( !"`" Nonspacechar )+ | !Ticks1 /`+/ |
-           !( @Sp Ticks1 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks1 |
-         Ticks2 @Sp < (
+           !Ticks1 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks1 |
+         Ticks2 < (
            ( !"`" Nonspacechar )+ |
            !Ticks2 /`+/ |
-           !( @Sp Ticks2 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks2 |
-         Ticks3 @Sp < (
+           !Ticks2 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks2 |
+         Ticks3 < (
            ( !"`" Nonspacechar )+ |
            !Ticks3 /`+/ |
-           !( @Sp Ticks3 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks3 |
-         Ticks4 @Sp < (
+           !Ticks3 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks3 |
+         Ticks4 < (
            ( !"`" Nonspacechar )+ |
            !Ticks4 /`+/ |
-           !( @Sp Ticks4 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks4 |
-         Ticks5 @Sp < (
+           !Ticks4 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks4 |
+         Ticks5 < (
            ( !"`" Nonspacechar )+ |
            !Ticks5 /`+/ |
-           !( @Sp Ticks5 ) ( @Spacechar | @Newline !@BlankLine )
-         )+ > @Sp Ticks5
+           !Ticks5 ( @Spacechar | @Newline !@BlankLine )
+         )+ > Ticks5
        )
-       { "<code>#{text}</code>" }
+       { code text }
 
 RawHtml = < (HtmlComment | HtmlBlockScript | HtmlTag) >
           { if html? then text else '' end }
@@ -1201,7 +1252,10 @@ CodeFence = &{ github? }
 
 Table = &{ github? }
         TableHead:header TableLine:line TableRow+:body
-        { table = RDoc::Markup::Table.new(header, line, body) }
+        {
+          table = RDoc::Markup::Table.new(header, line, body)
+          parse_table_cells(table)
+        }
 
 TableHead = TableItem2+:items "|"? @Newline
             { items }
@@ -1210,7 +1264,7 @@ TableRow = ( ( TableItem:item1 TableItem2*:items { [item1, *items] } ):row | Tab
 	   { row }
 TableItem2 = "|" TableItem
 TableItem = < /(?:\\.|[^|\n])+/ >
-	    { text.strip.gsub(/\\(.)/, '\1')  }
+	    { text.strip.gsub(/\\([|])/, '\1')  }
 
 TableLine = ( ( TableAlign:align1 TableAlign2*:aligns {[align1, *aligns] } ):line | TableAlign2+:line ) "|"? @Newline
 	    { line }