rdoc 6.2.1 → 6.3.0

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

@@ -25,9 +25,9 @@
     <%= klass.description %>
   </section>
 
-  <% klass.each_section do |section, constants, attributes| %>
+  <%- klass.each_section do |section, constants, attributes| -%>
   <section id="<%= section.aref %>" class="documentation-section">
-    <% if section.title then %>
+    <%- if section.title then -%>
     <header class="documentation-section-title">
       <h2>
         <%= section.title %>
@@ -36,39 +36,39 @@
         <a href="#top">&uarr; top</a>
       </span>
     </header>
-    <% end %>
+    <%- end -%>
 
-    <% if section.comment then %>
+    <%- if section.comment then -%>
     <div>
       <%= section.description %>
     </div>
-    <% end %>
+    <%- end -%>
 
-    <% unless constants.empty? then %>
+    <%- unless constants.empty? then -%>
     <section class="constants-list">
       <header>
         <h3>Constants</h3>
       </header>
       <dl>
-      <% constants.each do |const| %>
+      <%- constants.each do |const| -%>
         <dt id="<%= const.name %>"><%= const.name %>
-        <% if const.comment then %>
+        <%- if const.comment then -%>
         <dd><%= const.description.strip %>
-        <% else %>
+        <%- else -%>
         <dd class="missing-docs">(Not documented)
-        <% end %>
-      <% end %>
+        <%- end -%>
+      <%- end -%>
       </dl>
     </section>
-    <% end %>
+    <%- end -%>
 
-    <% unless attributes.empty? then %>
+    <%- unless attributes.empty? then -%>
     <section class="attribute-method-details" class="method-section">
       <header>
         <h3>Attributes</h3>
       </header>
 
-      <% attributes.each do |attrib| %>
+      <%- attributes.each do |attrib| -%>
       <div id="<%= attrib.aref %>" class="method-detail">
         <div class="method-heading attribute-method-heading">
           <span class="method-name"><%= h attrib.name %></span><span
@@ -76,18 +76,18 @@
         </div>
 
         <div class="method-description">
-        <% if attrib.comment then %>
+        <%- if attrib.comment then -%>
         <%= attrib.description.strip %>
-        <% else %>
+        <%- else -%>
         <p class="missing-docs">(Not documented)
-        <% end %>
+        <%- end -%>
         </div>
       </div>
-      <% end %>
+      <%- end -%>
     </section>
-    <% end %>
+    <%- end -%>
 
-    <% klass.methods_by_type(section).each do |type, visibilities|
+    <%- klass.methods_by_type(section).each do |type, visibilities|
        next if visibilities.empty?
        visibilities.each do |visibility, methods|
          next if methods.empty? %>
@@ -96,38 +96,38 @@
          <h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
        </header>
 
-    <% methods.each do |method| %>
+    <%- methods.each do |method| -%>
       <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-        <% if method.call_seq then %>
-        <%   method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+        <%- if (call_seq = method.call_seq) then -%>
+        <%-   call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
         <div class="method-heading">
           <span class="method-callseq">
             <%= h(call_seq.strip.
                   gsub( /^\w+\./m, '')).
                   gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
           </span>
-          <% if i == 0 and method.token_stream then %>
+          <%- if i == 0 and method.token_stream then -%>
           <span class="method-click-advice">click to toggle source</span>
-          <% end %>
+          <%- end -%>
         </div>
-        <%   end %>
-        <% else %>
+        <%-   end -%>
+        <%- else -%>
         <div class="method-heading">
           <span class="method-name"><%= h method.name %></span><span
             class="method-args"><%= h method.param_seq %></span>
-          <% if method.token_stream then %>
+          <%- if method.token_stream then -%>
           <span class="method-click-advice">click to toggle source</span>
-          <% end %>
+          <%- end -%>
         </div>
-        <% end %>
+        <%- end -%>
 
         <div class="method-description">
-          <% if method.comment then %>
+          <%- if method.comment then -%>
           <%= method.description.strip %>
-          <% else %>
+          <%- else -%>
           <p class="missing-docs">(Not documented)
-          <% end %>
-          <% if method.calls_super then %>
+          <%- end -%>
+          <%- if method.calls_super then -%>
             <div class="method-calls-super">
               Calls superclass method
               <%=
