rdoc 5.1.0 → 6.3.1

data/lib/rdoc/generator/json_index.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'json'
 begin
   require 'zlib'
@@ -147,12 +147,15 @@ class RDoc::Generator::JsonIndex
 
       JSON.dump data, io, 0
     end
+    unless ENV['SOURCE_DATE_EPOCH'].nil?
+      index_file.utime index_file.atime, Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
+    end
 
     Dir.chdir @template_dir do
       Dir['**/*.js'].each do |source|
         dest = File.join out_dir, source
 
-        FileUtils.install source, dest, :mode => 0644, :verbose => $DEBUG_RDOC
+        FileUtils.install source, dest, :mode => 0644, :preserve => true, :verbose => $DEBUG_RDOC
       end
     end
   end
@@ -161,7 +164,7 @@ class RDoc::Generator::JsonIndex
   # Compress the search_index.js file using gzip
 
   def generate_gzipped
-    return unless defined?(Zlib)
+    return if @options.dry_run or not defined?(Zlib)
 
     debug_msg "Compressing generated JSON index"
     out_dir = @base_dir + @options.op_dir

data/lib/rdoc/generator/markup.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Handle common RDoc::Markup tasks for various CodeObjects
 #
@@ -65,16 +65,6 @@ end
 
 class RDoc::MethodAttr
 
-  @add_line_numbers = false
-
-  class << self
-    ##
-    # Allows controlling whether <tt>#markup_code</tt> adds line numbers to
-    # the source code.
-
-    attr_accessor :add_line_numbers
-  end
-
   ##
   # Prepend +src+ with line numbers.  Relies on the first line of a source
   # code listing having:
@@ -106,7 +96,7 @@ class RDoc::MethodAttr
   ##
   # Turns the method's token stream into HTML.
   #
-  # Prepends line numbers if +add_line_numbers+ is true.
+  # Prepends line numbers if +options.line_numbers+ is true.
 
   def markup_code
     return '' unless @token_stream
