rbs 2.8.4 → 3.8.1

data/core/random.rbs

@@ -20,6 +20,9 @@
 # of 2**19937-1.  As this algorithm is *not* for cryptographical use, you must
 # use SecureRandom for security purpose, instead of this PRNG.
 #
+# See also Random::Formatter module that adds convenience methods to generate
+# various forms of random data.
+#
 class Random < RBS::Unnamed::Random_Base
   # <!--
   #   rdoc-file=random.c
@@ -88,7 +91,7 @@ class Random < RBS::Unnamed::Random_Base
   #
   # See also Random#rand.
   #
-  def self.rand: () -> Float
+  def self.rand: (?0) -> Float
                | (Integer | ::Range[Integer] max) -> Integer
                | (Float | ::Range[Float] max) -> Float
                | [T < Numeric] (::Range[T]) -> T
@@ -164,15 +167,18 @@ class Random < RBS::Unnamed::Random_Base
   def state: () -> untyped
 end
 
-Random::DEFAULT: Random
-
 class Random::Base < RBS::Unnamed::Random_Base
 end
 
 # <!-- rdoc-file=lib/random/formatter.rb -->
 # ## Random number formatter.
 #
-# Formats generated random numbers in many manners.
+# Formats generated random numbers in many manners. When `'random/formatter'` is
+# required, several methods are added to empty core module `Random::Formatter`,
+# making them available as Random's instance and module methods.
+#
+# Standard library SecureRandom is also extended with the module, and the
+# methods described below are available as a module methods in it.
 #
 # ### Examples
 #
@@ -180,30 +186,41 @@ end
 #
 #     require 'random/formatter'
 #
+#     prng = Random.new
 #     prng.hex(10) #=> "52750b30ffbc7de3b362"
 #     prng.hex(10) #=> "92b15d6c8dc4beb5f559"
 #     prng.hex(13) #=> "39b290146bea6ce975c37cfc23"
+#     # or just
+#     Random.hex #=> "1aed0c631e41be7f77365415541052ee"
 #
 # Generate random base64 strings:
 #
 #     prng.base64(10) #=> "EcmTPZwWRAozdA=="
 #     prng.base64(10) #=> "KO1nIU+p9DKxGg=="
 #     prng.base64(12) #=> "7kJSM/MzBJI+75j8"
+#     Random.base64(4) #=> "bsQ3fQ=="
 #
 # Generate random binary strings:
 #
 #     prng.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
 #     prng.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
+#     Random.random_bytes(6) #=> "\xA1\xE6Lr\xC43"
 #
 # Generate alphanumeric strings:
 #
 #     prng.alphanumeric(10) #=> "S8baxMJnPl"
 #     prng.alphanumeric(10) #=> "aOxAg8BAJe"
+#     Random.alphanumeric #=> "TmP9OsJHJLtaZYhP"
 #
 # Generate UUIDs:
 #
 #     prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
 #     prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+#     Random.uuid #=> "f14e0271-de96-45cc-8911-8910292a42cd"
+#
+# All methods are available in the standard library SecureRandom, too:
+#
+#     SecureRandom.hex #=> "05b45376a30c67238eb93b16499e50cf"
 #
 # <!-- rdoc-file=random.c -->
 # Generate a random number in the given range as Random does