@@ -135,16 +135,16 @@
                   method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
               %>
             </div>
-          <% end %>
+          <%- end -%>
 
-          <% if method.token_stream then %>
+          <%- if method.token_stream then -%>
           <div class="method-source-code" id="<%= method.html_name %>-source">
             <pre><%= method.markup_code %></pre>
           </div>
-          <% end %>
+          <%- end -%>
         </div>
 
-        <% unless method.aliases.empty? then %>
+        <%- unless method.aliases.empty? then -%>
         <div class="aliases">
           Also aliased as: <%= method.aliases.map do |aka|
             if aka.parent then # HACK lib/rexml/encodings
@@ -154,19 +154,19 @@
             end
           end.join ", " %>
         </div>
-        <% end %>
+        <%- end -%>
 
-        <% if method.is_alias_for then %>
+        <%- if method.is_alias_for then -%>
         <div class="aliases">
           Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
         </div>
-        <% end %>
+        <%- end -%>
       </div>
 
-    <% end %>
+    <%- end -%>
     </section>
-  <% end
+  <%- end
      end %>
   </section>
-<% end %>
+<%- end -%>
 </main>

data/lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -276,7 +276,7 @@ ul.link-list .type {
   -webkit-border-radius: 5px;
 }
 
-dl.label-list dt {
+dl.note-list dt {
   float: left;
   margin-right: 1em;
 }

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

@@ -13,11 +13,10 @@
 </nav>
 
 <main role="main">
-<% if @options.main_page and
+<%- if @options.main_page and
       main_page = @files.find { |f| f.full_name == @options.main_page } then %>
 <%= main_page.description %>
-<% else %>
+<%- else -%>
 <p>This is the API documentation for <%= @title %>.
-<% end %>
+<%- end -%>
 </main>
-

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

@@ -19,28 +19,28 @@
   <p>Here you can browse local documentation from the ruby standard library and
   your installed gems.
 
-<% 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? then -%>
   <h2>Missing Gem Documentation</h2>
 
   <p>You are missing documentation for some of your installed gems.
@@ -53,11 +53,10 @@
   the following commands.
 
   <ul>
-  <% names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq %>
-  <% names.each do |name| %>
+  <%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq -%>
+  <%- names.each do |name| -%>
     <li><kbd>gem rdoc <%=h name %></kbd>
-  <% end %>
+  <%- end -%>
   </ul>
-<% end %>
+<%- end -%>
 </main>
-

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

@@ -2,11 +2,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="<%= file.path %>"><%= h file.page_name %></a>
 <%
@@ -14,45 +14,45 @@
    table = file.parse(file.comment).table_of_contents
    unless table.empty? then %>
     <ul>
-<% table.each do |heading| %>
+<%- table.each do |heading| -%>
       <li><a href="<%= file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
-<%   end %>
+<%-   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 = []
+<%- table = []
    table.concat klass.parse(klass.comment_location).table_of_contents
    table.concat klass.section_contents
 
    unless table.empty? then %>
     <ul>
-<% table.each do |item| %>
+<%- table.each do |item| -%>
       <li><a href="<%= klass.path %>#<%= item.aref %>"><%= item.plain_html %></a>
-<%   end %>
+<%-   end -%>
     </ul>
-<% end %>
+<%- end -%>
   </li>
-<% end %>
+<%- end -%>
 </ul>
 
 <h2 id="methods">Methods</h2>
 <ul>
-<% @store.all_classes_and_modules.map do |mod|
+<%- @store.all_classes_and_modules.map do |mod|
      mod.method_list
    end.flatten.sort.each do |method| %>
   <li class="method">
     <a href="<%= method.path %>"><%= h method.pretty_name %></a>
     &mdash;
     <span class="container"><%= method.parent.full_name %></span>
-<% end %>
+<%- end -%>
 </ul>
 </main>

data/lib/rdoc/i18n.rb

@@ -5,6 +5,6 @@
 module RDoc::I18n
 
   autoload :Locale, 'rdoc/i18n/locale'
-  require 'rdoc/i18n/text'
+  require_relative 'i18n/text'
 
 end

data/lib/rdoc/markdown.kpeg

@@ -176,7 +176,7 @@
 # The port to kpeg was performed by Eric Hodel and Evan Phoenix
 #
 # [dingus]: http://daringfireball.net/projects/markdown/dingus
-# [GFM]: http://github.github.com/github-flavored-markdown/
+# [GFM]: https://github.github.com/gfm/
 # [pegmarkdown]: https://github.com/jgm/peg-markdown
 # [PHPE]: http://michelf.com/projects/php-markdown/extra/#def-list
 # [syntax]: http://daringfireball.net/projects/markdown/syntax

data/lib/rdoc/markdown.rb

@@ -173,7 +173,7 @@
 # The port to kpeg was performed by Eric Hodel and Evan Phoenix
 #
 # [dingus]: http://daringfireball.net/projects/markdown/dingus
-# [GFM]: http://github.github.com/github-flavored-markdown/
+# [GFM]: https://github.github.com/gfm/
 # [pegmarkdown]: https://github.com/jgm/peg-markdown
 # [PHPE]: http://michelf.com/projects/php-markdown/extra/#def-list
 # [syntax]: http://daringfireball.net/projects/markdown/syntax

data/lib/rdoc/markup/formatter.rb

@@ -156,7 +156,7 @@ class RDoc::Markup::Formatter
       method_name = "handle_regexp_#{name}"
 
       if respond_to? method_name then
-        target.text = send method_name, target
+        target.text = public_send method_name, target
         handled = true
       end
     end

data/lib/rdoc/markup/pre_process.rb

@@ -178,7 +178,7 @@ class RDoc::Markup::PreProcess
 
       blankline
     when 'include' then
-      filename = param.split.first
+      filename = param.split(' ', 2).first
       include_file filename, prefix, encoding
     when 'main' then
       @options.main_page = param if @options.respond_to? :main_page

data/lib/rdoc/markup/to_html.rb

@@ -52,12 +52,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
     @th = nil
     @hard_break = "<br>\n"
 
-    # external links
-    @markup.add_regexp_handling(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)\S+\w/,
-                                :HYPERLINK)
-
-    add_regexp_handling_RDOCLINK
-    add_regexp_handling_TIDYLINK
+    init_regexp_handlings
 
     init_tags
   end
