Merge branch 'master' into kconv

Author: tk0miya

.github/workflows/ruby.yml

@@ -32,6 +32,8 @@ jobs:
             job: lexer compile confirm_lexer
           - ruby: "3.3"
             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

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)
 

Gemfile

@@ -40,3 +40,7 @@ gem 'csv'
 group :minitest do
   gem "minitest"
 end
+
+group :typecheck_test do
+  gem "steep", "~> 1.7.0.dev", require: false
+end

Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs (3.5.0.pre.2)
-      abbrev
+    rbs (3.5.0)
 
 PATH
   remote: test/assets/test-gem
@@ -13,26 +12,47 @@ GEM
   remote: https://rubygems.org/
   specs:
     abbrev (0.1.2)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
     benchmark-ips (2.13.0)
     bigdecimal (3.1.8)
+    concurrent-ruby (1.3.1)
+    connection_pool (2.4.1)
     csv (3.3.0)
     dbm (1.1.0)
     diff-lcs (1.5.1)
     digest (3.1.1)
+    drb (2.2.1)
+    ffi (1.17.0)
+    ffi (1.17.0-x86_64-darwin)
     fileutils (1.7.2)
     goodcheck (3.1.0)
       marcel (>= 1.0, < 2.0)
       psych (>= 3.1, < 5.0)
       rainbow (>= 3.0, < 4.0)
       strong_json (>= 1.1, < 2.2)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
     json (2.7.2)
     json-schema (4.3.0)
       addressable (>= 2.8)
     language_server-protocol (3.17.0.3)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.0)
     marcel (1.0.4)
     memory_profiler (1.0.1)
     minitest (5.23.1)
@@ -58,6 +78,9 @@ GEM
     rake (13.2.1)
     rake-compiler (1.2.7)
       rake
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
     rdoc (6.6.3.1)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
@@ -92,14 +115,34 @@ GEM
     rubocop-rubycw (0.1.6)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
     stackprof (0.2.26)
+    steep (1.7.0.dev.4)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 3.5.0.pre)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
     stringio (3.1.0)
     strong_json (2.1.2)
     strscan (3.1.0)
     tempfile (0.2.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     test-unit (3.6.2)
       power_assert
     timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS
@@ -133,6 +176,7 @@ DEPENDENCIES
   rubocop
   rubocop-rubycw
   stackprof
+  steep (~> 1.7.0.dev)
   tempfile
   test-unit
 

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,19 @@ 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

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/"

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
 

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 ]
 
   # <!--

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
 

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