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

Inherits:

Base

• Object
• YARD::Handlers::Base
• Base
• YARD::Handlers::Ruby::MixinHandler

show all

Defined in:

lib/yard/handlers/ruby/mixin_handler.rb

Constant Summary

Constants included from YARD::CodeObjects

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

Instance Method Summary

• - (Object) process
• - (Object) process_mixin(mixin) protected

Methods inherited from Base

handles?, meta_type, method_call, #parse_block

Methods included from YARD::Parser::Ruby

#s

Methods inherited from YARD::Handlers::Base

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

5
6
7

# File 'lib/yard/handlers/ruby/mixin_handler.rb', line 5

def process
  statement.parameters(false).each {|mixin| process_mixin(mixin) }
end

11
12
13
14
15
16
17
18
19
20
21
22
23
24

# File 'lib/yard/handlers/ruby/mixin_handler.rb', line 11

def process_mixin(mixin)
  unless mixin.ref?
    raise YARD::Parser::UndocumentableError, "mixin #{mixin.source} for class #{namespace.path}"
  end
  
  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) << obj
end