rbs 2.8.0.pre.1 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d6bcfbb96db1bd762270824620e4a430057521398fdef7d8543cceaaaab127
-  data.tar.gz: 4616fee00017d88cb942fa34f25dee2bd1959ba83bf3f8eedf7f57770792d2e0
+  metadata.gz: 7260861dc5546d0f4673c4cbff61a97b222553fbedb0f0cf7b45fffa7e70fc29
+  data.tar.gz: 3a354b926470d26670ac209c3190f0a934289126b4ed484180eebf81d9c9a076
 SHA512:
-  metadata.gz: 9bfb3f1cb6ed463fbc9d78181b6fdd683bbb476adfdbda4ef7a1009d8c225ee96f7f5d958dbba3d2f5b461f2253ad0d27e68072653efde251886550cf64973c3
-  data.tar.gz: bb8b7a2984b4211d8bbb19d213b999f78caa9e676fef3584da29b49a18639362f2884233337e1c5aedad01ce495055085ae080df81f696ce135de1220638d34a
+  metadata.gz: '07842180f916e2726333424a6263e05f8cfff54a1165c144fd6dab1137ab26a129ca0a5d22531483868a2cf1b3008bc8e617893f98de4d9433bb0b482fc910ce'
+  data.tar.gz: 861ac0661a1784d29c2bff49683d4d679d84bf788f20bf899a5c6596d341437a38dc1eb8072f027c44f199f17b0e056203db097056306c6363ac5076072045a8

data/.github/workflows/comments.yml

@@ -12,23 +12,24 @@ jobs:
     container:
       image: rubylang/ruby:3.1-focal
     steps:
-    - uses: actions/checkout@v3
-    - name: Install dependencies
-      run: |
-        apt-get update
-        apt-get install -y libdb-dev curl
-    - name: Update rubygems & bundler
-      run: |
-        ruby -v
-        gem update --system
-    - name: bundle config set with
-      run: |
-        echo "NO_MINITEST=true" >> $GITHUB_ENV
-        bundle config set --local without 'minitest'
-      if: "contains(matrix.container_tag, 'master-nightly')"
-    - name: bin/setup
-      run: |
-        bin/setup
-    - name: Check if `rake annotate` has been executed
-      run: |
-        bundle exec rake annotate confirm_annotation
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install -y libdb-dev curl
+      - name: Update rubygems & bundler
+        run: |
+          ruby -v
+          gem update --system
+      - name: bundle config set with
+        run: |
+          echo "NO_MINITEST=true" >> $GITHUB_ENV
+          bundle config set --local without 'minitest'
+        if: "contains(matrix.container_tag, 'master-nightly')"
+      - name: bin/setup
+        run: |
+          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/.github/workflows/ruby.yml

@@ -12,70 +12,70 @@ jobs:
     strategy:
       matrix:
         container_tag:
-        - master-nightly-focal
-        - 3.1-focal
-        - 3.0-focal
-        - 2.7-bionic
-        - 2.6-bionic
+          - master-nightly-focal
+          - 3.1-focal
+          - 3.0-focal
+          - 2.7-bionic
+          - 2.6-bionic
         job:
-        - test
-        - stdlib_test
-        - rubocop validate test_doc build test_generate_stdlib
-        - lexer confirm_lexer
-        - lexer compile
+          - test
+          - stdlib_test
+          - rubocop validate test_doc build test_generate_stdlib
+          - lexer confirm_lexer
+          - lexer compile
         exclude:
