123456789_123456789_123456789_123456789_123456789_

Class: YARD::Handlers::Ruby::PrivateConstantHandler

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Base, ::YARD::Parser::Ruby, ::YARD::Handlers::Base
Instance Chain:
self, Base, ::YARD::Parser::Ruby, ::YARD::Handlers::Base, ::YARD::Parser, ::YARD::CodeObjects
Inherits: YARD::Handlers::Ruby::Base
Defined in: lib/yard/handlers/ruby/private_constant_handler.rb

Overview

Sets visibility of a constant (class, module, const)

Constant Summary

::YARD::CodeObjects - Included

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

Class Attribute Summary

::YARD::Handlers::Base - Inherited

.namespace_only

Declares that the handler should only be called when inside a ::YARD::CodeObjects::NamespaceObject, not a method body.
.namespace_only?

Class Method Summary

Base - Inherited

.handles?,
.meta_type

Matcher for handling a node with a specific meta-type.
.method_call

Matcher for handling any type of method call.

::YARD::Parser::Ruby - Extended

s

Builds and s-expression by creating AstNode objects with the type provided by the first argument.

::YARD::Handlers::Base - Inherited

.clear_subclasses

Clear all registered subclasses.
.handlers,
.handles

Declares the statement type which will be processed by this handler.
.handles?

This class is implemented by Base and Legacy::Base.
.in_file

Declares that a handler should only be called when inside a filename by its basename or a regex match for the full path.
.inherited, .matches_file?, .new,
.process

Generates a #process method, equivalent to +def process; ...
.subclasses

Returns all registered handler subclasses.

Instance Attribute Summary

::YARD::Handlers::Base - Inherited

#extra_state

Share state across different handlers inside of a file.
#globals

::YARD::Handlers can share state for the entire post processing stage through this attribute.
#namespace, #namespace=, #owner, #owner=, #parser, #scope, #scope=, #statement, #visibility, #visibility=

Instance Method Summary

Base - Inherited

#call_params, #caller_method, #parse_block

::YARD::Parser::Ruby - Included

#s

Builds and s-expression by creating AstNode objects with the type provided by the first argument.

::YARD::Handlers::Base - Inherited

#abort!

Aborts a handler by raising ::YARD::Handlers::HandlerAborted.
#call_params, #caller_method,
#ensure_loaded!

Ensures that a specific object has been parsed and loaded into the registry.
#parse_block

Parses the semantic "block" contained in the statement node.
#process

The main handler method called by the parser on a statement that matches the handles declaration.
#push_state

Executes a given block with specific state values for #owner, #namespace and #scope.
#register

Do some post processing on a list of code objects.
#register_docstring

Registers any docstring found for the object and expands macros.
#register_dynamic

Registers the object as dynamic if the object is defined inside a method or block (owner != namespace).
#register_ensure_loaded

Ensures that the object's namespace is loaded before attaching it to the namespace.
#register_file_info

Registers the file/line of the declaration with the object.
#register_group

Registers the object as being inside a specific group.
#register_module_function

Registers the same method information on the module function, if the object was defined as a module function.
#register_source,
#register_transitive_tags

Registers any transitive tags from the namespace on the object.
#register_visibility

Registers visibility on a method object.

Constructor Details

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

Instance Method Details

#privatize_constant(node) (private)

[ GitHub ] 

  


# File 'lib/yard/handlers/ruby/private_constant_handler.rb', line 28



def privatize_constant(node)
  if node.literal? || (node.type == :var_ref && node[0].type == :const)
    node = node.jump(:tstring_content, :const)
    const = Proxy.new(namespace, node[0])
    ensure_loaded!(const)
    const.visibility = :private
  else
    raise UndocumentableError, "invalid argument to private_constant: #{node.source}"
  end
rescue NamespaceMissingError
  raise UndocumentableError, "private visibility set on unrecognized constant: #{node[0]}"
end


  








  

    #process  ⇒ void 
  



  

    
This method returns an undefined value.
Main processing callback


  





  


  [ GitHub ]


  

  


# File 'lib/yard/handlers/ruby/private_constant_handler.rb', line 10



process do
  errors = []
  statement.parameters.each do |param|
    next unless AstNode === param
    begin
      privatize_constant(param)
    rescue UndocumentableError => err
      errors << err.message
    end
  end
  unless errors.empty?
    msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
    raise UndocumentableError, "private constant#{msg} for #{namespace.path}"
  end
end