rdoc 4.2.1 → 6.3.1

data/lib/rdoc/comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # A comment holds the text comment for a RDoc::CodeObject and provides a
 # unified way of cleaning it up and parsing it into an RDoc::Markup::Document.
@@ -22,6 +23,11 @@ class RDoc::Comment
 
   attr_accessor :location
 
+  ##
+  # Line where this Comment was written
+
+  attr_accessor :line
+
   ##
   # For duck-typing when merging classes at load time
 
@@ -32,6 +38,11 @@ class RDoc::Comment
 
   attr_reader :text
 
+  ##
+  # Alias for text
+
+  alias to_s text
+
   ##
   # Overrides the content returned by #parse.  Use when there is no #text
   # source for this comment
@@ -42,9 +53,10 @@ class RDoc::Comment
   # Creates a new comment with +text+ that is found in the RDoc::TopLevel
   # +location+.
 
-  def initialize text = nil, location = nil
+  def initialize text = nil, location = nil, language = nil
     @location = location
-    @text     = text
+    @text     = text.nil? ? nil : text.dup
+    @language = language
 
     @document   = nil
     @format     = 'rdoc'
@@ -113,10 +125,14 @@ class RDoc::Comment
 
       method.call_seq = seq.chomp
 
-    elsif @text.sub!(/^\s*:?call-seq:(.*?)(^\s*$|\z)/m, '') then
-      seq = $1
-      seq.gsub!(/^\s*/, '')
-      method.call_seq = seq
+    else
+      regexp = /^\s*:?call-seq:(.*?)(^\s*$|\z)/m
+      if regexp =~ @text then
+        @text = @text.sub(regexp, '')
+        seq = $1
+        seq.gsub!(/^\s*/, '')
+        method.call_seq = seq
+      end
     end
 
     method
@@ -132,8 +148,14 @@ class RDoc::Comment
   ##
   # HACK dubious
 
-  def force_encoding encoding
-    @text.force_encoding encoding
+  def encode! encoding
+    # TODO: Remove this condition after Ruby 2.2 EOL
+    if RUBY_VERSION < '2.3.0'
+      @text = @text.force_encoding encoding
+    else
+      @text = String.new @text, encoding: encoding
+    end
+    self
   end
 
   ##
@@ -199,7 +221,7 @@ class RDoc::Comment
   def remove_private
     # Workaround for gsub encoding for Ruby 1.9.2 and earlier
     empty = ''
