rbs 3.5.0.pre.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d531a807ca33dac823ab8abc9381ad2769607581f7f878c7e90b64f96a7df12c
-  data.tar.gz: f063ae7209b5eded9645c0429ddba1c70104d4866252eee234b4f58dad2f0090
+  metadata.gz: 1b76067316b4cfcc66b0072df88be6f74b1e982c3e2c583aa81153fc1d7590cf
+  data.tar.gz: 1051d0012adab3eb36807bad04223e2f6aee7e242981ff12ad0f5e7bdab910d9
 SHA512:
-  metadata.gz: 361cee4e71bb3430d5f83e48923e44f3a542336b77b81ee6aa2188d5434f14d89569d204d866c8b688fc932803bd6fd5c6ad3a1c65db99536032d63f5b882443
-  data.tar.gz: 2c526b49e8db179a6137a2ab82d1205f11fd1b2346e630248f8cdd874d514c6647bff7cb5bfc9e224d5ea10ae3d90c2fff0cacd903b69f071b5930d3831eded3
+  metadata.gz: cb7c0b36f6398e989fb33cac75b76566404004c54bc395d2e320c01ec50022a6dd9161589506d2446ec71e4f64bebc983a2664acefc8b64a5bbef1832ee86191
+  data.tar.gz: fc53b27131a5b9d947c072b809aff22c23edadbbe211f49ce415796dc0d3f084230f6c609b1eaf1229adf4a15acce1f67aa57bc9ec0929989c9f085155f8c272

data/.github/dependabot.yml

@@ -1,13 +1,21 @@
 version: 2
 updates:
-  - package-ecosystem: "bundler"
+  - package-ecosystem: bundler
     directory: "/"
     schedule:
-      interval: "daily"
-  - package-ecosystem: "bundler"
+      interval: daily
+    open-pull-requests-limit: 3
+    allow:
+      - dependency-type: all
+
+  - package-ecosystem: bundler
     directory: "/steep"
     schedule:
-      interval: "daily"
+      interval: daily
+    open-pull-requests-limit: 3
+    allow:
+      - dependency-type: all
+
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:

data/.github/workflows/dependabot.yml

@@ -0,0 +1,26 @@
+name: Merge dependabot PRs automatically
+on: pull_request_target
+
+permissions:
+  pull-requests: write
+  contents: write
+
+env:
+  blocker_files: rbs.gemspec Gemfile steep/Gemfile
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Abort if blocker files are changed
+        run: git diff --exit-code ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} ${{ env.blocker_files }}
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.DEPENDABOT_MERGE_GH_TOKEN}}

data/.github/workflows/ruby.yml

@@ -31,7 +31,9 @@ jobs:
           - ruby: "3.3"
             job: lexer compile confirm_lexer
           - ruby: "3.3"
-            job: rubocop validate test_doc build test_generate_stdlib
+            job: rubocop validate test_doc build test_generate_stdlib raap
+          - ruby: "3.3"
+            job: typecheck_test
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
@@ -64,6 +66,10 @@ jobs:
           echo "NO_MINITEST=true" >> $GITHUB_ENV
           bundle config set --local without 'minitest'
         if: ${{ contains(matrix.ruby, 'head') }}
+      - name: Skip installing type checkers
+        if: ${{ ! contains(matrix.job, 'typecheck_test') }}
+        run: |
+          bundle config set without 'typecheck_test'
       - name: bin/setup
         run: |
           bin/setup

data/CHANGELOG.md

@@ -1,6 +1,107 @@
 # CHANGELOG
 
