rbs 1.5.1 → 1.6.0

data/lib/rbs/validator.rb

@@ -56,7 +56,10 @@ module RBS
 
     def validate_type_alias(entry:)
       @type_alias_dependency ||= TypeAliasDependency.new(env: env)
-      raise RecursiveTypeAliasError.new(alias_names: [entry.decl.name], location: entry.decl.location) if @type_alias_dependency.circular_definition?(entry.decl.name)
+      if @type_alias_dependency.circular_definition?(entry.decl.name)
+        location = entry.decl.location or raise
+        raise RecursiveTypeAliasError.new(alias_names: [entry.decl.name], location: location)
+      end
     end
   end
 end

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

data/lib/rbs.rb

@@ -45,6 +45,7 @@ require "rbs/repository"
 require "rbs/ancestor_graph"
 require "rbs/locator"
 require "rbs/type_alias_dependency"
+require "rbs/collection"
 
 begin
   require "rbs/parser"

data/sig/builtin_names.rbs

@@ -37,5 +37,6 @@ module RBS
     Regexp: Name
     TrueClass: Name
     FalseClass: Name
+    Numeric: Name
   end
 end

data/sig/cli.rbs

@@ -2,6 +2,7 @@ module RBS
   class CLI
     class LibraryOptions
       attr_accessor core_root: Pathname?
+      attr_accessor config_path: Pathname?
 
       attr_reader libs: Array[String]
       attr_reader dirs: Array[String]
@@ -63,6 +64,10 @@ module RBS
 
     def run_test: (Array[String], LibraryOptions) -> void
 
+    def run_collection: (Array[String], LibraryOptions) -> void
+
     def test_opt: (LibraryOptions) -> String?
+
+    def collection_options: (Array[String]) -> OptionParser
   end
 end

data/sig/collection/cleaner.rbs

@@ -0,0 +1,13 @@
+module RBS
+  module Collection
+    class Cleaner
+      attr_reader lock: Config
+
+      def initialize: (lockfile_path: Pathname) -> void
+
+      def clean: () -> void
+
+      def needed?: (String gem_name, String version) -> bool
+    end
+  end
+end

data/sig/collection/collections.rbs

@@ -0,0 +1,112 @@
+module RBS
+  module Collection
+    module Sources
+      def self.from_config_entry: (source_entry) -> _Source
+
+      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 to_lockfile: () -> source_entry
+      end
+
+      type source_entry = Git::source_entry
+                            | Stdlib::source_entry
+                            | Rubygems::source_entry
+
+      class Git
+        METADATA_FILENAME: String
+
+        type source_entry = {
+          'type' => 'git',
+          'name' => String,
+          'remote' => String,
+          'revision' => String,
+          'repo_dir' => String?,
+        }
+
+        class CommandError < StandardError
+        end
+
+        attr_reader name: String
+        attr_reader remote: String
+        attr_reader repo_dir: String
+
+        def initialize: (name: String, revision: String, remote: String, repo_dir: String?) -> untyped
+
+        def has?: (Config::gem_entry) -> bool
+
+        def versions: (Config::gem_entry) -> Array[String]
+
+        def install: (dest: Pathname, config_entry: Config::gem_entry, stdout: CLI::_IO) -> void
+
+        def to_lockfile: () -> source_entry
+
+        private
+
+        def _install: (dest: Pathname , config_entry: Config::gem_entry) -> void
+
+        def setup!: (revision: String) -> void
+
+        def need_to_fetch?: (String revision ) -> bool
+
+        def git_dir: () -> Pathname
+
+        def gem_repo_dir: () -> Pathname
+
+        def with_revision: [T] () { () -> T } -> T
+
+        def resolved_revision: () -> String
+
+        def resolve_revision: () -> String
+
+        def git: (*String cmd) -> String
+
+        def sh!: (*String cmd) -> String
+
+        def format_config_entry: (Config::gem_entry) -> String
+      end
+
+      # signatures that are bundled in rbs gem under the stdlib/ directory
+      class Stdlib
+        type source_entry =  {
+          'type' => 'stdlib',
+        }
+
+        # polyfill of singleton module
+        def self.instance: () -> instance
+
+        def has?: (Config::gem_entry) -> bool
+
+        def versions: (Config::gem_entry) -> Array[String]
+
+        def install: (dest: Pathname, config_entry: Config::gem_entry, stdout: CLI::_IO) -> void
+
+        def to_lockfile: () -> source_entry
+
+        private
+
+        def gem_dir: (Config::gem_entry) -> Pathname
+      end
+
+      # sig/ directory
+      class Rubygems
+        type source_entry = {
+          'type' => 'rubygems',
+        }
+
+        # 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 to_lockfile: () -> source_entry
+
+        private
+
+        def gem_sig_path: (Config::gem_entry) -> [Gem::Specification, Pathname]?
+      end
+    end
+  end
+end

