rbs 0.2.0

data/stdlib/builtin/random.rbs

@@ -0,0 +1,267 @@
+# Random provides an interface to Ruby's pseudo-random number generator, or
+# PRNG.  The PRNG produces a deterministic sequence of bits which approximate
+# true randomness. The sequence may be represented by integers, floats, or
+# binary strings.
+#
+# The generator may be initialized with either a system-generated or
+# user-supplied seed value by using Random.srand.
+#
+# The class method Random.rand provides the base functionality of Kernel.rand
+# along with better handling of floating point values. These are both interfaces
+# to Random::DEFAULT, the Ruby system PRNG.
+#
+# Random.new will create a new PRNG with a state independent of Random::DEFAULT,
+# allowing multiple generators with different seed values or sequence positions
+# to exist simultaneously. Random objects can be marshaled, allowing sequences
+# to be saved and resumed.
+#
+# PRNGs are currently implemented as a modified Mersenne Twister with a period
+# of 2**19937-1.
+#
+class Random < Object
+  include Random::Formatter
+
+  # Returns true if the two generators have the same internal state, otherwise
+  # false.  Equivalent generators will return the same sequence of pseudo-random
+  # numbers.  Two generators will generally have the same state only if they were
+  # initialized with the same seed
+  #
+  #     Random.new == Random.new             # => false
+  #     Random.new(1234) == Random.new(1234) # => true
+  #
+  # and have the same invocation history.
+  #
+  #     prng1 = Random.new(1234)
+  #     prng2 = Random.new(1234)
+  #     prng1 == prng2 # => true
+  #
+  #     prng1.rand     # => 0.1915194503788923
+  #     prng1 == prng2 # => false
+  #
+  #     prng2.rand     # => 0.1915194503788923
+  #     prng1 == prng2 # => true
+  #
+  def ==: (untyped arg0) -> bool
+
+  # Returns a random binary string containing `size` bytes.
+  #
+  #     random_string = Random.new.bytes(10) # => "\xD7:R\xAB?\x83\xCE\xFAkO"
+  #     random_string.size                   # => 10
+  #
+  def bytes: (Integer size) -> String
+
+  # Creates a new PRNG using `seed` to set the initial state. If `seed` is
+  # omitted, the generator is initialized with Random.new_seed.
+  #
+  # See Random.srand for more information on the use of seed values.
+  #
+  def initialize: (?Integer seed) -> void
+
+  # When `max` is an Integer, `rand` returns a random integer greater than or
+  # equal to zero and less than `max`. Unlike Kernel.rand, when `max` is a
+  # negative integer or zero, `rand` raises an ArgumentError.
+  #
+  #     prng = Random.new
+  #     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`.
+  #
+  #     prng.rand(1.5)       # => 1.4600282860034115
+  #
+  # When `max` is a Range, `rand` returns a random number where
+  # range.member?(number) == true.
+  #
+  #     prng.rand(5..9)      # => one of [5, 6, 7, 8, 9]
+  #     prng.rand(5...9)     # => one of [5, 6, 7, 8]
+  #     prng.rand(5.0..9.0)  # => between 5.0 and 9.0, including 9.0
+  #     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.
+  #
+  def rand: () -> Float
+          | (Integer | ::Range[Integer] max) -> Integer
+          | (Float | ::Range[Float] max) -> Float
+
+  # Returns the seed value used to initialize the generator. This may be used to
+  # initialize another generator with the same state at a later time, causing it
+  # to produce the same sequence of numbers.
+  #
+  #     prng1 = Random.new(1234)
+  #     prng1.seed       #=> 1234
+  #     prng1.rand(100)  #=> 47
+  #
+  #     prng2 = Random.new(prng1.seed)
+  #     prng2.rand(100)  #=> 47
+  #
+  def seed: () -> Integer
+
+  # Returns an arbitrary seed value. This is used by Random.new when no seed value
+  # is specified as an argument.
+  #
+  #     Random.new_seed  #=> 115032730400174366788466674494640623225
+  #
+  def self.new_seed: () -> Integer
+
+  # Alias of Random::DEFAULT.rand.
+  #
+  def self.rand: (?Integer max) -> Numeric
+
+  # Seeds the system pseudo-random number generator, Random::DEFAULT, with
+  # `number`.  The previous seed value is returned.
+  #
+  # If `number` is omitted, seeds the generator using a source of entropy provided
+  # by the operating system, if available (/dev/urandom on Unix systems or the RSA
+  # cryptographic provider on Windows), which is then combined with the time, the
+  # process id, and a sequence number.
+  #
+  # srand may be used to ensure repeatable sequences of pseudo-random numbers
+  # between different runs of the program. By setting the seed to a known value,
+  # programs can be made deterministic during testing.
+  #
+  #     srand 1234               # => 268519324636777531569100071560086917274
+  #     [ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]
+  #     [ rand(10), rand(1000) ] # => [4, 664]
+  #     srand 1234               # => 1234
+  #     [ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]
+  #
+  def self.srand: (?Integer number) -> Numeric
+end
+
+# The default Pseudorandom number generator.  Used by class methods of Random.
+#
+#
+Random::DEFAULT: Random
+
+# Format raw random number as Random does
+#
+#
+module Random::Formatter
+  # SecureRandom.base64 generates 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 'securerandom'
+  #
+  #     SecureRandom.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
+  #     SecureRandom.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
+  #
+  # If a secure random number generator is not available, `NotImplementedError` is
+  # raised.
+  #
+  # See RFC 3548 for the definition of base64.
+  #
+  def base64: (?Integer? n) -> String
+
+  # SecureRandom.hex generates 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 'securerandom'
+  #
+  #     SecureRandom.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
+  #     SecureRandom.hex #=> "91dc3bfb4de5b11d029d376634589b61"
+  #
+  # If a secure random number generator is not available, `NotImplementedError` is
+  # raised.
+  #
+  def hex: (?Integer? n) -> String
+
+  # Generates formatted random number from raw random bytes. See Random#rand.
+  #
+  def rand: () -> Float
+          | (?Float? n) -> Float
+          | (?Integer? n) -> Integer
+          | (?Numeric? n) -> Numeric
+          | (?::Range[Float]? n) -> Float
+          | (?::Range[Integer]? n) -> Integer
+          | (?::Range[Numeric]? n) -> Numeric
+
+  # SecureRandom.random_bytes generates a random binary string.
+  #
+  # The argument *n* specifies the length of the result string.
+  #
+  # If *n* is not specified or is nil, 16 is assumed. It may be larger in future.
+  #
+  # The result may contain any byte: "x00" - "xff".
+  #
+  #     require 'securerandom'
+  #
+  #     SecureRandom.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
+  #     SecureRandom.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
+  #
+  # If a secure random number generator is not available, `NotImplementedError` is
+  # raised.
+  #
+  def random_bytes: (?Integer? n) -> String
+
+  # Generates formatted random number from raw random bytes. See Random#rand.
+  #
+  def random_number: () -> Float
+                   | (?Float? n) -> Float
+                   | (?Integer? n) -> Integer
+                   | (?Numeric? n) -> Numeric
+                   | (?::Range[Float]? n) -> Float
+                   | (?::Range[Integer]? n) -> Integer
+                   | (?::Range[Numeric]? n) -> Numeric
+
+  # SecureRandom.urlsafe_base64 generates 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 'securerandom'
+  #
+  #     SecureRandom.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
+  #     SecureRandom.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
+  #
+  #     SecureRandom.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
+  #     SecureRandom.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
+  #
+  # If a secure random number generator is not available, `NotImplementedError` is
+  # raised.
+  #
+  # See RFC 3548 for the definition of URL-safe base64.
+  #
+  def urlsafe_base64: (?Integer? n, ?bool padding) -> String
+
+  # SecureRandom.uuid generates a random v4 UUID (Universally Unique IDentifier).
+  #
+  #     require 'securerandom'
+  #
+  #     SecureRandom.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
+  #     SecureRandom.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
+  #     SecureRandom.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 RFC 4122 for details of UUID.
+  #
+  def uuid: () -> String
+end

