nio4r 2.4.0 → 2.5.7

data/lib/nio.rb

@@ -12,9 +12,28 @@ module NIO
   def self.engine
     ENGINE
   end
+
+  def self.pure?(env = ENV)
+    # The user has explicitly opted in to non-native implementation:
+    if env["NIO4R_PURE"] == "true"
+      return true
+    end
+
+    # Native Ruby on Windows is not supported:
+    if (Gem.win_platform? && !defined?(JRUBY_VERSION))
+      return true
+    end
+
+    # M1 native extension is crashing on M1 (arm64):
+    # if RUBY_PLATFORM =~ /darwin/ && RUBY_PLATFORM =~ /arm64/
+    #   return true
+    # end
+
+    return false
+  end
 end
 
-if ENV["NIO4R_PURE"] == "true" || (Gem.win_platform? && !defined?(JRUBY_VERSION))
+if NIO.pure?
   require "nio/monitor"
   require "nio/selector"
   require "nio/bytebuffer"

data/lib/nio/bytebuffer.rb

@@ -24,6 +24,7 @@ module NIO
     # @return [NIO::ByteBuffer]
     def initialize(capacity)
       raise TypeError, "no implicit conversion of #{capacity.class} to Integer" unless capacity.is_a?(Integer)
+
       @capacity = capacity
       clear
     end
@@ -119,9 +120,11 @@ module NIO
     # @return [self]
     def put(str)
       raise TypeError, "expected String, got #{str.class}" unless str.respond_to?(:to_str)
+
       str = str.to_str
 
       raise OverflowError, "buffer is full" if str.length > @limit - @position
+
       @buffer[@position...str.length] = str
       @position += str.length
       self
@@ -188,6 +191,7 @@ module NIO
     # @raise [NIO::ByteBuffer::MarkUnsetError] mark has not been set (call `#mark` first)
     def reset
       raise MarkUnsetError, "mark has not been set" unless @mark
+
       @position = @mark
       self
     end

data/lib/nio/monitor.rb

@@ -8,7 +8,7 @@ module NIO
 
     # :nodoc:
     def initialize(io, interests, selector)
-      unless io.is_a? OpenSSL::SSL::SSLSocket
+      unless defined?(::OpenSSL) && io.is_a?(::OpenSSL::SSL::SSLSocket)
         unless io.is_a?(IO)
           if IO.respond_to? :try_convert
             io = IO.try_convert(io)

data/lib/nio/selector.rb

@@ -14,7 +14,7 @@ module NIO
 
     # Create a new NIO::Selector
     def initialize(backend = :ruby)
-      raise ArgumentError, "unsupported backend: #{backend}" unless backend == :ruby
+      raise ArgumentError, "unsupported backend: #{backend}" unless [:ruby, nil].include?(backend)
 
       @selectables = {}
       @lock = Mutex.new
@@ -26,14 +26,16 @@ module NIO
 
     # Return a symbol representing the backend I/O multiplexing mechanism used.
     # Supported backends are:
-    # * :ruby    - pure Ruby (i.e IO.select)
-    # * :java    - Java NIO on JRuby
-    # * :epoll   - libev w\ Linux epoll
-    # * :poll    - libev w\ POSIX poll
-    # * :kqueue  - libev w\ BSD kqueue
-    # * :select  - libev w\ SysV select
-    # * :port    - libev w\ I/O completion ports
-    # * :unknown - libev w\ unknown backend
+    # * :ruby     - pure Ruby (i.e IO.select)
+    # * :java     - Java NIO on JRuby
+    # * :epoll    - libev w\ Linux epoll
+    # * :poll     - libev w\ POSIX poll
+    # * :kqueue   - libev w\ BSD kqueue
+    # * :select   - libev w\ SysV select
+    # * :port     - libev w\ I/O completion ports
+    # * :linuxaio - libev w\ Linux AIO io_submit (experimental)
+    # * :io_uring - libev w\ Linux io_uring (experimental)
+    # * :unknown  - libev w\ unknown backend
     def backend
       :ruby
     end
