rdoc 8.0.0 → 8.1.0

data/lib/rdoc/code_object/constant.rb

@@ -1,221 +1,223 @@
 # frozen_string_literal: true
-##
-# A constant
+module RDoc
+  ##
+  # A constant
 
-class RDoc::Constant < RDoc::CodeObject
+  class Constant < CodeObject
 
-  MARSHAL_VERSION = 0 # :nodoc:
+    MARSHAL_VERSION = 0 # :nodoc:
 
-  ##
-  # Sets the module or class this is constant is an alias for.
+    ##
+    # Sets the module or class this is constant is an alias for.
 
-  attr_writer :is_alias_for
+    attr_writer :is_alias_for
 
-  ##
-  # The constant's name
+    ##
+    # The constant's name
 
-  attr_accessor :name
+    attr_accessor :name
 
-  ##
-  # The constant's value
+    ##
+    # The constant's value
 
-  attr_accessor :value
+    attr_accessor :value
 
-  ##
-  # The constant's visibility
+    ##
+    # The constant's visibility
 
-  attr_accessor :visibility
+    attr_accessor :visibility
 
-  ##
-  # The constant path on the RHS when the RHS is a bare constant reference
-  # (+Foo = Bar+ or +Foo = Bar::Baz+). Captured at parse time so
-  # #resolved_alias_target doesn't have to re-derive it from the textual
-  # #value. nil for other RHS shapes.
+    ##
+    # The constant path on the RHS when the RHS is a bare constant reference
+    # (+Foo = Bar+ or +Foo = Bar::Baz+). Captured at parse time so
+    # #resolved_alias_target doesn't have to re-derive it from the textual
+    # #value. nil for other RHS shapes.
 
-  attr_accessor :is_alias_for_path
+    attr_accessor :is_alias_for_path
 
-  ##
-  # Creates a new constant with +name+, +value+ and +comment+
+    ##
+    # Creates a new constant with +name+, +value+ and +comment+
 
-  def initialize(name, value, comment)
-    super()
+    def initialize(name, value, comment)
+      super()
 
-    @name  = name
-    @value = value
+      @name  = name
+      @value = value
 
-    @is_alias_for      = nil
-    @is_alias_for_path = nil
-    @visibility        = :public
+      @is_alias_for      = nil
+      @is_alias_for_path = nil
+      @visibility        = :public
 
-    self.comment = comment
-  end
+      self.comment = comment
+    end
 
-  ##
-  # Constants are ordered by name
+    ##
+    # Constants are ordered by name
 
-  def <=>(other)
-    return unless self.class === other
+    def <=>(other)
+      return unless self.class === other
 
-    [parent_name, name] <=> [other.parent_name, other.name]
-  end
+      [parent_name, name] <=> [other.parent_name, other.name]
+    end
 
-  ##
-  # Constants are equal when their #parent and #name is the same
+    ##
+    # Constants are equal when their #parent and #name is the same
 
-  def ==(other)
-    self.class == other.class and
-      @parent == other.parent and
-      @name == other.name
-  end
+    def ==(other)
+      self.class == other.class and
+        @parent == other.parent and
+        @name == other.name
+    end
 
-  ##
-  # A constant is documented if it has a comment, or is an alias
-  # for a documented class or module.
-
-  def documented?
-    return true if super
-    return false unless @is_alias_for
-    case @is_alias_for
-    when String then
-      found = @store.find_class_or_module @is_alias_for
-      return false unless found
-      @is_alias_for = found
+    ##
+    # A constant is documented if it has a comment, or is an alias
+    # for a documented class or module.
+
+    def documented?
+      return true if super
+      return false unless @is_alias_for
+      case @is_alias_for
+      when String
+        found = @store.find_class_or_module @is_alias_for
+        return false unless found
+        @is_alias_for = found
+      end
+      @is_alias_for.documented?
     end
-    @is_alias_for.documented?
-  end
 
-  ##
-  # Full constant name including namespace
+    ##
+    # Full constant name including namespace
 
-  def full_name
-    @full_name ||= "#{parent_name}::#{@name}"
-  end
+    def full_name
+      @full_name ||= "#{parent_name}::#{@name}"
+    end
 
-  ##
-  # The module or class this constant is an alias for, when one was recorded
-  # explicitly (by RDoc::Context#add_module_alias, RDoc::ClassModule#update_aliases,
-  # or ri marshal load). Pure accessor; see #resolved_alias_target for the
-  # opportunistic lookup path.
-
-  def is_alias_for
-    case @is_alias_for
-    when String then
-      found = @store.find_class_or_module @is_alias_for
-      @is_alias_for = found if found
-      @is_alias_for
-    else
-      @is_alias_for
+    ##
+    # The module or class this constant is an alias for, when one was recorded
+    # explicitly (by RDoc::Context#add_module_alias, RDoc::ClassModule#update_aliases,
+    # or ri marshal load). Pure accessor; see #resolved_alias_target for the
+    # opportunistic lookup path.
+
+    def is_alias_for
+      case @is_alias_for
+      when String
+        found = @store.find_class_or_module @is_alias_for
+        @is_alias_for = found if found
+        @is_alias_for
+      else
+        @is_alias_for
+      end
     end
-  end
 
