-
-
Notifications
You must be signed in to change notification settings - Fork 392
/
mixin_handler.rb
36 lines (31 loc) · 1.1 KB
/
mixin_handler.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# 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