Class: YARD::Handlers::Ruby::MixinHandler

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

Overview

Handles the ‘include’ statement to mixin a module in the instance scope

Direct Known Subclasses

ExtendHandler

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 Attribute Summary

Attributes inherited from Base

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

Instance Method Summary collapse

Methods inherited from Base

#call_params, #caller_method, handles?, meta_type, method_call, #parse_block

Methods included from Parser::Ruby

#s

Methods inherited from Base

#call_params, #caller_method, clear_subclasses, #ensure_loaded!, #expand_macro, #find_or_create_macro, handlers, handles, handles?, in_file, #initialize, matches_file?, 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

#process ⇒ void

This method returns an undefined value.

Main processing callback



6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/yard/handlers/ruby/mixin_handler.rb', line 6

process do
  errors = []
  statement.parameters(false).each do |mixin|
    begin
      process_mixin(mixin)
    rescue YARD::Parser::UndocumentableError => err
      errors << err.message
    end
  end
  if errors.size > 0
    msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
    raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}"
  end
end

#process_mixin(mixin) ⇒ Object (protected)

Raises:



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/yard/handlers/ruby/mixin_handler.rb', line 23

def process_mixin(mixin)
  raise YARD::Parser::UndocumentableError unless mixin.ref?
  raise YARD::Parser::UndocumentableError if mixin.first.type == :ident

  case obj = Proxy.new(namespace, mixin.source)
  when Proxy
    obj.type = :module
  when ConstantObject # If a constant is included, use its value as the real object
    obj = Proxy.new(namespace, obj.value)
  end

  namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
end