rdoc 4.2.1 → 6.3.1

data/lib/rdoc/erb_partial.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # Allows an ERB template to be rendered in the context (binding) of an
 # existing ERB template evaluation.
@@ -11,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,3 +1,4 @@
+# frozen_string_literal: true
 require 'erb'
 
 ##
@@ -8,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
 #
@@ -19,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,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # A Module extension to a class with \#extend
 #

data/lib/rdoc/generator/darkfish.rb

@@ -1,9 +1,10 @@
+# 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
@@ -268,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
 
@@ -277,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
@@ -312,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})"
@@ -342,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
 
   ##
@@ -415,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
@@ -433,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 =
@@ -457,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
 
   ##
@@ -482,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})"
@@ -539,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})"
@@ -557,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
 
@@ -697,7 +725,7 @@ class RDoc::Generator::Darkfish
 
       out_file.dirname.mkpath
       out_file.open 'w', 0644 do |io|
-        io.set_encoding @options.encoding if Object.const_defined? :Encoding
+        io.set_encoding @options.encoding
 
         @context = yield io
 
@@ -743,18 +771,20 @@ class RDoc::Generator::Darkfish
       erbout = 'io'
     else
       template = file.read
-      template = template.encode @options.encoding if
-        Object.const_defined? :Encoding
+      template = template.encode @options.encoding
 
       file_var = File.basename(file).sub(/\..*/, '')
 
       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
 
 end
-

data/lib/rdoc/generator/json_index.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 begin
   require 'zlib'
@@ -141,17 +142,20 @@ class RDoc::Generator::JsonIndex
     FileUtils.mkdir_p index_file.dirname, :verbose => $DEBUG_RDOC
 
     index_file.open 'w', 0644 do |io|
-      io.set_encoding Encoding::UTF_8 if Object.const_defined? :Encoding
+      io.set_encoding Encoding::UTF_8
       io.write 'var search_data = '
 
       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
@@ -160,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
@@ -169,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
 
@@ -294,4 +298,3 @@ class RDoc::Generator::JsonIndex
   end
 
 end
-

data/lib/rdoc/generator/markup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # Handle common RDoc::Markup tasks for various CodeObjects
 #
