rbs 2.2.2 → 2.3.0

data/sig/environment_loader.rbs

@@ -1,26 +1,26 @@
 module RBS
   # EnvironmentLoader is an object to load RBS files from filesystem.
-  # 
+  #
   # Set up your configuration through repository and `#add` method.
-  # 
+  #
   #   # Set up the repository to load library RBSs from.
   #   repo = RBS::Repository.default
   #   repo.add(Pathname("vendor/rbs/gem-rbs"))
   #   repo.add(Pathname("vendor/rbs/internal-rbs"))
-  # 
+  #
   #   loader = RBS::EnvironmentLoader.new(repository: repo)
-  # 
+  #
   #   # Add libraries to load RBS files.
   #   loader.add(library: "minitest")
   #   loader.add(library: "rbs", version: "1.0.0")
-  # 
+  #
   #   # Add dirs to load RBS files from.
   #   loader.add(path: Pathname("sig"))
-  # 
+  #
   #   # Load RBSs into an environment.
   #   environment = RBS::Environment.new()
   #   loader.load(env: environment)
-  # 
+  #
   class EnvironmentLoader
     class UnknownLibraryError < StandardError
       attr_reader library: Library
@@ -44,37 +44,37 @@ module RBS
     attr_reader dirs: Array[Pathname]
 
     # The source where the RBS comes from.
-    # 
+    #
     # `:core` means it is part of core library.
     # `Library` means it is from library.
     # `Pathname` means it is loaded from a directory.
-    # 
+    #
     type source = :core
                 | Library
                 | Pathname
 
     # Accepts two optional keyword arguments.
-    # 
+    #
     # `core_root` is the path to the directory with RBSs for core classes.
     # The default value is the core library included in RBS gem. (EnvironmentLoader::DEFAULT_CORE_ROOT)
     # Passing `nil` means it skips loading core class definitions.
-    # 
+    #
     # `repository` is the repository for library classes.
     # The default value is repository only with stdlib classes. (Repository.new)
-    # 
+    #
     def initialize: (?core_root: Pathname?, ?repository: Repository) -> void
-    
+
     # Add a path or library to load RBSs from.
-    # 
+    #
     # `path` can be a file or a directory.
     # All `.rbs` files from the given directory will be loaded.
     # Specifying a file will load the file regardless the extension of the file is.
-    # 
+    #
     # `library` can be a name of a gem.
     # Specifying `nil` to `version` will load any version available.
     # It first tries to load RBS files from gem with specified version.
     # If RBS files cannot be found in the gem, it tries to load RBSs from repository.
-    # 
+    #
     def add: (path: Pathname) -> void
            | (library: String, version: String?) -> void
 
@@ -82,26 +82,26 @@ module RBS
     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
 
     # Add all declarations to environment.
-    # 
+    #
     # Raises `UnknownLibraryError` if RBS cannot be loaded from a library.
-    # 
+    #
     # Returns an array of tuples of the declaration, path to the file, and the source.
-    # 
+    #
     def load: (env: Environment) -> Array[[AST::Declarations::t, Pathname, source]]
 
     # Returns a pair of spec and path for a gem with RBS.
     # Returns nil if the gem is not installed, or the gem doesn't provide 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_dir: { (source, Pathname) -> void } -> void
-                
+
     def each_file: (Pathname path, immediate: boolish, skip_hidden: boolish) { (Pathname) -> void } -> void
   end
 end

data/sig/locator.rbs

@@ -37,6 +37,8 @@ module RBS
 
     def find_in_type: (Integer pos, type: Types::t, array: Array[component]) -> bool
 
+    def find_in_type_param: (Integer pos, type_param: AST::TypeParam, array: Array[component]) -> bool
+
     def find_in_loc: (Integer pos, location: Location[untyped, untyped]?, array: Array[component]) -> bool
 
     def test_loc: (Integer pos, location: Location[untyped, untyped]?) -> bool

data/sig/manifest.yaml

@@ -0,0 +1,8 @@
+dependencies:
+  - name: logger
+  - name: set
+  - name: pathname
+  - name: json
+  - name: optparse
+  - name: rubygems
+  - name: tsort

data/sig/resolver/constant_resolver.rbs

