io-wait 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ea39ff5c3815f098f8c15eb5b493e27408afda30a88d11cd00564ab85438639
-  data.tar.gz: 1a9ba20f028fe3259153bac2aa27b70870ef8e103d00c20cb6f7a267da94a6b5
+  metadata.gz: ac9aac81de884ac5961c9415e4347be5f26ae3ef6e52854834c76a105e4f7388
+  data.tar.gz: 118b4011fcaa3f94a48ff2d3be11db1b2049375f709426b177ab5a9bc4799d7f
 SHA512:
-  metadata.gz: bebdf7aba83d894c28fa9763b0048047c437c67962a939e3d29a6b4cbefe1ac690afd8ef8ed372d013204b1298f7fab0f01cd45c35ced0bb4d62e4234818f0ae
-  data.tar.gz: 0f9635692758b787c4dc873e449e0a3e893dee5427f122fbda17f9458d4f33916bd32c333bf76023a73285177ac70b4b576025504130423089467fdb703266b5
+  metadata.gz: 58cf2bc5cdc614eb7827a460decf662def72676011fbf9d4a853dfd71b66311dd10d81fcd100ac0a2d676d61009e6e3a4c80ac0f7c7d0d88f303a8a16f1510de
+  data.tar.gz: 700343ef7233d37f9e27d22bfab091af07e681e996619c8953553152b7b7598bb1843d2d969b8d268cac752ead4641b13f32380d2b5c43e8d4808e4176b64c89

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in etc.gemspec
+# Specify your gem's dependencies in io-wait.gemspec
 gemspec

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+name = "io/wait"
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test/lib"
   t.ruby_opts << "-rhelper"
@@ -8,5 +10,7 @@ Rake::TestTask.new(:test) do |t|
 end
 
 require 'rake/extensiontask'
-Rake::ExtensionTask.new("io/wait")
+Rake::ExtensionTask.new(name)
+task :test => :compile
+
 task :default => :test

data/ext/io/wait/wait.c

@@ -1,3 +1,4 @@
+/* -*- c-file-style: "ruby"; indent-tabs-mode: t -*- */
 /**********************************************************************
 
   io/wait.c -
@@ -39,35 +40,6 @@
 #define FIONREAD_POSSIBLE_P(fd) ((void)(fd),Qtrue)
 #endif
 
-static VALUE io_ready_p _((VALUE io));
-static VALUE io_wait_readable _((int argc, VALUE *argv, VALUE io));
-static VALUE io_wait_writable _((int argc, VALUE *argv, VALUE io));
-void Init_wait _((void));
-
-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);
-}
-
 /*
  * call-seq:
  *   io.nread -> int
@@ -79,13 +51,12 @@ wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv)
 static VALUE
 io_nread(VALUE io)
 {
-    rb_io_t *fptr;
-    int len;
+    rb_io_t *fptr = NULL;
     ioctl_arg n;
 
     GetOpenFile(io, fptr);
     rb_io_check_readable(fptr);
-    len = rb_io_read_pending(fptr);
+    int len = rb_io_read_pending(fptr);
     if (len > 0) return INT2FIX(len);
     if (!FIONREAD_POSSIBLE_P(fptr->fd)) return INT2FIX(0);
     if (ioctl(fptr->fd, FIONREAD, &n)) return INT2FIX(0);
@@ -93,76 +64,114 @@ io_nread(VALUE io)
     return INT2FIX(0);
 }
 
+static VALUE
+io_wait_event(VALUE io, int event, VALUE timeout)
+{
+    VALUE result = rb_io_wait(io, RB_INT2NUM(event), timeout);
+
+    if (!RB_TEST(result)) {
+	return Qnil;
+    }
+
+    int mask = RB_NUM2INT(result);
+
+    if (mask & event) {
+	return io;
+    }
+    else {
+	return Qfalse;
+    }
+}
+
 /*
  * call-seq:
  *   io.ready? -> true or false
  *
- * Returns true if input available without blocking, or false.
+ * Returns +true+ if input available without blocking, or +false+.
  */
 
 static VALUE
 io_ready_p(VALUE io)
 {
     rb_io_t *fptr;
-    struct timeval tv = {0, 0};
 
     GetOpenFile(io, fptr);
     rb_io_check_readable(fptr);
     if (rb_io_read_pending(fptr)) return Qtrue;
-    if (wait_for_single_fd(fptr, RB_WAITFD_IN, &tv))
-	return Qtrue;
-    return Qfalse;
+
+    return io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0));
 }
 
 /*
  * call-seq:
- *   io.wait_readable          -> IO, true or nil
- *   io.wait_readable(timeout) -> IO, true or nil
+ *   io.wait_readable          -> true or false
+ *   io.wait_readable(timeout) -> true or false
  *
- * Waits until IO is readable without blocking and returns +self+, or
- * +nil+ when times out.
+ * Waits until IO is readable and returns +true+, or
+ * +false+ when times out.
  * Returns +true+ immediately when buffered data is available.
  */
 
 static VALUE
 io_wait_readable(int argc, VALUE *argv, VALUE io)
 {
-    rb_io_t *fptr;
-    struct timeval timerec;
-    struct timeval *tv;
+    rb_io_t *fptr = NULL;
 
-    GetOpenFile(io, fptr);
+    RB_IO_POINTER(io, fptr);
     rb_io_check_readable(fptr);
-    tv = get_timeout(argc, argv, &timerec);
+
     if (rb_io_read_pending(fptr)) return Qtrue;
-    if (wait_for_single_fd(fptr, RB_WAITFD_IN, tv)) {
-	return io;
-    }
-    return Qnil;
+
+    rb_check_arity(argc, 0, 1);
+    VALUE timeout = (argc == 1 ? argv[0] : Qnil);
+
+    return io_wait_event(io, RUBY_IO_READABLE, timeout);
 }
 
 /*
  * call-seq:
- *   io.wait_writable          -> IO
- *   io.wait_writable(timeout) -> IO or nil
+ *   io.wait_writable          -> true or false
+ *   io.wait_writable(timeout) -> true or false
  *
- * Waits until IO is writable without blocking and returns +self+ or
- * +nil+ when times out.
+ * Waits until IO is writable and returns +true+ or
+ * +false+ when times out.
  */
 static VALUE
 io_wait_writable(int argc, VALUE *argv, VALUE io)
 {
-    rb_io_t *fptr;
-    struct timeval timerec;
-    struct timeval *tv;
+    rb_io_t *fptr = NULL;
 
-    GetOpenFile(io, fptr);
+    RB_IO_POINTER(io, fptr);
     rb_io_check_writable(fptr);
-    tv = get_timeout(argc, argv, &timerec);
-    if (wait_for_single_fd(fptr, RB_WAITFD_OUT, tv)) {
-	return io;
-    }
-    return Qnil;
+
+    rb_check_arity(argc, 0, 1);
+    VALUE timeout = (argc == 1 ? argv[0] : Qnil);
+
+    return io_wait_event(io, RUBY_IO_WRITABLE, timeout);
+}
+
+/*
+ * call-seq:
+ *   io.wait_priority          -> true or false
+ *   io.wait_priority(timeout) -> true or false
+ *
+ * Waits until IO is priority and returns +true+ or
+ * +false+ when times out.
+ */
+static VALUE
+io_wait_priority(int argc, VALUE *argv, VALUE io)
+{
+    rb_io_t *fptr = NULL;
+
+    RB_IO_POINTER(io, fptr);
+    rb_io_check_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);
 }
 
 static int
