Class: Prism::OptionalParameterNode

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

Overview

Represents an optional parameter to a method, block, or lambda definition.

def a(b = 1)
      ^^^^^
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, name_loc, operator_loc, value, location) ⇒ OptionalParameterNode

def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void



10562
10563
10564
10565
10566
10567
10568
 
# File 'lib/prism/node.rb', line 10562

def initialize(name, name_loc, operator_loc, value, location)
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
  @value = value
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



10550
10551
10552
 
# File 'lib/prism/node.rb', line 10550

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



10553
10554
10555
 
# File 'lib/prism/node.rb', line 10553

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



10556
10557
10558
 
# File 'lib/prism/node.rb', line 10556

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



10559
10560
10561
 
# File 'lib/prism/node.rb', line 10559

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



10571
10572
10573
 
# File 'lib/prism/node.rb', line 10571

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10576
10577
10578
 
# File 'lib/prism/node.rb', line 10576

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



10586
10587
10588
 
# File 'lib/prism/node.rb', line 10586

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10581
10582
10583
 
# File 'lib/prism/node.rb', line 10581

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> OptionalParameterNode



10591
10592
10593
10594
10595
10596
10597
10598
10599
 
# File 'lib/prism/node.rb', line 10591

def copy(**params)
  OptionalParameterNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



10605
10606
10607
 
# File 'lib/prism/node.rb', line 10605

def deconstruct_keys(keys)
  { name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



10614
10615
10616
10617
10618
10619
10620
10621
10622
 
# File 'lib/prism/node.rb', line 10614

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector << "└── value:\n"
  inspector << inspector.child_node(value, "    ")
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



10610
10611
10612
 
# File 'lib/prism/node.rb', line 10610

def operator
  operator_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



10638
10639
10640
 
# File 'lib/prism/node.rb', line 10638

def type
  :optional_parameter_node
end