-        - container_tag: master-nightly-focal
-          job: confirm_lexer
-        - container_tag: 2.6-bionic
-          job: stdlib_test
-        - container_tag: 2.7-bionic
-          job: stdlib_test
-        - container_tag: 3.0-focal
-          job: stdlib_test
+          - container_tag: master-nightly-focal
+            job: confirm_lexer
+          - container_tag: 2.6-bionic
+            job: stdlib_test
+          - container_tag: 2.7-bionic
+            job: stdlib_test
+          - container_tag: 3.0-focal
+            job: stdlib_test
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
-    - uses: actions/checkout@v3
-    - name: Set working directory as safe
-      run: /usr/bin/git config --global --add safe.directory $(pwd)
-    - name: Install dependencies
-      run: |
-        apt-get update
-        apt-get install -y libdb-dev curl autoconf automake m4 libtool
-    - name: Install Re2c
-      if: contains(matrix.job, 'lexer')
-      run: |
-        cd /tmp
-        curl -L https://github.com/skvadrik/re2c/archive/refs/tags/3.0.tar.gz > re2c-3.0.tar.gz
-        tar xf re2c-3.0.tar.gz
-        cd re2c-3.0
-        autoreconf -i -W all
-        ./configure
-        make
-        make install
-    - name: Update rubygems & bundler
-      run: |
-        ruby -v
-        gem update --system
-    - name: bundle config set with
-      run: |
-        echo "NO_MINITEST=true" >> $GITHUB_ENV
-        bundle config set --local without 'minitest'
-      if: "contains(matrix.container_tag, 'master-nightly')"
-    - name: bin/setup
-      run: |
-        bin/setup
-    - name: Run test
-      run: |
-        bundle exec rake ${{ matrix.job }}
+      - uses: actions/checkout@v3
+      - name: Set working directory as safe
+        run: /usr/bin/git config --global --add safe.directory $(pwd)
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install -y libdb-dev curl autoconf automake m4 libtool
+      - name: Install Re2c
+        if: contains(matrix.job, 'lexer')
+        run: |
+          cd /tmp
+          curl -L https://github.com/skvadrik/re2c/archive/refs/tags/3.0.tar.gz > re2c-3.0.tar.gz
+          tar xf re2c-3.0.tar.gz
+          cd re2c-3.0
+          autoreconf -i -W all
+          ./configure
+          make
+          make install
+      - name: Update rubygems & bundler
+        run: |
+          ruby -v
+          gem update --system
+      - name: bundle config set with
+        run: |
+          echo "NO_MINITEST=true" >> $GITHUB_ENV
+          bundle config set --local without 'minitest'
+        if: "contains(matrix.container_tag, 'master-nightly')"
+      - name: bin/setup
+        run: |
+          bin/setup
+      - name: Run test
+        run: |
+          bundle exec rake ${{ matrix.job }}
 
   windows:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ windows-2019, windows-2022 ]
