io-wait 0.3.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cece766b90e4d81cd9f633898dbe10bfb4c50ad82be6f2caee138df7047ed3c
-  data.tar.gz: 0a7bb7fad1bb08afe84a64debfcec609e4f341173ded73745e5fd72e5bae8d17
+  metadata.gz: e840aeccf62ace0f185f0c01a338dc56d2d3a9dd460f1d6c8c9a1b8922a496e7
+  data.tar.gz: 479cc43d9ea99894a26fdf077b9aba104dd94eb415203ff37118d40661a9bbda
 SHA512:
-  metadata.gz: 498ed5a2e45eb6e5201fb59d5f4bc47e4b4ed7948a0813a0f9849a858fcc4faec0574958f638afdcb881ea8e691bd8f7715f722c5d9fd0ab7d6ede15f4484d76
-  data.tar.gz: b7ea14ccee049182560f902f722f6c263c5d8015685e5969a3c25bbea630064f6bb2d5549706272d2143e6590bd1cd814d8763fdb70f6c3b9a34d4b82d17666c
+  metadata.gz: cf81ae33a384f6c6de2d14743d5d85bf3796a782f08310cc558ba435e4ecbc9f044fb0db330e2f00112729017f7d6439b71bd482fdc3bf7841d2c94e97dd92a0
+  data.tar.gz: 202d42a5ce573fc50252c0bcdcb7a5c1c820d091c12ca520212e735528ddfd226a53818852de686bced1ffbed7dd6cab72ac920a2e58af4f80709b94e24f0e11

data/.document

@@ -1,6 +1,2 @@
 COPYING
-ChangeLog
 README.md
-_doc/
-ext/
-logs/ChangeLog-*

data/README.md

@@ -2,28 +2,4 @@
 
 This gem provides the feature for waiting until IO is readable or writable without blocking.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'io-wait'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install io-wait
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/io-wait.
+**Note:** This gem is empty and deprecated. All functionality was moved into core Ruby as of version 3.2.

data/lib/io/wait.rb

@@ -0,0 +1 @@
+warn "The io-wait gem is deprecated; all functionality ships with Ruby 3.2 and higher."

metadata

@@ -1,32 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: io-wait
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Nobu Nakada
 - Charles Oliver Nutter
 bindir: exe
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2026-09-15 00:00:00.000000000 Z
 dependencies: []
-description: Waits until IO is readable or writable without blocking.
+description: 'Deprecated: All functionality ships with Ruby 3.2 and higher.'
 email:
 - nobu@ruby-lang.org
 - headius@headius.com
 executables: []
-extensions:
-- ext/io/wait/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
 - ".rdoc_options"
 - COPYING
 - README.md
-- _doc/io.rb
-- ext/io/wait/depend
-- ext/io/wait/extconf.rb
-- ext/io/wait/wait.c
+- lib/io/wait.rb
 homepage: https://github.com/ruby/io-wait
 licenses:
 - Ruby
@@ -41,7 +37,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -50,5 +46,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Waits until IO is readable or writable without blocking.
+summary: 'Deprecated: All functionality ships with Ruby 3.2 and higher.'
 test_files: []

data/_doc/io.rb

@@ -1,3 +0,0 @@
-# See {IO}[https://docs.ruby-lang.org/en/master/IO.html]
-class IO
-end

data/ext/io/wait/depend

@@ -1,18 +0,0 @@
-# AUTOGENERATED DEPENDENCIES START
-wait.o: $(RUBY_EXTCONF_H)
-wait.o: $(arch_hdrdir)/ruby/config.h
-wait.o: $(hdrdir)/ruby.h
-wait.o: $(hdrdir)/ruby/assert.h
-wait.o: $(hdrdir)/ruby/backward.h
-wait.o: $(hdrdir)/ruby/defines.h
-wait.o: $(hdrdir)/ruby/encoding.h
-wait.o: $(hdrdir)/ruby/intern.h
-wait.o: $(hdrdir)/ruby/io.h
-wait.o: $(hdrdir)/ruby/missing.h
-wait.o: $(hdrdir)/ruby/onigmo.h
-wait.o: $(hdrdir)/ruby/oniguruma.h
-wait.o: $(hdrdir)/ruby/ruby.h
-wait.o: $(hdrdir)/ruby/st.h
-wait.o: $(hdrdir)/ruby/subst.h
-wait.o: wait.c
-# AUTOGENERATED DEPENDENCIES END

