lightio 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9a17b0dab156ad387faf4b53a3688a8f92c86a8
-  data.tar.gz: a266e67454df145079d044db7da58e69e7093c3a
+  metadata.gz: 2da560fd469b39e6d55ee4acbe7ef0bae81602ae
+  data.tar.gz: 665f6fc976e45793695b3daa53810096f7db88a6
 SHA512:
-  metadata.gz: b016a8993bd4527250104ba72b97b7a95599d6f47986cc8f65e964a0d792976ad68b7d53e24c9881f52e851641f62c23e3decec84b21699e9a5a0a8c8042b4db
-  data.tar.gz: 64f5822c5e76447125e8ef795444fc8fe94841700e23e55eb475083f25cad527b9d0d89f8610e3c7da4b32b3d3a4a16bacfc83f81d78f1cd3a77cd7a60cc4579
+  metadata.gz: b1dbaf889b0b2649f110786e75aba70b42a02c0b887f3c9e5aff27bc5ee8049ffaec5ca911765492ddbff05ca24e773d0dcbff6859e05b40f1e64b571f0bad8c
+  data.tar.gz: e3bf2ff085faf5c582d6e57be7c9aff14a144f614b259720c86663d4fa71f23da895499152d4746fe5f28212984c0367520e2d0c9e06adfb8fb04aeb3461908c

data/.travis.yml

@@ -2,9 +2,9 @@ sudo: false
 language: ruby
 rvm:
   - jruby-9.1.15.0 # latest stable
-  - 2.2.7
   - 2.3.4
   - 2.4.1
+  - 2.5.0
   - ruby-head
 
 env:
@@ -16,4 +16,5 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-9.1.15.0
+    - rvm: 2.5.0
   fast_finish: true

data/Gemfile

@@ -5,6 +5,12 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in lightio.gemspec
 gemspec
 
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+end
+
 group :test do
   gem 'coveralls', require: false
 end

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    lightio (0.2.2)
-      nio4r (~> 2.1)
+    lightio (0.3.0)
+      nio4r (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.1)
     coveralls (0.8.21)
       json (>= 1.8, < 3)
       simplecov (~> 0.14.1)
@@ -15,9 +16,46 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.1.5)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     json (2.1.0)
-    nio4r (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.8.2)
+    nenv (0.3.0)
+    nio4r (2.2.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.1.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -31,11 +69,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    slop (3.6.0)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.19.4)
@@ -47,6 +88,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   coveralls
+  guard
+  guard-bundler
+  guard-rspec
   lightio!
   rake (~> 10.0)
   rspec (~> 3.0)

data/Guardfile

