Class: Prism::NoKeywordsParameterNode

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

Overview

Represents the use of ‘**nil` inside method arguments.

def a(**nil)
      ^^^^^
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator_loc, keyword_loc, location) ⇒ NoKeywordsParameterNode

def initialize: (operator_loc: Location, keyword_loc: Location, location: Location) -> void



12580
12581
12582
12583
12584
# File 'lib/prism/node.rb', line 12580

def initialize(operator_loc, keyword_loc, location)
  @operator_loc = operator_loc
  @keyword_loc = keyword_loc
  @location = location
end

Instance Attribute Details

#keyword_locObject (readonly)

attr_reader keyword_loc: Location



12577
12578
12579
# File 'lib/prism/node.rb', line 12577

def keyword_loc
  @keyword_loc
end

#operator_locObject (readonly)

attr_reader operator_loc: Location



12574
12575
12576
# File 'lib/prism/node.rb', line 12574

def operator_loc
  @operator_loc
end

Class Method Details

.typeObject

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



12665
12666
12667
# File 'lib/prism/node.rb', line 12665

def self.type
  :no_keywords_parameter_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12587
12588
12589
# File 'lib/prism/node.rb', line 12587

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

#child_nodesObject Also known as: deconstruct

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



12592
12593
12594
# File 'lib/prism/node.rb', line 12592

def child_nodes
  []
end

#comment_targetsObject

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



12602
12603
12604
# File 'lib/prism/node.rb', line 12602

def comment_targets
  [operator_loc, keyword_loc]
end

#compact_child_nodesObject

def compact_child_nodes: () -> Array



12597
12598
12599
# File 'lib/prism/node.rb', line 12597

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> NoKeywordsParameterNode



12607
12608
12609
12610
12611
12612
12613
# File 'lib/prism/node.rb', line 12607

def copy(**params)
  NoKeywordsParameterNode.new(
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



12619
12620
12621
# File 'lib/prism/node.rb', line 12619

def deconstruct_keys(keys)
  { operator_loc: operator_loc, keyword_loc: keyword_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



12634
12635
12636
12637
12638
12639
# File 'lib/prism/node.rb', line 12634

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

#keywordObject

def keyword: () -> String



12629
12630
12631
# File 'lib/prism/node.rb', line 12629

def keyword
  keyword_loc.slice
end

#operatorObject

def operator: () -> String



12624
12625
12626
# File 'lib/prism/node.rb', line 12624

def operator
  operator_loc.slice
end

#typeObject

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



12655
12656
12657
# File 'lib/prism/node.rb', line 12655

def type
  :no_keywords_parameter_node
end