rbs 2.8.4 → 3.8.1

data/stdlib/delegate/0/simple_delegator.rbs

@@ -0,0 +1,96 @@
+# <!-- rdoc-file=lib/delegate.rb -->
+# A concrete implementation of Delegator, this class provides the means to
+# delegate all supported method calls to the object passed into the constructor
+# and even to change the object being delegated to at a later time with
+# #__setobj__.
+#
+#     class User
+#       def born_on
+#         Date.new(1989, 9, 10)
+#       end
+#     end
+#
+#     require 'delegate'
+#
+#     class UserDecorator < SimpleDelegator
+#       def birth_year
+#         born_on.year
+#       end
+#     end
+#
+#     decorated_user = UserDecorator.new(User.new)
+#     decorated_user.birth_year  #=> 1989
+#     decorated_user.__getobj__  #=> #<User: ...>
+#
+# A SimpleDelegator instance can take advantage of the fact that SimpleDelegator
+# is a subclass of `Delegator` to call `super` to have methods called on the
+# object being delegated to.
+#
+#     class SuperArray < SimpleDelegator
+#       def [](*args)
+#         super + 1
+#       end
+#     end
+#
+#     SuperArray.new([1])[0]  #=> 2
+#
+# Here's a simple example that takes advantage of the fact that
+# SimpleDelegator's delegation object can be changed at any time.
+#
+#     class Stats
+#       def initialize
+#         @source = SimpleDelegator.new([])
+#       end
+#
+#       def stats(records)
+#         @source.__setobj__(records)
+#
+#         "Elements:  #{@source.size}\n" +
+#         " Non-Nil:  #{@source.compact.size}\n" +
+#         "  Unique:  #{@source.uniq.size}\n"
+#       end
+#     end
+#
+#     s = Stats.new
+#     puts s.stats(%w{James Edward Gray II})
+#     puts
+#     puts s.stats([1, 2, 3, nil, 4, 5, 1, 2])
+#
+# Prints:
+#
+#     Elements:  4
+#      Non-Nil:  4
+#       Unique:  4
+#
+#     Elements:  8
+#      Non-Nil:  7
+#       Unique:  6
+#
+class SimpleDelegator < Delegator
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - __getobj__() { || ... }
+  # -->
+  # Returns the current object method calls are being delegated to.
+  #
+  def __getobj__: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/delegate.rb
+  #   - __setobj__(obj)
+  # -->
+  # Changes the delegate object to *obj*.
+  #
+  # It's important to note that this does **not** cause SimpleDelegator's methods
+  # to change.  Because of this, you probably only want to change delegation to
+  # objects of the same type as the original delegate.
+  #
+  # Here's an example of changing the delegation object.
+  #
+  #     names = SimpleDelegator.new(%w{James Edward Gray II})
+  #     puts names[1]    # => Edward
+  #     names.__setobj__(%w{Gavin Sinclair})
+  #     puts names[1]    # => Sinclair
+  #
+  def __setobj__: (untyped obj) -> untyped
+end

data/stdlib/did_you_mean/0/did_you_mean.rbs

@@ -71,11 +71,6 @@
 #     # => NoMethodError (undefined method `zeor?' for 1:Integer)
 #
 module DidYouMean
-  # <!-- rdoc-file=lib/did_you_mean.rb -->
-  # TODO: Remove on 3.3:
-  #
-  SPELL_CHECKERS: untyped
-
   NameErrorCheckers: Object
 
   VERSION: String
@@ -243,7 +238,7 @@ module DidYouMean
     #   - requireables()
     # -->
     #
-    def self.requireables: -> Array[String]
+    def self.requireables: () -> Array[String]
 
     # <!--
     #   rdoc-file=lib/did_you_mean/spell_checkers/require_path_checker.rb
@@ -266,14 +261,14 @@ module DidYouMean
     #   - new(dictionary:)
     # -->
     #
-    def initialize: (dictionary: Array[String | Symbol]) -> void
+    def initialize: (dictionary: Array[interned]) -> void
 
     # <!--
     #   rdoc-file=lib/did_you_mean/spell_checker.rb
     #   - correct(input)
     # -->
     #