@@ -0,0 +1,93 @@
+module RBS
+  module Resolver
+    class ConstantResolver
+      # Table stores the set of immediate child constants of a module.
+      #
+      # ```rb
+      # table = RBS::ConstantResolver::Table.new(env)
+      #
+      # table.children(TypeName("::Object"))                # -> { ... }  Returns a hash of name and constants.
+      # table.children(TypeName("::File::PATH_SEPARATOR"))  # -> nil      Returns nil because the constant is not a module.
+      #
+      # table.toplevel                                      # -> { ... }  Returns a hash of top level constants.
+      # ```
+      #
+      # The `#toplevel` is incompatible with Ruby.
+      # All constants in Ruby are defined under `Object`, and they are accessed with `::` (Colon3) operator.
+      # RBS is different.
+      # `::` constants are _toplevel_ constants, and they are not defined under `::Object`.
+      #
+      # The behavior is simulated in `ConstantResolver`.
+      #
+      class Table
+        attr_reader children_table: Hash[TypeName, Hash[Symbol, Constant]?]
+        attr_reader constants_table: Hash[TypeName, Constant]
+        attr_reader toplevel: Hash[Symbol, Constant]
+
+        def initialize: (Environment) -> void
+
+        def constant: (TypeName constant_name) -> Constant?
+
+        # Returns a set of constants defined under `module_name`.
+        # Returns `nil` if there is no module with given `module_name`.
+        #
+        def children: (TypeName module_name) -> Hash[Symbol, Constant]?
+
+        private
+
+        def constant_of_module: (TypeName name, Environment::ClassEntry | Environment::ModuleEntry) -> Constant
+
+        def constant_of_constant: (TypeName name, Environment::SingleEntry[TypeName, AST::Declarations::Constant]) -> Constant
+      end
+
+      attr_reader builder: DefinitionBuilder
+      attr_reader table: Table
+      attr_reader context_constants_cache: Hash[context, Hash[Symbol, Constant]?]
+      attr_reader child_constants_cache: Hash[TypeName, Hash[Symbol, Constant]]
+
+      def initialize: (builder: DefinitionBuilder) -> void
+
+      # Resolves to `Constant` with given constant name `name` and `context`.
+      # Returns `nil` if the constant cannot be resolved from the context.
+      #
+      def resolve: (Symbol name, context: context) -> Constant?
+
+      # Returns the available all constants from `context`.
+      #
+      # Returns `nil` when the `context` is invalid.
+      def constants: (context) -> Hash[Symbol, Constant]?
+
+      # Resolves the module_name and constant name to `Constant`
+      #
+      # ```ruby
+      # A::B
+      # ^     <- module_name
+      #    ^  <- constant_name
+      # ```
+      #
+      # Find the
+      def resolve_child: (TypeName module_name, Symbol constant_name) -> Constant?
+
+      # Returns the table of all constants accessible with `::` (colon2) operator.
+      #
+      # * The constants under the module are included.
+      # * The constants under the ancestor modules are included.
+      #   * The constants under the `::Object` class are not included.
+      #   * The top level constants are not included.
+      #
+      def children: (TypeName module_name) -> Hash[Symbol, Constant]
+
+      private
+
+      def load_context_constants: (context) -> void
+
+      def load_child_constants: (TypeName) -> void
+
+      def constants_from_context: (context, constants: Hash[Symbol, Constant]) -> bool
+
+      def constants_from_ancestors: (TypeName, constants: Hash[Symbol, Constant]) -> void
+
+      def constants_itself: (context, constants: Hash[Symbol, Constant]) -> void
+    end
+  end
+end

data/sig/resolver/context.rbs

@@ -0,0 +1,34 @@
+module RBS
+  module Resolver
+    # `context` represents the module nesting structure.
+    #
+    # - `nil` means toplevel
+    # - A 2-tuple represents parent and the most inner module
+    #   - `TypeName` is for a module
+    #   - `false` is for unknown module
+    #
+    # Note that the `TypeName` must be an absolute type name.
+    #
+    # The following Ruby code has context of `[[nil, TypeName("::Foo")], false]` where
+    #
+    # * `Foo` is a class defined in RBS file
+    # * `Bar` is not defined in RBS files
+    #
+    # ```ruby
+    # class Foo
+    #   module Bar
+    #     # Context here
+    #   end
+    # end
+    # ```
+    #
+    # The unknown module (`false`) appears only in Ruby code.
+    # RBS modules/classes are always exists (or defines new module).
+    # Nesting a unknown module cannot happen in RBS.
+    #
+    # In Ruby this happens when the module/class is not declared in RBS files.
+    #
+    type context = [context, TypeName | false]
+                 | nil
+  end
+end

data/sig/resolver/type_name_resolver.rbs

