Class: RBS::Prototype::Runtime
- Inherits:
-
Object
- Object
- RBS::Prototype::Runtime
- Defined in:
- lib/rbs/prototype/runtime.rb,
lib/rbs/prototype/runtime/helpers.rb,
lib/rbs/prototype/runtime/reflection.rb,
lib/rbs/prototype/runtime/value_object_generator.rb
Defined Under Namespace
Modules: Helpers, Reflection Classes: DataGenerator, StructGenerator, ValueObjectBase
Instance Attribute Summary collapse
-
#env ⇒ Object
readonly
Returns the value of attribute env.
-
#merge ⇒ Object
readonly
Returns the value of attribute merge.
-
#outline ⇒ Object
Returns the value of attribute outline.
-
#owners_included ⇒ Object
readonly
Returns the value of attribute owners_included.
-
#patterns ⇒ Object
readonly
Returns the value of attribute patterns.
-
#todo ⇒ Object
readonly
Returns the value of attribute todo.
Instance Method Summary collapse
- #block_from_ast_of(method) ⇒ Object
- #builder ⇒ Object
- #decls ⇒ Object
-
#ensure_outer_module_declarations(mod) ⇒ Object
Generate/find outer module declarations This is broken down into another method to comply with ‘DRY` This generates/finds declarations in nested form & returns the last array of declarations.
- #generate_class(mod) ⇒ Object
- #generate_constants(mod, decls) ⇒ Object
- #generate_methods(mod, module_name, members) ⇒ Object
- #generate_mixin(mod, decl, type_name, type_name_absolute) ⇒ Object
- #generate_module(mod) ⇒ Object
- #generate_super_class(mod) ⇒ Object
-
#initialize(patterns:, env:, merge:, todo: false, owners_included: []) ⇒ Runtime
constructor
A new instance of Runtime.
- #merge_rbs(module_name, members, instance: nil, singleton: nil) ⇒ Object
- #method_type(method) ⇒ Object
- #parse(file) ⇒ Object
- #target?(const) ⇒ Boolean
- #target_method?(mod, instance: nil, singleton: nil) ⇒ Boolean
- #todo_object ⇒ Object
- #type_args(type_name) ⇒ Object
- #type_params(mod) ⇒ Object
Constructor Details
#initialize(patterns:, env:, merge:, todo: false, owners_included: []) ⇒ Runtime
Returns a new instance of Runtime.
70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/rbs/prototype/runtime.rb', line 70 def initialize(patterns:, env:, merge:, todo: false, owners_included: []) @patterns = patterns @decls = nil @modules = {} @env = env @merge = merge @owners_included = owners_included.map do |name| Object.const_get(name) end @outline = false @todo = todo end |
Instance Attribute Details
#env ⇒ Object (readonly)
Returns the value of attribute env.
64 65 66 |
# File 'lib/rbs/prototype/runtime.rb', line 64 def env @env end |
#merge ⇒ Object (readonly)
Returns the value of attribute merge.
65 66 67 |
# File 'lib/rbs/prototype/runtime.rb', line 65 def merge @merge end |
#outline ⇒ Object
Returns the value of attribute outline.
68 69 70 |
# File 'lib/rbs/prototype/runtime.rb', line 68 def outline @outline end |
#owners_included ⇒ Object (readonly)
Returns the value of attribute owners_included.
67 68 69 |
# File 'lib/rbs/prototype/runtime.rb', line 67 def owners_included @owners_included end |
#patterns ⇒ Object (readonly)
Returns the value of attribute patterns.
63 64 65 |
# File 'lib/rbs/prototype/runtime.rb', line 63 def patterns @patterns end |
#todo ⇒ Object (readonly)
Returns the value of attribute todo.
66 67 68 |
# File 'lib/rbs/prototype/runtime.rb', line 66 def todo @todo end |
Instance Method Details
#block_from_ast_of(method) ⇒ Object
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'lib/rbs/prototype/runtime.rb', line 652 def block_from_ast_of(method) return nil if RUBY_VERSION < '3.1' begin ast = RubyVM::AbstractSyntaxTree.of(method) rescue ArgumentError return # When the method is defined in eval end if ast && ast.type == :SCOPE block_from_body(ast) end end |
#builder ⇒ Object
100 101 102 |
# File 'lib/rbs/prototype/runtime.rb', line 100 def builder @builder ||= DefinitionBuilder.new(env: env) end |
#decls ⇒ Object
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/rbs/prototype/runtime.rb', line 108 def decls unless @decls @decls = [] @modules = ObjectSpace.each_object(Module) .map { |mod| [const_name(mod), mod] } .select { |name, _| name } .to_h @modules.select { |name, mod| target?(mod) }.sort_by { |name, _| name }.each do |_, mod| case mod when Class generate_class mod when Module generate_module mod end end end @decls or raise end |
#ensure_outer_module_declarations(mod) ⇒ Object
Generate/find outer module declarations This is broken down into another method to comply with ‘DRY` This generates/finds declarations in nested form & returns the last array of declarations
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 624 625 626 627 628 629 630 631 632 633 |
# File 'lib/rbs/prototype/runtime.rb', line 581 def ensure_outer_module_declarations(mod) # @type var outer_module_names: Array[String] *outer_module_names, _ = const_name!(mod).split(/::/) #=> parent = [A, B], mod = C # Copy the entries in ivar @decls, not .dup destination = @decls || [] #: Array[AST::Declarations::Class::member] outer_module_names&.each_with_index do |outer_module_name, i| current_name = outer_module_names.take(i+1).join('::') outer_module = @modules[current_name] outer_decl = destination.detect do |decl| case outer_module when Class decl.is_a?(AST::Declarations::Class) && decl.name.name == outer_module_name.to_sym when Module decl.is_a?(AST::Declarations::Module) && decl.name.name == outer_module_name.to_sym end end #: AST::Declarations::Class | AST::Declarations::Module | nil # Insert AST::Declarations if declarations are not added previously unless outer_decl outer_module or raise if outer_module.is_a?(Class) outer_decl = AST::Declarations::Class.new( name: to_type_name(outer_module_name), type_params: type_params(outer_module), super_class: generate_super_class(outer_module), members: [], annotations: [], location: nil, comment: nil ) else outer_decl = AST::Declarations::Module.new( name: to_type_name(outer_module_name), type_params: type_params(outer_module), self_types: [], members: [], annotations: [], location: nil, comment: nil ) end destination << outer_decl end destination = outer_decl.members end # Return the array of declarations checked out at the end destination end |
#generate_class(mod) ⇒ Object
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 |
# File 'lib/rbs/prototype/runtime.rb', line 486 def generate_class(mod) type_name_absolute = to_type_name(const_name!(mod), full_name: true).absolute! type_name = to_type_name(const_name!(mod)) outer_decls = ensure_outer_module_declarations(mod) # Check if a declaration exists for the actual module decl = outer_decls.detect do |decl| decl.is_a?(AST::Declarations::Class) && decl.name.name == only_name(mod).to_sym end #: AST::Declarations::Class? unless decl if StructGenerator.generatable?(mod) decl = StructGenerator.new(mod).build_decl elsif DataGenerator.generatable?(mod) decl = DataGenerator.new(mod).build_decl else decl = AST::Declarations::Class.new( name: to_type_name(only_name(mod)), type_params: type_params(mod), super_class: generate_super_class(mod), members: [], annotations: [], location: nil, comment: nil ) end outer_decls << decl end generate_mixin(mod, decl, type_name, type_name_absolute) unless mod < Struct || (RUBY_VERSION >= '3.2' && mod < Data) generate_methods(mod, type_name, decl.members) unless outline end generate_constants mod, decl.members end |
#generate_constants(mod, decls) ⇒ Object
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 |
# File 'lib/rbs/prototype/runtime.rb', line 424 def generate_constants(mod, decls) module_name = const_name!(mod) Reflection.constants_of(mod, false).sort.each do |name| next if todo_object&.skip_constant?(module_name: module_name, name: name) begin value = mod.const_get(name) rescue StandardError, LoadError => e RBS.logger.warn("Skipping constant #{name} of #{mod} since #{e}") next end next if Reflection.object_class(value).equal?(Class) next if Reflection.object_class(value).equal?(Module) unless Reflection.object_class(value).name RBS.logger.warn("Skipping constant #{name} #{value} of #{mod} as an instance of anonymous class") next end type = case value when true, false Types::Bases::Bool.new(location: nil) when nil Types::Optional.new( type: Types::Bases::Any.new(location: nil), location: nil ) when ARGF Types::ClassInstance.new(name: TypeName("::RBS::Unnamed::ARGFClass"), args: [], location: nil) when ENV Types::ClassInstance.new(name: TypeName("::RBS::Unnamed::ENVClass"), args: [], location: nil) else value_type_name = to_type_name(const_name!(Reflection.object_class(value)), full_name: true).absolute! args = type_args(value_type_name) Types::ClassInstance.new(name: value_type_name, args: args, location: nil) end decls << AST::Declarations::Constant.new( name: to_type_name(name.to_s), type: type, location: nil, comment: nil ) end end |
#generate_methods(mod, module_name, members) ⇒ Object
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 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 |
# File 'lib/rbs/prototype/runtime.rb', line 298 def generate_methods(mod, module_name, members) module_name_absolute = to_type_name(const_name!(mod), full_name: true).absolute! mod.singleton_methods.select {|name| target_method?(mod, singleton: name) }.sort.each do |name| method = mod.singleton_class.instance_method(name) next if todo_object&.skip_singleton_method?(module_name: module_name_absolute, method: method, accessibility: :public) if can_alias?(mod.singleton_class, method) members << AST::Members::Alias.new( new_name: method.name, old_name: method.original_name, kind: :singleton, location: nil, comment: nil, annotations: [], ) else merge_rbs(module_name, members, singleton: name) do RBS.logger.info "missing #{module_name}.#{name} #{method.source_location}" members << AST::Members::MethodDefinition.new( name: method.name, overloads: [ AST::Members::MethodDefinition::Overload.new(annotations: [], method_type: method_type(method)) ], kind: :singleton, location: nil, comment: nil, annotations: [], overloading: false, visibility: nil ) end end end public_instance_methods = mod.public_instance_methods.select {|name| target_method?(mod, instance: name) } unless public_instance_methods.empty? members << AST::Members::Public.new(location: nil) public_instance_methods.sort.each do |name| method = mod.instance_method(name) next if todo_object&.skip_instance_method?(module_name: module_name_absolute, method: method, accessibility: :public) if can_alias?(mod, method) members << AST::Members::Alias.new( new_name: method.name, old_name: method.original_name, kind: :instance, location: nil, comment: nil, annotations: [], ) else merge_rbs(module_name, members, instance: name) do RBS.logger.info "missing #{module_name}##{name} #{method.source_location}" members << AST::Members::MethodDefinition.new( name: method.name, overloads: [ AST::Members::MethodDefinition::Overload.new(annotations: [], method_type: method_type(method)) ], kind: :instance, location: nil, comment: nil, annotations: [], overloading: false, visibility: nil ) end end end end private_instance_methods = mod.private_instance_methods.select {|name| target_method?(mod, instance: name) } unless private_instance_methods.empty? added = false members << AST::Members::Private.new(location: nil) private_instance_methods.sort.each do |name| method = mod.instance_method(name) next if todo_object&.skip_instance_method?(module_name: module_name_absolute, method: method, accessibility: :private) added = true if can_alias?(mod, method) members << AST::Members::Alias.new( new_name: method.name, old_name: method.original_name, kind: :instance, location: nil, comment: nil, annotations: [], ) else merge_rbs(module_name, members, instance: name) do RBS.logger.info "missing #{module_name}##{name} #{method.source_location}" members << AST::Members::MethodDefinition.new( name: method.name, overloads: [ AST::Members::MethodDefinition::Overload.new(annotations: [], method_type: method_type(method)) ], kind: :instance, location: nil, comment: nil, annotations: [], overloading: false, visibility: nil ) end end end members.pop unless added end end |
#generate_mixin(mod, decl, type_name, type_name_absolute) ⇒ Object
563 564 565 566 567 568 569 570 571 572 573 574 575 576 |
# File 'lib/rbs/prototype/runtime.rb', line 563 def generate_mixin(mod, decl, type_name, type_name_absolute) each_mixined_module(type_name, mod) do |module_name, module_full_name, mixin_class| next if todo_object&.skip_mixin?(type_name: type_name_absolute, module_name: module_full_name, mixin_class: mixin_class) args = type_args(module_full_name) decl.members << mixin_class.new( name: module_name, args: args, location: nil, comment: nil, annotations: [] ) end end |
#generate_module(mod) ⇒ Object
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 |
# File 'lib/rbs/prototype/runtime.rb', line 525 def generate_module(mod) name = const_name(mod) unless name RBS.logger.warn("Skipping anonymous module #{mod}") return end type_name_absolute = to_type_name(name, full_name: true).absolute! type_name = to_type_name(name) outer_decls = ensure_outer_module_declarations(mod) # Check if a declaration exists for the actual class decl = outer_decls.detect do |decl| decl.is_a?(AST::Declarations::Module) && decl.name.name == only_name(mod).to_sym end #: AST::Declarations::Module? unless decl decl = AST::Declarations::Module.new( name: to_type_name(only_name(mod)), type_params: type_params(mod), self_types: [], members: [], annotations: [], location: nil, comment: nil ) outer_decls << decl end generate_mixin(mod, decl, type_name, type_name_absolute) generate_methods(mod, type_name, decl.members) unless outline generate_constants mod, decl.members end |
#generate_super_class(mod) ⇒ Object
471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/rbs/prototype/runtime.rb', line 471 def generate_super_class(mod) superclass = mod.superclass if superclass.nil? || superclass == ::Object nil elsif const_name(superclass).nil? RBS.logger.warn("Skipping anonymous superclass #{superclass} of #{mod}") nil else super_name = to_type_name(const_name!(superclass), full_name: true).absolute! super_args = type_args(super_name) AST::Declarations::Class::Super.new(name: super_name, args: super_args, location: nil) end end |
#merge_rbs(module_name, members, instance: nil, singleton: nil) ⇒ Object
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 |
# File 'lib/rbs/prototype/runtime.rb', line 239 def merge_rbs(module_name, members, instance: nil, singleton: nil) if merge if env.class_decls[module_name.absolute!] # @type var kind: AST::Members::MethodDefinition::kind case when instance method = builder.build_instance(module_name.absolute!).methods[instance] method_name = instance kind = :instance when singleton method = builder.build_singleton(module_name.absolute!).methods[singleton] method_name = singleton kind = :singleton end if method members << AST::Members::MethodDefinition.new( name: method_name, overloads: method.method_types.map {|type| AST::Members::MethodDefinition::Overload.new( annotations: [], method_type: type.update.tap do |ty| def ty.to_s location or raise location.source end end ) }, kind: kind, location: nil, comment: method.comments[0], annotations: method.annotations, overloading: false, visibility: nil ) return end end yield else yield end end |
#method_type(method) ⇒ Object
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 |
# File 'lib/rbs/prototype/runtime.rb', line 170 def method_type(method) untyped = Types::Bases::Any.new(location: nil) required_positionals = [] #: Array[Types::Function::Param] optional_positionals = [] #: Array[Types::Function::Param] rest = nil #: Types::Function::Param? trailing_positionals = [] #: Array[Types::Function::Param] required_keywords = {} #: Hash[Symbol, Types::Function::Param] optional_keywords = {} #: Hash[Symbol, Types::Function::Param] rest_keywords = nil #: Types::Function::Param? requireds = required_positionals block = nil #: Types::Block? method.parameters.each do |(kind, name)| case kind when :req requireds << Types::Function::Param.new(name: name, type: untyped) when :opt requireds = trailing_positionals optional_positionals << Types::Function::Param.new(name: name, type: untyped) when :rest requireds = trailing_positionals name = nil if name == :* # For `def f(...) end` syntax rest = Types::Function::Param.new(name: name, type: untyped) when :keyreq name or raise required_keywords[name] = Types::Function::Param.new(name: nil, type: untyped) when :key name or raise optional_keywords[name] = Types::Function::Param.new(name: nil, type: untyped) when :keyrest rest_keywords = Types::Function::Param.new(name: nil, type: untyped) when :block block = Types::Block.new( type: Types::Function.empty(untyped).update(rest_positionals: Types::Function::Param.new(name: nil, type: untyped)), required: true, self_type: nil ) end end block ||= block_from_ast_of(method) return_type = if method.name == :initialize Types::Bases::Void.new(location: nil) else untyped end method_type = Types::Function.new( required_positionals: required_positionals, optional_positionals: optional_positionals, rest_positionals: rest, trailing_positionals: trailing_positionals, required_keywords: required_keywords, optional_keywords: optional_keywords, rest_keywords: rest_keywords, return_type: return_type, ) MethodType.new( location: nil, type_params: [], type: method_type, block: block ) end |
#parse(file) ⇒ Object
104 105 106 |
# File 'lib/rbs/prototype/runtime.rb', line 104 def parse(file) require file end |
#target?(const) ⇒ Boolean
83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/rbs/prototype/runtime.rb', line 83 def target?(const) name = const_name(const) return false unless name patterns.any? do |pattern| if pattern.end_with?("*") (name || "").start_with?(pattern.chop) else name == pattern end end end |
#target_method?(mod, instance: nil, singleton: nil) ⇒ Boolean
285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/rbs/prototype/runtime.rb', line 285 def target_method?(mod, instance: nil, singleton: nil) case when instance method = mod.instance_method(instance) method.owner == mod || owners_included.any? {|m| method.owner == m } when singleton method = mod.singleton_class.instance_method(singleton) method.owner == mod.singleton_class || owners_included.any? {|m| method.owner == m.singleton_class } else raise end end |
#todo_object ⇒ Object
96 97 98 |
# File 'lib/rbs/prototype/runtime.rb', line 96 def todo_object @todo_object ||= Todo.new(builder: builder) if todo end |
#type_args(type_name) ⇒ Object
635 636 637 638 639 640 641 |
# File 'lib/rbs/prototype/runtime.rb', line 635 def type_args(type_name) if class_decl = env.class_decls.fetch(type_name.absolute!, nil) class_decl.type_params.size.times.map { Types::Bases::Any.new(location: nil) } else [] end end |
#type_params(mod) ⇒ Object
643 644 645 646 647 648 649 650 |
# File 'lib/rbs/prototype/runtime.rb', line 643 def type_params(mod) type_name = to_type_name(const_name!(mod), full_name: true) if class_decl = env.class_decls[type_name.absolute!] class_decl.type_params else [] end end |