rbs 3.0.0.dev.1 → 3.0.0.dev.2

data/sig/constant.rbs

@@ -2,7 +2,7 @@ module RBS
   class Constant
     type constant_entry = Environment::ClassEntry
                         | Environment::ModuleEntry
-                        | Environment::SingleEntry[TypeName, AST::Declarations::Constant]
+                        | Environment::ConstantEntry
 
     attr_reader name: TypeName
 

data/sig/declarations.rbs

@@ -1,7 +1,7 @@
 module RBS
   module AST
     module Declarations
-      type t = Class | Module | Interface | Constant | Global | Alias
+      type t = Class | Module | Interface | Constant | Global | TypeAlias | ClassAlias | ModuleAlias
 
       class Base
       end
@@ -135,7 +135,7 @@ module RBS
         include _ToJson
       end
 
-      class Interface
+      class Interface < Base
         type member = Members::t
 
         # interface _Foo end
@@ -166,7 +166,7 @@ module RBS
         include _ToJson
       end
 
-      class Alias < Base
+      class TypeAlias < Base
         # type loc[T] = Location[T, bot]
         # ^^^^                            keyword
         #      ^^^                        name
@@ -223,6 +223,39 @@ module RBS
         include _HashEqual
         include _ToJson
       end
+
+      class AliasDecl < Base
+        # module Foo = Bar
+        # ^^^^^^             keyword
+        #        ^^^         new_name
+        #            ^       eq
+        #              ^^^   old_name
+        #
+        # class Foo = Bar
+        # ^^^^^              keyword
+        #
+        type loc = Location[:keyword | :new_name | :eq | :old_name, bot]
+
+        attr_reader new_name: TypeName
+
+        attr_reader old_name: TypeName
+
+        attr_reader location: loc?
+
+        attr_reader comment: Comment?
+
+        def initialize: (new_name: TypeName, old_name: TypeName, location: loc?, comment: Comment?) -> void
+
+        include _HashEqual
+      end
+
+      class ClassAlias < AliasDecl
+        include _ToJson
+      end
+
+      class ModuleAlias < AliasDecl
+        include _ToJson
+      end
     end
   end
 end

data/sig/definition.rbs

@@ -119,7 +119,7 @@ module RBS
     end
 
     type self_type = Types::ClassSingleton | Types::ClassInstance | Types::Interface
-    type definition_entry = Environment::ModuleEntry | Environment::ClassEntry | Environment::SingleEntry[TypeName, AST::Declarations::Interface]
+    type definition_entry = Environment::ModuleEntry | Environment::ClassEntry | Environment::InterfaceEntry
 
     attr_reader type_name: TypeName
     attr_reader entry: definition_entry

data/sig/definition_builder.rbs

@@ -5,7 +5,6 @@ module RBS
   #
   class DefinitionBuilder
     attr_reader env: Environment
-    attr_reader type_name_resolver: TypeNameResolver
     attr_reader ancestor_builder: AncestorBuilder
     attr_reader method_builder: MethodBuilder
 

data/sig/directives.rbs

@@ -0,0 +1,61 @@
+module RBS
+  module AST
+    module Directives
+      type t = Use
+
+      class Base
+      end
+
+      # ```
+      # use Foo, Foo::Bar as FBar, Foo:Baz::*
+      # ```
+      #
+      class Use < Base
+        type clause = SingleClause | WildcardClause
+
+        class SingleClause
+          # Foo::Bar
+          # ^^^^^^^^       type_name
+          #
+          # Foo::Bar as X
+          #          ^^    keyword
+          #             ^  new_name
+          #
+          type loc = Location[:type_name, :keyword | :new_name]
+
+          attr_reader type_name: TypeName
+
+          attr_reader new_name: Symbol?
+
+          attr_reader location: loc?
+
+          def initialize: (type_name: TypeName, new_name: Symbol?, location: loc?) -> void
+        end
+
+        class WildcardClause
+          # Foo::Bar::*
+          # ^^^^^^^^^^    namespace
+          #           ^   star
+          #
+          type loc = Location[:namespace | :star, bot]
+
+          attr_reader namespace: Namespace
+
+          attr_reader location: loc?
+
+          def initialize: (namespace: Namespace, location: loc?) -> void
+        end
+
+        # use Foo
+        # ^^^       keyword
+        type loc = Location[:keyword, bot]
+
+        attr_reader clauses: Array[clause]
+
+        attr_reader location: loc?
+
+        def initialize: (clauses: Array[clause], location: loc?) -> void
+      end
+    end
+  end
+end

