rbs 1.3.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd9429b1384739e9aae5f7b2c1d19ee02b6ea34b49e4a17a60df270acc484a0
-  data.tar.gz: 931456b6cb01870a8ac178115effe3d13f8ce8e5968a94954b702c4c7a1f3645
+  metadata.gz: fb7050ff50eb28c830dd0b36c6f36a5d1913342daf67096313b2abf6d5285dbe
+  data.tar.gz: 4ee896f45c1857cea2f15a6cc69fd976c15055a36bb77cec51c669dfb56cc79e
 SHA512:
-  metadata.gz: c8b595190e9c69217b56d494859d759caa545bd4902a7a2f4ae679bc34720d5e64385b40f48cd77191ea1fe5c06237cd1774372d20abf7d3530308e1648ddd9c
-  data.tar.gz: b85b23a46f0cd32fc4b45a90cd5f82b7029d9c37a36af0ccf26e61ae36cd43e0ca71e5c77350546e141e404abf4e8027f43f80b31de371e19aef9379f9a825ab
+  metadata.gz: 3aa3aa5be6922a746a36012cb3c5ba624a44d0ed5dac05790942ebf44bb7f4f44a107209465a69143282b33e9a18b7b4f820d093b6228f0a091c0fb190268e32
+  data.tar.gz: fa46604d3d6b154555084d4d77861dbc8eae77d54f88486cf6df691da4b605576569f7d55acac1deeb3b30202ea561c9cf221ac44c8aab6acbe0cd483f7d786d

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "bundler"
+    directory: "/steep"
+    schedule:
+      interval: "daily"

data/CHANGELOG.md

@@ -2,6 +2,75 @@
 
 ## master
 
