nio4r 2.5.8 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8bda8397f00743e7ca6814df9ae0072197fe4a1c9ba49efa74c8b44148ee71
-  data.tar.gz: c3fb1c470e4d378346f67b0c07fb7ffe4fe5527339097297a3b93ac950202d0b
+  metadata.gz: ae8b5e59a799c0161b454b1e4dcd97becc5bdb0b835ec6becf2a3a4488b648b5
+  data.tar.gz: e5b186044e74c4ad7c3b9846d6244dd21938b831eb415eccb63a781a4ee5dc9e
 SHA512:
-  metadata.gz: 51c13b6c08c436b692b0e858abc704d1e682667a302c55e43635a043daf2b26b8faff4ad67c1ea02ca2d619efad776903497b15ad67d2dd22894dd82a598cd49
-  data.tar.gz: '08297c9a051369fd39ad02489ddeb35595f1fbba313c3516d24f60e4e4e46db41307da90075a5a3b11ac377ad410bf908719d585ad1e3ba1b7ba867d520e4c0c'
+  metadata.gz: c22f5d7466ede134956ab01ea87c4554ce38a950019519f0a7c4a9f16cbe81c5a338de488d885761bd49393cfd72bf20a857204db13b051d6f59f8e5bc52bc1d
+  data.tar.gz: 27152f810d81a2f94b7428a3662e991441adb4756e24cb09753addd8d00b1a3a6ea80a2e89580eac76ab5d3328fa368cb43147ccaa9432d70e74a771ce22c863

data/.github/workflows/workflow.yml

@@ -14,34 +14,48 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-20.04, ubuntu-18.04, macos-10.15, windows-2019 ]
-        ruby: [ head, 3.0, 2.7, 2.6, 2.5, 2.4, jruby, truffleruby-head ]
+        os: 
+          - ubuntu-22.04
+          - macos-11
+          - windows-2022
+        ruby:
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "head"
+          - "jruby"
+          - "truffleruby"
         include:
-          - { os: ubuntu-16.04, ruby: 3.0 }
-          - { os: ubuntu-16.04, ruby: 2.4 }
+          - {os: ubuntu-20.04, ruby: "3.2"}
+          - {os: windows-2019, ruby: "3.2"}
+          - {os: windows-2022, ruby: ucrt}
         exclude:
-          - { os: windows-2019, ruby: head  }
-          - { os: windows-2019, ruby: jruby }
-          - { os: windows-2019, ruby: truffleruby-head }
+          - {os: windows-2022, ruby: head}
+          - {os: windows-2022, ruby: jruby}
+          - {os: windows-2022, ruby: truffleruby}
 
     steps:
-      - name: repo checkout
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: load ruby
-        uses: ruby/setup-ruby@v1
+      - name: set JAVA_HOME
+        if: |
+          startsWith(matrix.ruby, 'jruby')
+        shell: bash
+        run:  |
+          echo JAVA_HOME=$JAVA_HOME_11_X64 >> $GITHUB_ENV
+
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
 
-      - name: RubyGems, Bundler Update
-        run: gem update --system --no-document --conservative
-
-      - name: bundle install
-        run: bundle install --path .bundle/gems --without development
-
-      - name: compile
+      - name: Compile
         run: bundle exec rake compile
 
-      - name: test
+      - name: Test
         run: bundle exec rake spec
         timeout-minutes: 10

data/.mailmap

@@ -0,0 +1,16 @@
+Sadayuki Furuhashi <frsyuki@users.sourceforge.jp>
+Shannon Skipper <shannonskipper@gmail.com>
+Anatol Pomozov <anatol.pomozov@gmail.com>
+Hiroshi Shibata <shibata.hiroshi@gmail.com>
+John Thornton <ubergeek3141@gmail.com>
+Upekshe Jayasekera <usmj000@gmail.com>
+Upekshe Jayasekera <upekshej.11@cse.mrt.ac.lk>
+Usaku Nakamura <usa@garbagecollect.jp>
+Tomoya Ishida <tomoyapenguin@gmail.com>
+Tiago Cardoso <cardoso_tiago@hotmail.com>
+Ravil Bayramgalin <brainopia@evilmartians.com>
+Gregory Longtin <Greg.mpls@gmail.com>
+Gregory Longtin <Greg.mpls@gmail.com> <MSP-Greg@users.noreply.github.com>
+Elad Eyal <elad.eyal@intel.com>
+Boaz Segev <bo@bowild.com>
+Tao Luo <luotao.ruby@gmail.com>

data/Gemfile

@@ -6,13 +6,14 @@ gemspec
 
 gem "jruby-openssl" if defined? JRUBY_VERSION
 
