class RDoc::Constant

A constant

Attributes

Sets the module or class this is constant is an alias for.

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.

name [RW]

The constant’s name

value [RW]

The constant’s value

visibility [RW]

The constant’s visibility

Public Class Methods

new (name, value, comment)

Creates a new constant with name, value and comment

Calls superclass method RDoc::CodeObject::new

# File lib/rdoc/code_object/constant.rb, line 41
def initialize(name, value, comment)
  super()

  @name  = name
  @value = value

  @is_alias_for      = nil
  @is_alias_for_path = nil
  @visibility        = :public

  self.comment = comment
end

Public Instance Methods

<=> (other)

Constants are ordered by name

# File lib/rdoc/code_object/constant.rb, line 57
def <=>(other)
  return unless self.class === other

  [parent_name, name] <=> [other.parent_name, other.name]
end

== (other)

Constants are equal when their parent and name is the same

# File lib/rdoc/code_object/constant.rb, line 66
def ==(other)
  self.class == other.class and
    @parent == other.parent and
    @name == other.name
end

documented? ()

A constant is documented if it has a comment, or is an alias for a documented class or module.

Calls superclass method RDoc::CodeObject#documented?

# File lib/rdoc/code_object/constant.rb, line 76
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

full_name ()

Full constant name including namespace

# File lib/rdoc/code_object/constant.rb, line 91
def full_name
  @full_name ||= "#{parent_name}::#{@name}"
end

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.

# File lib/rdoc/code_object/constant.rb, line 101
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

marshal_dump ()

Dumps this Constant for use by ri. See also marshal_load

# File lib/rdoc/code_object/constant.rb, line 136
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

marshal_load (array)

Loads this Constant from array. For a loaded Constant the following methods will return cached values:

# File lib/rdoc/code_object/constant.rb, line 162
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 ()

Path to this constant for use with HTML generator output.

# File lib/rdoc/code_object/constant.rb, line 180
def path
  "#{@parent.path}##{@name}"
end

resolved_alias_target ()

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.

# File lib/rdoc/code_object/constant.rb, line 120
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

search_snippet ()

Returns an HTML snippet of the comment for search results.

# File lib/rdoc/code_object/constant.rb, line 187
def search_snippet
  return '' if comment.empty?

  snippet(comment)
end

store= (store)

Sets the store for this class or module and its contained code objects.

Calls superclass method RDoc::CodeObject#store=

# File lib/rdoc/code_object/constant.rb, line 207
def store=(store)
  super

  @file = @store.add_file @file.full_name if @file
end