rdoc 7.2.0 → 8.1.0

data/lib/rdoc/generator/markup.rb

@@ -1,171 +1,214 @@
 # frozen_string_literal: true
-##
-# Handle common RDoc::Markup tasks for various CodeObjects
-#
-# This module is loaded by generators.  It allows RDoc's CodeObject tree to
-# avoid loading generator code to improve startup time for +ri+.
+module RDoc
+  module Generator
+    ##
+    # Handle common RDoc::Markup tasks for various CodeObjects
+    #
+    # This module is loaded by generators.  It allows RDoc's CodeObject tree to
+    # avoid loading generator code to improve startup time for +ri+.
 
-module RDoc::Generator::Markup
+    module Markup
 
-  ##
-  # Generates a relative URL from this object's path to +target_path+
+      ##
+      # Generates a relative URL from this object's path to +target_path+
 
-  def aref_to(target_path)
-    RDoc::Markup::ToHtml.gen_relative_url path, target_path
-  end
+      def aref_to(target_path)
+        ::RDoc::Markup::ToHtml.gen_relative_url path, target_path
+      end
 
-  ##
-  # Generates a relative URL from +from_path+ to this object's path
+      ##
+      # Generates a relative URL from +from_path+ to this object's path
 
-  def as_href(from_path)
-    RDoc::Markup::ToHtml.gen_relative_url from_path, path
-  end
+      def as_href(from_path)
+        ::RDoc::Markup::ToHtml.gen_relative_url from_path, path
+      end
 
-  ##
-  # Handy wrapper for marking up this object's comment
+      ##
+      # Handy wrapper for marking up this object's comment
 
-  def description
-    markup @comment
-  end
+      def description
+        markup @comment
+      end
 
-  ##
-  # Creates an RDoc::Markup::ToHtmlCrossref formatter
+      ##
+      # Creates an RDoc::Markup::ToHtmlCrossref formatter
+
+      def formatter
+        return @formatter if defined? @formatter
+
+        options = @store.options
+        this = Context === self ? self : @parent
+
+        @formatter = ::RDoc::Markup::ToHtmlCrossref.new(
+          this.path, this,
+          pipe: options.pipe,
+          output_decoration: options.output_decoration,
+          hyperlink_all: options.hyperlink_all,
+          show_hash: options.show_hash,
+          autolink_excluded_words: options.autolink_excluded_words || [],
+          warn_missing_rdoc_ref: options.warn_missing_rdoc_ref
+        )
+        @formatter.code_object = self
+        @formatter
+      end
 
-  def formatter
-    return @formatter if defined? @formatter
+      ##
+      # Build a webcvs URL starting for the given +url+ with +full_path+ appended
+      # as the destination path.  If +url+ contains '%s' +full_path+ will be
+      # will replace the %s using sprintf on the +url+.
+
+      def cvs_url(url, full_path)
+        if /%s/ =~ url
+          sprintf url, full_path
+        else
+          url + full_path
+        end
+      end
 
-    options = @store.options
-    this = RDoc::Context === self ? self : @parent
+      ##
+      # The preferred URL for this object.
 
-    @formatter = RDoc::Markup::ToHtmlCrossref.new options, this.path, this
-    @formatter.code_object = self
-    @formatter
+      def canonical_url
+        options = @store.options
+        if path
+          File.join(options.canonical_root, path.to_s)
+        else
+          options.canonical_root
+        end
+      end
+
+    end
   end
+end
 
-  ##
-  # Build a webcvs URL starting for the given +url+ with +full_path+ appended
-  # as the destination path.  If +url+ contains '%s' +full_path+ will be
-  # will replace the %s using sprintf on the +url+.
+module RDoc
+  class CodeObject
+
+    include Generator::Markup
 
-  def cvs_url(url, full_path)
-    if /%s/ =~ url then
-      sprintf url, full_path
-    else
-      url + full_path
-    end
   end
+end
+
+module RDoc
+  class AnyMethod
 
-  ##
-  # The preferred URL for this object.
+    ##
+    # Creates an HTML link to the superclass method called by this method.
 