@@ -0,0 +1,10 @@
+directories %w(. lib spec) \
+ .select {|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec, all_after_pass: false, all_on_start: false, failed_mode: :keep, cmd: 'bundle exec rspec' do
+  watch(%r{^(lib|spec)/(.+?)(_spec)?\.rb}) {|m| "spec/#{m[2]}_spec.rb"}
+end

data/README.md

@@ -38,7 +38,7 @@ Or install it yourself as:
 The following documentations is also usable:
 
 * [Basic usage](https://github.com/socketry/lightio/wiki/Basic-Usage)
-* [YARD documentation](http://www.rubydoc.info/gems/lightio/frames)
+* [YARD documentation](http://www.rubydoc.info/github/socketry/lightio/master)
 * [Examples](/examples)
 
 ## Discussion

data/bin/_guard-core

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/guard

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/lib/lightio/core/backend/nio.rb

@@ -55,7 +55,7 @@ module LightIO::Core
         @running = false
         @timers = Timers.new
         @callbacks = []
-        @selector = ::NIO::Selector.new
+        @selector = ::NIO::Selector.new(env_backend)
       end
 
       def run
@@ -98,6 +98,15 @@ module LightIO::Core
         raise
       end
 
+      def backend
+        @selector.backend
+      end
+
+      def env_backend
+        key = 'LIGHTIO_BACKEND'.freeze
+        ENV.has_key?(key) ? ENV[key].to_sym : nil
+      end
+
       private
 
       def run_timers
@@ -112,7 +121,10 @@ module LightIO::Core
       end
 
       def run_callbacks
-        while (callback = @callbacks.shift)
+        # prevent 'add new callbacks' during callback call, new callbacks will run in next turn
+        callbacks = @callbacks
+        @callbacks = []
+        while (callback = callbacks.shift)
           callback.call
         end
       end

data/lib/lightio/core/beam.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module LightIO::Core
   # Beam is light-weight executor, provide thread-like interface
   #
@@ -20,6 +22,9 @@ module LightIO::Core
     # special class for simulate Thread#raise for Beam
     class BeamError
       attr_reader :error, :parent
+      extend Forwardable
+
+      def_delegators :@error, :message, :backtrace
 
       def initialize(error)
         @error = error
@@ -27,6 +32,9 @@ module LightIO::Core
       end
     end
 
+    attr_reader :error
+    attr_accessor :on_dead
+
     # Create a new beam
     #
     # Beam is light-weight executor, provide thread-like interface
@@ -72,9 +80,9 @@ module LightIO::Core
     #
     # @param [Numeric]  limit wait limit seconds if limit > 0, return nil if beam still alive, else return beam self
     # @return [Beam, nil]
-    def join(limit=0)
+    def join(limit=nil)
       # try directly get result
-      if !alive? || limit <= 0
+      if !alive? || limit.nil? || limit <= 0
         # call value to raise error
         value
         return self
@@ -106,10 +114,18 @@ module LightIO::Core
 
     # Fiber not provide raise method, so we have to simulate one
     # @param [BeamError]  error currently only support raise BeamError
-    def raise(error)
-      super unless error.is_a?(BeamError)
+    def raise(error, message=nil, backtrace=nil)
+      unless error.is_a?(BeamError)
+        message ||= error.respond_to?(:message) ? error.message : nil
+        backtrace ||= error.respond_to?(:backtrace) ? error.backtrace : nil
+        super(error, message, backtrace)
+      end
       self.parent = error.parent if error.parent
-      raise error.error
+      if Beam.current == self
+        raise(error.error, message, backtrace)
+      else
+        @error ||= error
+      end
     end
 
     class << self
@@ -130,6 +146,7 @@ module LightIO::Core
     # mark beam as dead
     def dead
       @alive = false
+      on_dead.call(self) if on_dead
     end
 
     # Beam transfer back to parent after schedule

data/lib/lightio/core/ioloop.rb

@@ -1,36 +1,21 @@
 require 'lightio/core/backend/nio'
+require 'forwardable'
+
 module LightIO::Core
   # IOloop like a per-threaded EventMachine (cause fiber cannot resume cross threads)
   #
   # IOloop handle io waiting and schedule beams, user do not supposed to directly use this class
   class IOloop
 
+    RAW_THREAD = ::Thread
+
     def initialize
       @fiber = Fiber.new {run}
       @backend = Backend::NIO.new
     end
 
-    # should never invoke explicitly
-    def run
-      # start io loop and never return...
-      @backend.run
-    end
-
-    def add_timer(timer)
-      @backend.add_timer(timer)
-    end
-
-    def add_callback(&blk)
-      @backend.add_callback(&blk)
-    end
-
-    def add_io_wait(io, interests, &blk)
-      @backend.add_io_wait(io, interests, &blk)
-    end
-
-    def cancel_io_wait(io)
-      @backend.cancel_io_wait(io)
-    end
+    extend Forwardable
+    def_delegators :@backend, :run, :add_timer, :add_callback, :add_io_wait, :cancel_io_wait, :backend
 
     # Wait a watcher, watcher can be a timer or socket.
     # see LightIO::Watchers module for detail
@@ -44,15 +29,18 @@ module LightIO::Core
       # wait until watcher is ok
       # then do work
       response_id, err = future.value
+      current_beam = LightIO::Core::Beam.current
       if response_id != id
-        raise InvalidTransferError, "expect #{id}, but get #{result}"
+        raise LightIO::InvalidTransferError, "expect #{id}, but get #{response_id}"
       elsif err
         # if future return a err
         # simulate Thread#raise to Beam , that we can shutdown beam blocking by socket accepting
         # transfer back to which beam occur this err
         # not sure this is a right way to do it
-        LightIO::Core::Beam.current.raise(err)
+        current_beam.raise(err) if current_beam.is_a?(LightIO::Core::Beam)
       end
+      # check beam error after wait
+      current_beam.send(:check_and_raise_error) if current_beam.is_a?(LightIO::Core::Beam)
     end
 
     def transfer
@@ -63,10 +51,10 @@ module LightIO::Core
       # return current ioloop or create new one
       def current
         key = :"lightio.ioloop"
-        unless Thread.current.thread_variable?(key)
-          Thread.current.thread_variable_set(key, IOloop.new)
+        unless RAW_THREAD.current.thread_variable?(key)
+          RAW_THREAD.current.thread_variable_set(key, IOloop.new)
         end
-        Thread.current.thread_variable_get(key)
+        RAW_THREAD.current.thread_variable_get(key)
       end
     end
   end

data/lib/lightio/core/light_fiber.rb

@@ -6,10 +6,24 @@ module LightIO::Core
   # SHOULD NOT BE USED DIRECTLY
   class LightFiber < Fiber
     attr_reader :ioloop
+    attr_accessor :on_transfer
+
+    ROOT_FIBER = Fiber.current
 
     def initialize(ioloop: IOloop.current, &blk)
       @ioloop = ioloop
       super(&blk)
     end
+
+    def transfer
+      on_transfer.call(LightFiber.current, self) if on_transfer
+      super
+    end
+
+    class << self
+      def is_root?(fiber)
+        ROOT_FIBER == fiber
+      end
+    end
   end
 end

data/lib/lightio/library/io.rb

@@ -4,10 +4,7 @@ module LightIO::Library
     include LightIO::Wrap::IOWrapper
     wrap ::IO
 
-    extend Forwardable
-    def_delegators :@io_watcher, :wait, :wait_readable, :wait_writable
-
-    wrap_blocking_methods :read, :write, exception_symbol: false
+    wrap_blocking_methods :read, :write
 
     alias_method :<<, :write
 
@@ -16,23 +13,88 @@ module LightIO::Library
       (outbuf ||= "").clear
       loop do
         readlen = length.nil? ? 4096 : length - outbuf.size
-        begin
-          outbuf << wait_nonblock(:read_nonblock, readlen, exception_symbol: false)
+        if (data = wait_nonblock(:read_nonblock, readlen))
+          outbuf << data
           if length == outbuf.size
             return outbuf
           end
-        rescue EOFError
-          return outbuf
+        else
+          return length.nil? ? '' : nil
         end
       end
     end
 
     def readpartial(maxlen, outbuf=nil)
       (outbuf ||= "").clear
-      outbuf << wait_nonblock(:read_nonblock, maxlen, exception_symbol: false)
+      if (data = wait_nonblock(:read_nonblock, maxlen))
+        outbuf << data
+      else
+        raise EOFError, 'end of file reached'
+      end
       outbuf
     end
 
+    def getbyte
+      read(1)
+    end
+
+    def getc
+      wait_readable
+      @io.getc
+    end
+
+    def readline(*args)
+      line = gets(*args)
+      raise EOFError, 'end of file reached' if line.nil?
+      line
+    end
+
+    def readlines(*args)
+      result = []
+      until eof?
+        result << readline(*args)
+      end
+      result
+    end
+
+    def readchar
+      c = getc
+      raise EOFError, 'end of file reached' if c.nil?
+      c
+    end
+
+    def readbyte
+      b = getbyte
+      raise EOFError, 'end of file reached' if b.nil?
+      b
+    end
+
+    def eof
+      wait_readable
+      @io.eof?
+    end
+
+    alias eof? eof
+
+    def gets(*args)
+      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0..2)" if args.size > 2
+      return nil if eof?
+      sep = $/
+      if args[0].is_a?(Numeric)
+        limit = args.shift
+      else
+        sep = args.shift if args.size > 0
+        limit = args.shift if args.first.is_a?(Numeric)
+      end
+      s = ''
+      while (c = getc)
+        s << c
+        break if limit && s.size == limit
+        break if c == sep
+      end
+      $_ = s
+    end
+
     def close(*args)
       # close watcher before io closed
       @io_watcher.close
@@ -43,6 +105,19 @@ module LightIO::Library
       self
     end
 
+    private
+    def wait_readable
+      # if IO is already readable, continue wait_readable may block it forever
+      # so use getbyte detect this situation
+      # Maybe move getc and gets to thread pool is a good idea
+      b = getbyte
+      if b
+        ungetbyte(b)
+        return
+      end
+      @io_watcher.wait_readable
+    end
+
     class << self
       def open(*args)
         io = self.new(*args)
@@ -65,7 +140,7 @@ module LightIO::Library
       end
 
       def select(read_fds, write_fds=nil, _except_fds=nil, timeout=nil)
-        timer = 0
+        timer = timeout && Time.now
         # run once ioloop
         LightIO.sleep 0
         loop do
@@ -73,10 +148,8 @@ module LightIO::Library
           w_fds = (write_fds || []).select {|fd| fd.closed? ? raise(IOError, 'closed stream') : fd.instance_variable_get(:@io_watcher).writable?}
           e_fds = []
           if r_fds.empty? && w_fds.empty?
-            interval = 0.1
-            LightIO.sleep interval
-            timer += interval
-            if timeout && timer > timeout
+            LightIO.sleep 0
+            if timeout && Time.now - timer > timeout
               return nil
             end
           else

data/lib/lightio/library/kernel_ext.rb

@@ -7,8 +7,8 @@ module LightIO::Library
         LightIO::IOloop.current.transfer
       end
       duration = duration[0]
-      if duration.zero? && LightIO::Beam.current.respond_to?(:pass)
-        LightIO::Beam.current.pass
+      if duration.zero?
+        LightIO::Beam.pass
         return
       end
       timer = LightIO::Watchers::Timer.new duration

data/lib/lightio/library/mutex.rb

@@ -0,0 +1,62 @@
+require_relative 'queue'
+
+module LightIO::Library
+  class Thread
+    class Mutex
+      def initialize
+        @queue = Queue.new
+        @queue << true
+        @locked_thread = nil
+      end
+
+      def lock
+        raise ThreadError, "deadlock; recursive locking" if owner?
+        @queue.pop
+        @locked_thread = LightIO::Thread.current
+        self
+      end
+
+      def unlock
+        raise ThreadError, "Attempt to unlock a mutex which is not locked" unless owner?
+        @locked_thread = nil
+        @queue << true
+        self
+      end
+
+      def locked?
+        !@locked_thread.nil?
+      end
+
+      def owner?
+        @locked_thread == LightIO::Thread.current
+      end
+
+      def sleep(timeout=nil)
+        unlock
+        LightIO.sleep(timeout)
+        lock
+      end
+
+      def synchronize
+        raise ThreadError, 'must be called with a block' unless block_given?
+        lock
+        begin
+          yield
+        ensure
+          unlock
+        end
+      end
+
+      def try_lock
+        if @locked_thread.nil?
+          lock
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+
+  Mutex = Thread::Mutex
+end

data/lib/lightio/library/queue.rb

@@ -27,10 +27,10 @@ module LightIO::Library
     # Pushes the given +object+ to the queue.
     def push(object)
       raise ClosedQueueError, "queue closed" if @close
-      if @waiters.any?
+      if (waiter = @waiters.shift)
         future = LightIO::Future.new
         LightIO::IOloop.current.add_callback {
-          @waiters.shift.transfer(object)
+          waiter.transfer(object)
           future.transfer
         }
         future.value