rbs 4.2.0 → 4.2.1.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e76f94a794b829effcba20a9dc637da54915d4bb3a87fa1b4200c4091fa60a6
-  data.tar.gz: 5f6eb47e5f31023f56ccede03402493f223719fa5dc1033995fecc592e87e2f1
+  metadata.gz: 0f1e581488613321c155d44ece6ce189d985fb3dac67c4dc10b61b3f71e7420b
+  data.tar.gz: b33c3d43cbd6f46a0995aea52d72fdc6041ce48b4d649f2401a1e7b5d1abd090
 SHA512:
-  metadata.gz: 168b150476b5515f06f4bc72a58854bc2c60cf073365761ceacf9dc48a5be22d41a0469c168e76ac9d85d03fbdb0e67ac2f7d3564ee6055191432514ff56b10c
-  data.tar.gz: 80e89dae7445279f1ee30c825280af61259363911fc78032812dfd1be5f4fc7677598732ca42b3366dff2bc1269fe8b7cd8e6bfa49ccd8a225fe318285bfdfb1
+  metadata.gz: 86d91c1baecfd5ad59f46c07af82d8d8bf1fabb33473d74484d547db179b3060430f495d6f1dbe65ee8465365be4cd5bd6c08526435ccc5c01677ad7cf7096df
+  data.tar.gz: b4ef431b1b7094f2c6734b54ad6884af9dd4d56a5127831556af8e36a6eb54064621d5e2b5557f44d1eec0f605a3b934b48a7b28815043c2abb6c36b79b5ea0c

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 4.2.1.pre.1 (2026-08-26)
+
+### Library changes
+
+* Remove some obsolete ruby version guards ([#3100](https://github.com/ruby/rbs/pull/3100))
+
+#### rbs collection
+
+* Make `rbs collection` say where the gem list comes from ([#3094](https://github.com/ruby/rbs/pull/3094))
+
+### Miscellaneous
+
+* Run `bundle` with the Ruby running the tests ([#3099](https://github.com/ruby/rbs/pull/3099))
+* docs: fix typo prefered -> preferred ([#3098](https://github.com/ruby/rbs/pull/3098))
+
 ## 4.2.0 (2026-08-23)
 
 RBS 4.2 accepts non-ASCII characters in identifiers. Method names, instance variable names and parameter names can be written in any script, and other names may contain non-ASCII characters as long as they start with an ASCII letter, which is what tells a constant from a method name.

data/docs/collection.md

@@ -2,6 +2,17 @@
 
 `rbs collection` sub command manages third party gems' RBS. In short, it is `bundler` for RBS.
 
+## Quickstart
+
+In a project that has a `Gemfile.lock`:
+
+```console
+$ rbs collection init
+$ rbs collection install
+```
+
+`rbs collection` reads `Gemfile.lock`, so there is no list of dependencies to maintain. `rbs` and type checkers such as Steep load the installed RBS files automatically.
+
 ## Requirements
 
 * `git(1)`
@@ -17,33 +28,44 @@ First, generate the configuration file, `rbs_collection.yaml`, with `rbs collect
 $ rbs collection init
 created: rbs_collection.yaml
 
+rbs collection installs RBS files for the gems in your Gemfile.lock.
+Gems in Gemfile.lock don't need to be listed anywhere.
+
+Next steps:
+  $ echo "/.gem_rbs_collection/" >> .gitignore
+  $ rbs collection install    # writes rbs_collection.lock.yaml; keep it in version control
+
 $ cat rbs_collection.yaml
+# rbs collection installs RBS files for the gems in your Gemfile.lock.
+# Run `rbs collection install` to resolve them into rbs_collection.lock.yaml and install them.
+
 # Download sources
 sources:
-  - name: ruby/gem_rbs_collection
+  - type: git
+    name: ruby/gem_rbs_collection
     remote: https://github.com/ruby/gem_rbs_collection.git
     revision: main
     repo_dir: gems
 
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
 # A directory to install the downloaded RBSs
 path: .gem_rbs_collection
 
 # gems:
+#   # RBS for a library that doesn't appear in Gemfile.lock, such as a non-gem standard library.
+#   - name: socket
+#
 #   # If you want to avoid installing rbs files for gems, you can specify them here.
 #   - name: GEM_NAME
 #     ignore: true
 ```
 
-I also recommend updating `.gitignore`.
-
-```console
-$ echo /.gem_rbs_collection/ >> .gitignore
-```
-
 ### Install dependencies
 
 Then, install gems' RBS with `rbs collection install`! It copies RBS from [the gem RBS repository](https://github.com/ruby/gem_rbs_collection) to `.gem_rbs_collection/` directory by default.
-I recommend to ignore `.gem_rbs_collection/` from version control system, such as Git.
 
 ```console
 $ rbs collection install
@@ -86,9 +108,9 @@ sources:
 path: .gem_rbs_collection
 
 gems:
-  # If the Gemfile.lock doesn't contain csv gem but you use csv gem,
-  # you can write the gem name explicitly to install RBS of the gem.
-  - name: csv
+  # If the Gemfile.lock doesn't contain socket but you use it,
+  # you can write the library name explicitly to install RBS of the library.
+  - name: socket
 
   # If the Gemfile.lock contains nokogiri gem but you don't want to use the RBS,
   # you can ignore the gem.

data/docs/data_and_struct.md

@@ -48,7 +48,7 @@ class Measure < Data.define(:amount, :unit)
 end
 ```
 
-@soutaro has prefered inheriting from `Data.define`, but you may find an extra annonymous class in `.ancestors` [^1].
+@soutaro has preferred inheriting from `Data.define`, but you may find an extra annonymous class in `.ancestors` [^1].
 
 ```ruby
 Measure.ancestors #=> [Measure, #<Class:0xOOF>, Data, ...]

data/lib/rbs/cli.rb

@@ -1089,21 +1089,37 @@ EOB
 
       case args[0]
       when 'install', 'instal', 'insta', 'inst', 'ins', 'in', 'i'
-        unless params[:frozen]
-          Collection::Config.generate_lockfile(config_path: config_path, definition: Bundler.definition)
+        if params[:frozen]
+          unless lock_path.exist?
+            if config_path.exist?
+              stderr.puts "#{lock_path} not found. Run `rbs collection install` without `--frozen` to generate it."
+            else
+              stderr.puts "#{lock_path} not found. Run `rbs collection init` and `rbs collection install` to generate it."
+            end
+            return 1
+          end
+        else
+          return 1 unless collection_config_available?(config_path)
+          definition = bundler_definition or return 1
+          Collection::Config.generate_lockfile(config_path: config_path, definition: definition)
         end
         Collection::Installer.new(lockfile_path: lock_path, stdout: stdout).install_from_lockfile
       when 'update', 'updat', 'upda', 'upd', 'up', 'u'
+        return 1 unless collection_config_available?(config_path)
+        definition = bundler_definition or return 1
         # TODO: Be aware of argv to update only specified gem
-        Collection::Config.generate_lockfile(config_path: config_path, definition: Bundler.definition, with_lockfile: false)
+        Collection::Config.generate_lockfile(config_path: config_path, definition: definition, with_lockfile: false)
         Collection::Installer.new(lockfile_path: lock_path, stdout: stdout).install_from_lockfile
       when 'init'
         if config_path.exist?
-          puts "#{config_path} already exists"
+          stderr.puts "#{config_path} already exists"
           return 1
         end
 
         config_path.write(<<~'YAML')
+          # rbs collection installs RBS files for the gems in your Gemfile.lock.
+          # Run `rbs collection install` to resolve them into rbs_collection.lock.yaml and install them.
+
           # Download sources
           sources:
             - type: git
@@ -1120,27 +1136,57 @@ EOB
           path: .gem_rbs_collection
 
           # gems:
+          #   # RBS for a library that doesn't appear in Gemfile.lock, such as a non-gem standard library.
+          #   - name: socket
+          #
           #   # If you want to avoid installing rbs files for gems, you can specify them here.
           #   - name: GEM_NAME
           #     ignore: true
         YAML
-        stdout.puts "created: #{config_path}"
+        stdout.puts <<~MESSAGE
+          created: #{config_path}
+
+          rbs collection installs RBS files for the gems in your Gemfile.lock.
+          Gems in Gemfile.lock don't need to be listed anywhere.
+
+          Next steps:
+            $ echo "/.gem_rbs_collection/" >> .gitignore
+            $ rbs collection install    # writes rbs_collection.lock.yaml; keep it in version control
+        MESSAGE
       when 'clean'
         unless lock_path.exist?
-          puts "#{lock_path} should exist to clean"
+          stderr.puts "#{lock_path} should exist to clean"
           return 1
         end
         Collection::Cleaner.new(lockfile_path: lock_path)
       when 'help', 'hel', 'he', 'h'
-        puts opts.help
+        stdout.puts opts.help
       else
-        puts opts.help
+        stdout.puts opts.help
         return 1
       end
 
       0
     end
 
+    def collection_config_available?(config_path)
+      return true if config_path.exist?
+
+      stderr.puts "#{config_path} not found. Run `rbs collection init` to generate it."
+      false
+    end
+
+    def bundler_definition
+      definition = Bundler.definition
+      return definition if definition.lockfile.file?
+
+      stderr.puts "#{definition.lockfile} not found. Run `bundle install` to generate it."
+      nil
+    rescue Bundler::GemfileNotFound
+      stderr.puts "Gemfile not found. `rbs collection` reads the gems to install from Gemfile.lock."
+      nil
+    end
+
     def collection_options(args)
       OptionParser.new do |opts|
         opts.banner = <<~HELP

data/lib/rbs/prototype/runtime/value_object_generator.rb

@@ -99,8 +99,6 @@ module RBS
 
         private
 
-        CAN_CALL_KEYWORD_INIT_P = Struct.new(:tmp).respond_to?(:keyword_init?)
-
         def build_super_class
           AST::Declarations::Class::Super.new(name: TypeName.parse("::Struct"), args: [untyped], location: nil)
         end
@@ -118,21 +116,16 @@ module RBS
           [:new, :[]].map do |name|
             new_overloads = [] #: Array[AST::Members::MethodDefinition::Overload]
 
-            if CAN_CALL_KEYWORD_INIT_P
-              case @target_class.keyword_init?
-              when false
-                new_overloads << build_overload_for_positional_arguments
-              when true
-                new_overloads << build_overload_for_keyword_arguments
-              when nil
-                new_overloads << build_overload_for_positional_arguments
-                new_overloads << build_overload_for_keyword_arguments
-              else
-                raise
-              end
-            else
+            case @target_class.keyword_init?
+            when false
+              new_overloads << build_overload_for_positional_arguments
+            when true
+              new_overloads << build_overload_for_keyword_arguments
+            when nil
               new_overloads << build_overload_for_positional_arguments
               new_overloads << build_overload_for_keyword_arguments
+            else
+              raise
             end
 
             AST::Members::MethodDefinition.new(
@@ -178,8 +171,6 @@ module RBS
 
         # def self.keyword_init?: () -> bool?
         def build_s_keyword_init_p
-          return [] unless CAN_CALL_KEYWORD_INIT_P
-
           return_type = @target_class.keyword_init?.nil? \
                       ? Types::Bases::Nil.new(location: nil)
                       : Types::Literal.new(literal: @target_class.keyword_init?, location: nil)

data/lib/rbs/version.rb

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

data/sig/cli.rbs

@@ -76,6 +76,12 @@ module RBS
 
     def run_collection: (Array[String], LibraryOptions) -> Integer
 
+    # Returns `true` if the collection config exists, otherwise prints a message to `stderr` and returns `false`
+    def collection_config_available?: (Pathname) -> bool
+
+    # Returns `nil` if `Gemfile` or `Gemfile.lock` is not found, after printing a message to `stderr`
+    def bundler_definition: () -> Bundler::Definition?
+
     def run_annotate: (Array[String], top) -> Integer
 
     def run_subtract: (Array[String], top) -> Integer

data/sig/prototype/runtime.rbs

@@ -64,8 +64,6 @@ module RBS
         def build_s_new: () -> Array[AST::Members::MethodDefinition]
 
         def build_super_class: () -> AST::Declarations::Class::Super
-
-        CAN_CALL_KEYWORD_INIT_P: bool
       end
 
       class DataGenerator < ValueObjectBase

data/sig/shims/bundler.rbs

@@ -1,4 +1,7 @@
 module Bundler
+  class GemfileNotFound < StandardError
+  end
+
   class LockfileParser
     def initialize: (String) -> void
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1.pre.1
 platform: ruby
 authors:
 - Soutaro Matsumoto