io-wait 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac9aac81de884ac5961c9415e4347be5f26ae3ef6e52854834c76a105e4f7388
-  data.tar.gz: 118b4011fcaa3f94a48ff2d3be11db1b2049375f709426b177ab5a9bc4799d7f
+  metadata.gz: 43e7f91045efd73e51af1a6e055afe646fc95d1b7c1a154453d915e6a213d223
+  data.tar.gz: 4d542bfb7bde6053c4069f451d41f39e05b77d0ebab5514532f601466ca57bba
 SHA512:
-  metadata.gz: 58cf2bc5cdc614eb7827a460decf662def72676011fbf9d4a853dfd71b66311dd10d81fcd100ac0a2d676d61009e6e3a4c80ac0f7c7d0d88f303a8a16f1510de
-  data.tar.gz: 700343ef7233d37f9e27d22bfab091af07e681e996619c8953553152b7b7598bb1843d2d969b8d268cac752ead4641b13f32380d2b5c43e8d4808e4176b64c89
+  metadata.gz: f78dc92e4500c196b69d87fb47f13f426f4a2d9b8532e69027d3c96a8dd93514d08c77adc421b8d3cac2e0aaf2f80d92327c98d95969a9816111b41c373fe10a
+  data.tar.gz: 4b2b4af88c93ddc7d12d1060f6f638aab6fc75178a32fe9810478a5b95e27575cbe1054c1e46964b7ca1eec1269f47b64bf823a990472363cb97c75236b4a438

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in io-wait.gemspec
 gemspec
+
+group :development do
+  gem "rake"
+  gem "rake-compiler"
+  gem "test-unit"
+  gem 'ruby-maven', :platforms => :jruby
+end

data/ext/io/wait/depend

@@ -2,7 +2,7 @@
 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/assert.h # not in 2.6
 wait.o: $(hdrdir)/ruby/backward.h
 wait.o: $(hdrdir)/ruby/defines.h
 wait.o: $(hdrdir)/ruby/encoding.h

data/ext/io/wait/extconf.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: false
 require 'mkmf'
-target = "io/wait"
 
-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
+if RUBY_VERSION < "2.6"
+  File.write("Makefile", dummy_makefile($srcdir).join(""))
 else
-  if have_func("rb_w32_ioctlsocket", "ruby.h")
-    have_func("rb_w32_is_socket", "ruby.h")
-    create_makefile(target)
+  target = "io/wait"
+  have_func("rb_io_wait")
+  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
 end

data/ext/io/wait/wait.c

@@ -40,23 +40,57 @@
 #define FIONREAD_POSSIBLE_P(fd) ((void)(fd),Qtrue)
 #endif
 
+#ifndef HAVE_RB_IO_WAIT
+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);
+}
+#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 = NULL;
+    rb_io_t *fptr;
+    int len;
     ioctl_arg n;
 
     GetOpenFile(io, fptr);
     rb_io_check_readable(fptr);
-    int len = rb_io_read_pending(fptr);
+    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);
@@ -64,6 +98,7 @@ io_nread(VALUE io)
     return INT2FIX(0);
 }
 
+#ifdef HAVE_RB_IO_WAIT
 static VALUE
 io_wait_event(VALUE io, int event, VALUE timeout)
 {
@@ -82,81 +117,128 @@ io_wait_event(VALUE io, int event, VALUE timeout)
 	return Qfalse;
     }
 }
