Class: RBS::Prototype::RB
- Inherits:
-
Object
- Object
- RBS::Prototype::RB
- Defined in:
- lib/rbs/prototype/rb.rb
Defined Under Namespace
Classes: Context
Instance Attribute Summary collapse
-
#source_decls ⇒ Object
readonly
Returns the value of attribute source_decls.
-
#toplevel_members ⇒ Object
readonly
Returns the value of attribute toplevel_members.
Instance Method Summary collapse
- #any_node?(node, nodes: [], &block) ⇒ Boolean
-
#args_from_node(args_node) ⇒ Object
NOTE: args_node may be a nil by a bug bugs.ruby-lang.org/issues/17495.
- #block_from_body(node) ⇒ Object
- #const_to_name(node, context: nil) ⇒ Object
- #current_accessibility(decls, index = decls.size) ⇒ Object
- #decls ⇒ Object
- #each_child(node, &block) ⇒ Object
- #each_node(nodes) ⇒ Object
- #find_def_index_by_name(decls, name) ⇒ Object
- #function_return_type_from_body(node) ⇒ Object
- #function_type_from_body(node, def_name) ⇒ Object
-
#initialize ⇒ RB
constructor
A new instance of RB.
- #is_accessibility?(decl) ⇒ Boolean
- #keyword_hash?(node) ⇒ Boolean
- #literal_to_symbol(node) ⇒ Object
- #literal_to_type(node) ⇒ Object
- #node_type(node, default: Types::Bases::Any.new(location: nil)) ⇒ Object
- #parse(string) ⇒ Object
- #private ⇒ Object
- #process(node, decls:, comments:, context:) ⇒ Object
- #process_children(node, decls:, comments:, context:) ⇒ Object
- #public ⇒ Object
- #range_element_type(types) ⇒ Object
- #remove_unnecessary_accessibility_methods!(decls) ⇒ Object
- #types_to_union_type(types) ⇒ Object
- #untyped ⇒ Object
Constructor Details
#initialize ⇒ RB
Returns a new instance of RB.
31 32 33 |
# File 'lib/rbs/prototype/rb.rb', line 31 def initialize @source_decls = [] end |
Instance Attribute Details
#source_decls ⇒ Object (readonly)
Returns the value of attribute source_decls.
28 29 30 |
# File 'lib/rbs/prototype/rb.rb', line 28 def source_decls @source_decls end |
#toplevel_members ⇒ Object (readonly)
Returns the value of attribute toplevel_members.
29 30 31 |
# File 'lib/rbs/prototype/rb.rb', line 29 def toplevel_members @toplevel_members end |
Instance Method Details
#any_node?(node, nodes: [], &block) ⇒ Boolean
641 642 643 644 645 646 647 648 649 650 651 |
# File 'lib/rbs/prototype/rb.rb', line 641 def any_node?(node, nodes: [], &block) if yield(node) nodes << node end each_child node do |child| any_node? child, nodes: nodes, &block end nodes.empty? ? nil : nodes end |
#args_from_node(args_node) ⇒ Object
NOTE: args_node may be a nil by a bug
https://bugs.ruby-lang.org/issues/17495
627 628 629 |
# File 'lib/rbs/prototype/rb.rb', line 627 def args_from_node(args_node) args_node&.children || [0, nil, nil, nil, 0, nil, nil, nil, nil, nil] end |
#block_from_body(node) ⇒ Object
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 |
# File 'lib/rbs/prototype/rb.rb', line 564 def block_from_body(node) _, args_node, body_node = node.children _pre_num, _pre_init, _opt, _first_post, _post_num, _post_init, _rest, _kw, _kwrest, block = args_from_node(args_node) method_block = nil if block method_block = Types::Block.new( # HACK: The `block` is :& on `def m(...)` syntax. # In this case the block looks optional in most cases, so it marks optional. # In other cases, we can't determine which is required or optional, so it marks required. required: block != :&, type: Types::Function.empty(untyped) ) end if body_node if (yields = any_node?(body_node) {|n| n.type == :YIELD }) method_block = Types::Block.new( required: true, type: Types::Function.empty(untyped) ) yields.each do |yield_node| array_content = yield_node.children[0]&.children&.compact || [] positionals, keywords = if keyword_hash?(array_content.last) [array_content.take(array_content.size - 1), array_content.last] else [array_content, nil] end if (diff = positionals.size - method_block.type.required_positionals.size) > 0 diff.times do method_block.type.required_positionals << Types::Function::Param.new( type: untyped, name: nil ) end end if keywords keywords.children[0].children.each_slice(2) do |key_node, value_node| if key_node key = key_node.children[0] method_block.type.required_keywords[key] ||= Types::Function::Param.new( type: untyped, name: nil ) end end end end end end method_block end |
#const_to_name(node, context: nil) ⇒ Object
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/rbs/prototype/rb.rb', line 340 def const_to_name(node, context: nil) case node&.type when :CONST TypeName.new(name: node.children[0], namespace: Namespace.empty) when :COLON2 if node.children[0] namespace = const_to_name(node.children[0]).to_namespace else namespace = Namespace.empty end TypeName.new(name: node.children[1], namespace: namespace) when :COLON3 TypeName.new(name: node.children[0], namespace: Namespace.root) when :SELF context&.then { |c| c.namespace.to_type_name } end end |
#current_accessibility(decls, index = decls.size) ⇒ Object
697 698 699 700 |
# File 'lib/rbs/prototype/rb.rb', line 697 def current_accessibility(decls, index = decls.size) idx = decls.slice(0, index).rindex { |decl| decl == private || decl == public } (idx && decls[idx]) || public end |
#decls ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/rbs/prototype/rb.rb', line 35 def decls decls = [] top_decls, top_members = source_decls.partition {|decl| decl.is_a?(AST::Declarations::Base) } decls.push(*top_decls) unless top_members.empty? top = AST::Declarations::Class.new( name: TypeName.new(name: :Object, namespace: Namespace.empty), super_class: nil, members: top_members, annotations: [], comment: nil, location: nil, type_params: AST::Declarations::ModuleTypeParams.empty ) decls << top end decls end |
#each_child(node, &block) ⇒ Object
376 377 378 |
# File 'lib/rbs/prototype/rb.rb', line 376 def each_child(node, &block) each_node node.children, &block end |
#each_node(nodes) ⇒ Object
368 369 370 371 372 373 374 |
# File 'lib/rbs/prototype/rb.rb', line 368 def each_node(nodes) nodes.each do |child| if child.is_a?(RubyVM::AbstractSyntaxTree::Node) yield child end end end |
#find_def_index_by_name(decls, name) ⇒ Object
731 732 733 734 735 736 737 738 739 740 |
# File 'lib/rbs/prototype/rb.rb', line 731 def find_def_index_by_name(decls, name) decls.find_index do |decl| case decl when AST::Members::MethodDefinition, AST::Members::AttrReader decl.name == name when AST::Members::AttrWriter decl.name == :"#{name}=" end end end |
#function_return_type_from_body(node) ⇒ Object
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/rbs/prototype/rb.rb', line 436 def function_return_type_from_body(node) body = node.children[2] return Types::Bases::Nil.new(location: nil) unless body if body.type == :BLOCK return_stmts = any_node?(body) do |n| n.type == :RETURN end&.map do |return_node| returned_value = return_node.children[0] returned_value ? literal_to_type(returned_value) : Types::Bases::Nil.new(location: nil) end || [] last_node = body.children.last last_evaluated = last_node ? literal_to_type(last_node) : Types::Bases::Nil.new(location: nil) types_to_union_type([*return_stmts, last_evaluated]) else literal_to_type(body) end end |
#function_type_from_body(node, def_name) ⇒ Object
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 430 431 432 433 434 |
# File 'lib/rbs/prototype/rb.rb', line 380 def function_type_from_body(node, def_name) table_node, args_node, *_ = node.children pre_num, _pre_init, opt, _first_post, post_num, _post_init, rest, kw, kwrest, _block = args_from_node(args_node) return_type = if def_name == :initialize Types::Bases::Void.new(location: nil) else function_return_type_from_body(node) end fun = Types::Function.empty(return_type) table_node.take(pre_num).each do |name| fun.required_positionals << Types::Function::Param.new(name: name, type: untyped) end while opt&.type == :OPT_ARG lvasgn, opt = opt.children name = lvasgn.children[0] fun.optional_positionals << Types::Function::Param.new( name: name, type: node_type(lvasgn.children[1]) ) end if rest rest_name = rest == :* ? nil : rest # # For `def f(...) end` syntax fun = fun.update(rest_positionals: Types::Function::Param.new(name: rest_name, type: untyped)) end table_node.drop(fun.required_positionals.size + fun.optional_positionals.size + (fun.rest_positionals ? 1 : 0)).take(post_num).each do |name| fun.trailing_positionals << Types::Function::Param.new(name: name, type: untyped) end while kw lvasgn, kw = kw.children name, value = lvasgn.children case value when nil, :NODE_SPECIAL_REQUIRED_KEYWORD fun.required_keywords[name] = Types::Function::Param.new(name: name, type: untyped) when RubyVM::AbstractSyntaxTree::Node fun.optional_keywords[name] = Types::Function::Param.new(name: name, type: node_type(value)) else raise "Unexpected keyword arg value: #{value}" end end if kwrest && kwrest.children.any? fun = fun.update(rest_keywords: Types::Function::Param.new(name: kwrest.children[0], type: untyped)) end fun end |
#is_accessibility?(decl) ⇒ Boolean
727 728 729 |
# File 'lib/rbs/prototype/rb.rb', line 727 def is_accessibility?(decl) decl == public || decl == private end |
#keyword_hash?(node) ⇒ Boolean
631 632 633 634 635 636 637 638 639 |
# File 'lib/rbs/prototype/rb.rb', line 631 def keyword_hash?(node) if node if node.type == :HASH node.children[0].children.compact.each_slice(2).all? {|key, _| key.type == :LIT && key.children[0].is_a?(Symbol) } end end end |
#literal_to_symbol(node) ⇒ Object
359 360 361 362 363 364 365 366 |
# File 'lib/rbs/prototype/rb.rb', line 359 def literal_to_symbol(node) case node.type when :LIT node.children[0] if node.children[0].is_a?(Symbol) when :STR node.children[0].to_sym end end |
#literal_to_type(node) ⇒ Object
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 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 |
# File 'lib/rbs/prototype/rb.rb', line 455 def literal_to_type(node) case node.type when :STR lit = node.children[0] if lit.match?(/\A[ -~]+\z/) Types::Literal.new(literal: lit, location: nil) else BuiltinNames::String.instance_type end when :DSTR, :XSTR BuiltinNames::String.instance_type when :DSYM BuiltinNames::Symbol.instance_type when :DREGX BuiltinNames::Regexp.instance_type when :TRUE BuiltinNames::TrueClass.instance_type when :FALSE BuiltinNames::FalseClass.instance_type when :NIL Types::Bases::Nil.new(location: nil) when :LIT lit = node.children[0] case lit when Symbol if lit.match?(/\A[ -~]+\z/) Types::Literal.new(literal: lit, location: nil) else BuiltinNames::Symbol.instance_type end when Integer Types::Literal.new(literal: lit, location: nil) else type_name = TypeName.new(name: lit.class.name.to_sym, namespace: Namespace.root) Types::ClassInstance.new(name: type_name, args: [], location: nil) end when :ZLIST, :ZARRAY BuiltinNames::Array.instance_type([untyped]) when :LIST, :ARRAY elem_types = node.children.compact.map { |e| literal_to_type(e) } t = types_to_union_type(elem_types) BuiltinNames::Array.instance_type([t]) when :DOT2, :DOT3 types = node.children.map { |c| literal_to_type(c) } type = range_element_type(types) BuiltinNames::Range.instance_type([type]) when :HASH list = node.children[0] if list children = list.children children.pop else children = [] end key_types = [] value_types = [] children.each_slice(2) do |k, v| if k key_types << literal_to_type(k) value_types << literal_to_type(v) else key_types << untyped value_types << untyped end end if !key_types.empty? && key_types.all? { |t| t.is_a?(Types::Literal) } fields = key_types.map { |t| t.literal }.zip(value_types).to_h Types::Record.new(fields: fields, location: nil) else key_type = types_to_union_type(key_types) value_type = types_to_union_type(value_types) BuiltinNames::Hash.instance_type([key_type, value_type]) end else untyped end end |
#node_type(node, default: Types::Bases::Any.new(location: nil)) ⇒ Object
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 |
# File 'lib/rbs/prototype/rb.rb', line 653 def node_type(node, default: Types::Bases::Any.new(location: nil)) case node.type when :LIT case node.children[0] when Symbol BuiltinNames::Symbol.instance_type when Integer BuiltinNames::Integer.instance_type when Float BuiltinNames::Float.instance_type else default end when :STR, :DSTR BuiltinNames::String.instance_type when :NIL # This type is technical non-sense, but may help practically. Types::Optional.new( type: Types::Bases::Any.new(location: nil), location: nil ) when :TRUE, :FALSE Types::Bases::Bool.new(location: nil) when :ARRAY, :LIST BuiltinNames::Array.instance_type(default) when :HASH BuiltinNames::Hash.instance_type(default, default) else default end end |
#parse(string) ⇒ Object
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/rbs/prototype/rb.rb', line 58 def parse(string) comments = Ripper.lex(string).yield_self do |tokens| tokens.each.with_object({}) do |token, hash| if token[1] == :on_comment line = token[0][0] body = token[2][2..-1] body = "\n" if body.empty? comment = AST::Comment.new(string: body, location: nil) if (prev_comment = hash[line - 1]) hash[line - 1] = nil hash[line] = AST::Comment.new(string: prev_comment.string + comment.string, location: nil) else hash[line] = comment end end end end process RubyVM::AbstractSyntaxTree.parse(string), decls: source_decls, comments: comments, context: Context.initial end |
#private ⇒ Object
689 690 691 |
# File 'lib/rbs/prototype/rb.rb', line 689 def private @private ||= AST::Members::Private.new(location: nil) end |
#process(node, decls:, comments:, context:) ⇒ Object
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 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 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 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 |
# File 'lib/rbs/prototype/rb.rb', line 82 def process(node, decls:, comments:, context:) case node.type when :CLASS class_name, super_class, *class_body = node.children kls = AST::Declarations::Class.new( name: const_to_name(class_name), super_class: super_class && AST::Declarations::Class::Super.new(name: const_to_name(super_class), args: [], location: nil), type_params: AST::Declarations::ModuleTypeParams.empty, members: [], annotations: [], location: nil, comment: comments[node.first_lineno - 1] ) decls.push kls new_ctx = Context.initial(namespace: context.namespace + kls.name.to_namespace) each_node class_body do |child| process child, decls: kls.members, comments: comments, context: new_ctx end remove_unnecessary_accessibility_methods! kls.members when :MODULE module_name, *module_body = node.children mod = AST::Declarations::Module.new( name: const_to_name(module_name), type_params: AST::Declarations::ModuleTypeParams.empty, self_types: [], members: [], annotations: [], location: nil, comment: comments[node.first_lineno - 1] ) decls.push mod new_ctx = Context.initial(namespace: context.namespace + mod.name.to_namespace) each_node module_body do |child| process child, decls: mod.members, comments: comments, context: new_ctx end remove_unnecessary_accessibility_methods! mod.members when :SCLASS this, body = node.children if this.type != :SELF RBS.logger.warn "`class <<` syntax with not-self may be compiled to incorrect code: #{this}" end accessibility = current_accessibility(decls) ctx = Context.initial.tap { |ctx| ctx.singleton = true } process_children(body, decls: decls, comments: comments, context: ctx) decls << accessibility when :DEFN, :DEFS if node.type == :DEFN def_name, def_body = node.children kind = context.method_kind else _, def_name, def_body = node.children kind = :singleton end types = [ MethodType.new( type_params: [], type: function_type_from_body(def_body, def_name), block: block_from_body(def_body), location: nil ) ] member = AST::Members::MethodDefinition.new( name: def_name, location: nil, annotations: [], types: types, kind: kind, comment: comments[node.first_lineno - 1], overload: false ) decls.push member unless decls.include?(member) when :ALIAS new_name, old_name = node.children.map { |c| literal_to_symbol(c) } member = AST::Members::Alias.new( new_name: new_name, old_name: old_name, kind: context.singleton ? :singleton : :instance, annotations: [], location: nil, comment: comments[node.first_lineno - 1], ) decls.push member unless decls.include?(member) when :FCALL, :VCALL # Inside method definition cannot reach here. args = node.children[1]&.children || [] case node.children[0] when :include args.each do |arg| if (name = const_to_name(arg)) decls << AST::Members::Include.new( name: name, args: [], annotations: [], location: nil, comment: comments[node.first_lineno - 1] ) end end when :extend args.each do |arg| if (name = const_to_name(arg, context: context)) decls << AST::Members::Extend.new( name: name, args: [], annotations: [], location: nil, comment: comments[node.first_lineno - 1] ) end end when :attr_reader args.each do |arg| if arg && (name = literal_to_symbol(arg)) decls << AST::Members::AttrReader.new( name: name, ivar_name: nil, type: Types::Bases::Any.new(location: nil), kind: context.attribute_kind, location: nil, comment: comments[node.first_lineno - 1], annotations: [] ) end end when :attr_accessor args.each do |arg| if arg && (name = literal_to_symbol(arg)) decls << AST::Members::AttrAccessor.new( name: name, ivar_name: nil, type: Types::Bases::Any.new(location: nil), kind: context.attribute_kind, location: nil, comment: comments[node.first_lineno - 1], annotations: [] ) end end when :attr_writer args.each do |arg| if arg && (name = literal_to_symbol(arg)) decls << AST::Members::AttrWriter.new( name: name, ivar_name: nil, type: Types::Bases::Any.new(location: nil), kind: context.attribute_kind, location: nil, comment: comments[node.first_lineno - 1], annotations: [] ) end end when :alias_method if args[0] && args[1] && (new_name = literal_to_symbol(args[0])) && (old_name = literal_to_symbol(args[1])) decls << AST::Members::Alias.new( new_name: new_name, old_name: old_name, kind: context.singleton ? :singleton : :instance, annotations: [], location: nil, comment: comments[node.first_lineno - 1], ) end when :module_function if args.empty? context.module_function = true else module_func_context = context.dup.tap { |ctx| ctx.module_function = true } args.each do |arg| if arg && (name = literal_to_symbol(arg)) if i = find_def_index_by_name(decls, name) decls[i] = decls[i].update(kind: :singleton_instance) end elsif arg process arg, decls: decls, comments: comments, context: module_func_context end end end when :public, :private accessibility = __send__(node.children[0]) if args.empty? decls << accessibility else args.each do |arg| if arg && (name = literal_to_symbol(arg)) if i = find_def_index_by_name(decls, name) current = current_accessibility(decls, i) if current != accessibility decls.insert(i + 1, current) decls.insert(i, accessibility) end end end end # For `private def foo` syntax current = current_accessibility(decls) decls << accessibility process_children(node, decls: decls, comments: comments, context: context) decls << current end else process_children(node, decls: decls, comments: comments, context: context) end when :ITER method_name = node.children.first.children.first case method_name when :refine # ignore else process_children(node, decls: decls, comments: comments, context: context) end when :CDECL const_name = case when node.children[0].is_a?(Symbol) TypeName.new(name: node.children[0], namespace: Namespace.empty) else const_to_name(node.children[0]) end decls << AST::Declarations::Constant.new( name: const_name, type: node_type(node.children.last), location: nil, comment: comments[node.first_lineno - 1] ) else process_children(node, decls: decls, comments: comments, context: context) end end |
#process_children(node, decls:, comments:, context:) ⇒ Object
334 335 336 337 338 |
# File 'lib/rbs/prototype/rb.rb', line 334 def process_children(node, decls:, comments:, context:) each_child node do |child| process child, decls: decls, comments: comments, context: context end end |
#public ⇒ Object
693 694 695 |
# File 'lib/rbs/prototype/rb.rb', line 693 def public @public ||= AST::Members::Public.new(location: nil) end |
#range_element_type(types) ⇒ Object
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 |
# File 'lib/rbs/prototype/rb.rb', line 544 def range_element_type(types) types = types.reject { |t| t == untyped } return untyped if types.empty? types = types.map do |t| if t.is_a?(Types::Literal) type_name = TypeName.new(name: t.literal.class.name.to_sym, namespace: Namespace.root) Types::ClassInstance.new(name: type_name, args: [], location: nil) else t end end.uniq if types.size == 1 types.first else untyped end end |
#remove_unnecessary_accessibility_methods!(decls) ⇒ Object
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 |
# File 'lib/rbs/prototype/rb.rb', line 702 def remove_unnecessary_accessibility_methods!(decls) current = public idx = 0 loop do decl = decls[idx] or break if current == decl decls.delete_at(idx) next end if 0 < idx && is_accessibility?(decls[idx - 1]) && is_accessibility?(decl) decls.delete_at(idx - 1) idx -= 1 current = current_accessibility(decls, idx) next end current = decl if is_accessibility?(decl) idx += 1 end decls.pop while decls.last && is_accessibility?(decls.last) end |