Class: YARD::Handlers::Ruby::VisibilityHandler

Inherits:
Base
  • Object
show all
Defined in:
lib/yard/handlers/ruby/visibility_handler.rb

Overview

Handles 'private', 'protected', and 'public' calls.

Constant Summary

Constants included from CodeObjects

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

Instance Attribute Summary

Attributes inherited from Base

#extra_state, #globals, #namespace, #owner, #parser, #scope, #statement, #visibility

Instance Method Summary collapse

Methods inherited from Base

#call_params, #caller_method, handles?, meta_type, method_call, #parse_block

Methods included from Parser::Ruby

#s

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, #push_state, #register, subclasses

Constructor Details

This class inherits a constructor from YARD::Handlers::Base

Instance Method Details

#processvoid

This method returns an undefined value.

Main processing callback



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'lib/yard/handlers/ruby/visibility_handler.rb', line 8

process do
  return if (ident = statement.jump(:ident)) == statement
  case statement.type
  when :var_ref, :vcall
    self.visibility = ident.first
  when :fcall, :command
    statement[1].traverse do |node|
      case node.type
      when :symbol; source = node.first.source
      when :string_content; source = node.source
      else next
      end
      MethodObject.new(namespace, source, scope) {|o| o.visibility = ident.first }
    end
  end
end