Class: SyntaxTree::RBS::MethodSignature

Inherits:
Object
  • Object
show all
Defined in:
lib/syntax_tree/rbs/utils.rb

Overview

Prints out a specific method signature, which looks like: (T t) -> void

Defined Under Namespace

Classes: OptionalKeyword, OptionalPositional, RequiredKeyword, RestKeyword, RestPositional

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(node) ⇒ MethodSignature

Returns a new instance of MethodSignature.



301
302
303
 
# File 'lib/syntax_tree/rbs/utils.rb', line 301

def initialize(node)
  @node = node
end

Instance Attribute Details

#node ⇒ Object (readonly)

Returns the value of attribute node.



299
300
301
 
# File 'lib/syntax_tree/rbs/utils.rb', line 299

def node
  @node
end

Instance Method Details

#format(q) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/syntax_tree/rbs/utils.rb', line 305

def format(q)
  q.group do
    # We won't have a type_params key if we're printing a block
    if node.respond_to?(:type_params) && node.type_params.any?
      q.text("[")
      q.seplist(node.type_params, -> { q.text(", ") }) do |param|
        # We need to do a type check here to support RBS 1.0
        q.text(param.is_a?(Symbol) ? param.to_s : param.name)
      end
      q.text("] ")
    end

    params = [
      *node.type.required_positionals,
      *node.type.optional_positionals.map { |param| OptionalPositional.new(param) },
      *(RestPositional.new(node.type.rest_positionals) if node.type.rest_positionals),
      *node.type.trailing_positionals,
      *node.type.required_keywords.map { |name, param| RequiredKeyword.new(name, param) },
      *node.type.optional_keywords.map { |name, param| OptionalKeyword.new(name, param) },
      *(RestKeyword.new(node.type.rest_keywords) if node.type.rest_keywords)
    ]

    if params.any?
      q.text("(")
      q.indent do
        q.breakable("")
        q.seplist(params) { |param| param.format(q) }
      end
      q.breakable("")
      q.text(") ")
    end

    if node.respond_to?(:block) && node.block
      q.text("?") unless node.block.required
      q.text("{")
      q.indent do
        q.breakable
        MethodSignature.new(node.block).format(q)
      end
      q.breakable
      q.text("} ")
    end

    q.text("-> ")
    q.force_parens { node.type.return_type.format(q) }
  end
end

#pretty_print(q) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/syntax_tree/rbs/utils.rb', line 353

def pretty_print(q)
  if node.respond_to?(:type_params) && node.type_params.any?
    q.breakable
    q.text("type_params=")
    q.group(2, "[", "]") do
      q.breakable("")
      q.seplist(node.type_params) do |param|
        q.group(2, "(type-param", ")") do
          q.breakable
          q.text("name=")
          q.pp(param.name)
        end
      end
      q.breakable("")
    end
  end

  if node.type.required_positionals.any?
    q.breakable
    q.text("required_positionals=")
    q.pp(node.type.required_positionals)
  end

  if node.type.optional_positionals.any?
    q.breakable
    q.text("optional_positionals=")
    q.pp(node.type.optional_positionals)
  end

  if node.type.rest_positionals
    q.breakable
    q.text("rest_positionals=")
    q.pp(node.type.rest_positionals)
  end

  if node.type.trailing_positionals.any?
    q.breakable
    q.text("trailing_positionals=")
    q.pp(node.type.trailing_positionals)
  end

  if node.type.required_keywords.any?
    q.breakable
    q.text("required_keywords=")
    q.pp(node.type.required_keywords)
  end

  if node.type.optional_keywords.any?
    q.breakable
    q.text("optional_keywords=")
    q.pp(node.type.optional_keywords)
  end

  if node.type.rest_keywords
    q.breakable
    q.text("rest_keywords=")
    q.pp(node.type.rest_keywords)
  end

  if node.respond_to?(:block) && node.block
    q.breakable
    q.text("block=")
    q.group(2, "(block", ")") do
      if node.block.required
        q.breakable
        q.text("required")
      end

      q.breakable
      q.pp(MethodSignature.new(node.block))
    end
  end

  q.breakable
  q.text("return_type=")
  q.pp(node.type.return_type)
end