-  def canonical_url
-    options = @store.options
-    if path
-      File.join(options.canonical_root, path.to_s)
-    else
-      options.canonical_root
+    def superclass_method_link
+      target = superclass_method
+      return unless target
+
+      html_formatter = formatter
+      name = target.full_name
+
+      html_formatter.link name, html_formatter.convert_string(name)
     end
-  end
 
+  end
 end
 
-class RDoc::CodeObject
+module RDoc
+  class MethodAttr
 
-  include RDoc::Generator::Markup
+    ##
+    # Prepend +src+ with line numbers.
 
-end
+    def add_line_numbers(src)
+      return if src.empty? || !line
+      start_line = line
+      end_line  = start_line + src.count("\n")
+      number_digits = end_line.to_s.length
 
-class RDoc::MethodAttr
-
-  ##
-  # Prepend +src+ with line numbers.  Relies on the first line of a source
-  # code listing having:
-  #
-  #   # File xxxxx, line dddd
-  #
-  # If it has this comment then line numbers are added to +src+ and the <tt>,
-  # line dddd</tt> portion of the comment is removed.
-
-  def add_line_numbers(src)
-    return unless src.sub!(/\A(.*)(, line (\d+))/, '\1')
-    first = $3.to_i - 1
-    last  = first + src.count("\n")
-    size = last.to_s.length
-
-    line = first
-    src.gsub!(/^/) do
-      res = if line == first then
-              " " * (size + 1)
-            else
-              "<span class=\"line-num\">%2$*1$d</span> " % [size, line]
-            end
-
-      line += 1
-      res
+      current_line = start_line
+      src.gsub!(/^/) do
+        res = "<span class=\"line-num\">#{current_line.to_s.rjust(number_digits)}</span> "
+
+        current_line += 1
+        res
+      end
     end
-  end
 
-  ##
-  # Turns the method's token stream into HTML.
-  #
-  # Prepends line numbers if +options.line_numbers+ is true.
-
-  def markup_code
-    return '' unless @token_stream
-
-    src = RDoc::TokenStream.to_html @token_stream
-
-    # dedent the source
-    indent = src.length
-    lines = src.lines.to_a
-    lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
-    lines.each do |line|
-      if line =~ /^ *(?=\S)/
-        n = $~.end(0)
-        indent = n if n < indent
-        break if n == 0
+    ##
+    # Prepend +src+ with a comment that declares its location in the source.
+
+    def add_location_comment(src)
+      path = CGI.escapeHTML(file.relative_name)
+      if options.line_numbers && !src.empty?
+        src.prepend("<span class=\"ruby-comment\"># File #{path}</span>\n")
+      else
+        src.prepend("<span class=\"ruby-comment\"># File #{path}, line #{line}</span>\n")
       end
     end
