Class: RBI::RBSPrinter

Inherits:
Visitor show all
Defined in:
lib/rbi/rbs_printer.rb

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Visitor

#visit

Constructor Details

#initialize(out: $stdout, indent: 0, print_locs: false) ⇒ RBSPrinter

Returns a new instance of RBSPrinter.



18
19
20
21
22
23
24
25
 
# File 'lib/rbi/rbs_printer.rb', line 18

def initialize(out: $stdout, indent: 0, print_locs: false)
  super()
  @out = out
  @current_indent = indent
  @print_locs = print_locs
  @in_visibility_group = T.let(false, T::Boolean)
  @previous_node = T.let(nil, T.nilable(Node))
end

Instance Attribute Details

#current_indent ⇒ Object (readonly)

Returns the value of attribute current_indent.



15
16
17
 
# File 'lib/rbi/rbs_printer.rb', line 15

def current_indent
  @current_indent
end

#in_visibility_group ⇒ Object

Returns the value of attribute in_visibility_group.



9
10
11
 
# File 'lib/rbi/rbs_printer.rb', line 9

def in_visibility_group
  @in_visibility_group
end

#previous_node ⇒ Object (readonly)

Returns the value of attribute previous_node.



12
13
14
 
# File 'lib/rbi/rbs_printer.rb', line 12

def previous_node
  @previous_node
end

#print_locs ⇒ Object

Returns the value of attribute print_locs.



9
10
11
 
# File 'lib/rbi/rbs_printer.rb', line 9

def print_locs
  @print_locs
end

Instance Method Details

#dedent ⇒ Object 



35
36
37
 
# File 'lib/rbi/rbs_printer.rb', line 35

def dedent
  @current_indent -= 2
end

#indent ⇒ Object 



30
31
32
 
# File 'lib/rbi/rbs_printer.rb', line 30

def indent
  @current_indent += 2
end

#print(string) ⇒ Object 



41
42
43
 
# File 'lib/rbi/rbs_printer.rb', line 41

def print(string)
  @out.print(string)
end

#print_attr_sig(node, sig) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/rbi/rbs_printer.rb', line 275

def print_attr_sig(node, sig)
  ret_type = sig.return_type

  type = case node
  when AttrReader, AttrAccessor
    parse_type(ret_type).rbs_string
  else
    # For attr_writer, Sorbet will prioritize the return type over the argument type in case of mismatch
    arg_type = sig.params.first
    if arg_type && (ret_type.is_a?(Type::Void) || ret_type == "void")
      # If we have an argument type and the return type is void, we prioritize the argument type
      parse_type(arg_type.type).rbs_string
    else
      # Otherwise, we prioritize the return type
      parse_type(ret_type).rbs_string
    end
  end

  print(type)
end

#print_method_sig(node, sig) ⇒ Object 



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
 
# File 'lib/rbi/rbs_printer.rb', line 363

def print_method_sig(node, sig)
  unless sig.type_params.empty?
    print("[#{sig.type_params.join(", ")}] ")
  end

  block_param = node.params.find { |param| param.is_a?(BlockParam) }
  sig_block_param = sig.params.find { |param| param.name == block_param&.name }

  sig_params = sig.params.dup
  if block_param
    sig_params.reject! do |param|
      param.name == block_param.name
    end
  end

  unless sig_params.empty?
    print("(")
    sig_params.each_with_index do |param, index|
      print(", ") if index > 0
      print_sig_param(node, param)
    end
    print(") ")
  end
  if sig_block_param
    block_type = sig_block_param.type
    block_type = Type.parse_string(block_type) if block_type.is_a?(String)

    block_is_nilable = false
    if block_type.is_a?(Type::Nilable)
      block_is_nilable = true
      block_type = block_type.type
    end

    type_string = parse_type(block_type).rbs_string.delete_prefix("^")

    skip = false
    case block_type
    when Type::Untyped
      type_string = "(?) -> untyped"
      block_is_nilable = true
    when Type::Simple
      type_string = "(?) -> untyped"
      skip = true if block_type.name == "NilClass"
    end

    if skip
      # no-op, we skip the block definition
    elsif block_is_nilable
      print("?{ #{type_string} } ")
    else
      print("{ #{type_string} } ")
    end
  end

  type = parse_type(sig.return_type)
  print("-> #{type.rbs_string}")

  loc = sig.loc
  print(" # #{loc}") if loc && print_locs
