Ruby 3.3 support

[eregon]

We are working on Ruby 3.3 support for the next release (24.2).

Any help is appreciated whether it is:

• implementing one of the Ruby 3.3 changes in TruffleRuby, and ensuring it is tested in specs or MRI tests and otherwise add specs. If adding specs please leave a comment here to mention you are working on adding these specs to avoid conflicts & duplicated work.
• adding specs for Ruby 3.3 changes, which is best done in ruby/spec directly, see https://github.com/ruby/spec/issues/1216

To make it easier to find good getting-started issues, I annotated items with easy, medium and hard. There is also pure ruby for changes which should only affect Ruby code and not require any change to Java sources or any Java knowledge. If there is no pure ruby then some Java code is involved, but it should still be fairly straightforward if easy or medium. hard typically requires more knowledge about TruffleRuby implementation details. [import] means this needs the import of Ruby 3.3 sources to happen first.

If you'd like to start on some task please mention it here or edit the description directly for committers (to avoid duplicated work).

Full list of changes for Ruby 3.3.0

NOTE: https://rubyreferences.github.io/rubychanges/3.3.html gives more details for many features and changes.

From https://github.com/ruby/ruby/blob/master/doc/NEWS/NEWS-3.3.0.md:

This document is a list of user-visible feature changes since the 3.2.0 release, except for bug fixes.

Note that each entry is kept to a minimum, see links for details.

Core classes updates

Note: We're only listing outstanding class updates.

Array

• [ ] [easy, Java] Array#pack now raises ArgumentError for unknown directives. [Bug #19150]. NOTE: change how unknown directives are handled in org.truffleruby.core.format.pack.SimplePackParser#parse. Fixes String#unpack as well.

Dir

