Sha256: c321a178f4e847f1cb296c31a05937e1b3003ae1da8f1e70d02889a3effdcdca
Contents?: true
Size: 1.1 KB
Versions: 5
Compression:
Stored size: 1.1 KB
Contents
# 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)
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
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
protected
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
end
Version data entries
5 entries across 5 versions & 2 rubygems