-group :development do
-  gem "pry", require: false
+group :maintenance, optional: true do
+  gem "bake"
+  gem "bake-gem"
+  # gem "bake-modernize"
 end
 
 group :development, :test do
-  gem "coveralls", require: false
-  gem "rake-compiler", require: false
+  gem "rake-compiler", "~> 1.1.9", require: false
   gem "rspec", "~> 3.7", require: false
   gem "rubocop", "0.82.0", require: false
 end

data/{CHANGES.md → changes.md}

@@ -1,3 +1,40 @@
+## 2.6.2
+
+* Convert NIO objects to TypedData API.
+
+## 2.6.1
+
+* Don't update `io` which is subsequently stored. Retain the original.
+
+## 2.6.0
+
+* Fix conversion loses int precision.
+* Avoid direct access to IO internals.
+* Resolve issue loading both nio and nio4r gems.
+
+## 2.5.9 (2023-04-02)
+
+https://github.com/socketry/nio4r/compare/v2.5.8..v2.5.9
+
+## 2.5.8 (2021-08-03)
+
+* [#276](https://github.com/socketry/nio4r/pull/276)
+  Fix missing return statement in function returning non-void (issue [#275](https://github.com/socketry/nio4r/pull/275))
+  ([@ioquatix])
+* Remove `guard-rspec` from development dependencies ([@ioquatix])
+
+## 2.5.7 (2021-03-04)
+
+* [#267](https://github.com/socketry/nio4r/pull/267)
+  Don't try to link universal extension
+  ([@ioquatix])
+
+## 2.5.6 (2021-03-04)
+
+* [#268](https://github.com/socketry/nio4r/pull/268)
+  Prefer kqueue when on OSX >= v10.12.2
+  ([@jcmfernandes])
+
 ## 2.5.5 (2021-02-05)
 
 * [#256](https://github.com/socketry/nio4r/pull/256)

data/examples/echo_server.rb

@@ -1,6 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2016, by Tony Arcieri.
+# Copyright, 2016, by Jun Aruga.
+# Copyright, 2019, by Zhang Kang.
+# Copyright, 2020, by Thomas Dziedzic.
+# Copyright, 2023, by Samuel Williams.
+
 $LOAD_PATH.push File.expand_path("../lib", __dir__)
 require "nio"
 require "socket"

data/ext/nio4r/bytebuffer.c

@@ -8,8 +8,8 @@ static VALUE cNIO_ByteBuffer_MarkUnsetError = Qnil;
 
 /* Allocator/deallocator */
 static VALUE NIO_ByteBuffer_allocate(VALUE klass);
-static void NIO_ByteBuffer_gc_mark(struct NIO_ByteBuffer *byteBuffer);
-static void NIO_ByteBuffer_free(struct NIO_ByteBuffer *byteBuffer);
+static void NIO_ByteBuffer_free(void *data);
+static size_t NIO_ByteBuffer_memsize(const void *data);
 
 /* Methods */
 static VALUE NIO_ByteBuffer_initialize(VALUE self, VALUE capacity);
@@ -36,6 +36,26 @@ static VALUE NIO_ByteBuffer_inspect(VALUE self);
 
 #define MARK_UNSET -1
 
+/* Compatibility for Ruby <= 3.1 */
+#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
+
+static void
+io_set_nonblock(VALUE io)
+{
+    rb_io_t *fptr;
+    GetOpenFile(io, fptr);
+    rb_io_set_nonblock(fptr);
+}
+
 void Init_NIO_ByteBuffer()
 {
     mNIO = rb_define_module("NIO");
@@ -72,28 +92,46 @@ void Init_NIO_ByteBuffer()
     rb_define_method(cNIO_ByteBuffer, "inspect", NIO_ByteBuffer_inspect, 0);
 }
 
+static const rb_data_type_t NIO_ByteBuffer_type = {
+    "NIO::ByteBuffer",
+    {
+        NULL, // Nothing to mark
+        NIO_ByteBuffer_free,
+        NIO_ByteBuffer_memsize,
+    },
+    0,
+    0,
+    RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED
+};
+
 static VALUE NIO_ByteBuffer_allocate(VALUE klass)
 {
     struct NIO_ByteBuffer *bytebuffer = (struct NIO_ByteBuffer *)xmalloc(sizeof(struct NIO_ByteBuffer));
     bytebuffer->buffer = NULL;
-    return Data_Wrap_Struct(klass, NIO_ByteBuffer_gc_mark, NIO_ByteBuffer_free, bytebuffer);
+    return TypedData_Wrap_Struct(klass, &NIO_ByteBuffer_type, bytebuffer);
 }
 
-static void NIO_ByteBuffer_gc_mark(struct NIO_ByteBuffer *buffer)
+static void NIO_ByteBuffer_free(void *data)
 {
+    struct NIO_ByteBuffer *buffer = (struct NIO_ByteBuffer *)data;
+    if (buffer->buffer)
+        xfree(buffer->buffer);
+    xfree(buffer);
 }
 
-static void NIO_ByteBuffer_free(struct NIO_ByteBuffer *buffer)
+static size_t NIO_ByteBuffer_memsize(const void *data)
 {
+    const struct NIO_ByteBuffer *buffer = (const struct NIO_ByteBuffer *)data;
+    size_t memsize = sizeof(struct NIO_ByteBuffer);
     if (buffer->buffer)
-        xfree(buffer->buffer);
-    xfree(buffer);
+        memsize += buffer->capacity;
+    return memsize;
 }
 
 static VALUE NIO_ByteBuffer_initialize(VALUE self, VALUE capacity)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     buffer->capacity = NUM2INT(capacity);
     buffer->buffer = xmalloc(buffer->capacity);
@@ -106,7 +144,7 @@ static VALUE NIO_ByteBuffer_initialize(VALUE self, VALUE capacity)
 static VALUE NIO_ByteBuffer_clear(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     memset(buffer->buffer, 0, buffer->capacity);
 
@@ -120,7 +158,7 @@ static VALUE NIO_ByteBuffer_clear(VALUE self)
 static VALUE NIO_ByteBuffer_get_position(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     return INT2NUM(buffer->position);
 }
@@ -129,7 +167,7 @@ static VALUE NIO_ByteBuffer_set_position(VALUE self, VALUE new_position)
 {
     int pos;
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     pos = NUM2INT(new_position);
 
@@ -153,7 +191,7 @@ static VALUE NIO_ByteBuffer_set_position(VALUE self, VALUE new_position)
 static VALUE NIO_ByteBuffer_get_limit(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     return INT2NUM(buffer->limit);
 }
@@ -162,7 +200,7 @@ static VALUE NIO_ByteBuffer_set_limit(VALUE self, VALUE new_limit)
 {
     int lim;
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     lim = NUM2INT(new_limit);
 
@@ -190,7 +228,7 @@ static VALUE NIO_ByteBuffer_set_limit(VALUE self, VALUE new_limit)
 static VALUE NIO_ByteBuffer_capacity(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     return INT2NUM(buffer->capacity);
 }
@@ -198,7 +236,7 @@ static VALUE NIO_ByteBuffer_capacity(VALUE self)
 static VALUE NIO_ByteBuffer_remaining(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     return INT2NUM(buffer->limit - buffer->position);
 }
@@ -206,7 +244,7 @@ static VALUE NIO_ByteBuffer_remaining(VALUE self)
 static VALUE NIO_ByteBuffer_full(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     return buffer->position == buffer->limit ? Qtrue : Qfalse;
 }
@@ -216,7 +254,7 @@ static VALUE NIO_ByteBuffer_get(int argc, VALUE *argv, VALUE self)
     int len;
     VALUE length, result;
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     rb_scan_args(argc, argv, "01", &length);
 
@@ -244,7 +282,7 @@ static VALUE NIO_ByteBuffer_fetch(VALUE self, VALUE index)
 {
     int i;
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     i = NUM2INT(index);
 
@@ -263,7 +301,7 @@ static VALUE NIO_ByteBuffer_put(VALUE self, VALUE string)
 {
     long length;
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     StringValue(string);
     length = RSTRING_LEN(string);
@@ -281,19 +319,19 @@ static VALUE NIO_ByteBuffer_put(VALUE self, VALUE string)
 static VALUE NIO_ByteBuffer_read_from(VALUE self, VALUE io)
 {
     struct NIO_ByteBuffer *buffer;
-    rb_io_t *fptr;
     ssize_t nbytes, bytes_read;
 
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
-    GetOpenFile(rb_convert_type(io, T_FILE, "IO", "to_io"), fptr);
-    rb_io_set_nonblock(fptr);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
+
+    io = rb_convert_type(io, T_FILE, "IO", "to_io");
+    io_set_nonblock(io);
 
     nbytes = buffer->limit - buffer->position;
     if (nbytes == 0) {
         rb_raise(cNIO_ByteBuffer_OverflowError, "buffer is full");
     }
 
-    bytes_read = read(FPTR_TO_FD(fptr), buffer->buffer + buffer->position, nbytes);
+    bytes_read = read(rb_io_descriptor(io), buffer->buffer + buffer->position, nbytes);
 
     if (bytes_read < 0) {
         if (errno == EAGAIN) {
@@ -305,25 +343,24 @@ static VALUE NIO_ByteBuffer_read_from(VALUE self, VALUE io)
 
     buffer->position += bytes_read;
 
-    return INT2NUM(bytes_read);
+    return SIZET2NUM(bytes_read);
 }
 
 static VALUE NIO_ByteBuffer_write_to(VALUE self, VALUE io)
 {
     struct NIO_ByteBuffer *buffer;
-    rb_io_t *fptr;
     ssize_t nbytes, bytes_written;
 
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
-    GetOpenFile(rb_convert_type(io, T_FILE, "IO", "to_io"), fptr);
-    rb_io_set_nonblock(fptr);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
+    io = rb_convert_type(io, T_FILE, "IO", "to_io");
+    io_set_nonblock(io);
 
     nbytes = buffer->limit - buffer->position;
     if (nbytes == 0) {
         rb_raise(cNIO_ByteBuffer_UnderflowError, "no data remaining in buffer");
     }
 
-    bytes_written = write(FPTR_TO_FD(fptr), buffer->buffer + buffer->position, nbytes);
+    bytes_written = write(rb_io_descriptor(io), buffer->buffer + buffer->position, nbytes);
 
     if (bytes_written < 0) {
         if (errno == EAGAIN) {
@@ -335,13 +372,13 @@ static VALUE NIO_ByteBuffer_write_to(VALUE self, VALUE io)
 
     buffer->position += bytes_written;
 
-    return INT2NUM(bytes_written);
+    return SIZET2NUM(bytes_written);
 }
 
 static VALUE NIO_ByteBuffer_flip(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     buffer->limit = buffer->position;
     buffer->position = 0;
@@ -353,7 +390,7 @@ static VALUE NIO_ByteBuffer_flip(VALUE self)
 static VALUE NIO_ByteBuffer_rewind(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     buffer->position = 0;
     buffer->mark = MARK_UNSET;
@@ -364,7 +401,7 @@ static VALUE NIO_ByteBuffer_rewind(VALUE self)
 static VALUE NIO_ByteBuffer_mark(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     buffer->mark = buffer->position;
     return self;
@@ -373,7 +410,7 @@ static VALUE NIO_ByteBuffer_mark(VALUE self)
 static VALUE NIO_ByteBuffer_reset(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     if (buffer->mark < 0) {
         rb_raise(cNIO_ByteBuffer_MarkUnsetError, "mark has not been set");
@@ -387,7 +424,7 @@ static VALUE NIO_ByteBuffer_reset(VALUE self)
 static VALUE NIO_ByteBuffer_compact(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     memmove(buffer->buffer, buffer->buffer + buffer->position, buffer->limit - buffer->position);
     buffer->position = buffer->limit - buffer->position;
@@ -400,7 +437,7 @@ static VALUE NIO_ByteBuffer_each(VALUE self)
 {
     int i;
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     if (rb_block_given_p()) {
         for (i = 0; i < buffer->limit; i++) {
@@ -416,7 +453,7 @@ static VALUE NIO_ByteBuffer_each(VALUE self)
 static VALUE NIO_ByteBuffer_inspect(VALUE self)
 {
     struct NIO_ByteBuffer *buffer;
-    Data_Get_Struct(self, struct NIO_ByteBuffer, buffer);
+    TypedData_Get_Struct(self, struct NIO_ByteBuffer, &NIO_ByteBuffer_type, buffer);
 
     return rb_sprintf(
         "#<%s:%p @position=%d @limit=%d @capacity=%d>",

data/ext/nio4r/extconf.rb

@@ -1,10 +1,27 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2011-2020, by Tony Arcieri.
+# Copyright, 2014, by Hiroshi Shibata.
+# Copyright, 2014, by Sergey Avseyev.
+# Copyright, 2015, by Daniel Berger.
+# Copyright, 2017, by Jun Aruga.
+# Copyright, 2017, by Usaku Nakamura.
+# Copyright, 2017, by Lars Kanis.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2020, by Gregory Longtin.
+# Copyright, 2020, by Boaz Segev.
+# Copyright, 2020, by Joao Fernandes.
+# Copyright, 2021, by Jeffrey Martin.
+
 require "rubygems"
 
 # Write a dummy Makefile on Windows because we use the pure Ruby implementation there
 if Gem.win_platform?
-  require "devkit" if RUBY_PLATFORM.include?("mingw")
+  begin
+    require "devkit" if RUBY_PLATFORM.include?("mingw")
+  rescue LoadError => e
+  end
   File.write("Makefile", "all install::\n")
   File.write("nio4r_ext.so", "")
   exit
@@ -13,6 +30,7 @@ end
 require "mkmf"
 
 have_header("unistd.h")
+have_func("rb_io_descriptor")
 
 $defs << "-DEV_USE_LINUXAIO"     if have_header("linux/aio_abi.h")
 $defs << "-DEV_USE_IOURING"      if have_header("linux/io_uring.h")