Class: SyntaxTree::ModuleDeclaration

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

Overview

ModuleDeclaration represents defining a module using the module keyword.

module Namespace
end

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(constant:, bodystmt:, location:, comments: []) ⇒ ModuleDeclaration

Returns a new instance of ModuleDeclaration.



6462
6463
6464
6465
6466
6467
 
# File 'lib/syntax_tree/node.rb', line 6462

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

Instance Attribute Details

#bodystmt ⇒ Object (readonly)

BodyStmt

the expressions to be executed in the context of the module



6457
6458
6459
 
# File 'lib/syntax_tree/node.rb', line 6457

def bodystmt
  @bodystmt
end

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



6460
6461
6462
 
# File 'lib/syntax_tree/node.rb', line 6460

def comments
  @comments
end

#constant ⇒ Object (readonly)

ConstPathRef | ConstRef | TopConstRef

the name of the module



6454
6455
6456
 
# File 'lib/syntax_tree/node.rb', line 6454

def constant
  @constant
end

Instance Method Details

#accept(visitor) ⇒ Object 



6469
6470
6471
 
# File 'lib/syntax_tree/node.rb', line 6469

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

#child_nodes ⇒ Object Also known as: deconstruct 



6473
6474
6475
 
# File 'lib/syntax_tree/node.rb', line 6473

def child_nodes
  [constant, bodystmt]
end

#deconstruct_keys(_keys) ⇒ Object 



6479
6480
6481
6482
6483
6484
6485
6486
 
# File 'lib/syntax_tree/node.rb', line 6479

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

#format(q) ⇒ Object 



6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
 
# File 'lib/syntax_tree/node.rb', line 6488

def format(q)
  declaration = -> do
    q.group do
      q.text("module ")
      q.format(constant)
    end
  end

  if bodystmt.empty?
    q.group do
      declaration.call
      q.breakable(force: true)
      q.text("end")
    end
  else
    q.group do
      declaration.call

      q.indent do
        q.breakable(force: true)
        q.format(bodystmt)
      end

      q.breakable(force: true)
      q.text("end")
    end
  end
end