rdoc 6.17.0 → 8.1.0

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

@@ -26,13 +26,14 @@
         <% if namespace[:self] %>
         <span><%= namespace[:name] %></span>
         <% else %>
-        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span>::</span>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span class="separator">::</span>
         <% end %>
       </li>
       <% end %>
     </ol>
   <% end %>
 
+  <span id="<%= h klass.legacy_aref %>" class="legacy-anchor"></span>
   <h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
     <%= klass.type %> <%= klass.full_name %>
   </h1>
@@ -42,8 +43,9 @@
   </section>
 
   <%- klass.each_section do |section, constants, attributes| %>
+  <span id="<%= section.legacy_aref %>" class="legacy-anchor"></span>
   <section id="<%= section.aref %>" class="documentation-section anchor-link">
-    <%- if section.title then %>
+    <%- if section.title %>
     <header class="documentation-section-title">
       <h2>
         <%= section.title %>
@@ -54,13 +56,13 @@
     </header>
     <%- end %>
 
-    <%- if section.comment then %>
+    <%- if section.comment %>
     <div>
       <%= section.description %>
     </div>
     <%- end %>
 
-    <%- unless constants.empty? then %>
+    <%- unless constants.empty? %>
     <section class="constants-list">
       <header>
         <h3>Constants</h3>
@@ -68,9 +70,9 @@
       <dl>
       <%- constants.each do |const| %>
         <dt id="<%= const.name %>"><%= const.name %></dt>
-        <%- if const.comment then %>
+        <%- if const.comment %>
         <dd>
-          <%- if const.mixin_from then %>
+          <%- if const.mixin_from %>
             <div class="mixin-from">
               Included from <a href="<%= klass.aref_to(const.mixin_from.path) %>"><%= const.mixin_from.full_name %></a>
             </div>
@@ -85,7 +87,7 @@
     </section>
     <%- end %>
 
-    <%- unless attributes.empty? then %>
+    <%- unless attributes.empty? %>
     <section class="attribute-method-details method-section">
       <header>
         <h3>Attributes</h3>
@@ -101,12 +103,12 @@
         </div>
 
         <div class="method-description">
-        <%- if attrib.mixin_from then %>
+        <%- if attrib.mixin_from %>
           <div class="mixin-from">
             <%= attrib.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(attrib.mixin_from.path) %>"><%= attrib.mixin_from.full_name %></a>
           </div>
         <%- end %>
-        <%- if attrib.comment then %>
+        <%- if attrib.comment %>
         <%= attrib.description.strip %>
         <%- else %>
         <p class="missing-docs">(Not documented)</p>
@@ -117,10 +119,10 @@
     </section>
     <%- end %>
 
-    <%- klass.methods_by_type(section).each do |type, visibilities|
-       next if visibilities.empty?
-       visibilities.each do |visibility, methods|
-         next if methods.empty? %>
+    <%- klass.methods_by_type(section).each do |type, visibilities| %>
+    <%- next if visibilities.empty? %>
+    <%- visibilities.each do |visibility, methods| %>
+    <%- next if methods.empty? %>
      <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section anchor-link">
        <header>
          <h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
@@ -129,7 +131,7 @@
     <%- methods.each do |method| %>
       <div id="<%= method.aref %>" class="method-detail anchor-link <%= method.is_alias_for ? "method-alias" : '' %>">
         <div class="method-header">
-          <%- if (call_seq = method.call_seq) then %>
+          <%- if (call_seq = method.call_seq) %>
             <%- call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
               <div class="method-heading">
                 <a href="#<%= method.aref %>" title="Link to this method">
@@ -141,7 +143,7 @@
                 </a>
               </div>
             <%- end %>
-          <%- elsif method.has_call_seq? then %>
+          <%- elsif method.has_call_seq? %>
             <div class="method-heading">
               <a href="#<%= method.aref %>" title="Link to this method">
                 <span class="method-name"><%= h method.name %></span>
@@ -163,38 +165,33 @@
               <summary>Source</summary>
             </details>
           </div>
-        <%- end %>
-
-        <%- unless method.skip_description? then %>
-        <div class="method-description">
-          <%- if method.token_stream then %>
           <div class="method-source-code" id="<%= method.html_name %>-source">
             <pre><%= method.markup_code %></pre>
           </div>
