nio4r 0.1.0-java

data/lib/nio.rb

@@ -0,0 +1,30 @@
+require 'thread'
+require 'nio/version'
+
+# New I/O for Ruby
+module NIO
+  # NIO implementation, one of the following (as a string):
+  # * select: in pure Ruby using Kernel.select
+  # * libev: as a C extension using libev
+  # * java: using Java NIO
+  def self.engine; ENGINE end
+end
+
+if ENV["NIO4R_PURE"]
+  require 'nio/monitor'
+  require 'nio/selector'
+  NIO::ENGINE = 'select'
+else
+  if defined?(JRUBY_VERSION)
+    require 'java'
+    require 'nio/jruby/monitor'
+    require 'nio/jruby/selector'
+    NIO::ENGINE = 'java'
+  else
+    require 'nio4r_ext'
+    NIO::ENGINE = 'libev'
+  end
+end
+
+# TIMTOWTDI!!!
+Nio = NIO

data/nio4r.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nio/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tony Arcieri"]
+  gem.email         = ["tony.arcieri@gmail.com"]
+  gem.description   = "New IO for Ruby"
+  gem.summary       = "NIO provides a high performance selector API for monitoring IO objects"
+  gem.homepage      = "https://github.com/tarcieri/nio4r"
+  gem.platform      = "java"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "nio4r"
+  gem.require_paths = ["lib"]
+  gem.version       = NIO::VERSION
+  #gem.extensions    = ["ext/nio4r/extconf.rb"]
+
+  gem.add_development_dependency "rake-compiler", "~> 0.7.9"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", ">= 2.7.0"
+end

data/spec/nio/monitor_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe NIO::Monitor do
+  let :readable_pipe do
+    pipe, peer = IO.pipe
+    peer << "data"
+    pipe
+  end
+
+  # let :unreadable_pipe do
+  #   pipe, _ = IO.pipe
+  #   pipe
+  # end
+
+  let :selector do
+    NIO::Selector.new
+  end
+
+  # Monitors are created by registering IO objects or channels with a selector
+  subject { selector.register(readable_pipe, :r) }
+
+  it "knows its interests" do
+    subject.interests.should == :r
+  end
+
+  it "stores arbitrary values" do
+    subject.value = 42
+    subject.value.should == 42
+  end
+
+  it "closes" do
+    subject.should_not be_closed
+    subject.close
+    subject.should be_closed
+  end
+end

data/spec/nio/selector_spec.rb

