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

Inherits:
  Base
  - Object
  - Base
  - Base
  - YARD::Handlers::Ruby::MethodHandler
  show all

Includes:
  Common::MethodHandler

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::CONSTANTSTART, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ

## Instance Method Summary collapse

- #format_args ⇒ Object
- #process ⇒ void

  Main processing callback.

### Methods included from Common::MethodHandler

#add_predicate_return_tag

### Methods included from Parser::Ruby

#s

### Methods included from CodeObjects::NamespaceMapper

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

## Constructor Details

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

## Instance Method Details

### #format_args ⇒ `Object`

    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103

    # File 'lib/yard/handlers/ruby/method_handler.rb', line 69

    def format_args
      return [] unless args = statement.parameters

      params = []

      if args.unnamed_required_params
        params += args.unnamed_required_params.map {|a| [a.source, nil] }
      end

      if args.unnamed_optional_params
        params += args.unnamed_optional_params.map do |a|
          [a[0].source, a[1].source]
        end
      end

      params << ['*' + args.splat_param.source, nil] if args.splat_param

      if args.unnamed_end_params
        params += args.unnamed_end_params.map {|a| [a.source, nil] }
      end

      if args.named_params
        params += args.named_params.map do |a|
          [a[0].source, a[1] ? a[1].source : nil]
        end
      end

      if args.double_splat_param
        params << ['**' + args.double_splat_param.source, nil]
      end

      params << ['&' + args.block_param.source, nil] if args.block_param && !args.args_forward

      params
    end

### #process ⇒ `void`

This method returns an undefined value.

Main processing callback

    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

    # File 'lib/yard/handlers/ruby/method_handler.rb', line 8

    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.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 obj.constructor?
        unless obj.has_tag?(:return)
          obj.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.add_tag(YARD::Tags::Tag.new(:private, nil))
      elsif meth.to_s =~ /\?$/
        add_predicate_return_tag(obj)
      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.add_tag(new_tag)
          end
        end
      end

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

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