Class: SyntaxTree::BlockVar

Inherits:
Node
  • Object
show all
Defined in:
lib/syntax_tree/node.rb

Overview

BlockVar represents the parameters being declared for a block. Effectively this node is everything contained within the pipes. This includes all of the various parameter types, as well as block-local variable declarations.

method do |positional, optional = value, keyword:, █ local|
end

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #pretty_print, #to_json

Constructor Details

#initialize(params:, locals:, location:, comments: []) ⇒ BlockVar

Returns a new instance of BlockVar.



1732
1733
1734
1735
1736
1737
 
# File 'lib/syntax_tree/node.rb', line 1732

def initialize(params:, locals:, location:, comments: [])
  @params = params
  @locals = locals
  @location = location
  @comments = comments
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



1730
1731
1732
 
# File 'lib/syntax_tree/node.rb', line 1730

def comments
  @comments
end

#locals ⇒ Object (readonly)

Array[ Ident ]

the list of block-local variable declarations



1727
1728
1729
 
# File 'lib/syntax_tree/node.rb', line 1727

def locals
  @locals
end

#params ⇒ Object (readonly)

Params

the parameters being declared with the block



1724
1725
1726
 
# File 'lib/syntax_tree/node.rb', line 1724

def params
  @params
end

Instance Method Details

#accept(visitor) ⇒ Object 



1739
1740
1741
 
# File 'lib/syntax_tree/node.rb', line 1739

def accept(visitor)
  visitor.visit_block_var(self)
end

#child_nodes ⇒ Object Also known as: deconstruct 



1743
1744
1745
 
# File 'lib/syntax_tree/node.rb', line 1743

def child_nodes
  [params, *locals]
end

#deconstruct_keys(_keys) ⇒ Object 



1749
1750
1751
 
# File 'lib/syntax_tree/node.rb', line 1749

def deconstruct_keys(_keys)
  { params: params, locals: locals, location: location, comments: comments }
end

#format(q) ⇒ Object 



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
 
# File 'lib/syntax_tree/node.rb', line 1753

def format(q)
  q.group(0, "|", "|") do
    doc = q.format(params)
    RemoveBreaks.call(doc)

    if locals.any?
      q.text("; ")
      q.seplist(locals, -> { q.text(", ") }) { |local| q.format(local) }
    end
  end
end