• [ ] [medium, Ruby] Dir.for_fd added for returning a Dir object for the directory specified by the provided directory file descriptor. [Feature #19347]
• [ ] [medium, Ruby] Dir.fchdir added for changing the directory to the directory specified by the provided directory file descriptor. [Feature #19347]
• [ ] [easy, Ruby] Dir#chdir added for changing the directory to the directory specified by the provided Dir object. [Feature #19347]

Encoding

• [ ] [easy, Ruby/Java]Encoding#replicate has been removed, it was already deprecated. [Feature #18949]

Fiber

• [ ] Introduce Fiber#kill. [Bug #595]

fiber = Fiber.new do
  while true
    puts "Yielding..."
    Fiber.yield
  end
ensure
  puts "Exiting..."
end

fiber.resume
# Yielding...
fiber.kill
# Exiting...

MatchData

• [ ] [easy, Ruby] MatchData#named_captures now accepts optional symbolize_names keyword. [Feature #19591]

Module

• [ ] [medium, Java] Module#set_temporary_name added for setting a temporary name for a module. [Feature #19521]

ObjectSpace::WeakKeyMap

• [ ] New core class to build collections with weak references. The class use equality semantic to lookup keys like a regular hash, but it doesn't hold strong references on the keys. [Feature #18498]

ObjectSpace::WeakMap

• [ ] [easy, Java] ObjectSpace::WeakMap#delete was added to eagerly clear weak map entries. [Feature #19561]

Proc

• [ ] [easy, Java] Now Proc#dup and Proc#clone call #initialize_dup and #initialize_clone hooks respectively. [Feature #19362]

Process

• [x] New Process.warmup method that notify the Ruby virtual machine that the boot sequence is finished, and that now is a good time to optimize the application. This is useful for long-running applications. The actual optimizations performed are entirely implementation-specific and may change in the future without notice. [Feature #18885]

Process::Status

• [ ] [easy, Ruby] Process::Status#& and Process::Status#>> are deprecated. [Bug #19868]

Range

• [ ] [medium, Ruby] Range#reverse_each can now process beginless ranges with an Integer endpoint. [Feature #18515]
• [ ] [easy, Ruby] Range#reverse_each now raises TypeError for endless ranges. [Feature #18551]
• [ ] [easy, Ruby] Range#overlap? added for checking if two ranges overlap. [Feature #19839]

Refinement

• [ ] [easy, Ruby] Add Refinement#target as an alternative of Refinement#refined_class. Refinement#refined_class is deprecated and will be removed in Ruby 3.4. [Feature #19714]

Regexp

• [ ] The cache-based optimization now supports lookarounds and atomic groupings. That is, match for Regexp containing these extensions can now also be performed in linear time to the length of the input string. However, these cannot contain captures and cannot be nested. [Feature #19725]

String

• [ ] [easy, Java] String#unpack now raises ArgumentError for unknown directives. [Bug #19150]. NOTE: fixes Array#pack as well.
• [ ] [medium, Ruby] String#bytesplice now accepts new arguments index/length or range of the source string to be copied. [Feature #19314]. NOTE: index/length parameters are already implemented.

Thread::Queue

• [ ] [easy, Ruby] Thread::Queue#freeze now raises TypeError. [Bug #17146]. NOTE: the Queue class is defined in lib/truffle/thread.rb file.

Thread::SizedQueue

• [ ] [easy, Ruby] Thread::SizedQueue#freeze now raises TypeError. [Bug #17146]. NOTE: the SizedQueue class is defined in lib/truffle/thread.rb file.

Time

• [ ] [medium, Ruby] Time.new with a string argument became stricter. [Bug #19293]

Time.new('2023-12-20')
#  no time information (ArgumentError)

TracePoint

• [ ] TracePoint supports rescue event. When the raised exception was rescued, the TracePoint will fire the hook. rescue event only supports Ruby-level rescue. [Feature #19572]

Stdlib updates

• [x] RubyGems and Bundler warn if users do require the following gems without adding them to Gemfile or gemspec. This is because they will become the bundled gems in the future version of Ruby. This warning is suppressed if you use bootsnap gem. We recommend to run your application with DISABLE_BOOTSNAP=1 environmental variable at least once. This is limitation of this version. [Feature #19351] [Feature #19776] [Feature #19843]

  • abbrev
  • base64
  • bigdecimal
  • csv
  • drb
  • getoptlong
  • mutex_m
  • nkf
  • observer
  • racc
  • resolv-replace
  • rinda
  • syslog

• [ ] Socket#recv and Socket#recv_nonblock returns nil instead of an empty string on closed connections. Socket#recvmsg and Socket#recvmsg_nonblock returns nil instead of an empty packet on closed connections. [Bug #19012]

• [ ] Name resolution such as Socket.getaddrinfo, Socket.getnameinfo, Addrinfo.getaddrinfo, etc. can now be interrupted. [Feature #19965]

• [x] Random::Formatter#alphanumeric is extended to accept optional chars keyword argument. [Feature #18183]

• [x] The following default gem is added.

  • prism 0.19.0

• [x] The following default gems are updated.

  • RubyGems 3.5.3
  • abbrev 0.1.2
  • base64 0.2.0
  • benchmark 0.3.0
  • bigdecimal 3.1.5
  • bundler 2.5.3
  • cgi 0.4.1
  • csv 3.2.8
  • date 3.3.4
  • delegate 0.3.1
  • drb 2.2.0
  • english 0.8.0
  • erb 4.0.3
  • error_highlight 0.6.0
  • etc 1.4.3
  • fcntl 1.1.0
  • fiddle 1.1.2
  • fileutils 1.7.2
  • find 0.2.0
  • getoptlong 0.2.1
  • io-console 0.7.1
  • io-nonblock 0.3.0
  • io-wait 0.3.1
  • ipaddr 1.2.6
  • irb 1.11.0
  • json 2.7.1
  • logger 1.6.0
  • mutex_m 0.2.0
  • net-http 0.4.0
  • net-protocol 0.2.2
  • nkf 0.1.3
  • observer 0.1.2
  • open-uri 0.4.1
  • open3 0.2.1
  • openssl 3.2.0
  • optparse 0.4.0
  • ostruct 0.6.0
  • pathname 0.3.0
  • pp 0.5.0
  • prettyprint 0.2.0
  • pstore 0.1.3
  • psych 5.1.2
  • rdoc 6.6.2
  • readline 0.0.4
  • reline 0.4.1
  • resolv 0.3.0
  • rinda 0.2.0
  • securerandom 0.3.1
  • set 1.1.0
  • shellwords 0.2.0
  • singleton 0.2.0
  • stringio 3.1.0
  • strscan 3.0.7
  • syntax_suggest 2.0.0
  • syslog 0.1.2
  • tempfile 0.2.1
  • time 0.3.0
  • timeout 0.4.1
  • tmpdir 0.2.0
  • tsort 0.2.0
  • un 0.3.0
  • uri 0.13.0
  • weakref 0.1.3
  • win32ole 1.8.10
  • yaml 0.3.0
  • zlib 3.1.0

• [x] The following bundled gem is promoted from default gems.

  • racc 1.7.3

• [x] The following bundled gems are updated.

  • minitest 5.20.0
  • rake 13.1.0
  • test-unit 3.6.1
  • rexml 3.2.6
  • rss 0.3.0
  • net-ftp 0.3.3
  • net-imap 0.4.9
  • net-smtp 0.4.0
  • rbs 3.4.0
  • typeprof 0.21.9
  • debug 1.9.1

See GitHub releases like Logger or changelog for details of the default gems or bundled gems.

Prism

• [x] Introduced the Prism parser as a default gem
  • Prism is a portable, error tolerant, and maintainable recursive descent parser for the Ruby language

Compatibility issues

• [ ] Subprocess creation/forking via the following file open methods is deprecated. [Feature #19630]

  • Kernel#open
  • URI.open
  • IO.binread
  • IO.foreach
  • IO.readlines
  • IO.read
  • IO.write

• [ ] [easy, Java] When given a non-lambda, non-literal block, Kernel#lambda with now raises ArgumentError instead of returning it unmodified. These usages have been issuing warnings under the Warning[:deprecated] category since Ruby 3.0.0. [Feature #19777]

• [ ] (@andrykonchin) [medium, Java] it calls without arguments in a block with no ordinary parameters are deprecated. it will be a reference to the first block parameter in Ruby 3.4. [Feature #18980]

• [ ] [easy, Java] Error message for NoMethodError have changed to not use the target object's #inspect for efficiency, and says "instance of ClassName" instead. [Feature #18285]

  ([1] * 100).nonexisting
  # undefined method `nonexisting' for an instance of Array (NoMethodError)

• [ ] [medium, Java] Now anonymous parameters forwarding is disallowed inside a block that uses anonymous parameters. [Feature #19370]

Stdlib compatibility issues

• [x] racc is promoted to bundled gems.
  • You need to add racc to your Gemfile if you use racc under bundler environment.
• [x] ext/readline is retired
  • We have reline that is pure Ruby implementation compatible with ext/readline API. We rely on reline in the future. If you need to use ext/readline, you can install ext/readline via rubygems.org with gem install readline-ext.
  • We no longer need to install libraries like libreadline or libedit.

C API updates

rb_postponed_job updates

• New APIs and deprecated APIs (see comments for details)
  • [ ] added: rb_postponed_job_preregister()
  • [ ] added: rb_postponed_job_trigger()
  • [ ] deprecated: rb_postponed_job_register() (and semantic change. see below)
  • [ ] deprecated: rb_postponed_job_register_one()
• [ ] The postponed job APIs have been changed to address some rare crashes. To solve the issue, we introduced new two APIs and deprecated current APIs. The semantics of these functions have also changed slightly; rb_postponed_job_register now behaves like the once variant in that multiple calls with the same func might be coalesced into a single execution of the func [Feature #20057]

Some updates for internal thread event hook APIs

• [ ] rb_internal_thread_event_data_t with a target Ruby thread (VALUE) and callback functions (rb_internal_thread_event_callback) receive it. https://github.com/ruby/ruby/pull/8885
• The following functions are introduced to manipulate Ruby thread local data from internal thread event hook APIs (they are introduced since Ruby 3.2). https://github.com/ruby/ruby/pull/8936
  • [ ] rb_internal_thread_specific_key_create()
  • [ ] rb_internal_thread_specific_get()
  • [ ] rb_internal_thread_specific_set()

• [ ] rb_profile_thread_frames() is introduced to get a frames from a specific thread. [Feature #10602]

• [ ] rb_data_define() is introduced to define Data. [Feature #19757]

• [ ] rb_ext_resolve_symbol() is introduced to search a function from extension libraries. [Feature #20005]

IO related updates:

• [ ] The details of rb_io_t will be hidden and deprecated attributes are added for each members. [Feature #19057]
• [x] rb_io_path(VALUE io) is introduced to get a path of io.
• [ ] (@andrykochin) rb_io_closed_p(VALUE io) to get opening or closing of io.
• [x] rb_io_mode(VALUE io) to get the mode of io.
• [ ] (@andrykochin) rb_io_open_descriptor() is introduced to make an IO object from a file descriptor.

[andrykonchin]

I am working on

[medium, Java] it calls without arguments in a block with no ordinary parameters are deprecated. it will be a reference to the first block parameter in Ruby 3.4. [[Feature #18980]]