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

Class Method 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



12962
12963
12964
12965
12966
12967
12968
 
# File 'lib/prism/node.rb', line 12962

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



12950
12951
12952
 
# File 'lib/prism/node.rb', line 12950

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



12953
12954
12955
 
# File 'lib/prism/node.rb', line 12953

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



12956
12957
12958
 
# File 'lib/prism/node.rb', line 12956

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



12959
12960
12961
 
# File 'lib/prism/node.rb', line 12959

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



13049
13050
13051
 
# File 'lib/prism/node.rb', line 13049

def self.type
  :optional_parameter_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12971
12972
12973
 
# File 'lib/prism/node.rb', line 12971

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

#child_nodes ⇒ Object Also known as: deconstruct

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



12976
12977
12978
 
# File 'lib/prism/node.rb', line 12976

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



12986
12987
12988
 
# File 'lib/prism/node.rb', line 12986

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



12981
12982
12983
 
# File 'lib/prism/node.rb', line 12981

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> OptionalParameterNode



12991
12992
12993
12994
12995
12996
12997
12998
12999
 
# File 'lib/prism/node.rb', line 12991

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]



13005
13006
13007
 
# File 'lib/prism/node.rb', line 13005

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



13015
13016
13017
13018
13019
13020
13021
13022
13023
 
# File 'lib/prism/node.rb', line 13015

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



13010
13011
13012
 
# File 'lib/prism/node.rb', line 13010

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



13039
13040
13041
 
# File 'lib/prism/node.rb', line 13039

def type
  :optional_parameter_node
end