polyphony 0.24 → 0.25

data/test/test_io.rb

@@ -49,33 +49,33 @@ class IOTest < MiniTest::Test
 
       spin { msg = @i.read }
     ].each(&:await)
-    assert_equal(5, count)
-    assert_equal('hello', msg)
+    assert_equal 5, count
+    assert_equal 'hello', msg
   end
 
   def test_that_double_chevron_method_returns_io
-    assert_equal(@o, @o << 'foo')
+    assert_equal @o, @o << 'foo'
 
     @o << 'bar' << 'baz'
     @o.close
-    assert_equal('foobarbaz', @i.read)
+    assert_equal 'foobarbaz', @i.read
   end
 end
 
 class IOClassMethodsTest < MiniTest::Test
   def test_binread
     s = IO.binread(__FILE__)
-    assert_kind_of(String, s)
-    assert(!s.empty?)
-    assert_equal(IO.orig_binread(__FILE__), s)
+    assert_kind_of String, s
+    assert !s.empty?
+    assert_equal IO.orig_binread(__FILE__), s
 
     s = IO.binread(__FILE__, 100)
-    assert_equal(100, s.bytesize)
-    assert_equal(IO.orig_binread(__FILE__, 100), s)
+    assert_equal 100, s.bytesize
+    assert_equal IO.orig_binread(__FILE__, 100), s
 
     s = IO.binread(__FILE__, 100, 2)
-    assert_equal(100, s.bytesize)
-    assert_equal('frozen', s[0..5])
+    assert_equal 100, s.bytesize
+    assert_equal 'frozen', s[0..5]
   end
 
   BIN_DATA = "\x00\x01\x02\x03"
@@ -85,37 +85,38 @@ class IOClassMethodsTest < MiniTest::Test
     FileUtils.rm(fn) rescue nil
 
     len = IO.binwrite(fn, BIN_DATA)
-    assert_equal(4, len)
+    assert_equal 4, len
     s = IO.binread(fn)
-    assert_equal(BIN_DATA, s)
+    assert_equal BIN_DATA, s
   end
 
   def test_foreach
+    skip "IO.foreach is not yet implemented"
     lines = []
     IO.foreach(__FILE__) { |l| lines << l }
-    assert_equal("# frozen_string_literal: true\n", lines[0])
-    assert_equal("end\n", lines[-1])
+    assert_equal "# frozen_string_literal: true\n", lines[0]
+    assert_equal "end\n", lines[-1]
   end
 
   def test_read
     s = IO.read(__FILE__)
-    assert_kind_of(String, s)
+    assert_kind_of String, s
     assert(!s.empty?)
-    assert_equal(IO.orig_read(__FILE__), s)
+    assert_equal IO.orig_read(__FILE__), s
 
     s = IO.read(__FILE__, 100)
-    assert_equal(100, s.bytesize)
-    assert_equal(IO.orig_read(__FILE__, 100), s)
+    assert_equal 100, s.bytesize
+    assert_equal IO.orig_read(__FILE__, 100), s
 
     s = IO.read(__FILE__, 100, 2)
-    assert_equal(100, s.bytesize)
-    assert_equal('frozen', s[0..5])
+    assert_equal 100, s.bytesize
+    assert_equal 'frozen', s[0..5]
   end
 
   def test_readlines
     lines = IO.readlines(__FILE__)
-    assert_equal("# frozen_string_literal: true\n", lines[0])
-    assert_equal("end\n", lines[-1])
+    assert_equal "# frozen_string_literal: true\n", lines[0]
+    assert_equal "end\n", lines[-1]
   end
 
   WRITE_DATA = "foo\nbar קוקו"
@@ -125,9 +126,9 @@ class IOClassMethodsTest < MiniTest::Test
     FileUtils.rm(fn) rescue nil
 
     len = IO.write(fn, WRITE_DATA)
-    assert_equal(WRITE_DATA.bytesize, len)
+    assert_equal WRITE_DATA.bytesize, len
     s = IO.read(fn)
-    assert_equal(WRITE_DATA, s)
+    assert_equal WRITE_DATA, s
   end
 
   def test_popen
@@ -139,7 +140,7 @@ class IOClassMethodsTest < MiniTest::Test
 
     result = nil
     IO.popen('echo "foo"') { |io| result = io.read(8192) }
