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

Instance Attribute Summary

Attributes inherited from Base

#namespace, #owner, #parser, #scope, #statement, #visibility

Instance Method Summary (collapse)

Methods inherited from Base

handles?, meta_type, method_call, #parse_block

Methods included from Parser::Ruby

#s

Methods inherited from Base

clear_subclasses, #ensure_loaded!, handlers, handles, handles?, #initialize, namespace_only, namespace_only?, #parse_block, process, #push_state, #register, subclasses

Constructor Details

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

Instance Method Details

- (Object) process

Main processing callback



5
6
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
 
# File 'lib/yard/handlers/ruby/alias_handler.rb', line 5

process do
  names = []
  if statement.type == :alias
    names = statement.map {|o| o.jump(:ident, :op, :kw, :const).first }
  elsif statement.call?
    statement.parameters(false).each do |obj|
      case obj.type
      when :symbol_literal
        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, old_meth = names[0].to_sym, 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.visibility = visibility
    o.scope = scope
    o.add_file(parser.file, statement.line)
    o.docstring = statement.comments

    if old_obj
      o.signature = old_obj.signature
      o.source = old_obj.source
    else
      o.signature = "def #{new_meth}" # this is all we know.
    end
  end
  
  namespace.aliases[new_obj] = old_meth
end