rdoc 6.17.0 → 8.1.0

data/lib/rdoc/code_object/mixin.rb

@@ -1,120 +1,125 @@
 # frozen_string_literal: true
-##
-# A Mixin adds features from a module into another context.  RDoc::Include and
-# RDoc::Extend are both mixins.
+module RDoc
+  ##
+  # A Mixin adds features from a module into another context.  RDoc::Include and
+  # RDoc::Extend are both mixins.
 
-class RDoc::Mixin < RDoc::CodeObject
+  class Mixin < CodeObject
 
-  ##
-  # Name of included module
+    ##
+    # Name of included module
 
-  attr_accessor :name
+    attr_accessor :name
 
-  ##
-  # Creates a new Mixin for +name+ with +comment+
+    ##
+    # Creates a new Mixin for +name+ with +comment+
 
-  def initialize(name, comment)
-    super()
-    @name = name
-    self.comment = comment
-    @module = nil # cache for module if found
-  end
+    def initialize(name, comment)
+      super()
+      @name = name
+      self.comment = comment
+      @module = nil # cache for module if found
+    end
 
-  ##
-  # Mixins are sorted by name
+    ##
+    # Mixins are sorted by name
 
-  def <=>(other)
-    return unless self.class === other
+    def <=>(other)
+      return unless self.class === other
 
-    name <=> other.name
-  end
+      name <=> other.name
+    end
 
-  def ==(other) # :nodoc:
-    self.class === other and @name == other.name
-  end
+    def ==(other) # :nodoc:
+      self.class === other and @name == other.name
+    end
 
-  alias eql? == # :nodoc:
+    alias eql? == # :nodoc:
 
-  ##
-  # Full name based on #module
+    ##
+    # Full name based on #module
 
-  def full_name
-    m = self.module
-    RDoc::ClassModule === m ? m.full_name : @name
-  end
+    def full_name
+      m = self.module
+      ClassModule === m ? m.full_name : @name
+    end
 
-  def hash # :nodoc:
-    [@name, self.module].hash
-  end
+    def hash # :nodoc:
+      [@name, self.module].hash
+    end
 
-  def inspect # :nodoc:
-    "#<%s:0x%x %s.%s %s>" % [
-      self.class,
-      object_id,
-      parent_name, self.class.name.downcase, @name,
-    ]
-  end
+    def inspect # :nodoc:
+      "#<%s:0x%x %s.%s %s>" % [
+        self.class,
+        object_id,
+        parent_name, self.class.name.downcase, @name,
+      ]
+    end
 
-  ##
-  # Attempts to locate the included module object.  Returns the name if not
-  # known.
-  #
-  # The scoping rules of Ruby to resolve the name of an included module are:
-  # - first look into the children of the current context;
-  # - if not found, look into the children of included modules,
-  #   in reverse inclusion order;
-  # - if still not found, go up the hierarchy of names.
-  #
-  # This method has <code>O(n!)</code> behavior when the module calling
-  # include is referencing nonexistent modules.  Avoid calling #module until
-  # after all the files are parsed.  This behavior is due to ruby's constant
-  # lookup behavior.
-  #
-  # As of the beginning of October, 2011, no gem includes nonexistent modules.
-
-  def module
-    return @module if @module
-
-    # search the current context
-    return @name unless parent
-    full_name = parent.child_name(@name)
-    @module = @store.modules_hash[full_name]
-    return @module if @module
-    return @name if @name =~ /^::/
-
-    # search the includes before this one, in reverse order
-    searched = parent.includes.take_while { |i| i != self }.reverse
-    searched.each do |i|
-      inc = i.module
-      next if String === inc
-      full_name = inc.child_name(@name)
-      @module = @store.modules_hash[full_name]
+    ##
+    # Attempts to locate the included module object.  Returns the name if not
+    # known.
+    #
+    # The scoping rules of Ruby to resolve the name of an included module are:
+    # - first look into the children of the current context;
+    # - if not found, look into the children of included modules,
+    #   in reverse inclusion order;
+    # - if still not found, go up the hierarchy of names.
+    #
+    # This method has <code>O(n!)</code> behavior when the module calling
+    # include is referencing nonexistent modules.  Avoid calling #module until
+    # after all the files are parsed.  This behavior is due to ruby's constant
+    # lookup behavior.
+    #
+    # As of the beginning of October, 2011, no gem includes nonexistent modules.
+    #
+    # The Ruby parser passes an already-resolved full-path +name+, so most of this
+    # logic only runs for the C parser, which passes the unresolved local name.
+
+    def module
       return @module if @module