-    assert_equal("foo\n", result)
+    assert_equal "foo\n", result
   ensure
     timer&.stop
   end
@@ -158,7 +159,7 @@ class IOClassMethodsTest < MiniTest::Test
     end
 
     assert(counter >= 0)
-    assert_equal("foo\n", gets)
+    assert_equal "foo\n", gets
   ensure
     $stdin = orig_stdin
     timer&.stop
@@ -170,7 +171,7 @@ class IOClassMethodsTest < MiniTest::Test
     s = StringIO.new(IO.orig_read(__FILE__))
 
     while (l = s.gets)
-      assert_equal(l, gets)
+      assert_equal l, gets
     end
   ensure
     ARGV.delete __FILE__
@@ -188,7 +189,7 @@ class IOClassMethodsTest < MiniTest::Test
     $stdout = o
 
     puts 'foobar'
-    assert_equal("foobar\n", o.buf)
+    assert_equal "foobar\n", o.buf
   ensure
     $stdout = orig_stdout
   end

data/test/test_kernel.rb

@@ -15,7 +15,7 @@ class KernelTest < MiniTest::Test
     $stdout = o
     system('echo "hello"')
     o.close
-    assert_equal("hello\n", i.read)
+    assert_equal "hello\n", i.read
   ensure
     $stdout = orig_stdout
     timer&.stop
@@ -29,7 +29,7 @@ class KernelTest < MiniTest::Test
     assert(counter >= 2)
 
     result = `echo "hello"`
-    assert_equal("hello\n", result)
+    assert_equal "hello\n", result
   ensure
     timer&.stop
   end

data/test/test_signal.rb

@@ -20,7 +20,7 @@ class SignalTest < MiniTest::Test
       Process.kill(:USR1, Process.pid)
     end
     suspend
-    assert_equal(1, count)
+    assert_equal 1, count
   end
 
   def test_wait_for_signal_api

data/test/test_supervisor.rb

@@ -13,7 +13,7 @@ class SupervisorTest < MiniTest::Test
     assert_equal [:foo], result
   end
 