+## 1.6.0 (2021-09-05)
+
+This release includes a preview of `rbs collection` commands, which is _bundler for RBS_.
+The command helps you manage RBS files from gem_rbs_collection or other repositories.
+
+This feature is a preview, and any feedback is welcome!
+
+## Signature updates
+
+* objspace ([\#763](https://github.com/ruby/rbs/pull/763), [\#776](https://github.com/ruby/rbs/pull/776))
+* tempfile ([\#767](https://github.com/ruby/rbs/pull/767), [\#775](https://github.com/ruby/rbs/pull/775))
+* `IO#set_encoding_by_bom` ([\#106](https://github.com/ruby/rbs/pull/106))
+* `OpenSSL::PKey::EC#dh_compute_key` ([\#775](https://github.com/ruby/rbs/pull/775))
+
+## Library changes
+
+* Add `rbs collection` ([\#589](https://github.com/ruby/rbs/pull/589), [\#772](https://github.com/ruby/rbs/pull/772), [\#773](https://github.com/ruby/rbs/pull/773))
+
+## Miscellaneous
+
+* Let `bin/annotate-with-rdoc` process nested constants/classes ([\#766](https://github.com/ruby/rbs/pull/766), [\#768](https://github.com/ruby/rbs/pull/768))
+* Stop printing version mismatch message in CI ([\#777](https://github.com/ruby/rbs/pull/777))
+* Update Steep and fix type errors ([\#770](https://github.com/ruby/rbs/pull/770), [\#774](https://github.com/ruby/rbs/pull/774))
+* Add dependabot configuration ([\#771](https://github.com/ruby/rbs/pull/771))
+
+## 1.5.1 (2021-08-22)
+
+### Miscellaneous
+
+* Fix Net_HTTP_test ([\#759](https://github.com/ruby/rbs/pull/759))
+
+## 1.5.0 (2021-08-22)
+
+This release includes stdlib signature updates.
+
+### Signature updates
+
+* digest ([\#744](https://github.com/ruby/rbs/pull/744), [\#757](https://github.com/ruby/rbs/pull/757))
+* io-wait ([\#756](https://github.com/ruby/rbs/pull/756), [\#758](https://github.com/ruby/rbs/pull/758))
+* `Ractor` ([\#755](https://github.com/ruby/rbs/pull/755))
+* `File::Stat#size?` ([\#754](https://github.com/ruby/rbs/pull/754))
+* `$-i`, `$0`, `$PROGRAM_NAME` ([\#753](https://github.com/ruby/rbs/pull/753))
+
+## 1.4.0 (2021-08-19)
+
+This release includes feature enhancements including recursive `type` definition validation, improved compatibility of global variable names, and various method type updates.
+
+### Signature updates
+
+* openssl ([\#743](https://github.com/ruby/rbs/pull/743))
+* `Array`, `Enumerator`, `Enumerable`, `Hash`, `FalseClass`, `Float`, `Hash`, `Integer`, `Object`, `Range`, `TrueClass` ([\#728](https://github.com/ruby/rbs/pull/728))
+* `Array#[]` ([\#732](https://github.com/ruby/rbs/pull/732))
+* `Exception#set_backtrace` ([\#738](https://github.com/ruby/rbs/pull/738))
+* `Kernel#Array` ([\#733](https://github.com/ruby/rbs/pull/733))
+* `Kernel#spawn` ([\#748](https://github.com/ruby/rbs/pull/748))
+* `Kernel#String` ([\#745](https://github.com/ruby/rbs/pull/745), [\#751](https://github.com/ruby/rbs/pull/751))
+* `URI::Generic#fragment` ([\#752](https://github.com/ruby/rbs/pull/752))
+* `URI::Generic#merge` ([\#746](https://github.com/ruby/rbs/pull/746))
+
+### Language updates
+
+* Add global variables signature ([\#749](https://github.com/ruby/rbs/pull/749))
+
+### Library changes
+
+* Add Recursiive type alias defnition validation ([\#719](https://github.com/ruby/rbs/pull/719))
+* Generate included modules with complete name ([\#731](https://github.com/ruby/rbs/pull/731))
+* Fix `rbs-prototype-rb` error when multi assign with const ([\#740](https://github.com/ruby/rbs/pull/740))
+
 ## 1.3.3 (2021-07-28)
 
 This release includes a minor update of `resolv` library RBS and a fix of test for `ruby/ruby` CI.

data/Gemfile

@@ -15,6 +15,8 @@ gem "json-schema"
 gem 'stackprof'
 gem "goodcheck"
 gem "dbm"
+gem 'digest'
+gem 'tempfile'
 
 # Test gems
 gem "rbs-amber", path: "test/assets/test-gem"

data/Rakefile

@@ -63,6 +63,10 @@ task :validate => :parser do
       lib << "timeout"
     end
 
+    if lib == ["openssl"]
+      lib << "socket"
+    end
+
     sh "#{ruby} #{rbs} #{lib.map {|l| "-r #{l}"}.join(" ")} validate --silent"
   end
 end

data/Steepfile

@@ -1,13 +1,21 @@
+D = Steep::Diagnostic
+
 target :lib do
   signature "sig"
   check "lib"
   ignore "lib/rbs/parser.rb"
   ignore "lib/rbs/prototype", "lib/rbs/test", "lib/rbs/test.rb"
 
-  library "set", "pathname", "json", "logger", "monitor", "tsort"
+  library "set", "pathname", "json", "logger", "monitor", "tsort", "uri"
   signature "stdlib/strscan/0/"
   signature "stdlib/rubygems/0/"
   signature "stdlib/optparse/0/"
+
+  configure_code_diagnostics do |config|
+    config[D::Ruby::MethodDefinitionMissing] = :hint
+    config[D::Ruby::ElseOnExhaustiveCase] = :hint
+    config[D::Ruby::FallbackAny] = :hint
+  end
 end
 
 # target :lib do

data/core/array.rbs

@@ -452,7 +452,7 @@ class Array[unchecked out Elem] < Object
   #
   def []: (int index) -> Elem
         | (int start, int length) -> ::Array[Elem]?
-        | (::Range[::Integer] range) -> ::Array[Elem]?
+        | (::Range[::Integer?] range) -> ::Array[Elem]?
 
   # Element Assignment --- Sets the element at `index`, or replaces a subarray
   # from the `start` index for `length` elements, or replaces a subarray specified
@@ -486,9 +486,9 @@ class Array[unchecked out Elem] < Object
          | (int start, int length, Elem obj) -> Elem
          | (int start, int length, ::Array[Elem]) -> ::Array[Elem]
          | (int start, int length, nil) -> nil
-         | (::Range[::Integer], Elem obj) -> Elem
-         | (::Range[::Integer], ::Array[Elem]) -> ::Array[Elem]
-         | (::Range[::Integer], nil) -> nil
+         | (::Range[::Integer?], Elem obj) -> Elem
+         | (::Range[::Integer?], ::Array[Elem]) -> ::Array[Elem]
+         | (::Range[::Integer?], nil) -> nil
 
   # See also Enumerable#all?
   #
@@ -576,7 +576,8 @@ class Array[unchecked out Elem] < Object
   # true/false, or always return a number.  It is undefined which value is
   # actually picked up at each iteration.
   #
-  def bsearch: () { (Elem) -> (true | false) } -> Elem?
+  def bsearch: () -> ::Enumerator[Elem, Elem?]
+             | () { (Elem) -> (true | false) } -> Elem?
              | () { (Elem) -> ::Integer } -> Elem?
 
   # By using binary search, finds an index of a value from this array which meets
@@ -855,7 +856,7 @@ class Array[unchecked out Elem] < Object
   #     0 -- 1 -- 2 --
   #
   def each_index: () { (::Integer index) -> void } -> self
-                | () -> ::Enumerator[Elem, self]
+                | () -> ::Enumerator[::Integer, self]
 
   # Returns `true` if `self` contains no elements.
   #
@@ -1585,7 +1586,7 @@ class Array[unchecked out Elem] < Object
   #     a.sample(4, random: Random.new(1))  #=> [6, 10, 9, 2]
   #
   def sample: (?random: _Rand rng) -> Elem?
-            | (?int n, ?random: _Rand rng) -> ::Array[Elem]
+            | (int n, ?random: _Rand rng) -> ::Array[Elem]
 
   # Returns a new array containing all elements of `ary` for which the given
   # `block` returns a true value.

data/core/builtin.rbs

@@ -31,7 +31,7 @@ interface _Each[out A]
 end
 
 interface _Reader
-  def read: (?int length, ?string outbuf) -> String?
+  def read: (?int? length, ?string outbuf) -> String?
 end
 
 interface _ReaderPartial

data/core/enumerable.rbs

@@ -48,7 +48,8 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   def collect: [U] () { (Elem arg0) -> U } -> ::Array[U]
              | () -> ::Enumerator[Elem, ::Array[untyped]]
 
-  def collect_concat: [U] () { (Elem arg0) -> ::Enumerator[U, untyped] } -> ::Array[U]
+  def collect_concat: [U] () { (Elem) -> (::Array[U] | U) } -> ::Array[U]
+                    | () -> ::Enumerator[Elem, ::Array[untyped]]
 
   # Returns the number of items in `enum` through enumeration. If an
   # argument is given, the number of items in `enum` that are equal to
@@ -79,11 +80,11 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   def each_cons: (Integer n) { (::Array[Elem] arg0) -> untyped } -> NilClass
                | (Integer n) -> ::Enumerator[::Array[Elem], NilClass]
 
-  def each_with_index: () { (Elem arg0, Integer arg1) -> untyped } -> void
-                     | () -> ::Enumerator[[ Elem, Integer ], void]
+  def each_with_index: () { (Elem, Integer index) -> untyped } -> self
+                     | () -> ::Enumerator[[ Elem, Integer ], self]
 
-  def each_with_object: [U] (U arg0) { (Elem arg0, untyped arg1) -> untyped } -> U
-                      | [U] (U arg0) -> ::Enumerator[[ Elem, U ], U]
+  def each_with_object: [U] (U obj) { (Elem, U obj) -> untyped } -> U
+                      | [U] (U obj) -> ::Enumerator[[ Elem, U ], U]
 
   # Returns an array containing the items in *enum* .
   #
@@ -102,7 +103,7 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   alias select find_all
   alias filter find_all
 
-  def find_index: (?untyped value) -> Integer?
+  def find_index: (untyped value) -> Integer?
                 | () { (Elem) -> boolish } -> Integer?
                 | () -> ::Enumerator[Elem, Integer?]
 
@@ -123,8 +124,8 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   def grep: (untyped arg0) -> ::Array[Elem]
           | [U] (untyped arg0) { (Elem arg0) -> U } -> ::Array[U]
 
-  def grep_v: (untyped arg0) -> ::Array[Integer]
-            | [U] (untyped arg0) { (Elem arg0) -> U } -> ::Array[U]
+  def grep_v: (untyped) -> ::Array[Elem]
+            | [U] (untyped) { (Elem) -> U } -> ::Array[U]
 
   def group_by: [U] () { (Elem arg0) -> U } -> ::Hash[U, ::Array[Elem]]
               | () -> ::Enumerator[Elem, ::Array[Elem]]
@@ -410,8 +411,8 @@ module Enumerable[unchecked out Elem]: _Each[Elem]
   def zip: [Elem2] (::Enumerable[Elem2] enum) -> ::Array[[Elem, Elem2 | nil]]
          | [U, Elem2] (::Enumerable[Elem2]) { ([Elem, Elem2 | nil]) -> U } -> nil
 
-  def chunk: [U] () { (Elem elt) -> U } -> ::Enumerator[[U, Array[Elem]], void]
-           | () -> ::Enumerator[Elem, Enumerator[untyped, untyped]]
+  def chunk: [U] () { (Elem elt) -> U } -> ::Enumerator[[U, ::Array[Elem]], void]
+           | () -> ::Enumerator[Elem, ::Enumerator[[untyped, ::Array[Elem]], void]]
 
   def chunk_while: () { (Elem elt_before, Elem elt_after) -> boolish } -> ::Enumerator[::Array[Elem], void]
 

data/core/enumerator.rbs

@@ -238,8 +238,8 @@ class Enumerator[unchecked out Elem, out Return] < Object
   def with_index: (?Integer offset) { (Elem arg0, Integer arg1) -> untyped } -> Return
                 | (?Integer offset) -> ::Enumerator[[ Elem, Integer ], Return]
 
-  def with_object: [U] (U arg0) { (Elem arg0, U arg1) -> untyped } -> U
-                 | [U] (U arg0) -> ::Enumerator[[ Elem, U ], Return]
+  def with_object: [U] (U obj) { (Elem, U obj) -> untyped } -> U
+                 | [U] (U obj) -> ::Enumerator[[ Elem, U ], U]
 end
 
 class Enumerator::Generator[out Elem] < Object

data/core/exception.rbs

@@ -185,6 +185,7 @@ class Exception < Object
   def message: () -> String
 
   def set_backtrace: (String | ::Array[String] arg0) -> ::Array[String]
+                   | (nil) -> nil
 
   # Returns exception’s message (or the name of the exception if no message
   # is set).

data/core/false_class.rbs

@@ -5,12 +5,12 @@
 class FalseClass
   public
 
-  def !: () -> bool
+  def !: () -> true
 
   # And---Returns `false`. *obj* is always evaluated as it is the argument to a
   # method call---there is no short-circuit evaluation in this case.
   #
-  def &: (untyped obj) -> bool
+  def &: (untyped obj) -> false
 
   # Case Equality -- For class Object, effectively the same as calling `#==`, but
   # typically overridden by descendants to provide meaningful semantics in `case`
@@ -24,7 +24,7 @@ class FalseClass
   #
   def ^: (nil) -> false
        | (false) -> false
-       | (untyped obj) -> bool
+       | (untyped obj) -> true
 
   alias inspect to_s
 
@@ -36,5 +36,5 @@ class FalseClass
   #
   def |: (nil) -> false
        | (false) -> false
-       | (untyped obj) -> bool
+       | (untyped obj) -> true
 end

data/core/file.rbs

@@ -1042,7 +1042,7 @@ class File::Stat < Object
 
   def rdev_minor: () -> Integer
 
-  def read: (?Integer length, ?String outbuf) -> String
+  def read: (?int? length, ?string outbuf) -> String?
 
   def readable?: () -> bool
 
@@ -1054,6 +1054,8 @@ class File::Stat < Object
 
   def size: () -> Integer
 
+  def size?: () -> Integer?
+
   def socket?: () -> bool
 
   def sticky?: () -> bool

data/core/float.rbs

@@ -180,7 +180,7 @@ class Float < Numeric
   #     1.2.coerce(3)       #=> [3.0, 1.2]
   #     2.5.coerce(1.1)     #=> [1.1, 2.5]
   #
-  def coerce: (Numeric) -> [Numeric, Numeric]
+  def coerce: (Numeric) -> [Float, Float]
 
   def conj: () -> Float
 

data/core/global_variables.rbs

@@ -0,0 +1,180 @@
+# The Exception object set by Kernel#raise.
+$!: Exception | nil
+
+# The array contains the module names loaded by require.
+$": Array[String]
+
+# The process number of the Ruby running this script. Same as Process.pid.
+$$: Integer
+
+# The string matched by the last successful match.
+$&: String | nil
+
+# The string to the right of the last successful match.
+$': String | nil
+
+# The same as ARGV.
+$*: Array[String]
+
+# The highest group matched by the last successful match.
+$+: String | nil
+
+# The output field separator for Kernel#print and Array#join. Non-nil $, will be deprecated.
+$,: String | nil
+
+# The input record separator, newline by default.
+$-0: String | nil
+
+# The default separator for String#split. Non-nil $; will be deprecated.
+$-F: Regexp | String | nil
+
+# Load path for searching Ruby scripts and extension libraries used
+# by Kernel#load and Kernel#require.
+# Has a singleton method <code>$LOAD_PATH.resolve_feature_path(feature)</code>
+# that returns [+:rb+ or +:so+, path], which resolves the feature to
+# the path the original Kernel#require method would load.
+$-I: Array[String]
+
+$-W: 0 | 1 | 2
+
+# True if option <tt>-a</tt> is set. Read-only variable.
+$-a: bool
+
+# The debug flag, which is set by the <tt>-d</tt> switch.  Enabling debug
+# output prints each exception raised to $stderr (but not its
+# backtrace).  Setting this to a true value enables debug output as
+# if <tt>-d</tt> were given on the command line.  Setting this to a false
+# value disables debug output.
+$-d: bool
+
+# In in-place-edit mode, this variable holds the extension, otherwise +nil+.
+$-i: String?
+
+# True if option <tt>-l</tt> is set. Read-only variable.
+$-l: bool
+
+# True if option <tt>-p</tt> is set. Read-only variable.
+$-p: bool
+
+# The verbose flag, which is set by the <tt>-w</tt> or <tt>-v</tt> switch.
+# Setting this to a true value enables warnings as if <tt>-w</tt> or <tt>-v</tt> were given
+# on the command line.  Setting this to +nil+ disables warnings,
+# including from Kernel#warn.
+$-v: bool | nil
+
+# The verbose flag, which is set by the <tt>-w</tt> or <tt>-v</tt> switch.
+# Setting this to a true value enables warnings as if <tt>-w</tt> or <tt>-v</tt> were given
+# on the command line.  Setting this to +nil+ disables warnings,
+# including from Kernel#warn.
+$-w: bool | nil
+
+# The current input line number of the last file that was read.
+$.: Integer
+
+# The input record separator, newline by default. Aliased to $-0.
+$/: String | nil
+
+# Contains the name of the script being executed. May be assignable.
+$0: String
+
+# The Nth group of the last successful match. May be > 1.
+$1: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$2: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$3: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$4: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$5: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$6: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$7: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$8: String | nil
+
+# The Nth group of the last successful match. May be > 1.
+$9: String | nil
+
+# Load path for searching Ruby scripts and extension libraries used
+# by Kernel#load and Kernel#require.
+# Has a singleton method <code>$LOAD_PATH.resolve_feature_path(feature)</code>
+# that returns [+:rb+ or +:so+, path], which resolves the feature to
+# the path the original Kernel#require method would load.
+$:: Array[String]
+
+# The default separator for String#split. Non-nil $; will be deprecated. Aliased to $-F.
+$;: Regexp | String | nil
+
+# The same as ARGF.
+$<: IO
+
+# This variable is no longer effective. Deprecated.
+$=: bool
+
+# The default output stream for Kernel#print and Kernel#printf. $stdout by default.
+$>: IO
+
+# The status of the last executed child process (thread-local).
+$?: Process::Status | nil
+
+# The same as <code>$!.backtrace</code>.
+$@: Array[String] | nil
+
+# The debug flag, which is set by the <tt>-d</tt> switch.  Enabling debug
+# output prints each exception raised to $stderr (but not its
+# backtrace).  Setting this to a true value enables debug output as
+# if <tt>-d</tt> were given on the command line.  Setting this to a false
+# value disables debug output. Aliased to $-d.
+$DEBUG: bool
+
+# Current input filename from ARGF. Same as ARGF.filename.
+$FILENAME: String
+
+# The array contains the module names loaded by require.
+$LOADED_FEATURES: Array[String]
+
+# Load path for searching Ruby scripts and extension libraries used
+# by Kernel#load and Kernel#require. Aliased to $: and $-I.
+# Has a singleton method <code>$LOAD_PATH.resolve_feature_path(feature)</code>
+# that returns [+:rb+ or +:so+, path], which resolves the feature to
+# the path the original Kernel#require method would load.
+$LOAD_PATH: Array[String]
+
+# Contains the name of the script being executed. May be assignable.
+$PROGRAM_NAME: String
+
+# The verbose flag, which is set by the <tt>-w</tt> or <tt>-v</tt> switch.
+# Setting this to a true value enables warnings as if <tt>-w</tt> or <tt>-v</tt> were given
+# on the command line.  Setting this to +nil+ disables warnings,
+# including from Kernel#warn. Aliased to $-v and $-w.
+$VERBOSE: bool | nil
+
+# The output record separator for Kernel#print and IO#write. Default is +nil+.
+$\: String | nil
+
+# The last input line of string by gets or readline.
+$_: String | nil
+
+# The string to the left of the last successful match.
+$`: String | nil
+
+# The current standard error output.
+$stderr: IO
+
+# The current standard input.
+$stdin: IO
+
+# The current standard output.
+$stdout: IO
+
+# The information about the last match in the current scope (thread-local and frame-local).
+$~: MatchData | nil