rbs 2.8.4 → 3.0.0.dev.2

data/sig/collection/sources.rbs

@@ -1,27 +1,32 @@
 module RBS
   module Collection
     module Sources
-      def self.from_config_entry: (source_entry) -> _Source
+      def self.from_config_entry: (Git::source_entry) -> Git
+                                | (source_entry) -> t
 
       interface _Source
-        def has?: (Config::gem_entry) -> boolish
-        def versions: (Config::gem_entry) -> Array[String]
-        def install: (dest: Pathname, config_entry: Config::gem_entry, stdout: CLI::_IO) -> void
+        def has?: (String name, String? version) -> boolish
+        def versions: (String name) -> Array[String]
+        def install: (dest: Pathname, name: String, version: String, stdout: CLI::_IO) -> void
         def to_lockfile: () -> source_entry
-        def manifest_of: (Config::gem_entry) -> manifest_entry?
-        def dependencies_of: (Config::gem_entry) -> Array[{"name" => String}]?
+        def manifest_of: (String name, String version) -> manifest_entry?
+        def dependencies_of: (String name, String version) -> Array[manifest_dependency]?
       end
 
+      type t = Git | Stdlib | Rubygems
+
       type source_entry = Git::source_entry
                         | Stdlib::source_entry
                         | Rubygems::source_entry
 
       type manifest_entry = {
-        "dependencies" => Array[{"name" => String}]?,
+        "dependencies" => Array[manifest_dependency]?,
       }
 
+      type manifest_dependency = { "name" => String }
+
       module Base : _Source
-        def dependencies_of: (Config::gem_entry config_entry) -> Array[{"name" => String}]?
+        def dependencies_of: (String name, String version) -> Array[manifest_dependency]?
       end
 
       class Git
@@ -43,48 +48,82 @@ module RBS
         attr_reader name: String
         attr_reader remote: String
         attr_reader repo_dir: String
+        attr_reader revision: String
 
         def initialize: (name: String, revision: String, remote: String, repo_dir: String?) -> untyped
 
-        def has?: (Config::gem_entry) -> bool
+        def has?: (String name, String? version) -> boolish
 
-        def versions: (Config::gem_entry) -> Array[String]
+        def versions: (String name) -> Array[String]
 
-        def install: (dest: Pathname, config_entry: Config::gem_entry, stdout: CLI::_IO) -> void
+        def install: (dest: Pathname, name: String, version: String, stdout: CLI::_IO) -> void
 
         def to_lockfile: () -> source_entry
 
-        def manifest_of: (Config::gem_entry) -> manifest_entry?
+        def manifest_of: (String name, String version) -> manifest_entry?
+
+        def resolved_revision: () -> String
 
         private
 
+        @need_setup: bool
+
         @git_dir: Pathname?
 
         @resolved_revision: String?
 
-        def _install: (dest: Pathname , config_entry: Config::gem_entry) -> void
+        @gems_versions: Hash[String, Set[String]]?
 
-        def cp_r: (Pathname, Pathname) -> void
+        def _install: (dest: Pathname , name: String, version: String) -> void
 
-        def setup!: (revision: String) -> void
-
-        def need_to_fetch?: (String revision ) -> bool
+        def cp_r: (Pathname, Pathname) -> void
 
+        # Ensure the git repository exists, and
+        #
+        # * When `revision` is a commit hash, the commit exists in the local repository, or
+        # * When `revision` is a branch name, the latest version is fetched from `origin`
+        #
+        # It may require a network connection to fetch or clone the repository from remote.
+        #
+        # * If `revision` is a commit hash and the commit doesn't exists in the local repository, it runs `git fetch`
+        # * If `revision` is a branch name, it runs `git fetch` once per instance
+        #
+        def setup!: [T] () { () -> T } -> T
+                  | () -> void
+
+        def need_to_fetch?: (String revision) -> bool
+
+        # The full path of local git repository
         def git_dir: () -> Pathname
 
