rdoc 5.0.0 → 6.3.1

data/lib/rdoc/erb_partial.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Allows an ERB template to be rendered in the context (binding) of an
 # existing ERB template evaluation.
@@ -12,7 +12,7 @@ class RDoc::ERBPartial < ERB
   def set_eoutvar compiler, eoutvar = '_erbout'
     super
 
-    compiler.pre_cmd = ["#{eoutvar} ||= ''"]
+    compiler.pre_cmd = ["#{eoutvar} ||= +''"]
   end
 
 end

data/lib/rdoc/erbio.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'erb'
 
 ##
@@ -9,7 +9,7 @@ require 'erb'
 #
 #   erbio = RDoc::ERBIO.new '<%= "hello world" %>', nil, nil
 #
-#   open 'hello.txt', 'w' do |io|
+#   File.open 'hello.txt', 'w' do |io|
 #     erbio.result binding
 #   end
 #
@@ -20,8 +20,12 @@ class RDoc::ERBIO < ERB
   ##
   # Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize
 
-  def initialize str, safe_level = nil, trim_mode = nil, eoutvar = 'io'
-    super
+  def initialize str, safe_level = nil, legacy_trim_mode = nil, legacy_eoutvar = 'io', trim_mode: nil, eoutvar: 'io'
+    if RUBY_VERSION >= '2.6'
+      super(str, trim_mode: trim_mode, eoutvar: eoutvar)
+    else
+      super(str, safe_level, legacy_trim_mode, legacy_eoutvar)
+    end
   end
 
   ##

data/lib/rdoc/extend.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A Module extension to a class with \#extend
 #

data/lib/rdoc/generator/darkfish.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 # -*- mode: ruby; ruby-indent-level: 2; tab-width: 2 -*-
 
 require 'erb'
 require 'fileutils'
 require 'pathname'
-require 'rdoc/generator/markup'
+require_relative 'markup'
 
 ##
 # Darkfish RDoc HTML Generator
@@ -269,7 +269,7 @@ class RDoc::Generator::Darkfish
 
     @options.static_path.each do |path|
       unless File.directory? path then
-        FileUtils.install path, @outputdir, fu_options.merge(:mode => 0644)
+        FileUtils.install path, @outputdir, **fu_options.merge(:mode => 0644)
         next
       end
 
@@ -278,9 +278,9 @@ class RDoc::Generator::Darkfish
           dest_file = @outputdir + entry
 
           if File.directory? entry then
-            FileUtils.mkdir_p entry, fu_options
+            FileUtils.mkdir_p entry, **fu_options
           else
-            FileUtils.install entry, dest_file, fu_options.merge(:mode => 0644)
+            FileUtils.install entry, dest_file, **fu_options.merge(:mode => 0644)
           end
         end
       end
@@ -313,12 +313,16 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+    asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = @options.title
 
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   rescue => e
     error = RDoc::Error.new \
       "error generating index.html: #{e.message} (#{e.class})"
@@ -343,14 +347,19 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
-    svninfo          = svninfo          = get_svninfo(current)
+    asset_rel_prefix = rel_prefix + @asset_rel_path
+    svninfo          = get_svninfo(current)
 
     @title = "#{klass.type} #{klass.full_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here.local_variable_set(:svninfo, svninfo)
+      here
+    end
   end
 
   ##
@@ -416,8 +425,7 @@ class RDoc::Generator::Darkfish
       search_index_rel_prefix = rel_prefix
       search_index_rel_prefix += @asset_rel_path if @file_output
 
-      # suppress 1.9.3 warning
-      asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+      asset_rel_prefix = rel_prefix + @asset_rel_path
 
       unless filepage_file then
         if file.text? then
@@ -434,7 +442,13 @@ class RDoc::Generator::Darkfish
       @title += " - #{@options.title}"
       template_file ||= filepage_file
 
-      render_template template_file, out_file do |io| binding end
+      render_template template_file, out_file do |io|
+        here = binding
+        # suppress 1.9.3 warning
+        here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+        here.local_variable_set(:current, current)
+        here
+      end
     end
   rescue => e
     error =
@@ -458,14 +472,19 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    current          = current          = file
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+    current          = file
+    asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = "#{file.page_name} - #{@options.title}"
 
     debug_msg "  rendering #{out_file}"
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:current, current)
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   end
 
   ##
@@ -483,12 +502,16 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = ''
+    asset_rel_prefix = ''
 
     @title = 'Not Found'
 
-    render_template template_file do |io| binding end
+    render_template template_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   rescue => e
     error = RDoc::Error.new \
       "error generating servlet_not_found: #{e.message} (#{e.class})"
@@ -540,12 +563,16 @@ class RDoc::Generator::Darkfish
     search_index_rel_prefix = rel_prefix
     search_index_rel_prefix += @asset_rel_path if @file_output
 
-    # suppress 1.9.3 warning
-    asset_rel_prefix = asset_rel_prefix = rel_prefix + @asset_rel_path
+    asset_rel_prefix = rel_prefix + @asset_rel_path
 
     @title = "Table of Contents - #{@options.title}"
 
-    render_template template_file, out_file do |io| binding end
+    render_template template_file, out_file do |io|
+      here = binding
+      # suppress 1.9.3 warning
+      here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
+      here
+    end
   rescue => e
     error = RDoc::Error.new \
       "error generating table_of_contents.html: #{e.message} (#{e.class})"
@@ -558,16 +585,16 @@ class RDoc::Generator::Darkfish
     return unless source.exist?
 
     begin
-      FileUtils.mkdir_p File.dirname(destination), options
+      FileUtils.mkdir_p File.dirname(destination), **options
 
       begin
-        FileUtils.ln source, destination, options
+        FileUtils.ln source, destination, **options
       rescue Errno::EEXIST
         FileUtils.rm destination
         retry
       end
     rescue
-      FileUtils.cp source, destination, options
+      FileUtils.cp source, destination, **options
     end
   end
 
@@ -751,7 +778,11 @@ class RDoc::Generator::Darkfish
       erbout = "_erbout_#{file_var}"
     end
 
-    template = klass.new template, nil, '<>', erbout
+    if RUBY_VERSION >= '2.6'
+      template = klass.new template, trim_mode: '-', eoutvar: erbout
+    else
+      template = klass.new template, nil, '-', erbout
+    end
     @template_cache[file] = template
     template
   end

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
@@ -170,7 +173,7 @@ class RDoc::Generator::JsonIndex
     outfile           = out_dir + "#{search_index_file}.gz"
 
     debug_msg "Reading the JSON index file from %s" % search_index_file
-    search_index = search_index_file.read
+    search_index = search_index_file.read(mode: 'r:utf-8')
 
     debug_msg "Writing gzipped search index to %s" % outfile
 

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 -%>