Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://ruby.github.io/rdoc/RDoc/Context.html below:

class RDoc::Context - rdoc Documentation

1. RDoc::
2. Context

A Context is something that can hold modules, classes, methods, attributes, aliases, requires, and includes. Classes, modules, and files are all Contexts.

TYPES

Types of methods

Block params to be used in the next MethodAttr parsed under this context

Hash of registered constants.

Current visibility of this line

Sets the current documentation section of documentation

Modules this context is extended with

Aliases that could not be resolved.

Files this context is found in

Modules this context includes

Methods defined in this context

Hash of registered methods. Attributes are also registered here, twice if they are RW.

Name of this class excluding namespace. See also full_name

Params to be used in the next MethodAttr parsed under this context

Files this context requires

Use this section for the next method, attribute or constant added.

Hash old_name => [aliases], for aliases that haven’t (yet) been resolved to a method/attribute. (Not to be confused with the aliases of the context.)

Current visibility of this context

def initialize
  super

  @in_files = []

  @name    ||= "unknown"
  @parent  = nil
  @visibility = :public

  @current_section = Section.new self, nil, nil
  @sections = { nil => @current_section }
  @temporary_section = nil

  @classes = {}
  @modules = {}

  initialize_methods_etc
end

Creates an unnamed empty context with public current visibility

def <=>(other)
  return nil unless RDoc::CodeObject === other

  full_name <=> other.full_name
end

Contexts are sorted by full_name

def add(klass, name, comment)
  if RDoc::Extend == klass then
    ext = RDoc::Extend.new name, comment
    add_extend ext
  elsif RDoc::Include == klass then
    incl = RDoc::Include.new name, comment
    add_include incl
  else
    raise NotImplementedError, "adding a #{klass} is not implemented"
  end
end

Adds an item of type klass with the given name and comment to the context.

Currently only RDoc::Extend and RDoc::Include are supported.

def add_alias(an_alias)
  return an_alias unless @document_self

  method_attr = find_method(an_alias.old_name, an_alias.singleton) ||
                find_attribute(an_alias.old_name, an_alias.singleton)

  if method_attr then
    method_attr.add_alias an_alias, self
  else
    add_to @external_aliases, an_alias
    unmatched_alias_list =
      @unmatched_alias_lists[an_alias.pretty_old_name] ||= []
    unmatched_alias_list.push an_alias
  end

  an_alias
end

Adds an_alias that is automatically resolved

def add_attribute(attribute)
  return attribute unless @document_self

  
  
  register = false

  key = nil

  if attribute.rw.index 'R' then
    key = attribute.pretty_name
    known = @methods_hash[key]

    if known then
      known.comment = attribute.comment if known.comment.empty?
    elsif registered = @methods_hash[attribute.pretty_name + '='] and
          RDoc::Attr === registered then
      registered.rw = 'RW'
    else
      @methods_hash[key] = attribute
      register = true
    end
  end

  if attribute.rw.index 'W' then
    key = attribute.pretty_name + '='
    known = @methods_hash[key]

    if known then
      known.comment = attribute.comment if known.comment.empty?
    elsif registered = @methods_hash[attribute.pretty_name] and
          RDoc::Attr === registered then
      registered.rw = 'RW'
    else
      @methods_hash[key] = attribute
      register = true
    end
  end

  if register then
    attribute.visibility = @visibility
    add_to @attributes, attribute
    resolve_aliases attribute
  end

  attribute
end

Adds attribute if not already there. If it is (as method(s) or attribute), updates the comment if it was empty.

The attribute is registered only if it defines a new method. For instance, attr_reader :foo will not be registered if method foo exists, but attr_accessor :foo will be registered if method foo exists, but foo= does not.