+        # The full path of `repo_dir` in the local git repository
         def gem_repo_dir: () -> Pathname
 
-        def with_revision: [T] () { () -> T } -> T
-
-        def resolved_revision: () -> String
-
-        def resolve_revision: () -> String
+        # Returns `true` if `revision` looks like a commit hash
+        def commit_hash?: () -> bool
 
+        # Executes a git command, raises an error if failed
         def git: (*String cmd, **untyped opt) -> String
 
+        # Executes a git command, returns `nil` if failed
+        def git?: (*String cmd, **untyped opt) -> String?
+
         def sh!: (*String cmd, **untyped opt) -> String
 
-        def format_config_entry: (Config::gem_entry) -> String
+        def format_config_entry: (String name, String version) -> String
+
+        type metadata = { 'name' => String, 'version' => String, 'source' => source_entry }
+
+        def metadata_content: (name: String, version: String) -> metadata
+
+        # Write `.rbs_meta.yaml`
+        def write_metadata: (dir: Pathname, name: String, version: String) -> void
+
+        # Load `.rbs_meta.yaml` from the `dir`, where is the destination of the RBS file installation, and return the cleaned up content
+        #
+        def load_metadata: (dir: Pathname) -> metadata
+
+        def gems_versions: () -> Hash[String, Set[String]]
       end
 
       # signatures that are bundled in rbs gem under the stdlib/ directory
@@ -101,19 +140,19 @@ module RBS
         # polyfill of singleton module
         def self.instance: () -> instance
 
-        def has?: (Config::gem_entry) -> boolish
+        def has?: (String name, String? version) -> boolish
 
-        def versions: (Config::gem_entry) -> Array[String]
+        def versions: (String name) -> Array[String]
 
-        def install: (dest: Pathname, config_entry: Config::gem_entry, stdout: CLI::_IO) -> void
+        def install: (dest: Pathname, name: String, version: String, stdout: CLI::_IO) -> void
 
         def to_lockfile: () -> source_entry
 
-        def manifest_of: (Config::gem_entry) -> manifest_entry?
+        def manifest_of: (String name, String version) -> manifest_entry?
 
         private
 
-        def lookup: (Config::gem_entry) -> Pathname?
+        def lookup: (String name, String? version) -> Pathname?
       end
 
       # sig/ directory
@@ -127,15 +166,19 @@ module RBS
         # polyfill of singleton module
         def self.instance: () -> instance
 
-        def has?: (Config::gem_entry) -> boolish
-        def versions: (Config::gem_entry) -> Array[String]
-        def install: (dest: Pathname, config_entry: Config::gem_entry, stdout: CLI::_IO) -> void
+        def has?: (String name, String? version) -> boolish
+
+        def versions: (String name) -> Array[String]
+
+        def install: (dest: Pathname, name: String, version: String, stdout: CLI::_IO) -> void
+
         def to_lockfile: () -> source_entry
-        def manifest_of: (Config::gem_entry) -> manifest_entry?
+
+        def manifest_of: (String name, String version) -> manifest_entry?
 
         private
 
-        def gem_sig_path: (Config::gem_entry) -> [Gem::Specification, Pathname]?
+        def gem_sig_path: (String name, String? version) -> [Gem::Specification, Pathname]?
       end
     end
   end

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

@@ -1,111 +1,39 @@
 module RBS
   # DefinitionBuilder translates TypeName to Definition of the type
   #
-  # The translation goes three steps:
-  #
-  # 1. Calculate _ancestors_ of the type with AncestorBuilder
-  # 2. Calculate _partial_ definitions of each ancestor
-  # 3. Merge _partial_ definitions
-  #
-  # A _partial_ definition is a definition of one type name, in terms of it doesn't have methods of super classes nor included modules.
-  #
+  # It also provides semantic utilities that depends on Environment.
   #
   class DefinitionBuilder
     attr_reader env: Environment