-    def correct: (String | Symbol input) -> Array[String]
+    def correct: (interned input) -> Array[String]
   end
 
   # <!-- rdoc-file=lib/did_you_mean/tree_spell_checker.rb -->

data/stdlib/digest/0/digest.rbs

@@ -51,11 +51,14 @@
 #
 # MD5
 # :   See RFC 1321 The MD5 Message-Digest Algorithm
+#
 # RIPEMD-160
 # :   As Digest::RMD160. See
 #     http://homes.esat.kuleuven.be/~bosselae/ripemd160.html.
+#
 # SHA1
 # :   See FIPS 180 Secure Hash Standard.
+#
 # SHA2 family
 # :   See FIPS 180 Secure Hash Standard which defines the following algorithms:
 #     *   SHA512
@@ -63,7 +66,6 @@
 #     *   SHA256
 #
 #
-#
 # The latest versions of the FIPS publications can be found here:
 # http://csrc.nist.gov/publications/PubsFIPS.html.
 #
@@ -74,7 +76,7 @@ module Digest
   # -->
   # Returns a BubbleBabble encoded version of a given *string*.
   #
-  def self.bubblebabble: (String) -> String
+  def self.bubblebabble: (string) -> String
 
   def self.const_missing: (Symbol name) -> singleton(::Digest::Base)
 
@@ -84,13 +86,13 @@ module Digest
   # -->
   # Generates a hex-encoded version of a given *string*.
   #
-  def self.hexencode: (String) -> String
+  def self.hexencode: (string) -> String
 
   private
 
-  def bubblebabble: (String) -> String
+  def bubblebabble: (string) -> String
 
-  def hexencode: (String) -> String
+  def hexencode: (string) -> String
 end
 
 # <!-- rdoc-file=ext/digest/lib/digest.rb -->
@@ -103,15 +105,13 @@ Digest::REQUIRE_MUTEX: Thread::Mutex
 # calculate message digest values.
 #
 module Digest::Instance
-  public
-
   # <!-- rdoc-file=ext/digest/digest.c -->
   # Updates the digest using a given *string* and returns self.
   #
   # The update() method and the left-shift operator are overridden by each
   # implementation subclass. (One should be an alias for the other)
   #
-  def <<: (String) -> self
+  def <<: (string) -> self
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -122,7 +122,7 @@ module Digest::Instance
   # of the digest object.  If another digest instance is given, checks whether
   # they have the same hash value.  Otherwise returns false.
   #
-  def ==: (::Digest::Instance | String) -> bool
+  def ==: (instance | string) -> bool
 
   # <!--
   #   rdoc-file=ext/digest/lib/digest.rb
@@ -138,7 +138,7 @@ module Digest::Instance
   # In either case, the return value is properly padded with '=' and contains no
   # line feeds.
   #
-  def base64digest: (?String? str) -> String
+  def base64digest: (?string? str) -> String
 
   # <!--
   #   rdoc-file=ext/digest/lib/digest.rb
@@ -177,7 +177,7 @@ module Digest::Instance
   # If a *string* is given, returns the hash value for the given *string*,
   # resetting the digest to the initial state before and after the process.
   #
-  def digest: (?String) -> String
+  def digest: (?string) -> String
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -204,7 +204,7 @@ module Digest::Instance
   # -->
   # Updates the digest with the contents of a given file *name* and returns self.
   #
-  def file: (String name) -> self
+  def file: (string name) -> instance
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -218,7 +218,7 @@ module Digest::Instance
   # hex-encoded form, resetting the digest to the initial state before and after
   # the process.
   #
-  def hexdigest: (?String) -> String
+  def hexdigest: (?string) -> String
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -253,7 +253,7 @@ module Digest::Instance
   # Returns a new, initialized copy of the digest object.  Equivalent to
   # digest_obj.clone().reset().
   #