def add_class(class_type, given_name, superclass = '::Object')
  
  
  
  
  
  
  

  
  if given_name =~ /^:+(\w+)$/ then
    full_name = $1
    enclosing = top_level
    name = full_name.split(/:+/).last
  else
    full_name = child_name given_name

    if full_name =~ /^(.+)::(\w+)$/ then
      name = $2
      ename = $1
      enclosing = @store.classes_hash[ename] || @store.modules_hash[ename]
      
      unless enclosing then
        
        enclosing = @store.classes_hash[given_name] ||
                    @store.modules_hash[given_name]
        return enclosing if enclosing
        
        names = ename.split('::')
        enclosing = self
        names.each do |n|
          enclosing = enclosing.classes_hash[n] ||
                      enclosing.modules_hash[n] ||
                      enclosing.add_module(RDoc::NormalModule, n)
        end
      end
    else
      name = full_name
      enclosing = self
    end
  end

  
  if full_name == 'BasicObject' then
    superclass = nil
  elsif full_name == 'Object' then
    superclass = '::BasicObject'
  end

  
  if superclass then
    if superclass =~ /^:+/ then
      superclass = $' 
    else
      if superclass =~ /^(\w+):+(.+)$/ then
        suffix = $2
        mod = find_module_named($1)
        superclass = mod.full_name + '::' + suffix if mod
      else
        mod = find_module_named(superclass)
        superclass = mod.full_name if mod
      end
    end

    
    mod = @store.modules_hash.delete superclass

    upgrade_to_class mod, RDoc::NormalClass, mod.parent if mod

    
    superclass = nil if superclass == full_name
  end

  klass = @store.classes_hash[full_name]

  if klass then
    
    enclosing.classes_hash[name] = klass

    
    if superclass then
      existing = klass.superclass
      existing = existing.full_name unless existing.is_a?(String) if existing
      if existing.nil? ||
         (existing == 'Object' && superclass != 'Object') then
        klass.superclass = superclass
      end
    end
  else
    
    mod = @store.modules_hash.delete full_name

    if mod then
      klass = upgrade_to_class mod, RDoc::NormalClass, enclosing

      klass.superclass = superclass unless superclass.nil?
    else
      klass = class_type.new name, superclass

      enclosing.add_class_or_module(klass, enclosing.classes_hash,
                                    @store.classes_hash)
    end
  end

  klass.parent = self

  klass
end

Adds a class named given_name with superclass.

Both given_name and superclass may contain ‘::’, and are interpreted relative to the self context. This allows handling correctly examples like these:

class RDoc::Gauntlet < Gauntlet
module Mod
  class Object   # implies < ::Object
  class SubObject < Object  # this is _not_ ::Object

Given class Container::Item RDoc assumes Container is a module unless it later sees class Container. add_class automatically upgrades given_name to a class in this case.

def add_class_or_module(mod, self_hash, all_hash)
  mod.section = current_section 
                                
  mod.parent = self
  mod.full_name = nil
  mod.store = @store

  unless @done_documenting then
    self_hash[mod.name] = mod
    
    
    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
end

Adds the class or module mod to the modules or classes Hash self_hash, and to all_hash (either TopLevel::modules_hash or TopLevel::classes_hash), unless done_documenting is true. Sets the parent of mod to self, and its section to current_section. Returns mod.

def add_constant(constant)
  return constant unless @document_self

  
  
  known = @constants_hash[constant.name]

  if known then
    known.comment = constant.comment if known.comment.empty?

    known.value = constant.value if
      known.value.nil? or known.value.strip.empty?

    known.is_alias_for ||= constant.is_alias_for
  else
    @constants_hash[constant.name] = constant
    add_to @constants, constant
  end

  constant
end

Adds constant if not already there. If it is, updates the comment, value and/or is_alias_for of the known constant if they were empty/nil.

def add_extend(ext)
  add_to @extends, ext

  ext
end

Adds extension module ext which should be an RDoc::Extend

def add_include(include)
  add_to @includes, include

  include
end

Adds included module include which should be an RDoc::Include

def add_method(method)
  return method unless @document_self

  
  key = method.pretty_name
  known = @methods_hash[key]

  if known then
    if @store then 
      known.comment = method.comment if known.comment.empty?
      previously = ", previously in #{known.file}" unless
        method.file == known.file
      @store.options.warn \
        "Duplicate method #{known.full_name} in #{method.file}#{previously}"
    end
  else
    @methods_hash[key] = method
    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

  method
end

Adds method if not already there. If it is (as method or attribute), updates the comment if it was empty.

def add_module(class_type, name)
  mod = @classes[name] || @modules[name]
  return mod if mod

  full_name = child_name name
  mod = @store.modules_hash[full_name] || class_type.new(name)

  add_class_or_module mod, @modules, @store.modules_hash
end

