rbs 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26f1a45c1e5dbf02bc102b1fc68c925979facec75a9971e9b405481087fc9ad9
-  data.tar.gz: b6e8bee27043e2bc710a894fe9518266dac265a8d0afc685193ca157dc5e8cac
+  metadata.gz: 7260861dc5546d0f4673c4cbff61a97b222553fbedb0f0cf7b45fffa7e70fc29
+  data.tar.gz: 3a354b926470d26670ac209c3190f0a934289126b4ed484180eebf81d9c9a076
 SHA512:
-  metadata.gz: 918413c661460215dc7de7404e6b9a6f117a56493e91b2c1f059524352c9fe84c6deff43c43987816eaca958224eb57c3206f463dd3fe09b7e402f2a5daed92d
-  data.tar.gz: b743905981aa9b998c41b84a6dc9ae81b5d2456a89218c2840a490260552dc1919a7c2cc46d4293b49df120ccada9b220ffd06b25ebfe47f941a0632b4cc63fc
+  metadata.gz: '07842180f916e2726333424a6263e05f8cfff54a1165c144fd6dab1137ab26a129ca0a5d22531483868a2cf1b3008bc8e617893f98de4d9433bb0b482fc910ce'
+  data.tar.gz: 861ac0661a1784d29c2bff49683d4d679d84bf788f20bf899a5c6596d341437a38dc1eb8072f027c44f199f17b0e056203db097056306c6363ac5076072045a8

data/.github/workflows/comments.yml

@@ -31,4 +31,5 @@ jobs:
           bin/setup
       - name: Check if `rake annotate` has been executed
         run: |
+          git config --global --add safe.directory `pwd`
           bundle exec rake annotate confirm_annotation

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## master
 