@@ -64,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:
@@ -105,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
@@ -125,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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+##
+# Extracts message from RDoc::Store
+
+class RDoc::Generator::POT::MessageExtractor
+
+  ##
+  # Creates a message extractor for +store+.
+
+  def initialize store
+    @store = store
+    @po = RDoc::Generator::POT::PO.new
+  end
+
+  ##
+  # Extracts messages from +store+, stores them into
+  # RDoc::Generator::POT::PO and returns it.
+
+  def extract
+    @store.all_classes_and_modules.each do |klass|
+      extract_from_klass(klass)
+    end
+    @po
+  end
+
+  private
+
+  def extract_from_klass klass
+    extract_text(klass.comment_location, klass.full_name)
+
+    klass.each_section do |section, constants, attributes|
+      extract_text(section.title ,"#{klass.full_name}: section title")
+      section.comments.each do |comment|
+        extract_text(comment, "#{klass.full_name}: #{section.title}")
+      end
+    end
+
+    klass.each_constant do |constant|
+      extract_text(constant.comment, constant.full_name)
+    end
+
+    klass.each_attribute do |attribute|
+      extract_text(attribute.comment, attribute.full_name)
+    end
+
+    klass.each_method do |method|
+      extract_text(method.comment, method.full_name)
+    end
+  end
+
+  def extract_text text, comment, location = nil
+    return if text.nil?
+
+    options = {
+      :extracted_comment => comment,
+      :references => [location].compact,
+    }
+    i18n_text = RDoc::I18n::Text.new(text)
+    i18n_text.extract_messages do |part|
+      @po.add(entry(part[:paragraph], options))
+    end
+  end
+
+  def entry msgid, options
+    RDoc::Generator::POT::POEntry.new(msgid, options)
+  end
+
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+##
+# Generates a PO format text
+
+class RDoc::Generator::POT::PO
+
+  ##
+  # Creates an object that represents PO format.
+
+  def initialize
+    @entries = {}
+    add_header
+  end
+
+  ##
+  # Adds a PO entry to the PO.
+
+  def add entry
+    existing_entry = @entries[entry.msgid]
+    if existing_entry
+      entry = existing_entry.merge(entry)
+    end
+    @entries[entry.msgid] = entry
+  end
+
+  ##
+  # Returns PO format text for the PO.
+
+  def to_s
+    po = ''
+    sort_entries.each do |entry|
+      po += "\n" unless po.empty?
+      po += entry.to_s
+    end
+    po
+  end
+
+  private
+
+  def add_header
+    add(header_entry)
+  end
+
+  def header_entry
+    comment = <<-COMMENT
+SOME DESCRIPTIVE TITLE.
+Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+This file is distributed under the same license as the PACKAGE package.
+FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+    COMMENT
+
+    content = <<-CONTENT
+Project-Id-Version: PACKAGE VERSEION
+Report-Msgid-Bugs-To:
+PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE
+Last-Translator: FULL NAME <EMAIL@ADDRESS>
+Language-Team: LANGUAGE <LL@li.org>
+Language:
+MIME-Version: 1.0
+Content-Type: text/plain; charset=CHARSET
+Content-Transfer-Encoding: 8bit
+Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;
+    CONTENT
+
+    options = {
+      :msgstr => content,
+      :translator_comment => comment,
+      :flags => ['fuzzy'],
+    }
+    RDoc::Generator::POT::POEntry.new('', options)
+  end
+
+  def sort_entries
+    headers, messages = @entries.values.partition do |entry|
+      entry.msgid.empty?
+    end
+    # TODO: sort by location
+    sorted_messages = messages.sort_by do |entry|
+      entry.msgid
+    end
+    headers + sorted_messages
+  end
+
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+##
+# A PO entry in PO
+
+class RDoc::Generator::POT::POEntry
+
+  # The msgid content
+  attr_reader :msgid
+
+  # The msgstr content
+  attr_reader :msgstr
+
+  # The comment content created by translator (PO editor)
+  attr_reader :translator_comment
+
+  # The comment content extracted from source file
+  attr_reader :extracted_comment
+
+  # The locations where the PO entry is extracted
+  attr_reader :references
+
+  # The flags of the PO entry
+  attr_reader :flags
+
+  ##
+  # Creates a PO entry for +msgid+. Other valus can be specified by
+  # +options+.
+
+  def initialize msgid, options = {}
+    @msgid = msgid
+    @msgstr = options[:msgstr] || ""
+    @translator_comment = options[:translator_comment]
+    @extracted_comment = options[:extracted_comment]
+    @references = options[:references] || []
+    @flags = options[:flags] || []
+  end
+
+  ##
+  # Returns the PO entry in PO format.
+
+  def to_s
+    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
+  end
+
+  ##
+  # Merges the PO entry with +other_entry+.
+
+  def merge other_entry
+    options = {
+      :extracted_comment  => merge_string(@extracted_comment,
+                                          other_entry.extracted_comment),
+      :translator_comment => merge_string(@translator_comment,
+                                          other_entry.translator_comment),
+      :references         => merge_array(@references,
+                                         other_entry.references),
+      :flags              => merge_array(@flags,
+                                         other_entry.flags),
+    }
+    self.class.new(@msgid, options)
+  end
+
+  private
+
+  def format_comment mark, comment
+    return '' unless comment
+    return '' if comment.empty?
+
+    formatted_comment = ''
+    comment.each_line do |line|
+      formatted_comment += "#{mark} #{line}"
+    end
+    formatted_comment += "\n" unless formatted_comment.end_with?("\n")
+    formatted_comment
+  end
+
+  def format_translator_comment
+    format_comment('#', @translator_comment)
+  end
+
+  def format_extracted_comment
+    format_comment('#.', @extracted_comment)
+  end
+
+  def format_references
+    return '' if @references.empty?
+
+    formatted_references = ''
+    @references.sort.each do |file, line|
+      formatted_references += "\#: #{file}:#{line}\n"
+    end
+    formatted_references
+  end
+
+  def format_flags
+    return '' if @flags.empty?
+
+    formatted_flags = flags.join(",")
+    "\#, #{formatted_flags}\n"
+  end
+
+  def format_message message
+    return "\"#{escape(message)}\"" unless message.include?("\n")
+
+    formatted_message = '""'
+    message.each_line do |line|
+      formatted_message += "\n"
+      formatted_message += "\"#{escape(line)}\""
+    end
+    formatted_message
+  end
+
+  def escape string
+    string.gsub(/["\\\t\n]/) do |special_character|
+      case special_character
+      when "\t"
+        "\\t"
+      when "\n"
+        "\\n"
+      else
+        "\\#{special_character}"
+      end
+    end
+  end
+
+  def merge_string string1, string2
+    [string1, string2].compact.join("\n")
+  end
+
+  def merge_array array1, array2
+      (array1 + array2).uniq
+  end
+
+end

data/lib/rdoc/generator/pot.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # Generates a POT file.
 #
@@ -90,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,3 +1,4 @@
+# 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="http://docs.seattlerb.org/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>