class RBS::Environment
Attributes
Class declarations
Constant declarations
Global declarations
Interface declarations
Array[Source::t]
Array of source objects loaded in the environment
Type alias declarations
Public Class Methods
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 69 def self.from_loader(loader) self.new.tap do |env| loader.load(env: env) end end
Construct an environment from EnvironmentLoader
() → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 48 def initialize @sources = [] @class_decls = {} @interface_decls = {} @type_alias_decls = {} @constant_decls = {} @global_decls = {} @class_alias_decls = {} @normalize_module_name_cache = {} end
Public Instance Methods
(Resolver::TypeNameResolver, UseMap? map, Types::t, context: Resolver::context) → Types::t
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 981 def absolute_type(resolver, map, type, context:) type.map_type_name do |name, _, _| absolute_type_name(resolver, map, name, context: context) end end
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 976 def absolute_type_name(resolver, map, type_name, context:) type_name = map.resolve(type_name) if map resolver.resolve(type_name, context: context) || type_name end
(Source::t) → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 455 def add_source(source) sources << source case source when Source::RBS source.declarations.each do |decl| insert_rbs_decl(decl, context: nil, namespace: Namespace.root) end when Source::Ruby source.declarations.each do |dir| insert_ruby_decl(dir, context: nil, namespace: Namespace.root) end end end
(Resolver::context, module_decl) → Resolver::context
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 568 def append_context(context, decl) if (_, last = context) last or raise [context, last + decl.name] else [nil, decl.name.absolute!] end end
() → Array[Buffer]
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 992 def buffers sources.map(&:buffer) end
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 117 def class_alias?(name) if decl = class_alias_decls[name] decl.decl.is_a?(AST::Declarations::ClassAlias) else false end end
Returns true if the type name is a class alias
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 101 def class_decl?(name) class_decls[name].is_a?(ClassEntry) end
Returns true if the type name is defined by class declaration
(TypeName, normalized: true) → ClassEntry?
(TypeName, ?normalized: bool) → (ClassEntry | ClassAliasEntry | nil)
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 125 def class_entry(type_name, normalized: false) case entry = constant_entry(type_name, normalized: normalized || false) when ClassEntry, ClassAliasEntry entry end end
Returns the entry for the class name
Returns nil when:
-
The type name is not found
-
The type name is not a class
It normalizes when normalized: true is given – returns ClassEntry or nil.
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 97 def constant_decl?(name) constant_decls.key?(name) end
Returns true if the type name is defined by constant declaration
(TypeName, normalized: true) → (ClassEntry | ModuleEntry | ConstantEntry | nil)
(TypeName, ?normalized: bool) → (ClassEntry | ClassAliasEntry | ModuleEntry | ModuleAliasEntry | ConstantEntry | nil)
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 167 def constant_entry(type_name, normalized: false) if normalized if normalized_name = normalize_module_name?(type_name) class_decls.fetch(normalized_name, nil) else # The type_name may be declared with constant declaration unless type_name.namespace.empty? parent = type_name.namespace.to_type_name normalized_parent = normalize_module_name?(parent) or return constant_name = TypeName.new(name: type_name.name, namespace: normalized_parent.to_namespace) constant_decls.fetch(constant_name, nil) end end else class_decls.fetch(type_name, nil) || class_alias_decls.fetch(type_name, nil) || constant_decls.fetch(type_name, nil) end end
Returns the entry for the type name
The entry is one of ClassEntry, ModuleEntry, ConstantEntry, ClassAliasEntry, or ModuleAliasEntry. When normalized: true is given, it returns normalized entry – one of ClassEntry, ModuleEntry, or ConstantEntry.
Returns nil if not found.
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 93 def constant_name?(name) constant_decl?(name) || module_name?(name) end
Returns if a constant of the name is defined
() → Array[AST::Ruby::Declarations::t | AST::Declarations::t]
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 14 def declarations sources.flat_map(&:declarations) end
Top level declarations
() { (Source::RBS) → void } → void
() → Enumerator[Source::RBS]
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 470 def each_rbs_source(&block) if block sources.each do |source| if source.is_a?(Source::RBS) yield source end end else enum_for(:each_rbs_source) end end
() { (Source::Ruby) → void } → void
() → Enumerator[Source::Ruby]
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 482 def each_ruby_source(&block) if block sources.each do |source| if source.is_a?(Source::Ruby) yield source end end else enum_for(:each_ruby_source) end end
(Environment) → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 59 def initialize_copy(other) @sources = other.sources.dup @class_decls = other.class_decls.dup @interface_decls = other.interface_decls.dup @type_alias_decls = other.type_alias_decls.dup @constant_decls = other.constant_decls.dup @global_decls = other.global_decls.dup @class_alias_decls = other.class_alias_decls.dup end
(AST::Declarations::t, context: Resolver::context, namespace: Namespace) → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 277 def insert_rbs_decl(decl, context:, namespace:) case decl when AST::Declarations::Class, AST::Declarations::Module name = decl.name.with_prefix(namespace) if cdecl = constant_entry(name) if cdecl.is_a?(ConstantEntry) || cdecl.is_a?(ModuleAliasEntry) || cdecl.is_a?(ClassAliasEntry) raise DuplicatedDeclarationError.new(name, decl, cdecl.decl) end end unless class_decls.key?(name) case decl when AST::Declarations::Class class_decls[name] ||= ClassEntry.new(name) when AST::Declarations::Module class_decls[name] ||= ModuleEntry.new(name) end end existing_entry = class_decls[name] case when decl.is_a?(AST::Declarations::Module) && existing_entry.is_a?(ModuleEntry) existing_entry << [context, decl] when decl.is_a?(AST::Declarations::Class) && existing_entry.is_a?(ClassEntry) existing_entry << [context, decl] else raise DuplicatedDeclarationError.new(name, decl, existing_entry.primary_decl) end inner_context = [context, name] #: Resolver::context inner_namespace = name.to_namespace decl.each_decl do |d| insert_rbs_decl(d, context: inner_context, namespace: inner_namespace) end when AST::Declarations::Interface name = decl.name.with_prefix(namespace) if interface_entry = interface_decls[name] raise DuplicatedDeclarationError.new(name, decl, interface_entry.decl) end interface_decls[name] = InterfaceEntry.new(name: name, decl: decl, context: context) when AST::Declarations::TypeAlias name = decl.name.with_prefix(namespace) if entry = type_alias_decls[name] raise DuplicatedDeclarationError.new(name, decl, entry.decl) end type_alias_decls[name] = TypeAliasEntry.new(name: name, decl: decl, context: context) when AST::Declarations::Constant name = decl.name.with_prefix(namespace) if entry = constant_entry(name) case entry when ClassAliasEntry, ModuleAliasEntry, ConstantEntry raise DuplicatedDeclarationError.new(name, decl, entry.decl) when ClassEntry, ModuleEntry raise DuplicatedDeclarationError.new(name, decl, *entry.each_decl.to_a) end end constant_decls[name] = ConstantEntry.new(name: name, decl: decl, context: context) when AST::Declarations::Global if entry = global_decls[decl.name] raise DuplicatedDeclarationError.new(decl.name, decl, entry.decl) end global_decls[decl.name] = GlobalEntry.new(name: decl.name, decl: decl, context: context) when AST::Declarations::ClassAlias, AST::Declarations::ModuleAlias name = decl.new_name.with_prefix(namespace) if entry = constant_entry(name) case entry when ClassAliasEntry, ModuleAliasEntry, ConstantEntry raise DuplicatedDeclarationError.new(name, decl, entry.decl) when ClassEntry, ModuleEntry raise DuplicatedDeclarationError.new(name, decl, *entry.each_decl.to_a) end end case decl when AST::Declarations::ClassAlias class_alias_decls[name] = ClassAliasEntry.new(name: name, decl: decl, context: context) when AST::Declarations::ModuleAlias class_alias_decls[name] = ModuleAliasEntry.new(name: name, decl: decl, context: context) end end end
Insert a declaration into the environment
(AST::Ruby::Declarations::t, context: Resolver::context, namespace: Namespace) → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 374 def insert_ruby_decl(decl, context:, namespace:) case decl when AST::Ruby::Declarations::ClassDecl name = decl.class_name.with_prefix(namespace) if entry = constant_entry(name) if entry.is_a?(ConstantEntry) || entry.is_a?(ModuleAliasEntry) || entry.is_a?(ClassAliasEntry) raise DuplicatedDeclarationError.new(name, decl, entry.decl) end if entry.is_a?(ModuleEntry) raise DuplicatedDeclarationError.new(name, decl, *entry.each_decl.to_a) end else entry = class_decls[name] = ClassEntry.new(name) end entry << [context, decl] inner_context = [context, name] #: Resolver::context decl.each_decl do |member| insert_ruby_decl(member, context: inner_context, namespace: name.to_namespace) end when AST::Ruby::Declarations::ModuleDecl name = decl.module_name.with_prefix(namespace) if entry = constant_entry(name) if entry.is_a?(ConstantEntry) || entry.is_a?(ModuleAliasEntry) || entry.is_a?(ClassAliasEntry) raise DuplicatedDeclarationError.new(name, decl, entry.decl) end if entry.is_a?(ClassEntry) raise DuplicatedDeclarationError.new(name, decl, *entry.each_decl.to_a) end else entry = class_decls[name] = ModuleEntry.new(name) end entry << [context, decl] inner_context = [context, name] #: Resolver::context decl.each_decl do |member| insert_ruby_decl(member, context: inner_context, namespace: name.to_namespace) end when AST::Ruby::Declarations::ConstantDecl name = decl.constant_name.with_prefix(namespace) if entry = constant_entry(name) case entry when ClassAliasEntry, ModuleAliasEntry, ConstantEntry raise DuplicatedDeclarationError.new(name, decl, entry.decl) when ClassEntry, ModuleEntry raise DuplicatedDeclarationError.new(name, decl, *entry.each_decl.to_a) end end constant_decls[name] = ConstantEntry.new(name: name, decl: decl, context: context) when AST::Ruby::Declarations::ClassModuleAliasDecl name = decl.new_name.with_prefix(namespace) if entry = constant_entry(name) case entry when ClassAliasEntry, ModuleAliasEntry, ConstantEntry raise DuplicatedDeclarationError.new(name, decl, entry.decl) when ClassEntry, ModuleEntry raise DuplicatedDeclarationError.new(name, decl, *entry.each_decl.to_a) end end case decl.annotation when AST::Ruby::Annotations::ClassAliasAnnotation class_alias_decls[name] = ClassAliasEntry.new(name: name, decl: decl, context: context) when AST::Ruby::Annotations::ModuleAliasAnnotation class_alias_decls[name] = ModuleAliasEntry.new(name: name, decl: decl, context: context) end else raise "Unknown Ruby declaration type: #{decl.class}" end end
Insert a declaration into the environment
() → String
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 987 def inspect ivars = %i[@sources @class_decls @class_alias_decls @interface_decls @type_alias_decls @constant_decls @global_decls] "\#<RBS::Environment #{ivars.map { |iv| "#{iv}=(#{instance_variable_get(iv).size} items)"}.join(' ')}>" end
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 75 def interface_name?(name) interface_decls.key?(name) end
Returns true if an interface with the type name is defined
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 109 def module_alias?(name) if decl = class_alias_decls[name] decl.decl.is_a?(AST::Declarations::ModuleAlias) else false end end
Returns true if the type name is a module alias
(TypeName, normalized: true) → (ClassEntry | ModuleEntry | nil)
(TypeName, ?normalized: bool) → (ClassEntry | ClassAliasEntry | ModuleEntry | ModuleAliasEntry | nil)
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 154 def module_class_entry(type_name, normalized: false) entry = constant_entry(type_name, normalized: normalized || false) if entry.is_a?(ConstantEntry) nil else entry end end
Returns ClassEntry or ModuleEntry if the class/module definition is found
Normalizes when normalized: true is given.
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 105 def module_decl?(name) class_decls[name].is_a?(ModuleEntry) end
Returns true if the type name is defined by module declaration
(TypeName, normalized: true) → ModuleEntry?
(TypeName, ?normalized: bool) → (ModuleEntry | ModuleAliasEntry | nil)
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 132 def module_entry(type_name, normalized: false) case entry = constant_entry(type_name, normalized: normalized || false) when ModuleEntry, ModuleAliasEntry entry end end
Returns the entry for the module name
Returns nil when:
-
The type name is not found
-
The type name is not a module
It normalizes when normalized: true is given – returns ModuleEntry or nil.
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 83 def module_name?(name) class_decls.key?(name) || class_alias_decls.key?(name) end
Returns true if a module or class with the type name is defined
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 269 def normalize_module_name(name) normalize_module_name?(name) || name end
Returns the original module name that is defined with module/class declaration
-
Raises an error if given type name is not module/class
-
Calls
#absolute!for relative module names -
Returns the name itself if the name cannot be normalized to a class/module
Note that this method assumes the declarations have resolved type names.
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 273 def normalize_module_name!(name) normalize_module_name?(name) or raise "Module name `#{name}` cannot be normalized" end
Returns the original module name that is defined with module/class declaration
-
Raises an error if given type name is not a module/class
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 241 def normalize_module_name?(name) raise "Class/module name is expected: #{name}" unless name.class? name = name.absolute! unless name.absolute? original_name = name if @normalize_module_name_cache.key?(original_name) return @normalize_module_name_cache[original_name] end if alias_entry = class_alias_decls.fetch(name, nil) unless alias_entry.decl.old_name.absolute? # Having relative old_name means the type name resolution was failed. # Run TypeNameResolver for failure reason resolver = Resolver::TypeNameResolver.build(self) name = resolver.resolve_namespace(name, context: nil) @normalize_module_name_cache[original_name] = name return name end name = alias_entry.decl.old_name end if class_decls.key?(name) @normalize_module_name_cache[original_name] = name end end
Returns the original module name that is defined with module declaration
-
Calls
#absolute!for relative module names -
Returns
nilif the rhs name cannot be found -
Returns
falseif the name is cyclic
Note that this method assumes the declarations have resolved type names.
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 219 def normalize_type_name(name) normalize_type_name?(name) || name end
Returns a normalized module/class name or a type name with a normalized namespace
-
Calls
#absolute!for relative module names -
Returns the typename itself if the name cannot be normalized
Note that this method assumes the declarations have resolved type names.
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 206 def normalize_type_name!(name) result = normalize_type_name?(name) case result when TypeName result when false raise "Type name `#{name}` cannot be normalized because it's a cyclic definition" when nil raise "Type name `#{name}` cannot be normalized because of unknown type name in the path" end end
Normalize the type name or raises an error
Note that this method assumes the declarations have resolved type names.
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 187 def normalize_type_name?(name) return normalize_module_name?(name) if name.class? type_name = unless name.namespace.empty? parent = name.namespace.to_type_name parent = normalize_module_name?(parent) return parent unless parent TypeName.new(namespace: parent.to_namespace, name: name.name) else name end if type_name?(type_name) type_name end end
Returns a normalized module/class name or a type name with a normalized namespace
-
Calls
#absolute!for relative module names -
Returns
nilif the typename cannot be found -
Returns
falseif the name is cyclic
Note that this method assumes the declarations have resolved type names.
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 139 def normalized_class_entry(type_name) if name = normalize_module_name?(type_name) case entry = class_entry(name) when ClassEntry, nil entry when ClassAliasEntry raise end end end
Returns ClassEntry if the class definition is found, normalized in case of alias
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 163 def normalized_module_class_entry(type_name) module_class_entry(type_name, normalized: true) end
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 150 def normalized_module_entry(type_name) module_entry(type_name, normalized: true) end
Returns ModuleEntry if the module definition is found, normalized in case of alias
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 236 def normalized_type_name!(name) normalized_type_name?(name) or raise "Normalized type name is expected but given `#{name}`" name end
Returns the given type name if it’s normalized, or raises
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 223 def normalized_type_name?(type_name) case when type_name.interface? interface_decls.key?(type_name) when type_name.class? class_decls.key?(type_name) when type_name.alias? type_alias_decls.key?(type_name) else false end end
Returns true if given type name is normalized
(Resolver::TypeNameResolver resolver, UseMap map, AST::Declarations::t decl, context: Resolver::context, prefix: Namespace) → AST::Declarations::t
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 577 def resolve_declaration(resolver, map, decl, context:, prefix:) if decl.is_a?(AST::Declarations::Global) # @type var decl: AST::Declarations::Global return AST::Declarations::Global.new( name: decl.name, type: absolute_type(resolver, map, decl.type, context: nil), location: decl.location, comment: decl.comment, annotations: decl.annotations ) end case decl when AST::Declarations::Class outer_context = context inner_context = append_context(outer_context, decl) prefix_ = prefix + decl.name.to_namespace AST::Declarations::Class.new( name: decl.name.with_prefix(prefix), type_params: resolve_type_params(resolver, map, decl.type_params, context: inner_context), super_class: decl.super_class&.yield_self do |super_class| AST::Declarations::Class::Super.new( name: absolute_type_name(resolver, map, super_class.name, context: outer_context), args: super_class.args.map {|type| absolute_type(resolver, map, type, context: outer_context) }, location: super_class.location ) end, members: decl.members.map do |member| case member when AST::Members::Base resolve_member(resolver, map, member, context: inner_context) when AST::Declarations::Base resolve_declaration( resolver, map, member, context: inner_context, prefix: prefix_ ) else raise end end, location: decl.location, annotations: decl.annotations, comment: decl.comment ) when AST::Declarations::Module outer_context = context inner_context = append_context(outer_context, decl) prefix_ = prefix + decl.name.to_namespace AST::Declarations::Module.new( name: decl.name.with_prefix(prefix), type_params: resolve_type_params(resolver, map, decl.type_params, context: inner_context), self_types: decl.self_types.map do |module_self| AST::Declarations::Module::Self.new( name: absolute_type_name(resolver, map, module_self.name, context: inner_context), args: module_self.args.map {|type| absolute_type(resolver, map, type, context: inner_context) }, location: module_self.location ) end, members: decl.members.map do |member| case member when AST::Members::Base resolve_member(resolver, map, member, context: inner_context) when AST::Declarations::Base resolve_declaration( resolver, map, member, context: inner_context, prefix: prefix_ ) else raise end end, location: decl.location, annotations: decl.annotations, comment: decl.comment ) when AST::Declarations::Interface AST::Declarations::Interface.new( name: decl.name.with_prefix(prefix), type_params: resolve_type_params(resolver, map, decl.type_params, context: context), members: decl.members.map do |member| resolve_member(resolver, map, member, context: context) end, comment: decl.comment, location: decl.location, annotations: decl.annotations ) when AST::Declarations::TypeAlias AST::Declarations::TypeAlias.new( name: decl.name.with_prefix(prefix), type_params: resolve_type_params(resolver, map, decl.type_params, context: context), type: absolute_type(resolver, map, decl.type, context: context), location: decl.location, annotations: decl.annotations, comment: decl.comment ) when AST::Declarations::Constant AST::Declarations::Constant.new( name: decl.name.with_prefix(prefix), type: absolute_type(resolver, map, decl.type, context: context), location: decl.location, comment: decl.comment, annotations: decl.annotations ) when AST::Declarations::ClassAlias AST::Declarations::ClassAlias.new( new_name: decl.new_name.with_prefix(prefix), old_name: absolute_type_name(resolver, map, decl.old_name, context: context), location: decl.location, comment: decl.comment, annotations: decl.annotations ) when AST::Declarations::ModuleAlias AST::Declarations::ModuleAlias.new( new_name: decl.new_name.with_prefix(prefix), old_name: absolute_type_name(resolver, map, decl.old_name, context: context), location: decl.location, comment: decl.comment, annotations: decl.annotations ) end end
(Resolver::TypeNameResolver, UseMap map, AST::Members::t, context: Resolver::context) → AST::Members::t
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 862 def resolve_member(resolver, map, member, context:) case member when AST::Members::MethodDefinition AST::Members::MethodDefinition.new( name: member.name, kind: member.kind, overloads: member.overloads.map do |overload| overload.update( method_type: resolve_method_type(resolver, map, overload.method_type, context: context) ) end, comment: member.comment, overloading: member.overloading?, annotations: member.annotations, location: member.location, visibility: member.visibility ) when AST::Members::AttrAccessor AST::Members::AttrAccessor.new( name: member.name, type: absolute_type(resolver, map, member.type, context: context), kind: member.kind, annotations: member.annotations, comment: member.comment, location: member.location, ivar_name: member.ivar_name, visibility: member.visibility ) when AST::Members::AttrReader AST::Members::AttrReader.new( name: member.name, type: absolute_type(resolver, map, member.type, context: context), kind: member.kind, annotations: member.annotations, comment: member.comment, location: member.location, ivar_name: member.ivar_name, visibility: member.visibility ) when AST::Members::AttrWriter AST::Members::AttrWriter.new( name: member.name, type: absolute_type(resolver, map, member.type, context: context), kind: member.kind, annotations: member.annotations, comment: member.comment, location: member.location, ivar_name: member.ivar_name, visibility: member.visibility ) when AST::Members::InstanceVariable AST::Members::InstanceVariable.new( name: member.name, type: absolute_type(resolver, map, member.type, context: context), comment: member.comment, location: member.location ) when AST::Members::ClassInstanceVariable AST::Members::ClassInstanceVariable.new( name: member.name, type: absolute_type(resolver, map, member.type, context: context), comment: member.comment, location: member.location ) when AST::Members::ClassVariable AST::Members::ClassVariable.new( name: member.name, type: absolute_type(resolver, map, member.type, context: context), comment: member.comment, location: member.location ) when AST::Members::Include AST::Members::Include.new( name: absolute_type_name(resolver, map, member.name, context: context), args: member.args.map {|type| absolute_type(resolver, map, type, context: context) }, comment: member.comment, location: member.location, annotations: member.annotations ) when AST::Members::Extend AST::Members::Extend.new( name: absolute_type_name(resolver, map, member.name, context: context), args: member.args.map {|type| absolute_type(resolver, map, type, context: context) }, comment: member.comment, location: member.location, annotations: member.annotations ) when AST::Members::Prepend AST::Members::Prepend.new( name: absolute_type_name(resolver, map, member.name, context: context), args: member.args.map {|type| absolute_type(resolver, map, type, context: context) }, comment: member.comment, location: member.location, annotations: member.annotations ) else member end end
(Resolver::TypeNameResolver, UseMap map, RBS::MethodType, context: Resolver::context) → RBS::MethodType
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 962 def resolve_method_type(resolver, map, type, context:) type.map_type do |ty| absolute_type(resolver, map, ty, context: context) end.map_type_bound do |bound| _ = absolute_type(resolver, map, bound, context: context) end end
(Resolver::TypeNameResolver, AST::Ruby::Declarations::t, context: Resolver::context, prefix: Namespace) → AST::Ruby::Declarations::t
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 713 def resolve_ruby_decl(resolver, decl, context:, prefix:) case decl when AST::Ruby::Declarations::ClassDecl full_name = decl.class_name.with_prefix(prefix) inner_context = [context, full_name] #: Resolver::context inner_prefix = full_name.to_namespace super_class = decl.super_class&.yield_self do |super_class| AST::Ruby::Declarations::ClassDecl::SuperClass.new( super_class.type_name_location, super_class.operator_location, absolute_type_name(resolver, nil, super_class.name, context: context), super_class.type_annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } ) end AST::Ruby::Declarations::ClassDecl.new(decl.buffer, full_name, decl.node, super_class).tap do |resolved| decl.members.each do |member| case member when AST::Ruby::Declarations::Base resolved.members << resolve_ruby_decl(resolver, member, context: inner_context, prefix: inner_prefix) when AST::Ruby::Members::Base resolved.members << resolve_ruby_member(resolver, member, context: inner_context) else raise "Unknown member type: #{member.class}" end end end when AST::Ruby::Declarations::ModuleDecl full_name = decl.module_name.with_prefix(prefix) inner_context = [context, full_name] #: Resolver::context inner_prefix = full_name.to_namespace AST::Ruby::Declarations::ModuleDecl.new(decl.buffer, full_name, decl.node).tap do |resolved| decl.members.each do |member| case member when AST::Ruby::Declarations::Base resolved.members << resolve_ruby_decl(resolver, member, context: inner_context, prefix: inner_prefix) when AST::Ruby::Members::Base resolved.members << resolve_ruby_member(resolver, member, context: inner_context) else raise "Unknown member type: #{member.class}" end end end when AST::Ruby::Declarations::ConstantDecl full_name = decl.constant_name.with_prefix(prefix) AST::Ruby::Declarations::ConstantDecl.new( decl.buffer, full_name, decl.node, decl.leading_comment, decl.type_annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } ) when AST::Ruby::Declarations::ClassModuleAliasDecl full_name = decl.new_name.with_prefix(prefix) resolved_annotation = decl.annotation.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } resolved_infered_name = decl.infered_old_name&.yield_self {|name| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Declarations::ClassModuleAliasDecl.new( decl.buffer, decl.node, full_name, resolved_infered_name, decl.leading_comment, resolved_annotation ) else raise "Unknown declaration type: #{decl.class}" end end
(Resolver::TypeNameResolver, AST::Ruby::Members::t, context: Resolver::context) → AST::Ruby::Members::t
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 790 def resolve_ruby_member(resolver, member, context:) case member when AST::Ruby::Members::DefMember AST::Ruby::Members::DefMember.new( member.buffer, member.name, member.node, member.method_type.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) }, member.leading_comment ) when AST::Ruby::Members::IncludeMember resolved_annotation = member.annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::IncludeMember.new( member.buffer, member.node, absolute_type_name(resolver, nil, member.module_name, context: context), resolved_annotation ) when AST::Ruby::Members::ExtendMember resolved_annotation = member.annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::ExtendMember.new( member.buffer, member.node, absolute_type_name(resolver, nil, member.module_name, context: context), resolved_annotation ) when AST::Ruby::Members::PrependMember resolved_annotation = member.annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::PrependMember.new( member.buffer, member.node, absolute_type_name(resolver, nil, member.module_name, context: context), resolved_annotation ) when AST::Ruby::Members::AttrReaderMember resolved_type_annotation = member.type_annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::AttrReaderMember.new( member.buffer, member.node, member.name_nodes, member.leading_comment, resolved_type_annotation ) when AST::Ruby::Members::AttrWriterMember resolved_type_annotation = member.type_annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::AttrWriterMember.new( member.buffer, member.node, member.name_nodes, member.leading_comment, resolved_type_annotation ) when AST::Ruby::Members::AttrAccessorMember resolved_type_annotation = member.type_annotation&.map_type_name {|name, _, _| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::AttrAccessorMember.new( member.buffer, member.node, member.name_nodes, member.leading_comment, resolved_type_annotation ) when AST::Ruby::Members::InstanceVariableMember resolved_annotation = member.annotation.map_type_name {|name| absolute_type_name(resolver, nil, name, context: context) } AST::Ruby::Members::InstanceVariableMember.new( member.buffer, resolved_annotation ) else raise "Unknown member type: #{member.class}" end end
(Resolver::TypeNameResolver, UseMap::Table, Array[AST::Directives::t], Array[AST::Declarations::t], ?only: Set[AST::Declarations::t | AST::Ruby::Declarations::t]?) → [ Array[AST::Directives::t], Array[AST::Declarations::t] ]
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 500 def resolve_signature(resolver, table, dirs, decls, only: nil) map = UseMap.new(table: table) dirs.each do |dir| case dir when AST::Directives::Use dir.clauses.each do |clause| map.build_map(clause) end end end decls = decls.map do |decl| if only && !only.member?(decl) decl else resolve_declaration(resolver, map, decl, context: nil, prefix: Namespace.root) end end [dirs, decls] end
(?only: Set[AST::Declarations::t | AST::Ruby::Declarations::t]?) → Environment
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 522 def resolve_type_names(only: nil) resolver = Resolver::TypeNameResolver.build(self) env = Environment.new table = UseMap::Table.new() table.known_types.merge(class_decls.keys) table.known_types.merge(class_alias_decls.keys) table.known_types.merge(type_alias_decls.keys) table.known_types.merge(interface_decls.keys) table.compute_children each_rbs_source do |source| resolve = source.directives.find { _1.is_a?(AST::Directives::ResolveTypeNames) } #: AST::Directives::ResolveTypeNames? if !resolve || resolve.value _, decls = resolve_signature(resolver, table, source.directives, source.declarations, only: only) else decls = source.declarations end env.add_source(Source::RBS.new(source.buffer, source.directives, decls)) end each_ruby_source do |source| decls = source.declarations.map do |decl| if only if only.include?(decl) resolve_ruby_decl(resolver, decl, context: nil, prefix: Namespace.root) else decl end else resolve_ruby_decl(resolver, decl, context: nil, prefix: Namespace.root) end end env.add_source(Source::Ruby.new(source.buffer, source.prism_result, decls, source.diagnostics)) end env end
Resolve all type names in the environment to absolute type names. Relative type name will be left if absolute type name cannot be found.
When only is given, it skips other top-level declarations not included in the collection. This helps running resolution faster in the case of partial updates.
(Resolver::TypeNameResolver resolver, UseMap map, Array[AST::TypeParam], context: Resolver::context) → Array[AST::TypeParam]
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 970 def resolve_type_params(resolver, map, params, context:) params.map do |param| param.map_type {|type| _ = absolute_type(resolver, map, type, context: context) } end end
(*module_decl) → Resolver::context
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 562 def resolver_context(*nesting) nesting.inject(nil) {|context, decl| #$ Resolver::context append_context(context, decl) } end
Returns a context for inside given decls
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 79 def type_alias_name?(name) type_alias_decls.key?(name) end
Returns true if a type alias with the type name is defined
(TypeName) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 87 def type_name?(name) interface_name?(name) || type_alias_name?(name) || module_name?(name) end
Returns true if the type name is defined
(Set[Pathname] paths) → Environment
(Set[Buffer] buffers) → Environment
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 996 def unload(paths) ps = Set[] paths.each do |path| if path.is_a?(Buffer) ps << path.name else ps << path end end env = Environment.new() each_rbs_source do |source| next if ps.include?(source.buffer.name) env.add_source(source) end each_ruby_source do |source| next if ps.include?(source.buffer.name) env.add_source(source) end env end
Remove declarations and directives that are loaded from buffers
() → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/environment.rb, line 494 def validate_type_params class_decls.each_value do |decl| decl.validate_type_params end end
Runs generics type params validation over each class definitions