-  def new: () -> ::Digest::Base
+  def new: () -> instance
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -288,7 +288,7 @@ module Digest::Instance
   # The update() method and the left-shift operator are overridden by each
   # implementation subclass. (One should be an alias for the other)
   #
-  def update: (String) -> self
+  def update: (string) -> self
 
   private
 
@@ -319,7 +319,7 @@ class Digest::Class
   # Returns the base64 encoded hash value of a given *string*.  The return value
   # is properly padded with '=' and contains no line feeds.
   #
-  def self.base64digest: (String str, *untyped) -> String
+  def self.base64digest: (string str) -> String
 
   # <!--
   #   rdoc-file=ext/digest/bubblebabble/bubblebabble.c
@@ -327,7 +327,7 @@ class Digest::Class
   # -->
   # Returns the BubbleBabble encoded hash value of a given *string*.
   #
-  def self.bubblebabble: (String, *untyped) -> String
+  def self.bubblebabble: (string) -> String
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -338,7 +338,7 @@ class Digest::Class
   # any, are passed through to the constructor and the *string* is passed to
   # #digest().
   #
-  def self.digest: (String, *untyped) -> String
+  def self.digest: (string) -> String
 
   # <!--
   #   rdoc-file=ext/digest/lib/digest.rb
@@ -350,7 +350,7 @@ class Digest::Class
   #     p Digest::SHA256.file("X11R6.8.2-src.tar.bz2").hexdigest
   #     # => "f02e3c85572dc9ad7cb77c2a638e3be24cc1b5bea9fdbb0b0299c9668475c534"
   #
-  def self.file: (String name, *untyped) -> ::Digest::Class
+  def self.file: (string name) -> instance
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -359,11 +359,11 @@ class Digest::Class
   # Returns the hex-encoded hash value of a given *string*.  This is almost
   # equivalent to Digest.hexencode(Digest::Class.new(*parameters).digest(string)).
   #
-  def self.hexdigest: (String, *untyped) -> String
+  def self.hexdigest: (string) -> String
 
   private
 
-  def initialize: () -> self
+  def initialize: () -> void
 end
 
 # <!-- rdoc-file=ext/digest/digest.c -->
@@ -400,15 +400,13 @@ end
 #     };
 #
 #     rb_ivar_set(cDigest_SHA1, rb_intern("metadata"),
-#                 Data_Wrap_Struct(0, 0, 0, (void *)&sha1));
+#                 rb_digest_make_metadata(&sha1));
 #
 class Digest::Base < Digest::Class
-  public
-
   # <!-- rdoc-file=ext/digest/digest.c -->
   # Update the digest using given *string* and return `self`.
   #
-  def <<: (String) -> self
+  def <<: (string) -> self
 
   # <!--
   #   rdoc-file=ext/digest/digest.c
@@ -434,20 +432,14 @@ class Digest::Base < Digest::Class
   #
   def reset: () -> self
 
-  # <!--
-  #   rdoc-file=ext/digest/digest.c
-  #   - digest_base.update(string) -> digest_base
-  #   - digest_base << string -> digest_base
-  # -->
-  # Update the digest using given *string* and return `self`.
-  #
-  def update: (String) -> self
+  %a{annotate:rdoc:skip}
+  alias update <<
 
   private
 
   def finish: () -> String
 
-  def initialize_copy: (::Digest::Base) -> self
+  def initialize_copy: (self) -> self
 end
 
 # <!-- rdoc-file=ext/digest/sha1/sha1init.c -->
@@ -531,12 +523,33 @@ end
 class Digest::RMD160 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/sha2init.c -->
+# Classes for calculating message digests using the SHA-256/384/512 Secure Hash
+# Algorithm(s) by NIST (the US' National Institute of Standards and Technology),
+# described in FIPS PUB 180-2.
+#
+# See SHA2.
+#
 class Digest::SHA256 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/sha2init.c -->
+# Classes for calculating message digests using the SHA-256/384/512 Secure Hash
+# Algorithm(s) by NIST (the US' National Institute of Standards and Technology),
+# described in FIPS PUB 180-2.
+#
+# See SHA2.
+#
 class Digest::SHA384 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/sha2init.c -->