end

#printl(string) ⇒ Object 



61
62
63
64
 
# File 'lib/rbi/rbs_printer.rb', line 61

def printl(string)
  printt
  printn(string)
end

#printn(string = nil) ⇒ Object 



47
48
49
50
 
# File 'lib/rbi/rbs_printer.rb', line 47

def printn(string = nil)
  print(string) if string
  print("\n")
end

#printt(string = nil) ⇒ Object 



54
55
56
57
 
# File 'lib/rbi/rbs_printer.rb', line 54

def printt(string = nil)
  print(" " * @current_indent)
  print(string) if string
end

#visit_all(nodes) ⇒ Object 



67
68
69
70
71
72
73
74
75
 
# File 'lib/rbi/rbs_printer.rb', line 67

def visit_all(nodes)
  previous_node = @previous_node
  @previous_node = nil
  nodes.each do |node|
    visit(node)
    @previous_node = node
  end
  @previous_node = previous_node
end

#visit_arg(node) ⇒ Object 



534
535
536
 
# File 'lib/rbi/rbs_printer.rb', line 534

def visit_arg(node)
  # no-op
end

#visit_attr(node) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/rbi/rbs_printer.rb', line 243

def visit_attr(node)
  print_blank_line_before(node)

  node.names.each do |name|
    visit_all(node.comments)
    print_loc(node)
    printt
    unless in_visibility_group || node.visibility.public? || node.visibility.protected?
      self.print(node.visibility.visibility.to_s)
      print(" ")
    end
    case node
    when AttrAccessor
      print("attr_accessor")
    when AttrReader
      print("attr_reader")
    when AttrWriter
      print("attr_writer")
    end
    print(" #{name}")
    first_sig, *_rest = node.sigs # discard remaining signatures
    if first_sig
      print(": ")
      print_attr_sig(node, first_sig)
    else
      print(": untyped")
    end
    printn
  end
end

#visit_attr_accessor(node) ⇒ Object 



228
229
230
 
# File 'lib/rbi/rbs_printer.rb', line 228

def visit_attr_accessor(node)
  visit_attr(node)
end

#visit_attr_reader(node) ⇒ Object 



233
234
235
 
# File 'lib/rbi/rbs_printer.rb', line 233

def visit_attr_reader(node)
  visit_attr(node)
end

#visit_attr_writer(node) ⇒ Object 



238
239
240
 
# File 'lib/rbi/rbs_printer.rb', line 238

def visit_attr_writer(node)
  visit_attr(node)
end

#visit_blank_line(node) ⇒ Object 



106
107
108
 
# File 'lib/rbi/rbs_printer.rb', line 106

def visit_blank_line(node)
  printn
end

#visit_block_param(node) ⇒ Object 



473
474
475
 
# File 'lib/rbi/rbs_printer.rb', line 473

def visit_block_param(node)
  print("{ (*untyped) -> untyped } ")
end

#visit_class(node) ⇒ Object 



123
124
125
 
# File 'lib/rbi/rbs_printer.rb', line 123

def visit_class(node)
  visit_scope(node)
end

#visit_comment(node) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rbi/rbs_printer.rb', line 90

def visit_comment(node)
  lines = node.text.lines

  if lines.empty?
    printl("#")
  end

  lines.each do |line|
    text = line.rstrip
    printt("#")
    print(" #{text}") unless text.empty?
    printn
  end
end

#visit_conflict_tree(node) ⇒ Object 



654
655
656
657
658
659
660
 
# File 'lib/rbi/rbs_printer.rb', line 654

def visit_conflict_tree(node)
  printl("<<<<<<< #{node.left_name}")
  visit(node.left)
  printl("=======")
  visit(node.right)
  printl(">>>>>>> #{node.right_name}")
end

#visit_const(node) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/rbi/rbs_printer.rb', line 213

def visit_const(node)
  print_blank_line_before(node)
  print_loc(node)
  visit_all(node.comments)

  type = parse_t_let(node.value)
  if type
    type = parse_type(type)
    printl("#{node.name}: #{type.rbs_string}")
  else
    printl("#{node.name}: untyped")
  end
end

#visit_extend(node) ⇒ Object 



483
484
485
 
# File 'lib/rbi/rbs_printer.rb', line 483

