rbs 3.9.4 → 4.1.1

data/stdlib/date/0/date_time.rbs

@@ -24,10 +24,10 @@
 #                         #=> #<DateTime: 2001-02-03T12:00:00+00:00 ...>
 #
 # An optional argument, the offset, indicates the difference between the local
-# time and UTC. For example, `Rational(3,24)` represents ahead of 3 hours of
-# UTC, `Rational(-5,24)` represents behind of 5 hours of UTC. The offset should
-# be -1 to +1, and its precision is assumed at most second. The default value is
-# zero (equals to UTC).
+# time and UTC. For example, <code>Rational(3,24)</code> represents ahead of 3
+# hours of UTC, <code>Rational(-5,24)</code> represents behind of 5 hours of
+# UTC. The offset should be -1 to +1, and its precision is assumed at most
+# second. The default value is zero (equals to UTC).
 #
 #     DateTime.new(2001,2,3,4,5,6,Rational(3,24))
 #                         #=> #<DateTime: 2001-02-03T04:05:06+03:00 ...>
@@ -39,7 +39,7 @@
 #
 # An optional argument, the day of calendar reform (`start`), denotes a Julian
 # day number, which should be 2298874 to 2426355 or negative/positive infinity.
-# The default value is `Date::ITALY` (2299161=1582-10-15).
+# The default value is <code>Date::ITALY</code> (2299161=1582-10-15).
 #
 # A DateTime object has various methods. See each reference.
 #
@@ -183,8 +183,8 @@ class DateTime < Date
   #                               #=> #<DateTime: 2001-02-03T04:05:06+00:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.httpdate: (String str, ?Integer start) -> DateTime
 
@@ -203,8 +203,8 @@ class DateTime < Date
   #                               #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.iso8601: (String str, ?Integer start) -> DateTime
 
@@ -237,8 +237,8 @@ class DateTime < Date
   #                               #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.jisx0301: (String str, ?Integer start) -> DateTime
 
@@ -288,8 +288,8 @@ class DateTime < Date
   #                               #=> #<DateTime: 2001-02-03T16:05:06+00:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.parse: (String str, ?boolish complete, ?Integer start) -> DateTime
 
@@ -305,8 +305,8 @@ class DateTime < Date
   #                              #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.rfc2822: (String str, ?Integer start) -> DateTime
 
@@ -321,8 +321,8 @@ class DateTime < Date
   #                               #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.rfc3339: (String str, ?Integer start) -> DateTime
 
@@ -338,8 +338,8 @@ class DateTime < Date
   #                              #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.rfc822: (String str, ?Integer start) -> DateTime
 
@@ -383,8 +383,8 @@ class DateTime < Date
   #                               #=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
   #
   # Raise an ArgumentError when the string length is longer than *limit*. You can
-  # stop this check by passing `limit: nil`, but note that it may take a long time
-  # to parse.
+  # stop this check by passing <code>limit: nil</code>, but note that it may take
+  # a long time to parse.
   #
   def self.xmlschema: (String str, ?Integer start) -> DateTime
 
@@ -393,8 +393,9 @@ class DateTime < Date
   #   - deconstruct_keys(array_of_names_or_nil) -> hash
   # -->
   # Returns a hash of the name/value pairs, to use in pattern matching. Possible
-  # keys are: `:year`, `:month`, `:day`, `:wday`, `:yday`, `:hour`, `:min`,
-  # `:sec`, `:sec_fraction`, `:zone`.
+  # keys are: <code>:year</code>, <code>:month</code>, <code>:day</code>,
+  # <code>:wday</code>, <code>:yday</code>, <code>:hour</code>, <code>:min</code>,
+  # <code>:sec</code>, <code>:sec_fraction</code>, <code>:zone</code>.
   #
   # Possible usages:
   #
@@ -555,7 +556,7 @@ class DateTime < Date
   #     DateTime.now.strftime # => "2022-07-01T11:03:19-05:00"
   #
   # For other formats, see [Formats for Dates and
-  # Times](rdoc-ref:strftime_formatting.rdoc):
+  # Times](rdoc-ref:language/strftime_formatting.rdoc):
   #
   def strftime: (?String format) -> String
 