@@ -0,0 +1,31 @@
+module RBS
+  module Resolver
+    # TypeNameResolver resolves given relative type name to absolute type name under a module nesting context.
+    #
+    # The type name resolution doesn't take account of ancestors of modules.
+    # It just ignores included modules and super classes.
+    #
+    class TypeNameResolver
+      type query = [TypeName, context]
+
+      def initialize: (Environment) -> void
+
+      # Translates given type name to absolute type name.
+      # Returns `nil` if cannot find associated type name.
+      #
+      def resolve: (TypeName, context: context) -> TypeName?
+
+      private
+
+      attr_reader all_names: Set[TypeName]
+
+      attr_reader cache: Hash[query, TypeName?]
+
+      def has_name?: (TypeName) -> TypeName?
+
+      def try_cache: (query) { () -> TypeName? } -> TypeName?
+
+      def resolve_in: (TypeName, context) -> TypeName?
+    end
+  end
+end

data/sig/typename.rbs

@@ -56,11 +56,17 @@ module RBS
 
     # Returns a new type name with a namespace appended to given namespace.
     #
-    #    TypeName("Hello").with_prefix(Namespace("World"))           # => World::Hello
-    #    TypeName("Foo::Bar").with_prefix(Namespace("::Hello"))      # => ::Hello::Foo::Bar
-    #    TypeName("::A::B").with_prefix(Namespace("C"))              # => ::A::B
+    # ```rb
+    # TypeName("Hello").with_prefix(Namespace("World"))           # => World::Hello
+    # TypeName("Foo::Bar").with_prefix(Namespace("::Hello"))      # => ::Hello::Foo::Bar
+    # TypeName("::A::B").with_prefix(Namespace("C"))              # => ::A::B
+    # ```
     #
     def with_prefix: (Namespace namespace) -> TypeName
+
+    def +: (TypeName) -> TypeName
+
+    def split: () -> Array[Symbol]
   end
 end
 

data/stdlib/bigdecimal/0/big_decimal.rbs

@@ -1187,6 +1187,19 @@ class BigDecimal < Numeric
   #
   def zero?: () -> bool
 
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - a.to_d -> bigdecimal
+  # -->
+  # Returns self.
+  #
+  #     require 'bigdecimal/util'
+  #
+  #     d = BigDecimal("3.14")
+  #     d.to_d                       # => 0.314e1
+  #
+  def to_d: () -> BigDecimal
+
   private
 
   def initialize_copy: (self) -> self
@@ -1378,3 +1391,125 @@ module Kernel
   #
   def self?.BigDecimal: (real | string | BigDecimal initial, ?int digits, ?exception: bool) -> BigDecimal
 end
+
+%a{annotate:rdoc:skip}
+class Integer
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - int.to_d  -> bigdecimal
+  # -->
+  # Returns the value of `int` as a BigDecimal.
+  #
+  #     require 'bigdecimal'
+  #     require 'bigdecimal/util'
+  #
+  #     42.to_d   # => 0.42e2
+  #
+  # See also BigDecimal::new.
+  #
+  def to_d: () -> BigDecimal
+end
+
+%a{annotate:rdoc:skip}
+class Float
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - float.to_d             -> bigdecimal
+  #   - float.to_d(precision)  -> bigdecimal
+  # -->
+  # Returns the value of `float` as a BigDecimal. The `precision` parameter is
+  # used to determine the number of significant digits for the result (the default
+  # is Float::DIG).
+  #
+  #     require 'bigdecimal'
+  #     require 'bigdecimal/util'
+  #
+  #     0.5.to_d         # => 0.5e0
+  #     1.234.to_d(2)    # => 0.12e1
+  #
+  # See also BigDecimal::new.
+  #
+  def to_d: (?Integer precision) -> BigDecimal
+end
+
+%a{annotate:rdoc:skip}
+class String
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - str.to_d  -> bigdecimal
+  # -->
+  # Returns the result of interpreting leading characters in `str` as a
+  # BigDecimal.
+  #
+  #     require 'bigdecimal'
+  #     require 'bigdecimal/util'
+  #
+  #     "0.5".to_d             # => 0.5e0
+  #     "123.45e1".to_d        # => 0.12345e4
+  #     "45.67 degrees".to_d   # => 0.4567e2
+  #
+  # See also BigDecimal::new.
+  #
+  def to_d: () -> BigDecimal
+end
+
+%a{annotate:rdoc:skip}
+class Rational
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - rat.to_d(precision)  -> bigdecimal
+  # -->
+  # Returns the value as a BigDecimal.
+  #
+  # The required `precision` parameter is used to determine the number of
+  # significant digits for the result.
+  #
+  #     require 'bigdecimal'
+  #     require 'bigdecimal/util'
+  #
+  #     Rational(22, 7).to_d(3)   # => 0.314e1
+  #
+  # See also BigDecimal::new.
+  #
+  def to_d: (Integer precision) -> BigDecimal
+end
+
+%a{annotate:rdoc:skip}
+class Complex
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - cmp.to_d             -> bigdecimal
+  #   - cmp.to_d(precision)  -> bigdecimal
+  # -->
+  # Returns the value as a BigDecimal.
+  #
+  # The `precision` parameter is required for a rational complex number. This
+  # parameter is used to determine the number of significant digits for the
+  # result.
+  #
+  #     require 'bigdecimal'
+  #     require 'bigdecimal/util'
+  #
+  #     Complex(0.1234567, 0).to_d(4)   # => 0.1235e0
+  #     Complex(Rational(22, 7), 0).to_d(3)   # => 0.314e1
+  #
+  # See also BigDecimal::new.
+  #
+  def to_d: (*untyped args) -> BigDecimal
+end
+
+%a{annotate:rdoc:skip}
+class NilClass
+  # <!--
+  #   rdoc-file=ext/bigdecimal/lib/bigdecimal/util.rb
+  #   - nil.to_d -> bigdecimal
+  # -->
+  # Returns nil represented as a BigDecimal.
+  #
+  #     require 'bigdecimal'
+  #     require 'bigdecimal/util'
+  #
+  #     nil.to_d   # => 0.0
+  #
+  def to_d: () -> BigDecimal
+end

