Class: YARD::Handlers::Ruby::MixinHandler
Overview
Handles the 'include' statement to mixin a module in the instance scope
Direct Known Subclasses
Constant Summary
Constants included from CodeObjects
BUILTIN_ALL, BUILTIN_CLASSES, BUILTIN_EXCEPTIONS, BUILTIN_EXCEPTIONS_HASH, BUILTIN_MODULES, CONSTANTMATCH, CSEP, CSEPQ, ISEP, ISEPQ, METHODMATCH, METHODNAMEMATCH, NAMESPACEMATCH, NSEP, NSEPQ
Instance Attribute Summary
Attributes inherited from Base
extra_state, globals, namespace, owner, parser, scope, statement, visibility
Instance Method Summary (collapse)
- - (Object) process_mixin(mixin) protected
Methods inherited from Base
#call_params, #caller_method, handles?, meta_type, method_call, #parse_block
Methods included from Parser::Ruby
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, process, #push_state, #register, subclasses
Constructor Details
This class inherits a constructor from YARD::Handlers::Base
Instance Method Details
- (Object) process_mixin(mixin) (protected)
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 |