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

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

Overview

Handles attr_* statements in modules/classes

Constant Summary

Constants included from Parser::Ruby::Legacy::RubyToken

Parser::Ruby::Legacy::RubyToken::EXPR_ARG, Parser::Ruby::Legacy::RubyToken::EXPR_BEG, Parser::Ruby::Legacy::RubyToken::EXPR_CLASS, Parser::Ruby::Legacy::RubyToken::EXPR_DOT, Parser::Ruby::Legacy::RubyToken::EXPR_END, Parser::Ruby::Legacy::RubyToken::EXPR_FNAME, Parser::Ruby::Legacy::RubyToken::EXPR_MID, Parser::Ruby::Legacy::RubyToken::NEWLINE_TOKEN, Parser::Ruby::Legacy::RubyToken::TkReading2Token, Parser::Ruby::Legacy::RubyToken::TkSymbol2Token

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?, #parse_block

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

#process ⇒ void

This method returns an undefined value.

Main processing callback



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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/yard/handlers/ruby/legacy/attribute_handler.rb', line 6

process do
  begin
    attr_type   = statement.tokens.first.text.to_sym
    symbols     = tokval_list statement.tokens[2..-1], :attr, TkTRUE, TkFALSE
    read, write = true, false
  rescue SyntaxError
    raise YARD::Parser::UndocumentableError, attr_type
  end

  # Change read/write based on attr_reader/writer/accessor
  case attr_type
  when :attr
    # In the case of 'attr', the second parameter (if given) isn't a symbol.
    write = symbols.pop if symbols.size == 2
  when :attr_accessor
    write = true
  when :attr_reader
    # change nothing
  when :attr_writer
    read, write = false, true
  end

  # Add all attributes
  symbols.each do |name|
    namespace.attributes[scope][name] = SymbolHash[:read => nil, :write => nil]

    # Show their methods as well
    {:read => name, :write => "#{name}="}.each do |type, meth|
      if (type == :read ? read : write)
        namespace.attributes[scope][name][type] = MethodObject.new(namespace, meth, scope) do |o|
          if type == :write
            o.parameters = [['value', nil]]
            src = "def #{meth}(value)"
            full_src = "#{src}\n  @#{name} = value\nend"
            doc = "Sets the attribute #{name}\n@param value the value to set the attribute #{name} to."
          else
            src = "def #{meth}"
            full_src = "#{src}\n  @#{name}\nend"
            doc = "Returns the value of attribute #{name}"
          end
          o.source ||= full_src
          o.signature ||= src
          o.docstring = statement.comments.to_s.empty? ? doc : statement.comments
          o.visibility = visibility
        end

        # Register the objects explicitly
        register namespace.attributes[scope][name][type]
      elsif obj = namespace.children.find {|o| o.name == meth.to_sym && o.scope == scope }
        # register an existing method as attribute
        namespace.attributes[scope][name][type] = obj
      end
    end
  end
end