data/sig/environment.rbs

@@ -13,9 +13,11 @@ module RBS
     end
 
     module ContextUtil
-      def calculate_context: (Array[_NamedDecl]) -> Array[Namespace]
+      def calculate_context: (Array[_NamedDecl]) -> Resolver::context
     end
 
+    # Name of object, it's (multiple) declarations with the outer module declarations
+    #
     class MultiEntry[M < _ModuleOrClass]
       class D[M < _ModuleOrClass]
         attr_reader decl: M
@@ -25,9 +27,9 @@ module RBS
 
         include ContextUtil
 
-        @context: Array[Namespace]
+        @context: Resolver::context
 
-        def context: () -> Array[Namespace]
+        def context: () -> Resolver::context
       end
 
       attr_reader name: TypeName
@@ -55,6 +57,8 @@ module RBS
     class ClassEntry < MultiEntry[AST::Declarations::Class]
     end
 
+    # Name of object, it's (single) declaration, and the outer module declarations
+    #
     class SingleEntry[N, D]
       attr_reader name: N
       attr_reader decl: D
@@ -64,36 +68,68 @@ module RBS
 
       include ContextUtil
 
-      @context: Array[Namespace]
+      @context: Resolver::context
+
+      def context: () -> Resolver::context
+    end
+
+    class ModuleAliasEntry < SingleEntry[TypeName, AST::Declarations::ModuleAlias]
+    end
+
+    class ClassAliasEntry < SingleEntry[TypeName, AST::Declarations::ClassAlias]
+    end
+
+    class InterfaceEntry < SingleEntry[TypeName, AST::Declarations::Interface]
+    end
+
+    class TypeAliasEntry < SingleEntry[TypeName, AST::Declarations::TypeAlias]
+    end
 
-      def context: () -> Array[Namespace]
+    class ConstantEntry < SingleEntry[TypeName, AST::Declarations::Constant]
     end
 
-    # Top level declarations.
+    class GlobalEntry < SingleEntry[Symbol, AST::Declarations::Global]
+    end
+
+    # Top level declarations
     attr_reader declarations: Array[AST::Declarations::t]
 
+    # Class declarations
     attr_reader class_decls: Hash[TypeName, ModuleEntry | ClassEntry]
-    attr_reader interface_decls: Hash[TypeName, SingleEntry[TypeName, AST::Declarations::Interface]]
-    attr_reader alias_decls: Hash[TypeName, SingleEntry[TypeName, AST::Declarations::Alias]]
-    attr_reader constant_decls: Hash[TypeName, SingleEntry[TypeName, AST::Declarations::Constant]]
-    attr_reader global_decls: Hash[Symbol, SingleEntry[Symbol, AST::Declarations::Global]]
+
+    attr_reader class_alias_decls: Hash[TypeName, ModuleAliasEntry | ClassAliasEntry]
+
+    # Interface declarations
+    attr_reader interface_decls: Hash[TypeName, InterfaceEntry]
+
+    # Type alias declarations
+    attr_reader type_alias_decls: Hash[TypeName, TypeAliasEntry]
+
+    # Constant declarations
+    attr_reader constant_decls: Hash[TypeName, ConstantEntry]
+
+    # Global declarations
+    attr_reader global_decls: Hash[Symbol, GlobalEntry]
+
+    attr_reader buffer_directives: Hash[Buffer, Array[AST::Directives::t]]
 
     def initialize: () -> void
 
     def initialize_copy: (Environment) -> void
 
+    # Construct an environment from EnvironmentLoader
+    #
     def self.from_loader: (EnvironmentLoader) -> Environment
 
-    def cache_name: [N, D] (Hash[N, SingleEntry[N, D]] cache, name: N, decl: D, outer: Array[module_decl]) -> SingleEntry[N, D]
-
-    def insert_decl: (AST::Declarations::t, outer: Array[module_decl], namespace: Namespace) -> void
+    def add_signature: (buffer: Buffer, directives: Array[AST::Directives::t], decls: Array[AST::Declarations::t]) -> void
 
