nio4r 1.2.1-java → 2.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27ed3f9e4814ea11b179f4852fec22ae987ce176
-  data.tar.gz: 2a5c3b0c1989783fa59580869ce67c95bdb7baad
+  metadata.gz: 2685d0b193772fb648d55b9ce46f6ce0ebffa646
+  data.tar.gz: babb78d3c1e768b192b8b51062ac23eb4d94270e
 SHA512:
-  metadata.gz: f72319ce240707fdab1bccb6d3e5fa242f064f33d781559f3cc461821fc54a584bd9a598efbd676aa1af884dad32c2704e6f0972fa5d678499284bd0078f16e4
-  data.tar.gz: 557a30f1a8f152226e2da665c33d450f0f12031f1c25953c1219d18e8ce95fa0b427cea67359e2cf6229b3c33cf577cb31a69e750469c6b5b5bfedc9347eaa5e
+  metadata.gz: 71ceb314a13ec706fd72168850787bf2dd7942fe66b0cdbbf1d9b5bce4f4977a5dbcd9b4f0c04ab6f8daf3769f4a3e7daebea714c1b609df4371472082f63216
+  data.tar.gz: e16b5359765c62a6fcc443ea26c3bad5e7466b7e3d6c4cc93f8dc2993a872a13887bb3756d1ec6581dfc77a1a1e79798cce960042a830e2b6732c9ff2931c8b0

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

@@ -1,27 +1,28 @@
 language: ruby
 sudo: false
+cache: bundler
+
+bundler_args: --without development
+
+branches:
+  only:
+    - master
 
 rvm:
-  - 2.0.0
-  - 2.1.1
+  - jruby-9.1.6.0 # latest stable
   - 2.2.2
-  - ruby-head
-  - jruby
-  - jruby-head
-  - rbx-2
+  - 2.3.3
+  - 2.4.0
 
 env:
-  - NIO4R_PURE=false
-  - NIO4R_PURE=true
+  global:
+    - JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M"      
+  matrix:
+    - NIO4R_PURE=false
+    - NIO4R_PURE=true
 
 matrix:
   fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-2
-    - rvm: jruby
-      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,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
@@ -5,11 +7,14 @@ gemspec
 gem "jruby-openssl" if defined? JRUBY_VERSION
 
 group :development do
-  gem "rake-compiler"
+  gem "guard-rspec", require: false
+  gem "pry",         require: false
 end
 
-group :test do
-  gem "rspec",     "~> 3.0"
-  gem "rubocop",   "0.36.0"
-  gem "coveralls", require: false
+group :development, :test do
+  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,196 +1,92 @@
-![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:_
 
-nio4r: New IO for Ruby.
+https://github.com/socketry/nio4r/tree/1-x-stable
 
-nio4r provides an abstract, cross-platform stateful I/O selector API for Ruby.
+**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.
 
-The most similar API provided by Ruby today is Kernel.select, however the
-select API requires you to pass in arrays of all of the I/O objects you're
-interested in every time. nio4r provides a more object-oriented API that lets
-you register I/O objects with a selector then handle them when they're selected
-for various types of events.
+[Rails 5]: https://rubygems.org/gems/actioncable
+
+## Projects using nio4r
 
-nio4r is modeled after the Java NIO API, but simplified for ease-of-use.
+* [ActionCable]: Rails 5 WebSocket protocol, uses nio4r for a WebSocket server
+* [Celluloid::IO]: Actor-based concurrency framework, uses nio4r for async I/O
 
-Its goals are:
+[ActionCable]: https://rubygems.org/gems/actioncable
+[Celluloid::IO]: https://github.com/socketry/socketry-io
+
+## 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
 
-[Celluloid::IO](https://github.com/celluloid/celluloid-io) uses nio4r to
-monitor multiple IO objects from a single Celluloid actor.
-
-Supported Platforms
--------------------
-
-nio4r is known to work on the following Ruby implementations:
-
-* MRI/YARV 1.9.3, 2.0.0, 2.1.0
-* JRuby 1.7.x
-* Rubinius 2.x
-* A pure Ruby implementation based on Kernel.select is also provided
-
-Platform notes:
-
-* 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
-
-Usage
------
+## Supported platforms
 
-### Selectors
+* Ruby 2.2.2+
+* Ruby 2.3
+* Ruby 2.4
+* JRuby 9000
 
-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:
-
-```ruby
-require 'nio'
+## Supported backends
 
-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.
+* **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
 
-```ruby
->> reader, writer = IO.pipe
- => [#<IO:0xf30>, #<IO:0xf34>]
->> monitor = selector.register(reader, :r)
- => #<NIO::Monitor:0xfbc>
-```
+## Documentation
 
-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:
+[Please see the nio4r wiki](https://github.com/socketry/nio4r/wiki)
+for more detailed documentation and usage notes:
 
-```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>
-```
+* [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
 
-The main method of importance is NIO::Selector#select, which monitors all
-registered IO objects and returns an array of monitors that are ready.
+[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
 
-```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>]
-```
+See also:
 
-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:
+* [YARD API documentation](http://www.rubydoc.info/gems/nio4r/frames)
 
-```ruby
-ready = selector.select(15) # Wait 15 seconds
-```
+## Non-goals
 
-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.
-
-What nio4r is not
------------------
-
-nio4r is not a full-featured event framework like EventMachine or Cool.io.
+**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.
 
-As of the time of writing, the current implementation is (approximately):
+[EventMachine]: https://github.com/eventmachine/eventmachine
+[Cool.io]: https://coolio.github.io/
 
-* 200 lines of Ruby code
-* 700 lines of "custom" C code (not counting libev)
-* 400 lines of Java code
-
-nio4r is also not a replacement for Kinder Gentler IO (KGIO), a set of
-advanced Ruby IO APIs. At some point in the future nio4r might provide a
-cross-platform implementation that uses KGIO on CRubies, and Java NIO on JRuby,
-however this is not the case today.
-
-License
--------
+## 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