Class: Prism::BlockParametersNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a block’s parameters declaration.

-> (a, b = 1; local) { }
   ^^^^^^^^^^^^^^^^^

foo do |a, b = 1; local|
       ^^^^^^^^^^^^^^^^^
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parameters, locals, opening_loc, closing_loc, location) ⇒ BlockParametersNode

def initialize: (parameters: ParametersNode?, locals: Array, opening_loc: Location?, closing_loc: Location?, location: Location) -> void



1758
1759
1760
1761
1762
1763
1764
 
# File 'lib/prism/node.rb', line 1758

def initialize(parameters, locals, opening_loc, closing_loc, location)
  @parameters = parameters
  @locals = locals
  @opening_loc = opening_loc
  @closing_loc = closing_loc
  @location = location
end

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location?



1755
1756
1757
 
# File 'lib/prism/node.rb', line 1755

def closing_loc
  @closing_loc
end

#locals ⇒ Object (readonly)

attr_reader locals: Array



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

def locals
  @locals
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location?



1752
1753
1754
 
# File 'lib/prism/node.rb', line 1752

def opening_loc
  @opening_loc
end

#parameters ⇒ Object (readonly)

attr_reader parameters: ParametersNode?



1746
1747
1748
 
# File 'lib/prism/node.rb', line 1746

def parameters
  @parameters
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



1857
1858
1859
 
# File 'lib/prism/node.rb', line 1857

def self.type
  :block_parameters_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



1767
1768
1769
 
# File 'lib/prism/node.rb', line 1767

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array[nil | Node]



1772
1773
1774
 
# File 'lib/prism/node.rb', line 1772

def child_nodes
  [parameters, *locals]
end

#closing ⇒ Object

def closing: () -> String?



1814
1815
1816
 
# File 'lib/prism/node.rb', line 1814

def closing
  closing_loc&.slice
end

#comment_targets ⇒ Object

def comment_targets: () -> Array[Node | Location]



1785
1786
1787
 
# File 'lib/prism/node.rb', line 1785

def comment_targets
  [*parameters, *locals, *opening_loc, *closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1777
1778
1779
1780
1781
1782
 
# File 'lib/prism/node.rb', line 1777

def compact_child_nodes
  compact = []
  compact << parameters if parameters
  compact.concat(locals)
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> BlockParametersNode



1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/prism/node.rb', line 1790

def copy(**params)
  BlockParametersNode.new(
    params.fetch(:parameters) { parameters },
    params.fetch(:locals) { locals },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



1804
1805
1806
 
# File 'lib/prism/node.rb', line 1804

def deconstruct_keys(keys)
  { parameters: parameters, locals: locals, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
 
# File 'lib/prism/node.rb', line 1819

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (parameters = self.parameters).nil?
    inspector << "├── parameters: ∅\n"
  else
    inspector << "├── parameters:\n"
    inspector << parameters.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── locals: #{inspector.list("#{inspector.prefix}│   ", locals)}"
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#opening ⇒ Object

def opening: () -> String?



1809
1810
1811
 
# File 'lib/prism/node.rb', line 1809

def opening
  opening_loc&.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



1847
1848
1849
 
# File 'lib/prism/node.rb', line 1847

def type
  :block_parameters_node
end