data/stdlib/erb/0/erb.rbs

@@ -1,3 +1,240 @@
+# <!-- rdoc-file=lib/erb.rb -->
+# # ERB -- Ruby Templating
+#
+# ## Introduction
+#
+# ERB provides an easy to use but powerful templating system for Ruby.  Using
+# ERB, actual Ruby code can be added to any plain text document for the purposes
+# of generating document information details and/or flow control.
+#
+# A very simple example is this:
+#
+#     require 'erb'
+#
+#     x = 42
+#     template = ERB.new <<-EOF
+#       The value of x is: <%= x %>
+#     EOF
+#     puts template.result(binding)
+#
+# *Prints:* The value of x is: 42
+#
+# More complex examples are given below.
+#
+# ## Recognized Tags
+#
+# ERB recognizes certain tags in the provided template and converts them based
+# on the rules below:
+#
+#     <% Ruby code -- inline with output %>
+#     <%= Ruby expression -- replace with result %>
+#     <%# comment -- ignored -- useful in testing %> (`<% #` doesn't work. Don't use Ruby comments.)
+#     % a line of Ruby code -- treated as <% line %> (optional -- see ERB.new)
+#     %% replaced with % if first thing on a line and % processing is used
+#     <%% or %%> -- replace with <% or %> respectively
+#
+# All other text is passed through ERB filtering unchanged.
+#
+# ## Options
+#
+# There are several settings you can change when you use ERB:
+# *   the nature of the tags that are recognized;
+# *   the binding used to resolve local variables in the template.
+#
+#
+# See the ERB.new and ERB#result methods for more detail.
+#
+# ## Character encodings
+#
+# ERB (or Ruby code generated by ERB) returns a string in the same character
+# encoding as the input string.  When the input string has a magic comment,
+# however, it returns a string in the encoding specified by the magic comment.
+#
+#     # -*- coding: utf-8 -*-
+#     require 'erb'
+#
+#     template = ERB.new <<EOF
+#     <%#-*- coding: Big5 -*-%>
+#       \_\_ENCODING\_\_ is <%= \_\_ENCODING\_\_ %>.
+#     EOF
+#     puts template.result
+#
+# *Prints:* _*ENCODING*_ is Big5.
+#
+# ## Examples
+#
+# ### Plain Text
+#
+# ERB is useful for any generic templating situation.  Note that in this
+# example, we use the convenient "% at start of line" tag, and we quote the
+# template literally with `%q{...}` to avoid trouble with the backslash.
+#
+#     require "erb"
+#
+#     # Create template.
+#     template = %q{
+#       From:  James Edward Gray II <james@grayproductions.net>
+#       To:  <%= to %>
+#       Subject:  Addressing Needs
+#
+#       <%= to[/\w+/] %>:
+#
+#       Just wanted to send a quick note assuring that your needs are being
+#       addressed.
+#
+#       I want you to know that my team will keep working on the issues,
+#       especially:
+#
+#       <%# ignore numerous minor requests -- focus on priorities %>
+#       % priorities.each do |priority|
+#         * <%= priority %>
+#       % end
+#
+#       Thanks for your patience.
+#
+#       James Edward Gray II
+#     }.gsub(/^  /, '')
+#
+#     message = ERB.new(template, trim_mode: "%<>")
+#
+#     # Set up template data.
+#     to = "Community Spokesman <spokesman@ruby_community.org>"
+#     priorities = [ "Run Ruby Quiz",
+#                    "Document Modules",
+#                    "Answer Questions on Ruby Talk" ]
+#
+#     # Produce result.
+#     email = message.result
+#     puts email
+#
+# *Generates:*
+#
+#     From:  James Edward Gray II <james@grayproductions.net>
+#     To:  Community Spokesman <spokesman@ruby_community.org>
+#     Subject:  Addressing Needs
+#
+#     Community:
+#
+#     Just wanted to send a quick note assuring that your needs are being addressed.
+#
+#     I want you to know that my team will keep working on the issues, especially:
+#
+#         * Run Ruby Quiz
+#         * Document Modules
+#         * Answer Questions on Ruby Talk
+#
+#     Thanks for your patience.
+#
+#     James Edward Gray II
+#
+# ### Ruby in HTML
+#
+# ERB is often used in `.rhtml` files (HTML with embedded Ruby).  Notice the
+# need in this example to provide a special binding when the template is run, so
+# that the instance variables in the Product object can be resolved.
+#
+#     require "erb"
+#
+#     # Build template data class.
+#     class Product
+#       def initialize( code, name, desc, cost )
+#         @code = code
+#         @name = name
+#         @desc = desc
+#         @cost = cost
+#
+#         @features = [ ]
+#       end
+#
+#       def add_feature( feature )
+#         @features << feature
+#       end
+#
+#       # Support templating of member data.
+#       def get_binding
+#         binding
+#       end
+#
+#       # ...
+#     end
+#
+#     # Create template.
+#     template = %{
+#       <html>
+#         <head><title>Ruby Toys -- <%= @name %></title></head>
+#         <body>
+#
+#           <h1><%= @name %> (<%= @code %>)</h1>
+#           <p><%= @desc %></p>
+#
+#           <ul>
+#             <% @features.each do |f| %>
+#               <li><b><%= f %></b></li>
+#             <% end %>
+#           </ul>
+#
+#           <p>
+#             <% if @cost < 10 %>
+#               <b>Only <%= @cost %>!!!</b>
+#             <% else %>
+#                Call for a price, today!
+#             <% end %>
+#           </p>
+#
+#         </body>
+#       </html>
+#     }.gsub(/^  /, '')
+#
+#     rhtml = ERB.new(template)
+#
+#     # Set up template data.
+#     toy = Product.new( "TZ-1002",
+#                        "Rubysapien",
+#                        "Geek's Best Friend!  Responds to Ruby commands...",
+#                        999.95 )
+#     toy.add_feature("Listens for verbal commands in the Ruby language!")
+#     toy.add_feature("Ignores Perl, Java, and all C variants.")
+#     toy.add_feature("Karate-Chop Action!!!")
+#     toy.add_feature("Matz signature on left leg.")
+#     toy.add_feature("Gem studded eyes... Rubies, of course!")
+#
+#     # Produce result.
+#     rhtml.run(toy.get_binding)
+#
+# *Generates (some blank lines removed):*
+#
+#     <html>
+#       <head><title>Ruby Toys -- Rubysapien</title></head>
+#       <body>
+#
+#         <h1>Rubysapien (TZ-1002)</h1>
+#         <p>Geek's Best Friend!  Responds to Ruby commands...</p>
+#
+#         <ul>
+#             <li><b>Listens for verbal commands in the Ruby language!</b></li>
+#             <li><b>Ignores Perl, Java, and all C variants.</b></li>
+#             <li><b>Karate-Chop Action!!!</b></li>
+#             <li><b>Matz signature on left leg.</b></li>
+#             <li><b>Gem studded eyes... Rubies, of course!</b></li>
+#         </ul>
+#
+#         <p>
+#              Call for a price, today!
+#         </p>
+#
+#       </body>
+#     </html>
+#
+# ## Notes
+#
+# There are a variety of templating solutions available in various Ruby
+# projects. For example, RDoc, distributed with Ruby, uses its own template
+# engine, which can be reused elsewhere.
+#
+# Other popular engines could be found in the corresponding
+# [Category](https://www.ruby-toolbox.com/categories/template_engines) of The
+# Ruby Toolbox.
+#
 class ERB
   # <!--
   #   rdoc-file=lib/erb.rb