def visit_extend(node)
  visit_mixin(node)
end

#visit_file(file) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rbi/rbs_printer.rb', line 78

def visit_file(file)
  unless file.comments.empty?
    visit_all(file.comments)
  end

  unless file.root.empty? && file.root.comments.empty?
    printn unless file.comments.empty?
    visit(file.root)
  end
end

#visit_group(node) ⇒ Object 



630
631
632
633
 
# File 'lib/rbi/rbs_printer.rb', line 630

def visit_group(node)
  printn unless previous_node.nil?
  visit_all(node.nodes)
end

#visit_helper(node) ⇒ Object 



620
621
622
 
# File 'lib/rbi/rbs_printer.rb', line 620

def visit_helper(node)
  # no-op, we already show them in the scope header
end

#visit_include(node) ⇒ Object 



478
479
480
 
# File 'lib/rbi/rbs_printer.rb', line 478

def visit_include(node)
  visit_mixin(node)
end

#visit_kw_arg(node) ⇒ Object 



539
540
541
 
# File 'lib/rbi/rbs_printer.rb', line 539

def visit_kw_arg(node)
  # no-op
end

#visit_kw_opt_param(node) ⇒ Object 



463
464
465
 
# File 'lib/rbi/rbs_printer.rb', line 463

def visit_kw_opt_param(node)
  print("?#{node.name}: untyped")
end

#visit_kw_param(node) ⇒ Object 



458
459
460
 
# File 'lib/rbi/rbs_printer.rb', line 458

def visit_kw_param(node)
  print("#{node.name}: untyped")
end

#visit_kw_rest_param(node) ⇒ Object 



468
469
470
 
# File 'lib/rbi/rbs_printer.rb', line 468

def visit_kw_rest_param(node)
  print("**#{node.name}: untyped")
end

#visit_method(node) ⇒ Object 



297
298
299
300
301
302
303
304
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
352
353
354
355
356
357
358
359
360
 
# File 'lib/rbi/rbs_printer.rb', line 297

def visit_method(node)
  print_blank_line_before(node)
  visit_all(node.comments)

  if node.sigs.any?(&:is_abstract)
    printl("# @abstract")
  end

  if node.sigs.any?(&:is_override)
    if node.sigs.any?(&:allow_incompatible_override)
      printl("# @override(allow_incompatible: true)")
    else
      printl("# @override")
    end
  end

  if node.sigs.any?(&:is_overridable)
    printl("# @overridable")
  end

  if node.sigs.any?(&:is_final)
    printl("# @final")
  end

  print_loc(node)
  printt
  unless in_visibility_group || node.visibility.public?
    self.print(node.visibility.visibility.to_s)
    print(" ")
  end
  print("def ")
  print("self.") if node.is_singleton
  print(node.name)
  sigs = node.sigs
  print(": ")
  if sigs.any?
    first, *rest = sigs
    print_method_sig(node, T.must(first))
    if rest.any?
      spaces = node.name.size + 4
      rest.each do |sig|
        printn
        printt
        print("#{" " * spaces}| ")
        print_method_sig(node, sig)
      end
    end
  else
    if node.params.any?
      params = node.params.reject { |param| param.is_a?(BlockParam) }
      block = node.params.find { |param| param.is_a?(BlockParam) }

      print("(")
      params.each_with_index do |param, index|
        print(", ") if index > 0
        visit(param)
      end
      print(") ")
      visit(block)
    end
    print("-> untyped")
  end
  printn
end

#visit_mixes_in_class_methods(node) ⇒ Object 



625
626
627
 
# File 'lib/rbi/rbs_printer.rb', line 625

def visit_mixes_in_class_methods(node)
  visit_mixin(node)
end

#visit_mixin(node) ⇒ Object 



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/rbi/rbs_printer.rb', line 488

def visit_mixin(node)
  return if node.is_a?(MixesInClassMethods) # no-op, `mixes_in_class_methods` is not supported in RBS

  print_blank_line_before(node)
  print_loc(node)
  visit_all(node.comments)

  case node
  when Include
    printt("include")
  when Extend
    printt("extend")
  end
  printn(" #{node.names.join(", ")}")
end

#visit_module(node) ⇒ Object 



118
119
120
 
# File 'lib/rbi/rbs_printer.rb', line 118