data/stdlib/delegate/0/delegator.rbs

@@ -44,7 +44,7 @@ class Delegator < BasicObject
   #   rdoc-file=lib/delegate.rb
   #   - !()
   # -->
-  # Delegates ! to the _*getobj*_
+  # Delegates ! to the `__getobj__`
   #
   def !: () -> untyped
 
@@ -94,7 +94,7 @@ class Delegator < BasicObject
   #   rdoc-file=lib/delegate.rb
   #   - freeze()
   # -->
-  # :method: freeze Freeze both the object returned by _*getobj*_ and self.
+  # Freeze both the object returned by `__getobj__` and self.
   #
   def freeze: () -> self
 
@@ -102,7 +102,7 @@ class Delegator < BasicObject
   #   rdoc-file=lib/delegate.rb
   #   - marshal_dump()
   # -->
-  # Serialization support for the object returned by _*getobj*_.
+  # Serialization support for the object returned by `__getobj__`.
   #
   def marshal_dump: () -> untyped
 
@@ -118,6 +118,7 @@ class Delegator < BasicObject
   #   rdoc-file=lib/delegate.rb
   #   - method_missing(m, *args, &block)
   # -->
+  # Handles the magic of delegation through `__getobj__`.
   #
   def method_missing: (Symbol m, *untyped args, **untyped) { (*untyped, **untyped) -> untyped } -> untyped
 
@@ -126,7 +127,7 @@ class Delegator < BasicObject
   #   - methods(all=true)
   # -->
   # Returns the methods available to this delegate object as the union of this
-  # object's and _*getobj*_ methods.
+  # object's and `__getobj__` methods.
   #
   def methods: (?boolish all) -> Array[Symbol]
 
@@ -135,7 +136,7 @@ class Delegator < BasicObject
   #   - protected_methods(all=true)
   # -->
   # Returns the methods available to this delegate object as the union of this
-  # object's and _*getobj*_ protected methods.
+  # object's and `__getobj__` protected methods.
   #
   def protected_methods: (?boolish all) -> Array[Symbol]
 
@@ -144,7 +145,7 @@ class Delegator < BasicObject
   #   - public_methods(all=true)
   # -->
   # Returns the methods available to this delegate object as the union of this
-  # object's and _*getobj*_ public methods.
+  # object's and `__getobj__` public methods.
   #
   def public_methods: (?untyped all) -> Array[Symbol]
 
@@ -168,7 +169,7 @@ class Delegator < BasicObject
   #   - respond_to_missing?(m, include_private)
   # -->
   # Checks for a method provided by this the delegate object by forwarding the
-  # call through _*getobj*_.
+  # call through `__getobj__`.
   #
   def respond_to_missing?: (Symbol m, bool include_private) -> bool
 
@@ -180,5 +181,8 @@ class Delegator < BasicObject
   #
   def target_respond_to?: (untyped target, Symbol m, bool include_private) -> bool
 
+  # <!-- rdoc-file=lib/delegate.rb -->
+  # The version string
+  #
   VERSION: String
 end

data/stdlib/did_you_mean/0/did_you_mean.rbs

@@ -38,7 +38,7 @@
 #
 # Occasionally, you may want to disable the `did_you_mean` gem for e.g.
 # debugging issues in the error object itself. You can disable it entirely by
-# specifying `--disable-did_you_mean` option to the `ruby` command:
+# specifying <code>--disable-did_you_mean</code> option to the `ruby` command:
 #
 #     $ ruby --disable-did_you_mean -e "1.zeor?"
 #     -e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
@@ -55,7 +55,7 @@
 #
 # Sometimes, you do not want to disable the gem entirely, but need to get the
 # original error message without suggestions (e.g. testing). In this case, you
-# could use the `#original_message` method on the error object:
+# could use the <code>#original_message</code> method on the error object:
 #
 #     no_method_error = begin
 #                         1.zeor?
@@ -92,9 +92,9 @@ module DidYouMean
   end
 
   # <!-- rdoc-file=lib/did_you_mean/formatter.rb -->