@@ -201,41 +210,60 @@ wait_mode_sym(VALUE mode)
 
 /*
  * call-seq:
- *   io.wait(timeout = nil, mode = :read) -> IO, true or nil
+ *   io.wait(events, timeout) -> event mask or false.
+ *   io.wait(timeout = nil, mode = :read) -> event mask or false.
+ *
+ * Waits until the IO becomes ready for the specified events and returns the
+ * subset of events that become ready, or +false+ when times out.
+ *
+ * The events can be a bit mask of +IO::READABLE+, +IO::WRITABLE+ or
+ * +IO::PRIORITY+.
  *
- * Waits until IO is readable or writable without blocking and returns
- * +self+, or +nil+ when times out.
  * Returns +true+ immediately when buffered data is available.
+ *
  * Optional parameter +mode+ is one of +:read+, +:write+, or
  * +:read_write+.
  */
 
 static VALUE
-io_wait_readwrite(int argc, VALUE *argv, VALUE io)
+io_wait(int argc, VALUE *argv, VALUE io)
 {
-    rb_io_t *fptr;
-    struct timeval timerec;
-    struct timeval *tv = NULL;
-    int event = 0;
-    int i;
+    VALUE timeout = Qundef;
+    rb_io_event_t events = 0;
 
-    GetOpenFile(io, fptr);
-    for (i = 0; i < argc; ++i) {
-	if (SYMBOL_P(argv[i])) {
-	    event |= wait_mode_sym(argv[i]);
+    if (argc != 2 || (RB_SYMBOL_P(argv[0]) || RB_SYMBOL_P(argv[1]))) {
+	for (int 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");
+	    }
 	}
-	else {
-	    *(tv = &timerec) = rb_time_interval(argv[i]);
+	if (timeout == Qundef) timeout = Qnil;
+    }
+    else /* argc == 2 */ {
+	events = RB_NUM2UINT(argv[0]);
+	timeout = argv[1];
+    }
+
+    if (events == 0) {
+	events = RUBY_IO_READABLE;
+    }
+
+    if (events & RUBY_IO_READABLE) {
+	rb_io_t *fptr = NULL;
+	RB_IO_POINTER(io, fptr);
+
+	if (rb_io_read_pending(fptr)) {
+	    return Qtrue;
 	}
     }
-    /* 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;
+
+    return io_wait_event(io, events, timeout);
 }
 
 /*
@@ -245,9 +273,16 @@ io_wait_readwrite(int argc, VALUE *argv, VALUE io)
 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);
-    rb_define_method(rb_cIO, "wait", io_wait_readwrite, -1);
+
+    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);
+    rb_define_method(rb_cIO, "wait_priority", io_wait_priority, -1);
 }

data/io-wait.gemspec

@@ -1,6 +1,8 @@
+_VERSION = "0.2.0"
+
 Gem::Specification.new do |spec|
   spec.name          = "io-wait"
-  spec.version       = "0.1.0"
+  spec.version       = _VERSION
   spec.authors       = ["Nobu Nakada"]
   spec.email         = ["nobu@ruby-lang.org"]
 
@@ -8,15 +10,18 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Waits until IO is readable or writable without blocking.}
   spec.homepage      = "https://github.com/ruby/io-wait"
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/|\A\.(?:git|travis)})
+    end
   end
+  spec.extensions    = %w[ext/io/wait/extconf.rb]
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = []
   spec.require_paths = ["lib"]
 end

data/rakelib/changelogs.rake

@@ -0,0 +1,34 @@
+task "build" => "changelogs"
+
+changelog = proc do |output, ver = nil, prev = nil|
+  ver &&= Gem::Version.new(ver)
+  range = [[prev], [ver, "HEAD"]].map {|ver, branch| ver ? "v#{ver.to_s}" : branch}.compact.join("..")
+  IO.popen(%W[git log --format=fuller --topo-order --no-merges #{range}]) do |log|
+    line = log.gets
+    FileUtils.mkpath(File.dirname(output))
+    File.open(output, "wb") do |f|
+      f.print "-*- coding: utf-8 -*-\n\n", line
+      log.each_line do |line|
+        line.sub!(/^(?!:)(?:Author|Commit)?(?:Date)?: /, '  \&')
+        line.sub!(/ +$/, '')
+        f.print(line)
+      end
+    end
+  end
+end
+
+tags = IO.popen(%w[git tag -l v[0-9]*]).grep(/v(.*)/) {$1}
+tags.sort_by! {|tag| tag.scan(/\d+/).map(&:to_i)}
+tags.inject(nil) do |prev, tag|
+  task("logs/ChangeLog-#{tag}") {|t| changelog[t.name, tag, prev]}
+  tag
+end
+
+desc "Make ChangeLog"
+task "ChangeLog", [:ver, :prev] do |t, ver: nil, prev: tags.last|
+  changelog[t.name, ver, prev]
+end
+
+changelogs = ["ChangeLog", *tags.map {|tag| "logs/ChangeLog-#{tag}"}]
+task "changelogs" => changelogs
+CLOBBER.concat(changelogs) << "logs"

data/rakelib/epoch.rake

@@ -0,0 +1,5 @@
+task "build" => "date_epoch"
+
+task "date_epoch" do
+  ENV["SOURCE_DATE_EPOCH"] = IO.popen(%W[git -C #{__dir__} log -1 --format=%ct], &:read).chomp
+end

data/rakelib/version.rake

@@ -0,0 +1,44 @@
+class << (helper = Bundler::GemHelper.instance)
+  def update_gemspec
+    path = gemspec.loaded_from
+    File.open(path, "r+b") do |f|
+      d = f.read
+      if d.sub!(/^(_VERSION\s*=\s*)".*"/) {$1 + gemspec.version.to_s.dump}
+        f.rewind
+        f.truncate(0)
+        f.print(d)
+      end
+    end
+  end
+
+  def commit_bump
+    sh(%W[git -C #{__dir__} commit -m bump\ up\ to\ #{gemspec.version}
+          #{gemspec.loaded_from}])
+  end
+
+  def version=(v)
+    gemspec.version = v
+    update_gemspec
+    commit_bump
+  end
+end
+
+major, minor, teeny = helper.gemspec.version.segments
+
+task "bump:teeny" do
+  helper.version = Gem::Version.new("#{major}.#{minor}.#{teeny+1}")
+end
+
+task "bump:minor" do
+  helper.version = Gem::Version.new("#{major}.#{minor+1}.0")
+end
+
+task "bump:major" do
+  helper.version = Gem::Version.new("#{major+1}.0.0")
+end
+
+task "bump" => "bump:teeny"
+
+task "tag" do
+  helper.__send__(:tag_version)
+end

metadata

@@ -1,34 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: io-wait
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nobu Nakada
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies: []
 description: Waits until IO is readable or writable without blocking.
 email:
 - nobu@ruby-lang.org
 executables: []
-extensions: []
+extensions:
+- ext/io/wait/extconf.rb
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - COPYING
 - Gemfile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - ext/io/wait/depend
 - ext/io/wait/extconf.rb
 - ext/io/wait/wait.c
 - io-wait.gemspec
+- rakelib/changelogs.rake
+- rakelib/epoch.rake
+- rakelib/version.rake
 homepage: https://github.com/ruby/io-wait
 licenses:
 - Ruby
@@ -44,14 +44,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: Waits until IO is readable or writable without blocking.

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.dll
-*.so

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.8.0
-before_install: gem install bundler -v 2.1.4

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "io/wait"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here