+# Classes for calculating message digests using the SHA-256/384/512 Secure Hash
+# Algorithm(s) by NIST (the US' National Institute of Standards and Technology),
+# described in FIPS PUB 180-2.
+#
+# See SHA2.
+#
 class Digest::SHA512 < Digest::Base
 end
 
@@ -560,5 +573,5 @@ class Object
   #     Digest(:Foo)
   #     # => LoadError: library not found for class Digest::Foo -- digest/foo
   #
-  def Digest: (String | Symbol name) -> singleton(::Digest::Base)
+  def Digest: (interned name) -> singleton(::Digest::Base)
 end

data/stdlib/erb/0/erb.rbs

@@ -41,7 +41,6 @@
 # *   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
@@ -286,11 +285,11 @@ class ERB
   #       def build
   #         b = binding
   #         # create and run templates, filling member data variables
-  #         ERB.new(<<-'END_PRODUCT'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@product").result b
+  #         ERB.new(<<~'END_PRODUCT', trim_mode: "", eoutvar: "@product").result b
   #           <%= PRODUCT[:name] %>
   #           <%= PRODUCT[:desc] %>
   #         END_PRODUCT
-  #         ERB.new(<<-'END_PRICE'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@price").result b
+  #         ERB.new(<<~'END_PRICE', trim_mode: "", eoutvar: "@price").result b
   #           <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
   #           <%= PRODUCT[:desc] %>
   #         END_PRICE
@@ -447,9 +446,6 @@ class ERB
   #
   def def_class: (?Class, ?String) -> Class
 
-  # <!-- rdoc-file=lib/erb.rb -->
-  # A utility module for conversion routines, often handy in HTML generation.
-  #
   module Util
     # <!--
     #   rdoc-file=lib/erb.rb
@@ -483,7 +479,7 @@ class ERB
     alias self.h self.html_escape
 
     # <!--
-    #   rdoc-file=lib/erb.rb
+    #   rdoc-file=lib/erb/util.rb
     #   - url_encode(s)
     # -->
     # A utility method for encoding the String *s* as a URL.
@@ -500,52 +496,23 @@ class ERB
     def self?.url_encode: (String) -> String
 
     # <!--
-    #   rdoc-file=lib/erb.rb
+    #   rdoc-file=lib/erb/util.rb
     #   - u(s)
     # -->
     #
     alias u url_encode
 
     # <!--
-    #   rdoc-file=lib/erb.rb
+    #   rdoc-file=lib/erb/util.rb
     #   - u(s)
     # -->
     #
     alias self.u self.url_encode
   end
 
-  # <!-- rdoc-file=lib/erb.rb -->
-  # Utility module to define eRuby script as instance method.
-  #
-  # ### Example
-  #
-  # example.rhtml:
-  #     <% for item in @items %>
-  #     <b><%= item %></b>
-  #     <% end %>
-  #
-  # example.rb:
-  #     require 'erb'
-  #     class MyClass
-  #       extend ERB::DefMethod
-  #       def_erb_method('render()', 'example.rhtml')
-  #       def initialize(items)
-  #         @items = items
-  #       end
-  #     end
-  #     print MyClass.new([10,20,30]).render()
-  #
-  # result:
-  #
-  #     <b>10</b>
-  #
-  #     <b>20</b>
-  #
-  #     <b>30</b>
-  #
   module DefMethod
     # <!--
-    #   rdoc-file=lib/erb.rb
+    #   rdoc-file=lib/erb/def_method.rb
     #   - def_erb_method(methodname, erb_or_fname)
     # -->
     # define *methodname* as instance method of current module, using ERB object or
@@ -553,4 +520,13 @@ class ERB
     #
     def self.def_erb_method: (String methodname, (String | ERB) erb_or_fname) -> untyped
   end
+
+  module Escape
+    # <!--
+    #   rdoc-file=lib/erb/util.rb
+    #   - html_escape(s)
+    # -->
+    #
+    def self?.html_escape: (String) -> String
+  end
 end