-    # Insert a toplevel declaration into the env.
+    # Insert a toplevel declaration into the environment
     #
     def <<: (AST::Declarations::t decl) -> self
 
-    # Runs generics type params validation over each class definitions.
-    def validate_type_params: () -> void
+    # Insert a declaration into the environment
+    #
+    private def insert_decl: (AST::Declarations::t, outer: Array[module_decl], namespace: Namespace) -> void
 
     # Resolve all type names in the environment to absolute type names.
     # Relative type name will be left if absolute type name cannot be found.
@@ -103,18 +139,6 @@ module RBS
     #
     def resolve_type_names: (?only: Set[AST::Declarations::t]?) -> Environment
 
-    def resolve_declaration: (TypeNameResolver resolver, AST::Declarations::t decl, outer: Array[module_decl], prefix: Namespace) -> AST::Declarations::t
-
-    def resolve_member: (TypeNameResolver, AST::Members::t, context: Array[Namespace]) -> AST::Members::t
-
-    def resolve_method_type: (TypeNameResolver, RBS::MethodType, context: Array[Namespace]) -> RBS::MethodType
-
-    def resolve_type_params: (TypeNameResolver resolver, Array[AST::TypeParam], context: Array[Namespace]) ->  Array[AST::TypeParam]
-
-    def absolute_type: (TypeNameResolver, Types::t, context: Array[Namespace]) -> Types::t
-
-    def absolute_type_name: (TypeNameResolver, TypeName, context: Array[Namespace]) -> TypeName
-
     def inspect: () -> String
 
     @buffers: Array[Buffer]
@@ -127,5 +151,103 @@ module RBS
     # Construction of new environment is done with `<<` so that nested declarations will work well.
     #
     def reject: () { (AST::Declarations::t) -> boolish } -> Environment
+
+    # Returns true if an interface with the type name is defined
+    #
+    def interface_name?: (TypeName) -> bool
+
+    # Returns true if a type alias with the type name is defined
+    #
+    def type_alias_name?: (TypeName) -> bool
+
+    # Returns true if a module or class with the type name is defined
+    #
+    def module_name?: (TypeName) -> bool
+
+    # Returns true if the type name is defined
+    #
+    def type_name?: (TypeName) -> bool
+
+    # Returns if a constant of the name is defined
+    #
+    def constant_name?: (TypeName) -> bool
+
+    # Returns true if the type name is defined by constant declaration
+    #
+    def constant_decl?: (TypeName) -> bool
+
+    # Returns true if the type name is defined by class declaration
+    #
+    def class_decl?: (TypeName) -> bool
+
+    # Returns true if the type name is defined by module declaration
+    #
+    def module_decl?: (TypeName) -> bool
+
+    # Returns true if the type name is a module alias
+    #
+    def module_alias?: (TypeName) -> bool
+
+    # Returns true if the type name is a class alias
+    def class_alias?: (TypeName) -> bool
+
+    def class_entry: (TypeName) -> (ClassEntry | ClassAliasEntry | nil)
+
+    # Returns ClassEntry if the class definition is found, normalized in case of alias
+    #
+    def normalized_class_entry: (TypeName) -> ClassEntry?
+
+    def module_entry: (TypeName) -> (ModuleEntry | ModuleAliasEntry | nil)
+
+    # Returns ModuleEntry if the module definition is found, normalized in case of alias
+    #
+    def normalized_module_entry: (TypeName) -> ModuleEntry?
+
+    def constant_entry: (TypeName) -> (ClassEntry | ClassAliasEntry | ModuleEntry | ModuleAliasEntry | ConstantEntry | nil)
+
+    def module_class_entry: (TypeName) -> (ClassEntry | ClassAliasEntry | ModuleEntry | ModuleAliasEntry | nil)
+
+    def normalized_module_class_entry: (TypeName) -> (ClassEntry | ModuleEntry | nil)
+
+    @normalize_module_name_cache: Hash[TypeName, TypeName | false | nil]
+
+    # Returns the original module name that is defined with `module` declaration
+    #
+    # * Calls `#absolute!` for relative module names
+    # * Returns `nil` if the rhs name cannot be found
+    # * Returns `false` if the name is cyclic
+    #
+    def normalize_module_name?: (TypeName) -> (TypeName | nil | false)
+
+    # Returns the original module name that is defined with `module` declaration
+    #
+    # * Raises an error if given type name is not module
+    # * Calls `#absolute!` for relative module names
+    # * Returns the name itself if the name cannot be normalized to a class/module
+    #
+    def normalize_module_name: (TypeName) -> TypeName
+
+    # Runs generics type params validation over each class definitions
+    def validate_type_params: () -> void
+
+    private
+
+    # Returns a context for inside given decls
+    #
+    def resolver_context: (*module_decl) -> Resolver::context
+
+    def append_context: (Resolver::context, module_decl) -> Resolver::context
+
+    def resolve_declaration: (Resolver::TypeNameResolver resolver, UseMap map, AST::Declarations::t decl, outer: Array[module_decl], prefix: Namespace) -> AST::Declarations::t
+
+    def resolve_member: (Resolver::TypeNameResolver, UseMap map, AST::Members::t, context: Resolver::context) -> AST::Members::t
+
+    def resolve_method_type: (Resolver::TypeNameResolver, UseMap map, RBS::MethodType, context: Resolver::context) -> RBS::MethodType
+
+    def resolve_type_params: (Resolver::TypeNameResolver resolver, UseMap map, Array[AST::TypeParam], context: Resolver::context) ->  Array[AST::TypeParam]
+
+    def absolute_type: (Resolver::TypeNameResolver, UseMap map, Types::t, context: Resolver::context) -> Types::t
+
+    def absolute_type_name: (Resolver::TypeNameResolver, UseMap map, TypeName, context: Resolver::context) -> TypeName
   end
 end

