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.



1686
1687
1688
1689
1690
1691
 
# File 'lib/syntax_tree/node.rb', line 1686

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



1684
1685
1686
 
# File 'lib/syntax_tree/node.rb', line 1684

def comments
  @comments
end

#locals ⇒ Object (readonly)

Array[ Ident ]

the list of block-local variable declarations



1681
1682
1683
 
# File 'lib/syntax_tree/node.rb', line 1681

def locals
  @locals
end

#params ⇒ Object (readonly)

Params

the parameters being declared with the block



1678
1679
1680
 
# File 'lib/syntax_tree/node.rb', line 1678

def params
  @params
end

Instance Method Details

#accept(visitor) ⇒ Object 



1693
1694
1695
 
# File 'lib/syntax_tree/node.rb', line 1693

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

#child_nodes ⇒ Object Also known as: deconstruct 



1697
1698
1699
 
# File 'lib/syntax_tree/node.rb', line 1697

def child_nodes
  [params, *locals]
end

#deconstruct_keys(_keys) ⇒ Object 



1703
1704
1705
 
# File 'lib/syntax_tree/node.rb', line 1703

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

#format(q) ⇒ Object 



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/syntax_tree/node.rb', line 1707

def format(q)
  q.group(0, "|", "|") do
    q.remove_breaks(q.format(params))

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