-    src.gsub!(/^#{' ' * indent}/, '') if indent > 0
 
-    add_line_numbers(src) if options.line_numbers
+    ##
+    # Turns the method's token stream into HTML.
+    #
+    # Prepends line numbers if +options.line_numbers+ is true.
 
-    src
-  end
+    def markup_code
+      return '' unless token_stream
 
-end
+      src = TokenStream.to_html token_stream
 
-class RDoc::ClassModule
+      # dedent the source
+      common_indent = src.length
+      src.scan(/^ *(?=\S)/) do |whitespace|
+        common_indent = whitespace.length if whitespace.length < common_indent
+        break if common_indent == 0
+      end
+      src.gsub!(/^#{' ' * common_indent}/, '') if common_indent > 0
 
-  ##
-  # Handy wrapper for marking up this class or module's comment
+      if source_language == 'ruby'
+        add_line_numbers(src) if options.line_numbers
+        add_location_comment(src)
+      end
+
+      src
+    end
 
-  def description
-    markup @comment_location
   end
+end
 
+module RDoc
+  class ClassModule
+
+    ##
+    # Handy wrapper for marking up this class or module's comment
+
+    def description
+      markup @comment_location
+    end
+
+  end
 end
 
-class RDoc::Context::Section
+module RDoc
+  class Context
+    class Section
 
-  include RDoc::Generator::Markup
+      include Generator::Markup
 
+    end
+  end
 end
 
-class RDoc::TopLevel
+module RDoc
+  class TopLevel
 
-  ##
-  # Returns a URL for this source file on some web repository.  Use the -W
-  # command line option to set.
+    ##
+    # Returns a URL for this source file on some web repository.  Use the -W
+    # command line option to set.
 
-  def cvs_url
-    url = @store.options.webcvs
+    def cvs_url
+      url = @store.options.webcvs
 
-    if /%s/ =~ url then
-      url % @relative_name
-    else
-      url + @relative_name
+      if /%s/ =~ url
+        url % @relative_name
+      else
+        url + @relative_name
+      end
     end
-  end
 
+  end
 end

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

@@ -1,68 +1,74 @@
 # frozen_string_literal: true
-##
-# Extracts message from RDoc::Store
+module RDoc
+  module Generator
+    class POT
+      ##
+      # Extracts message from RDoc::Store
 
-class RDoc::Generator::POT::MessageExtractor
+      class MessageExtractor
 
-  ##
-  # Creates a message extractor for +store+.
+        ##
+        # Creates a message extractor for +store+.
 
-  def initialize(store)
-    @store = store
-    @po = RDoc::Generator::POT::PO.new
-  end
+        def initialize(store)
+          @store = store
+          @po = Generator::POT::PO.new
+        end
 
-  ##
-  # Extracts messages from +store+, stores them into
-  # RDoc::Generator::POT::PO and returns it.
+        ##
+        # 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
+        def extract
+          @store.all_classes_and_modules.each do |klass|
+            extract_from_klass(klass)
+          end
+          @po
+        end
 
-  private
+      private
 
-  def extract_from_klass(klass)
-    extract_text(klass.comment_location, klass.full_name)
+        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_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.constants.each do |constant|
-      extract_text(constant.comment, constant.full_name)
-    end
+          klass.constants.each do |constant|
+            extract_text(constant.comment, constant.full_name)
+          end
 
-    klass.attributes.each do |attribute|
-      extract_text(attribute.comment, attribute.full_name)
-    end
+          klass.attributes.each do |attribute|
+            extract_text(attribute.comment, attribute.full_name)
+          end
 
-    klass.each_method do |method|
-      extract_text(method.comment, method.full_name)
-    end
-  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?
+        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
+          options = {
+            :extracted_comment => comment,
+            :references => [location].compact,
+          }
+          i18n_text = 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
+        def entry(msgid, options)
+          Generator::POT::POEntry.new(msgid, options)
+        end
 
+      end
+    end
+  end
 end

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

@@ -1,55 +1,53 @@
 # frozen_string_literal: true
-##
-# Generates a PO format text
+module RDoc
+  module Generator
+    class POT
+      ##
+      # Generates a PO format text
 
-class RDoc::Generator::POT::PO
+      class PO
 
-  ##
-  # Creates an object that represents PO format.
+        ##
+        # Creates an object that represents PO format.
 
-  def initialize
-    @entries = {}
-    add_header
-  end
+        def initialize
+          @entries = {}
+          add_header
+        end
 
-  ##
-  # Adds a PO entry to the PO.
+        ##
+        # 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
+        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.
+        ##
+        # 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
+        def to_s
+          sort_entries.map(&:to_s).join("\n")
+        end
 
-  private
+      private
 
-  def add_header
-    add(header_entry)
-  end
+        def add_header
+          add(header_entry)
+        end
 
-  def header_entry
-    comment = <<-COMMENT
+        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
+          content = <<-CONTENT
 Project-Id-Version: PACKAGE VERSEION
 Report-Msgid-Bugs-To:
 PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE
@@ -62,23 +60,26 @@ 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
+          options = {
+            :msgstr => content,
+            :translator_comment => comment,
+            :flags => ['fuzzy'],
+          }
+          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
+        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
     end
-    headers + sorted_messages
   end
-
 end