io-nonblock 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f197b776a167ab8e464d769208e51374e123069c567469f5ace8329bcdaa37
-  data.tar.gz: 482709a0e5dd558e54a6bcd1329df17a91d36cb6910585446b1685a5389d5af1
+  metadata.gz: 72722b1ffc6a232b51665e937ecabe164a15e2dbccdb35628fe158db78e56713
+  data.tar.gz: 491aa2cbbb825667d190e5dca3f3ef44abb7fcc65d2a5080e33f5fa4936142f0
 SHA512:
-  metadata.gz: 5e55dadc9959a30f527985b7afdb0297dfbdc9b0680a49037099ce0205301992cfbcccd84aa52f18704529d31afb30bc1b033f2284902714fea5e38e5344f60f
-  data.tar.gz: '00328f04184febef11667804acc88257c28383fbfb65a54649b16fbe1937172af000798ca201aaf2cdd44c572b37dff48b0cc14cdc436b162efc8e437b3e89cd'
+  metadata.gz: 9c1e8c2abd77710e460dc12c39a89f2bf3e2466208bc422e97ec1891629d71d569c95c8b80beadd0ef5f5673c53f4101f016930038770266b2f62732972f7b65
+  data.tar.gz: 3045f739c5bdcbef2c1335bfd0024842e5be44d0af0a3a90fb49c3ca9151fa02e74520cc854b3207e328b8c1a7f19fde5b580ad121c511590860e484de5b335d

data/ext/io/nonblock/extconf.rb

@@ -2,6 +2,13 @@
 require 'mkmf'
 target = "io/nonblock"
 
+unless RUBY_ENGINE == 'ruby'
+  File.write("Makefile", dummy_makefile($srcdir).join(""))
+  return
+end
+
+have_func("rb_io_descriptor")
+
 hdr = %w"fcntl.h"
 if have_macro("O_NONBLOCK", hdr) and
     (have_macro("F_GETFL", hdr) or have_macro("F_SETFL", hdr))

data/ext/io/nonblock/nonblock.c

@@ -17,16 +17,27 @@
 #endif
 #include <fcntl.h>
 
+#ifndef HAVE_RB_IO_DESCRIPTOR
+static int
+io_descriptor_fallback(VALUE io)
+{
+    rb_io_t *fptr;
+    GetOpenFile(io, fptr);
+    return fptr->fd;
+}
+#define rb_io_descriptor io_descriptor_fallback
+#endif
+
 #ifdef F_GETFL
 static int
-io_nonblock_mode(int fd)
+get_fcntl_flags(int fd)
 {
     int f = fcntl(fd, F_GETFL);
     if (f == -1) rb_sys_fail(0);
     return f;
 }
 #else
-#define io_nonblock_mode(fd) ((void)(fd), 0)
+#define get_fcntl_flags(fd) ((void)(fd), 0)
 #endif
 
 #ifdef F_GETFL
@@ -39,10 +50,8 @@ io_nonblock_mode(int fd)
 static VALUE
 rb_io_nonblock_p(VALUE io)
 {
-    rb_io_t *fptr;
-    GetOpenFile(io, fptr);
-    if (io_nonblock_mode(fptr->fd) & O_NONBLOCK)
-	return Qtrue;
+    if (get_fcntl_flags(rb_io_descriptor(io)) & O_NONBLOCK)
+        return Qtrue;
     return Qfalse;
 }
 #else
@@ -50,6 +59,15 @@ rb_io_nonblock_p(VALUE io)
 #endif
 
 #ifdef F_SETFL
+static void
+set_fcntl_flags(int fd, int f)
+{
+    if (fcntl(fd, F_SETFL, f) == -1)
+	rb_sys_fail(0);
+}
+
+#ifndef RUBY_IO_NONBLOCK_METHODS
+
 static int
 io_nonblock_set(int fd, int f, int nb)
 {
@@ -63,8 +81,7 @@ io_nonblock_set(int fd, int f, int nb)
 	    return 0;
 	f &= ~O_NONBLOCK;
     }
-    if (fcntl(fd, F_SETFL, f) == -1)
-	rb_sys_fail(0);
+    set_fcntl_flags(fd, f);
     return 1;
 }
 
@@ -74,32 +91,77 @@ io_nonblock_set(int fd, int f, int nb)
  *
  * Enables non-blocking mode on a stream when set to
  * +true+, and blocking mode when set to +false+.