-    attr_reader type_name_resolver: TypeNameResolver
     attr_reader ancestor_builder: AncestorBuilder
     attr_reader method_builder: MethodBuilder
 
-    attr_reader instance_cache: Hash[[TypeName, bool], Definition | false | nil]
+    attr_reader instance_cache: Hash[TypeName, Definition | false | nil]
     attr_reader singleton_cache: Hash[TypeName, Definition | false | nil]
     attr_reader singleton0_cache: Hash[TypeName, Definition | false | nil]
     attr_reader interface_cache: Hash[TypeName, Definition | false | nil]
 
     def initialize: (env: Environment, ?ancestor_builder: AncestorBuilder?, ?method_builder: MethodBuilder?) -> void
 
+    # Returns a Definition of a interface
+    #
     def build_interface: (TypeName) -> Definition
 
-    # Returns a Definition of a instance of given type name.
+    # Returns a Definition of an instance type
     #
     # If TypeName is a module and `no_self_types` is `true`, it won't have methods of _self type constraints_.
     # This typically happens when definition is being calculated for mixin.
     #
-    def build_instance: (TypeName, ?no_self_types: bool) -> Definition
+    def build_instance: (TypeName) -> Definition
 
+    # Returns a Definition of a singleton type
     def build_singleton: (TypeName) -> Definition
 
-    def validate_super_class!: (TypeName, Environment::ClassEntry) -> void
-
-    def ensure_namespace!: (Namespace, location: Location[untyped, untyped]?) -> void
-
-    def build_singleton0: (TypeName) -> Definition
-
-    def merge_definition: (src: Definition, dest: Definition, subst: Substitution, ?implemented_in: :keep | TypeName | nil, ?keep_super: bool) -> void
-
-    def merge_method: (TypeName, Hash[Symbol, Definition::Method], Symbol, Definition::Method, Substitution, ?implemented_in: :keep | TypeName | nil, ?keep_super: bool) -> void
-
-    def merge_variable: (Hash[Symbol, Definition::Variable], Symbol, Definition::Variable, Substitution, ?keep_super: bool) -> void
-
-    def try_cache: (TypeName, cache: Hash[TypeName, Definition | false | nil]) { () -> Definition } -> Definition
-                 | [A] (TypeName, cache: Hash[A, Definition | false | nil], key: A) { () -> Definition } -> Definition
-
-    def validate_params_with: (Array[AST::TypeParam], result: VarianceCalculator::Result) { (AST::TypeParam) -> void } -> void
-
-    def validate_type_params: (Definition, ancestors: AncestorBuilder::OneAncestors, methods: MethodBuilder::Methods) -> void
-
-    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location[untyped, untyped]?
-
-    def insert_variable: (TypeName, Hash[Symbol, Definition::Variable], name: Symbol, type: Types::t) -> void
-
-    # Add methods from `methods` to Definition
-    #
-    # * `methods`:
-    # * `interface_methods`: Methods of interfaces mixed into the type
-    # * `self_constraints_methods`: Methods of the self constraints methods
-    # * `super_interface_method`: `true` to have super method of existing method (`true` is the Definition is the target module)
-    #
-    def define_methods: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method],
-      methods_with_self: Hash[Symbol, Definition::Method]?,
-      super_interface_method: bool
-    ) -> void
-
-    # Define methods on singleton type
-    #
-    def define_methods_singleton: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method]
-    ) -> void
-
-    # Define methods on instance type
-    #
-    def define_methods_instance: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method]
-    ) -> void
-
-    # Define methods on module instance type
+    # Validates the given Namespace and its ancestor namespaces exists
     #
-    # * Pass `nil` to `module_self_methods:` to build a module instance type that will be mixed in to other modules/classes
-    # * Pass methods from self-type-constraints to build a module instance type alone (to type check itself)
+    # Raises NoTypeFoundError
     #
