Class: YARD::Handlers::Ruby::MethodHandler

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

Overview

Handles a method definition

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::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

Constructor Details

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

Instance Method Details

#format_args ⇒ Object 



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/yard/handlers/ruby/method_handler.rb', line 72

def format_args
  args = statement.parameters
  params = []
  params += args.required_params.map {|a| [a.source, nil] } if args.required_params
  params += args.optional_params.map {|a| [a[0].source, a[1].source] } if args.optional_params
  params << ["*" + args.splat_param.source, nil] if args.splat_param
  params += args.required_end_params.map {|a| [a.source, nil] } if args.required_end_params
  params << ["&" + args.block_param.source, nil] if args.block_param
  params
end

#method_signature ⇒ Object 



83
84
85
86
87
88
89
90
 
# File 'lib/yard/handlers/ruby/method_handler.rb', line 83

def method_signature
  method_name = statement.method_name(true)
  if statement.parameters.any? {|e| e }
    "def #{method_name}(#{statement.parameters.source})"
  else
    "def #{method_name}"
  end
end

#process ⇒ void

This method returns an undefined value.

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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/yard/handlers/ruby/method_handler.rb', line 5

process do
  meth = statement.method_name(true).to_s
  args = format_args
  blk = statement.block
  nobj = namespace
  mscope = scope
  if statement.type == :defs
    if statement[0][0].type == :ident
      raise YARD::Parser::UndocumentableError, 'method defined on object instance'
    end
    nobj = P(namespace, statement[0].source) if statement[0][0].type == :const
    mscope = :class
  end

  nobj = P(namespace, nobj.value) while nobj.type == :constant
  obj = register MethodObject.new(nobj, meth, mscope) do |o|
    o.signature = method_signature
    o.explicit = true
    o.parameters = args
  end

  # delete any aliases referencing old method
  nobj.aliases.each do |aobj, name|
    next unless name == obj.name
    nobj.aliases.delete(aobj)
  end if nobj.is_a?(NamespaceObject)

  if mscope == :instance && meth == "initialize"
    unless obj.has_tag?(:return)
      obj.docstring.add_tag(YARD::Tags::Tag.new(:return,
        "a new instance of #{namespace.name}", namespace.name.to_s))
    end
  elsif mscope == :class && obj.docstring.blank? && %w(inherited included
      extended method_added method_removed method_undefined).include?(meth)
    obj.docstring.add_tag(YARD::Tags::Tag.new(:private, nil))
  elsif meth.to_s =~ /\?$/
    if obj.tag(:return) && (obj.tag(:return).types || []).empty?
      obj.tag(:return).types = ['Boolean']
    elsif obj.tag(:return).nil?
      unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
        obj.docstring.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
      end
    end
  end

  if obj.has_tag?(:option)
    # create the options parameter if its missing
    obj.tags(:option).each do |option|
      expected_param = option.name
      unless obj.tags(:param).find {|x| x.name == expected_param }
        new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
        obj.docstring.add_tag(new_tag)
      end
    end
  end

  if info = obj.attr_info
    if meth.to_s =~ /=$/ # writer
      info[:write] = obj if info[:read]
    else
      info[:read] = obj if info[:write]
    end
  end

  parse_block(blk, :owner => obj) # mainly for yield/exceptions
end