Class: RBS::Prototype::RBI
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Helpers
|
|
Inherits: | Object |
Defined in: | lib/rbs/prototype/rbi.rb |
Class Method Summary
- .new ⇒ RBI constructor
Instance Attribute Summary
Instance Method Summary
- #call_node?(node, name:, receiver: -> (node) { node.type == :CONST && node.children[0] == :T }, args: -> (node) { true }) ⇒ Boolean
- #const_to_name(node)
- #current_module
- #current_module!
- #current_namespace
- #each_arg(array, &block)
- #each_child(node)
- #join_comments(nodes, comments)
- #method_type(args_node, type_node, variables:, overloads:)
- #nested_name(name)
- #node_to_hash(node)
- #parse(string)
- #parse_params(args_node, args, method_type, variables:, overloads:)
- #pop_sig
- #proc_type?(type_node) ⇒ Boolean
- #process(node, outer: [], comments:)
- #push_class(name, super_class, comment:)
- #push_module(name, comment:)
- #push_sig(node)
- #type_of(type_node, variables:)
- #type_of0(type_node, variables:)
Helpers
- Included
#any_node?, | |
#args_from_node | NOTE: args_node may be a nil by a bug bugs.ruby-lang.org/issues/17495. |
#block_from_body, #each_child, #each_node, #keyword_hash?, #symbol_literal_node?, #untyped |
Constructor Details
.new ⇒ RBI
# File 'lib/rbs/prototype/rbi.rb', line 12
def initialize @decls = [] @modules = [] end
Instance Attribute Details
#decls (readonly)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 8
attr_reader :decls
#last_sig (readonly)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 10
attr_reader :last_sig
#modules (readonly)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 9
attr_reader :modules
Instance Method Details
#call_node?(node, name:, receiver: -> (node) { node.type == :CONST && node.children[0] == :T }, args: -> (node) { true }) ⇒ Boolean
# File 'lib/rbs/prototype/rbi.rb', line 557
def call_node?(node, name:, receiver: -> (node) { node.type == :CONST && node.children[0] == :T }, args: -> (node) { true }) node.type == :CALL && receiver[node.children[0]] && name == node.children[1] && args[node.children[2]] end
#const_to_name(node)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 561
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 type_name = TypeName.new(name: node.children[1], namespace: namespace) case type_name.to_s when "T::Array" BuiltinNames::Array.name when "T::Hash" BuiltinNames::Hash.name when "T::Range" BuiltinNames::Range.name when "T::Enumerator" BuiltinNames::Enumerator.name when "T::Enumerable" BuiltinNames::Enumerable.name when "T::Set" BuiltinNames::Set.name else type_name end when :COLON3 TypeName.new(name: node.children[0], namespace: Namespace.root) else raise "Unexpected node type: #{node.type}" end end
#current_module
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 92
def current_module modules.last end
#current_module!
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 96
def current_module! current_module or raise end
#current_namespace
[ GitHub ]#each_arg(array, &block)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 597
def each_arg(array, &block) if block_given? if array&.type == :ARRAY || array&.type == :LIST array.children.each do |arg| if arg yield arg end end end else enum_for :each_arg, array end end
#each_child(node)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 611
def each_child(node) node.children.each do |child| if child.is_a?(RubyVM::AbstractSyntaxTree::Node) yield child end end end
#join_comments(nodes, comments)
[ GitHub ]#method_type(args_node, type_node, variables:, overloads:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 281
def method_type(args_node, type_node, variables:, overloads:) if type_node if type_node.type == :CALL method_type = method_type(args_node, type_node.children[0], variables: variables, overloads: overloads) or raise else method_type = MethodType.new( type: Types::Function.empty(Types::Bases::Any.new(location: nil)), block: nil, location: nil, type_params: [] ) end name, args = case type_node.type when :CALL [ type_node.children[1], type_node.children[2] ] when :FCALL, :VCALL [ type_node.children[0], type_node.children[1] ] end case name when :returns return_type = each_arg(args).to_a[0] method_type.update(type: method_type.type.with_return_type(type_of(return_type, variables: variables))) when :params if args_node parse_params(args_node, args, method_type, variables: variables, overloads: overloads) else vars = (node_to_hash(each_arg(args).to_a[0]) || {}).transform_values {|value| type_of(value, variables: variables) } required_positionals = vars.map do |name, type| Types::Function::Param.new(name: name, type: type) end if method_type.type.is_a?(RBS::Types::Function) method_type.update(type: method_type.type.update(required_positionals: required_positionals)) else method_type end end when :type_parameters type_params = [] each_arg args do |node| if name = symbol_literal_node?(node) type_params << name end end method_type.update(type_params: type_params) when :void method_type.update(type: method_type.type.with_return_type(Types::Bases::Void.new(location: nil))) when :proc method_type else method_type end end end
#nested_name(name)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 44
def nested_name(name) (current_namespace + const_to_name(name).to_namespace).to_type_name.relative! end
#node_to_hash(node)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 619
def node_to_hash(node) if node&.type == :HASH # @type var hash: Hash[Symbol, untyped] hash = {} each_arg(node.children[0]).each_slice(2) do |var, type| var or raise if (name = symbol_literal_node?(var)) && type hash[name] = type end end hash end end
#parse(string)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 18
def parse(string) comments = Ripper.lex(string).yield_self do |tokens| tokens.each.with_object({}) do |token, hash| # @type var hash: Hash[Integer, AST::Comment] if token[1] == :on_comment line = token[0][0] body = token[2][2..-1] or raise body = "\n" if body.empty? comment = AST::Comment.new(string: body, location: nil) if (prev_comment = hash.delete(line - 1)) 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), comments: comments end
#parse_params(args_node, args, method_type, variables:, overloads:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 347
def parse_params(args_node, args, method_type, variables:, overloads:) vars = (node_to_hash(each_arg(args).to_a[0]) || {}).transform_values {|value| type_of(value, variables: variables) } # @type var required_positionals: Array[Types::Function::Param] required_positionals = [] # @type var optional_positionals: Array[Types::Function::Param] optional_positionals = [] # @type var rest_positionals: Types::Function::Param? rest_positionals = nil # @type var trailing_positionals: Array[Types::Function::Param] trailing_positionals = [] # @type var required_keywords: Hash[Symbol, Types::Function::Param] required_keywords = {} # @type var optional_keywords: Hash[Symbol, Types::Function::Param] optional_keywords = {} # @type var rest_keywords: Types::Function::Param? rest_keywords = nil var_names = args_node.children[0] pre_num, _pre_init, opt, _first_post, post_num, _post_init, rest, kw, kwrest, block = args_node.children[1].children pre_num.times.each do |i| name = var_names[i] type = vars[name] || Types::Bases::Any.new(location: nil) required_positionals << Types::Function::Param.new(type: type, name: name) end index = pre_num while opt name = var_names[index] if (type = vars[name]) optional_positionals << Types::Function::Param.new(type: type, name: name) end index += 1 opt = opt.children[1] end if rest name = var_names[index] if (type = vars[name]) rest_positionals = Types::Function::Param.new(type: type, name: name) end index += 1 end post_num.times do |i| name = var_names[i+index] if (type = vars[name]) trailing_positionals << Types::Function::Param.new(type: type, name: name) end index += 1 end while kw name, value = kw.children[0].children if (type = vars[name]) if value optional_keywords[name] = Types::Function::Param.new(type: type, name: name) else required_keywords[name] = Types::Function::Param.new(type: type, name: name) end end kw = kw.children[1] end if kwrest name = kwrest.children[0] if (type = vars[name]) rest_keywords = Types::Function::Param.new(type: type, name: name) end end method_block = nil if block if (type = vars[block]) if type.is_a?(Types::Proc) method_block = Types::Block.new(required: true, type: type.type, self_type: nil) elsif type.is_a?(Types::Bases::Any) method_block = Types::Block.new( required: true, type: Types::Function.empty(Types::Bases::Any.new(location: nil)), self_type: nil ) # Handle an optional block like `T.nilable(T.proc.void)`. elsif type.is_a?(Types::Optional) && (proc_type = type.type).is_a?(Types::Proc) method_block = Types::Block.new(required: false, type: proc_type.type, self_type: nil) else STDERR.puts "Unexpected block type: #{type}" PP.pp args_node, STDERR method_block = Types::Block.new( required: true, type: Types::Function.empty(Types::Bases::Any.new(location: nil)), self_type: nil ) end else if overloads == 1 method_block = Types::Block.new( required: false, type: Types::Function.empty(Types::Bases::Any.new(location: nil)), self_type: nil ) end end end if method_type.type.is_a?(Types::Function) method_type.update( type: method_type.type.update( required_positionals: required_positionals, optional_positionals: optional_positionals, rest_positionals: rest_positionals, trailing_positionals: trailing_positionals, required_keywords: required_keywords, optional_keywords: optional_keywords, rest_keywords: rest_keywords ), block: method_block ) else method_type end end
#pop_sig
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 108
def pop_sig @last_sig.tap do @last_sig = nil end end
#proc_type?(type_node) ⇒ Boolean
# File 'lib/rbs/prototype/rbi.rb', line 549
def proc_type?(type_node) if call_node?(type_node, name: :proc) true else type_node.type == :CALL && proc_type?(type_node.children[0]) end end
#process(node, outer: [], comments:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 119
def process(node, outer: [], comments:) case node.type when :CLASS comment = comments[node.first_lineno - 1] push_class node.children[0], node.children[1], comment: comment do process node.children[2], outer: outer + [node], comments: comments end when :MODULE comment = comments[node.first_lineno - 1] push_module node.children[0], comment: comment do process node.children[1], outer: outer + [node], comments: comments end when :FCALL case node.children[0] when :include each_arg node.children[1] do |arg| if arg.type == :CONST || arg.type == :COLON2 || arg.type == :COLON3 name = const_to_name(arg) include_member = AST::Members::Include.new( name: name, args: [], annotations: [], location: nil, comment: nil ) current_module!.members << include_member end end when :extend each_arg node.children[1] do |arg| if arg.type == :CONST || arg.type == :COLON2 name = const_to_name(arg) unless name.to_s == "T::Generic" || name.to_s == "T::Sig" member = AST::Members::Extend.new( name: name, args: [], annotations: [], location: nil, comment: nil ) current_module!.members << member end end end when :sig out = outer.last or raise push_sig out.children.last.children.last when :alias_method new, old = each_arg(node.children[1]).map {|x| x.children[0] } current_module!.members << AST::Members::Alias.new( new_name: new, old_name: old, location: nil, annotations: [], kind: :instance, comment: nil ) end when :DEFS sigs = pop_sig if sigs comment = join_comments(sigs, comments) args = node.children[2] types = sigs.map {|sig| method_type(args, sig, variables: current_module!.type_params, overloads: sigs.size) }.compact current_module!.members << AST::Members::MethodDefinition.new( name: node.children[1], location: nil, annotations: [], overloads: types.map {|type| AST::Members::MethodDefinition::Overload.new(annotations: [], method_type: type) }, kind: :singleton, comment: comment, overloading: false, visibility: nil ) end when :DEFN sigs = pop_sig if sigs comment = join_comments(sigs, comments) args = node.children[1] types = sigs.map {|sig| method_type(args, sig, variables: current_module!.type_params, overloads: sigs.size) }.compact current_module!.members << AST::Members::MethodDefinition.new( name: node.children[0], location: nil, annotations: [], overloads: types.map {|type| AST::Members::MethodDefinition::Overload.new(annotations: [], method_type: type) }, kind: :instance, comment: comment, overloading: false, visibility: nil ) end when :CDECL if (send = node.children.last) && send.type == :FCALL && send.children[0] == :type_member unless each_arg(send.children[1]).any? {|node| node.type == :HASH && each_arg(node.children[0]).each_slice(2).any? {|a, _| symbol_literal_node?(a) == :fixed } } # @type var variance: AST::TypeParam::variance? if (a0 = each_arg(send.children[1]).to_a[0]) && (v = symbol_literal_node?(a0)) variance = case v when :out :covariant when :in :contravariant end end current_module!.type_params << AST::TypeParam.new( name: node.children[0], variance: variance || :invariant, location: nil, upper_bound: nil, default_type: nil ) end else name = node.children[0].yield_self do |n| if n.is_a?(Symbol) TypeName.new(namespace: current_namespace, name: n) else const_to_name(n) end end value_node = node.children.last type = if value_node && value_node.type == :CALL && value_node.children[1] == :let type_node = each_arg(value_node.children[2]).to_a[1] type_of type_node, variables: current_module&.type_params || [] else Types::Bases::Any.new(location: nil) end decls << AST::Declarations::Constant.new( name: name, type: type, location: nil, comment: nil ) end when :ALIAS current_module!.members << AST::Members::Alias.new( new_name: node.children[0].children[0], old_name: node.children[1].children[0], location: nil, annotations: [], kind: :instance, comment: nil ) else each_child node do |child| process child, outer: outer + [node], comments: comments end end end
#push_class(name, super_class, comment:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 54
def push_class(name, super_class, comment:) class_decl = AST::Declarations::Class.new( name: nested_name(name), super_class: super_class && AST::Declarations::Class::Super.new(name: const_to_name(super_class), args: [], location: nil), type_params: [], members: [], annotations: [], location: nil, comment: comment ) modules << class_decl decls << class_decl yield ensure modules.pop end
#push_module(name, comment:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 73
def push_module(name, comment:) module_decl = AST::Declarations::Module.new( name: nested_name(name), type_params: [], members: [], annotations: [], location: nil, self_types: [], comment: comment ) modules << module_decl decls << module_decl yield ensure modules.pop end
#push_sig(node)
[ GitHub ]#type_of(type_node, variables:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 472
def type_of(type_node, variables:) type = type_of0(type_node, variables: variables) case when type.is_a?(Types::ClassInstance) && type.name.name == BuiltinNames::BasicObject.name.name Types::Bases::Any.new(location: nil) when type.is_a?(Types::ClassInstance) && type.name.to_s == "T::Boolean" Types::Bases::Bool.new(location: nil) else type end end
#type_of0(type_node, variables:)
[ GitHub ]# File 'lib/rbs/prototype/rbi.rb', line 485
def type_of0(type_node, variables:) case when type_node.type == :CONST if variables.include?(type_node.children[0]) Types::Variable.new(name: type_node.children[0], location: nil) else Types::ClassInstance.new(name: const_to_name(type_node), args: [], location: nil) end when type_node.type == :COLON2 || type_node.type == :COLON3 Types::ClassInstance.new(name: const_to_name(type_node), args: [], location: nil) when call_node?(type_node, name: :[], receiver: -> (_) { true }) # The type_node represents a type application type = type_of(type_node.children[0], variables: variables) type.is_a?(Types::ClassInstance) or raise each_arg(type_node.children[2]) do |arg| type.args << type_of(arg, variables: variables) end type when call_node?(type_node, name: :type_parameter) name = each_arg(type_node.children[2]).to_a[0].children[0] Types::Variable.new(name: name, location: nil) when call_node?(type_node, name: :any) types = each_arg(type_node.children[2]).to_a.map {|node| type_of(node, variables: variables) } Types::Union.new(types: types, location: nil) when call_node?(type_node, name: :all) types = each_arg(type_node.children[2]).to_a.map {|node| type_of(node, variables: variables) } Types::Intersection.new(types: types, location: nil) when call_node?(type_node, name: :untyped) Types::Bases::Any.new(location: nil) when call_node?(type_node, name: :nilable) type = type_of each_arg(type_node.children[2]).to_a[0], variables: variables Types::Optional.new(type: type, location: nil) when call_node?(type_node, name: :self_type) Types::Bases::Self.new(location: nil) when call_node?(type_node, name: :attached_class) Types::Bases::Instance.new(location: nil) when call_node?(type_node, name: :noreturn) Types::Bases::Bottom.new(location: nil) when call_node?(type_node, name: :class_of) type = type_of each_arg(type_node.children[2]).to_a[0], variables: variables case type when Types::ClassInstance Types::ClassSingleton.new(name: type.name, location: nil) else STDERR.puts "Unexpected type for `class_of`: #{type}" Types::Bases::Any.new(location: nil) end when type_node.type == :ARRAY, type_node.type == :LIST types = each_arg(type_node).map {|node| type_of(node, variables: variables) } Types::Tuple.new(types: types, location: nil) else if proc_type?(type_node) method_type = method_type(nil, type_node, variables: variables, overloads: 1) or raise Types::Proc.new(type: method_type.type, block: nil, location: nil, self_type: nil) else STDERR.puts "Unexpected type_node:" PP.pp type_node, STDERR Types::Bases::Any.new(location: nil) end end end