nio4r 2.0.0.pre → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6641deb5a7b32db8287d8856510a07dd33ec737
-  data.tar.gz: e414ccbb0aef8b0d8cf9ab63e09154753652766b
+  metadata.gz: 9f553c279692e1cf308af13c716610b424caca04
+  data.tar.gz: 7cd52022633fd0a5d2ba26f003e976505a783237
 SHA512:
-  metadata.gz: 37539315f05ec820ec9a5644acb178c49098e6384955ce234c7b5d4f137d8122d98a8486e9ebc419250057b4268d55f72f82ca28145c2ebf713af7823bd9a7fb
-  data.tar.gz: 1c151cb3ac3d8aef61665ebf4827b59712509d2482c1b26ad1af2853711e6888c8043306a312d4d84b89f511085c346ade0915e768307811bddabc2cc39c41ae
+  metadata.gz: 6bdc6f608f34b8be39efa968e523f9bac24da9dc976467afb7ff2d271ca234b6c46d614f37f2c5b82bcbab56c11b3835d0c2c5c26028b794b1dd26ffdee86b83
+  data.tar.gz: 32a6b982cbd25605a031d39b7fdb9208b767be7d11f842405fd081f384addb372e1e1fec846176e78f5a77c81e8a21bdf5709eb76753fd85b43583b819e75d5d

data/.rspec

@@ -1,5 +1,4 @@
 --color
 --format documentation
---backtrace
 --order random
 --warnings

data/.rubocop.yml

@@ -1,61 +1,54 @@
+AllCops:
+  DisplayCopNames: true
+
 #
-# Deliberate style choices
+# Lint
 #
 
-LineLength:
-  Max: 100
+Lint/HandleExceptions:
+  Enabled: false
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+Lint/Loop:
+  Enabled: false
 
-Metrics/MethodLength:
-  CountComments: false
-  Max: 40
+#
+# Metrics
+#
 
 Metrics/AbcSize:
-  Max: 40
+  Max: 35
 
-Metrics/PerceivedComplexity:
-  Max: 15
+Metrics/ClassLength:
+  Max: 128
 
-Metrics/CyclomaticComplexity:
-  Max: 10
+Metrics/LineLength:
+  Max: 128
 
-Style/GlobalVars:
-  Enabled: false
+Metrics/MethodLength:
+  CountComments: false
+  Max: 50
 
-Style/TrivialAccessors:
-  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 15
 
 #
-# Auto-generated overrides
+# Style
 #
 
-# Offense count: 2
-Lint/HandleExceptions:
-  Enabled: false
-
-# Offense count: 3
-Lint/Loop:
-  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
 
-# Offense count: 1
-Lint/NonLocalExitFromIterator:
+Style/GlobalVars:
   Enabled: false
 
-# Offense count: 7
-Lint/UselessAssignment:
+Style/NumericPredicate:
   Enabled: false
 
-# Offense count: 1
-# Configuration parameters: SupportedStyles, IndentOneStep.
-Style/CaseIndentation:
-  IndentWhenRelativeTo: end
-
-# Offense count: 1
-Style/Documentation:
+Style/RescueModifier:
   Enabled: false
 
-# Offense count: 2
-Style/RescueModifier:
+Style/TrivialAccessors:
   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -8,19 +8,11 @@ branches:
   only:
     - master
 
-os:
-  - linux
-  - osx
-
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - ruby-head
-  - jruby-9.1.5.0 # latest stable
-  - jruby-head
-  - rbx
+  - jruby-9.1.6.0 # latest stable
+  - 2.2.2
+  - 2.3.3
+  - 2.4.0
 
 env:
   global:
@@ -31,15 +23,6 @@ env:
 
 matrix:
   fast_finish: true
-  allow_failures:
-    - os:  osx # TODO: make tests pass reliably on OS X
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx
-    - rvm: jruby-1.7
-      env: NIO4R_PURE=true
-    - rvm: jruby-9.1
-      env: NIO4R_PURE=true
 
 notifications:
   irc: "irc.freenode.org#celluloid"

data/CHANGES.md

