Class: Prism::CaseMatchNode

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

Overview

Represents the use of a case statement for pattern matching.

case true
in false
end
^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location) ⇒ CaseMatchNode

def initialize: (predicate: Node?, conditions: Array, consequent: ElseNode?, case_keyword_loc: Location, end_keyword_loc: Location, location: Location) -> void



2948
2949
2950
2951
2952
2953
2954
2955
 
# File 'lib/prism/node.rb', line 2948

def initialize(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location)
  @predicate = predicate
  @conditions = conditions
  @consequent = consequent
  @case_keyword_loc = case_keyword_loc
  @end_keyword_loc = end_keyword_loc
  @location = location
end

Instance Attribute Details

#case_keyword_loc ⇒ Object (readonly)

attr_reader case_keyword_loc: Location



2942
2943
2944
 
# File 'lib/prism/node.rb', line 2942

def case_keyword_loc
  @case_keyword_loc
end

#conditions ⇒ Object (readonly)

attr_reader conditions: Array



2936
2937
2938
 
# File 'lib/prism/node.rb', line 2936

def conditions
  @conditions
end

#consequent ⇒ Object (readonly)

attr_reader consequent: ElseNode?



2939
2940
2941
 
# File 'lib/prism/node.rb', line 2939

def consequent
  @consequent
end

#end_keyword_loc ⇒ Object (readonly)

attr_reader end_keyword_loc: Location



2945
2946
2947
 
# File 'lib/prism/node.rb', line 2945

def end_keyword_loc
  @end_keyword_loc
end

#predicate ⇒ Object (readonly)

attr_reader predicate: Node?



2933
2934
2935
 
# File 'lib/prism/node.rb', line 2933

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



3056
3057
3058
 
# File 'lib/prism/node.rb', line 3056

def self.type
  :case_match_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



2958
2959
2960
 
# File 'lib/prism/node.rb', line 2958

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

#case_keyword ⇒ Object

def case_keyword: () -> String



3002
3003
3004
 
# File 'lib/prism/node.rb', line 3002

def case_keyword
  case_keyword_loc.slice
end

#child_nodes ⇒ Object Also known as: deconstruct

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



2963
2964
2965
 
# File 'lib/prism/node.rb', line 2963

def child_nodes
  [predicate, *conditions, consequent]
end

#comment_targets ⇒ Object

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



2977
2978
2979
 
# File 'lib/prism/node.rb', line 2977

def comment_targets
  [*predicate, *conditions, *consequent, case_keyword_loc, end_keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2968
2969
2970
2971
2972
2973
2974
 
# File 'lib/prism/node.rb', line 2968

def compact_child_nodes
  compact = []
  compact << predicate if predicate
  compact.concat(conditions)
  compact << consequent if consequent
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> CaseMatchNode



2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
 
# File 'lib/prism/node.rb', line 2982

def copy(**params)
  CaseMatchNode.new(
    params.fetch(:predicate) { predicate },
    params.fetch(:conditions) { conditions },
    params.fetch(:consequent) { consequent },
    params.fetch(:case_keyword_loc) { case_keyword_loc },
    params.fetch(:end_keyword_loc) { end_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]



2997
2998
2999
 
# File 'lib/prism/node.rb', line 2997

def deconstruct_keys(keys)
  { predicate: predicate, conditions: conditions, consequent: consequent, case_keyword_loc: case_keyword_loc, end_keyword_loc: end_keyword_loc, location: location }
end

#end_keyword ⇒ Object

def end_keyword: () -> String



3007
3008
3009
 
# File 'lib/prism/node.rb', line 3007

def end_keyword
  end_keyword_loc.slice
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
 
# File 'lib/prism/node.rb', line 3012

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (predicate = self.predicate).nil?
    inspector << "├── predicate: ∅\n"
  else
    inspector << "├── predicate:\n"
    inspector << predicate.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── conditions: #{inspector.list("#{inspector.prefix}│   ", conditions)}"
  if (consequent = self.consequent).nil?
    inspector << "├── consequent: ∅\n"
  else
    inspector << "├── consequent:\n"
    inspector << consequent.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── case_keyword_loc: #{inspector.location(case_keyword_loc)}\n"
  inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
  inspector.to_str
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



3046
3047
3048
 
# File 'lib/prism/node.rb', line 3046

def type
  :case_match_node
end