rbs 4.0.0.dev.4 → 4.0.0

data/core/rbs/unnamed/env_class.rbs

@@ -34,7 +34,7 @@ module RBS
     #         ENV[''] = '0'
     #         # Raises Errno::EINVAL (Invalid argument - ruby_setenv())
     #
-    # *   May not contain character `"="`:
+    # *   May not contain character <code>"="</code>:
     #         ENV['='] = '0'
     #         # Raises Errno::EINVAL (Invalid argument - ruby_setenv(=))
     #
@@ -47,7 +47,7 @@ module RBS
     #         ENV[Object.new] = '0'
     #         # Raises TypeError (no implicit conversion of Object into String)
     #
-    # *   May not contain the NUL character `"\0"`:
+    # *   May not contain the NUL character <code>"\0"</code>:
     #
     #         ENV['foo'] = "\0"
     #         # Raises ArgumentError (bad environment variable value: contains null byte)
@@ -140,7 +140,7 @@ module RBS
     #
     # *   ::assoc: Returns a 2-element array containing the name and value of the
     #     named environment variable if it exists:
-    # *   ::clone: Returns `ENV` (and issues a warning).
+    # *   ::clone: Raises an exception.
     # *   ::except: Returns a hash of all name/value pairs except those given.
     # *   ::fetch: Returns the value for the given name.
     # *   ::inspect: Returns the contents of `ENV` as a string.
@@ -156,7 +156,7 @@ module RBS
     # *   ::to_a: Returns the entries as an array of 2-element Arrays.
     # *   ::to_h: Returns a hash of entries selected by the block.
     # *   ::to_hash: Returns a hash of all entries.
-    # *   ::to_s: Returns the string `'ENV'`.
+    # *   ::to_s: Returns the string <code>'ENV'</code>.
     # *   ::values: Returns all values as an array.
     # *   ::values_at: Returns an array of the values for the given name.
     #
@@ -1001,11 +1001,12 @@ module RBS
       #     ENV.include?('baz') # => false
       #
       # Returns `false` if `name` is the empty String or is a String containing
-      # character `'='`:
+      # character <code>'='</code>:
       #     ENV.include?('') # => false
       #     ENV.include?('=') # => false
       #
-      # Raises an exception if `name` is a String containing the NUL character `"\0"`:
+      # Raises an exception if `name` is a String containing the NUL character
+      # <code>"\0"</code>:
       #     ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)
       #
       # Raises an exception if `name` has an encoding that is not ASCII-compatible:
@@ -1034,11 +1035,12 @@ module RBS
       #     ENV.include?('baz') # => false
       #
       # Returns `false` if `name` is the empty String or is a String containing
-      # character `'='`:
+      # character <code>'='</code>:
       #     ENV.include?('') # => false
       #     ENV.include?('=') # => false
       #
-      # Raises an exception if `name` is a String containing the NUL character `"\0"`:
+      # Raises an exception if `name` is a String containing the NUL character
+      # <code>"\0"</code>:
       #     ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)
       #
       # Raises an exception if `name` has an encoding that is not ASCII-compatible:
@@ -1067,11 +1069,12 @@ module RBS
       #     ENV.include?('baz') # => false
       #
       # Returns `false` if `name` is the empty String or is a String containing
-      # character `'='`:
+      # character <code>'='</code>:
       #     ENV.include?('') # => false
       #     ENV.include?('=') # => false
       #
-      # Raises an exception if `name` is a String containing the NUL character `"\0"`:
+      # Raises an exception if `name` is a String containing the NUL character
+      # <code>"\0"</code>:
       #     ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)
       #
       # Raises an exception if `name` has an encoding that is not ASCII-compatible:
@@ -1132,11 +1135,12 @@ module RBS
       #     ENV.include?('baz') # => false
       #
       # Returns `false` if `name` is the empty String or is a String containing
-      # character `'='`:
+      # character <code>'='</code>:
       #     ENV.include?('') # => false
       #     ENV.include?('=') # => false
       #
-      # Raises an exception if `name` is a String containing the NUL character `"\0"`:
+      # Raises an exception if `name` is a String containing the NUL character
+      # <code>"\0"</code>:
       #     ENV.include?("\0") # Raises ArgumentError (bad environment variable name: contains null byte)
       #
       # Raises an exception if `name` has an encoding that is not ASCII-compatible:
@@ -1173,9 +1177,10 @@ module RBS
       # variable.
       #
       # Returns `nil` if `name` is the empty String or is a String containing
-      # character `'='`.
+      # character <code>'='</code>.
       #
-      # Raises an exception if `name` is a String containing the NUL character `"\0"`:
+      # Raises an exception if `name` is a String containing the NUL character
+      # <code>"\0"</code>:
       #     ENV.assoc("\0") # Raises ArgumentError (bad environment variable name: contains null byte)
       #
       # Raises an exception if `name` has an encoding that is not ASCII-compatible:

data/core/rbs/unnamed/main_class.rbs