data/stdlib/builtin/range.rbs

@@ -0,0 +1,226 @@
+# A `Range` represents an interval—a set of values with a beginning and an
+# end. Ranges may be constructed using the *s* `..` *e* and *s* `...` *e*
+# literals, or with [::new](Range#method-c-new).
+# Ranges constructed using `..` run from the beginning to the end
+# inclusively. Those created using `...` exclude the end value. When used
+# as an iterator, ranges return each value in the sequence.
+#
+# ```ruby
+# (-1..-5).to_a      #=> []
+# (-5..-1).to_a      #=> [-5, -4, -3, -2, -1]
+# ('a'..'e').to_a    #=> ["a", "b", "c", "d", "e"]
+# ('a'...'e').to_a   #=> ["a", "b", "c", "d"]
+# ```
+#
+#
+# An “endless range” represents a semi-infinite range. Literal notation
+# for an endless range is:
+#
+#     (1..)
+#     # or similarly
+#     (1...)
+#
+# Which is equivalent to
+#
+# ```ruby
+# (1..nil)  # or similarly (1...nil)
+# Range.new(1, nil) # or Range.new(1, nil, true)
+# ```
+#
+# Endless ranges are useful, for example, for idiomatic slicing of arrays:
+#
+#     [1, 2, 3, 4, 5][2...]   # => [3, 4, 5]
+#
+# Some implementation details:
+#
+#   - `end` of endless range is `nil` ;
+#
+#   - `each` of endless range enumerates infinite sequence (may be useful
+#     in combination with
+#     [Enumerable\#take\_while](https://ruby-doc.org/core-2.6.3/Enumerable.html#method-i-take_while)
+#     or similar methods);
+#
+#   - `(1..)` and `(1...)` are not equal, although technically
+#     representing the same sequence.
+#
+#
+# Ranges can be constructed using any objects that can be compared using
+# the `<=>` operator. Methods that treat the range as a sequence (\#each
+# and methods inherited from
+# [Enumerable](https://ruby-doc.org/core-2.6.3/Enumerable.html) ) expect
+# the begin object to implement a `succ` method to return the next object
+# in sequence. The [step](Range#method-i-step) and
+# [include?](Range#method-i-include-3F) methods
+# require the begin object to implement `succ` or to be numeric.
+#
+# In the `Xs` class below both `<=>` and `succ` are implemented so `Xs`
+# can be used to construct ranges. Note that the
+# [Comparable](https://ruby-doc.org/core-2.6.3/Comparable.html) module is
+# included so the `==` method is defined in terms of `<=>` .
+#
+# ```ruby
+# class Xs                # represent a string of 'x's
+#   include Comparable
+#   attr :length
+#   def initialize(n)
+#     @length = n
+#   end
+#   def succ
+#     Xs.new(@length + 1)
+#   end
+#   def <=>(other)
+#     @length <=> other.length
+#   end
+#   def to_s
+#     sprintf "%2d #{inspect}", @length
+#   end
+#   def inspect
+#     'x' * @length
+#   end
+# end
+# ```
+#
+# An example of using `Xs` to construct a range:
+#
+# ```ruby
+# r = Xs.new(3)..Xs.new(6)   #=> xxx..xxxxxx
+# r.to_a                     #=> [xxx, xxxx, xxxxx, xxxxxx]
+# r.member?(Xs.new(5))       #=> true
+# ```
+class Range[Elem] < Object
+  include Enumerable[Elem, Range[Elem]]
+
+  def self.new: [U] (U from, U to, ?bool exclude_end) -> ::Range[U]
+
+  def ==: (untyped obj) -> bool
+
+  def ===: (untyped obj) -> bool
+
+  # Returns the object that defines the beginning of the range.
+  #
+  # ```ruby
+  # (1..10).begin   #=> 1
+  # ```
+  def begin: () -> Elem
+
+  def bsearch: [U] () { (Elem arg0) -> bool } -> U?
+
+  def cover?: (untyped obj) -> bool
+
+  def each: () { (Elem arg0) -> untyped } -> self
+          | () -> ::Enumerator[Elem, self]
+
+  # Returns the object that defines the end of the range.
+  #
+  # ```ruby
+  # (1..10).end    #=> 10
+  # (1...10).end   #=> 10
+  # ```
+  def `end`: () -> Elem
+
+  # Returns `true` if the range excludes its end value.
+  #
+  # ```ruby
+  # (1..5).exclude_end?     #=> false
+  # (1...5).exclude_end?    #=> true
+  # ```
+  def `exclude_end?`: () -> bool
+
+  # Returns the first object in the range, or an array of the first `n`
+  # elements.
+  #
+  # ```ruby
+  # (10..20).first     #=> 10
+  # (10..20).first(3)  #=> [10, 11, 12]
+  # ```
+  def first: () -> Elem
+           | (?Integer n) -> ::Array[Elem]
+
+  # Compute a hash-code for this range. Two ranges with equal begin and end
+  # points (using `eql?` ), and the same
+  # [exclude\_end?](Range.downloaded.ruby_doc#method-i-exclude_end-3F) value
+  # will generate the same hash-code.
+  #
+  # See also Object\#hash.
+  def hash: () -> Integer
+
+  def `include?`: (untyped obj) -> bool
+
+  def initialize: (Elem _begin, Elem _end, ?bool exclude_end) -> void
+
+  # Convert this range object to a printable form (using `inspect` to
+  # convert the begin and end objects).
+  def inspect: () -> String
+
+  # Returns the last object in the range, or an array of the last `n`
+  # elements.
+  #
+  # Note that with no arguments `last` will return the object that defines
+  # the end of the range even if
+  # [exclude\_end?](Range.downloaded.ruby_doc#method-i-exclude_end-3F) is
+  # `true` .
+  #
+  # ```ruby
+  # (10..20).last      #=> 20
+  # (10...20).last     #=> 20
+  # (10..20).last(3)   #=> [18, 19, 20]
+  # (10...20).last(3)  #=> [17, 18, 19]
+  # ```
+  def last: () -> Elem
+          | (?Integer n) -> ::Array[Elem]
+
+  # Returns the maximum value in the range. Returns `nil` if the begin value
+  # of the range larger than the end value. Returns `nil` if the begin value
+  # of an exclusive range is equal to the end value.
+  #
+  # Can be given an optional block to override the default comparison method
+  # `a <=> b` .
+  #
+  # ```ruby
+  # (10..20).max    #=> 20
+  # ```
+  def max: () -> Elem
+         | () { (Elem arg0, Elem arg1) -> Integer } -> Elem
+         | (?Integer n) -> ::Array[Elem]
+         | (?Integer n) { (Elem arg0, Elem arg1) -> Integer } -> ::Array[Elem]
+
+  # Returns the minimum value in the range. Returns `nil` if the begin value
+  # of the range is larger than the end value. Returns `nil` if the begin
+  # value of an exclusive range is equal to the end value.
+  #
+  # Can be given an optional block to override the default comparison method
+  # `a <=> b` .
+  #
+  # ```ruby
+  # (10..20).min    #=> 10
+  # ```
+  def min: () -> Elem
+         | () { (Elem arg0, Elem arg1) -> Integer } -> Elem
+         | (?Integer n) -> ::Array[Elem]
+         | (?Integer n) { (Elem arg0, Elem arg1) -> Integer } -> ::Array[Elem]
+
+  # Returns the number of elements in the range. Both the begin and the end
+  # of the [Range](Range.downloaded.ruby_doc) must be
+  # [Numeric](https://ruby-doc.org/core-2.6.3/Numeric.html), otherwise nil
+  # is returned.
+  #
+  # ```ruby
+  # (10..20).size    #=> 11
+  # ('a'..'z').size  #=> nil
+  # (-Float::INFINITY..Float::INFINITY).size #=> Infinity
+  # ```
+  def size: () -> Integer?
+          | () -> Float?
+
+  def step: (?Integer n) { (Elem arg0) -> untyped } -> self
+          | (?Integer n) -> ::Enumerator[Elem, void]
+
+  # Convert this range object to a printable form (using
+  # [to\_s](Range.downloaded.ruby_doc#method-i-to_s) to convert the begin
+  # and end objects).
+  def to_s: () -> String
+
+  def eql?: (untyped obj) -> bool
+
+  def member?: (untyped obj) -> bool
+end