@@ -44,7 +46,7 @@ module NIO
     # * :w - is the IO writeable?
     # * :rw - is the IO either readable or writeable?
     def register(io, interest)
-      unless io.is_a? OpenSSL::SSL::SSLSocket
+      unless defined?(::OpenSSL) && io.is_a?(::OpenSSL::SSL::SSLSocket)
         io = IO.try_convert(io)
       end
 

data/lib/nio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NIO
-  VERSION = "2.4.0"
+  VERSION = "2.5.7"
 end

data/nio4r.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path("../lib/nio/version", __FILE__)
+require File.expand_path("lib/nio/version", __dir__)
 
 Gem::Specification.new do |spec|
   spec.authors       = ["Tony Arcieri"]
@@ -20,7 +20,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.version       = NIO::VERSION
 
-  spec.required_ruby_version = ">= 2.3"
+  spec.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/#{spec.version}",
+    "source_code_uri"   => "https://github.com/socketry/nio4r/tree/v#{spec.version}",
+    "wiki_uri"          => "https://github.com/socketry/nio4r/wiki"
+  }
+
+  spec.required_ruby_version = ">= 2.4"
 
   if defined? JRUBY_VERSION
     spec.files << "lib/nio4r_ext.jar"

data/spec/nio/bytebuffer_spec.rb

@@ -352,4 +352,3 @@ RSpec.describe NIO::ByteBuffer do
     end
   end
 end
-# rubocop:enable Metrics/BlockLength

data/spec/nio/selectables/ssl_socket_spec.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require "openssl"
 
 RSpec.describe OpenSSL::SSL::SSLSocket do
+
+  require "openssl"
+
   before(:all) do
     @tls = []
   end

data/spec/nio/selectables/udp_socket_spec.rb

@@ -33,8 +33,8 @@ RSpec.describe UDPSocket, if: !defined?(JRUBY_VERSION) do
       peer.send("X" * 1024, 0)
       cntr += 1
       t = select [], [peer], [], 0
-    rescue Errno::ECONNREFUSED => ex
-      skip "Couldn't make writable UDPSocket subject: #{ex.class}: #{ex}"
+    rescue Errno::ECONNREFUSED => e
+      skip "Couldn't make writable UDPSocket subject: #{e.class}: #{e}"
     end while t && t[1].include?(peer) && cntr < 5
 
     peer

data/spec/nio/selector_spec.rb

@@ -16,10 +16,16 @@ RSpec.describe NIO::Selector do
   end
 
   context "#initialize" do
-    it "allows explicitly specifying a backend" do
+    it "allows explicitly specifying a backend" do |example|
       backend = described_class.backends.first
       selector = described_class.new(backend)
       expect(selector.backend).to eq backend
+
+      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
@@ -32,8 +38,10 @@ RSpec.describe NIO::Selector do
   end
 
   context "backend" do
-    it "knows its backend" do
+    it "knows its backend" do |example|
       expect(subject.backend).to be_a Symbol
+
+      example.reporter.message "Current backend: #{subject.backend}"
     end
   end
 
@@ -67,6 +75,15 @@ RSpec.describe NIO::Selector do
     expect(monitor).to be_closed
   end
 
+  it "allows deregistering closed IO objects" do
+    subject.register(reader, :r)
+    reader.close
+
+    expect do
+      subject.deregister(reader)
+    end.not_to raise_error
+  end
+
   it "reports if it is empty" do
     expect(subject).to be_empty
     subject.register(reader, :r)
@@ -91,14 +108,20 @@ RSpec.describe NIO::Selector do
 
   context "timeouts" do
     let(:select_precision) {0.2}
+    let(:timeout) {2.0}
     let(:payload) {"hi there"}
 
-    it "waits for a timeout when selecting" do
+    it "waits for timeout when selecting from empty selector" do
+      started_at = Time.now
+      expect(subject.select(timeout)).to be_nil
+      expect(Time.now - started_at).to be_within(select_precision).of(timeout)
+    end
+
+    it "waits for a timeout when selecting with reader" do
       monitor = subject.register(reader, :r)
 
       writer << payload
 