data/sig/environment_loader.rbs

@@ -100,7 +100,7 @@ module RBS
     #
     def self.gem_sig_path: (String name, String? version) -> [Gem::Specification, Pathname]?
 
-    def each_decl: () { (AST::Declarations::t, Buffer, source, Pathname) -> void } -> void
+    def each_signature: () { (source, Pathname, Buffer, Array[AST::Declarations::t], Array[AST::Directives::t]) -> void } -> void
 
     def each_dir: { (source, Pathname) -> void } -> void
 

data/sig/errors.rbs

@@ -174,7 +174,7 @@ module RBS
   end
 
   # The *overloading* method definition cannot find *non-overloading* method definition
-  # 
+  #
   class InvalidOverloadMethodError < DefinitionError
     attr_reader type_name: TypeName
     attr_reader method_name: Symbol
@@ -280,4 +280,25 @@ module RBS
 
     def initialize: (type_name: TypeName, method_name: Symbol?, params: Array[AST::TypeParam], location: Location[untyped, untyped]?) -> void
   end
+
+  # A module/class alias declaration has inconsistent right-hand-side
+  #
+  # ```rbs
+  # module Foo = Object     # Error
+  # class Bar = Kernel      # Error
+  # ```
+  #
+  class InconsistentClassModuleAliasError < BaseError
+    attr_reader alias_entry: Environment::ModuleAliasEntry | Environment::ClassAliasEntry
+
+    def initialize: (Environment::ModuleAliasEntry | Environment::ClassAliasEntry) -> void
+  end
+
+  # A module/class alias declaration is cyclic
+  #
+  class CyclicClassAliasDefinitionError < BaseError
+    attr_reader alias_entry: Environment::ModuleAliasEntry | Environment::ClassAliasEntry
+
+    def initialize: (Environment::ModuleAliasEntry | Environment::ClassAliasEntry) -> void
+  end
 end

data/sig/parser.rbs

@@ -6,15 +6,13 @@ module RBS
     # If no token is left in the input, it returns `nil`.
     #
     # ```ruby
+    # RBS::Parser.parse_method_type("() -> void")                                # => `() -> void`
     # RBS::Parser.parse_method_type("() -> void", range: 0...)                   # => `() -> void`
     # RBS::Parser.parse_method_type("() -> void () -> String", range: 11...)     # => `() -> String`
     # RBS::Parser.parse_method_type("() -> void () -> String", range: 23...)     # => nil
     # ```
     #