-    empty.force_encoding @text.encoding if Object.const_defined? :Encoding
+    empty = RDoc::Encoding.change_encoding empty, @text.encoding
 
     @text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\+\+\n?%m, empty)
     @text = @text.sub(%r%^\s*[#*]?--.*%m, '')
@@ -215,7 +237,7 @@ class RDoc::Comment
       @text.nil? and @document
 
     @document = nil
-    @text = text
+    @text = text.nil? ? nil : text.dup
   end
 
   ##
@@ -226,4 +248,3 @@ class RDoc::Comment
   end
 
 end
-

data/lib/rdoc/constant.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # A constant
 
@@ -35,7 +36,7 @@ class RDoc::Constant < RDoc::CodeObject
     @value = value
 
     @is_alias_for = nil
-    @visibility   = nil
+    @visibility   = :public
 
     self.comment = comment
   end
@@ -135,7 +136,7 @@ class RDoc::Constant < RDoc::CodeObject
     initialize array[1], nil, array[5]
 
     @full_name     = array[2]
-    @visibility    = array[3]
+    @visibility    = array[3] || :public
     @is_alias_for  = array[4]
     #                      5 handled above
     #                      6 handled below

data/lib/rdoc/context/section.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # A section of documentation like:
 #
@@ -33,8 +34,6 @@ class RDoc::Context::Section
 
   attr_reader :title
 
-  @@sequence = "SEC00000"
-
   ##
   # Creates a new section with +title+ and +comment+
 
@@ -42,9 +41,6 @@ class RDoc::Context::Section
     @parent = parent
     @title = title ? title.strip : title
 
-    @@sequence.succ!
-    @sequence = @@sequence.dup
-
     @comments = []
 
     add_comment comment
@@ -57,6 +53,8 @@ class RDoc::Context::Section
     self.class === other and @title == other.title
   end
 
+  alias eql? ==
+
   ##
   # Adds +comment+ to this section
 
@@ -127,6 +125,10 @@ class RDoc::Context::Section
     "#<%s:0x%x %p>" % [self.class, object_id, title]
   end
 
+  def hash # :nodoc:
+    @title.hash
+  end
+
   ##
   # The files comments in this section come from
 
@@ -226,13 +228,5 @@ class RDoc::Context::Section
     end
   end
 
-  ##
-  # Section sequence number (deprecated)
-
-  def sequence
-    warn "RDoc::Context::Section#sequence is deprecated, use #aref"
-    @sequence
-  end
-
 end
 

data/lib/rdoc/context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cgi'
 
 ##
@@ -97,6 +98,11 @@ class RDoc::Context < RDoc::CodeObject
 
   attr_accessor :visibility
 
+  ##
+  # Current visibility of this line
+
+  attr_writer :current_line_visibility
+
   ##
   # Hash of registered methods. Attributes are also registered here,
   # twice if they are RW.
@@ -147,6 +153,7 @@ class RDoc::Context < RDoc::CodeObject
     @extends     = []
     @constants   = []
     @external_aliases = []
+    @current_line_visibility = nil
 
     # This Hash maps a method name to a list of unmatched aliases (aliases of
     # a method not yet encountered).
@@ -232,7 +239,7 @@ class RDoc::Context < RDoc::CodeObject
 
       if known then
         known.comment = attribute.comment if known.comment.empty?
-      elsif registered = @methods_hash[attribute.pretty_name << '='] and
+      elsif registered = @methods_hash[attribute.pretty_name + '='] and
             RDoc::Attr === registered then
         registered.rw = 'RW'
       else
@@ -242,7 +249,7 @@ class RDoc::Context < RDoc::CodeObject
     end
 
     if attribute.rw.index 'W' then
-      key = attribute.pretty_name << '='
+      key = attribute.pretty_name + '='
       known = @methods_hash[key]
 
       if known then
@@ -326,7 +333,7 @@ class RDoc::Context < RDoc::CodeObject
     if full_name == 'BasicObject' then
       superclass = nil
     elsif full_name == 'Object' then
-      superclass = defined?(::BasicObject) ? '::BasicObject' : nil
+      superclass = '::BasicObject'
     end
 
     # find the superclass full name
@@ -400,6 +407,7 @@ class RDoc::Context < RDoc::CodeObject
     mod.section = current_section # TODO declaring context? something is
                                   # wrong here...
     mod.parent = self
+    mod.full_name = nil
     mod.store = @store
 
     unless @done_documenting then
@@ -407,6 +415,10 @@ class RDoc::Context < RDoc::CodeObject
       # this must be done AFTER adding mod to its parent, so that the full
       # name is correct:
       all_hash[mod.full_name] = mod
+      if @store.unmatched_constant_alias[mod.full_name] then
+        to, file = @store.unmatched_constant_alias[mod.full_name]
+        add_module_alias mod, mod.name, to, file
+      end
     end
 
     mod
@@ -477,7 +489,11 @@ class RDoc::Context < RDoc::CodeObject
       end
     else
       @methods_hash[key] = method
-      method.visibility = @visibility
+      if @current_line_visibility
+        method.visibility, @current_line_visibility = @current_line_visibility, nil
+      else
+        method.visibility = @visibility
+      end
       add_to @method_list, method
       resolve_aliases method
     end
@@ -499,41 +515,53 @@ class RDoc::Context < RDoc::CodeObject
     add_class_or_module mod, @modules, @store.modules_hash
   end
 
+  ##
+  # Adds a module by +RDoc::NormalModule+ instance. See also #add_module.
+
+  def add_module_by_normal_module(mod)
+    add_class_or_module mod, @modules, @store.modules_hash
+  end
+
   ##
   # Adds an alias from +from+ (a class or module) to +name+ which was defined
   # in +file+.
 
-  def add_module_alias from, name, file
+  def add_module_alias from, from_name, to, file
     return from if @done_documenting
 
-    to_name = child_name name
+    to_full_name = child_name to.name
 
     # if we already know this name, don't register an alias:
     # see the metaprogramming in lib/active_support/basic_object.rb,
     # where we already know BasicObject is a class when we find
     # BasicObject = BlankSlate
-    return from if @store.find_class_or_module to_name
+    return from if @store.find_class_or_module to_full_name
 
-    to = from.dup
-    to.name = name
-    to.full_name = nil
+    unless from
+      @store.unmatched_constant_alias[child_name(from_name)] = [to, file]
+      return to
+    end
+
+    new_to = from.dup
+    new_to.name = to.name
+    new_to.full_name = nil
 
-    if to.module? then
-      @store.modules_hash[to_name] = to
-      @modules[name] = to
+    if new_to.module? then
+      @store.modules_hash[to_full_name] = new_to
+      @modules[to.name] = new_to
     else
-      @store.classes_hash[to_name] = to
-      @classes[name] = to
+      @store.classes_hash[to_full_name] = new_to
+      @classes[to.name] = new_to
     end
 
     # Registers a constant for this alias.  The constant value and comment
     # will be updated later, when the Ruby parser adds the constant
-    const = RDoc::Constant.new name, nil, to.comment
+    const = RDoc::Constant.new to.name, nil, new_to.comment
     const.record_location file
     const.is_alias_for = from
     add_constant const
 
-    to
+    new_to
   end
 
   ##
@@ -751,7 +779,7 @@ class RDoc::Context < RDoc::CodeObject
     attributes.default = []
 
     sort_sections.each do |section|
-      yield section, constants[section].sort, attributes[section].sort
+      yield section, constants[section].select(&:display?).sort, attributes[section].select(&:display?).sort
     end
   end
 
@@ -788,7 +816,9 @@ class RDoc::Context < RDoc::CodeObject
   # Finds a constant with +name+ in this context
 
   def find_constant_named(name)
-    @constants.find {|m| m.name == name}
+    @constants.find do |m|
+      m.name == name || m.full_name == name
+    end
   end
 
   ##
@@ -850,7 +880,13 @@ class RDoc::Context < RDoc::CodeObject
   # Finds a method named +name+ with singleton value +singleton+.
 
   def find_method(name, singleton)
-    @method_list.find { |m| m.name == name && m.singleton == singleton }
+    @method_list.find { |m|
+      if m.singleton
+        m.name == name && m.singleton == singleton
+      else
+        m.name == name && !m.singleton && !singleton
+      end
+    }
   end
 
   ##
@@ -954,13 +990,21 @@ class RDoc::Context < RDoc::CodeObject
     @instance_attributes ||= attributes.reject { |a| a.singleton }
   end
 
+  ##
+  # Instance methods
+
+  def instance_methods
+    @instance_methods ||= method_list.reject { |a| a.singleton }
+  end
+
   ##
   # Instance methods
   #--
-  # TODO rename to instance_methods
+  # TODO remove this later
 
   def instance_method_list
-    @instance_method_list ||= method_list.reject { |a| a.singleton }
+    warn '#instance_method_list is obsoleted, please use #instance_methods'
+    @instance_methods ||= method_list.reject { |a| a.singleton }
   end
 
   ##
@@ -1066,6 +1110,7 @@ class RDoc::Context < RDoc::CodeObject
     return if [:private, :nodoc].include? min_visibility
     remove_invisible_in @method_list, min_visibility
     remove_invisible_in @attributes, min_visibility
+    remove_invisible_in @constants, min_visibility
   end
 
   ##
@@ -1152,6 +1197,17 @@ class RDoc::Context < RDoc::CodeObject
     end
   end
 
+  ##
+  # Given an array +names+ of constants, set the visibility of each constant to
+  # +visibility+
+
+  def set_constant_visibility_for(names, visibility)
+    names.each do |name|
+      constant = @constants_hash[name] or next
+      constant.visibility = visibility
+    end
+  end
+
   ##
   # Sorts sections alphabetically (default) or in TomDoc fashion (none,
   # Public, Internal, Deprecated)
@@ -1208,4 +1264,3 @@ class RDoc::Context < RDoc::CodeObject
   autoload :Section, 'rdoc/context/section'
 
 end
-

data/lib/rdoc/cross_reference.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # RDoc::CrossReference is a reusable way to create cross references for names.
 
@@ -18,16 +19,16 @@ class RDoc::CrossReference
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = '([a-z]\w*[!?=]?|%|===|\[\]=?|<<|>>|\+@|-@|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
 
   ##
   # Regular expressions matching text that should potentially have
-  # cross-reference links generated are passed to add_special.  Note that
-  # these expressions are meant to pick up text for which cross-references
+  # cross-reference links generated are passed to add_regexp_handling. Note
+  # that these expressions are meant to pick up text for which cross-references
   # have been suppressed, since the suppression characters are removed by the
   # code that is triggered.
 
-  CROSSREF_REGEXP = /(?:^|\s)
+  CROSSREF_REGEXP = /(?:^|[\s()])
                      (
                       (?:
                        # A::B::C.meth
@@ -75,7 +76,7 @@ class RDoc::CrossReference
   # Version of CROSSREF_REGEXP used when <tt>--hyperlink-all</tt> is specified.
 
   ALL_CROSSREF_REGEXP = /
-                     (?:^|\s)
+                     (?:^|[\s()])
                      (
                       (?:
                        # A::B::C.meth
@@ -126,23 +127,41 @@ class RDoc::CrossReference
 
     if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $2
-      type = '' if type == '.'  # will find either #method or ::method
-      method = "#{type}#{$3}"
+      if '.' == type # will find either #method or ::method
+        method = $3
+      else
+        method = "#{type}#{$3}"
+      end
       container = @context.find_symbol_module($1)
     elsif /^([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $1
-      type = '' if type == '.'
-      method = "#{type}#{$2}"
+      if '.' == type
+        method = $2
+      else
+        method = "#{type}#{$2}"
+      end
       container = @context
     else
+      type = nil
       container = nil
     end
 
     if container then
-      ref = container.find_local_symbol method
-
-      unless ref || RDoc::TopLevel === container then
-        ref = container.find_ancestor_local_symbol method
+      unless RDoc::TopLevel === container then
+        if '.' == type then
+          if 'new' == method then # AnyClassName.new will be class method
+            ref = container.find_local_symbol method
+            ref = container.find_ancestor_local_symbol method unless ref
+          else
+            ref = container.find_local_symbol "::#{method}"
+            ref = container.find_ancestor_local_symbol "::#{method}" unless ref
+            ref = container.find_local_symbol "##{method}" unless ref
+            ref = container.find_ancestor_local_symbol "##{method}" unless ref
+          end
+        else
+          ref = container.find_local_symbol method
+          ref = container.find_ancestor_local_symbol method unless ref
+        end
       end
     end
 
@@ -154,7 +173,7 @@ class RDoc::CrossReference
           end unless ref
 
     # Try a page name
-    ref = @store.page name if not ref and name =~ /^\w+$/
+    ref = @store.page name if not ref and name =~ /^[\w.]+$/
 
     ref = nil if RDoc::Alias === ref # external alias, can't link to it
 

data/lib/rdoc/encoding.rb

@@ -1,4 +1,5 @@
 # coding: US-ASCII
+# frozen_string_literal: true
 
 ##
 # This class is a wrapper around File IO and Encoding that helps RDoc load
@@ -6,6 +7,18 @@
 
 module RDoc::Encoding
 
+  HEADER_REGEXP = /^
+    (?:
+      \A\#!.*\n
+      |
+      ^\#\s+frozen[-_]string[-_]literal[=:].+\n
+      |
+      ^\#[^\n]+\b(?:en)?coding[=:]\s*(?<name>[^\s;]+).*\n
+      |
+      <\?xml[^?]*encoding=(?<quote>["'])(?<name>.*?)\k<quote>.*\n
+    )+
+  /xi # :nodoc:
+
   ##
   # Reads the contents of +filename+ and handles any encoding directives in
   # the file.
@@ -17,50 +30,50 @@ module RDoc::Encoding
   # unknown character in the target encoding will be replaced with '?'
 
   def self.read_file filename, encoding, force_transcode = false
-    content = open filename, "rb" do |f| f.read end
+    content = File.open filename, "rb" do |f| f.read end
     content.gsub!("\r\n", "\n") if RUBY_PLATFORM =~ /mswin|mingw/
 
     utf8 = content.sub!(/\A\xef\xbb\xbf/, '')
 
-    RDoc::Encoding.set_encoding content
-
-    if Object.const_defined? :Encoding then
-      begin
-        encoding ||= Encoding.default_external
-        orig_encoding = content.encoding
-
-        if not orig_encoding.ascii_compatible? then
-          content.encode! encoding
-        elsif utf8 then
-          content.force_encoding Encoding::UTF_8
-          content.encode! encoding
-        else
-          # assume the content is in our output encoding
-          content.force_encoding encoding
-        end
-
-        unless content.valid_encoding? then
-          # revert and try to transcode
-          content.force_encoding orig_encoding
-          content.encode! encoding
-        end
-
-        unless content.valid_encoding? then
-          warn "unable to convert #{filename} to #{encoding}, skipping"
-          content = nil
-        end
-      rescue Encoding::InvalidByteSequenceError,
-             Encoding::UndefinedConversionError => e
-        if force_transcode then
-          content.force_encoding orig_encoding
-          content.encode!(encoding,
-                          :invalid => :replace, :undef => :replace,
-                          :replace => '?')
-          return content
-        else
-          warn "unable to convert #{e.message} for #{filename}, skipping"
-          return nil
-        end
+    enc = RDoc::Encoding.detect_encoding content
+    content = RDoc::Encoding.change_encoding content, enc if enc
+
+    begin
+      encoding ||= Encoding.default_external
+      orig_encoding = content.encoding
+
+      if not orig_encoding.ascii_compatible? then
+        content = content.encode encoding
+      elsif utf8 then
+        content = RDoc::Encoding.change_encoding content, Encoding::UTF_8
+        content = content.encode encoding
+      else
+        # assume the content is in our output encoding
+        content = RDoc::Encoding.change_encoding content, encoding
+      end
+
+      unless content.valid_encoding? then
+        # revert and try to transcode
+        content = RDoc::Encoding.change_encoding content, orig_encoding
+        content = content.encode encoding
+      end
+
+      unless content.valid_encoding? then
+        warn "unable to convert #{filename} to #{encoding}, skipping"
+        content = nil
+      end
+    rescue Encoding::InvalidByteSequenceError,
+           Encoding::UndefinedConversionError => e
+      if force_transcode then
+        content = RDoc::Encoding.change_encoding content, orig_encoding
+        content = content.encode(encoding,
+                                 :invalid => :replace,
+                                 :undef => :replace,
+                                 :replace => '?')
+        return content
+      else
+        warn "unable to convert #{e.message} for #{filename}, skipping"
+        return nil
       end
     end
 
@@ -73,27 +86,51 @@ module RDoc::Encoding
     nil
   end
 
-  ##
-  # Sets the encoding of +string+ based on the magic comment
-
-  def self.set_encoding string
+  def self.remove_frozen_string_literal string
     string =~ /\A(?:#!.*\n)?(.*\n)/
-
     first_line = $1
 
-    name = case first_line
-           when /^<\?xml[^?]*encoding=(["'])(.*?)\1/ then $2
-           when /\b(?:en)?coding[=:]\s*([^\s;]+)/i   then $1
-           else                                           return
-           end
+    if first_line =~ /\A# +frozen[-_]string[-_]literal[=:].+$/i
+      string = string.sub first_line, ''
+    end
+
+    string
+  end
+
+  ##
+  # Detects the encoding of +string+ based on the magic comment
+
+  def self.detect_encoding string
+    result = HEADER_REGEXP.match string
+    name = result && result[:name]
 
-    string.sub! first_line, ''
+    name ? Encoding.find(name) : nil
+  end
+
+  ##
+  # Removes magic comments and shebang
 
-    return unless Object.const_defined? :Encoding
+  def self.remove_magic_comment string
+    string.sub HEADER_REGEXP do |s|
+      s.gsub(/[^\n]/, '')
+    end
+  end
 
-    enc = Encoding.find name
-    string.force_encoding enc if enc
+  ##
+  # Changes encoding based on +encoding+ without converting and returns new
+  # string
+
+  def self.change_encoding text, encoding
+    if text.kind_of? RDoc::Comment
+      text.encode! encoding
+    else
+      # TODO: Remove this condition after Ruby 2.2 EOL
+      if RUBY_VERSION < '2.3.0'
+        text.force_encoding encoding
+      else
+        String.new text, encoding: encoding
+      end
+    end
   end
 
 end
-