@@ -66,6 +61,24 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   #
   # These methods are used by regexp handling markup added by RDoc::Markup#add_regexp_handling.
 
+  ##
+  # Adds regexp handlings.
+
+  def init_regexp_handlings
+    # external links
+    @markup.add_regexp_handling(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)\S+\w/,
+                                :HYPERLINK)
+    init_link_notation_regexp_handlings
+  end
+
+  ##
+  # Adds regexp handlings about link notations.
+
+  def init_link_notation_regexp_handlings
+    add_regexp_handling_RDOCLINK
+    add_regexp_handling_TIDYLINK
+  end
+
   def handle_RDOCLINK url # :nodoc:
     case url
     when /^rdoc-ref:/

data/lib/rdoc/markup/to_html_crossref.rb

@@ -39,10 +39,18 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     @hyperlink_all = @options.hyperlink_all
     @show_hash     = @options.show_hash
 
-    crossref_re = @hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
+    @cross_reference = RDoc::CrossReference.new @context
+  end
+
+  def init_link_notation_regexp_handlings
+    add_regexp_handling_RDOCLINK
+
+    # The crossref must be linked before tidylink because Klass.method[:sym]
+    # will be processed as a tidylink first and will be broken.
+    crossref_re = @options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
     @markup.add_regexp_handling crossref_re, :CROSSREF
 
-    @cross_reference = RDoc::CrossReference.new @context
+    add_regexp_handling_TIDYLINK
   end
 
   ##
@@ -54,7 +62,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
 
-    if name =~ /(.*[^#:])@/
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
       text ||= "#{CGI.unescape $'} at <code>#{$1}</code>"
       code = false
     else
@@ -130,7 +138,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Creates an HTML link to +name+ with the given +text+.
 
   def link name, text, code = true
-    if name =~ /(.*[^#:])@/ then
+    if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
       name = $1
       label = $'
     end
@@ -144,7 +152,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       path = ref.as_href @from_path
 
       if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
-        text = "<code>#{text}</code>"
+        text = "<code>#{CGI.escapeHTML text}</code>"
       end
 
       if path =~ /#/ then