+#endif
 
 /*
  * call-seq:
- *   io.ready? -> true or false
+ *   io.ready? -> truthy or falsy
  *
- * Returns +true+ if input available without blocking, or +false+.
+ * 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
 
     GetOpenFile(io, fptr);
     rb_io_check_readable(fptr);
     if (rb_io_read_pending(fptr)) return Qtrue;
 
-    return io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0));
+#ifndef HAVE_RB_IO_WAIT
+    if (wait_for_single_fd(fptr, RB_WAITFD_IN, &tv))
+	return Qtrue;
+#else
+    if (RTEST(io_wait_event(io, RUBY_IO_READABLE, RB_INT2NUM(0))))
+	return Qtrue;
+#endif
+    return Qfalse;
 }
 
 /*
  * call-seq:
- *   io.wait_readable          -> true or false
- *   io.wait_readable(timeout) -> true or false
+ *   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.
  *
- * Waits until IO is readable and returns +true+, or
- * +false+ when times out.
- * Returns +true+ 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 = NULL;
+    rb_io_t *fptr;
+#ifndef HAVE_RB_IO_WAIT
+    struct timeval timerec;
+    struct timeval *tv;
+#endif
 
-    RB_IO_POINTER(io, fptr);
+    GetOpenFile(io, fptr);
     rb_io_check_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);
+#endif
 }
 
 /*
  * call-seq:
- *   io.wait_writable          -> true or false
- *   io.wait_writable(timeout) -> true or false
+ *   io.wait_writable          -> truthy or falsy
+ *   io.wait_writable(timeout) -> truthy or falsy
  *
- * Waits until IO is writable and returns +true+ or
- * +false+ when times out.
+ * 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 = NULL;
+    rb_io_t *fptr;
+#ifndef HAVE_RB_IO_WAIT
+    struct timeval timerec;
+    struct timeval *tv;
+#endif
 
-    RB_IO_POINTER(io, fptr);
+    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);
+#endif
 }
 
+#ifdef HAVE_RB_IO_WAIT
 /*
  * call-seq:
- *   io.wait_priority          -> true or false
- *   io.wait_priority(timeout) -> true or false
+ *   io.wait_priority          -> truthy or falsy
+ *   io.wait_priority(timeout) -> truthy or falsy
  *
- * Waits until IO is priority and returns +true+ or
- * +false+ when times out.
+ * Waits until IO is priority 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_priority(int argc, VALUE *argv, VALUE io)
@@ -173,6 +255,7 @@ io_wait_priority(int argc, VALUE *argv, VALUE io)
 
     return io_wait_event(io, RUBY_IO_PRIORITY, timeout);
 }
+#endif
 
 static int
 wait_mode_sym(VALUE mode)
@@ -210,24 +293,51 @@ wait_mode_sym(VALUE mode)
 
 /*
  * call-seq:
- *   io.wait(events, timeout) -> event mask or false.
- *   io.wait(timeout = nil, mode = :read) -> event mask or false.
+ *   io.wait(events, timeout) -> truthy or falsy
+ *   io.wait(timeout = nil, mode = :read) -> truthy or falsy.
  *
  * Waits until the IO becomes ready for the specified events and returns the
- * subset of events that become ready, or +false+ when times out.
+ * 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 +true+ immediately when buffered data is available.
+ * Returns a truthy value immediately when buffered data is available.
  *
  * Optional parameter +mode+ is one of +:read+, +:write+, or
  * +:read_write+.
+ *
+ * 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;
 
@@ -264,6 +374,7 @@ io_wait(int argc, VALUE *argv, VALUE io)
     }
 
     return io_wait_event(io, events, timeout);
+#endif
 }
 
 /*
@@ -284,5 +395,7 @@ Init_wait(void)
 
     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
 }

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: io-wait
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Nobu Nakada
+- Charles Oliver Nutter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies: []
 description: Waits until IO is readable or writable without blocking.
 email:
 - nobu@ruby-lang.org
+- headius@headius.com
 executables: []
 extensions:
 - ext/io/wait/extconf.rb
@@ -21,14 +23,9 @@ files:
 - COPYING
 - Gemfile
 - README.md
-- Rakefile
 - 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 +41,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Waits until IO is readable or writable without blocking.

data/Rakefile

@@ -1,16 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-name = "io/wait"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test/lib"
-  t.ruby_opts << "-rhelper"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-require 'rake/extensiontask'
-Rake::ExtensionTask.new(name)
-task :test => :compile
-
-task :default => :test

data/io-wait.gemspec

@@ -1,27 +0,0 @@
-_VERSION = "0.2.0"
-
-Gem::Specification.new do |spec|
-  spec.name          = "io-wait"
-  spec.version       = _VERSION
-  spec.authors       = ["Nobu Nakada"]
-  spec.email         = ["nobu@ruby-lang.org"]
-
-  spec.summary       = %q{Waits until IO is readable or writable without blocking.}
-  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(">= 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 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.require_paths = ["lib"]
-end

data/rakelib/changelogs.rake

@@ -1,34 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,44 +0,0 @@
-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