-          <%- end %>
-          <%- if method.mixin_from then %>
+        <%- end %>
+
+        <%- unless method.skip_description? %>
+        <div class="method-description">
+          <%- if method.mixin_from %>
             <div class="mixin-from">
               <%= method.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(method.mixin_from.path) %>"><%= method.mixin_from.full_name %></a>
             </div>
           <%- end %>
-          <%- if method.comment then %>
+          <%- if method.comment %>
           <%= method.description.strip %>
           <%- else %>
           <p class="missing-docs">(Not documented)</p>
           <%- end %>
-          <%- if method.calls_super then %>
+          <%- if method.calls_super %>
             <div class="method-calls-super">
               Calls superclass method
-              <%=
-                  method.superclass_method ?
-                  method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
-              %>
+              <%= method.superclass_method_link %>
             </div>
           <%- end %>
         </div>
         <%- end %>
 
-        <%- unless method.aliases.empty? then %>
+        <%- unless method.aliases.empty? %>
         <div class="aliases">
           Also aliased as: <%= method.aliases.map do |aka|
             if aka.parent then # HACK lib/rexml/encodings
@@ -206,7 +203,7 @@
         </div>
         <%- end %>
 
-        <%- if method.is_alias_for then %>
+        <%- if method.is_alias_for %>
         <div class="aliases">
           Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
         </div>
@@ -215,8 +212,8 @@
 
     <%- end %>
     </section>
-  <%- end
-     end %>
+  <%- end %>
+  <%- end %>
   </section>
 <%- end %>
 </main>

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

@@ -92,6 +92,25 @@ main .anchor-link:target {
   scroll-margin-top: 1rem;
 }
 
