Class: Prism::ClassVariableWriteNode

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

Overview

Represents writing to a class variable.

@@foo = 1
^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, name_loc, value, operator_loc, location) ⇒ ClassVariableWriteNode

def initialize: (name: Symbol, name_loc: Location, value: Node, operator_loc: Location?, location: Location) -> void



3876
3877
3878
3879
3880
3881
3882
 
# File 'lib/prism/node.rb', line 3876

def initialize(name, name_loc, value, operator_loc, location)
  @name = name
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



3864
3865
3866
 
# File 'lib/prism/node.rb', line 3864

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



3867
3868
3869
 
# File 'lib/prism/node.rb', line 3867

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location?



3873
3874
3875
 
# File 'lib/prism/node.rb', line 3873

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



3870
3871
3872
 
# File 'lib/prism/node.rb', line 3870

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



3963
3964
3965
 
# File 'lib/prism/node.rb', line 3963

def self.type
  :class_variable_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



3885
3886
3887
 
# File 'lib/prism/node.rb', line 3885

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

#child_nodes ⇒ Object Also known as: deconstruct

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



3890
3891
3892
 
# File 'lib/prism/node.rb', line 3890

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



3900
3901
3902
 
# File 'lib/prism/node.rb', line 3900

def comment_targets
  [name_loc, value, *operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



3895
3896
3897
 
# File 'lib/prism/node.rb', line 3895

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ClassVariableWriteNode



3905
3906
3907
3908
3909
3910
3911
3912
3913
 
# File 'lib/prism/node.rb', line 3905

def copy(**params)
  ClassVariableWriteNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:value) { value },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



3919
3920
3921
 
# File 'lib/prism/node.rb', line 3919

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



3929
3930
3931
3932
3933
3934
3935
3936
3937
 
# File 'lib/prism/node.rb', line 3929

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "├── value:\n"
  inspector << inspector.child_node(value, "│   ")
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String?



3924
3925
3926
 
# File 'lib/prism/node.rb', line 3924

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



3953
3954
3955
 
# File 'lib/prism/node.rb', line 3953

def type
  :class_variable_write_node
end