-## master
+## 3.5.0 (2024-06-06)
+
+### Signature updates
+
+* `net-http` headers ([#1750](https://github.com/ruby/rbs/pull/1750))
+* `CSV.foreach` ([#1738](https://github.com/ruby/rbs/pull/1738))
+* `Enumerator#initialize` ([#1801](https://github.com/ruby/rbs/pull/1801))
+* `Float#divmod`, `Rational#divmod` ([#1868](https://github.com/ruby/rbs/pull/1868))
+* `GC` ([#1530](https://github.com/ruby/rbs/pull/1530))
+* `Integer#pow` ([#1706](https://github.com/ruby/rbs/pull/1706))
+* `Kernel.rand` ([#1783](https://github.com/ruby/rbs/pull/1783))
+* `Kernel#extend` ([#1769](https://github.com/ruby/rbs/pull/1769))
+* `Module#include`, `Module#prepend` ([#1769](https://github.com/ruby/rbs/pull/1769))
+* `Proc#parameters` ([#1819](https://github.com/ruby/rbs/pull/1819))
+* `Range#step` ([#1709](https://github.com/ruby/rbs/pull/1709))
+* `Regexp.union` ([#1809](https://github.com/ruby/rbs/pull/1809))
+* `RubyVM::YJIT.enable` ([#1812](https://github.com/ruby/rbs/pull/1812))
+* `RubyVM::YJIT`, `RubyVM::RJIT` ([#1746](https://github.com/ruby/rbs/pull/1746))
+* `String#bytesplice` ([#1793](https://github.com/ruby/rbs/pull/1793))
+* `String#gsub!` ([#1768](https://github.com/ruby/rbs/pull/1768))
+* `Symbol#=~` ([#1704](https://github.com/ruby/rbs/pull/1704))
+* `Time#initialize` ([#1771](https://github.com/ruby/rbs/pull/1771))
+* `Time#zone` ([#1770](https://github.com/ruby/rbs/pull/1770))
+* `Timeout::ExitException`  ([#1803](https://github.com/ruby/rbs/pull/1803))
+* `URI::MailTo` ([#1858](https://github.com/ruby/rbs/pull/1858))
+* Update docs ([#1811](https://github.com/ruby/rbs/pull/1811), [#1699](https://github.com/ruby/rbs/pull/1699))
+
+### Language updates
+
+* Fix proc type syntax ([#1807](https://github.com/ruby/rbs/pull/1807))
+* Function types with untyped parameter ([#1806](https://github.com/ruby/rbs/pull/1806))
+* Fix record type ([#1732](https://github.com/ruby/rbs/pull/1732))
+* parser: enable record types with optional fields ([#1717](https://github.com/ruby/rbs/pull/1717))
+
+### Library changes
+
+* Drop dependency on `abbrev` ([#1866](https://github.com/ruby/rbs/pull/1866))
+* Fix source display ([#1832](https://github.com/ruby/rbs/pull/1832))
+* Include trivia tokens to lex result ([#1831](https://github.com/ruby/rbs/pull/1831))
+* Implement token list API ([#1829](https://github.com/ruby/rbs/pull/1829))
+* Fix memory leak when ParsingError ([#1830](https://github.com/ruby/rbs/pull/1830))
+* [rbs diff] Fix error when empty manifest.yaml ([#1762](https://github.com/ruby/rbs/pull/1762))
+* Remove deprecated API since RBS v1 ([#1805](https://github.com/ruby/rbs/pull/1805))
+* Use array instead of linked list for rbs  location's child ([#1786](https://github.com/ruby/rbs/pull/1786))
+* Fix SEGV with parse negative position ([#1790](https://github.com/ruby/rbs/pull/1790))
+* Add location for attribute ([#1787](https://github.com/ruby/rbs/pull/1787))
+* Always be private ([#1774](https://github.com/ruby/rbs/pull/1774))
+* Prevent resource leak with type/method-type parser when reaching EOF. ([#1742](https://github.com/ruby/rbs/pull/1742))
+* Allow loading RBS from different version of a gem ([#1731](https://github.com/ruby/rbs/pull/1731))
+* Fix method name tag on assertion ([#1705](https://github.com/ruby/rbs/pull/1705))
+* Improve interface check by method parameters ([#1698](https://github.com/ruby/rbs/pull/1698))
+
+#### rbs prototype
+
+* Fix prototype for ruby-3.4 ([#1760](https://github.com/ruby/rbs/pull/1760))
+* Fix 3.4 `prototype rb` failure ([#1713](https://github.com/ruby/rbs/pull/1713))
+* Add Numeric Node's check for parse rbs ([#1711](https://github.com/ruby/rbs/pull/1711))
+
+#### rbs collection
+
+* Fix RBS loading precedence ([#1720](https://github.com/ruby/rbs/pull/1720))
+* Refactor Git source by using `git?` method ([#1701](https://github.com/ruby/rbs/pull/1701))
+
+### Miscellaneous
+
+* Introduce RaaP for testing of signature ([#1810](https://github.com/ruby/rbs/pull/1810))
+* Revise .gemspec to remove `Gemfile` and `Gemfile.lock` ([#1856](https://github.com/ruby/rbs/pull/1856))
+* Add link to gem_rbs_collection to README ([#1827](https://github.com/ruby/rbs/pull/1827))
+* Remove `Gemfile.lock` from the gem package ([#1823](https://github.com/ruby/rbs/pull/1823))
+* Modify template to use TestHelper ([#1776](https://github.com/ruby/rbs/pull/1776))
+* Should focus on `String.new` not `String#initialize`. ([#1789](https://github.com/ruby/rbs/pull/1789))
+* Make the test suite compatible with `--enable-frozen-string-literal` ([#1767](https://github.com/ruby/rbs/pull/1767))
+* Stop reusing `fd` ([#1752](https://github.com/ruby/rbs/pull/1752))
+* Fix test failures on Ruby 3.4 ([#1734](https://github.com/ruby/rbs/pull/1734))
+* Stop trace object allocations during test ([#1724](https://github.com/ruby/rbs/pull/1724))
+* Fix head test fails ([#1719](https://github.com/ruby/rbs/pull/1719))
+
+## 3.4.4 (2024-02-08)
+
+### Miscellaneous
+
+* Backport [#1752](https://github.com/ruby/rbs/pull/1752) ([#1753](https://github.com/ruby/rbs/pull/1753))
+
+## 3.4.3 (2024-01-25)
+
+### Library changes
+
+#### rbs collection
+
+* Backport [#1731](https://github.com/ruby/rbs/pull/1731) ([#1735](https://github.com/ruby/rbs/pull/1735))
+
+## 3.4.2 (2024-01-19)
+
+### Miscellaneous
+
+* Backport [#1724](https://github.com/ruby/rbs/pull/1724) ([#1726](https://github.com/ruby/rbs/pull/1726))
+
+## 3.4.1 (2023-12-26)
+
+### Signature updates
+
+* Update embedded RDoc based on ruby-3.3.0 (Backport #1699) ([#1700](https://github.com/ruby/rbs/pull/1700))
 
 ## 3.4.0 (2023-12-21)
 

data/README.md

@@ -69,7 +69,7 @@ gem "rbs"
 
 The gem ships with the `rbs` command line tool to demonstrate what it can do and help develop RBS.
 
-```bash
+```console
 $ rbs version
 $ rbs list
 $ rbs ancestors ::Object
@@ -98,7 +98,7 @@ end
 
 Running prototype on the above will automatically generate
 
-```
+```console
 $ rbs prototype rb person.rb
 class Person
   @name: untyped
@@ -190,6 +190,7 @@ Here is a list of some places you can talk with active maintainers.
 
 - [Ruby Discord Server (invite link)](https://discord.gg/ad2acQFtkh) -- We have `rbs` channel in Ruby Discord server.
 - [ruby-jp Slack Workspace (in Japanese)](https://ruby-jp.github.io/) -- We have `types` channel in ruby-jp slack workspace.
+- [gem_rbs_collection](https://github.com/ruby/gem_rbs_collection) -- We have a repository of third-party RBS type definitions, for the case your dependency doesn't ship with RBS files.
 
 ## Development
 

data/Rakefile

@@ -19,7 +19,7 @@ Rake::TestTask.new(:test => :compile) do |t|
   end
 end
 
-multitask :default => [:test, :stdlib_test, :rubocop, :validate, :test_doc]
+multitask :default => [:test, :stdlib_test, :typecheck_test, :rubocop, :validate, :test_doc]
 
 task :lexer do
   sh "re2c -W --no-generation-date -o ext/rbs_extension/lexer.c ext/rbs_extension/lexer.re"
@@ -92,6 +92,23 @@ task :stdlib_test => :compile do
   sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Encoding_test.rb"
 end
 
+task :typecheck_test => :compile do
+  FileList["test/typecheck/*"].each do |test|
+    Dir.chdir(test) do
+      expectations = File.join(test, "steep_expectations.yml")
+      if File.exist?(expectations)
+        sh "steep check --with_expectations"
+      else
+        sh "steep check"
+      end
+    end
+  end
+end
+
+task :raap => :compile do
+  sh %q[cat test/raap.txt | egrep -v '^#|^$' | xargs bundle exec raap]
+end
+
 task :rubocop do
   sh "rubocop --parallel"
 end

data/Steepfile

@@ -8,7 +8,7 @@ target :lib do
     # "lib/rbs/test.rb"
   )
 
-  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'abbrev', 'prettyprint', 'yaml', "psych", "securerandom"
+  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'prettyprint', 'yaml', "psych", "securerandom"
   signature "stdlib/strscan/0/"
   signature "stdlib/optparse/0/"
   signature "stdlib/rdoc/0/"

data/core/float.rbs

@@ -442,7 +442,8 @@ class Float < Numeric
   #     13.0.divmod(4.0)            # => [3, 1.0]
   #     13.0.divmod(Rational(4, 1)) # => [3, 1.0]
   #
-  def divmod: (Numeric) -> [ Numeric, Numeric ]
+  def divmod: (Integer | Float | Rational) -> [ Integer, Float ]
+            | (Numeric) -> [ Numeric, Numeric ]
 
   def dup: () -> self
 

data/core/integer.rbs

@@ -766,7 +766,8 @@ class Integer < Numeric
   #     13.divmod(Rational(4, 1)) # => [3, (1/1)]
   #
   def divmod: (Integer) -> [ Integer, Integer ]
-            | (Float) -> [ Float, Float ]
+            | (Float) -> [ Integer, Float ]
+            | (Rational) -> [ Integer, Rational ]
             | (Numeric) -> [ Numeric, Numeric ]
 
   # <!--

data/core/proc.rbs

@@ -602,7 +602,7 @@ class Proc < Object
   #     prc = lambda{|x, y=42, *other|}
   #     prc.parameters(lambda: false) #=> [[:opt, :x], [:opt, :y], [:rest, :other]]
   #
-  def parameters: (lambda: boolish) -> ::Array[[ Symbol, Symbol ]]
+  def parameters: (?lambda: boolish) -> ::Array[[ Symbol, Symbol ]]
 
   # <!--
   #   rdoc-file=proc.c

data/core/rational.rbs

@@ -245,7 +245,8 @@ class Rational < Numeric
 
   def div: (Numeric) -> Integer
 
-  def divmod: (Numeric) -> [ Numeric, Numeric ]
+  def divmod: (Integer | Float | Rational) -> [ Integer, Rational ]
+            | (Numeric) -> [ Numeric, Numeric ]
 
   def dup: () -> self
 

data/core/regexp.rbs

@@ -1544,8 +1544,8 @@ class Regexp
   #
   # If any regexp pattern contains captures, the behavior is unspecified.
   #
-  def self.union: (*_ToRegexp | string patterns) -> Regexp
-                | (array[_ToRegexp | string] patterns) -> Regexp
+  def self.union: (*Regexp | _ToRegexp | string patterns) -> Regexp
+                | (array[Regexp | _ToRegexp | string] patterns) -> Regexp
                 | (Symbol | [Symbol] symbol_pattern) -> Regexp
 
   # <!--

data/core/ruby_vm.rbs

@@ -309,9 +309,13 @@ module RubyVM::YJIT
   #   rdoc-file=yjit.rb
   #   - enable(stats: false)
   # -->
-  # Enable YJIT compilation.
+  # Enable YJIT compilation. `stats` option decides whether to enable YJIT stats
+  # or not.
+  # *   `false`: Disable stats.
+  # *   `true`: Enable stats. Print stats at exit.
+  # *   `:quiet`: Enable stats. Do not print stats at exit.
   #
-  def self.enable: () -> void
+  def self.enable: (?stats: false | true | :quiet) -> void
 
   # <!--
   #   rdoc-file=yjit.rb

data/core/rubygems/rubygems.rbs

@@ -482,7 +482,7 @@ module Gem
   #   rdoc-file=lib/rubygems.rb
   #   - find_unresolved_default_spec(path)
   # -->
-  # Find a Gem::Specification of default gem from `path`
+  # Find an unresolved Gem::Specification of default gem from `path`
   #
   def self.find_unresolved_default_spec: (String path) -> Specification?
 

data/core/set.rbs

@@ -415,7 +415,7 @@ class Set[unchecked out A]
   # Equivalent to Set#delete_if, but returns nil if no changes were
   # made. Returns an enumerator if no block is given.
   #
-  def reject!: () { (A) -> untyped } -> self
+  def reject!: () { (A) -> untyped } -> self?
 
   # <!--
   #   rdoc-file=lib/set.rb
@@ -437,7 +437,7 @@ class Set[unchecked out A]
   #     Set[1, 2, 3].disjoint? [3, 4]      #=> false
   #     Set[1, 2, 3].disjoint? 4..5        #=> true
   #
-  def disjoint?: (_Each[A]) -> bool
+  def disjoint?: (Set[A] | Enumerable[A]) -> bool
 
   # <!--
   #   rdoc-file=lib/set.rb
@@ -458,8 +458,8 @@ class Set[unchecked out A]
   #
   # Returns an enumerator if no block is given.
   #
-  def divide: () { (A, A) -> untyped } -> Set[self]
-            | () { (A) -> untyped } -> Set[self]
+  def divide: () { (A, A) -> Hash::_Key } -> Set[self]
+            | () { (A) -> Hash::_Key } -> Set[self]
 
   # <!--
   #   rdoc-file=lib/set.rb
@@ -500,7 +500,7 @@ class Set[unchecked out A]
   #     Set[1, 2, 3].intersect? 4..5        #=> false
   #     Set[1, 2, 3].intersect? [3, 4]      #=> true
   #
-  def intersect?: (_Each[A]) -> bool
+  def intersect?: (Set[A] | Enumerable[A]) -> bool
 
   # <!--
   #   rdoc-file=lib/set.rb
@@ -534,7 +534,7 @@ class Set[unchecked out A]
   # Merges the elements of the given enumerable objects to the set and
   # returns self.
   #
-  def merge: (_Each[A]) -> self
+  def merge: (*_Each[A]) -> self
 
   # <!--
   #   rdoc-file=lib/set.rb
@@ -544,7 +544,13 @@ class Set[unchecked out A]
   #
   def subset?: (self) -> bool
 
-  def proper_subst?: (self) -> bool
+  # <!--
+  #   rdoc-file=lib/set.rb
+  #   - proper_subset?(set)
+  # -->
+  # Returns true if the set is a proper subset of the given set.
+  #
+  def proper_subset?: (self) -> bool
 
   # <!--
   #   rdoc-file=lib/set.rb

data/docs/gem.md

@@ -31,7 +31,6 @@ Assume you have three RBS files in your gem package:
 
 ```yaml
 dependencies:
-  - name: abbrev
   - name: json
   - name: logger
   - name: optparse