Adds a module named name. If RDoc already knows name is a class then that class is returned instead. See also add_class.

def add_module_alias(from, from_name, to, file)
  return from if @done_documenting

  to_full_name = child_name to.name

  
  
  
  
  return from if @store.find_class_or_module to_full_name

  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 new_to.module? then
    @store.modules_hash[to_full_name] = new_to
    @modules[to.name] = new_to
  else
    @store.classes_hash[to_full_name] = new_to
    @classes[to.name] = new_to
  end

  
  
  const = RDoc::Constant.new to.name, nil, new_to.comment
  const.record_location file
  const.is_alias_for = from
  add_constant const

  new_to
end

Adds an alias from from (a class or module) to name which was defined in file.

def add_module_by_normal_module(mod)
  add_class_or_module mod, @modules, @store.modules_hash
end

Adds a module by RDoc::NormalModule instance. See also add_module.

def add_require(require)
  return require unless @document_self

  if RDoc::TopLevel === self then
    add_to @requires, require
  else
    parent.add_require require
  end
end

Adds require to this context’s top level

def add_section(title, comment = nil)
  if section = @sections[title] then
    section.add_comment comment if comment
  else
    section = Section.new self, title, comment
    @sections[title] = section
  end

  section
end

Returns a section with title, creating it if it doesn’t already exist. comment will be appended to the section’s comment.

A section with a title of nil will return the default section.

See also RDoc::Context::Section

def add_to(array, thing)
  array << thing if @document_self

  thing.parent  = self
  thing.store   = @store if @store
  thing.section = current_section
end

Adds thing to the collection array

def any_content(includes = true)
  @any_content ||= !(
    @comment.empty? &&
    @method_list.empty? &&
    @attributes.empty? &&
    @aliases.empty? &&
    @external_aliases.empty? &&
    @requires.empty? &&
    @constants.empty?
  )
  @any_content || (includes && !(@includes + @extends).empty? )
end

Is there any content?

This means any of: comment, aliases, methods, attributes, external aliases, require, constant.

Includes and extends are also checked unless includes == false.

def child_name(name)
  if name =~ /^:+/
    $'  
  elsif RDoc::TopLevel === self then
    name
  else
    "#{self.full_name}::#{name}"
  end
end

Creates the full name for a child with name

def class_attributes
  @class_attributes ||= attributes.select { |a| a.singleton }
end

Class attributes

def class_method_list
  @class_method_list ||= method_list.select { |a| a.singleton }
end

Class methods

def classes
  @classes.values
end

Array of classes in this context

def classes_and_modules
  classes + modules
end

All classes and modules in this namespace

def classes_hash
  @classes
end

Hash of classes keyed by class name

def current_section
  if section = @temporary_section then
    @temporary_section = nil
  else
    section = @current_section
  end

  section
end

The current documentation section that new items will be added to. If temporary_section is available it will be used.

def each_classmodule(&block) 
  classes_and_modules.sort.each(&block)
end

Iterator for classes and modules

def each_method 
  return enum_for __method__ unless block_given?

  @method_list.sort.each { |m| yield m }
end

Iterator for methods

def each_section 
  return enum_for __method__ unless block_given?

  constants  = @constants.group_by  do |constant|  constant.section end
  attributes = @attributes.group_by do |attribute| attribute.section end

  constants.default  = []
  attributes.default = []

  sort_sections.each do |section|
    yield section, constants[section].select(&:display?).sort, attributes[section].select(&:display?).sort
  end
end

Iterator for each section’s contents sorted by title. The section, the section’s constants and the sections attributes are yielded. The constants and attributes collections are sorted.

To retrieve methods in a section use methods_by_type with the optional section parameter.

NOTE: Do not edit collections yielded by this method

def find_attribute(name, singleton)
  name = $1 if name =~ /^(.*)=$/
  @attributes.find { |a| a.name == name && a.singleton == singleton }
end

Finds an attribute name with singleton value singleton.

def find_attribute_named(name)
  case name
  when /\A#/ then
    find_attribute name[1..-1], false
  when /\A::/ then
    find_attribute name[2..-1], true
  else
    @attributes.find { |a| a.name == name }
  end
end

Finds an attribute with name in this context

def find_class_method_named(name)
  @method_list.find { |meth| meth.singleton && meth.name == name }
end

