rbs 3.2.2 → 3.3.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35554c5e6cea0f61928bfdc6faaf896414118057a8889c82dd1d6dc87811811
-  data.tar.gz: f6506b40efbcc5df5ffeb51ebd700e63311b76aaf6c9627e542aecf8d16232b8
+  metadata.gz: 0ce19044f9943d12d17256e09e0296aca13a4284b9e2f76de3b130c002ed9244
+  data.tar.gz: d3b2b843cf28aeb5ef4608356aa0eb2d958d4392f541fe91e5e00e7f68a40fc4
 SHA512:
-  metadata.gz: b075058eceed815b0fb39a844dc663bda7651694a79a024a33196a252e58eb6767cdc14595fbf989d02f8558ac4b252d543e8e13bfd930abd046e259d12e97a3
-  data.tar.gz: 7a19f068dc2278bc2bd0332559ecf91c848516f80537ff7bb3bda7cf6084e4c085fbae8f59e7dae241ae16867827e13e81107d154d78c7336cc560eda9084dbb
+  metadata.gz: 02e143cf64af949a560f3b41b9d1a1756375ae0456182a3b727b985db88d5f5fe092887d21c3237036ddf177f19661ef80f03c6daa96fdd6840e727d579f1018
+  data.tar.gz: 38df75f2912926a63b6082a4515b063e8f4c71d9e3c820adb0b2ee6e7030464fa3702faad28b04b221facb31c79c5aff0f96b7f4d2624b1b399378fc5bcd6168

data/.github/workflows/comments.yml

@@ -13,7 +13,7 @@ jobs:
     container:
       image: rubylang/ruby:3.2-dev-focal
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install dependencies
         run: |
           apt-get update

data/.github/workflows/ruby.yml

@@ -11,6 +11,7 @@ jobs:
   test:
     runs-on: "ubuntu-latest"
     strategy:
+      fail-fast: false
       matrix:
         container_tag:
           - master-nightly-focal
@@ -30,10 +31,13 @@ jobs:
             job: stdlib_test
           - container_tag: 3.1-dev-focal
             job: stdlib_test
+        include:
+          - container_tag: master-nightly-focal
+            allow_failures: "true"
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set working directory as safe
         run: git config --global --add safe.directory $(pwd)
       - name: Install dependencies
@@ -66,6 +70,7 @@ jobs:
       - name: Run test
         run: |
           bundle exec rake ${{ matrix.job }}
+        continue-on-error: ${{ matrix.allow_failures == 'true' && (github.event_name == 'push' || github.event_name == 'merge_group') }}
 
   windows:
     runs-on: ${{ matrix.os }}
@@ -75,7 +80,7 @@ jobs:
         os: [windows-2019, windows-2022]
         ruby: [ucrt, mswin]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: load ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -2,6 +2,91 @@
 
 ## master
 