@@ -0,0 +1,197 @@
+require 'spec_helper'
+
+# Timeouts should be at least this precise (in seconds) to pass the tests
+# Typical precision should be better than this, but if it's worse it will fail
+# the tests
+TIMEOUT_PRECISION = 0.1
+
+describe NIO::Selector do
+  it "monitors IO objects" do
+    pipe, _ = IO.pipe
+
+    monitor = subject.register(pipe, :r)
+    monitor.should_not be_closed
+  end
+
+  it "knows which IO objects are registered" do
+    reader, writer = IO.pipe
+    subject.register(reader, :r)
+
+    subject.should be_registered(reader)
+    subject.should_not be_registered(writer)
+  end
+
+  it "deregisters IO objects" do
+    pipe, _ = IO.pipe
+
+    subject.register(pipe, :r)
+    monitor = subject.deregister(pipe)
+    subject.should_not be_registered(pipe)
+    monitor.should be_closed
+  end
+
+  context "select" do
+    it "waits for a timeout when selecting" do
+      reader, writer = IO.pipe
+      monitor = subject.register(reader, :r)
+
+      payload = "hi there"
+      writer << payload
+
+      timeout = 0.5
+      started_at = Time.now
+      subject.select(timeout).should include monitor
+      (Time.now - started_at).should be_within(TIMEOUT_PRECISION).of(0)
+      reader.read_nonblock(payload.size)
+
+      started_at = Time.now
+      subject.select(timeout).should be_nil
+      (Time.now - started_at).should be_within(TIMEOUT_PRECISION).of(timeout)
+    end
+
+    it "wakes up if signaled to from another thread" do
+      pipe, _ = IO.pipe
+      subject.register(pipe, :r)
+
+      thread = Thread.new do
+        started_at = Time.now
+        subject.select.should be_nil
+        Time.now - started_at
+      end
+
+      timeout = 0.1
+      sleep timeout
+      subject.wakeup
+
+      thread.value.should be_within(TIMEOUT_PRECISION).of(timeout)
+    end
+  end
+
+  it "closes" do
+    subject.close
+    subject.should be_closed
+  end
+
+  context "selectables" do
+    shared_context "an NIO selectable" do
+      it "selects for read readiness" do
+        waiting_monitor = subject.register(unreadable_subject, :r)
+        ready_monitor   = subject.register(readable_subject, :r)
+
+        ready_monitors = subject.select
+        ready_monitors.should include ready_monitor
+        ready_monitors.should_not include waiting_monitor
+      end
+
+      it "selects for write readiness" do
+        waiting_monitor = subject.register(unwritable_subject, :w)
+        ready_monitor   = subject.register(writable_subject, :w)
+
+        ready_monitors = subject.select(0.1)
+
+        ready_monitors.should include ready_monitor
+        ready_monitors.should_not include waiting_monitor
+      end
+    end
+
+    context "IO.pipe" do
+      let :readable_subject do
+        pipe, peer = IO.pipe
+        peer << "data"
+        pipe
+      end
+
+      let :unreadable_subject do
+        pipe, _ = IO.pipe
+        pipe
+      end
+
+      let :writable_subject do
+        _, pipe = IO.pipe
+        pipe
+      end
+
+      let :unwritable_subject do
+        reader, pipe = IO.pipe
+
+        begin
+          pipe.write_nonblock "JUNK IN THE TUBES"
+          _, writers = select [], [pipe], [], 0
+        rescue Errno::EPIPE
+          break
+        end while writers and writers.include? pipe
+
+        pipe
+      end
+
+      it_behaves_like "an NIO selectable"
+    end
+
+    context TCPSocket do
+      let(:tcp_port) { 12345 }
+
+      let :readable_subject do
+        server = TCPServer.new("localhost", tcp_port)
+        sock = TCPSocket.open("localhost", tcp_port)
+        peer = server.accept
+        peer << "data"
+        sock
+      end
+
+      let :unreadable_subject do
+        TCPServer.new("localhost", tcp_port + 1)
+        TCPSocket.open("localhost", tcp_port + 1)
+      end
+
+      let :writable_subject do
+        TCPServer.new("localhost", tcp_port + 2)
+        TCPSocket.open("localhost", tcp_port + 2)
+      end
+
+      let :unwritable_subject do
+        server = TCPServer.new("localhost", tcp_port + 3)
+        sock = TCPSocket.open("localhost", tcp_port + 3)
+        peer = server.accept
+
+        begin
+          sock.write_nonblock "JUNK IN THE TUBES"
+          _, writers = select [], [sock], [], 0
+        end while writers and writers.include? sock
+
+        sock
+      end
+
+      it_behaves_like "an NIO selectable"
+    end
+
+    context UDPSocket do
+      let(:udp_port) { 23456 }
+
+      let :readable_subject do
+        sock = UDPSocket.new
+        sock.bind('localhost', udp_port)
+
+        peer = UDPSocket.new
+        peer.send("hi there", 0, 'localhost', udp_port)
+
+        sock
+      end
+
+      let :unreadable_subject do
+        sock = UDPSocket.new
+        sock.bind('localhost', udp_port + 1)
+        sock
+      end
+
+      let :writable_subject do
+        pending "come up with a writable UDPSocket example"
+      end
+
+      let :unwritable_subject do
+        pending "come up with a UDPSocket that's blocked on writing"
+      end
+
+      it_behaves_like "an NIO selectable"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'nio'

data/tasks/extension.rake

@@ -0,0 +1,10 @@
+require 'rake/extensiontask'
+
+if defined?(JRUBY_VERSION)
+  # Don't build the native extension on JRuby since it uses native Java NIO
+  task :compile
+else
+  Rake::ExtensionTask.new('nio4r_ext') do |ext|
+    ext.ext_dir = 'ext/nio4r'
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+RSpec::Core::RakeTask.new(:rcov) do |task|
+    task.rcov = true
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: nio4r
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: java
+authors:
+- Tony Arcieri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: &70326293926580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.9
+  type: :development
+  prerelease: false
+  version_requirements: *70326293926580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70326293925820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70326293925820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70326293924680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70326293924680
+description: New IO for Ruby
+email:
+- tony.arcieri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/libev/Changes
+- ext/libev/LICENSE
+- ext/libev/README
+- ext/libev/README.embed
+- ext/libev/ev.c
+- ext/libev/ev.h
+- ext/libev/ev_epoll.c
+- ext/libev/ev_kqueue.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/libev/test_libev_win32.c
+- ext/nio4r/extconf.rb
+- ext/nio4r/libev.h
+- ext/nio4r/monitor.c
+- ext/nio4r/nio4r.h
+- ext/nio4r/nio4r_ext.c
+- ext/nio4r/selector.c
+- lib/nio.rb
+- lib/nio/jruby/monitor.rb
+- lib/nio/jruby/selector.rb
+- lib/nio/monitor.rb
+- lib/nio/selector.rb
+- lib/nio/version.rb
+- nio4r.gemspec
+- spec/nio/monitor_spec.rb
+- spec/nio/selector_spec.rb
+- spec/spec_helper.rb
+- tasks/extension.rake
+- tasks/rspec.rake
+homepage: https://github.com/tarcieri/nio4r
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: NIO provides a high performance selector API for monitoring IO objects
+test_files:
+- spec/nio/monitor_spec.rb
+- spec/nio/selector_spec.rb
+- spec/spec_helper.rb