class Prism::InNode

Represents the use of the ‘in` keyword in a case statement.

case a; in b then c end
        ^^^^^^^^^^^

Attributes

pattern[R]

attr_reader pattern: Prism::node

statements[R]

attr_reader statements: StatementsNode?

Public Class Methods

new(source, pattern, statements, in_loc, then_loc, location) click to toggle source

def initialize: (Prism::node pattern, StatementsNode? statements, Location in_loc, Location? then_loc, Location location) -> void

# File lib/prism/node.rb, line 8985
def initialize(source, pattern, statements, in_loc, then_loc, location)
  @source = source
  @newline = false
  @location = location
  @pattern = pattern
  @statements = statements
  @in_loc = in_loc
  @then_loc = then_loc
end

type() click to toggle source

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

# File lib/prism/node.rb, line 9096
def self.type
  :in_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File lib/prism/node.rb, line 9102
def ===(other)
  other.is_a?(InNode) &&
    (pattern === other.pattern) &&
    (statements === other.statements) &&
    (in_loc.nil? == other.in_loc.nil?) &&
    (then_loc.nil? == other.then_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 8996
def accept(visitor)
  visitor.visit_in_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 9001
def child_nodes
  [pattern, statements]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 9014
def comment_targets
  [pattern, *statements, in_loc, *then_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 9006
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << pattern
  compact << statements if statements
  compact
end

copy(pattern: self.pattern, statements: self.statements, in_loc: self.in_loc, then_loc: self.then_loc, location: self.location) click to toggle source

def copy: (?pattern: Prism::node, ?statements: StatementsNode?, ?in_loc: Location, ?then_loc: Location?, ?location: Location) -> InNode

# File lib/prism/node.rb, line 9019
def copy(pattern: self.pattern, statements: self.statements, in_loc: self.in_loc, then_loc: self.then_loc, location: self.location)
  InNode.new(source, pattern, statements, in_loc, then_loc, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { pattern: Prism::node, statements: StatementsNode?, in_loc: Location, then_loc: Location?, location: Location }

# File lib/prism/node.rb, line 9027
def deconstruct_keys(keys)
  { pattern: pattern, statements: statements, in_loc: in_loc, then_loc: then_loc, location: location }
end

in() click to toggle source

def in: () -> String

# File lib/prism/node.rb, line 9058
def in
  in_loc.slice
end

in_loc() click to toggle source

attr_reader in_loc: Location

# File lib/prism/node.rb, line 9038
def in_loc
  location = @in_loc
  return location if location.is_a?(Location)
  @in_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 9068
def inspect
  InspectVisitor.compose(self)
end

then() click to toggle source

def then: () -> String?

# File lib/prism/node.rb, line 9063
def then
  then_loc&.slice
end

then_loc() click to toggle source

attr_reader then_loc: Location?

# File lib/prism/node.rb, line 9045
def then_loc
  location = @then_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @then_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

type() click to toggle source

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

# File lib/prism/node.rb, line 9086
def type
  :in_node
end