-    end
 
-    # go up the hierarchy of names
-    up = parent.parent
-    while up
-      full_name = up.child_name(@name)
+      # search the current context
+      return @name unless parent
+      full_name = parent.child_name(@name)
       @module = @store.modules_hash[full_name]
       return @module if @module
-      up = up.parent
+      return @name if @name =~ /^::/
+
+      # search the includes before this one, in reverse order
+      searched = parent.includes.take_while { |i| i != self }.reverse
+      searched.each do |i|
+        inc = i.module
+        next if String === inc
+        full_name = inc.child_name(@name)
+        @module = @store.modules_hash[full_name]
+        return @module if @module
+      end
+
+      # go up the hierarchy of names
+      up = parent.parent
+      while up
+        full_name = up.child_name(@name)
+        @module = @store.modules_hash[full_name]
+        return @module if @module
+        up = up.parent
+      end
+
+      @name
     end
 
-    @name
-  end
+    ##
+    # Sets the store for this class or module and its contained code objects.
 
-  ##
-  # Sets the store for this class or module and its contained code objects.
+    def store=(store)
+      super
 
-  def store=(store)
-    super
+      @file = @store.add_file @file.full_name if @file
+    end
 
-    @file = @store.add_file @file.full_name if @file
-  end
+    def to_s # :nodoc:
+      "#{self.class.name.downcase} #@name in: #{parent}"
+    end
 
-  def to_s # :nodoc:
-    "#{self.class.name.downcase} #@name in: #{parent}"
   end
-
 end

data/lib/rdoc/code_object/normal_class.rb

@@ -1,92 +1,91 @@
 # frozen_string_literal: true
-##
-# A normal class, neither singleton nor anonymous
-
-class RDoc::NormalClass < RDoc::ClassModule
-
+module RDoc
   ##
-  # The ancestors of this class including modules.  Unlike Module#ancestors,
-  # this class is not included in the result.  The result will contain both
-  # RDoc::ClassModules and Strings.
-
-  def ancestors
-    if String === superclass then
-      super << superclass
-    elsif superclass then
-      ancestors = super
-      ancestors << superclass
-      ancestors.concat superclass.ancestors
-    else
-      super
+  # A normal class, neither singleton nor anonymous
+
+  class NormalClass < ClassModule
+
+    ##
+    # The ancestors of this class including modules.  Unlike Module#ancestors,
+    # this class is not included in the result.  The result will contain both
+    # RDoc::ClassModules and Strings.
+
+    def ancestors
+      ancestors = included_ancestors
+      super_classes.each do |sclass|
+        ancestors << sclass
+        ancestors.concat sclass.included_ancestors unless String === sclass
+      end
+      ancestors
     end
-  end
 
-  def aref_prefix # :nodoc:
-    'class'
-  end
+    def aref_prefix # :nodoc:
+      'class'
+    end
 
-  ##
-  # The definition of this class, <tt>class MyClassName</tt>
+    ##
+    # The definition of this class, <tt>class MyClassName</tt>
 
-  def definition
-    "class #{full_name}"
-  end
+    def definition
+      "class #{full_name}"
+    end
 
-  def direct_ancestors
-    superclass ? super + [superclass] : super
-  end
+    def direct_ancestors
+      superclass ? super + [superclass] : super
+    end
 
-  def inspect # :nodoc:
-    superclass = @superclass ? " < #{@superclass}" : nil
-    "<%s:0x%x class %s%s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
-      self.class, object_id,
-      full_name, superclass, @includes, @extends, @attributes, @method_list, @aliases
-    ]
-  end
+    def inspect # :nodoc:
+      superclass = @superclass ? " < #{@superclass}" : nil
+      "<%s:0x%x class %s%s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
+        self.class, object_id,
+        full_name, superclass, @includes, @extends, @attributes, @method_list, @aliases
+      ]
+    end
 
-  def to_s # :nodoc:
-    display = "#{self.class.name} #{self.full_name}"
-    if superclass
-      display += ' < ' + (superclass.is_a?(String) ? superclass : superclass.full_name)
+    def to_s # :nodoc:
+      display = "#{self.class.name} #{self.full_name}"
+      if superclass
+        display += ' < ' + (superclass.is_a?(String) ? superclass : superclass.full_name)
+      end
+      display += ' -> ' + is_alias_for.to_s if is_alias_for
+      display
     end