def visit_module(node)
  visit_scope(node)
end

#visit_opt_param(node) ⇒ Object 



448
449
450
 
# File 'lib/rbi/rbs_printer.rb', line 448

def visit_opt_param(node)
  print("?untyped #{node.name}")
end

#visit_private(node) ⇒ Object 



515
516
517
 
# File 'lib/rbi/rbs_printer.rb', line 515

def visit_private(node)
  visit_visibility(node)
end

#visit_protected(node) ⇒ Object 



510
511
512
 
# File 'lib/rbi/rbs_printer.rb', line 510

def visit_protected(node)
  # no-op, `protected` is not supported in RBS
end

#visit_public(node) ⇒ Object 



505
506
507
 
# File 'lib/rbi/rbs_printer.rb', line 505

def visit_public(node)
  visit_visibility(node)
end

#visit_req_param(node) ⇒ Object 



443
444
445
 
# File 'lib/rbi/rbs_printer.rb', line 443

def visit_req_param(node)
  print("untyped #{node.name}")
end

#visit_requires_ancestor(node) ⇒ Object 



649
650
651
 
# File 'lib/rbi/rbs_printer.rb', line 649

def visit_requires_ancestor(node)
  # no-op, we already show them in the scope header
end

#visit_rest_param(node) ⇒ Object 



453
454
455
 
# File 'lib/rbi/rbs_printer.rb', line 453

def visit_rest_param(node)
  print("*untyped #{node.name}")
end

#visit_scope(node) ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'lib/rbi/rbs_printer.rb', line 138

def visit_scope(node)
  print_blank_line_before(node)
  print_loc(node)
  visit_all(node.comments)

  visit_scope_header(node)
  visit_scope_body(node)
end

#visit_scope_body(node) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/rbi/rbs_printer.rb', line 201

def visit_scope_body(node)
  unless node.empty?
    indent
    visit_all(node.nodes)
    dedent
  end
  if !node.is_a?(Struct) || !node.empty?
    printl("end")
  end
end

#visit_scope_conflict(node) ⇒ Object 



663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/rbi/rbs_printer.rb', line 663

def visit_scope_conflict(node)
  print_blank_line_before(node)
  print_loc(node)
  visit_all(node.comments)

  printl("<<<<<<< #{node.left_name}")
  visit_scope_header(node.left)
  printl("=======")
  visit_scope_header(node.right)
  printl(">>>>>>> #{node.right_name}")
  visit_scope_body(node.left)
end

#visit_scope_header(node) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/rbi/rbs_printer.rb', line 148

def visit_scope_header(node)
  node.nodes.grep(Helper).each do |helper|
    visit(Comment.new("@#{helper.name}"))
  end

  mixins = node.nodes.grep(MixesInClassMethods)
  if mixins.any?
    visit(Comment.new("@mixes_in_class_methods #{mixins.map(&:names).join(", ")}"))
  end

  ancestors = node.nodes.grep(RequiresAncestor)
  if ancestors.any?
    visit(Comment.new("@requires_ancestor #{ancestors.map(&:name).join(", ")}"))
  end

  case node
  when TStruct
    printt("class #{node.name}")
  when TEnum
    printt("class #{node.name}")
  when Module
    printt("module #{node.name}")
  when Class
    printt("class #{node.name}")
    superclass = node.superclass_name
    print(" < #{superclass}") if superclass
  when Struct
    printt("#{node.name} = ::Struct.new")
    if !node.members.empty? || node.keyword_init
      print("(")
      args = node.members.map { |member| ":#{member}" }
      args << "keyword_init: true" if node.keyword_init
      print(args.join(", "))
      print(")")
    end
  when SingletonClass
    printt("class << self")
  else
    raise Error, "Unhandled node: #{node.class}"
  end

  type_params = node.nodes.grep(TypeMember)
  if type_params.any?
    print("[#{type_params.map(&:name).join(", ")}]")
  end

  if !node.empty? && node.is_a?(Struct)
    print(" do")
  end
  printn
end

#visit_send(node) ⇒ Object 



529
530
531
 
# File 'lib/rbi/rbs_printer.rb', line 529

def visit_send(node)
  # no-op, arbitrary sends are not supported in RBS
end

#visit_sig(node) ⇒ Object 



425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/rbi/rbs_printer.rb', line 425