-  def test_await_multiple_coprocs
+  def test_await_multiple_fibers
     result = Polyphony::Supervisor.new.await { |s|
       (1..3).each { |i|
         s.spin {
@@ -25,7 +25,7 @@ class SupervisorTest < MiniTest::Test
     assert_equal [10, 20, 30], result
   end
 
-  def test_join_multiple_coprocs
+  def test_join_multiple_fibers
     result = Polyphony::Supervisor.new.join { |s|
       (1..3).each { |i|
         s.spin {
@@ -48,24 +48,24 @@ class SupervisorTest < MiniTest::Test
       }
     }
 
-    assert_equal [Polyphony::Coprocess], buffer.map { |v| v.class }.uniq
+    assert_equal [Fiber], buffer.map { |v| v.class }.uniq
   end
 
   def test_supervisor_select
     buffer = []
-    foo_cp = bar_cp = baz_cp = nil
-    result, cp = Polyphony::Supervisor.new.select { |s|
-      foo_cp = s.spin { sleep 0.01; buffer << :foo; :foo }
-      bar_cp = s.spin { sleep 0.02; buffer << :bar; :bar }
-      baz_cp = s.spin { sleep 0.03; buffer << :baz; :baz }
+    foo_f = bar_f = baz_f = nil
+    result, f = Polyphony::Supervisor.new.select { |s|
+      foo_f = s.spin { sleep 0.01; buffer << :foo; :foo }
+      bar_f = s.spin { sleep 0.02; buffer << :bar; :bar }
+      baz_f = s.spin { sleep 0.03; buffer << :baz; :baz }
     }
 
     assert_equal :foo, result
-    assert_equal foo_cp, cp
+    assert_equal foo_f, f
 
     sleep 0.03
-    assert_nil bar_cp.alive?
-    assert_nil baz_cp.alive?
+    assert !bar_f.running?
+    assert !baz_f.running?
     assert_equal [:foo], buffer
   end
 
@@ -137,31 +137,31 @@ class SupervisorTest < MiniTest::Test
   end
 end
 
-class CoprocessExtensionsTest < MiniTest::Test
+class FiberExtensionsTest < MiniTest::Test
   def test_join
-    cp1 = spin { :foo }
-    cp2 = spin { :bar }
-    assert_equal [:foo, :bar], Polyphony::Coprocess.join(cp1, cp2)
+    f1 = spin { :foo }
+    f2 = spin { :bar }
+    assert_equal [:foo, :bar], Fiber.join(f1, f2)
 
-    cp1 = spin { :foo }
-    cp2 = spin { raise 'bar' }
-    result = capture_exception { Polyphony::Coprocess.join(cp1, cp2) }
+    f1 = spin { :foo }
+    f2 = spin { raise 'bar' }
+    result = capture_exception { Fiber.join(f1, f2) }
     assert_kind_of RuntimeError, result
     assert_equal 'bar', result.message
   end
 
   def test_select
-    cp1 = spin { sleep 1; :foo }
-    cp2 = spin { :bar }
-    assert_equal [:bar, cp2], Polyphony::Coprocess.select(cp1, cp2)
+    f1 = spin { sleep 1; :foo }
+    f2 = spin { :bar }
+    assert_equal [:bar, f2], Fiber.select(f1, f2)
 
-    cp1 = spin { :foo }
-    cp2 = spin { sleep 0.01; raise 'bar' }
-    assert_equal [:foo, cp1], Polyphony::Coprocess.select(cp1, cp2)
+    f1 = spin { :foo }
+    f2 = spin { sleep 0.01; raise 'bar' }
+    assert_equal [:foo, f1], Fiber.select(f1, f2)
 
-    cp1 = spin { sleep 1; :foo }
-    cp2 = spin { raise 'bar' }
-    result = capture_exception { Polyphony::Coprocess.select(cp1, cp2) }
+    f1 = spin { sleep 1; :foo }
+    f2 = spin { raise 'bar' }
+    result = capture_exception { Fiber.select(f1, f2) }
     assert_kind_of RuntimeError, result
     assert_equal 'bar', result.message
   end

data/test/test_timer.rb

@@ -11,7 +11,7 @@ class TimerTest < MiniTest::Test
       count += 1
     }
     suspend
-    assert_equal(1, count)
+    assert_equal 1, count
   end
 
   def test_that_repeating_timer_works
@@ -25,7 +25,7 @@ class TimerTest < MiniTest::Test
       }
     }
     suspend
-    assert_equal(3, count)
+    assert_equal 3, count
   end
 
   def test_that_repeating_timer_compensates_for_drift

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: '0.24'
+  version: '0.25'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modulation
@@ -194,13 +194,13 @@ files:
 - docs/technical-overview/faq.md
 - docs/technical-overview/fiber-scheduling.md
 - docs/user-guide/web-server.md
-- examples/core/01-spinning-up-coprocesses.rb
-- examples/core/02-awaiting-coprocesses.rb
+- examples/core/01-spinning-up-fibers.rb
+- examples/core/02-awaiting-fibers.rb
 - examples/core/03-interrupting.rb
-- examples/core/04-no-auto-run.rb
 - examples/core/xx-channels.rb
 - examples/core/xx-deferring-an-operation.rb
 - examples/core/xx-erlang-style-genserver.rb
+- examples/core/xx-extended_fibers.rb
 - examples/core/xx-forking.rb
 - examples/core/xx-move_on.rb
 - examples/core/xx-recurrent-timer.rb
@@ -277,7 +277,6 @@ files:
 - lib/polyphony.rb
 - lib/polyphony/core/cancel_scope.rb
 - lib/polyphony/core/channel.rb
-- lib/polyphony/core/coprocess.rb
 - lib/polyphony/core/exceptions.rb
 - lib/polyphony/core/global_api.rb
 - lib/polyphony/core/resource_pool.rb
@@ -287,6 +286,7 @@ files:
 - lib/polyphony/core/thread_pool.rb
 - lib/polyphony/core/throttler.rb
 - lib/polyphony/extensions/core.rb
+- lib/polyphony/extensions/fiber.rb
 - lib/polyphony/extensions/io.rb
 - lib/polyphony/extensions/openssl.rb
 - lib/polyphony/extensions/socket.rb
@@ -303,7 +303,7 @@ files:
 - test/run.rb
 - test/test_async.rb
 - test/test_cancel_scope.rb
-- test/test_coprocess.rb
+- test/test_fiber.rb
 - test/test_global_api.rb
 - test/test_gyro.rb
 - test/test_io.rb

data/examples/core/04-no-auto-run.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-
-require 'polyphony'
-
-def nap(tag, t)
-  puts "#{Time.now} #{tag} napping for #{t} seconds..."
-  sleep t
-  puts "#{Time.now} #{tag} done napping"
-end
-
-spin { nap(:a, 1) }
-
-# Wait for any coprocess still alive
-suspend

data/lib/polyphony/core/coprocess.rb

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-export_default :Coprocess
-
-import '../extensions/core'
-Exceptions = import './exceptions'
-
-# Encapsulates an asynchronous task
-class Coprocess
-  # inter-coprocess message passing
-  module Messaging
-    def <<(value)
-      if @receive_waiting && @fiber
-        @fiber&.schedule value
-      else
-        @queued_messages ||= []
-        @queued_messages << value
-      end
-      snooze
-    end
-
-    def receive
-      if !@queued_messages || @queued_messages&.empty?
-        wait_for_message
-      else
-        value = @queued_messages.shift
-        snooze
-        value
-      end
-    end
-
-    def wait_for_message
-      Gyro.ref
-      @receive_waiting = true
-      suspend
-    ensure
-      Gyro.unref
-      @receive_waiting = nil
-    end
-  end
-
-  include Messaging
-
-  @@map = {}
-
-  def self.map
-    @@map
-  end
-
-  def self.count
-    @@map.size
-  end
-
-  attr_reader :result, :fiber
-
-  def initialize(fiber = nil, &block)
-    @fiber = fiber
-    @block = block
-  end
-
-  def location
-    @block ? @block.source_location.join(':') : nil
-  end
-
-  def caller
-    @fiber ? @fiber.caller[2..-1] : nil
-  end
-
-  def run
-    @calling_fiber = Fiber.current
-
-    @fiber = Fiber.new(location) { |v| execute(v) }
-    @fiber.schedule
-    @ran = true
-    self
-  end
-
-  def execute(first_value)
-    # The first value passed to the coprocess can be used to stop it before it
-    # is scheduled for the first time
-    raise first_value if first_value.is_a?(Exception)
-
-    @@map[@fiber] = @fiber.coprocess = self
-    @result = @block.call(self)
-  rescue Exceptions::MoveOn => e
-    @result = e.value
-  rescue Exception => e
-    uncaught_exception = true
-    @result = e
-  ensure
-    finish_execution(uncaught_exception)
-  end
-
-  def finish_execution(uncaught_exception)
-    @@map.delete(@fiber)
-    @fiber.coprocess = nil
-    @fiber = nil
-    @awaiting_fiber&.schedule @result
-    @when_done&.()
-
-    return unless uncaught_exception && !@awaiting_fiber
-
-    # if no awaiting fiber, raise any uncaught error by passing it to the
-    # calling fiber, or to the root fiber if the calling fiber
-    calling_fiber_alive = @calling_fiber && @calling_fiber.state != :dead
-    calling_fiber = calling_fiber_alive ? @calling_fiber : Fiber.root
-    calling_fiber.transfer @result
-  end
-
-  def alive?
-    @fiber
-  end
-
-  # Kernel.await expects the given argument / block to be a callable, so #call
-  # in fact waits for the coprocess to finish
-  def await
-    await_coprocess_result
-  ensure
-    # If the awaiting fiber has been transferred an exception, the awaited fiber
-    # might still be running, so we need to stop it
-    @fiber&.schedule(Exceptions::MoveOn.new)
-  end
-  alias_method :join, :await
-
-  def await_coprocess_result
-    run unless @ran
-    if @fiber
-      @awaiting_fiber = Fiber.current
-      suspend
-    else
-      @result
-    end
-  end
-
-  def when_done(&block)
-    @when_done = block
-  end
-
-  def schedule(value = nil)
-    @fiber&.schedule(value)
-  end
-
-  def resume(value = nil)
-    return unless @fiber
-
-    @fiber.schedule(value)
-    snooze
-  end
-
-  def interrupt(value = nil)
-    return unless @fiber
-
-    @fiber.schedule(Exceptions::MoveOn.new(nil, value))
-    snooze
-  end
-  alias_method :stop, :interrupt
-
-  def cancel!
-    return unless @fiber
-
-    @fiber.schedule(Exceptions::Cancel.new)
-    snooze
-  end
-
-  def self.current
-    Fiber.current.coprocess
-  end
-end