+## 3.3.0.pre.1 (2023-10-31)
+
+### Signature updates
+
+* json ([#1575](https://github.com/ruby/rbs/pull/1575))
+* net-protocol ([#1559](https://github.com/ruby/rbs/pull/1559))
+* pp ([#1545](https://github.com/ruby/rbs/pull/1545))
+* psych ([#1527](https://github.com/ruby/rbs/pull/1527))
+* `BasicObject` ([#1506](https://github.com/ruby/rbs/pull/1506))
+* `ConditionVariable` ([#1468](https://github.com/ruby/rbs/pull/1468))
+* `Encoding` ([#1510](https://github.com/ruby/rbs/pull/1510))
+* `Exception` ([#1529](https://github.com/ruby/rbs/pull/1529))
+* `FalseClass` ([#1478](https://github.com/ruby/rbs/pull/1478), [#1487](https://github.com/ruby/rbs/pull/1487))
+* `Fiber` ([#1463](https://github.com/ruby/rbs/pull/1463))
+* `FileTest` ([#1500](https://github.com/ruby/rbs/pull/1500))
+* `Kernel` ([#1567](https://github.com/ruby/rbs/pull/1567), [#1518](https://github.com/ruby/rbs/pull/1518), [#1504](https://github.com/ruby/rbs/pull/1504), [#1487](https://github.com/ruby/rbs/pull/1487))
+* `Marshal` ([#1524](https://github.com/ruby/rbs/pull/1524))
+* `Math` ([#1533](https://github.com/ruby/rbs/pull/1533))
+* `Mutex` ([#1468](https://github.com/ruby/rbs/pull/1468))
+* `NilClass` ([#1478](https://github.com/ruby/rbs/pull/1478), [#1487](https://github.com/ruby/rbs/pull/1487))
+* `Object` ([#1504](https://github.com/ruby/rbs/pull/1504))
+* `Queue` ([#1468](https://github.com/ruby/rbs/pull/1468))
+* `RbConfig` ([#1534](https://github.com/ruby/rbs/pull/1534))
+* `Signal` ([#1512](https://github.com/ruby/rbs/pull/1512))
+* `SizedQueue` ([#1468](https://github.com/ruby/rbs/pull/1468))
+* `ThreadGroup` ([#1509](https://github.com/ruby/rbs/pull/1509))
+* `TrueClass` ([#1478](https://github.com/ruby/rbs/pull/1478), [#1487](https://github.com/ruby/rbs/pull/1487))
+* `Warning` ([#1477](https://github.com/ruby/rbs/pull/1477))
+* `Enumerator.produce` ([#1516](https://github.com/ruby/rbs/pull/1516))
+* `Module.define_method` ([#1557](https://github.com/ruby/rbs/pull/1557))
+* `URI.join` ([#1580](https://github.com/ruby/rbs/pull/1580))
+* `YAML.unsafe_load` ([#1528](https://github.com/ruby/rbs/pull/1528))
+* `builtin.rbs`([#1455](https://github.com/ruby/rbs/pull/1455), [#1469](https://github.com/ruby/rbs/pull/1469))
+* `constants.rbs` ([#1531](https://github.com/ruby/rbs/pull/1531))
+* `::interned` ([#1499](https://github.com/ruby/rbs/pull/1499), [#1488](https://github.com/ruby/rbs/pull/1488))
+
+
+### Language updates
+
+* Add `__todo__` type ([#1520](https://github.com/ruby/rbs/pull/1520))
+
+### Library changes
+
+* Colored diff ([#1589](https://github.com/ruby/rbs/pull/1589))
+* Fix the issue where ::array[T] would be interpreted as ::array, and type mismatch ([#1491](https://github.com/ruby/rbs/pull/1491))
+* Add `Abbrev` to runtime dependency ([#1573](https://github.com/ruby/rbs/pull/1573))
+* Avoid an error when parsing files including SyntaxError ([#1574](https://github.com/ruby/rbs/pull/1574))
+* Implement rbs diff command ([#1459](https://github.com/ruby/rbs/pull/1459))
+* Add another type syntax validation ([#1566](https://github.com/ruby/rbs/pull/1566))* Mark global variables ([#1551](https://github.com/ruby/rbs/pull/1551))
+* Show location of type by method command ([#1537](https://github.com/ruby/rbs/pull/1537))* Make alias and interface names absolute ([#1502](https://github.com/ruby/rbs/pull/1502))
+* Better record type format ([#1501](https://github.com/ruby/rbs/pull/1501))
+* Should keep escape of alias and attr family ([#1486](https://github.com/ruby/rbs/pull/1486))
+* Fix error when undefined interface or alias ([#1465](https://github.com/ruby/rbs/pull/1465))
+
+#### rbs prototype
+
+* [prototype runtime --todo] Consider accessibility mismatch ([#1539](https://github.com/ruby/rbs/pull/1539))
+* Better support for inherited class of `Struct` or `Data` by prototype runtime ([#1571](https://github.com/ruby/rbs/pull/1571))
+* prototype rb: Ignore ITER (method call with block) ([#1562](https://github.com/ruby/rbs/pull/1562))
+* [prototype runtime] Add --autoload option ([#1561](https://github.com/ruby/rbs/pull/1561))
+* Implement todo option ([#1470](https://github.com/ruby/rbs/pull/1470))
+* [prototype runtime] Fix error when constant is a BasicObject instance. ([#1485](https://github.com/ruby/rbs/pull/1485))
+* [prototype runtime] Const name should be absolute ([#1490](https://github.com/ruby/rbs/pull/1490))
+* [prototype runtime] Optimize performance ([#1495](https://github.com/ruby/rbs/pull/1495))
+* [prototype runtime] Fix error when output Object constants ([#1472](https://github.com/ruby/rbs/pull/1472))
+* [prototype runtime] Support prepend mixin ([#1460](https://github.com/ruby/rbs/pull/1460))
+* [prototype runtime] Avoid alias for methods defined in another module ([#1457](https://github.com/ruby/rbs/pull/1457))
+
+#### rbs collection
+
+* [Collection] Simple colorize collection text like Bundler ([#1558](https://github.com/ruby/rbs/pull/1558))
+* Delete `sources` section from lockfile ([#1544](https://github.com/ruby/rbs/pull/1544))
+
+### Miscellaneous
+
+* Add in with_XXX methods ([#1492](https://github.com/ruby/rbs/pull/1492))
+* Updated binding to use modern kernel tests ([#1507](https://github.com/ruby/rbs/pull/1507))
+* Remove all non-required methods from testing types ([#1541](https://github.com/ruby/rbs/pull/1541))
+* Add `assert_type` assertion to confirm if the value has a type ([#1532](https://github.com/ruby/rbs/pull/1532))
+* Add `#assert_const_type` and guide to use type assertions ([#1514](https://github.com/ruby/rbs/pull/1514))
+* Improve skip test message ([#1476](https://github.com/ruby/rbs/pull/1476))
+* Type check ([#1467](https://github.com/ruby/rbs/pull/1467))
+* Type check RDoc related Ruby code ([#1466](https://github.com/ruby/rbs/pull/1466))
+* Fix CI failure ([#1464](https://github.com/ruby/rbs/pull/1464))
+
 ## 3.2.2 (2023-09-28)
 
 ### Library changes

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rbs (3.2.2)
+    rbs (3.3.0.pre.1)
+      abbrev
 
 PATH
   remote: test/assets/test-gem
@@ -11,10 +12,10 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
+    abbrev (0.1.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    base64 (0.1.1)
     dbm (1.1.0)
     diff-lcs (1.5.0)
     digest (3.1.1)
@@ -24,27 +25,27 @@ GEM
       rainbow (>= 3.0, < 4.0)
       strong_json (>= 1.1, < 2.2)
     json (2.6.3)
-    json-schema (4.0.0)
+    json-schema (4.1.1)
       addressable (>= 2.8)
     language_server-protocol (3.17.0.3)
     marcel (1.0.2)
-    minitest (5.19.0)
+    minitest (5.20.0)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
     power_assert (2.0.3)
     psych (4.0.6)
       stringio
-    public_suffix (5.0.1)
+    public_suffix (5.0.3)
     racc (1.7.1)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     rake-compiler (1.2.5)
       rake
     rdoc (6.4.0)
       psych (>= 4.0.0)
-    regexp_parser (2.8.1)
+    regexp_parser (2.8.2)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -59,19 +60,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.56.0)
-      base64 (~> 0.1.1)
+    rubocop (1.57.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     rubocop-rubycw (0.1.6)
       rubocop (~> 1.0)
@@ -82,7 +82,7 @@ GEM
     tempfile (0.1.3)
     test-unit (3.6.1)
       power_assert
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -54,8 +54,8 @@ end
 
 ## The Target Version
 
-* The standard library signatures targets Ruby 3.1. (The latest release of Ruby.)
-* The library code targets Ruby 3.1, 3.0, and 2.7. (It runs on 2.6 in fact.)
+* The standard library signatures targets the latest release of Ruby. (`3.2` as of 2023.)
+* The library code targets non-EOL versions of Ruby. (`>= 3.0` as of 2023.)
 
 ## Installation
 
@@ -132,6 +132,15 @@ puts singleton.methods[:gsub]
 - [Stdlib signatures guide](docs/stdlib.md)
 - [Syntax](docs/syntax.md)
 - [RBS by Example](docs/rbs_by_example.md)
+- [RBS collection](docs/collection.md)
+- [Using `Data` and `Struct`](docs/data_and_struct.md)
+
+## Community
+
+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.
 
 ## Development
 

data/Rakefile

@@ -84,11 +84,12 @@ end
 
 task :stdlib_test => :compile do
   test_files = FileList["test/stdlib/**/*_test.rb"].reject do |path|
-    path =~ %r{Ractor}
+    path =~ %r{Ractor} || path =~ %r{Encoding}
   end
   sh "#{ruby} -Ilib #{bin}/test_runner.rb #{test_files.join(' ')}"
   # TODO: Ractor tests need to be run in a separate process
   sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Ractor_test.rb"
+  sh "#{ruby} -Ilib #{bin}/test_runner.rb test/stdlib/Encoding_test.rb"
 end
 
 task :rubocop do
@@ -157,13 +158,14 @@ namespace :generate do
             # library "pathname", "securerandom"     # Declare library signatures to load
             testing "singleton(::<%= target %>)"
 
-          <%- class_methods.each do |method_name, definition| %>
+          <%- class_methods.each do |method_name, definition| -%>
             def test_<%= test_name_for(method_name) %>
           <%- definition.method_types.each do |method_type| -%>
-              assert_send_type  "<%= method_type %>",
-                                <%= target %>, :<%= method_name %>
+              assert_send_type "<%= method_type %>",
+                               <%= target %>, :<%= method_name %>
           <%- end -%>
             end
+
           <%- end -%>
           end
           <%- end -%>
@@ -175,13 +177,14 @@ namespace :generate do
             # library "pathname", "securerandom"     # Declare library signatures to load
             testing "::<%= target %>"
 
-          <%- instance_methods.each do |method_name, definition| %>
+          <%- instance_methods.each do |method_name, definition| -%>
             def test_<%= test_name_for(method_name) %>
           <%- definition.method_types.each do |method_type| -%>
-              assert_send_type  "<%= method_type %>",
-                                <%= target %>.new, :<%= method_name %>
+              assert_send_type "<%= method_type %>",
+                               <%= target %>.new, :<%= method_name %>
           <%- end -%>
             end
+
           <%- end -%>
           end
           <%- end -%>

data/Steepfile

@@ -4,23 +4,23 @@ target :lib do
   signature "sig"
   check "lib"
   ignore(
-    "lib/rbs/prototype/runtime.rb",
     "lib/rbs/test",
     "lib/rbs/test.rb"
   )
 
-  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'abbrev'
+  library "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest', 'abbrev', 'prettyprint'
   signature 'stdlib/yaml/0'
   signature "stdlib/strscan/0/"
   signature "stdlib/optparse/0/"
   signature "stdlib/rdoc/0/"
   signature "stdlib/ripper/0"
+  signature "stdlib/pp/0"
 
-  configure_code_diagnostics do |config|
-    config[D::Ruby::MethodDefinitionMissing] = :hint
-    config[D::Ruby::ElseOnExhaustiveCase] = :hint
-    config[D::Ruby::FallbackAny] = :hint
-  end
+  # configure_code_diagnostics do |config|
+  #   config[D::Ruby::MethodDefinitionMissing] = :hint
+  #   config[D::Ruby::ElseOnExhaustiveCase] = :hint
+  #   config[D::Ruby::FallbackAny] = :hint
+  # end
 end
 
 # target :lib do

data/core/basic_object.rbs

@@ -163,7 +163,7 @@ class BasicObject
   #     k = Klass.new
   #     k.send :hello, "gentle", "readers"   #=> "Hello gentle readers"
   #
-  def __send__: (String | Symbol arg0, *untyped args) -> untyped
+  def __send__: (interned name, *untyped, **untyped) ?{ (*untyped, **untyped) -> untyped } -> untyped
 
   # <!-- rdoc-file=object.c -->
   # Equality --- At the Object level, #== returns `true` only if `obj` and `other`
@@ -195,7 +195,7 @@ class BasicObject
   #     1 == 1.0     #=> true
   #     1.eql? 1.0   #=> false
   #
-  def equal?: (untyped other) -> bool
+  alias equal? ==
 
   # <!--
   #   rdoc-file=vm_eval.c
@@ -228,7 +228,7 @@ class BasicObject
   #     k.instance_eval { the_secret }       #=> "Ssssh! The secret is 99."
   #     k.instance_eval {|obj| obj == self } #=> true
   #
-  def instance_eval: (String, ?String filename, ?Integer lineno) -> untyped
+  def instance_eval: (string code, ?string filename, ?int lineno) -> untyped
                    | [U] () { (self) [self: self] -> U } -> U
 
   # <!--
@@ -256,7 +256,7 @@ class BasicObject
   # -->
   # Returns a new BasicObject.
   #
-  def initialize: () -> void
+  def initialize: () -> nil
 
   private
 
@@ -318,7 +318,7 @@ class BasicObject
   #     Adding one
   #     Adding three
   #
-  def singleton_method_added: (Symbol) -> void
+  def singleton_method_added: (Symbol name) -> nil
 
   # <!--
   #   rdoc-file=object.c
@@ -345,7 +345,7 @@ class BasicObject
   #     Removing three
   #     Removing one
   #
-  def singleton_method_removed: (Symbol) -> void
+  def singleton_method_removed: (Symbol name) -> nil
 
   # <!--
   #   rdoc-file=object.c
@@ -368,5 +368,5 @@ class BasicObject
   #
   #     Undefining one
   #
-  def singleton_method_undefined: (Symbol) -> void
+  def singleton_method_undefined: (Symbol name) -> nil
 end

data/core/binding.rbs

@@ -66,7 +66,7 @@ class Binding
   #
   #     binding.eval("defined?(#{symbol}) == 'local-variable'")
   #
-  def local_variable_defined?: (Symbol | string varname) -> bool
+  def local_variable_defined?: (interned varname) -> bool
 
   # <!--
   #   rdoc-file=proc.c
@@ -84,7 +84,7 @@ class Binding
   #
   #     binding.eval("#{symbol}")
   #
-  def local_variable_get: (Symbol | string varname) -> untyped
+  def local_variable_get: (interned varname) -> untyped
 
   # <!--
   #   rdoc-file=proc.c
@@ -111,7 +111,7 @@ class Binding
   #
   # if `obj` can be dumped in Ruby code.
   #
-  def local_variable_set: [U] (Symbol | string varname, U obj) -> U
+  def local_variable_set: [U] (interned varname, U obj) -> U
 
   # <!--
   #   rdoc-file=proc.c