@@ -0,0 +1,123 @@
+module RBS
+  module Unnamed
+    class TopLevelSelfClass
+      private
+
+      # <!--
+      #   rdoc-file=eval.c
+      #   - include(module, ...)    -> self
+      # -->
+      # Invokes Module.append_features on each parameter in reverse order.
+      #
+      %a{annotate:rdoc:copy:Module#include}
+      def include: (Module, *Module arg0) -> self
+
+      # <!--
+      #   rdoc-file=eval.c
+      #   - using(module)    -> self
+      # -->
+      # Import class refinements from *module* into the current class or module
+      # definition.
+      #
+      %a{annotate:rdoc:copy:Module#using}
+      def using: (Module arg0) -> self
+
+      # <!--
+      #   rdoc-file=proc.c
+      #   - define_method(symbol, method)     -> symbol
+      #   - define_method(symbol) { block }   -> symbol
+      # -->
+      # Defines an instance method in the receiver. The *method* parameter can be a
+      # `Proc`, a `Method` or an `UnboundMethod` object. If a block is specified, it
+      # is used as the method body. If a block or the *method* parameter has
+      # parameters, they're used as method parameters. This block is evaluated using
+      # #instance_eval.
+      #
+      #     class A
+      #       def fred
+      #         puts "In Fred"
+      #       end
+      #       def create_method(name, &block)
+      #         self.class.define_method(name, &block)
+      #       end
+      #       define_method(:wilma) { puts "Charge it!" }
+      #       define_method(:flint) {|name| puts "I'm #{name}!"}
+      #     end
+      #     class B < A
+      #       define_method(:barney, instance_method(:fred))
+      #     end
+      #     a = B.new
+      #     a.barney
+      #     a.wilma
+      #     a.flint('Dino')
+      #     a.create_method(:betty) { p self }
+      #     a.betty
+      #
+      # <em>produces:</em>
+      #
+      #     In Fred
+      #     Charge it!
+      #     I'm Dino!
+      #     #<B:0x401b39e8>
+      #
+      %a{annotate:rdoc:copy:Module#define_method}
+      def define_method: (interned symbol, ^(?) [self: top] -> untyped | Method | UnboundMethod method) -> Symbol
+                       | (interned symbol) { (?) [self: top] -> untyped } -> Symbol
+
+      # <!--
+      #   rdoc-file=vm_method.c
+      #   - public                                -> nil
+      #   - public(method_name)                   -> method_name
+      #   - public(method_name, method_name, ...) -> array
+      #   - public(array)                         -> array
+      # -->
+      # With no arguments, sets the default visibility for subsequently defined
+      # methods to public. With arguments, sets the named methods to have public
+      # visibility. String arguments are converted to symbols. An Array of Symbols
+      # and/or Strings is also accepted. If a single argument is passed, it is
+      # returned. If no argument is passed, nil is returned. If multiple arguments are
+      # passed, the arguments are returned as an array.
+      #
+      %a{annotate:rdoc:copy:Module#public}
+      def public: () -> nil
+                | (Symbol method_name) -> Symbol
+                | (Symbol, Symbol, *Symbol method_name) -> Array[Symbol]
+                | (string method_name) -> string
+                | (interned, interned, *interned method_name) -> Array[interned]
+                | (Array[interned]) -> Array[interned]
+
+      # <!--
+      #   rdoc-file=vm_method.c
+      #   - private                                -> nil
+      #   - private(method_name)                   -> method_name
+      #   - private(method_name, method_name, ...) -> array
+      #   - private(array)                         -> array
+      # -->
+      # With no arguments, sets the default visibility for subsequently defined
+      # methods to private. With arguments, sets the named methods to have private
+      # visibility. String arguments are converted to symbols. An Array of Symbols
+      # and/or Strings is also accepted. If a single argument is passed, it is
+      # returned. If no argument is passed, nil is returned. If multiple arguments are
+      # passed, the arguments are returned as an array.
+      #
+      #     module Mod
+      #       def a()  end
+      #       def b()  end
+      #       private
+      #       def c()  end
+      #       private :a
+      #     end
+      #     Mod.private_instance_methods   #=> [:a, :c]
+      #
+      # Note that to show a private method on RDoc, use <code>:doc:</code>.
+      #
+      %a{annotate:rdoc:copy:Module#private}
+      def private: () -> nil
+                 | (Symbol method_name) -> Symbol
+                 | (Symbol, Symbol, *Symbol method_name) -> Array[Symbol]
+                 | (string method_name) -> string
+                 | (interned, interned, *interned method_name) -> Array[interned]
+                 | (Array[interned]) -> Array[interned]
+    end
+  end
+end

data/core/rbs/unnamed/random.rbs

@@ -31,12 +31,14 @@ module RBS
       #     prng.rand(100)       # => 42
       #
       # When `max` is a Float, `rand` returns a random floating point number between
-      # 0.0 and `max`, including 0.0 and excluding `max`.
+      # 0.0 and `max`, including 0.0 and excluding `max`. Note that it behaves
+      # differently from Kernel.rand.
       #
-      #     prng.rand(1.5)       # => 1.4600282860034115
+      #     prng.rand(1.5)  # => 1.4600282860034115
+      #     rand(1.5)       # => 0
       #
       # When `range` is a Range, `rand` returns a random number where
-      # `range.member?(number) == true`.
+      # <code>range.member?(number) == true</code>.
       #
       #     prng.rand(5..9)      # => one of [5, 6, 7, 8, 9]
       #     prng.rand(5...9)     # => one of [5, 6, 7, 8]
@@ -44,7 +46,8 @@ module RBS
       #     prng.rand(5.0...9.0) # => between 5.0 and 9.0, excluding 9.0
       #
       # Both the beginning and ending values of the range must respond to subtract
-      # (`-`) and add (`+`)methods, or rand will raise an ArgumentError.
+      # (<code>-</code>) and add (<code>+</code>)methods, or rand will raise an
+      # ArgumentError.
       #
       %a{annotate:rdoc:copy:Random#rand}
       def rand: (?0) -> Float
@@ -85,9 +88,10 @@ module RBS
     # <!-- rdoc-file=lib/random/formatter.rb -->
     # ## Random number formatter.
     #
-    # 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.
+    # Formats generated random numbers in many manners. When
+    # <code>'random/formatter'</code> is required, several methods are added to
+    # empty core module <code>Random::Formatter</code>, 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.
@@ -146,56 +150,6 @@ module RBS
     #
     %a{annotate:rdoc:copy:Random::Formatter}
     module Random_Formatter
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - base64(n=nil)
-      # -->
-      # Generate a random base64 string.
-      #
-      # The argument *n* specifies the length, in bytes, of the random number to be
-      # generated. The length of the result string is about 4/3 of *n*.
-      #
-      # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
-      # future.
-      #
-      # The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
-      #     # or
-      #     prng = Random.new
-      #     prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
-      #
-      # See RFC 3548 for the definition of base64.
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#base64}
-      def base64: (?Integer? n) -> String
-
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - hex(n=nil)
-      # -->
-      # Generate a random hexadecimal string.
-      #
-      # The argument *n* specifies the length, in bytes, of the random number to be
-      # generated. The length of the resulting hexadecimal string is twice of *n*.
-      #
-      # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
-      # future.
-      #
-      # The result may contain 0-9 and a-f.
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
-      #     # or
-      #     prng = Random.new
-      #     prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#hex}
-      def hex: (?Integer? n) -> String
-
       # <!-- rdoc-file=random.c -->
       # Generates formatted random number from raw random bytes. See Random#rand.
       #
@@ -208,9 +162,6 @@ module RBS
               | (::Range[Integer] n) -> Integer
               | (::Range[Numeric] n) -> Numeric
 
-      %a{annotate:rdoc:copy:Random::Formatter#random_byte}
-      def random_bytes: (?Integer? n) -> String
-
       # <!--
       #   rdoc-file=random.c
       #   - prng.random_number        -> float
@@ -230,64 +181,6 @@ module RBS
                        | (?::Range[Float]? n) -> Float
                        | (?::Range[Integer]? n) -> Integer
                        | (?::Range[Numeric]? n) -> Numeric
-
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - urlsafe_base64(n=nil, padding=false)
-      # -->
-      # Generate a random URL-safe base64 string.
-      #
-      # The argument *n* specifies the length, in bytes, of the random number to be
-      # generated. The length of the result string is about 4/3 of *n*.
-      #
-      # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
-      # future.
-      #
-      # The boolean argument *padding* specifies the padding. If it is false or nil,
-      # padding is not generated. Otherwise padding is generated. By default, padding
-      # is not generated because "=" may be used as a URL delimiter.
-      #
-      # The result may contain A-Z, a-z, 0-9, "-" and "_". "=" is also used if
-      # *padding* is true.
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
-      #     # or
-      #     prng = Random.new
-      #     prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
-      #
-      #     prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
-      #     prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
-      #
-      # See RFC 3548 for the definition of URL-safe base64.
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#urlsafe_base64}
-      def urlsafe_base64: (?Integer? n, ?boolish padding) -> String
-
-      # <!--
-      #   rdoc-file=lib/random/formatter.rb
-      #   - uuid()
-      # -->
-      # Generate a random v4 UUID (Universally Unique IDentifier).
-      #
-      #     require 'random/formatter'
-      #
-      #     Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
-      #     Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
-      #     # or
-      #     prng = Random.new
-      #     prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
-      #
-      # The version 4 UUID is purely random (except the version). It doesn't contain
-      # meaningful information such as MAC addresses, timestamps, etc.
-      #
-      # The result contains 122 random bits (15.25 random bytes).
-      #
-      # See [RFC9562](https://www.rfc-editor.org/rfc/rfc9562) for details of UUIDv4.
-      #
-      %a{annotate:rdoc:copy:Random::Formatter#uuid}
-      def uuid: () -> String
     end
   end
 end