Class: SyntaxTree::Field

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

Overview

Field is always the child of an assignment. It represents assigning to a “field” on an object.

object.variable = value

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #pretty_print, #to_json

Constructor Details

#initialize(parent:, operator:, name:, location:, comments: []) ⇒ Field

Returns a new instance of Field.



4445
4446
4447
4448
4449
4450
4451
# File 'lib/syntax_tree/node.rb', line 4445

def initialize(parent:, operator:, name:, location:, comments: [])
  @parent = parent
  @operator = operator
  @name = name
  @location = location
  @comments = comments
end

Instance Attribute Details

#commentsObject (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



4443
4444
4445
# File 'lib/syntax_tree/node.rb', line 4443

def comments
  @comments
end

#nameObject (readonly)

Const | Ident

the name of the field being assigned



4440
4441
4442
# File 'lib/syntax_tree/node.rb', line 4440

def name
  @name
end

#operatorObject (readonly)

:“::” | Op | Period

the operator being used for the assignment



4437
4438
4439
# File 'lib/syntax_tree/node.rb', line 4437

def operator
  @operator
end

#parentObject (readonly)

untyped

the parent object that owns the field being assigned



4434
4435
4436
# File 'lib/syntax_tree/node.rb', line 4434

def parent
  @parent
end

Instance Method Details

#accept(visitor) ⇒ Object



4453
4454
4455
# File 'lib/syntax_tree/node.rb', line 4453

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

#child_nodesObject Also known as: deconstruct



4457
4458
4459
# File 'lib/syntax_tree/node.rb', line 4457

def child_nodes
  [parent, (operator if operator != :"::"), name]
end

#deconstruct_keys(_keys) ⇒ Object



4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'lib/syntax_tree/node.rb', line 4463

def deconstruct_keys(_keys)
  {
    parent: parent,
    operator: operator,
    name: name,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object



4473
4474
4475
4476
4477
4478
4479
# File 'lib/syntax_tree/node.rb', line 4473

def format(q)
  q.group do
    q.format(parent)
    q.format(CallOperatorFormatter.new(operator), stackable: false)
    q.format(name)
  end
end