-      timeout = 0.5
       started_at = Time.now
       expect(subject.select(timeout)).to include monitor
       expect(Time.now - started_at).to be_within(select_precision).of(0)
@@ -215,4 +238,3 @@ RSpec.describe NIO::Selector do
     expect(subject).to be_closed
   end
 end
-# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -12,6 +12,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nio4r
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.7
 platform: ruby
 authors:
 - Tony Arcieri
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,17 +47,14 @@ extensions:
 - ext/nio4r/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/workflow.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
-- Guardfile
-- LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - examples/echo_server.rb
 - ext/libev/Changes
 - ext/libev/LICENSE
@@ -65,13 +62,16 @@ 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
 - ext/libev/ev_port.c
 - ext/libev/ev_select.c
 - ext/libev/ev_vars.h
 - ext/libev/ev_win32.c
 - ext/libev/ev_wrap.h
+- ext/nio4r/.clang-format
 - ext/nio4r/bytebuffer.c
 - ext/nio4r/extconf.rb
 - ext/nio4r/libev.h
@@ -106,8 +106,13 @@ files:
 homepage: https://github.com/socketry/nio4r
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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.7
+  source_code_uri: https://github.com/socketry/nio4r/tree/v2.5.7
+  wiki_uri: https://github.com/socketry/nio4r/wiki
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,15 +120,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: New IO for Ruby
 test_files:

data/.travis.yml

@@ -1,29 +0,0 @@
-language: ruby
-cache: bundler
-dist: xenial
-bundler_args: --without development
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: 2.3
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-      env: NIO4R_PURE=true
-    - rvm: 2.6
-    - rvm: 2.6
-      os: osx
-    - rvm: truffleruby
-    - rvm: truffleruby
-      env: NIO4R_PURE=true
-    - rvm: jruby
-      env: JRUBY_OPTS="--debug -X+O --dev -J-Djruby.launch.inproc=true -J-Xmx1024M"
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O --dev -J-Djruby.launch.inproc=true -J-Xmx1024M"
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: truffleruby
-    - rvm: jruby-head
-    - rvm: jruby

data/Guardfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-directories %w[lib spec]
-clearing :on
-
-guard :rspec, cmd: "bundle exec rspec" do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})    { |m| "spec/#{m[1]}_spec.rb" }
-  watch("spec/spec_helper.rb") { "spec" }
-end

data/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2011-2018 Tony Arcieri
-
-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.

data/appveyor.yml

@@ -1,40 +0,0 @@
-build: off
-deploy: off
-
-environment:
-  PATH: C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  APPVEYOR_SAVE_CACHE_ON_ERROR: True
-  matrix:
-  - RUBY_VERSION: _trunk
-  - RUBY_VERSION: 26-x64
-  - RUBY_VERSION: 25-x64
-  - RUBY_VERSION: 24-x64
-  - RUBY_VERSION: 23-x64
-  - RUBY_VERSION: 23
-
-init:
-  - ps: |
-      if ($env:RUBY_VERSION -eq '_trunk') {
-        $trunk_uri = 'https://ci.appveyor.com/api/projects/MSP-Greg/ruby-loco/artifacts/ruby_trunk.7z'
-        (New-Object Net.WebClient).DownloadFile($trunk_uri, 'C:\ruby_trunk.7z')
-        7z.exe x C:\ruby_trunk.7z -oC:\Ruby_trunk
-      }
-
-install:
-  - SET RAKEOPT=-rdevkit
-  - gem update --system --conservative --no-document
-  - ruby -v
-  - gem -v
-  - bundle -v
-  - bundle install --path vendor\bundle --without development
-
-test_script:
-  - bundle exec rake spec
-
-matrix:
-  allow_failures:
-    - RUBY_VERSION: _trunk
-
-cache:
-  # If one of the files after the right arrow changes, cache will be invalidated
-  - vendor\bundle -> appveyor.yml, Gemfile, nio4r.gemspec