Class: YARD::Handlers::Ruby::AttributeHandler

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

Overview

Handles attr_* statements in modules/classes

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

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

Instance Method Summary collapse

Methods inherited from Base

handles?, meta_type, method_call, #parse_block

Methods included from Parser::Ruby

#s

Methods inherited from Base

clear_subclasses, #ensure_loaded!, handlers, handles, handles?, #initialize, namespace_only, namespace_only?, #parse_block, process, #process, #push_state, #register, subclasses

Constructor Details

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

Instance Method Details

#validated_attribute_names(params) ⇒ Array<String> (protected)

Strips out any non-essential arguments from the attr statement.

Parameters:

Returns:

Raises:



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/yard/handlers/ruby/attribute_handler.rb', line 70

def validated_attribute_names(params)
  params.map do |obj|
    case obj.type
    when :symbol_literal
      obj.jump(:ident, :op, :kw, :const).source
    when :string_literal
      obj.jump(:string_content).source
    else
      raise YARD::Parser::UndocumentableError, obj.source
    end
  end
end