nio4r 2.5.4 → 2.7.0

data/readme.md

@@ -0,0 +1,91 @@
+# ![nio4r](https://raw.github.com/socketry/nio4r/master/logo.png)
+
+[![Gem Version](https://badge.fury.io/rb/nio4r.svg)](http://rubygems.org/gems/nio4r)
+[![Build Status](https://github.com/socketry/nio4r/workflows/nio4r/badge.svg?branch=master&event=push)](https://github.com/socketry/nio4r/actions?query=workflow:nio4r)
+[![Code Climate](https://codeclimate.com/github/socketry/nio4r.svg)](https://codeclimate.com/github/socketry/nio4r)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/nio4r/2.2.0)
+
+**New I/O for Ruby (nio4r)**: cross-platform asynchronous I/O primitives for
+scalable network clients and servers. Modeled after the Java NIO API, but
+simplified for ease-of-use.
+
+**nio4r** provides an abstract, cross-platform stateful I/O selector API for Ruby.
+I/O selectors are the heart of "reactor"-based event loops, and monitor
+multiple I/O objects for various types of readiness, e.g. ready for reading or
+writing.
+
+## Projects using nio4r
+
+  - [ActionCable](https://rubygems.org/gems/actioncable): Rails 5 WebSocket protocol, uses nio4r for a WebSocket server
+  - [Celluloid](https://github.com/celluloid/celluloid-io): Actor-based concurrency framework, uses nio4r for async I/O
+  - [Async](https://github.com/socketry/async): Asynchronous I/O framework for Ruby
+  - [Puma](https://github.com/puma/puma): Ruby/Rack web server built for concurrency
+
+## Goals
+
+  - Expose high-level interfaces for stateful IO selectors
+  - Keep the API small to maximize both portability and performance across many
+    different OSes and Ruby VMs
+  - Provide inherently thread-safe facilities for working with IO objects
+
+## Supported platforms
+
+  - Ruby 2.4
+  - Ruby 2.5
+  - Ruby 2.6
+  - Ruby 2.7
+  - Ruby 3.0
+  - [JRuby](https://github.com/jruby/jruby)
+  - [TruffleRuby](https://github.com/oracle/truffleruby)
+
+## Supported backends
+
+  - **libev**: MRI C extension targeting multiple native IO selector APIs (e.g epoll, kqueue)
+  - **Java NIO**: JRuby extension which wraps the Java NIO subsystem
+  - **Pure Ruby**: `Kernel.select`-based backend that should work on any Ruby interpreter
+
+## Documentation
+
+[Please see the nio4r wiki](https://github.com/socketry/nio4r/wiki)
+for more detailed documentation and usage notes:
+
+  - [Getting Started](https://github.com/socketry/nio4r/wiki/Getting-Started): Introduction to nio4r's components
+  - [Selectors](https://github.com/socketry/nio4r/wiki/Selectors): monitor multiple `IO` objects for readiness events
+  - [Monitors](https://github.com/socketry/nio4r/wiki/Monitors): control interests and inspect readiness for specific `IO` objects
+  - [Byte Buffers](https://github.com/socketry/nio4r/wiki/Byte-Buffers): fixed-size native buffers for high-performance I/O
+
+See also:
+
+  - [YARD API documentation](http://www.rubydoc.info/gems/nio4r/frames)
+
+## Non-goals
+
+**nio4r** is not a full-featured event framework like [EventMachine](https://github.com/eventmachine/eventmachine) or [Cool.io](https://coolio.github.io/).
+Instead, nio4r is the sort of thing you might write a library like that on
+top of. nio4r provides a minimal API such that individual Ruby implementers
+may choose to produce optimized versions for their platform, without having
+to maintain a large codebase.
+
+## Releases
+
+### CRuby
+
+    rake clean
+    rake release
+
+### JRuby
+
+You might need to delete `Gemfile.lock` before trying to `bundle install`.
+
+    # Ensure you have the correct JDK:
+    pacman -Syu jdk-openjdk
+    archlinux-java set java-19-openjdk
+    
+    # Ensure you are using jruby:
+    chruby jruby
+    bundle update
+    
+    # Build the package:
+    rake clean
+    rake compile
+    rake release

data/spec/nio/acceptables_spec.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2017, by Tony Arcieri.
+# Copyright, 2019-2023, by Samuel Williams.
+
 require "spec_helper"
 
 RSpec.describe "NIO acceptables" do

data/spec/nio/bytebuffer_spec.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2016, by Upekshe Jayasekera.
+# Copyright, 2016-2017, by Tony Arcieri.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2020, by Thomas Dziedzic.
+
 require "spec_helper"
 
 RSpec.describe NIO::ByteBuffer do

data/spec/nio/monitor_spec.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2011-2018, by Tony Arcieri.
+# Copyright, 2012, by Logan Bowers.
+# Copyright, 2015, by Tiago Cardoso.
+# Copyright, 2015, by Upekshe Jayasekera.
+# Copyright, 2018-2023, by Samuel Williams.
+
 require "spec_helper"
 require "socket"
 

data/spec/nio/selectables/pipe_spec.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2017, by Tony Arcieri.
+# Copyright, 2012, by Logan Bowers.
+# Copyright, 2017, by Gregory Longtin.
+# Copyright, 2023, by Samuel Williams.
+
 require "spec_helper"
 
 RSpec.describe "IO.pipe" do

data/spec/nio/selectables/ssl_socket_spec.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2017, by Tony Arcieri.
+# Copyright, 2012, by Logan Bowers.
+# Copyright, 2017-2020, by Gregory Longtin.
+# Copyright, 2019, by Cédric Boutillier.
+# Copyright, 2019-2023, by Samuel Williams.
+
 require "spec_helper"
+require "openssl"
 
 RSpec.describe OpenSSL::SSL::SSLSocket do
-
-  require "openssl"
-
   before(:all) do
     @tls = []
   end

data/spec/nio/selectables/tcp_socket_spec.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2017, by Tony Arcieri.
+# Copyright, 2012, by Bernd Ahlers.
+# Copyright, 2012, by Logan Bowers.
+# Copyright, 2013, by Tim Carey-Smith.
+# Copyright, 2019-2023, by Samuel Williams.
+
 require "spec_helper"
 
 RSpec.describe TCPSocket do

data/spec/nio/selectables/udp_socket_spec.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2017, by Tony Arcieri.
+# Copyright, 2017, by Gregory Longtin.
+# Copyright, 2017, by Olle Jonsson.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2020, by Thomas Dziedzic.
+
 require "spec_helper"
 
 RSpec.describe UDPSocket, if: !defined?(JRUBY_VERSION) do

data/spec/nio/selector_spec.rb

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2011-2017, by Tony Arcieri.
+# Copyright, 2012, by Logan Bowers.
+# Copyright, 2013, by Ravil Bayramgalin.
+# Copyright, 2013, by Tim Carey-Smith.
+# Copyright, 2015, by Vladimir Kochnev.
+# Copyright, 2016, by Tiago Cardoso.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019, by Jesús Burgos Maciá.
+# Copyright, 2020, by Thomas Dziedzic.
+# Copyright, 2021, by Joao Fernandes.
+
 require "spec_helper"
 require "timeout"
 
@@ -24,6 +36,10 @@ RSpec.describe NIO::Selector do
       example.reporter.message "Supported backends: #{described_class.backends}"
     end
 
+    it "automatically selects a backend if none or nil is specified" do
+      expect(described_class.new.backend).to eq described_class.new(nil).backend
+    end
+
     it "raises ArgumentError if given an invalid backend" do
       expect { described_class.new(:derp) }.to raise_error ArgumentError
     end

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
-require "coveralls"
-Coveralls.wear!
+# Released under the MIT License.
+# Copyright, 2011-2017, by Tony Arcieri.
+# Copyright, 2017, by Gregory Longtin.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2021, by Joao Fernandes.
 
 require "nio"
 require "support/selectable_examples"
@@ -12,6 +15,8 @@ RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = ".rspec_status"
 
+  config.filter_run_when_matching :focus
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end

data/spec/support/selectable_examples.rb

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2017, by Tony Arcieri.
+# Copyright, 2012, by Logan Bowers.
+# Copyright, 2013, by Tim Carey-Smith.
+# Copyright, 2017-2019, by Gregory Longtin.
+# Copyright, 2017, by Tiago Cardoso.
+# Copyright, 2019-2023, by Samuel Williams.
+
 RSpec.shared_context NIO::Selector do
   let(:selector) {@selector = NIO::Selector.new}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nio4r
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.7.0
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,12 +49,12 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/workflow.yml"
 - ".gitignore"
+- ".mailmap"
 - ".rspec"
 - ".rubocop.yml"
-- CHANGES.md
 - Gemfile
-- README.md
 - Rakefile
+- changes.md
 - examples/echo_server.rb
 - ext/libev/Changes
 - ext/libev/LICENSE
@@ -62,6 +62,7 @@ files:
 - ext/libev/ev.c
 - ext/libev/ev.h
 - ext/libev/ev_epoll.c
+- ext/libev/ev_iouring.c
 - ext/libev/ev_kqueue.c
 - ext/libev/ev_linuxaio.c
 - ext/libev/ev_poll.c
@@ -87,11 +88,14 @@ files:
 - lib/nio/monitor.rb
 - lib/nio/selector.rb
 - lib/nio/version.rb
+- lib/nio4r.rb
+- license.md
 - logo.png
 - nio4r.gemspec
 - rakelib/extension.rake
 - rakelib/rspec.rake
 - rakelib/rubocop.rake
+- readme.md
 - spec/nio/acceptables_spec.rb
 - spec/nio/bytebuffer_spec.rb
 - spec/nio/monitor_spec.rb
@@ -104,13 +108,14 @@ files:
 - spec/support/selectable_examples.rb
 homepage: https://github.com/socketry/nio4r
 licenses:
-- MIT
+- MIT AND (BSD-2-Clause OR GPL-2.0-or-later)
 metadata:
   bug_tracker_uri: https://github.com/socketry/nio4r/issues
-  changelog_uri: https://github.com/socketry/nio4r/blob/master/CHANGES.md
-  documentation_uri: https://www.rubydoc.info/gems/nio4r/2.5.4
-  source_code_uri: https://github.com/socketry/nio4r/tree/v2.5.4
+  changelog_uri: https://github.com/socketry/nio4r/blob/main/changes.md
+  documentation_uri: https://www.rubydoc.info/gems/nio4r/2.6.1
+  source_code_uri: https://github.com/socketry/nio4r/tree/v2.6.1
   wiki_uri: https://github.com/socketry/nio4r/wiki
+  funding_uri: https://github.com/sponsors/ioquatix/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -126,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: New IO for Ruby

data/README.md

@@ -1,132 +0,0 @@
-# ![nio4r](https://raw.github.com/socketry/nio4r/master/logo.png)
-
-[![Gem Version](https://badge.fury.io/rb/nio4r.svg)](http://rubygems.org/gems/nio4r)
-[![Build Status](https://github.com/socketry/nio4r/workflows/nio4r/badge.svg?branch=master&event=push)](https://github.com/socketry/nio4r/actions?query=workflow:nio4r)
-[![Code Climate](https://codeclimate.com/github/socketry/nio4r.svg)](https://codeclimate.com/github/socketry/nio4r)
-[![Coverage Status](https://coveralls.io/repos/socketry/nio4r/badge.svg?branch=master)](https://coveralls.io/r/socketry/nio4r)
-[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/nio4r/2.2.0)
-
-**New I/O for Ruby (nio4r)**: cross-platform asynchronous I/O primitives for
-scalable network clients and servers. Modeled after the Java NIO API, but
-simplified for ease-of-use.
-
-**nio4r** provides an abstract, cross-platform stateful I/O selector API for Ruby.
-I/O selectors are the heart of "reactor"-based event loops, and monitor
-multiple I/O objects for various types of readiness, e.g. ready for reading or
-writing.
-
-## Projects using nio4r
-
-* [ActionCable]: Rails 5 WebSocket protocol, uses nio4r for a WebSocket server
-* [Celluloid]: Actor-based concurrency framework, uses nio4r for async I/O
-* [Async]: Asynchronous I/O framework for Ruby
-* [Puma]: Ruby/Rack web server built for concurrency
-
-[ActionCable]: https://rubygems.org/gems/actioncable
-[Celluloid]: https://github.com/celluloid/celluloid-io
-[Async]: https://github.com/socketry/async
-[Puma]: https://github.com/puma/puma
-
-## Goals
-
-* Expose high-level interfaces for stateful IO selectors
-* Keep the API small to maximize both portability and performance across many
-  different OSes and Ruby VMs
-* Provide inherently thread-safe facilities for working with IO objects
-
-## Supported platforms
-
-* Ruby 2.4
-* Ruby 2.5
-* Ruby 2.6
-* Ruby 2.7
-* [JRuby](https://github.com/jruby/jruby)
-* [TruffleRuby](https://github.com/oracle/truffleruby)
-
-## Supported backends
-
-* **libev**: MRI C extension targeting multiple native IO selector APIs (e.g epoll, kqueue)
-* **Java NIO**: JRuby extension which wraps the Java NIO subsystem
-* **Pure Ruby**: `Kernel.select`-based backend that should work on any Ruby interpreter
-
-## Documentation
-
-[Please see the nio4r wiki](https://github.com/socketry/nio4r/wiki)
-for more detailed documentation and usage notes:
-
-* [Getting Started]: Introduction to nio4r's components
-* [Selectors]: monitor multiple `IO` objects for readiness events
-* [Monitors]: control interests and inspect readiness for specific `IO` objects
-* [Byte Buffers]: fixed-size native buffers for high-performance I/O
-
-[Getting Started]: https://github.com/socketry/nio4r/wiki/Getting-Started
-[Selectors]: https://github.com/socketry/nio4r/wiki/Selectors
-[Monitors]: https://github.com/socketry/nio4r/wiki/Monitors
-[Byte Buffers]: https://github.com/socketry/nio4r/wiki/Byte-Buffers
-
-See also:
-
-* [YARD API documentation](http://www.rubydoc.info/gems/nio4r/frames)
-
-## Non-goals
-
-**nio4r** is not a full-featured event framework like [EventMachine] or [Cool.io].
-Instead, nio4r is the sort of thing you might write a library like that on
-top of. nio4r provides a minimal API such that individual Ruby implementers
-may choose to produce optimized versions for their platform, without having
-to maintain a large codebase.
-
-[EventMachine]: https://github.com/eventmachine/eventmachine
-[Cool.io]: https://coolio.github.io/
-
-## Releases
-
-### CRuby
-
-```
-rake clean
-rake release
-```
-
-### JRuby
-
-You might need to delete `Gemfile.lock` before trying to `bundle install`.
-
-```
-rake clean
-rake compile
-rake release
-```
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2019, by Tony Arcieri.  
-Copyright, 2019, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-### libev
-
-Released under the BSD license. See [ext/libev/LICENSE] for details.
-
-Copyright, 2007-2019, by Marc Alexander Lehmann.
-
-[ext/libev/LICENSE]: https://github.com/socketry/nio4r/blob/master/ext/libev/LICENSE