-  # The `DidYouMean::Formatter` is the basic, default formatter for the gem. The
-  # formatter responds to the `message_for` method and it returns a human readable
-  # string.
+  # The <code>DidYouMean::Formatter</code> is the basic, default formatter for the
+  # gem. The formatter responds to the `message_for` method and it returns a human
+  # readable string.
   #
   class Formatter
     # <!--
@@ -170,15 +170,16 @@ module DidYouMean
     NAMES_TO_EXCLUDE: Hash[untyped, Array[Symbol]]
 
     # <!-- rdoc-file=lib/did_you_mean/spell_checkers/method_name_checker.rb -->
-    # `MethodNameChecker::RB_RESERVED_WORDS` is the list of reserved words in Ruby
-    # that take an argument. Unlike `VariableNameChecker::RB_RESERVED_WORDS`, these
-    # reserved words require an argument, and a `NoMethodError` is raised due to the
-    # presence of the argument.
+    # <code>MethodNameChecker::RB_RESERVED_WORDS</code> is the list of reserved
+    # words in Ruby that take an argument. Unlike
+    # <code>VariableNameChecker::RB_RESERVED_WORDS</code>, these reserved words
+    # require an argument, and a `NoMethodError` is raised due to the presence of
+    # the argument.
     #
     # The `MethodNameChecker` will use this list to suggest a reversed word if a
     # `NoMethodError` is raised and found closest matches.
     #
-    # Also see `VariableNameChecker::RB_RESERVED_WORDS`.
+    # Also see <code>VariableNameChecker::RB_RESERVED_WORDS</code>.
     #
     RB_RESERVED_WORDS: Array[Symbol]
 
@@ -295,19 +296,19 @@ module DidYouMean
     NAMES_TO_EXCLUDE: Hash[String, Array[Symbol]]
 
     # <!-- rdoc-file=lib/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb -->
-    # `VariableNameChecker::RB_RESERVED_WORDS` is the list of all reserved words in
-    # Ruby. They could be declared like methods are, and a typo would cause Ruby to
-    # raise a `NameError` because of the way they are declared.
+    # <code>VariableNameChecker::RB_RESERVED_WORDS</code> is the list of all
+    # reserved words in Ruby. They could be declared like methods are, and a typo
+    # would cause Ruby to raise a `NameError` because of the way they are declared.
     #
-    # The `:VariableNameChecker` will use this list to suggest a reversed word if a
-    # `NameError` is raised and found closest matches, excluding:
+    # The <code>:VariableNameChecker</code> will use this list to suggest a reversed
+    # word if a `NameError` is raised and found closest matches, excluding:
     #
     #     * +do+
     #     * +if+
     #     * +in+
     #     * +or+
     #
-    # Also see `MethodNameChecker::RB_RESERVED_WORDS`.
+    # Also see <code>MethodNameChecker::RB_RESERVED_WORDS</code>.
     #
     RB_RESERVED_WORDS: Array[Symbol]
 

data/stdlib/digest/0/digest.rbs

@@ -303,7 +303,7 @@ module Digest::Instance
   # uninitialized.  Do not call this method from outside.  Use #digest!() instead,
   # which ensures that internal data be reset for security reasons.
   #
-  def finish: () -> self
+  def finish: () -> String
 end
 
 # <!-- rdoc-file=ext/digest/digest.c -->
@@ -471,6 +471,122 @@ end
 class Digest::SHA1 < Digest::Base
 end
 