data/ext/io/wait/extconf.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: false
-require 'mkmf'
-
-target = "io/wait"
-have_func("rb_io_wait", "ruby/io.h")
-have_func("rb_io_descriptor", "ruby/io.h")
-unless macro_defined?("DOSISH", "#include <ruby.h>")
-  have_header(ioctl_h = "sys/ioctl.h") or ioctl_h = nil
-  fionread = %w[sys/ioctl.h sys/filio.h sys/socket.h].find do |h|
-    have_macro("FIONREAD", [h, ioctl_h].compact)
-  end
-  if fionread
-    $defs << "-DFIONREAD_HEADER=\"<#{fionread}>\""
-    create_makefile(target)
-  end
-else
-  if have_func("rb_w32_ioctlsocket", "ruby.h")
-    have_func("rb_w32_is_socket", "ruby.h")
-    create_makefile(target)
-  end
-end

data/ext/io/wait/wait.c

@@ -1,439 +0,0 @@
-/* -*- c-file-style: "ruby"; indent-tabs-mode: t -*- */
-/**********************************************************************
-
-  io/wait.c -
-
-  $Author$
-  created at: Tue Aug 28 09:08:06 JST 2001
-
-  All the files in this distribution are covered under the Ruby's
-  license (see the file COPYING).
-
-**********************************************************************/
-
-#include "ruby.h"
-#include "ruby/io.h"
-
-#include <sys/types.h>
-#if defined(HAVE_UNISTD_H) && (defined(__sun))
-#include <unistd.h>
-#endif
-#if defined(HAVE_SYS_IOCTL_H)
-#include <sys/ioctl.h>
-#endif
-#if defined(FIONREAD_HEADER)
-#include FIONREAD_HEADER
-#endif
-
-#ifdef HAVE_RB_W32_IOCTLSOCKET
-#define ioctl ioctlsocket
-#define ioctl_arg u_long
-#define ioctl_arg2num(i) ULONG2NUM(i)
-#else
-#define ioctl_arg int
-#define ioctl_arg2num(i) INT2NUM(i)
-#endif
-
-#ifdef HAVE_RB_W32_IS_SOCKET
-#define FIONREAD_POSSIBLE_P(fd) rb_w32_is_socket(fd)
-#else
-#define FIONREAD_POSSIBLE_P(fd) ((void)(fd),Qtrue)
-#endif
-
-#ifndef HAVE_RB_IO_WAIT
-static struct timeval *
-get_timeout(int argc, VALUE *argv, struct timeval *timerec)
-{
-    VALUE timeout = Qnil;
-    rb_check_arity(argc, 0, 1);
-    if (!argc || NIL_P(timeout = argv[0])) {
-        return NULL;
-    }
-    else {
-        *timerec = rb_time_interval(timeout);
-        return timerec;
-    }
-}
-
-static int
-wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv)
-{
-    int i = rb_wait_for_single_fd(fptr->fd, events, tv);
-    if (i < 0)
-        rb_sys_fail(0);
-    rb_io_check_closed(fptr);
-    return (i & events);
-}
-#endif
-
-/*
- * call-seq:
- *   io.nread -> int
- *
- * Returns number of bytes that can be read without blocking.
- * Returns zero if no information available.
- *
- * You must require 'io/wait' to use this method.
- */
-
-static VALUE
-io_nread(VALUE io)
-{
-    rb_io_t *fptr;
-    int len;
-    ioctl_arg n;
-
-    rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "IO#nread is deprecated; use wait_readable instead");
-    GetOpenFile(io, fptr);
-    rb_io_check_char_readable(fptr);
-    len = rb_io_read_pending(fptr);
-    if (len > 0) return INT2FIX(len);
-
-#ifdef HAVE_RB_IO_DESCRIPTOR
-    int fd = rb_io_descriptor(io);
-#else
-    int fd = fptr->fd;
-#endif
-
-    if (!FIONREAD_POSSIBLE_P(fd)) return INT2FIX(0);
-    if (ioctl(fd, FIONREAD, &n)) return INT2FIX(0);
-    if (n > 0) return ioctl_arg2num(n);
-    return INT2FIX(0);
-}
-
-#ifdef HAVE_RB_IO_WAIT
-static VALUE
-io_wait_event(VALUE io, int event, VALUE timeout, int return_io)
-{
-    VALUE result = rb_io_wait(io, RB_INT2NUM(event), timeout);
-
-    if (!RB_TEST(result)) {
-        return Qnil;
-    }
-
-    int mask = RB_NUM2INT(result);
-
-    if (mask & event) {
-        if (return_io)
-            return io;
-        else
-            return result;
-    }
-    else {
-        return Qfalse;
-    }
-}
-#endif
-
-/*
- * call-seq:
- *   io.ready? -> truthy or falsy
- *
- * Returns a truthy value if input available without blocking, or a
- * falsy value.
- *
- * You must require 'io/wait' to use this method.
- */
-
-static VALUE
-io_ready_p(VALUE io)
-{
-    rb_io_t *fptr;
-#ifndef HAVE_RB_IO_WAIT
-    struct timeval tv = {0, 0};
-#endif
-
-    rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "IO#ready? is deprecated; use wait_readable instead");
-    GetOpenFile(io, fptr);
-    rb_io_check_char_readable(fptr);
-    if (rb_io_read_pending(fptr)) return Qtrue;
-
-#ifndef HAVE_RB_IO_WAIT
-    return wait_for_single_fd(fptr, RB_WAITFD_IN, &tv) ? Qtrue : Qfalse;
-#else
-    return io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0), 1);
-#endif
-}
-
-/* Ruby 3.2+ can define these methods. This macro indicates that case. */
-#ifndef RUBY_IO_WAIT_METHODS
-
-/*
- * call-seq:
- *   io.wait_readable          -> truthy or falsy
- *   io.wait_readable(timeout) -> truthy or falsy
- *
- * Waits until IO is readable and returns a truthy value, or a falsy
- * value when times out.  Returns a truthy value immediately when
- * buffered data is available.
- *
- * You must require 'io/wait' to use this method.
- */
-
-static VALUE
-io_wait_readable(int argc, VALUE *argv, VALUE io)
-{
-    rb_io_t *fptr;
-#ifndef HAVE_RB_IO_WAIT
-    struct timeval timerec;
-    struct timeval *tv;
-#endif
-
-    GetOpenFile(io, fptr);
-    rb_io_check_char_readable(fptr);
-
-#ifndef HAVE_RB_IO_WAIT
-    tv = get_timeout(argc, argv, &timerec);
-#endif
-    if (rb_io_read_pending(fptr)) return Qtrue;
-
-#ifndef HAVE_RB_IO_WAIT
-    if (wait_for_single_fd(fptr, RB_WAITFD_IN, tv)) {
-        return io;
-    }
-    return Qnil;
-#else
-    rb_check_arity(argc, 0, 1);
-    VALUE timeout = (argc == 1 ? argv[0] : Qnil);
-
-    return io_wait_event(io, RUBY_IO_READABLE, timeout, 1);
-#endif
-}
-
-/*
- * call-seq:
- *   io.wait_writable          -> truthy or falsy
- *   io.wait_writable(timeout) -> truthy or falsy
- *
- * Waits until IO is writable and returns a truthy value or a falsy
- * value when times out.
- *
- * You must require 'io/wait' to use this method.
- */
-static VALUE
-io_wait_writable(int argc, VALUE *argv, VALUE io)
-{
-    rb_io_t *fptr;
-#ifndef HAVE_RB_IO_WAIT
-    struct timeval timerec;
-    struct timeval *tv;
-#endif
-
-    GetOpenFile(io, fptr);
-    rb_io_check_writable(fptr);
-
-#ifndef HAVE_RB_IO_WAIT
-    tv = get_timeout(argc, argv, &timerec);
-    if (wait_for_single_fd(fptr, RB_WAITFD_OUT, tv)) {
-        return io;
-    }
-    return Qnil;
-#else
-    rb_check_arity(argc, 0, 1);
-    VALUE timeout = (argc == 1 ? argv[0] : Qnil);
-
-    return io_wait_event(io, RUBY_IO_WRITABLE, timeout, 1);
-#endif
-}
-
-#ifdef HAVE_RB_IO_WAIT
-/*
- * call-seq:
- *   io.wait_priority          -> truthy or falsy
- *   io.wait_priority(timeout) -> truthy or falsy
- *
- * Waits until IO is priority and returns a truthy value or a falsy
- * value when times out. Priority data is sent and received using
- * the Socket::MSG_OOB flag and is typically limited to streams.
- *
- * You must require 'io/wait' to use this method.
- */
-static VALUE
-io_wait_priority(int argc, VALUE *argv, VALUE io)
-{
-    rb_io_t *fptr = NULL;
-
-    RB_IO_POINTER(io, fptr);
-    rb_io_check_char_readable(fptr);
-
-    if (rb_io_read_pending(fptr)) return Qtrue;
-
-    rb_check_arity(argc, 0, 1);
-    VALUE timeout = argc == 1 ? argv[0] : Qnil;
-
-    return io_wait_event(io, RUBY_IO_PRIORITY, timeout, 1);
-}
-#endif
-
-static int
-wait_mode_sym(VALUE mode)
-{
-    if (mode == ID2SYM(rb_intern("r"))) {
-        return RB_WAITFD_IN;
-    }
-    if (mode == ID2SYM(rb_intern("read"))) {
-        return RB_WAITFD_IN;
-    }
-    if (mode == ID2SYM(rb_intern("readable"))) {
-        return RB_WAITFD_IN;
-    }
-    if (mode == ID2SYM(rb_intern("w"))) {
-        return RB_WAITFD_OUT;
-    }
-    if (mode == ID2SYM(rb_intern("write"))) {
-        return RB_WAITFD_OUT;
-    }
-    if (mode == ID2SYM(rb_intern("writable"))) {
-        return RB_WAITFD_OUT;
-    }
-    if (mode == ID2SYM(rb_intern("rw"))) {
-        return RB_WAITFD_IN|RB_WAITFD_OUT;
-    }
-    if (mode == ID2SYM(rb_intern("read_write"))) {
-        return RB_WAITFD_IN|RB_WAITFD_OUT;
-    }
-    if (mode == ID2SYM(rb_intern("readable_writable"))) {
-        return RB_WAITFD_IN|RB_WAITFD_OUT;
-    }
-    rb_raise(rb_eArgError, "unsupported mode: %"PRIsVALUE, mode);
-    return 0;
-}
-
-#ifdef HAVE_RB_IO_WAIT
-static inline rb_io_event_t
-io_event_from_value(VALUE value)
-{
-    int events = RB_NUM2INT(value);
-
-    if (events <= 0) rb_raise(rb_eArgError, "Events must be positive integer!");
-
-    return events;
-}
-#endif
-
-/*
- * call-seq:
- *   io.wait(events, timeout) -> event mask, false or nil
- *   io.wait(*event_symbols[, timeout]) -> self, true, or false
- *
- * Waits until the IO becomes ready for the specified events and returns the
- * subset of events that become ready, or a falsy value when times out.
- *
- * The events can be a bit mask of +IO::READABLE+, +IO::WRITABLE+ or
- * +IO::PRIORITY+.
- *
- * Returns an event mask (truthy value) immediately when buffered data is
- * available.
- *
- * The second form: if one or more event symbols (+:read+, +:write+, or
- * +:read_write+) are passed, the event mask is the bit OR of the bitmask
- * corresponding to those symbols.  In this form, +timeout+ is optional, the
- * order of the arguments is arbitrary, and returns +io+ if any of the
- * events is ready.
- *
- * You must require 'io/wait' to use this method.
- */
-
-static VALUE
-io_wait(int argc, VALUE *argv, VALUE io)
-{
-#ifndef HAVE_RB_IO_WAIT
-    rb_io_t *fptr;
-    struct timeval timerec;
-    struct timeval *tv = NULL;
-    int event = 0;
-    int i;
-
-    GetOpenFile(io, fptr);
-    for (i = 0; i < argc; ++i) {
-        if (SYMBOL_P(argv[i])) {
-            event |= wait_mode_sym(argv[i]);
-        }
-        else {
-            *(tv = &timerec) = rb_time_interval(argv[i]);
-        }
-    }
-    /* rb_time_interval() and might_mode() might convert the argument */
-    rb_io_check_closed(fptr);
-    if (!event) event = RB_WAITFD_IN;
-    if ((event & RB_WAITFD_IN) && rb_io_read_pending(fptr))
-        return Qtrue;
-    if (wait_for_single_fd(fptr, event, tv))
-        return io;
-    return Qnil;
-#else
-    VALUE timeout = Qundef;
-    rb_io_event_t events = 0;
-    int i, return_io = 0;
-
-    if (argc != 2 || (RB_SYMBOL_P(argv[0]) || RB_SYMBOL_P(argv[1]))) {
-        /* We'd prefer to return the actual mask, but this form would return the io itself: */
-        return_io = 1;
-
-        /* Slow/messy path: */
-        for (i = 0; i < argc; i += 1) {
-            if (RB_SYMBOL_P(argv[i])) {
-                events |= wait_mode_sym(argv[i]);
-            }
-            else if (timeout == Qundef) {
-                rb_time_interval(timeout = argv[i]);
-            }
-            else {
-                rb_raise(rb_eArgError, "timeout given more than once");
-            }
-        }
-
-        if (timeout == Qundef) timeout = Qnil;
-
-        if (events == 0) {
-            events = RUBY_IO_READABLE;
-        }
-    }
-    else /* argc == 2 and neither are symbols */ {
-        /* This is the fast path: */
-        events = io_event_from_value(argv[0]);
-        timeout = argv[1];
-    }
-
-    if (events & RUBY_IO_READABLE) {
-        rb_io_t *fptr = NULL;
-        RB_IO_POINTER(io, fptr);
-
-        if (rb_io_read_pending(fptr)) {
-            /* This was the original behaviour: */
-            if (return_io) return Qtrue;
-            /* New behaviour always returns an event mask: */
-            else return RB_INT2NUM(RUBY_IO_READABLE);
-        }
-    }
-
-    return io_wait_event(io, events, timeout, return_io);
-#endif
-}
-
-#endif /* RUBY_IO_WAIT_METHODS */
-
-/*
- * IO wait methods
- */
-
-void
-Init_wait(void)
-{
-#ifdef HAVE_RB_EXT_RACTOR_SAFE
-    RB_EXT_RACTOR_SAFE(true);
-#endif
-
-    rb_define_method(rb_cIO, "nread", io_nread, 0);
-    rb_define_method(rb_cIO, "ready?", io_ready_p, 0);
-
-#ifndef RUBY_IO_WAIT_METHODS
-    rb_define_method(rb_cIO, "wait", io_wait, -1);
-
-    rb_define_method(rb_cIO, "wait_readable", io_wait_readable, -1);
-    rb_define_method(rb_cIO, "wait_writable", io_wait_writable, -1);
-#ifdef HAVE_RB_IO_WAIT
-    rb_define_method(rb_cIO, "wait_priority", io_wait_priority, -1);
-#endif
-#endif
-}