rbs 3.4.4 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cb14174ab8984f446bae9472db5994cfd3f660101eb6ce33d53b1ce8d2c0871
-  data.tar.gz: f91955d86a636a762d5894fdb0230024c05dda5c2957c70c126d5d1e8ebe21e6
+  metadata.gz: 3dc7a972ca885618f8bcb3beb35d5096ddd9cc3dc6880fb6ae6b06d4a1845be0
+  data.tar.gz: 3fd84cf6a4869385f16e98cb1319855fcc1fcc242e16731b6bbdd5d249f1df8a
 SHA512:
-  metadata.gz: d26b8e953ca26fd82eb8c0a74718c9288ac0871de48b5ba4e968fe2ed00cbeb8396097b0b75c732227b2a7cb3eb59338ed3ca945a5051ff3f9d3c7293c37f5db
-  data.tar.gz: fa9c674f1fb275fcb920beea62d731edf3f831c7d2c9d53bcdd3ee97fb8d213b974e24466eb9ebf11f1922f35ed85ec6afd3466b93404d17de49e4d3377249b6
+  metadata.gz: 0b79dcac9fa9f94eff95b2c098208784f45e8ee891b94202f8e82886d15e0af04bbb26acdff5428277470536cfef164f79b5a1f73ded288b320600bd15568500
+  data.tar.gz: c0c6f53213e0b0aac09747c2aef470548b2b872b8ace2647ebdedca292a55b8aa0dbbebfa5c3ff75c47d3f76e87643f23f75883cacc49726fd778f95e1c3ee9e

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

@@ -14,6 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['3.0', '3.1', '3.2', '3.3', head]
+        rubyopt: [""]
         job:
           - test
         include:
@@ -21,10 +22,18 @@ jobs:
             job: stdlib_test rubocop
           - ruby: "3.3"
             job: stdlib_test
+          - ruby: "3.3"
+            job: test
+            rubyopt: "--enable-frozen-string-literal"
+          - ruby: "3.3"
+            job: stdlib_test
+            rubyopt: "--enable-frozen-string-literal"
           - 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
@@ -57,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,92 @@
 # CHANGELOG
 
-## master
+## 3.5.1 (2024-06-07)
+
+### Library changes
+
+* Add explicit dependency on the `logger` gem ([#1865](https://github.com/ruby/rbs/pull/1865))
+* Make c99, c23 compatible ([#1870](https://github.com/ruby/rbs/pull/1870))
+
+### Miscellaneous
+
+* Don't try to sign git commits when running tests ([#1867](https://github.com/ruby/rbs/pull/1867))
+
+## 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)
 

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
@@ -118,7 +118,7 @@ end
 It prints signatures for all methods, classes, instance variables, and constants.
 This is only a starting point, and you should edit the output to match your signature more accurately.
 
-`rbs prototpe` offers three options.
+`rbs prototype` offers three options.
 
 - `rb` generates from just the available Ruby code
 - `rbi` generates from Sorbet RBI
@@ -174,6 +174,7 @@ puts singleton.methods[:gsub]
 
 ## Guides
 
+- [Architecture](docs/architecture.md)
 - [Core and standard library signature contribution guide](docs/CONTRIBUTING.md)
 - [Writing signatures guide](docs/sigs.md)
 - [Stdlib signatures guide](docs/stdlib.md)
@@ -189,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
@@ -153,7 +170,7 @@ namespace :generate do
 
           <%- unless class_methods.empty? -%>
           class <%= target %>SingletonTest < Test::Unit::TestCase
-            include TypeAssertions
+            include TestHelper
 
             # library "pathname", "securerandom"     # Declare library signatures to load
             testing "singleton(::<%= target %>)"
@@ -172,7 +189,7 @@ namespace :generate do
 
           <%- unless instance_methods.empty? -%>
           class <%= target %>Test < Test::Unit::TestCase
-            include TypeAssertions
+            include TestHelper
 
             # library "pathname", "securerandom"     # Declare library signatures to load
             testing "::<%= target %>"

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/enumerator.rbs

@@ -293,7 +293,7 @@ class Enumerator[unchecked out Elem, out Return] < Object
   # lazy fashion (see Enumerator#size). It can either be a value or a callable
   # object.
   #
-  def initialize: (?Integer arg0) { (Enumerator::Yielder arg0) -> void } -> void
+  def initialize: (?Integer arg0) { (Enumerator::Yielder arg0) -> Return } -> void
 
   # <!--
   #   rdoc-file=enumerator.c

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