-    display += ' -> ' + is_alias_for.to_s if is_alias_for
-    display
-  end
 
-  def pretty_print(q) # :nodoc:
-    superclass = @superclass ? " < #{@superclass}" : nil
-
-    q.group 2, "[class #{full_name}#{superclass}", "]" do
-      q.breakable
-      q.text "includes:"
-      q.breakable
-      q.seplist @includes do |inc| q.pp inc end
-
-      q.breakable
-      q.text "constants:"
-      q.breakable
-      q.seplist @constants do |const| q.pp const end
-
-      q.breakable
-      q.text "attributes:"
-      q.breakable
-      q.seplist @attributes do |attr| q.pp attr end
-
-      q.breakable
-      q.text "methods:"
-      q.breakable
-      q.seplist @method_list do |meth| q.pp meth end
-
-      q.breakable
-      q.text "aliases:"
-      q.breakable
-      q.seplist @aliases do |aliaz| q.pp aliaz end
-
-      q.breakable
-      q.text "comment:"
-      q.breakable
-      q.pp comment
+    def pretty_print(q) # :nodoc:
+      superclass = @superclass ? " < #{@superclass}" : nil
+
+      q.group 2, "[class #{full_name}#{superclass}", "]" do
+        q.breakable
+        q.text "includes:"
+        q.breakable
+        q.seplist @includes do |inc| q.pp inc end
+
+        q.breakable
+        q.text "constants:"
+        q.breakable
+        q.seplist @constants do |const| q.pp const end
+
+        q.breakable
+        q.text "attributes:"
+        q.breakable
+        q.seplist @attributes do |attr| q.pp attr end
+
+        q.breakable
+        q.text "methods:"
+        q.breakable
+        q.seplist @method_list do |meth| q.pp meth end
+
+        q.breakable
+        q.text "aliases:"
+        q.breakable
+        q.seplist @aliases do |aliaz| q.pp aliaz end
+
+        q.breakable
+        q.text "comment:"
+        q.breakable
+        q.pp comment
+      end
     end
-  end
 
+  end
 end

data/lib/rdoc/code_object/normal_module.rb

@@ -1,73 +1,75 @@
 # frozen_string_literal: true
-##
-# A normal module, like NormalClass
+module RDoc
+  ##
+  # A normal module, like NormalClass
 
-class RDoc::NormalModule < RDoc::ClassModule
+  class NormalModule < ClassModule
 
-  def aref_prefix # :nodoc:
-    'module'
-  end
+    def aref_prefix # :nodoc:
+      'module'
+    end
 
-  def inspect # :nodoc:
-    "#<%s:0x%x module %s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
-      self.class, object_id,
-      full_name, @includes, @extends, @attributes, @method_list, @aliases
-    ]
-  end
+    def inspect # :nodoc:
+      "#<%s:0x%x module %s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
+        self.class, object_id,
+        full_name, @includes, @extends, @attributes, @method_list, @aliases
+      ]
+    end
 
-  ##
-  # The definition of this module, <tt>module MyModuleName</tt>
+    ##
+    # The definition of this module, <tt>module MyModuleName</tt>
 
-  def definition
-    "module #{full_name}"
-  end
+    def definition
+      "module #{full_name}"
+    end
 
-  ##
-  # This is a module, returns true
+    ##
+    # This is a module, returns true
 
-  def module?
-    true
-  end
+    def module?
+      true
+    end
 
-  def pretty_print(q) # :nodoc:
-    q.group 2, "[module #{full_name}:", "]" do
-      q.breakable
-      q.text "includes:"
-      q.breakable
-      q.seplist @includes do |inc| q.pp inc end
-      q.breakable
-
-      q.breakable
-      q.text "constants:"
-      q.breakable
-      q.seplist @constants do |const| q.pp const end
-
-      q.text "attributes:"
-      q.breakable
-      q.seplist @attributes do |attr| q.pp attr end
-      q.breakable
-
-      q.text "methods:"
-      q.breakable
-      q.seplist @method_list do |meth| q.pp meth end
-      q.breakable
-
-      q.text "aliases:"
-      q.breakable
-      q.seplist @aliases do |aliaz| q.pp aliaz end
-      q.breakable
-
-      q.text "comment:"
-      q.breakable
-      q.pp comment
+    def pretty_print(q) # :nodoc:
+      q.group 2, "[module #{full_name}:", "]" do
+        q.breakable
+        q.text "includes:"
+        q.breakable
+        q.seplist @includes do |inc| q.pp inc end
+        q.breakable
+
+        q.breakable
+        q.text "constants:"
+        q.breakable
+        q.seplist @constants do |const| q.pp const end
+
+        q.text "attributes:"
+        q.breakable
+        q.seplist @attributes do |attr| q.pp attr end
+        q.breakable
+
+        q.text "methods:"
+        q.breakable
+        q.seplist @method_list do |meth| q.pp meth end
+        q.breakable
+
+        q.text "aliases:"
+        q.breakable
+        q.seplist @aliases do |aliaz| q.pp aliaz end
+        q.breakable
+
+        q.text "comment:"
+        q.breakable
+        q.pp comment
+      end
     end