-  ##
-  # Returns the class/module this constant *would* alias if #is_alias_for_path
-  # was set by the parser and that path resolves to a known class/module, or
-  # nil. Used to support `Const = RHS` parsed before `class RHS;end` is defined
-  # in another file. Pure lookup; does not mutate state. Honors :nodoc:
-  # (returns nil if document_self is false). Note that module nesting
-  # information is lost, so constant lookup is inaccurate.
-
-  def resolved_alias_target
-    return nil unless document_self
-    return nil unless @is_alias_for_path
-    parent.find_module_named(@is_alias_for_path)
-  end
+    ##
+    # Returns the class/module this constant *would* alias if #is_alias_for_path
+    # was set by the parser and that path resolves to a known class/module, or
+    # nil. Used to support `Const = RHS` parsed before `class RHS;end` is defined
+    # in another file. Pure lookup; does not mutate state. Honors :nodoc:
+    # (returns nil if document_self is false). Note that module nesting
+    # information is lost, so constant lookup is inaccurate.
+
+    def resolved_alias_target
+      return nil unless document_self
+      return nil unless @is_alias_for_path
+      parent.find_module_named(@is_alias_for_path)
+    end
 
-  def inspect # :nodoc:
-    "#<%s:0x%x %s::%s>" % [
-      self.class, object_id,
-      parent_name, @name,
-    ]
-  end
+    def inspect # :nodoc:
+      "#<%s:0x%x %s::%s>" % [
+        self.class, object_id,
+        parent_name, @name,
+      ]
+    end
 
-  ##
-  # Dumps this Constant for use by ri.  See also #marshal_load
-
-  def marshal_dump
-    alias_name = case found = is_alias_for
-                 when RDoc::CodeObject then found.full_name
-                 else                       found
-                 end
-
-    [ MARSHAL_VERSION,
-      @name,
-      full_name,
-      @visibility,
-      alias_name,
-      parse(@comment),
-      @file.relative_name,
-      parent.name,
-      parent.class,
-      section.title,
-    ]
-  end
+    ##
+    # Dumps this Constant for use by ri.  See also #marshal_load
+
+    def marshal_dump
+      alias_name = case found = is_alias_for
+                   when CodeObject then found.full_name
+                   else                       found
+                   end
+
+      [ MARSHAL_VERSION,
+        @name,
+        full_name,
+        @visibility,
+        alias_name,
+        parse(@comment),
+        @file.relative_name,
+        parent.name,
+        parent.class,
+        section.title,
+      ]
+    end
 
-  ##
-  # Loads this Constant from +array+.  For a loaded Constant the following
-  # methods will return cached values:
-  #
-  # * #full_name
-  # * #parent_name
-
-  def marshal_load(array)
-    initialize array[1], nil, RDoc::Comment.from_document(array[5])
-
-    @full_name     = array[2]
-    @visibility    = array[3] || :public
-    @is_alias_for  = array[4]
-    #                      5 handled above
-    #                      6 handled below
-    @parent_name   = array[7]
-    @parent_class  = array[8]
-    @section_title = array[9]
-
-    @file = RDoc::TopLevel.new array[6]
-  end
+    ##
+    # Loads this Constant from +array+.  For a loaded Constant the following
+    # methods will return cached values:
+    #
+    # * #full_name
+    # * #parent_name
+
+    def marshal_load(array)
+      initialize array[1], nil, Comment.from_document(array[5])
+
+      @full_name     = array[2]
+      @visibility    = array[3] || :public
+      @is_alias_for  = array[4]
+      #                      5 handled above
+      #                      6 handled below
+      @parent_name   = array[7]
+      @parent_class  = array[8]
+      @section_title = array[9]
+
+      @file = TopLevel.new array[6]
+    end
 
-  ##
-  # Path to this constant for use with HTML generator output.
+    ##
+    # Path to this constant for use with HTML generator output.
 
-  def path
-    "#{@parent.path}##{@name}"
-  end
+    def path
+      "#{@parent.path}##{@name}"
+    end
 
-  ##
-  # Returns an HTML snippet of the comment for search results.
+    ##
+    # Returns an HTML snippet of the comment for search results.
 
-  def search_snippet
-    return '' if comment.empty?
+    def search_snippet
+      return '' if comment.empty?
 
-    snippet(comment)
-  end
+      snippet(comment)
+    end
 
-  def pretty_print(q) # :nodoc:
-    q.group 2, "[#{self.class.name} #{full_name}", "]" do
-      unless comment.empty? then
-        q.breakable
-        q.text "comment:"
-        q.breakable
-        q.pp @comment
+    def pretty_print(q) # :nodoc:
+      q.group 2, "[#{self.class.name} #{full_name}", "]" do
+        unless comment.empty?
+          q.breakable
+          q.text "comment:"
+          q.breakable
+          q.pp @comment
+        end
       end
     end
-  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:
-    parent_name = parent ? parent.full_name : '(unknown)'
-    if is_alias_for
-      "constant #{parent_name}::#@name -> #{is_alias_for}"
-    else
-      "constant #{parent_name}::#@name"
+    def to_s # :nodoc:
+      parent_name = parent ? parent.full_name : '(unknown)'
+      if is_alias_for
+        "constant #{parent_name}::#@name -> #{is_alias_for}"
+      else
+        "constant #{parent_name}::#@name"
+      end
     end
-  end
 
+  end
 end