-    def define_methods_module_instance: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method],
-      module_self_methods: Hash[Symbol, Definition::Method]?
-    ) -> void
-
-    # Validates presence of type names recursively.
-    # Assumes the type names are already resolved.
-    #
-    def validate_type_presence: (Types::t) -> void
-
-    def validate_type_name: (TypeName, Location[untyped, untyped]?) -> void
+    def ensure_namespace!: (Namespace, location: Location[untyped, untyped]?) -> void
 
     # Expand a type alias of given name without type arguments.
     # Raises an error if the type alias requires arguments.
@@ -138,6 +66,90 @@ module RBS
     #
     def expand_alias2: (TypeName, Array[Types::t] args) -> Types::t
 
+    # Validates presence of type names recursively
+    #
+    # Assumes the type names are already resolved.
+    # Raises NoTypeFoundError in case of failure.
+    #
+    def validate_type_presence: (Types::t) -> void
+
+    # Validates presence of an absolute type name
+    #
+    # Raises NoTypeFoundError in case of error.
+    #
+    def validate_type_name: (TypeName, Location[untyped, untyped]?) -> void
+
+    # Returns a new DefinitionBuilder with updated Environment, AncestorBuilder, and exceptions
+    #
     def update: (env: Environment, ancestor_builder: AncestorBuilder, except: _Each[TypeName]) -> DefinitionBuilder
+
+    private
+
+    def validate_super_class!: (TypeName, Environment::ClassEntry) -> void
+
+    def build_singleton0: (TypeName) -> Definition
+
+    # Returns `interface_methods` from given array of interface ancestors
+    #
+    def interface_methods: (Array[Definition::Ancestor::Instance] interface_ancestors) -> interface_methods
+
+    def try_cache: (TypeName, cache: Hash[TypeName, Definition | false | nil]) { () -> Definition } -> Definition
+
+    def validate_params_with: (Array[AST::TypeParam], result: VarianceCalculator::Result) { (AST::TypeParam) -> void } -> void
+
+    def validate_type_params: (Definition, ancestors: AncestorBuilder::OneAncestors, methods: MethodBuilder::Methods) -> void
+
+    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location[untyped, untyped]?
+
+    def insert_variable: (TypeName, Hash[Symbol, Definition::Variable], name: Symbol, type: Types::t) -> void
+
+    # Add method definition to `methods`, which will be merged to `class_definition` after defining all methods at this *level* -- class, module, or interface
+    #
+    # `class_definition` is a definition of given type, but it has definitions of prior levels.
+    #
+    def define_method: (
+      Hash[Symbol, Definition::Method] methods,
+      Definition class_definition,
+      MethodBuilder::Methods::Definition method_definition,
+      Substitution subst,
+      defined_in: TypeName,
+      ?implemented_in: TypeName?
+    ) -> void
+
+    # The `interface_methods` type describes the association between the interface name to its name and the *mixin* to a module
+    #
+    type interface_methods = Hash[
+      Definition::Ancestor::Instance,
+      [MethodBuilder::Methods, AST::Members::Include | AST::Members::Extend]
+    ]
+
+    # Add method definitions from `module_methods` to `definition`
+    #
+    # It also processes interface mixins, with duplication detection.
+    # It doesn't process module mixins.
+    #
+    def import_methods: (
+      Definition definition,
+      TypeName module_name,
+      MethodBuilder::Methods module_methods,
+      interface_methods interface_methods,
+      Substitution subst
+    ) -> void
+
+    # Updates `definition` with methods and variables of `type_name` that can be a module or a class
+    #
+    # It processes includes and prepends recursively.
+    #
+    def define_instance: (Definition definition, TypeName type_name, Substitution subst) -> void
+
+    def define_interface: (Definition definition, TypeName type_name, Substitution subst) -> void
+
+    # Returns a substitution that corresponds to type application
+    #
+    # ```
+    # tapp_subst(`::Array`, [`::Integer`]) # => Subsitution.build([:Elem], [`::Integer`])
+    # ```
+    #
+    def tapp_subst: (TypeName, Array[Types::t]) -> Substitution
   end
 end

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