Class: SyntaxTree::Def

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

Overview

Def represents defining a regular method on the current self object.

def method(param) result end

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#pretty_print, #to_json

Constructor Details

#initialize(name:, params:, bodystmt:, location:, comments: []) ⇒ Def

Returns a new instance of Def.



3340
3341
3342
3343
3344
3345
3346
 
# File 'lib/syntax_tree/node.rb', line 3340

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

Instance Attribute Details

#bodystmt ⇒ Object (readonly)

BodyStmt

the expressions to be executed by the method



3335
3336
3337
 
# File 'lib/syntax_tree/node.rb', line 3335

def bodystmt
  @bodystmt
end

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



3338
3339
3340
 
# File 'lib/syntax_tree/node.rb', line 3338

def comments
  @comments
end

#name ⇒ Object (readonly)

Backtick | Const | Ident | Kw | Op

the name of the method



3329
3330
3331
 
# File 'lib/syntax_tree/node.rb', line 3329

def name
  @name
end

#params ⇒ Object (readonly)

Params | Paren

the parameter declaration for the method



3332
3333
3334
 
# File 'lib/syntax_tree/node.rb', line 3332

def params
  @params
end

Instance Method Details

#accept(visitor) ⇒ Object 



3348
3349
3350
 
# File 'lib/syntax_tree/node.rb', line 3348

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

#child_nodes ⇒ Object Also known as: deconstruct 



3352
3353
3354
 
# File 'lib/syntax_tree/node.rb', line 3352

def child_nodes
  [name, params, bodystmt]
end

#deconstruct_keys(keys) ⇒ Object 



3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/syntax_tree/node.rb', line 3358

def deconstruct_keys(keys)
  {
    name: name,
    params: params,
    bodystmt: bodystmt,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
 
# File 'lib/syntax_tree/node.rb', line 3368

def format(q)
  q.group do
    q.group do
      q.text("def ")
      q.format(name)

      if !params.is_a?(Params) || !params.empty? || params.comments.any?
        q.format(params)
      end
    end

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

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