+ *
+ * This method set or clear O_NONBLOCK flag for the file descriptor
+ * in <em>ios</em>.
+ *
+ * The behavior of most IO methods is not affected by this flag
+ * because they retry system calls to complete their task
+ * after EAGAIN and partial read/write.
+ * (An exception is IO#syswrite which doesn't retry.)
+ *
+ * This method can be used to clear non-blocking mode of standard I/O.
+ * Since nonblocking methods (read_nonblock, etc.) set non-blocking mode but
+ * they doesn't clear it, this method is usable as follows.
+ *
+ *   END { STDOUT.nonblock = false }
+ *   STDOUT.write_nonblock("foo")
+ *
+ * Since the flag is shared across processes and
+ * many non-Ruby commands doesn't expect standard I/O with non-blocking mode,
+ * it would be safe to clear the flag before Ruby program exits.
+ *
+ * For example following Ruby program leaves STDIN/STDOUT/STDER non-blocking mode.
+ * (STDIN, STDOUT and STDERR are connected to a terminal.
+ * So making one of them nonblocking-mode effects other two.)
+ * Thus cat command try to read from standard input and
+ * it causes "Resource temporarily unavailable" error (EAGAIN).
+ *
+ *   % ruby -e '
+ *   STDOUT.write_nonblock("foo\n")'; cat
+ *   foo
+ *   cat: -: Resource temporarily unavailable
+ *
+ * Clearing the flag makes the behavior of cat command normal.
+ * (cat command waits input from standard input.)
+ *
+ *   % ruby -rio/nonblock -e '
+ *   END { STDOUT.nonblock = false }
+ *   STDOUT.write_nonblock("foo")
+ *   '; cat
+ *   foo
+ *
  */
 static VALUE
-rb_io_nonblock_set(VALUE io, VALUE nb)
+rb_io_nonblock_set(VALUE self, VALUE value)
 {
-    rb_io_t *fptr;
-    GetOpenFile(io, fptr);
-    if (RTEST(nb))
-	rb_io_set_nonblock(fptr);
-    else
-	io_nonblock_set(fptr->fd, io_nonblock_mode(fptr->fd), RTEST(nb));
-    return io;
+    if (RTEST(value)) {
+        rb_io_t *fptr;
+        GetOpenFile(self, fptr);
+        rb_io_set_nonblock(fptr);
+    }
+    else {
+        int descriptor = rb_io_descriptor(self);
+        io_nonblock_set(descriptor, get_fcntl_flags(descriptor), RTEST(value));
+    }
+
+    return self;
 }
 
+#endif /* RUBY_IO_NONBLOCK_METHODS */
+
 static VALUE
 io_nonblock_restore(VALUE arg)
 {
     int *restore = (int *)arg;
-    if (fcntl(restore[0], F_SETFL, restore[1]) == -1)
-	rb_sys_fail(0);
+    set_fcntl_flags(restore[0], restore[1]);
     return Qnil;
 }
 
 /*
  * call-seq:
- *   io.nonblock {|io| } -> io
- *   io.nonblock(boolean) {|io| } -> io
+ *   io.nonblock {|io| } -> object
+ *   io.nonblock(boolean) {|io| } -> object
  *
  * Yields +self+ in non-blocking mode.
  *
@@ -107,24 +169,25 @@ io_nonblock_restore(VALUE arg)
  * The original mode is restored after the block is executed.
  */
 static VALUE
-rb_io_nonblock_block(int argc, VALUE *argv, VALUE io)
+rb_io_nonblock_block(int argc, VALUE *argv, VALUE self)
 {
     int nb = 1;
-    rb_io_t *fptr;
-    int f, restore[2];
 
-    GetOpenFile(io, fptr);
+    int descriptor = rb_io_descriptor(self);
+
     if (argc > 0) {
-	VALUE v;
-	rb_scan_args(argc, argv, "01", &v);
-	nb = RTEST(v);
+        VALUE v;
+        rb_scan_args(argc, argv, "01", &v);
+        nb = RTEST(v);
     }
-    f = io_nonblock_mode(fptr->fd);
-    restore[0] = fptr->fd;
-    restore[1] = f;
-    if (!io_nonblock_set(fptr->fd, f, nb))
-	return rb_yield(io);
-    return rb_ensure(rb_yield, io, io_nonblock_restore, (VALUE)restore);
+
+    int current_flags = get_fcntl_flags(descriptor);
+    int restore[2] = {descriptor, current_flags};
+
+    if (!io_nonblock_set(descriptor, current_flags, nb))
+        return rb_yield(self);
+
+    return rb_ensure(rb_yield, self, io_nonblock_restore, (VALUE)restore);
 }
 #else
 #define rb_io_nonblock_set rb_f_notimplement
@@ -134,7 +197,10 @@ rb_io_nonblock_block(int argc, VALUE *argv, VALUE io)
 void
 Init_nonblock(void)
 {
+#ifndef RUBY_IO_NONBLOCK_METHODS
     rb_define_method(rb_cIO, "nonblock?", rb_io_nonblock_p, 0);
     rb_define_method(rb_cIO, "nonblock=", rb_io_nonblock_set, 1);
+#endif
+
     rb_define_method(rb_cIO, "nonblock", rb_io_nonblock_block, -1);
 }

metadata

@@ -1,34 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: io-nonblock
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nobu Nakada
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies: []
 description: Enables non-blocking mode with IO class
 email:
 - nobu@ruby-lang.org
 executables: []
-extensions: []
+extensions:
+- ext/io/nonblock/extconf.rb
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - COPYING
-- Gemfile
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - ext/io/nonblock/depend
 - ext/io/nonblock/extconf.rb
 - ext/io/nonblock/nonblock.c
-- io-nonblock.gemspec
 homepage: https://github.com/ruby/io-nonblock
 licenses:
 - Ruby
@@ -51,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Enables non-blocking mode with IO class

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/Gemfile

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

data/Rakefile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "io/nonblock"
-
-# 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

data/io-nonblock.gemspec

@@ -1,22 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name          = "io-nonblock"
-  spec.version       = "0.1.0"
-  spec.authors       = ["Nobu Nakada"]
-  spec.email         = ["nobu@ruby-lang.org"]
-
-  spec.summary       = %q{Enables non-blocking mode with IO class}
-  spec.description   = %q{Enables non-blocking mode with IO class}
-  spec.homepage      = "https://github.com/ruby/io-nonblock"
-  spec.licenses      = ["Ruby", "BSD-2-Clause"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.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)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end