Finds a class method with name in this context

def find_constant_named(name)
  @constants.find do |m|
    m.name == name || m.full_name == name
  end
end

Finds a constant with name in this context

def find_enclosing_module_named(name)
  parent && parent.find_module_named(name)
end

Find a module at a higher scope

def find_external_alias(name, singleton)
  @external_aliases.find { |m| m.name == name && m.singleton == singleton }
end

Finds an external alias name with singleton value singleton.

def find_external_alias_named(name)
  case name
  when /\A#/ then
    find_external_alias name[1..-1], false
  when /\A::/ then
    find_external_alias name[2..-1], true
  else
    @external_aliases.find { |a| a.name == name }
  end
end

Finds an external alias with name in this context

def find_instance_method_named(name)
  @method_list.find { |meth| !meth.singleton && meth.name == name }
end

Finds an instance method with name in this context

def find_local_symbol(symbol)
  find_method_named(symbol) or
  find_constant_named(symbol) or
  find_attribute_named(symbol) or
  find_external_alias_named(symbol) or
  find_module_named(symbol) or
  @store.find_file_named(symbol)
end

Finds a method, constant, attribute, external alias, module or file named symbol in this context.

def find_method(name, singleton)
  @method_list.find { |m|
    if m.singleton
      m.name == name && m.singleton == singleton
    else
      m.name == name && !m.singleton && !singleton
    end
  }
end

Finds a method named name with singleton value singleton.

def find_method_named(name)
  case name
  when /\A#/ then
    find_method name[1..-1], false
  when /\A::/ then
    find_method name[2..-1], true
  else
    @method_list.find { |meth| meth.name == name }
  end
end

Finds a instance or module method with name in this context

def find_module_named(name)
  res = @modules[name] || @classes[name]
  return res if res
  return self if self.name == name
  find_enclosing_module_named name
end

Find a module with name using ruby’s scoping rules

def find_symbol(symbol)
  find_symbol_module(symbol) || find_local_symbol(symbol)
end

Look up symbol, first as a module, then as a local symbol.

def find_symbol_module(symbol)
  result = nil

  
  case symbol
  when /^::/ then
    result = @store.find_class_or_module symbol
  when /^(\w+):+(.+)$/
    suffix = $2
    top = $1
    searched = self
    while searched do
      mod = searched.find_module_named(top)
      break unless mod
      result = @store.find_class_or_module "#{mod.full_name}::#{suffix}"
      break if result || searched.is_a?(RDoc::TopLevel)
      searched = searched.parent
    end
  else
    searched = self
    while searched do
      result = searched.find_module_named(symbol)
      break if result || searched.is_a?(RDoc::TopLevel)
      searched = searched.parent
    end
  end

  result
end

Look up a module named symbol.

def full_name
  '(unknown)'
end

The full name for this context. This method is overridden by subclasses.

def fully_documented?
  documented? and
    attributes.all? { |a| a.documented? } and
    method_list.all? { |m| m.documented? } and
    constants.all? { |c| c.documented? }
end

Does this context and its methods and constants all have documentation?

(Yes, fully documented doesn’t mean everything.)

def http_url
  path = name_for_path
  path = path.gsub(/<<\s*(\w*)/, 'from-\1') if path =~ /<</
  path = path.split('::')

  File.join(*path.compact) + '.html'
end

URL for this with a prefix

def initialize_methods_etc
  @method_list = []
  @attributes  = []
  @aliases     = []
  @requires    = []
  @includes    = []
  @extends     = []
  @constants   = []
  @external_aliases = []
  @current_line_visibility = nil

  
  
  @unmatched_alias_lists = {}

  @methods_hash   = {}
  @constants_hash = {}

  @params = nil

  @store ||= nil
end

Sets the defaults for methods and so-forth

def instance_attributes
  @instance_attributes ||= attributes.reject { |a| a.singleton }
end

Instance attributes

def instance_method_list
  warn '#instance_method_list is obsoleted, please use #instance_methods'
  @instance_methods ||= method_list.reject { |a| a.singleton }
end

Instance methods

def instance_methods
  @instance_methods ||= method_list.reject { |a| a.singleton }
end

Instance methods

