Class: Docscribe::InlineRewriter::Collector::AttrInsertion

Inherits:

Struct

• Object
• Struct
• Docscribe::InlineRewriter::Collector::AttrInsertion

Defined in:

lib/docscribe/inline_rewriter/collector.rb

Overview

One attribute macro call that Docscribe intends to document.

This corresponds to an ‘attr_reader`, `attr_writer`, or `attr_accessor` call in Ruby source.

Instance Attribute Summary

• #access ⇒ Symbol

  :r, :w, or :rw (reader/writer/accessor).

• #container ⇒ String

  Container name, e.g.

• #names ⇒ Array<Symbol>

  Attribute names.

• #node ⇒ Parser::AST::Node

  The ‘:send` node (e.g. `attr_reader :name`).

• #scope ⇒ Symbol

  :instance or :class (class when inside ‘class << self`).

• #visibility ⇒ Symbol

  :public, :protected, or :private.

Instance Attribute Details

#access ⇒ Symbol

Returns :r, :w, or :rw (reader/writer/accessor).

Returns:

• (Symbol) —

  :r, :w, or :rw (reader/writer/accessor)

# File 'lib/docscribe/inline_rewriter/collector.rb', line 57

AttrInsertion = Struct.new(:node, :scope, :visibility, :container, :access, :names)

#container ⇒ String

Returns container name, e.g. “MyModule::MyClass”.

Returns:

• (String) —

  container name, e.g. “MyModule::MyClass”

# File 'lib/docscribe/inline_rewriter/collector.rb', line 57

AttrInsertion = Struct.new(:node, :scope, :visibility, :container, :access, :names)

#names ⇒ Array<Symbol>

Returns attribute names.

Returns:

• (Array<Symbol>) —

  attribute names

# File 'lib/docscribe/inline_rewriter/collector.rb', line 57

AttrInsertion = Struct.new(:node, :scope, :visibility, :container, :access, :names)

#node ⇒ Parser::AST::Node

Returns the ‘:send` node (e.g. `attr_reader :name`).

Returns:

• (Parser::AST::Node) —

  the ‘:send` node (e.g. `attr_reader :name`)

# File 'lib/docscribe/inline_rewriter/collector.rb', line 57

AttrInsertion = Struct.new(:node, :scope, :visibility, :container, :access, :names)

#scope ⇒ Symbol

Returns :instance or :class (class when inside ‘class << self`).

Returns:

• (Symbol) —

  :instance or :class (class when inside ‘class << self`)

# File 'lib/docscribe/inline_rewriter/collector.rb', line 57

AttrInsertion = Struct.new(:node, :scope, :visibility, :container, :access, :names)

#visibility ⇒ Symbol

Returns :public, :protected, or :private.

Returns:

• (Symbol) —

  :public, :protected, or :private

# File 'lib/docscribe/inline_rewriter/collector.rb', line 57

AttrInsertion = Struct.new(:node, :scope, :visibility, :container, :access, :names)