+## 2.8.1 (2022-11-28)
+
+### Signature updates
+
+* Update documents based on ruby-3.1.3 ([#1160](https://github.com/ruby/rbs/pull/1160))
+
+### Library changes
+
+#### rbs collection
+
+* Delay loading `Gemfile` for unbundled environments ([#1161](https://github.com/ruby/rbs/pull/1161))
+
+### Miscellaneous
+
+* Fix collection tests ([#1159](https://github.com/ruby/rbs/pull/1159), [#1162](https://github.com/ruby/rbs/pull/1162))
+
 ## 2.8.0 (2022-11-24)
 
 ### Signature updates

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs (2.8.0)
+    rbs (2.8.1)
 
 PATH
   remote: test/assets/test-gem
@@ -62,7 +62,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.38.0)
+    rubocop (1.39.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)

data/core/io/buffer.rbs

@@ -88,11 +88,13 @@ class IO
 
     # <!--
     #   rdoc-file=io_buffer.c
-    #   - IO::Buffer.for(string) -> io_buffer
+    #   - IO::Buffer.for(string) -> readonly io_buffer
+    #   - IO::Buffer.for(string) {|io_buffer| ... read/write io_buffer ...}
     # -->
-    # Creates a IO::Buffer from the given string's memory. The buffer remains
-    # associated with the string, and writing to a buffer will update the string's
-    # contents.
+    # Creates a IO::Buffer from the given string's memory. Without a block a frozen
+    # internal copy of the string is created efficiently and used as the buffer
+    # source. When a block is provided, the buffer is associated directly with the
+    # string's internal data and updating the buffer will update the string.
     #
     # Until #free is invoked on the buffer, either explicitly or via the garbage
     # collector, the source string will be locked and cannot be modified.
@@ -101,7 +103,7 @@ class IO
     # modified.
     #
     #     string = 'test'
-    #     buffer = IO::Buffer.for(str)
+    #     buffer = IO::Buffer.for(string)
     #     buffer.external? #=> true
     #
     #     buffer.get_string(0, 1)
@@ -112,6 +114,12 @@ class IO
     #     buffer.resize(100)
     #     # in `resize': Cannot resize external buffer! (IO::Buffer::AccessError)
     #
+    #     IO::Buffer.for(string) do |buffer|
+    #       buffer.set_string("T")
+    #       string
+    #       # => "Test"
+    #     end
+    #
     def self.for: (String) -> Buffer
 
     # <!--

data/core/method.rbs

@@ -220,7 +220,15 @@ class Method < Object
   #   rdoc-file=proc.c
   #   - meth.owner    -> class_or_module
   # -->
-  # Returns the class or module that defines the method. See also Method#receiver.
+  # Returns the class or module on which this method is defined. In other words,
+  #
+  #     meth.owner.instance_methods(false).include?(meth.name) # => true
+  #
+  # holds as long as the method is not removed/undefined/replaced, (with
+  # private_instance_methods instead of instance_methods if the method is
+  # private).
+  #
+  # See also Method#receiver.
   #
   #     (1..3).method(:map).owner #=> Enumerable
   #

data/core/rbs/unnamed/argf.rbs

@@ -768,15 +768,15 @@ module RBS
 
       # <!--
       #   rdoc-file=io.c
-      #   - ARGF.readlines(sep=$/)     -> array
+      #   - ARGF.readlines(sep = $/)     -> array
       #   - ARGF.readlines(limit)      -> array
       #   - ARGF.readlines(sep, limit) -> array
-      #   - ARGF.to_a(sep=$/)     -> array
+      #   - ARGF.to_a(sep = $/)     -> array
       #   - ARGF.to_a(limit)      -> array
       #   - ARGF.to_a(sep, limit) -> array
       # -->
-      # Reads `ARGF`'s current file in its entirety, returning an `Array` of its
-      # lines, one line per element. Lines are assumed to be separated by *sep*.
+      # Reads each file in `ARGF` in its entirety, returning an `Array` containing
+      # lines from the files. Lines are assumed to be separated by *sep*.
       #
       #     lines = ARGF.readlines
       #     lines[0]                #=> "This is line one\n"
@@ -893,8 +893,8 @@ module RBS
       def tell: () -> Integer
 
       # <!-- rdoc-file=io.c -->
-      # Reads `ARGF`'s current file in its entirety, returning an `Array` of its
-      # lines, one line per element. Lines are assumed to be separated by *sep*.
+      # Reads each file in `ARGF` in its entirety, returning an `Array` containing
+      # lines from the files. Lines are assumed to be separated by *sep*.
       #
       #     lines = ARGF.readlines
       #     lines[0]                #=> "This is line one\n"

data/core/rubygems/rubygems.rbs

@@ -155,8 +155,8 @@ module Gem
   #   rdoc-file=lib/rubygems.rb
   #   - activated_gem_paths()
   # -->
-  # The number of paths in the `$LOAD_PATH` from activated gems. Used to
-  # prioritize `-I` and `[ENV]('RUBYLIB`)` entries during `require`.
+  # The number of paths in the +$LOAD_PATH+ from activated gems. Used to
+  # prioritize `-I` and +[ENV]('RUBYLIB')+ entries during `require`.
   #
   def self.activated_gem_paths: () -> Integer
 

data/core/unbound_method.rbs

@@ -153,7 +153,15 @@ class UnboundMethod
   #   rdoc-file=proc.c
   #   - meth.owner    -> class_or_module
   # -->
-  # Returns the class or module that defines the method. See also Method#receiver.
+  # Returns the class or module on which this method is defined. In other words,
+  #
+  #     meth.owner.instance_methods(false).include?(meth.name) # => true
+  #
+  # holds as long as the method is not removed/undefined/replaced, (with
+  # private_instance_methods instead of instance_methods if the method is
+  # private).
+  #
+  # See also Method#receiver.
   #
   #     (1..3).method(:map).owner #=> Enumerable
   #

data/lib/rbs/cli.rb

@@ -58,7 +58,7 @@ module RBS
           self.core_root = nil
         end
 
-        opts.on('--collection PATH', "File path of collection configuration (default: #{Collection::Config::PATH})") do |path|
+        opts.on('--collection PATH', "File path of collection configuration (default: #{@config_path})") do |path|
           self.config_path = Pathname(path).expand_path
         end
 
@@ -1034,15 +1034,17 @@ EOB
       opts.order args.drop(1), into: params
       config_path = options.config_path or raise
       lock_path = Collection::Config.to_lockfile_path(config_path)
-      gemfile_lock_path = Bundler.default_lockfile
 
       case args[0]
       when 'install'
         unless params[:frozen]
+          gemfile_lock_path = Bundler.default_lockfile
           Collection::Config.generate_lockfile(config_path: config_path, gemfile_lock_path: gemfile_lock_path)
         end
         Collection::Installer.new(lockfile_path: lock_path, stdout: stdout).install_from_lockfile
       when 'update'
+        gemfile_lock_path = Bundler.default_lockfile
+
         # TODO: Be aware of argv to update only specified gem
         Collection::Config.generate_lockfile(config_path: config_path, gemfile_lock_path: gemfile_lock_path, with_lockfile: false)
         Collection::Installer.new(lockfile_path: lock_path, stdout: stdout).install_from_lockfile
@@ -1101,6 +1103,8 @@ EOB
 
             # Update the RBSs
             $ rbs collection update
+
+          Options:
         HELP
         opts.on('--frozen') if args[0] == 'install'
       end

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "2.8.0"
+  VERSION = "2.8.1"
 end

data/stdlib/cgi/0/core.rbs

@@ -149,7 +149,7 @@
 #     cgi.has_key?('field_name')
 #     cgi.include?('field_name')
 #
-# CAUTION! [cgi]('field_name') returned an Array with the old cgi.rb(included in
+# CAUTION! `cgi['field_name']` returned an Array with the old cgi.rb(included in
 # Ruby 1.6)
 #
 # ### Get form values as hash
@@ -713,8 +713,11 @@ class CGI
     #
     def domain: () -> String?
 
-    # <!-- rdoc-file=lib/cgi/cookie.rb -->
-    # Domain for which this cookie applies, as a `String`
+    # <!--
+    #   rdoc-file=lib/cgi/cookie.rb
+    #   - domain=(str)
+    # -->
+    # Set domain for which this cookie applies
     #
     def domain=: (String domain) -> String
 
@@ -756,8 +759,11 @@ class CGI
     #
     def name: () -> String
 
-    # <!-- rdoc-file=lib/cgi/cookie.rb -->
-    # Name of this cookie, as a `String`
+    # <!--
+    #   rdoc-file=lib/cgi/cookie.rb
+    #   - name=(str)
+    # -->
+    # Set name of this cookie
     #
     def name=: (String name) -> String
 
@@ -766,8 +772,11 @@ class CGI
     #
     def path: () -> String?
 
-    # <!-- rdoc-file=lib/cgi/cookie.rb -->
-    # Path for which this cookie applies, as a `String`
+    # <!--
+    #   rdoc-file=lib/cgi/cookie.rb
+    #   - path=(str)
+    # -->
+    # Set path for which this cookie applies
     #
     def path=: (String path) -> String
 
@@ -861,7 +870,7 @@ class CGI
     #   rdoc-file=ext/cgi/escape/escape.c
     #   - CGI.escape(string) -> string
     # -->
-    # Returns URL-escaped string.
+    # Returns URL-escaped string (`application/x-www-form-urlencoded`).
     #
     def escape: (string str) -> String
 
@@ -877,7 +886,7 @@ class CGI
     #   rdoc-file=ext/cgi/escape/escape.c
     #   - CGI.unescape(string, encoding=@@accept_charset) -> string
     # -->
-    # Returns URL-unescaped string.
+    # Returns URL-unescaped string (`application/x-www-form-urlencoded`).
     #
     def unescape: (string str, ?encoding encoding) -> String