def methods_by_type(section = nil)
  methods = {}

  TYPES.each do |type|
    visibilities = {}
    RDoc::VISIBILITIES.each do |vis|
      visibilities[vis] = []
    end

    methods[type] = visibilities
  end

  each_method do |method|
    next if section and not method.section == section
    methods[method.type][method.visibility] << method
  end

  methods
end

Breaks method_list into a nested hash by type ('class' or 'instance') and visibility (:public, :protected, :private).

If section is provided only methods in that RDoc::Context::Section will be returned.

def methods_matching(methods, singleton = false, &block)
  (@method_list + @attributes).each do |m|
    yield m if methods.include?(m.name) and m.singleton == singleton
  end

  each_ancestor do |parent|
    parent.methods_matching(methods, singleton, &block)
  end
end

Yields AnyMethod and Attr entries matching the list of names in methods.

def modules
  @modules.values
end

Array of modules in this context

def modules_hash
  @modules
end

Hash of modules keyed by module name

def name_for_path
  full_name
end

Name to use to generate the url. full_name by default.

def ongoing_visibility=(visibility)
  @visibility = visibility
end

Changes the visibility for new methods to visibility

def record_location(top_level)
  @in_files << top_level unless @in_files.include?(top_level)
end

Record top_level as a file self is in.

def remove_from_documentation?
  @remove_from_documentation ||=
    @received_nodoc &&
    !any_content(false) &&
    @includes.all? { |i| !i.module.is_a?(String) && i.module.remove_from_documentation? } &&
    classes_and_modules.all? { |cm| cm.remove_from_documentation? }
end

Should we remove this context from the documentation?

The answer is yes if:

• received_nodoc is true

• any_content is false (not counting includes)

• All includes are modules (not a string), and their module has remove_from_documentation? == true

• All classes and modules have remove_from_documentation? == true

def remove_invisible(min_visibility)
  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

Removes methods and attributes with a visibility less than min_visibility.

def resolve_aliases(added)
  
  key = added.pretty_name
  unmatched_alias_list = @unmatched_alias_lists[key]
  return unless unmatched_alias_list
  unmatched_alias_list.each do |unmatched_alias|
    added.add_alias unmatched_alias, self
    @external_aliases.delete unmatched_alias
  end
  @unmatched_alias_lists.delete key
end

Tries to resolve unmatched aliases when a method or attribute has just been added.

def section_contents
  used_sections = {}

  each_method do |method|
    next unless method.display?

    used_sections[method.section] = true
  end

  
  sections = sort_sections.select do |section|
    used_sections[section]
  end

  
  return [] if
    sections.length == 1 and not sections.first.title

  sections
end

Returns RDoc::Context::Section objects referenced in this context for use in a table of contents.

def sections
  @sections.values
end

Sections in this context

def set_constant_visibility_for(names, visibility)
  names.each do |name|
    constant = @constants_hash[name] or next
    constant.visibility = visibility
  end
end

Given an array names of constants, set the visibility of each constant to visibility

def set_current_section(title, comment)
  @current_section = add_section title, comment
end

Sets the current section to a section with title. See also add_section

def set_visibility_for(methods, visibility, singleton = false)
  methods_matching methods, singleton do |m|
    m.visibility = visibility
  end
end

Given an array methods of method names, set the visibility of each to visibility

def sort_sections
  titles = @sections.map { |title, _| title }

  if titles.length > 1 and
     TOMDOC_TITLES_SORT ==
       (titles | TOMDOC_TITLES).sort_by { |title| title.to_s } then
    @sections.values_at(*TOMDOC_TITLES).compact
  else
    @sections.sort_by { |title, _|
      title.to_s
    }.map { |_, section|
      section
    }
  end
end

Sorts sections alphabetically (default) or in TomDoc fashion (none, Public, Internal, Deprecated)

def top_level
  return @top_level if defined? @top_level
  @top_level = self
  @top_level = @top_level.parent until RDoc::TopLevel === @top_level
  @top_level
end

Return the TopLevel that owns us

def upgrade_to_class(mod, class_type, enclosing)
  enclosing.modules_hash.delete mod.name

  klass = RDoc::ClassModule.from_module class_type, mod
  klass.store = @store

  
  @store.classes_hash[mod.full_name] = klass
  enclosing.classes_hash[mod.name]   = klass

  klass
end

Upgrades NormalModule mod in enclosing to a class_type

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4