+/* Legacy anchor for backward compatibility with old label- prefix links */
+.legacy-anchor {
+  display: block;
+  position: relative;
+  visibility: hidden;
+  scroll-margin-top: 1rem;
+}
+
+/* When a legacy anchor is targeted, highlight the next heading sibling */
+.legacy-anchor:target + h1,
+.legacy-anchor:target + h2,
+.legacy-anchor:target + h3,
+.legacy-anchor:target + h4,
+.legacy-anchor:target + h5,
+.legacy-anchor:target + h6 {
+  margin-left: -10px;
+  border-left: 10px solid var(--border-color);
+}
+
 /* 4. Links */
 a {
   color: var(--link-color);
@@ -430,7 +449,6 @@ main h6 {
 .ruby-ivar       { color: #B57614; }  /* Brown */
 .ruby-operator   { color: #427B58; }  /* Dark Teal */
 .ruby-identifier { color: #076678; }  /* Deep Teal */
-.ruby-node       { color: #8F3F71; }  /* Plum */
 .ruby-comment    { color: #928374; font-style: italic; }  /* Gray */
 .ruby-regexp     { color: #8F3F71; }  /* Plum */
 .ruby-value      { color: #AF3A03; }  /* Dark Orange */

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

@@ -14,7 +14,7 @@
 <h1 class="class"><%= h @title %></h1>
 
 <%- simple_files = @files.select { |f| f.text? } %>
-<%- unless simple_files.empty? then %>
+<%- unless simple_files.empty? %>
 <h2 id="pages">Pages</h2>
 <ul>
 <%- simple_files.sort.each do |file| %>
@@ -23,7 +23,7 @@
 <%
    # HACK table_of_contents should not exist on Document
    table = file.parse(file.comment).table_of_contents
-   unless table.empty? then %>
+   unless table.empty? %>
     <ul>
     <%- table.each do |heading| %>
       <li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a></li>
@@ -44,7 +44,7 @@
    table.concat klass.parse(klass.comment_location).table_of_contents
    table.concat klass.section_contents
 
-   unless table.empty? then %>
+   unless table.empty? %>
     <ul>
 <%- table.each do |item| %>
   <%- label = item.respond_to?(:label) ? item.label(klass) : item.aref %>

data/lib/rdoc/generator.rb

@@ -1,52 +1,54 @@
 # frozen_string_literal: true
-##
-# RDoc uses generators to turn parsed source code in the form of an
-# RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML
-# generator RDoc::Generator::Darkfish and an ri data generator
-# RDoc::Generator::RI.
-#
-# == Registering a Generator
-#
-# Generators are registered by calling RDoc::RDoc.add_generator with the class
-# of the generator:
-#
-#   class My::Awesome::Generator
-#     RDoc::RDoc.add_generator self
-#   end
-#
-# == Adding Options to +rdoc+
-#
-# Before option processing in +rdoc+, RDoc::Options will call ::setup_options
-# on the generator class with an RDoc::Options instance.  The generator can
-# use RDoc::Options#option_parser to add command-line options to the +rdoc+
-# tool.  See RDoc::Options@Custom+Options for an example and see OptionParser
-# for details on how to add options.
-#
-# You can extend the RDoc::Options instance with additional accessors for your
-# generator.
-#
-# == Generator Instantiation
-#
-# After parsing, RDoc::RDoc will instantiate a generator by calling
-# #initialize with an RDoc::Store instance and an RDoc::Options instance.
-#
-# The RDoc::Store instance holds documentation for parsed source code.  In
-# RDoc 3 and earlier the RDoc::TopLevel class held this data.  When upgrading
-# a generator from RDoc 3 and earlier you should only need to replace
-# RDoc::TopLevel with the store instance.
-#
-# RDoc will then call #generate on the generator instance.  You can use the
-# various methods on RDoc::Store and in the RDoc::CodeObject tree to create
-# your desired output format.
+module RDoc
+  ##
+  # RDoc uses generators to turn parsed source code in the form of an
+  # RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML
+  # generator RDoc::Generator::Darkfish and an ri data generator
+  # RDoc::Generator::RI.
+  #
+  # == Registering a Generator
+  #
+  # Generators are registered by calling RDoc::RDoc.add_generator with the class
+  # of the generator:
+  #
+  #   class My::Awesome::Generator
+  #     RDoc::RDoc.add_generator self
+  #   end
+  #
+  # == Adding Options to +rdoc+
+  #
+  # Before option processing in +rdoc+, RDoc::Options will call ::setup_options
+  # on the generator class with an RDoc::Options instance.  The generator can
+  # use RDoc::Options#option_parser to add command-line options to the +rdoc+
+  # tool.  See RDoc::Options@Custom+Options for an example and see OptionParser
+  # for details on how to add options.
+  #
+  # You can extend the RDoc::Options instance with additional accessors for your
+  # generator.
+  #
+  # == Generator Instantiation
+  #
+  # After parsing, RDoc::RDoc will instantiate a generator by calling
+  # #initialize with an RDoc::Store instance and an RDoc::Options instance.
+  #
+  # The RDoc::Store instance holds documentation for parsed source code.  In
+  # RDoc 3 and earlier the RDoc::TopLevel class held this data.  When upgrading
+  # a generator from RDoc 3 and earlier you should only need to replace
+  # RDoc::TopLevel with the store instance.
+  #
+  # RDoc will then call #generate on the generator instance.  You can use the
+  # various methods on RDoc::Store and in the RDoc::CodeObject tree to create
+  # your desired output format.
 
-module RDoc::Generator
+  module Generator
 
-  autoload :Markup,   "#{__dir__}/generator/markup"
+    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"
-  autoload :POT,       "#{__dir__}/generator/pot"
+    autoload :Aliki,     "#{__dir__}/generator/aliki"
+    autoload :Darkfish,  "#{__dir__}/generator/darkfish"
+    autoload :JsonIndex, "#{__dir__}/generator/json_index"
+    autoload :RI,        "#{__dir__}/generator/ri"
+    autoload :POT,       "#{__dir__}/generator/pot"
 
+  end
 end

data/lib/rdoc/i18n/locale.rb

@@ -1,102 +1,106 @@
 # frozen_string_literal: true
-##
-# A message container for a locale.
-#
-# This object provides the following two features:
-#
-#   * Loads translated messages from .po file.
-#   * Translates a message into the locale.
-
-class RDoc::I18n::Locale
-
-  @@locales = {} # :nodoc:
-
-  class << self
-
+module RDoc
+  module I18n
     ##
-    # Returns the locale object for +locale_name+.
-
-    def [](locale_name)
-      @@locales[locale_name] ||= new(locale_name)
-    end
-
-    ##
-    # Sets the locale object for +locale_name+.
+    # A message container for a locale.
     #
-    # Normally, this method is not used. This method is useful for
-    # testing.
-
-    def []=(locale_name, locale)
-      @@locales[locale_name] = locale
-    end
-
-  end
-
-  ##
-  # The name of the locale. It uses IETF language tag format
-  # +[language[_territory][.codeset][@modifier]]+.
-  #
-  # See also {BCP 47 - Tags for Identifying
-  # Languages}[http://tools.ietf.org/rfc/bcp/bcp47.txt].
-
-  attr_reader :name
-
-  ##
-  # Creates a new locale object for +name+ locale. +name+ must
-  # follow IETF language tag format.
-
-  def initialize(name)
-    @name = name
-    @messages = {}
-  end
+    # This object provides the following two features:
+    #
+    #   * Loads translated messages from .po file.
+    #   * Translates a message into the locale.
+
+    class Locale
+
+      @@locales = {} # :nodoc:
+
+      class << self
+
+        ##
+        # Returns the locale object for +locale_name+.
+
+        def [](locale_name)
+          @@locales[locale_name] ||= new(locale_name)
+        end
+
+        ##
+        # Sets the locale object for +locale_name+.
+        #
+        # Normally, this method is not used. This method is useful for
+        # testing.
+
+        def []=(locale_name, locale)
+          @@locales[locale_name] = locale
+        end
+
+      end
+
+      ##
+      # The name of the locale. It uses IETF language tag format
+      # +[language[_territory][.codeset][@modifier]]+.
+      #
+      # See also {BCP 47 - Tags for Identifying
+      # Languages}[http://tools.ietf.org/rfc/bcp/bcp47.txt].
+
+      attr_reader :name
+
+      ##
+      # Creates a new locale object for +name+ locale. +name+ must
+      # follow IETF language tag format.
+
+      def initialize(name)
+        @name = name
+        @messages = {}
+      end
+
+      ##
+      # Loads translation messages from +locale_directory+/+@name+/rdoc.po
+      # or +locale_directory+/+@name+.po. The former has high priority.
+      #
+      # This method requires gettext gem for parsing .po file. If you
+      # don't have gettext gem, this method doesn't load .po file. This
+      # method warns and returns +false+.
+      #
+      # Returns +true+ if succeeded, +false+ otherwise.
+
+      def load(locale_directory)
+        return false if @name.nil?
+
+        po_file_candidates = [
+          File.join(locale_directory, @name, 'rdoc.po'),
+          File.join(locale_directory, "#{@name}.po"),
+        ]
+        po_file = po_file_candidates.find do |po_file_candidate|
+          File.exist?(po_file_candidate)
+        end
+        return false unless po_file
+
+        begin
+          require 'gettext/po_parser'
+          require 'gettext/mo'
+        rescue LoadError
+          warn('Need gettext gem for i18n feature:')
+          warn('  gem install gettext')
+          return false
+        end
+
+        po_parser = GetText::POParser.new
+        messages = GetText::MO.new
+        po_parser.report_warning = false
+        po_parser.parse_file(po_file, messages)
+
+        @messages.merge!(messages)
+
+        true
+      end
+
+      ##
+      # Translates the +message+ into locale. If there is no translation
+      # messages for +message+ in locale, +message+ itself is returned.
+
+      def translate(message)
+        @messages[message] || message
+      end
 
-  ##
-  # Loads translation messages from +locale_directory+/+@name+/rdoc.po
-  # or +locale_directory+/+@name+.po. The former has high priority.
-  #
-  # This method requires gettext gem for parsing .po file. If you
-  # don't have gettext gem, this method doesn't load .po file. This
-  # method warns and returns +false+.
-  #
-  # Returns +true+ if succeeded, +false+ otherwise.
-
-  def load(locale_directory)
-    return false if @name.nil?
-
-    po_file_candidates = [
-      File.join(locale_directory, @name, 'rdoc.po'),
-      File.join(locale_directory, "#{@name}.po"),
-    ]
-    po_file = po_file_candidates.find do |po_file_candidate|
-      File.exist?(po_file_candidate)
-    end
-    return false unless po_file
-
-    begin
-      require 'gettext/po_parser'
-      require 'gettext/mo'
-    rescue LoadError
-      warn('Need gettext gem for i18n feature:')
-      warn('  gem install gettext')
-      return false
     end
-
-    po_parser = GetText::POParser.new
-    messages = GetText::MO.new
-    po_parser.report_warning = false
-    po_parser.parse_file(po_file, messages)
-
-    @messages.merge!(messages)
-
-    true
-  end
-
-  ##
-  # Translates the +message+ into locale. If there is no translation
-  # messages for +message+ in locale, +message+ itself is returned.
-
-  def translate(message)
-    @messages[message] || message
   end
-
 end