lib/yard/handlers/ruby/mixin_handler.rb
# frozen_string_literal: true # Handles the 'include' statement to mixin a module in the instance scope class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base handles method_call(:include) handles method_call(:prepend) namespace_only process do errors = [] statement.parameters(false).reverse.each do |mixin| begin process_mixin(mixin) rescue YARD::Parser::UndocumentableError => err errors << err.message end end unless errors.empty? msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}" raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}" end end protected def process_mixin(mixin) raise YARD::Parser::UndocumentableError unless mixin.ref? raise YARD::Parser::UndocumentableError if mixin.first.type == :ident if mixin.type == :var_ref && mixin[0] == s(:kw, "self") obj = namespace else case obj = Proxy.new(namespace, mixin.source) when ConstantObject # If a constant is included, use its value as the real object obj = Proxy.new(namespace, obj.value, :module) else obj = Proxy.new(namespace, mixin.source, :module) end end rec = recipient(mixin) return if rec.nil? ensure_loaded!(rec) return if rec.mixins(scope).include?(obj) shift = statement.method_name(true) == :include ? :unshift : :push rec.mixins(scope).send(shift, obj) end def recipient(mixin) if statement[0].type == :const_path_ref || statement[0].type == :top_const_ref Proxy.new(namespace, statement[0].source) elsif statement[0].type == :var_ref && statement[0][0] != s(:kw, "self") statement[0][0].type == :const ? Proxy.new(namespace, statement.namespace.source) : nil else namespace end end end