Class: SyntaxTree::VarField

Inherits:
Node
  • Object
show all
Defined in:
lib/syntax_tree/node.rb

Overview

VarField represents a variable that is being assigned a value. As such, it is always a child of an assignment type node.

variable = value

In the example above, the VarField node represents the variable token.

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #end_char, #pretty_print, #start_char, #to_json, #to_mermaid

Constructor Details

#initialize(value:, location:) ⇒ VarField

Returns a new instance of VarField.



11529
11530
11531
11532
11533
 
# File 'lib/syntax_tree/node.rb', line 11529

def initialize(value:, location:)
  @value = value
  @location = location
  @comments = []
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



11527
11528
11529
 
# File 'lib/syntax_tree/node.rb', line 11527

def comments
  @comments
end

#value ⇒ Object (readonly)

nil | :nil | Const | CVar | GVar | Ident | IVar

the target of this node



11524
11525
11526
 
# File 'lib/syntax_tree/node.rb', line 11524

def value
  @value
end

Instance Method Details

#===(other) ⇒ Object 



11568
11569
11570
 
# File 'lib/syntax_tree/node.rb', line 11568

def ===(other)
  other.is_a?(VarField) && value === other.value
end

#accept(visitor) ⇒ Object 



11535
11536
11537
 
# File 'lib/syntax_tree/node.rb', line 11535

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

#child_nodes ⇒ Object Also known as: deconstruct 



11539
11540
11541
 
# File 'lib/syntax_tree/node.rb', line 11539

def child_nodes
  value == :nil ? [] : [value]
end

#copy(value: nil, location: nil) ⇒ Object 



11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
 
# File 'lib/syntax_tree/node.rb', line 11543

def copy(value: nil, location: nil)
  node =
    VarField.new(
      value: value || self.value,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

#deconstruct_keys(_keys) ⇒ Object 



11556
11557
11558
 
# File 'lib/syntax_tree/node.rb', line 11556

def deconstruct_keys(_keys)
  { value: value, location: location, comments: comments }
end

#format(q) ⇒ Object 



11560
11561
11562
11563
11564
11565
11566
 
# File 'lib/syntax_tree/node.rb', line 11560

def format(q)
  if value == :nil
    q.text("nil")
  elsif value
    q.format(value)
  end
end