Class: YARD::Handlers::Ruby::AliasHandler

Inherits:
Base
  • Object
show all
Defined in:
lib/yard/handlers/ruby/alias_handler.rb

Overview

Handles alias and alias_method calls

Constant Summary

Constants included from CodeObjects

CodeObjects::BUILTIN_ALL, CodeObjects::BUILTIN_CLASSES, CodeObjects::BUILTIN_EXCEPTIONS, CodeObjects::BUILTIN_EXCEPTIONS_HASH, CodeObjects::BUILTIN_MODULES, CodeObjects::CONSTANTMATCH, CodeObjects::CONSTANTSTART, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ

Instance Method Summary collapse

Methods included from Parser::Ruby

#s

Methods included from CodeObjects::NamespaceMapper

#clear_separators, #default_separator, #register_separator, #separators, #separators_for_type, #separators_match, #types_for_separator

Constructor Details

This class inherits a constructor from YARD::Handlers::Base

Instance Method Details

#processvoid

This method returns an undefined value.

Main processing callback


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/yard/handlers/ruby/alias_handler.rb', line 7

process do
  names = []
  if statement.type == :alias
    names = statement.map {|o| o.jump(:ident, :op, :kw, :const).source }
  elsif statement.call?
    statement.parameters(false).each do |obj|
      case obj.type
      when :symbol_literal, :dyna_symbol
        names << obj.jump(:ident, :op, :kw, :const).source
      when :string_literal
        names << obj.jump(:string_content).source
      end
    end
  end
  raise YARD::Parser::UndocumentableError, "alias/alias_method" if names.size != 2

  new_meth = names[0].to_sym
  old_meth = names[1].to_sym
  old_obj = namespace.child(:name => old_meth, :scope => scope)
  new_obj = register MethodObject.new(namespace, new_meth, scope) do |o|
    o.add_file(parser.file, statement.line)
  end
  namespace.aliases[new_obj] = old_meth

  if old_obj
    new_obj.signature = old_obj.signature
    new_obj.source = old_obj.source
    comments = [old_obj.docstring.to_raw, statement.comments].join("\n")
    doc = YARD::Docstring.parser.parse(comments, new_obj, self)
    new_obj.docstring = doc.to_docstring
    new_obj.docstring.line_range = statement.comments_range
    new_obj.docstring.hash_flag = statement.comments_hash_flag
    new_obj.docstring.object = new_obj
  else
    new_obj.signature = "def #{new_meth}" # this is all we know.
  end
end