-    # `line` and `column` is deprecated and are ignored.
-    #
-    def self.parse_method_type: (Buffer | String, range: Range[Integer?], ?variables: Array[Symbol]) -> MethodType?
-                              | (Buffer | String, ?line: top, ?column: top, ?variables: Array[Symbol]) -> MethodType
+    def self.parse_method_type: (Buffer | String, ?range: Range[Integer?], ?variables: Array[Symbol]) -> MethodType?
 
     # Parse a type and return it
     #
@@ -22,22 +20,17 @@ module RBS
     # If no token is left in the input, it returns `nil`.
     #
     # ```ruby
+    # RBS::Parser.parse_type("String")                          # => `String`
     # RBS::Parser.parse_type("String", range: 0...)             # => `String`
     # RBS::Parser.parse_type("String Integer", pos: 7...)       # => `Integer`
     # RBS::Parser.parse_type("String Integer", pos: 14...)      # => nil
     # ```
     #
-    # `line` and `column` is deprecated and are ignored.
-    #
-    def self.parse_type: (Buffer | String, range: Range[Integer?], ?variables: Array[Symbol]) -> Types::t?
-                       | (Buffer | String, ?line: top, ?column: top, ?variables: Array[Symbol]) -> Types::t
+    def self.parse_type: (Buffer | String, ?range: Range[Integer?], ?variables: Array[Symbol]) -> Types::t?
 
     # Parse whole RBS file and return an array of declarations
     #
-    # `line` and `column` is deprecated and are ignored.
-    #
-    def self.parse_signature: (Buffer | String) -> Array[AST::Declarations::t]
-                            | (Buffer | String, ?line: top, ?column: top) -> Array[AST::Declarations::t]
+    def self.parse_signature: (Buffer | String) -> [Buffer, Array[AST::Directives::t], Array[AST::Declarations::t]]
 
     KEYWORDS: Hash[String, bot]
 
@@ -45,11 +38,11 @@ module RBS
 
     def self.buffer: (String | Buffer source) -> Buffer
 
-    def self._parse_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables, boolish eof) -> Types::t?
+    def self._parse_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables) -> Types::t?
 
-    def self._parse_method_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables, boolish eof) -> MethodType?
+    def self._parse_method_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables) -> MethodType?
 
-    def self._parse_signature: (Buffer, Integer end_pos) -> Array[AST::Declarations::t]
+    def self._parse_signature: (Buffer, Integer end_pos) -> [Array[AST::Directives::t], Array[AST::Declarations::t]]
 
     class LocatedValue
     end

data/sig/resolver/constant_resolver.rbs

@@ -37,7 +37,7 @@ module RBS
 
         def constant_of_module: (TypeName name, Environment::ClassEntry | Environment::ModuleEntry) -> Constant
 
-        def constant_of_constant: (TypeName name, Environment::SingleEntry[TypeName, AST::Declarations::Constant]) -> Constant
+        def constant_of_constant: (TypeName name, Environment::ConstantEntry) -> Constant
       end
 
       attr_reader builder: DefinitionBuilder
@@ -65,7 +65,6 @@ module RBS
       #    ^  <- constant_name
       # ```
       #
-      # Find the
       def resolve_child: (TypeName module_name, Symbol constant_name) -> Constant?
 
       # Returns the table of all constants accessible with `::` (colon2) operator.

data/sig/shims/bundler.rbs

@@ -1,13 +1,31 @@
 module Bundler
   class LockfileParser
     def initialize: (String) -> void
+
     def specs: () -> Array[LazySpecification]
   end
 
   class LazySpecification
     def name: () -> String
+
     def version: () -> String
+
+    def dependencies: () -> Array[Gem::Dependency]
+  end
+
+  class Dependency < Gem::Dependency
+    attr_reader autorequire: Array[String]?
+  end
+
+  class Definition
+    def lockfile: () -> Pathname
+
+    def locked_gems: () -> LockfileParser
+
+    def dependencies: () -> Array[Dependency]
   end
 
   def self.default_lockfile: () -> Pathname
+
+  def self.definition: () -> Definition
 end

data/sig/shims/rubygems.rbs

@@ -5,5 +5,11 @@ module Gem
     attr_reader gem_dir (): String
 
     def self.find_by_name: (String name, *String requirements) -> instance