@@ -126,7 +116,7 @@ class RDoc::MethodAttr
     end
     src.gsub!(/^#{' ' * indent}/, '') if indent > 0
 
-    add_line_numbers(src) if RDoc::MethodAttr.add_line_numbers
+    add_line_numbers(src) if options.line_numbers
 
     src
   end

data/lib/rdoc/generator/pot/message_extractor.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Extracts message from RDoc::Store
 

data/lib/rdoc/generator/pot/po.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Generates a PO format text
 
@@ -29,8 +29,8 @@ class RDoc::Generator::POT::PO
   def to_s
     po = ''
     sort_entries.each do |entry|
-      po << "\n" unless po.empty?
-      po << entry.to_s
+      po += "\n" unless po.empty?
+      po += entry.to_s
     end
     po
   end

data/lib/rdoc/generator/pot/po_entry.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A PO entry in PO
 
@@ -40,11 +40,11 @@ class RDoc::Generator::POT::POEntry
 
   def to_s
     entry = ''
-    entry << format_translator_comment
-    entry << format_extracted_comment
-    entry << format_references
-    entry << format_flags
-    entry << <<-ENTRY
+    entry += format_translator_comment
+    entry += format_extracted_comment
+    entry += format_references
+    entry += format_flags
+    entry += <<-ENTRY
 msgid #{format_message(@msgid)}
 msgstr #{format_message(@msgstr)}
     ENTRY
@@ -75,9 +75,9 @@ msgstr #{format_message(@msgstr)}
 
     formatted_comment = ''
     comment.each_line do |line|
-      formatted_comment << "#{mark} #{line}"
+      formatted_comment += "#{mark} #{line}"
     end
-    formatted_comment << "\n" unless formatted_comment.end_with?("\n")
+    formatted_comment += "\n" unless formatted_comment.end_with?("\n")
     formatted_comment
   end
 
@@ -94,7 +94,7 @@ msgstr #{format_message(@msgstr)}
 
     formatted_references = ''
     @references.sort.each do |file, line|
-      formatted_references << "\#: #{file}:#{line}\n"
+      formatted_references += "\#: #{file}:#{line}\n"
     end
     formatted_references
   end
@@ -111,8 +111,8 @@ msgstr #{format_message(@msgstr)}
 
     formatted_message = '""'
     message.each_line do |line|
-      formatted_message << "\n"
-      formatted_message << "\"#{escape(line)}\""
+      formatted_message += "\n"
+      formatted_message += "\"#{escape(line)}\""
     end
     formatted_message
   end

data/lib/rdoc/generator/pot.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Generates a POT file.
 #
@@ -91,8 +91,8 @@ class RDoc::Generator::POT
     extractor.extract
   end
 
-  autoload :MessageExtractor, 'rdoc/generator/pot/message_extractor'
-  autoload :PO,               'rdoc/generator/pot/po'
-  autoload :POEntry,          'rdoc/generator/pot/po_entry'
+  require_relative 'pot/message_extractor'
+  require_relative 'pot/po'
+  require_relative 'pot/po_entry'
 
 end

data/lib/rdoc/generator/ri.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Generates ri data files
 

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

@@ -1,5 +1,5 @@
 <footer id="validator-badges" role="contentinfo">
-  <p><a href="http://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> <%= RDoc::VERSION %>.
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>.
   <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
 </footer>

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

@@ -7,14 +7,16 @@
   var index_rel_prefix = "<%= rel_prefix %>/";
 </script>
 
-<script src="<%= asset_rel_prefix %>/js/jquery.js"></script>
-<script src="<%= asset_rel_prefix %>/js/darkfish.js"></script>
+<script src="<%= asset_rel_prefix %>/js/navigation.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/search.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/search_index.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/searcher.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/darkfish.js" defer></script>
 
 <link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
 <link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
-<% if @options.template_stylesheets.flatten.any? then %>
-<%   @options.template_stylesheets.flatten.each do |stylesheet| %>
+<%- if @options.template_stylesheets.flatten.any? then -%>
+<%-   @options.template_stylesheets.flatten.each do |stylesheet| -%>
 <link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
-<%   end %>
-<% end %>
-
+<%-   end -%>
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<% if !svninfo.empty? then %>
+<%- if !svninfo.empty? then %>
 <div id="file-svninfo-section" class="nav-section">
   <h3>VCS Info</h3>
 
@@ -16,4 +16,4 @@
     </dl>
   </div>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,8 +2,8 @@
   <h3>Class and Module Index</h3>
 
   <ul class="link-list">
-  <% @modsort.each do |index_klass| %>
+  <%- @modsort.each do |index_klass| -%>
     <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
-  <% end %>
+  <%- end -%>
   </ul>
 </div>

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

@@ -1,15 +1,15 @@
-<% unless klass.extends.empty? then %>
+<%- unless klass.extends.empty? then %>
 <div id="extends-section" class="nav-section">
   <h3>Extended With Modules</h3>
 
   <ul class="link-list">
-    <% klass.each_extend do |ext| %>
-  <% unless String === ext.module then %>
+    <%- klass.each_extend do |ext| -%>
+  <%- unless String === ext.module then -%>
     <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
-  <% else %>
+  <%- else -%>
     <li><span class="extend"><%= ext.name %></span>
-  <% end %>
-  <% end %>
+  <%- end -%>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,8 +2,8 @@
   <h3>Defined In</h3>
 
   <ul>
-<% klass.in_files.each do |tl| %>
+<%- klass.in_files.each do |tl| -%>
     <li><%= h tl.relative_name %>
-<% end %>
+<%- end -%>
   </ul>
 </div>

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

@@ -1,15 +1,15 @@
-<% unless klass.includes.empty? then %>
+<%- unless klass.includes.empty? then %>
 <div id="includes-section" class="nav-section">
   <h3>Included Modules</h3>
 
   <ul class="link-list">
-  <% klass.each_include do |inc| %>
-  <% unless String === inc.module then %>
+  <%- klass.each_include do |inc| -%>
+  <%- unless String === inc.module then -%>
     <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
-  <% else %>
+  <%- else -%>
     <li><span class="include"><%= inc.name %></span>
-  <% end %>
-  <% end %>
+  <%- end -%>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,14 +2,14 @@
   <h3>Documentation</h3>
 
   <ul>
-  <% installed.each do |name, href, exists, type, _| %>
-    <% next if type == :extra %>
+  <%- installed.each do |name, href, exists, type, _| -%>
+    <%- next if type == :extra -%>
     <li class="folder">
-    <% if exists then %>
+    <%- if exists then -%>
       <a href="<%= href %>"><%= h name %></a>
-    <% else %>
+    <%- else -%>
       <%= h name %>
-    <% end %>
-  <% end %>
+    <%- end -%>
+  <%- end -%>
   </ul>
 </div>

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

@@ -1,12 +1,12 @@
-<% unless klass.method_list.empty? then %>
+<%- unless klass.method_list.empty? then %>
 <!-- Method Quickref -->
 <div id="method-list-section" class="nav-section">
   <h3>Methods</h3>
 
   <ul class="link-list" role="directory">
-    <% klass.each_method do |meth| %>
-    <li <% if meth.calls_super %>class="calls-super" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
-    <% end %>
+    <%- klass.each_method do |meth| -%>
+    <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name -%></a>
+    <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,12 +1,12 @@
-<% simple_files = @files.select { |f| f.text? } %>
-<% unless simple_files.empty? then %>
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- unless simple_files.empty? then -%>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  <% simple_files.each do |f| %>
+  <%- simple_files.each do |f| -%>
     <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
-  <% end %>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,11 +1,11 @@
-<% if klass.type == 'class' then %>
+<%- if klass.type == 'class' then %>
 <div id="parent-class-section" class="nav-section">
   <h3>Parent</h3>
 
-  <% if klass.superclass and not String === klass.superclass then %>
+  <%- if klass.superclass and not String === klass.superclass then -%>
   <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
-  <% else %>
+  <%- else -%>
   <p class="link"><%= klass.superclass %>
-  <% end %>
+  <%- end -%>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,11 +1,11 @@
-<% unless klass.sections.length == 1 then %>
+<%- unless klass.sections.length == 1 then %>
 <div id="sections-section" class="nav-section">
   <h3>Sections</h3>
 
   <ul class="link-list" role="directory">
-    <% klass.sort_sections.each do |section| %>
+    <%- klass.sort_sections.each do |section| -%>
       <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
-    <% end %>
+    <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<% comment = if current.respond_to? :comment_location then
+<%- comment = if current.respond_to? :comment_location then
                current.comment_location
              else
                current.comment
@@ -10,9 +10,9 @@
   <h3>Table of Contents</h3>
 
   <ul class="link-list" role="directory">
-<%   table.each do |heading| %>
+<%-   table.each do |heading| -%>
     <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
-<%   end %>
+<%-   end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -25,11 +25,9 @@
     <%= klass.description %>
   </section>
 
-  <% klass.each_section do |section, constants, attributes| %>
-  <% constants = constants.select { |const| const.display? } %>
-  <% attributes = attributes.select { |attr| attr.display? } %>
+  <%- 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 %>
@@ -38,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
@@ -78,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? %>
@@ -98,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"><%= method.param_seq %></span>
-          <% if method.token_stream then %>
+            class="method-args"><%= h method.param_seq %></span>
+          <%- 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
               <%=
@@ -137,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
@@ -156,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>