-  end
 
-  ##
-  # Modules don't have one, raises NoMethodError
+    ##
+    # Modules don't have one, raises NoMethodError
 
-  def superclass
-    raise NoMethodError, "#{full_name} is a module"
-  end
+    def superclass
+      raise NoMethodError, "#{full_name} is a module"
+    end
 
+  end
 end

data/lib/rdoc/code_object/require.rb

@@ -1,51 +1,35 @@
 # frozen_string_literal: true
-##
-# A file loaded by \#require
-
-class RDoc::Require < RDoc::CodeObject
-
-  ##
-  # Name of the required file
-
-  attr_accessor :name
-
+module RDoc
   ##
-  # Creates a new Require that loads +name+ with +comment+
+  # A file loaded by \#require
 
-  def initialize(name, comment)
-    super()
-    @name = name.gsub(/'|"/, "") #'
-    @top_level = nil
-    self.comment = comment
-  end
+  class Require < CodeObject
 
-  def inspect # :nodoc:
-    "#<%s:0x%x require '%s' in %s>" % [
-      self.class,
-      object_id,
-      @name,
-      @parent ? @parent.base_name : '(unknown)'
-    ]
-  end
+    ##
+    # Name of the required file
 
-  def to_s # :nodoc:
-    "require #{name} in: #{parent}"
-  end
+    attr_accessor :name
 
-  ##
-  # The RDoc::TopLevel corresponding to this require, or +nil+ if not found.
+    ##
+    # Creates a new Require that loads +name+ with +comment+
 
-  def top_level
-    @top_level ||= begin
-      tl = RDoc::TopLevel.all_files_hash[name + '.rb']
+    def initialize(name, comment)
+      super()
+      @name = name.gsub(/'|"/, "")
+      self.comment = comment
+    end
 
-      if tl.nil? and RDoc::TopLevel.all_files.first.full_name =~ %r(^lib/) then
-        # second chance
-        tl = RDoc::TopLevel.all_files_hash['lib/' + name + '.rb']
-      end
+    def inspect # :nodoc:
+      "#<%s:0x%x require '%s' in %s>" % [
+        self.class,
+        object_id,
+        @name,
+        @parent ? @parent.base_name : '(unknown)'
+      ]
+    end
 
-      tl
+    def to_s # :nodoc:
+      "require #{name} in: #{parent}"
     end
   end
-
 end

data/lib/rdoc/code_object/single_class.rb

@@ -1,30 +1,32 @@
 # frozen_string_literal: true
-##
-# A singleton class
+module RDoc
+  ##
+  # A singleton class
 
-class RDoc::SingleClass < RDoc::ClassModule
+  class SingleClass < ClassModule
 
-  ##
-  # Adds the superclass to the included modules.
+    ##
+    # Adds the superclass to the included modules.
 
-  def ancestors
-    superclass ? super + [superclass] : super
-  end
+    def ancestors
+      superclass ? super + [superclass] : super
+    end
 
-  def aref_prefix # :nodoc:
-    'sclass'
-  end
+    def aref_prefix # :nodoc:
+      'sclass'
+    end
 
-  ##
-  # The definition of this singleton class, <tt>class << MyClassName</tt>
+    ##
+    # The definition of this singleton class, <tt>class << MyClassName</tt>
 
-  def definition
-    "class << #{full_name}"
-  end
+    def definition
+      "class << #{full_name}"
+    end
 
-  def pretty_print(q) # :nodoc:
-    q.group 2, "[class << #{full_name}", "]" do
-      next
+    def pretty_print(q) # :nodoc:
+      q.group 2, "[class << #{full_name}", "]" do
+        next
+      end
     end
   end
 end