Class: Prism::LocalVariableWriteNode

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

Overview

Represents writing to a local variable.

foo = 1
^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name, depth, name_loc, value, operator_loc) ⇒ LocalVariableWriteNode

Initialize a new LocalVariableWriteNode node.



10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
 
# File 'lib/prism/node.rb', line 10917

def initialize(source, node_id, location, flags, name, depth, name_loc, value, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @depth = depth
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
end

Instance Attribute Details

#depth ⇒ Object (readonly)

The number of semantic scopes we have to traverse to find the declaration of this variable.

foo = 1         # depth 0

tap { foo = 1 } # depth 1

The specific rules for calculating the depth may differ from individual Ruby implementations, as they are not specified by the language. For more information, see [the Prism documentation](github.com/ruby/prism/blob/main/docs/local_variable_depth.md).



10976
10977
10978
 
# File 'lib/prism/node.rb', line 10976

def depth
  @depth
end

#name ⇒ Object (readonly)

The name of the local variable, which is an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

foo = :bar # name `:foo`

abc = 123  # name `:abc`



10967
10968
10969
 
# File 'lib/prism/node.rb', line 10967

def name
  @name
end

#value ⇒ Object (readonly)

The value to write to the local variable. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

foo = :bar
      ^^^^

abc = 1234
      ^^^^

Note that since the name of a local variable is known before the value is parsed, it is valid for a local variable to appear within the value of its own write.

foo = foo



10999
11000
11001
 
# File 'lib/prism/node.rb', line 10999

def value
  @value
end

Class Method Details

.type ⇒ Object

Return a symbol representation of this node type. See ‘Node::type`.



11027
11028
11029
 
# File 'lib/prism/node.rb', line 11027

def self.type
  :local_variable_write_node
end

Instance Method Details

#===(other) ⇒ Object

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



11033
11034
11035
11036
11037
11038
11039
11040
 
# File 'lib/prism/node.rb', line 11033

def ===(other)
  other.is_a?(LocalVariableWriteNode) &&
    (name === other.name) &&
    (depth === other.depth) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



10930
10931
10932
 
# File 'lib/prism/node.rb', line 10930

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10935
10936
10937
 
# File 'lib/prism/node.rb', line 10935

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



10945
10946
10947
 
# File 'lib/prism/node.rb', line 10945

def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10940
10941
10942
 
# File 'lib/prism/node.rb', line 10940

def compact_child_nodes
  [value]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, depth: self.depth, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?depth: Integer, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) -> LocalVariableWriteNode



10950
10951
10952
 
# File 'lib/prism/node.rb', line 10950

def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, depth: self.depth, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  LocalVariableWriteNode.new(source, node_id, location, flags, name, depth, name_loc, value, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, depth: Integer, name_loc: Location, value: Prism::node, operator_loc: Location }



10958
10959
10960
 
# File 'lib/prism/node.rb', line 10958

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

#inspect ⇒ Object

def inspect -> String



11017
11018
11019
 
# File 'lib/prism/node.rb', line 11017

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

The location of the variable name.

foo = :bar
^^^



10982
10983
10984
10985
10986
 
# File 'lib/prism/node.rb', line 10982

def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#operator ⇒ Object

def operator: () -> String



11012
11013
11014
 
# File 'lib/prism/node.rb', line 11012

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘=` operator.

x = :y
  ^



11005
11006
11007
11008
11009
 
# File 'lib/prism/node.rb', line 11005

def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#type ⇒ Object

Return a symbol representation of this node type. See ‘Node#type`.



11022
11023
11024
 
# File 'lib/prism/node.rb', line 11022

def type
  :local_variable_write_node
end