def visit_sig(node)
  if node.params
    print("(")
    node.params.each do |param|
      visit(param)
    end
    print(") ")
  end

  print("-> #{parse_type(node.return_type).rbs_string}")
end

#visit_sig_param(node) ⇒ Object 



438
439
440
 
# File 'lib/rbi/rbs_printer.rb', line 438

def visit_sig_param(node)
  print(parse_type(node.type).rbs_string)
end

#visit_singleton_class(node) ⇒ Object 



133
134
135
 
# File 'lib/rbi/rbs_printer.rb', line 133

def visit_singleton_class(node)
  visit_scope(node)
end

#visit_struct(node) ⇒ Object 



128
129
130
 
# File 'lib/rbi/rbs_printer.rb', line 128

def visit_struct(node)
  visit_scope(node)
end

#visit_tenum(node) ⇒ Object 



592
593
594
 
# File 'lib/rbi/rbs_printer.rb', line 592

def visit_tenum(node)
  visit_scope(node)
end

#visit_tenum_block(node) ⇒ Object 



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/rbi/rbs_printer.rb', line 597

def visit_tenum_block(node)
  node.nodes.each do |child|
    child = if child.is_a?(Const) && child.value == "new"
      parent = node.parent_scope
      Const.new(
        child.name,
        "T.let(nil, #{parent.is_a?(TEnum) ? parent.name : "T.untyped"})",
        comments: child.comments,
      )
    else
      child
    end
    visit(child)
    @previous_node = child
  end
end

#visit_tree(node) ⇒ Object 



111
112
113
114
115
 
# File 'lib/rbi/rbs_printer.rb', line 111

def visit_tree(node)
  visit_all(node.comments)
  printn if !node.comments.empty? && !node.empty?
  visit_all(node.nodes)
end

#visit_tstruct(node) ⇒ Object 



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/rbi/rbs_printer.rb', line 544

def visit_tstruct(node)
  print_blank_line_before(node)
  print_loc(node)
  visit_all(node.comments)

  visit_scope_header(node)
  nodes = node.nodes.dup

  sig = Sig.new
  init = Method.new("initialize", sigs: [sig])
  last_field = -1
  nodes.each_with_index do |child, i|
    case child
    when TStructField
      default = child.default
      init << if default
        KwOptParam.new(child.name, default)
      else
        KwParam.new(child.name)
      end
      sig << SigParam.new(child.name, child.type)
      last_field = i
    end
  end
  nodes.insert(last_field + 1, init)

  indent
  visit_all(nodes)
  dedent

  printl("end")
end

#visit_tstruct_const(node) ⇒ Object 



578
579
580
581
582
 
# File 'lib/rbi/rbs_printer.rb', line 578

def visit_tstruct_const(node)
  # `T::Struct.const` is not supported in RBS instead we generate an attribute reader
  accessor = AttrReader.new(node.name.to_sym, comments: node.comments, sigs: [Sig.new(return_type: node.type)])
  visit_attr_reader(accessor)
end

#visit_tstruct_prop(node) ⇒ Object 



585
586
587
588
589
 
# File 'lib/rbi/rbs_printer.rb', line 585

def visit_tstruct_prop(node)
  # `T::Struct.prop` is not supported in RBS instead we generate an attribute accessor
  accessor = AttrAccessor.new(node.name.to_sym, comments: node.comments, sigs: [Sig.new(return_type: node.type)])
  visit_attr_accessor(accessor)
end

#visit_type_member(node) ⇒ Object 



615
616
617
 
# File 'lib/rbi/rbs_printer.rb', line 615

def visit_type_member(node)
  # no-op, we already show them in the scope header
end

#visit_visibility(node) ⇒ Object 



520
521
522
523
524
525
526
 
# File 'lib/rbi/rbs_printer.rb', line 520

def visit_visibility(node)
  print_blank_line_before(node)
  print_loc(node)
  visit_all(node.comments)

  printl(node.visibility.to_s)
end

#visit_visibility_group(node) ⇒ Object 



636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/rbi/rbs_printer.rb', line 636

def visit_visibility_group(node)
  self.in_visibility_group = true
  if node.visibility.public?
    printn unless previous_node.nil?
  else
    visit(node.visibility)
    printn
  end
  visit_all(node.nodes)
  self.in_visibility_group = false
end