data/sig/collection/config.rbs

@@ -0,0 +1,69 @@
+module RBS
+  module Collection
+    # This class represent the configration file.
+    class Config
+      class LockfileGenerator
+        attr_reader config: Config
+        attr_reader lock: Config?
+        attr_reader lock_path: Pathname
+        attr_reader gemfile_lock: Bundler::LockfileParser
+
+        def self.generate: (config_path: Pathname, gemfile_lock_path: Pathname, ?with_lockfile: boolish) -> Config
+
+        def initialize: (config_path: Pathname, gemfile_lock_path: Pathname, with_lockfile: boolish) -> void
+
+        def generate: () -> Config
+
+        private
+
+        def assign_gem: (gem_name: String, version: String?) -> void
+
+        def upsert_gem: (gem_entry? old, gem_entry new) -> void
+
+        def gemfile_lock_gems: () { (untyped) -> void } -> void
+
+        def remove_ignored_gems!: () -> void
+
+        def find_source: (gem_name: String) -> untyped
+
+        def find_best_version: (version: String?, versions: Array[String]) -> Gem::Version
+      end
+
+      PATH: Pathname
+
+      type gem_entry = {
+        'name' => String,
+        'version' => String?,
+        'ignore' => boolish,
+        'source' => Sources::source_entry?
+      }
+
+      @config_path: Pathname
+
+      def self.generate_lockfile: (config_path: Pathname, gemfile_lock_path: Pathname, ?with_lockfile: boolish) -> Config
+
+      def self.from_path: (Pathname path) -> Config
+
+      def self.lockfile_of: (Pathname config_path) -> Config?
+
+      def self.to_lockfile_path: (Pathname config_path) -> Pathname
+
+      # config_path is necessary to resolve relative repo_path
+      def initialize: (untyped data, config_path: Pathname) -> void
+
+      def add_gem: (untyped gem) -> untyped
+
+      def gem: (String gem_name) -> untyped
+
+      def repo_path: () -> Pathname
+
+      def sources: () -> Array[Sources::_Source]
+
+      def dump_to: (Pathname) -> void
+
+      def gems: () -> Array[untyped]
+
+      def check_rbs_availability!: () -> void
+    end
+  end
+end

data/sig/collection/installer.rbs

@@ -0,0 +1,15 @@
+module RBS
+  module Collection
+    class Installer
+      attr_reader lockfile: Config
+      attr_reader stdout: CLI::_IO
+
+      def initialize: (lockfile_path: Pathname, ?stdout: CLI::_IO) -> void
+      def install_from_lockfile: () -> void
+
+      private
+
+      def source_for: (Config::gem_entry) -> Sources::_Source
+    end
+  end
+end

data/sig/collection.rbs

@@ -0,0 +1,4 @@
+module RBS
+  module Collection
+  end
+end

data/sig/environment_loader.rbs

@@ -78,6 +78,9 @@ module RBS
     def add: (path: Pathname) -> void
            | (library: String, version: String?) -> void
 
+    # Add repository path and libraries via rbs_collection.lock.yaml.
+    def add_collection: (Collection::Config collection_config) -> void
+
     # This is helper function to test if RBS for a library is available or not.
     # 
     def has_library?: (library: String, version: String?) -> bool

data/sig/polyfill.rbs

@@ -1,6 +1,3 @@
-module Kernel
-end
-
 module Gem
   class Specification
     attr_reader version (): Version
@@ -16,3 +13,15 @@ module Enumerable[unchecked out Elem]
               | [U] () { (Elem) -> U } -> Array[U]
               | ...
 end
+
+module Bundler
+  class LockfileParser
+    def initialize: (String) -> void
+    def specs: () -> Array[LazySpecification]
+  end
+
+  class LazySpecification
+    def name: () -> String
+    def version: () -> String
+  end
+end

data/sig/repository.rbs

@@ -57,6 +57,10 @@ module RBS
 
     attr_reader gems: Hash[String, GemRBS]
 
+    def self.default: () -> instance
+
+    def self.find_best_version: (Gem::Version? version, Array[Gem::Version] candidates) -> Gem::Version
+
     # An optional keyword argument `no_stdlib` is to skip adding directory for stdlib classes.
     # Passing truthy value will skip loading stdlib. (You can add the stdlib root by yourself.)
     #

data/stdlib/objspace/0/objspace.rbs