+# <!-- rdoc-file=ext/digest/sha2/lib/sha2.rb -->
+# A meta digest provider class for SHA256, SHA384 and SHA512.
+#
+# FIPS 180-2 describes SHA2 family of digest algorithms. It defines three
+# algorithms:
+# *   one which works on chunks of 512 bits and returns a 256-bit digest
+#     (SHA256),
+# *   one which works on chunks of 1024 bits and returns a 384-bit digest
+#     (SHA384),
+# *   and one which works on chunks of 1024 bits and returns a 512-bit digest
+#     (SHA512).
+#
+# ## Examples
+#     require 'digest'
+#
+#     # Compute a complete digest
+#     Digest::SHA2.hexdigest 'abc'          # => "ba7816bf8..."
+#     Digest::SHA2.new(256).hexdigest 'abc' # => "ba7816bf8..."
+#     Digest::SHA256.hexdigest 'abc'        # => "ba7816bf8..."
+#
+#     Digest::SHA2.new(384).hexdigest 'abc' # => "cb00753f4..."
+#     Digest::SHA384.hexdigest 'abc'        # => "cb00753f4..."
+#
+#     Digest::SHA2.new(512).hexdigest 'abc' # => "ddaf35a19..."
+#     Digest::SHA512.hexdigest 'abc'        # => "ddaf35a19..."
+#
+#     # Compute digest by chunks
+#     sha2 = Digest::SHA2.new               # =>#<Digest::SHA2:256>
+#     sha2.update "ab"
+#     sha2 << "c"                           # alias for #update
+#     sha2.hexdigest                        # => "ba7816bf8..."
+#
+#     # Use the same object to compute another digest
+#     sha2.reset
+#     sha2 << "message"
+#     sha2.hexdigest                        # => "ab530a13e..."
+#
+class Digest::SHA2 < Digest::Class
+  # <!--
+  #   rdoc-file=ext/digest/sha2/lib/sha2.rb
+  #   - Digest::SHA2.new(bitlen = 256) -> digest_obj
+  # -->
+  # Create a new SHA2 hash object with a given bit length.
+  #
+  # Valid bit lengths are 256, 384 and 512.
+  #
+  def initialize: (?(256 | 384 | 512) bitlen) -> void
+
+  # <!--
+  #   rdoc-file=ext/digest/sha2/lib/sha2.rb
+  #   - digest_obj.reset -> digest_obj
+  # -->
+  # Reset the digest to the initial state and return self.
+  #
+  def reset: () -> self
+
+  # <!--
+  #   rdoc-file=ext/digest/sha2/lib/sha2.rb
+  #   - digest_obj.update(string) -> digest_obj
+  #   - digest_obj << string -> digest_obj
+  # -->
+  # Update the digest using a given *string* and return self.
+  #
+  def update: (String) -> self
+
+  # <!--
+  #   rdoc-file=ext/digest/digest.c
+  #   - digest_obj.instance_eval { finish } -> digest_obj
+  # -->
+  # Finishes the digest and returns the resulting hash value.
+  #
+  # This method is overridden by each implementation subclass and often made
+  # private, because some of those subclasses may leave internal data
+  # uninitialized.  Do not call this method from outside.  Use #digest!() instead,
+  # which ensures that internal data be reset for security reasons.
+  #
+  private def finish: () -> String
+
+  alias << update
+
+  # <!--
+  #   rdoc-file=ext/digest/sha2/lib/sha2.rb
+  #   - digest_obj.block_length -> Integer
+  # -->
+  # Return the block length of the digest in bytes.
+  #
+  #     Digest::SHA256.new.block_length * 8
+  #     # => 512
+  #     Digest::SHA384.new.block_length * 8
+  #     # => 1024
+  #     Digest::SHA512.new.block_length * 8
+  #     # => 1024
+  #
+  def block_length: () -> Integer
+
+  # <!--
+  #   rdoc-file=ext/digest/sha2/lib/sha2.rb
+  #   - digest_obj.digest_length -> Integer
+  # -->
+  # Return the length of the hash value (the digest) in bytes.
+  #
+  #     Digest::SHA256.new.digest_length * 8
+  #     # => 256
+  #     Digest::SHA384.new.digest_length * 8
+  #     # => 384
+  #     Digest::SHA512.new.digest_length * 8
+  #     # => 512
+  #
+  # For example, digests produced by Digest::SHA256 will always be 32 bytes (256
+  # bits) in size.
+  #
+  def digest_length: () -> Integer
+
+  def initialize_copy: (untyped) -> untyped
+end
+
 # <!-- rdoc-file=ext/digest/md5/md5init.c -->
 # A class for calculating message digests using the MD5 Message-Digest Algorithm
 # by RSA Data Security, Inc., described in RFC1321.