-        ruby: [ ucrt, mswin ]
+        os: [windows-2019, windows-2022]
+        ruby: [ucrt, mswin]
     steps:
       - uses: actions/checkout@v3
       - name: load ruby

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 ## 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
+
+* random ([#1144](https://github.com/ruby/rbs/pull/1144))
+
+### Library changes
+
+* Fix SEGV when give invalid object to `variables:` ([#1153](https://github.com/ruby/rbs/pull/1153))
+
+### Miscellaneous
+
+* Fix some typos ([#1155](https://github.com/ruby/rbs/pull/1155))
+* Fix a formatting some YAML files ([#1154](https://github.com/ruby/rbs/pull/1154))
+
 ## 2.8.0.pre.1 (2022-11-17)
 
 ### Signature updates

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs (2.8.0.pre.1)
+    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/random.rbs

@@ -21,6 +21,26 @@
 # use SecureRandom for security purpose, instead of this PRNG.
 #
 class Random < RBS::Unnamed::Random_Base
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.new(seed = Random.new_seed) -> prng
+  # -->
+  # 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
+
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.bytes(size) -> string
+  # -->
+  # Returns a random binary string. The argument `size` specifies the length of
+  # the returned string.
+  #
+  def self.bytes: (Integer size) -> String
+
   # <!--
   #   rdoc-file=random.c
   #   - prng1 == prng2 -> true or false
@@ -71,6 +91,7 @@ class Random < RBS::Unnamed::Random_Base
   def self.rand: () -> Float
                | (Integer | ::Range[Integer] max) -> Integer
                | (Float | ::Range[Float] max) -> Float
+               | [T < Numeric] (::Range[T]) -> T
 
   # <!--
   #   rdoc-file=random.c
@@ -95,6 +116,52 @@ class Random < RBS::Unnamed::Random_Base
   #     [ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]
   #
   def self.srand: (?Integer number) -> Integer
+
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.urandom(size) -> string
+  # -->
+  # Returns a string, using platform providing features. Returned value is
+  # expected to be a cryptographically secure pseudo-random number in binary form.
+  # This method raises a RuntimeError if the feature provided by platform failed
+  # to prepare the result.
+  #
+  # In 2017, Linux manpage random(7) writes that "no cryptographic primitive
+  # available today can hope to promise more than 256 bits of security".  So it
+  # might be questionable to pass size > 32 to this method.
+  #
+  #     Random.urandom(8)  #=> "\x78\x41\xBA\xAF\x7D\xEA\xD8\xEA"
+  #
+  def self.urandom: (Integer) -> String
+
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng.seed -> integer
+  # -->
+  # 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
+
+  private
+
+  def initialize_copy: (self object) -> self
+
+  def left: () -> untyped
+
+  def marshal_dump: () -> untyped
+
+  def marshal_load: (untyped) -> untyped
+
+  def state: () -> untyped
 end
 
 Random::DEFAULT: Random

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/docs/rbs_by_example.md

@@ -176,7 +176,7 @@ the type variable `Elem`, and the `?` suffix nilable marker.
 When called with an `Integer` positional argument, the return value will be an
 `Array` of whatever type is contained.
 
-The `?` syntax is a convenient shorthand for a union with nil. An equivalent union type woould be `(Elem | nil)`.
+The `?` syntax is a convenient shorthand for a union with nil. An equivalent union type would be `(Elem | nil)`.
 
 ### Keyword Arguments
 

data/ext/rbs_extension/location.h

@@ -28,7 +28,7 @@ typedef struct {
 VALUE rbs_new_location(VALUE buffer, range rg);
 
 /**
- * Return rbs_loc assiciated with the RBS::Location object.
+ * Return rbs_loc associated with the RBS::Location object.
  * */
 rbs_loc *rbs_check_location(VALUE location);
 

data/ext/rbs_extension/parser.c

@@ -537,8 +537,8 @@ EOP:
 }
 
 /*
-  optinal ::= {} <simple_type>
-            | {} simple_type <`?`>
+  optional ::= {} <simple_type>
+             | {} simple_type <`?`>
 */
 static VALUE parse_optional(parserstate *state) {
   range rg;

data/ext/rbs_extension/parserstate.c

@@ -299,6 +299,12 @@ parserstate *alloc_parser(VALUE buffer, int start_pos, int end_pos, VALUE variab
   parser_advance(parser);
 
   if (!NIL_P(variables)) {
+    if (!RB_TYPE_P(variables, T_ARRAY)) {
+      rb_raise(rb_eTypeError,
+               "wrong argument type %"PRIsVALUE" (must be array or nil)",
+               rb_obj_class(variables));
+    }
+
     parser_push_typevar_table(parser, true);
 
     for (long i = 0; i < rb_array_len(variables); i++) {

data/lib/rbs/cli.rb

@@ -58,11 +58,11 @@ module RBS
           self.core_root = nil
         end
 
-        opts.on('--collection PATH', "File path of collection configration (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
 
-        opts.on('--no-collection', 'Ignore collection configration') do
+        opts.on('--no-collection', 'Ignore collection configuration') do
           self.config_path = nil
         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
@@ -1093,7 +1095,7 @@ EOB
 
           Examples:
 
-            # Initialize the configration file
+            # Initialize the configuration file
             $ rbs collection init
 
             # Generate the lock file and install RBSs from the lock file
@@ -1101,6 +1103,8 @@ EOB
 
             # Update the RBSs
             $ rbs collection update
+
+          Options:
         HELP
         opts.on('--frozen') if args[0] == 'install'
       end

data/lib/rbs/collection/config.rb

@@ -3,7 +3,7 @@
 module RBS
   module Collection
 
-    # This class represent the configration file.
+    # This class represent the configuration file.
     class Config
       class CollectionNotAvailable < StandardError
         def initialize

data/lib/rbs/version.rb

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

data/sig/collection/config.rbs

@@ -1,6 +1,6 @@
 module RBS
   module Collection
-    # This class represent the configration file.
+    # This class represent the configuration file.
     class Config
       class CollectionNotAvailable < StandardError
         def initialize: () -> void

data/sig/rdoc/rbs.rbs

@@ -49,7 +49,7 @@ module RBS
       # * If `#comment" returns a Comment object, it returns its `#string` value
       # * If `#comment` returns `nil`, it raises an error
       #
-      # Note that you have to confirm if the `#comment` of given declartion exists.
+      # Note that you have to confirm if the `#comment` of given declaration exists.
       #
       # ```ruby
       # comment = construct_comment(context: context, comment: comment_string(decl)) if decl.comment

data/sig/variance_calculator.rbs

@@ -14,7 +14,7 @@ module RBS
   # result = calculator.in_type_alias(name: name, args: args, variables: variables)
   # ```
   #
-  # See `RBS::VarianceCaluculator::Result` for information recorded in the `Result` object.
+  # See `RBS::VarianceCalculator::Result` for information recorded in the `Result` object.
   #
   class VarianceCalculator
     type variance = :unused | :covariant | :contravariant | :invariant

data/sig/vendorer.rbs

@@ -12,7 +12,7 @@ module RBS
   # loader.add(path: Pathname("sig"))      # Dirs will be ignored.
   #
   # vendorer = RBS::Vendorer.new(vendor_dir: Pathname("vendor/rbs"), loader: loader)
-  # vendorer.clearn!
+  # vendorer.clean!
   # vendorer.copy!
   # ```
   #