Class: RBS::Prototype::RB
- Inherits:
-
Object
- Object
- RBS::Prototype::RB
- Includes:
- Helpers
- Defined in:
- lib/rbs/prototype/rb.rb
Constant Summary collapse
- Context =
_ = Struct.new(:module_function, :singleton, :namespace, keyword_init: true) do # @implements Context def self.initial(namespace: Namespace.root) self.new(module_function: false, singleton: false, namespace: namespace) end def method_kind if singleton :singleton elsif module_function :singleton_instance else :instance end end def attribute_kind if singleton :singleton else :instance end end end
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
- #block_type(node) ⇒ Object
- #body_type(node) ⇒ Object
- #const_to_name(node, context:) ⇒ Object
- #const_to_name!(node) ⇒ Object
- #current_accessibility(decls, index = decls.size) ⇒ Object
- #decls ⇒ Object
- #find_def_index_by_name(decls, name) ⇒ Object
- #function_return_type_from_body(node) ⇒ Object
- #function_type_from_body(node, def_name) ⇒ Object
- #if_unless_type(node) ⇒ Object
-
#initialize ⇒ RB
constructor
A new instance of RB.
- #is_accessibility?(decl) ⇒ Boolean
- #literal_to_symbol(node) ⇒ Object
- #literal_to_type(node) ⇒ Object
- #param_type(node, default: Types::Bases::Any.new(location: nil)) ⇒ Object (also: #node_type)
- #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
Constructor Details
#initialize ⇒ RB
Returns a new instance of RB.
37 38 39 |
# File 'lib/rbs/prototype/rb.rb', line 37 def initialize @source_decls = [] end |
Instance Attribute Details
#source_decls ⇒ Object (readonly)
Returns the value of attribute source_decls.
34 35 36 |
# File 'lib/rbs/prototype/rb.rb', line 34 def source_decls @source_decls end |
#toplevel_members ⇒ Object (readonly)
Returns the value of attribute toplevel_members.
35 36 37 |
# File 'lib/rbs/prototype/rb.rb', line 35 def toplevel_members @toplevel_members end |
Instance Method Details
#block_type(node) ⇒ Object
510 511 512 513 514 515 516 517 518 519 520 521 522 |
# File 'lib/rbs/prototype/rb.rb', line 510 def block_type(node) raise unless node.type == :BLOCK return_stmts = any_node?(node) 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 = node.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]) end |
#body_type(node) ⇒ Object
490 491 492 493 494 495 496 497 498 499 500 501 |
# File 'lib/rbs/prototype/rb.rb', line 490 def body_type(node) return Types::Bases::Nil.new(location: nil) unless node case node.type when :IF, :UNLESS if_unless_type(node) when :BLOCK block_type(node) else literal_to_type(node) end end |
#const_to_name(node, context:) ⇒ Object
409 410 411 412 413 414 415 416 417 418 |
# File 'lib/rbs/prototype/rb.rb', line 409 def const_to_name(node, context:) if node case node.type when :SELF context.namespace.to_type_name when :CONST, :COLON2, :COLON3 const_to_name!(node) end end end |
#const_to_name!(node) ⇒ Object
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'lib/rbs/prototype/rb.rb', line 390 def const_to_name!(node) 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) else raise end end |
#current_accessibility(decls, index = decls.size) ⇒ Object
688 689 690 691 692 693 694 695 696 |
# File 'lib/rbs/prototype/rb.rb', line 688 def current_accessibility(decls, index = decls.size) slice = decls.slice(0, index) or raise idx = slice.rindex { |decl| decl == private || decl == public } if idx _ = decls[idx] else public end end |
#decls ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/rbs/prototype/rb.rb', line 41 def decls # @type var decls: Array[AST::Declarations::t] decls = [] # @type var top_decls: Array[AST::Declarations::t] # @type var top_members: Array[AST::Members::t] 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: [] ) decls << top end decls end |
#find_def_index_by_name(decls, name) ⇒ Object
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 |
# File 'lib/rbs/prototype/rb.rb', line 728 def find_def_index_by_name(decls, name) index = 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 if index [ index, _ = decls[index] ] end end |
#function_return_type_from_body(node) ⇒ Object
485 486 487 488 |
# File 'lib/rbs/prototype/rb.rb', line 485 def function_return_type_from_body(node) body = node.children[2] body_type(body) end |
#function_type_from_body(node, def_name) ⇒ Object
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 475 476 477 478 479 480 481 482 483 |
# File 'lib/rbs/prototype/rb.rb', line 429 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: param_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: nil, type: untyped) when RubyVM::AbstractSyntaxTree::Node fun.optional_keywords[name] = Types::Function::Param.new(name: nil, type: param_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 |
#if_unless_type(node) ⇒ Object
503 504 505 506 507 508 |
# File 'lib/rbs/prototype/rb.rb', line 503 def if_unless_type(node) raise unless node.type == :IF || node.type == :UNLESS _exp_node, true_node, false_node = node.children types_to_union_type([body_type(true_node), body_type(false_node)]) end |
#is_accessibility?(decl) ⇒ Boolean
724 725 726 |
# File 'lib/rbs/prototype/rb.rb', line 724 def is_accessibility?(decl) decl == public || decl == private end |
#literal_to_symbol(node) ⇒ Object
420 421 422 423 424 425 426 427 |
# File 'lib/rbs/prototype/rb.rb', line 420 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
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 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 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 |
# File 'lib/rbs/prototype/rb.rb', line 524 def literal_to_type(node) case node.type when :STR lit = node.children[0] if lit.ascii_only? 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 Types::Literal.new(literal: true, location: nil) when :FALSE Types::Literal.new(literal: false, location: nil) when :NIL Types::Bases::Nil.new(location: nil) when :LIT lit = node.children[0] case lit when Symbol if lit.to_s.ascii_only? 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 when :SELF Types::Bases::Self.new(location: nil) when :CALL receiver, method_name, * = node.children case method_name when :freeze, :tap, :itself, :dup, :clone, :taint, :untaint, :extend literal_to_type(receiver) else untyped end else untyped end end |
#param_type(node, default: Types::Bases::Any.new(location: nil)) ⇒ Object Also known as: node_type
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 |
# File 'lib/rbs/prototype/rb.rb', line 645 def param_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
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/rbs/prototype/rb.rb', line 67 def parse(string) # @type var comments: Hash[Integer, AST::Comment] comments = Ripper.lex(string).yield_self do |tokens| code_lines = {} tokens.each.with_object({}) do |token, hash| case token[1] when :on_sp, :on_ignored_nl # skip when :on_comment line = token[0][0] # skip like `module Foo # :nodoc:` next if code_lines[line] body = token[2][2..-1] or raise 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 else code_lines[token[0][0]] = true end end end process RubyVM::AbstractSyntaxTree.parse(string), decls: source_decls, comments: comments, context: Context.initial end |
#private ⇒ Object
680 681 682 |
# File 'lib/rbs/prototype/rb.rb', line 680 def private @private ||= AST::Members::Private.new(location: nil) end |
#process(node, decls:, comments:, context:) ⇒ Object
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 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 |
# File 'lib/rbs/prototype/rb.rb', line 100 def process(node, decls:, comments:, context:) case node.type when :CLASS class_name, super_class_node, *class_body = node.children super_class_name = const_to_name(super_class_node, context: context) super_class = if super_class_name AST::Declarations::Class::Super.new(name: super_class_name, args: [], location: nil) else # Give up detect super class e.g. `class Foo < Struct.new(:bar)` nil end kls = AST::Declarations::Class.new( name: const_to_name!(class_name), super_class: super_class, type_params: [], 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: [], 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 # @type var kind: Context::method_kind 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: [], overloads: types.map {|type| AST::Members::MethodDefinition::Overload.new(annotations: [], method_type: type )}, kind: kind, comment: comments[node.first_lineno - 1], overloading: false, visibility: nil ) 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, context: context)) decls << AST::Members::Include.new( name: name, args: [], annotations: [], location: nil, comment: comments[node.first_lineno - 1] ) end end when :prepend args.each do |arg| if (name = const_to_name(arg, context: context)) decls << AST::Members::Prepend.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, defn = find_def_index_by_name(decls, name)) if defn.is_a?(AST::Members::MethodDefinition) decls[i] = defn.update(kind: :singleton_instance) end 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 value_node = node.children.last type = if value_node.nil? # Give up type prediction when node is MASGN. Types::Bases::Any.new(location: nil) else literal_to_type(value_node) end decls << AST::Declarations::Constant.new( name: const_name, type: type, 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
384 385 386 387 388 |
# File 'lib/rbs/prototype/rb.rb', line 384 def process_children(node, decls:, comments:, context:) each_child node do |child| process child, decls: decls, comments: comments, context: context end end |
#public ⇒ Object
684 685 686 |
# File 'lib/rbs/prototype/rb.rb', line 684 def public @public ||= AST::Members::Public.new(location: nil) end |
#range_element_type(types) ⇒ Object
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'lib/rbs/prototype/rb.rb', line 625 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 or raise else untyped end end |
#remove_unnecessary_accessibility_methods!(decls) ⇒ Object
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'lib/rbs/prototype/rb.rb', line 698 def remove_unnecessary_accessibility_methods!(decls) # @type var current: decl 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 || raise) end |