@@ -0,0 +1,406 @@
+# The objspace library extends the ObjectSpace module and adds several methods
+# to get internal statistic information about object/memory management.
+#
+# You need to `require 'objspace'` to use this extension module.
+#
+# Generally, you *SHOULD NOT* use this library if you do not know about the MRI
+# implementation.  Mainly, this library is for (memory) profiler developers and
+# MRI developers who need to know about MRI memory usage.
+# The ObjectSpace module contains a number of routines that interact with the
+# garbage collection facility and allow you to traverse all living objects with
+# an iterator.
+#
+# ObjectSpace also provides support for object finalizers, procs that will be
+# called when a specific object is about to be destroyed by garbage collection.
+# See the documentation for `ObjectSpace.define_finalizer` for important
+# information on how to use this method correctly.
+#
+#     a = "A"
+#     b = "B"
+#
+#     ObjectSpace.define_finalizer(a, proc {|id| puts "Finalizer one on #{id}" })
+#     ObjectSpace.define_finalizer(b, proc {|id| puts "Finalizer two on #{id}" })
+#
+#     a = nil
+#     b = nil
+#
+# *produces:*
+#
+#     Finalizer two on 537763470
+#     Finalizer one on 537763480
+module ObjectSpace
+  # Returns the class for the given `object`.
+  #
+  #     class A
+  #       def foo
+  #         ObjectSpace::trace_object_allocations do
+  #           obj = Object.new
+  #           p "#{ObjectSpace::allocation_class_path(obj)}"
+  #         end
+  #       end
+  #     end
+  #
+  #     A.new.foo #=> "Class"
+  #
+  # See ::trace_object_allocations for more information and examples.
+  #
+  def self.allocation_class_path: (untyped) -> String
+
+  # Returns garbage collector generation for the given `object`.
+  #
+  #     class B
+  #       include ObjectSpace
+  #
+  #       def foo
+  #         trace_object_allocations do
+  #           obj = Object.new
+  #           p "Generation is #{allocation_generation(obj)}"
+  #         end
+  #       end
+  #     end
+  #
+  #     B.new.foo #=> "Generation is 3"
+  #
+  # See ::trace_object_allocations for more information and examples.
+  #
+  def self.allocation_generation: (untyped) -> (Integer | nil)
+
+  # Returns the method identifier for the given `object`.
+  #
+  #     class A
+  #       include ObjectSpace
+  #
+  #       def foo
+  #         trace_object_allocations do
+  #           obj = Object.new
+  #           p "#{allocation_class_path(obj)}##{allocation_method_id(obj)}"
+  #         end
+  #       end
+  #     end
+  #
+  #     A.new.foo #=> "Class#new"
+  #
+  # See ::trace_object_allocations for more information and examples.
+  #
+  def self.allocation_method_id: (untyped) -> Symbol
+
+  # Returns the source file origin from the given `object`.
+  #
+  # See ::trace_object_allocations for more information and examples.
+  #
+  def self.allocation_sourcefile: (untyped) -> String
+
+  # Returns the original line from source for from the given `object`.
+  #
+  # See ::trace_object_allocations for more information and examples.
+  #
+  def self.allocation_sourceline: (untyped) -> Integer
+
+  # Counts objects for each `T_IMEMO` type.
+  #
+  # This method is only for MRI developers interested in performance and memory
+  # usage of Ruby programs.
+  #
+  # It returns a hash as:
+  #
+  #     {:imemo_ifunc=>8,
+  #      :imemo_svar=>7,
+  #      :imemo_cref=>509,
+  #      :imemo_memo=>1,
+  #      :imemo_throw_data=>1}
+  #
+  # If the optional argument, result_hash, is given, it is overwritten and
+  # returned. This is intended to avoid probe effect.
+  #
+  # The contents of the returned hash is implementation specific and may change in
+  # the future.
+  #
+  # In this version, keys are symbol objects.
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  def self.count_imemo_objects: (?Hash[Symbol, Integer] result_hash) -> Hash[Symbol, Integer]
+
+  # Counts nodes for each node type.
+  #
+  # This method is only for MRI developers interested in performance and memory
+  # usage of Ruby programs.
+  #
+  # It returns a hash as:
+  #
+  #     {:NODE_METHOD=>2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}
+  #
+  # If the optional argument, result_hash, is given, it is overwritten and
+  # returned. This is intended to avoid probe effect.
+  #
+  # Note: The contents of the returned hash is implementation defined. It may be
+  # changed in future.
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  def self.count_nodes: (?Hash[Symbol, Integer] result_hash) -> Hash[Symbol, Integer]
+
+  # Counts objects size (in bytes) for each type.
+  #
+  # Note that this information is incomplete.  You need to deal with this
+  # information as only a **HINT**.  Especially, total size of T_DATA may be
+  # wrong.
+  #
+  # It returns a hash as:
+  #     {:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}
+  #
+  # If the optional argument, result_hash, is given, it is overwritten and
+  # returned. This is intended to avoid probe effect.
+  #
+  # The contents of the returned hash is implementation defined. It may be changed
+  # in future.
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  def self.count_objects_size: (?Hash[Symbol, Integer] result_hash) -> Hash[Symbol, Integer]
+
+  # Counts symbols for each Symbol type.
+  #
+  # This method is only for MRI developers interested in performance and memory
+  # usage of Ruby programs.
+  #
+  # If the optional argument, result_hash, is given, it is overwritten and
+  # returned. This is intended to avoid probe effect.
+  #
+  # Note: The contents of the returned hash is implementation defined. It may be
+  # changed in future.
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  # On this version of MRI, they have 3 types of Symbols (and 1 total counts).
+  #
+  #     * mortal_dynamic_symbol: GC target symbols (collected by GC)
+  #     * immortal_dynamic_symbol: Immortal symbols promoted from dynamic symbols (do not collected by GC)
+  #     * immortal_static_symbol: Immortal symbols (do not collected by GC)
+  #     * immortal_symbol: total immortal symbols (immortal_dynamic_symbol+immortal_static_symbol)
+  #
+  def self.count_symbols: (?Hash[Symbol, Integer] result_hash) -> Hash[Symbol, Integer]
+
+  # Counts objects for each `T_DATA` type.
+  #
+  # This method is only for MRI developers interested in performance and memory
+  # usage of Ruby programs.
+  #
+  # It returns a hash as:
+  #
+  #     {RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
+  #      :mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
+  #      ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
+  #      Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}
+  #     # T_DATA objects existing at startup on r32276.
+  #
+  # If the optional argument, result_hash, is given, it is overwritten and
+  # returned. This is intended to avoid probe effect.
+  #
+  # The contents of the returned hash is implementation specific and may change in
+  # the future.
+  #
+  # In this version, keys are Class object or Symbol object.
+  #
+  # If object is kind of normal (accessible) object, the key is Class object. If
+  # object is not a kind of normal (internal) object, the key is symbol name,
+  # registered by rb_data_type_struct.
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  def self.count_tdata_objects: (?Hash[untyped, Integer] result_hash) -> Hash[untyped, Integer]
+
+  def self.dump: (untyped obj, ?output: Symbol) -> (String | File | nil)
+
+  def self.dump_all: (?since: (Integer|nil), ?full: boolish, ?output: Symbol) -> (String | File | nil)
+
+  # MRI specific feature
+  # :   Return internal class of obj.
+  #
+  # obj can be an instance of InternalObjectWrapper.
+  #
+  # Note that you should not use this method in your application.
+  #
+  def self.internal_class_of: (untyped) -> Class
+
+  # MRI specific feature
+  # :   Return internal super class of cls (Class or Module).
+  #
+  # obj can be an instance of InternalObjectWrapper.
+  #
+  # Note that you should not use this method in your application.
+  #
+  def self.internal_super_of: (untyped) -> untyped
+
+  # Return consuming memory size of obj in bytes.
+  #
+  # Note that the return size is incomplete.  You need to deal with this
+  # information as only a **HINT**. Especially, the size of `T_DATA` may not be
+  # correct.
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  # From Ruby 2.2, memsize_of(obj) returns a memory size includes sizeof(RVALUE).
+  #
+  def self.memsize_of: (untyped) -> Integer
+
+  # Return consuming memory size of all living objects in bytes.
+  #
+  # If `klass` (should be Class object) is given, return the total memory size of
+  # instances of the given class.
+  #
+  # Note that the returned size is incomplete. You need to deal with this
+  # information as only a **HINT**. Especially, the size of `T_DATA` may not be
+  # correct.
+  #
+  # Note that this method does **NOT** return total malloc'ed memory size.
+  #
+  # This method can be defined by the following Ruby code:
+  #
+  #     def memsize_of_all klass = false
+  #       total = 0
+  #       ObjectSpace.each_object{|e|
+  #         total += ObjectSpace.memsize_of(e) if klass == false || e.kind_of?(klass)
+  #       }
+  #       total
+  #     end
+  #
+  # This method is only expected to work with C Ruby.
+  #
+  def self.memsize_of_all: (?Class) -> Integer
+
+  # MRI specific feature
+  # :   Return all reachable objects from `obj'.
+  #
+  #
+  # This method returns all reachable objects from `obj'.
+  #
+  # If `obj' has two or more references to the same object `x', then returned
+  # array only includes one `x' object.
+  #
+  # If `obj' is a non-markable (non-heap management) object such as true, false,
+  # nil, symbols and Fixnums (and Flonum) then it simply returns nil.
+  #
+  # If `obj' has references to an internal object, then it returns instances of
+  # ObjectSpace::InternalObjectWrapper class. This object contains a reference to
+  # an internal object and you can check the type of internal object with `type'
+  # method.
+  #
+  # If `obj' is instance of ObjectSpace::InternalObjectWrapper class, then this
+  # method returns all reachable object from an internal object, which is pointed
+  # by `obj'.
+  #
+  # With this method, you can find memory leaks.
+  #
+  # This method is only expected to work except with C Ruby.
+  #
+  # Example:
+  #     ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
+  #     #=> [Array, 'a', 'b', 'c']
+  #
+  #     ObjectSpace.reachable_objects_from(['a', 'a', 'a'])
+  #     #=> [Array, 'a', 'a', 'a'] # all 'a' strings have different object id
+  #
+  #     ObjectSpace.reachable_objects_from([v = 'a', v, v])
+  #     #=> [Array, 'a']
+  #
+  #     ObjectSpace.reachable_objects_from(1)
+  #     #=> nil # 1 is not markable (heap managed) object
+  #
+  def self.reachable_objects_from: (untyped) -> ([ untyped ] | nil)
+
+  # MRI specific feature
+  # :   Return all reachable objects from root.
+  #
+  #
+  def self.reachable_objects_from_root: () -> Hash[String, untyped]
+
+  # Starts tracing object allocations from the ObjectSpace extension module.
+  #
+  # For example:
+  #
+  #     require 'objspace'
+  #
+  #     class C
+  #       include ObjectSpace
+  #
+  #       def foo
+  #         trace_object_allocations do
+  #           obj = Object.new
+  #           p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
+  #         end
+  #       end
+  #     end
+  #
+  #     C.new.foo #=> "objtrace.rb:8"
+  #
+  # This example has included the ObjectSpace module to make it easier to read,
+  # but you can also use the ::trace_object_allocations notation (recommended).
+  #
+  # Note that this feature introduces a huge performance decrease and huge memory
+  # consumption.
+  #
+  def self.trace_object_allocations: () { (untyped) -> untyped } -> untyped
+
+  # Clear recorded tracing information.
+  #
+  def self.trace_object_allocations_clear: () -> void
+
+  def self.trace_object_allocations_debug_start: () -> void
+
+  # Starts tracing object allocations.
+  #
+  def self.trace_object_allocations_start: () -> void
+
+  # Stop tracing object allocations.
+  #
+  # Note that if ::trace_object_allocations_start is called n-times, then tracing
+  # will stop after calling ::trace_object_allocations_stop n-times.
+  #
+  def self.trace_object_allocations_stop: () -> void
+
+  private
+
+  # Dump the contents of a ruby object as JSON.
+  #
+  # This method is only expected to work with C Ruby. This is an experimental
+  # method and is subject to change. In particular, the function signature and
+  # output format are not guaranteed to be compatible in future versions of ruby.
+  #
+  def dump: (untyped obj, ?output: Symbol) -> (String|File|nil)
+
+  # Dump the contents of the ruby heap as JSON.
+  #
+  # *since* must be a non-negative integer or `nil`.
+  #
+  # If *since* is a positive integer, only objects of that generation and newer
+  # generations are dumped. The current generation can be accessed using
+  # GC::count.
+  #
+  # Objects that were allocated without object allocation tracing enabled are
+  # ignored. See ::trace_object_allocations for more information and examples.
+  #
+  # If *since* is omitted or is `nil`, all objects are dumped.
+  #
+  # This method is only expected to work with C Ruby. This is an experimental
+  # method and is subject to change. In particular, the function signature and
+  # output format are not guaranteed to be compatible in future versions of ruby.
+  #
+  def dump_all: (?since: (Integer|nil), ?full: boolish, ?output: Symbol) -> (String|File|nil)
+
+  def memsize_of: (untyped) -> Integer
+
+  def memsize_of_all: (?class) -> Integer
+
+  def reachable_objects_from: (untyped) -> ([ untyped ] | nil)
+
+  def reachable_objects_from_root: () -> Hash[String, untyped]
+
+  def trace_object_allocations_clear: () -> void
+
+  def trace_object_allocations_debug_start: () -> void
+
+  def trace_object_allocations_start: () -> void
+
+  def trace_object_allocations_stop: () -> void
+end