+
+    def dependencies: () -> Array[Dependency]
+  end
+
+  class Dependency
+    def name: () -> String
   end
 end

data/sig/use_map.rbs

@@ -0,0 +1,35 @@
+module RBS
+  class Environment
+    # ```rb
+    # map = UseMap.build(environment)
+    #
+    # map.resolve?(TypeName("TN"))   # => nil or resolved type name
+    # ```
+    #
+    class UseMap
+      class Table
+        attr_reader known_types: Set[TypeName]
+
+        attr_reader children: Hash[Namespace, Set[TypeName]]
+
+        def initialize: () -> void
+
+        def compute_children: () -> self
+      end
+
+      attr_reader use_dirs: Array[AST::Directives::Use]
+
+      @map: Hash[Symbol, TypeName]
+
+      @table: Table
+
+      def initialize: (table: Table) -> void
+
+      def resolve?: (TypeName) -> TypeName?
+
+      def resolve: (TypeName) -> TypeName
+
+      def build_map: (AST::Directives::Use::clause) -> self
+    end
+  end
+end

data/sig/validator.rbs

@@ -2,7 +2,7 @@ module RBS
   class Validator
     attr_reader env: Environment
 
-    attr_reader resolver: TypeNameResolver
+    attr_reader resolver: Resolver::TypeNameResolver
 
     attr_reader definition_builder: DefinitionBuilder
 
@@ -10,11 +10,11 @@ module RBS
 
     attr_reader type_alias_regularity: TypeAliasRegularity
 
-    def initialize: (env: Environment, resolver: TypeNameResolver) -> void
+    def initialize: (env: Environment, resolver: Resolver::TypeNameResolver) -> void
 
     # Validates the presence of type names and type application arity match.
     #
-    def validate_type: (Types::t, context: TypeNameResolver::context) -> void
+    def validate_type: (Types::t, context: Resolver::context) -> void
 
     # Validates type alias definition:
     #
@@ -25,7 +25,7 @@ module RBS
     #
     # It yields the rhs type if block is given, so that you can validate the rhs type.
     #
-    def validate_type_alias: (entry: Environment::SingleEntry[TypeName, AST::Declarations::Alias]) ?{ (Types::t rhs_type) -> void } -> void
+    def validate_type_alias: (entry: Environment::TypeAliasEntry) ?{ (Types::t rhs_type) -> void } -> void
 
     # Validates the type parameters in generic methods.
     #
@@ -42,11 +42,18 @@ module RBS
     #
     def validate_type_params: (Array[AST::TypeParam] params, type_name: TypeName, ?method_name: Symbol?, location: Location[untyped, untyped]?) -> void
 
+    # Validates class alias declaration
+    #
+    # - The right hand side can be normalized
+    # - No mixing alias declaration between class and modules
+    # 
+    def validate_class_alias: (entry: Environment::ClassAliasEntry | Environment::ModuleAliasEntry) -> void
+
     private
 
     # Resolves relative type names to absolute type names in given context.
     # Yields the type when the type name resolution using `#resolver` fails.
     #
-    def absolute_type: (Types::t, context: TypeNameResolver::context) { (Types::t) -> TypeName } -> Types::t
+    def absolute_type: (Types::t, context: Resolver::context) { (Types::t) -> TypeName } -> Types::t
   end
 end

data/sig/writer.rbs

@@ -21,7 +21,7 @@ module RBS
     # Output the array of declarations.
     # It automatically inserts empty lines between the declarations.
     #
-    def write: (Array[AST::Declarations::t]) -> void
+    def write: (Array[AST::Declarations::t | AST::Directives::t]) -> void
 
     def preserve?: () -> bool
 
@@ -96,6 +96,8 @@ module RBS
 
     def format_annotation: (AST::Annotation) -> String
 
+    def write_directive: (AST::Directives::t) -> void
+
     def write_annotation: (Array[AST::Annotation]) -> void
 
     def write_comment: (AST::Comment?) -> void
@@ -108,7 +110,7 @@ module RBS
 
     def name_and_args: (TypeName, Array[Types::t]) -> String?
 
-    def write_alias: (AST::Declarations::Alias) -> void
+    def write_alias: (AST::Declarations::TypeAlias) -> void
 
     def method_name: (Symbol) -> String