Class: RBI::RBSPrinter
Defined Under Namespace
Classes: Error
Instance Attribute Summary collapse
-
#current_indent ⇒ Object
readonly
: Integer.
-
#in_visibility_group ⇒ Object
: bool.
-
#max_line_length ⇒ Object
readonly
: Integer?.
-
#positional_names ⇒ Object
: bool.
-
#previous_node ⇒ Object
readonly
: Node?.
-
#print_locs ⇒ Object
: bool.
Instance Method Summary collapse
-
#dedent ⇒ Object
: -> void.
-
#indent ⇒ Object
: -> void.
-
#initialize(out: $stdout, indent: 0, print_locs: false, positional_names: true, max_line_length: nil) ⇒ RBSPrinter
constructor
: ( | ?out: (IO | StringIO), | ?indent: Integer, | ?print_locs: bool, | ?positional_names: bool, | ?max_line_length: Integer? | ) -> void.
-
#print(string) ⇒ Object
Print a string without indentation nor ‘n` at the end.
-
#print_attr_sig(node, sig) ⇒ Object
: (RBI::Attr node, Sig sig) -> void.
-
#print_method_sig(node, sig) ⇒ Object
: (RBI::Method node, Sig sig) -> void.
-
#print_method_sig_inline(node, sig) ⇒ Object
: (RBI::Method node, Sig sig) -> void.
-
#print_method_sig_multiline(node, sig) ⇒ Object
: (RBI::Method node, Sig sig) -> void.
-
#printl(string) ⇒ Object
Print a string with indentation and ‘n` at the end.
-
#printn(string = nil) ⇒ Object
Print a string without indentation but with a ‘n` at the end.
-
#printt(string = nil) ⇒ Object
Print a string with indentation but without a ‘n` at the end.
-
#visit_all(nodes) ⇒ Object
: (Array nodes) -> void.
-
#visit_arg(node) ⇒ Object
: (Arg node) -> void.
-
#visit_attr(node) ⇒ Object
: (Attr node) -> void.
-
#visit_attr_accessor(node) ⇒ Object
: (AttrAccessor node) -> void.
-
#visit_attr_reader(node) ⇒ Object
: (AttrReader node) -> void.
-
#visit_attr_writer(node) ⇒ Object
: (AttrWriter node) -> void.
-
#visit_blank_line(node) ⇒ Object
: (BlankLine node) -> void.
-
#visit_block_param(node) ⇒ Object
: (BlockParam node) -> void.
-
#visit_class(node) ⇒ Object
: (Class node) -> void.
-
#visit_comment(node) ⇒ Object
: (Comment node) -> void.
-
#visit_conflict_tree(node) ⇒ Object
: (ConflictTree node) -> void.
-
#visit_const(node) ⇒ Object
: (Const node) -> void.
-
#visit_extend(node) ⇒ Object
: (Extend node) -> void.
-
#visit_file(file) ⇒ Object
: (File file) -> void.
-
#visit_group(node) ⇒ Object
: (Group node) -> void.
-
#visit_helper(node) ⇒ Object
: (Helper node) -> void.
-
#visit_include(node) ⇒ Object
: (Include node) -> void.
-
#visit_kw_arg(node) ⇒ Object
: (KwArg node) -> void.
-
#visit_kw_opt_param(node) ⇒ Object
: (KwOptParam node) -> void.
-
#visit_kw_param(node) ⇒ Object
: (KwParam node) -> void.
-
#visit_kw_rest_param(node) ⇒ Object
: (KwRestParam node) -> void.
-
#visit_method(node) ⇒ Object
: (Method node) -> void.
-
#visit_mixes_in_class_methods(node) ⇒ Object
: (MixesInClassMethods node) -> void.
-
#visit_mixin(node) ⇒ Object
: (Mixin node) -> void.
-
#visit_module(node) ⇒ Object
: (Module node) -> void.
-
#visit_opt_param(node) ⇒ Object
: (OptParam node) -> void.
-
#visit_private(node) ⇒ Object
: (Private node) -> void.
-
#visit_protected(node) ⇒ Object
: (Protected node) -> void.
-
#visit_public(node) ⇒ Object
: (Public node) -> void.
-
#visit_req_param(node) ⇒ Object
: (ReqParam node) -> void.
-
#visit_requires_ancestor(node) ⇒ Object
: (RequiresAncestor node) -> void.
-
#visit_rest_param(node) ⇒ Object
: (RestParam node) -> void.
-
#visit_scope(node) ⇒ Object
: (Scope node) -> void.
-
#visit_scope_body(node) ⇒ Object
: (Scope node) -> void.
-
#visit_scope_conflict(node) ⇒ Object
: (ScopeConflict node) -> void.
-
#visit_scope_header(node) ⇒ Object
: (Scope node) -> void.
-
#visit_send(node) ⇒ Object
: (Send node) -> void.
-
#visit_sig(node) ⇒ Object
: (Sig node) -> void.
-
#visit_sig_param(node) ⇒ Object
: (SigParam node) -> void.
-
#visit_singleton_class(node) ⇒ Object
: (SingletonClass node) -> void.
-
#visit_struct(node) ⇒ Object
: (Struct node) -> void.
-
#visit_tenum(node) ⇒ Object
: (TEnum node) -> void.
-
#visit_tenum_block(node) ⇒ Object
: (TEnumBlock node) -> void.
-
#visit_tenum_value(node) ⇒ Object
: (TEnumValue node) -> void.
-
#visit_tree(node) ⇒ Object
: (Tree node) -> void.
-
#visit_tstruct(node) ⇒ Object
: (TStruct node) -> void.
-
#visit_tstruct_const(node) ⇒ Object
: (TStructConst node) -> void.
-
#visit_tstruct_prop(node) ⇒ Object
: (TStructProp node) -> void.
-
#visit_type_member(node) ⇒ Object
: (TypeMember node) -> void.
-
#visit_visibility(node) ⇒ Object
: (Visibility node) -> void.
-
#visit_visibility_group(node) ⇒ Object
: (VisibilityGroup node) -> void.
Methods inherited from Visitor
Constructor Details
#initialize(out: $stdout, indent: 0, print_locs: false, positional_names: true, max_line_length: nil) ⇒ RBSPrinter
: ( | ?out: (IO | StringIO), | ?indent: Integer, | ?print_locs: bool, | ?positional_names: bool, | ?max_line_length: Integer? | ) -> void
30 31 32 33 34 35 36 37 38 39 |
# File 'lib/rbi/rbs_printer.rb', line 30 def initialize(out: $stdout, indent: 0, print_locs: false, positional_names: true, max_line_length: nil) super() @out = out @current_indent = indent @print_locs = print_locs @in_visibility_group = false #: bool @previous_node = nil #: Node? @positional_names = positional_names #: bool @max_line_length = max_line_length #: Integer? end |
Instance Attribute Details
#current_indent ⇒ Object (readonly)
: Integer
15 16 17 |
# File 'lib/rbi/rbs_printer.rb', line 15 def current_indent @current_indent end |
#in_visibility_group ⇒ Object
: bool
9 10 11 |
# File 'lib/rbi/rbs_printer.rb', line 9 def in_visibility_group @in_visibility_group end |
#max_line_length ⇒ Object (readonly)
: Integer?
21 22 23 |
# File 'lib/rbi/rbs_printer.rb', line 21 def max_line_length @max_line_length end |
#positional_names ⇒ Object
: bool
18 19 20 |
# File 'lib/rbi/rbs_printer.rb', line 18 def positional_names @positional_names end |
#previous_node ⇒ Object (readonly)
: Node?
12 13 14 |
# File 'lib/rbi/rbs_printer.rb', line 12 def previous_node @previous_node end |
#print_locs ⇒ Object
: bool
9 10 11 |
# File 'lib/rbi/rbs_printer.rb', line 9 def print_locs @print_locs end |
Instance Method Details
#dedent ⇒ Object
: -> void
49 50 51 |
# File 'lib/rbi/rbs_printer.rb', line 49 def dedent @current_indent -= 2 end |
#indent ⇒ Object
: -> void
44 45 46 |
# File 'lib/rbi/rbs_printer.rb', line 44 def indent @current_indent += 2 end |
#print(string) ⇒ Object
Print a string without indentation nor ‘n` at the end. : (String string) -> void
55 56 57 |
# File 'lib/rbi/rbs_printer.rb', line 55 def print(string) @out.print(string) end |
#print_attr_sig(node, sig) ⇒ Object
: (RBI::Attr node, Sig sig) -> void
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/rbi/rbs_printer.rb', line 302 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
: (RBI::Method node, Sig sig) -> void
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/rbi/rbs_printer.rb', line 398 def print_method_sig(node, sig) old_out = @out new_out = StringIO.new @out = new_out print_method_sig_inline(node, sig) @out = old_out max_line_length = @max_line_length if max_line_length.nil? || new_out.string.size <= max_line_length print(new_out.string) else print_method_sig_multiline(node, sig) end end |
#print_method_sig_inline(node, sig) ⇒ Object
: (RBI::Method node, Sig sig) -> void
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
# File 'lib/rbi/rbs_printer.rb', line 415 def print_method_sig_inline(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 |
#print_method_sig_multiline(node, sig) ⇒ Object
: (RBI::Method node, Sig sig) -> void
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'lib/rbi/rbs_printer.rb', line 477 def print_method_sig_multiline(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? printl("(") indent sig_params.each_with_index do |param, index| printt print_sig_param(node, param) print(",") if index < sig_params.size - 1 printn end dedent printt(") ") 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
Print a string with indentation and ‘n` at the end. : (String string) -> void
75 76 77 78 |
# File 'lib/rbi/rbs_printer.rb', line 75 def printl(string) printt printn(string) end |
#printn(string = nil) ⇒ Object
Print a string without indentation but with a ‘n` at the end. : (?String? string) -> void
61 62 63 64 |
# File 'lib/rbi/rbs_printer.rb', line 61 def printn(string = nil) print(string) if string print("\n") end |
#printt(string = nil) ⇒ Object
Print a string with indentation but without a ‘n` at the end. : (?String? string) -> void
68 69 70 71 |
# File 'lib/rbi/rbs_printer.rb', line 68 def printt(string = nil) print(" " * @current_indent) print(string) if string end |
#visit_all(nodes) ⇒ Object
: (Array nodes) -> void
82 83 84 85 86 87 88 89 90 |
# File 'lib/rbi/rbs_printer.rb', line 82 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
: (Arg node) -> void
678 679 680 |
# File 'lib/rbi/rbs_printer.rb', line 678 def visit_arg(node) # no-op end |
#visit_attr(node) ⇒ Object
: (Attr node) -> void
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/rbi/rbs_printer.rb', line 270 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
: (AttrAccessor node) -> void
253 254 255 |
# File 'lib/rbi/rbs_printer.rb', line 253 def visit_attr_accessor(node) visit_attr(node) end |
#visit_attr_reader(node) ⇒ Object
: (AttrReader node) -> void
259 260 261 |
# File 'lib/rbi/rbs_printer.rb', line 259 def visit_attr_reader(node) visit_attr(node) end |
#visit_attr_writer(node) ⇒ Object
: (AttrWriter node) -> void
265 266 267 |
# File 'lib/rbi/rbs_printer.rb', line 265 def visit_attr_writer(node) visit_attr(node) end |
#visit_blank_line(node) ⇒ Object
: (BlankLine node) -> void
124 125 126 |
# File 'lib/rbi/rbs_printer.rb', line 124 def visit_blank_line(node) printn end |
#visit_block_param(node) ⇒ Object
: (BlockParam node) -> void
610 611 612 |
# File 'lib/rbi/rbs_printer.rb', line 610 def visit_block_param(node) print("{ (*untyped) -> untyped } ") end |
#visit_class(node) ⇒ Object
: (Class node) -> void
144 145 146 |
# File 'lib/rbi/rbs_printer.rb', line 144 def visit_class(node) visit_scope(node) end |
#visit_comment(node) ⇒ Object
: (Comment node) -> void
107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/rbi/rbs_printer.rb', line 107 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
: (ConflictTree node) -> void
814 815 816 817 818 819 820 |
# File 'lib/rbi/rbs_printer.rb', line 814 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
: (Const node) -> void
237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/rbi/rbs_printer.rb', line 237 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
: (Extend node) -> void
622 623 624 |
# File 'lib/rbi/rbs_printer.rb', line 622 def visit_extend(node) visit_mixin(node) end |
#visit_file(file) ⇒ Object
: (File file) -> void
94 95 96 97 98 99 100 101 102 103 |
# File 'lib/rbi/rbs_printer.rb', line 94 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
: (Group node) -> void
787 788 789 790 |
# File 'lib/rbi/rbs_printer.rb', line 787 def visit_group(node) printn unless previous_node.nil? visit_all(node.nodes) end |
#visit_helper(node) ⇒ Object
: (Helper node) -> void
775 776 777 |
# File 'lib/rbi/rbs_printer.rb', line 775 def visit_helper(node) # no-op, we already show them in the scope header end |
#visit_include(node) ⇒ Object
: (Include node) -> void
616 617 618 |
# File 'lib/rbi/rbs_printer.rb', line 616 def visit_include(node) visit_mixin(node) end |
#visit_kw_arg(node) ⇒ Object
: (KwArg node) -> void
684 685 686 |
# File 'lib/rbi/rbs_printer.rb', line 684 def visit_kw_arg(node) # no-op end |
#visit_kw_opt_param(node) ⇒ Object
: (KwOptParam node) -> void
598 599 600 |
# File 'lib/rbi/rbs_printer.rb', line 598 def visit_kw_opt_param(node) print("?#{node.name}: untyped") end |
#visit_kw_param(node) ⇒ Object
: (KwParam node) -> void
592 593 594 |
# File 'lib/rbi/rbs_printer.rb', line 592 def visit_kw_param(node) print("#{node.name}: untyped") end |
#visit_kw_rest_param(node) ⇒ Object
: (KwRestParam node) -> void
604 605 606 |
# File 'lib/rbi/rbs_printer.rb', line 604 def visit_kw_rest_param(node) print("**#{node.name}: untyped") end |
#visit_method(node) ⇒ Object
: (Method node) -> void
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 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 |
# File 'lib/rbi/rbs_printer.rb', line 325 def visit_method(node) print_blank_line_before(node) visit_all(node.comments) if node.sigs.any?(&:without_runtime) printl("# @without_runtime") end 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, first, #: as !nil ) 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
: (MixesInClassMethods node) -> void
781 782 783 |
# File 'lib/rbi/rbs_printer.rb', line 781 def visit_mixes_in_class_methods(node) visit_mixin(node) end |
#visit_mixin(node) ⇒ Object
: (Mixin node) -> void
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 |
# File 'lib/rbi/rbs_printer.rb', line 627 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
: (Module node) -> void
138 139 140 |
# File 'lib/rbi/rbs_printer.rb', line 138 def visit_module(node) visit_scope(node) end |
#visit_opt_param(node) ⇒ Object
: (OptParam node) -> void
572 573 574 575 576 577 578 |
# File 'lib/rbi/rbs_printer.rb', line 572 def visit_opt_param(node) if @positional_names print("?untyped #{node.name}") else print("?untyped") end end |
#visit_private(node) ⇒ Object
: (Private node) -> void
657 658 659 |
# File 'lib/rbi/rbs_printer.rb', line 657 def visit_private(node) visit_visibility(node) end |
#visit_protected(node) ⇒ Object
: (Protected node) -> void
651 652 653 |
# File 'lib/rbi/rbs_printer.rb', line 651 def visit_protected(node) # no-op, `protected` is not supported in RBS end |
#visit_public(node) ⇒ Object
: (Public node) -> void
645 646 647 |
# File 'lib/rbi/rbs_printer.rb', line 645 def visit_public(node) visit_visibility(node) end |
#visit_req_param(node) ⇒ Object
: (ReqParam node) -> void
562 563 564 565 566 567 568 |
# File 'lib/rbi/rbs_printer.rb', line 562 def visit_req_param(node) if @positional_names print("untyped #{node.name}") else print("untyped") end end |
#visit_requires_ancestor(node) ⇒ Object
: (RequiresAncestor node) -> void
808 809 810 |
# File 'lib/rbi/rbs_printer.rb', line 808 def visit_requires_ancestor(node) # no-op, we already show them in the scope header end |
#visit_rest_param(node) ⇒ Object
: (RestParam node) -> void
582 583 584 585 586 587 588 |
# File 'lib/rbi/rbs_printer.rb', line 582 def visit_rest_param(node) if @positional_names print("*untyped #{node.name}") else print("*untyped") end end |
#visit_scope(node) ⇒ Object
: (Scope node) -> void
161 162 163 164 165 166 167 168 |
# File 'lib/rbi/rbs_printer.rb', line 161 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
: (Scope node) -> void
224 225 226 227 228 229 230 231 232 233 |
# File 'lib/rbi/rbs_printer.rb', line 224 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
: (ScopeConflict node) -> void
824 825 826 827 828 829 830 831 832 833 834 835 |
# File 'lib/rbi/rbs_printer.rb', line 824 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
: (Scope node) -> void
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/rbi/rbs_printer.rb', line 171 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
: (Send node) -> void
672 673 674 |
# File 'lib/rbi/rbs_printer.rb', line 672 def visit_send(node) # no-op, arbitrary sends are not supported in RBS end |
#visit_sig(node) ⇒ Object
: (Sig node) -> void
543 544 545 546 547 548 549 550 551 552 553 |
# File 'lib/rbi/rbs_printer.rb', line 543 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
: (SigParam node) -> void
556 557 558 |
# File 'lib/rbi/rbs_printer.rb', line 556 def visit_sig_param(node) print(parse_type(node.type).rbs_string) end |
#visit_singleton_class(node) ⇒ Object
: (SingletonClass node) -> void
156 157 158 |
# File 'lib/rbi/rbs_printer.rb', line 156 def visit_singleton_class(node) visit_scope(node) end |
#visit_struct(node) ⇒ Object
: (Struct node) -> void
150 151 152 |
# File 'lib/rbi/rbs_printer.rb', line 150 def visit_struct(node) visit_scope(node) end |
#visit_tenum(node) ⇒ Object
: (TEnum node) -> void
741 742 743 |
# File 'lib/rbi/rbs_printer.rb', line 741 def visit_tenum(node) visit_scope(node) end |
#visit_tenum_block(node) ⇒ Object
: (TEnumBlock node) -> void
747 748 749 |
# File 'lib/rbi/rbs_printer.rb', line 747 def visit_tenum_block(node) visit_all(node.nodes) end |
#visit_tenum_value(node) ⇒ Object
: (TEnumValue node) -> void
753 754 755 756 757 758 759 760 761 762 763 764 765 |
# File 'lib/rbi/rbs_printer.rb', line 753 def visit_tenum_value(node) print_blank_line_before(node) print_loc(node) visit_all(node.comments) t_enum = node.parent_scope&.parent_scope if t_enum.is_a?(TEnum) printl("#{node.name}: #{t_enum.name}") else printl("#{node.name}: untyped") end end |
#visit_tree(node) ⇒ Object
: (Tree node) -> void
130 131 132 133 134 |
# File 'lib/rbi/rbs_printer.rb', line 130 def visit_tree(node) visit_all(node.comments) printn if !node.comments.empty? && !node.empty? visit_all(node.nodes) end |
#visit_tstruct(node) ⇒ Object
: (TStruct node) -> void
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
# File 'lib/rbi/rbs_printer.rb', line 690 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
: (TStructConst node) -> void
725 726 727 728 729 |
# File 'lib/rbi/rbs_printer.rb', line 725 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
: (TStructProp node) -> void
733 734 735 736 737 |
# File 'lib/rbi/rbs_printer.rb', line 733 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
: (TypeMember node) -> void
769 770 771 |
# File 'lib/rbi/rbs_printer.rb', line 769 def visit_type_member(node) # no-op, we already show them in the scope header end |
#visit_visibility(node) ⇒ Object
: (Visibility node) -> void
662 663 664 665 666 667 668 |
# File 'lib/rbi/rbs_printer.rb', line 662 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
: (VisibilityGroup node) -> void
794 795 796 797 798 799 800 801 802 803 804 |
# File 'lib/rbi/rbs_printer.rb', line 794 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 |