@@ -1,28 +1,57 @@
-1.2.1 (2016-01-31)
-------------------
+## 2.0.0 (2016-12-28)
+
+* [#53](https://github.com/socketry/nio4r/pull/53)
+  Limit lock scope to prevent recursive locking.
+  ([@johnnyt])
+
+* [#95](https://github.com/socketry/nio4r/pull/95)
+   NIO::ByteBuffer Google Summer of Code project.
+   ([@UpeksheJay], [@tarcieri])
+
+* [#111](https://github.com/socketry/nio4r/pull/111)
+  NIO::Selector#backend introspection support.
+  ([@tarcieri])
+
+* [#112](https://github.com/socketry/nio4r/pull/112)
+  Upgrade to libev 4.23.
+  ([@tarcieri])
+
+* [#119](https://github.com/socketry/nio4r/pull/119)
+  Disambiguate wakeup vs timeout (fixes #63, #66).
+  ([@tarcieri])
+
+* [#124](https://github.com/socketry/nio4r/pull/124)
+  Monitor interests API improvements.
+  ([@tarcieri])
+
+* Drop Ruby 2.0 and 2.1 support, require Ruby 2.2.2+.
+  ([@tarcieri])
+
+## 1.2.1 (2016-01-31)
+
 * Fix bug in the JRuby backend which cases indefinite blocking when small
   timeout values are passed to the selector
 
-1.2.0 (2015-12-22)
-------------------
+## 1.2.0 (2015-12-22)
+
 * Add NIO::Monitor#interests= API for changing interests. Contributed by
   Upekshe Jayasekera as a Google Summer of Code project.
 * Update to libev 4.22
 
-1.1.1 (2015-07-17)
-------------------
+## 1.1.1 (2015-07-17)
+
 * Update to libev 4.20
 * Fall back to io.h if unistd.h is not found
 * RSpec updates
 * RuboCop
 
-1.1.0 (2015-01-10)
-------------------
+## 1.1.0 (2015-01-10)
+
 * Update to libev 4.19
 * Do not call ev_io_stop on monitors if the loop is already closed
 
-1.0.1 (2014-09-01)
-------------------
+## 1.0.1 (2014-09-01)
+
 * Fix C compiler warnings
 * Eliminate Ruby warnings about @lock_holder
 * Windows improvements
@@ -30,59 +59,59 @@
 * Automatically require 'set'
 * Update to RSpec 3
 
-1.0.0 (2014-01-14)
-------------------
+## 1.0.0 (2014-01-14)
+
 * Have Selector#register obtain the actual IO from a Monitor object
   because Monitor#initialize might convert it.
 * Drop 1.8 support
 
-0.5.0 (2013-08-06)
-------------------
+## 0.5.0 (2013-08-06)
+
 * Fix segv when attempting to register to a closed selector
 * Fix Windows support on Ruby 2.0.0
 * Upgrade to libev 4.15
 
-0.4.6 (2013-05-27)
-------------------
+## 0.4.6 (2013-05-27)
+
 * Fix for JRuby on Windows
 
-0.4.5
------
+## 0.4.5
+
 * Fix botched gem release
 
-0.4.4
------
+## 0.4.4
+
 * Fix return values for Selector_synchronize and Selector_unlock
 
-0.4.3
------
+## 0.4.3
+
 * REALLY have thread synchronization when closing selectors ;)
 
-0.4.2
------
+## 0.4.2
+
 * Attempt to work around packaging problems with bundler-api o_O
 
-0.4.1
------
+## 0.4.1
+
 * Thread synchronization when closing selectors
 
-0.4.0
------
+## 0.4.0
+
 * OpenSSL::SSL::SSLSocket support
 
-0.3.3
------
+## 0.3.3
+
 * NIO::Selector#select_each removed
 * Remove event buffer
 * Patch GIL unlock directly into libev
 * Re-release since 0.3.2 was botched :(
 
-0.3.1
------
+## 0.3.1
+
 * Prevent CancelledKeyExceptions on JRuby
 
-0.3.0
------
+## 0.3.0
+
 * NIO::Selector#select now takes a block and behaves like select_each
 * NIO::Selector#select_each is now deprecated and will be removed
 * Closing monitors detaches them from their selector
@@ -91,23 +120,27 @@
 * Bugfixes for zero/negative select timeouts
 * Handle OP_CONNECT properly on JRuby
 
-0.2.2
------
+## 0.2.2
+
 * Raise IOError if asked to wake up a closed selector
 
-0.2.1
------
+## 0.2.1
+
 * Implement wakeup mechanism using raw pipes instead of ev_async, since
   ev_async likes to cause segvs when used across threads (despite claims
   in the documentation to the contrary)
 
-0.2.0
------
+## 0.2.0
+
 * NIO::Monitor#readiness API to query readiness, along with #readable? and
   #writable? helper methods
 * NIO::Selector#select_each API which avoids memory allocations if possible
 * Bugfixes for the JRuby implementation
 
-0.1.0
------
+## 0.1.0
+
 * Initial release. Merry Christmas!
+
+[@tarcieri]: https://github.com/tarcieri
+[@johnnyt]: https://github.com/johnnyt
+[@UpeksheJay]: https://github.com/UpeksheJay

data/Gemfile

@@ -1,12 +1,20 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
 gem "jruby-openssl" if defined? JRUBY_VERSION
 
+group :development do
+  gem "guard-rspec", require: false
+  gem "pry",         require: false
+end
+
 group :development, :test do
-  gem "rake-compiler"
-  gem "rspec",   "~> 3",   require: false
-  gem "rubocop", "0.36.0", require: false
   gem "coveralls",         require: false
+  gem "rake-compiler",     require: false
+  gem "rspec", "~> 3",     require: false
+  gem "rspec-retry",       require: false
+  gem "rubocop", "0.46.0", require: false
 end

data/Guardfile

@@ -0,0 +1,10 @@
+# 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,4 +1,4 @@
-Copyright (c) 2011-12 Tony Arcieri
+Copyright (c) 2011-16 Tony Arcieri
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,15 +1,15 @@
-# ![nio4r](https://raw.github.com/celluloid/nio4r/master/logo.png)
+# ![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://secure.travis-ci.org/celluloid/nio4r.svg?branch=master)](http://travis-ci.org/celluloid/nio4r)
-[![Code Climate](https://codeclimate.com/github/celluloid/nio4r.svg)](https://codeclimate.com/github/celluloid/nio4r)
-[![Coverage Status](https://coveralls.io/repos/celluloid/nio4r/badge.svg?branch=master)](https://coveralls.io/r/celluloid/nio4r)
-[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/celluloid/nio4r/blob/master/LICENSE.txt)
+[![Build Status](https://secure.travis-ci.org/socketry/nio4r.svg?branch=master)](http://travis-ci.org/socketry/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)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/socketry/nio4r/blob/master/LICENSE.txt)
 
 _NOTE: This is the 2.x **development** branch of nio4r.  For the 1.x **stable**
 branch (used by [Rails 5]), please see:_
 
-https://github.com/celluloid/nio4r/tree/1-x-stable
+https://github.com/socketry/nio4r/tree/1-x-stable
 
 **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
@@ -28,7 +28,7 @@ writing.
 * [Celluloid::IO]: Actor-based concurrency framework, uses nio4r for async I/O
 
 [ActionCable]: https://rubygems.org/gems/actioncable
-[Celluloid::IO]: https://github.com/celluloid/celluloid-io
+[Celluloid::IO]: https://github.com/socketry/socketry-io
 
 ## Goals
 
@@ -39,142 +39,35 @@ writing.
 
 ## Supported platforms
 
-* Ruby 2.0
-* Ruby 2.1
-* Ruby 2.2
+* Ruby 2.2.2+
 * Ruby 2.3
+* Ruby 2.4
 * JRuby 9000
-* Pure Ruby using Kernel.select
 
-## Platform notes
+## Supported backends
 
-* MRI/YARV and Rubinius implement nio4r with a C extension based on libev,
-  which provides a high performance binding to native IO APIs
-* JRuby uses a Java extension based on the high performance Java NIO subsystem
-* A pure Ruby implementation is also provided for Ruby implementations which
-  don't implement the MRI C extension API
+* **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
 
-## Usage
-
-If you're interested in using nio4r for a project but just getting started,
-check out this blog post which provides some background and examples:
+## Documentation
 
-[A gentle introduction to nio4r: low-level portable asynchronous I/O for Ruby][blogpost]
+[Please see the nio4r wiki](https://github.com/socketry/nio4r/wiki)
+for more detailed documentation and usage notes:
 
-[blogpost]: https://tonyarcieri.com/a-gentle-introduction-to-nio4r
+* [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
 
-### Selectors
+[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
 
-The NIO::Selector class is the main API provided by nio4r. Use it where you
-might otherwise use Kernel.select, but want to monitor the same set of IO
-objects across multiple select calls rather than having to reregister them
-every single time:
+See also:
 
-```ruby
-require 'nio'
-
-selector = NIO::Selector.new
-```
-
-To monitor IO objects, attach them to the selector with the NIO::Selector#register
-method, monitoring them for read readiness with the :r parameter, write
-readiness with the :w parameter, or both with :rw.
-
-```ruby
->> reader, writer = IO.pipe
- => [#<IO:0xf30>, #<IO:0xf34>]
->> monitor = selector.register(reader, :r)
- => #<NIO::Monitor:0xfbc>
-```
-
-After registering an IO object with the selector, you'll get a NIO::Monitor
-object which you can use for managing how a particular IO object is being
-monitored. Monitors will store an arbitrary value of your choice, which
-provides an easy way to implement callbacks:
-
-```ruby
->> monitor = selector.register(reader, :r)
- => #<NIO::Monitor:0xfbc>
->> monitor.value = proc { puts "Got some data: #{monitor.io.read_nonblock(4096)}" }
- => #<Proc:0x1000@(irb):4>
-```
-
-The main method of importance is NIO::Selector#select, which monitors all
-registered IO objects and returns an array of monitors that are ready.
-
-```ruby
->> writer << "Hi there!"
- => #<IO:0x103c>
->> ready = selector.select
- => [#<NIO::Monitor:0xfbc>]
->> ready.each { |m| m.value.call }
-Got some data: Hi there!
- => [#<NIO::Monitor:0xfbc>]
-```
-
-By default, NIO::Selector#select will block indefinitely until one of the IO
-objects being monitored becomes ready. However, you can also pass a timeout to
-wait in seconds to NIO::Selector#select just like you can with Kernel.select:
-
-```ruby
-ready = selector.select(15) # Wait 15 seconds
-```
-
-If a timeout occurs, ready will be nil.
-
-You can avoid allocating an array each time you call NIO::Selector#select by
-passing a block to select. The block will be called for each ready monitor
-object, with that object passed as an argument. The number of ready monitors
-is returned as a Fixnum:
-
-```ruby
->> selector.select { |m| m.value.call }
-Got some data: Hi there!
- => 1
-```
-
-When you're done monitoring a particular IO object, just deregister it from
-the selector:
-
-```ruby
-selector.deregister(reader)
-```
-
-### Monitors
-
-Monitors provide methods which let you introspect on why a particular IO
-object was selected. These methods are not thread safe unless you are holding
-the selector lock (i.e. if you're in a block passed to #select). Only use them
-if you aren't concerned with thread safety, or you're within a #select
-block:
-
-- ***#interests***: what this monitor is interested in (:r, :w, or :rw)
-- ***#interests=***: change the current interests for a monitor (to :r, :w, or :rw)
-- ***#readiness***: what I/O operations the monitored object is ready for
-- ***#readable?***: was the IO readable last time it was selected?
-- ***#writable?***: was the IO writable last time it was selected?
-
-Monitors also support a ***#value*** and ***#value=*** method for storing a
-handle to an arbitrary object of your choice (e.g. a proc)
-
-### Flow Control
-
-For information on how to compose nio4r selectors inside of event loops,
-please read the [Flow Control Guide on the
-Wiki](https://github.com/celluloid/nio4r/wiki/Basic-Flow-Control)
-
-## Concurrency
-
-**nio4r** provides internal locking to ensure that it's safe to use from multiple
-concurrent threads. Only one thread can select on a NIO::Selector at a given
-time, and while a thread is selecting other threads are blocked from
-registering or deregistering IO objects. Once a pending select has completed,
-requests to register/unregister IO objects will be processed.
-
-NIO::Selector#wakeup allows one thread to unblock another thread that's in the
-middle of an NIO::Selector#select operation. This lets other threads that need
-to communicate immediately with the selector unblock it so it can process
-other events that it's not presently selecting on.
+* [YARD API documentation](http://www.rubydoc.info/gems/nio4r/frames)
 
 ## Non-goals
 
@@ -190,7 +83,10 @@ to maintain a large codebase.
 ## License
 
 Copyright (c) 2011-2016 Tony Arcieri. Distributed under the MIT License.
-See LICENSE.txt for further details.
+See [LICENSE.txt] for further details.
+
+Includes libev 4.23. Copyright (c) 2007-2016 Marc Alexander Lehmann.
+Distributed under the BSD license. See [ext/libev/LICENSE] for details.
 
-Includes libev 4.22. Copyright (c) 2007-2015 Marc Alexander Lehmann.
-Distributed under the BSD license. See ext/libev/LICENSE for details.
+[LICENSE.txt]: https://github.com/socketry/nio4r/blob/master/LICENSE.txt
+[ext/libev/LICENSE]: https://github.com/socketry/nio4r/blob/master/ext/libev/LICENSE