Class: Prism::ArrayNode

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

Overview

Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.

[1, 2, 3]
^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, elements, opening_loc, closing_loc, location) ⇒ ArrayNode

def initialize: (flags: Integer, elements: Array, opening_loc: Location?, closing_loc: Location?, location: Location) -> void



585
586
587
588
589
590
591
 
# File 'lib/prism/node.rb', line 585

def initialize(flags, elements, opening_loc, closing_loc, location)
  @flags = flags
  @elements = elements
  @opening_loc = opening_loc
  @closing_loc = closing_loc
  @location = location
end

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location?



582
583
584
 
# File 'lib/prism/node.rb', line 582

def closing_loc
  @closing_loc
end

#elements ⇒ Object (readonly)

attr_reader elements: Array



576
577
578
 
# File 'lib/prism/node.rb', line 576

def elements
  @elements
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



573
574
575
 
# File 'lib/prism/node.rb', line 573

def flags
  @flags
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location?



579
580
581
 
# File 'lib/prism/node.rb', line 579

def opening_loc
  @opening_loc
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



682
683
684
 
# File 'lib/prism/node.rb', line 682

def self.type
  :array_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



594
595
596
 
# File 'lib/prism/node.rb', line 594

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

#child_nodes ⇒ Object Also known as: deconstruct

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



599
600
601
 
# File 'lib/prism/node.rb', line 599

def child_nodes
  [*elements]
end

#closing ⇒ Object

def closing: () -> String?



643
644
645
 
# File 'lib/prism/node.rb', line 643

def closing
  closing_loc&.slice
end

#comment_targets ⇒ Object

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



609
610
611
 
# File 'lib/prism/node.rb', line 609

def comment_targets
  [*elements, *opening_loc, *closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



604
605
606
 
# File 'lib/prism/node.rb', line 604

def compact_child_nodes
  [*elements]
end

#contains_splat? ⇒ Boolean

def contains_splat?: () -> bool

Returns:

  • (Boolean) 


633
634
635
 
# File 'lib/prism/node.rb', line 633

def contains_splat?
  flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
end

#copy(**params) ⇒ Object

def copy: (**params) -> ArrayNode



614
615
616
617
618
619
620
621
622
 
# File 'lib/prism/node.rb', line 614

def copy(**params)
  ArrayNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:elements) { elements },
    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]



628
629
630
 
# File 'lib/prism/node.rb', line 628

def deconstruct_keys(keys)
  { flags: flags, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



648
649
650
651
652
653
654
655
656
 
# File 'lib/prism/node.rb', line 648

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("contains_splat" if contains_splat?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "├── elements: #{inspector.list("#{inspector.prefix}│   ", elements)}"
  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?



638
639
640
 
# File 'lib/prism/node.rb', line 638

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



672
673
674
 
# File 'lib/prism/node.rb', line 672

def type
  :array_node
end