polyphony 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62006f0bdd66c2776a252724cf1f842c859a39d8bc150f8f3db839105bfc60b0
-  data.tar.gz: e662adc4addce7d90c5dfd17a635618e6d8164cad911670f60901bac309c767a
+  metadata.gz: 16bd848555e9b517c4114a4324fe65d27ed08b2ac3f638a94c10070f99eb1915
+  data.tar.gz: 96dac9a4e8b5fe09f78ad6ffae157f048fdb499fca3c78028145bffdad45cfbd
 SHA512:
-  metadata.gz: 402eaf9528351b93e8026a7c91492ea367c8279bee389834d9a5b2f4855c10d82f9f1d23749cce1e1f5b38ac7f136001f0ffe6570051261d19e7e25fa6ca5f65
-  data.tar.gz: ed423faa2cfcf852277fc724e232e3836e8bdb0fcd98e009166fee7b8088f6d5db18aea1fa9e97c1fcc519e01c666d6a15fbaa9c87c337559bab04cc7f6957b3
+  metadata.gz: 39dbff6723dfe0e2a9919080d170d16b545081e8f57e8010a7a84402b185c3a7b0dbcb3b11390c854fdeee90f967a8d055d8b4e6adb4c0d4344ac79f7d8a4f94
+  data.tar.gz: cb0a008a4234cab661e8a7e8ed6a70919093d210135c983704e201b043082a8e268ff2d8f11cf755aab64e1118c817ac3287d938282c62d39fe02dd66ef25d19

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+0.17 2019-05-24
+---------------
+
+* Implement IO#read_watcher, IO#write_watcher in C for better performance
+* Implement nonblocking (yielding) versions of Kernel#system, IO.popen,
+  Process.detach, IO#gets IO#puts, other IO singleton methods
+* Add Coprocess#join as alias to Coprocess#await
+* Rename Kernel#spawn to Kernel#coproc
+* Fix encoding of strings read with IO#read, IO#readpartial
+* Fix non-blocking behaviour of IO#read, IO#readpartial, IO#write
+
 0.16 2019-05-22
 ---------------
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.16)
+    polyphony (0.17)
       http-2 (= 0.10.0)
       http_parser.rb (= 0.6.0)
       modulation (= 0.24)

data/README.md

@@ -1,4 +1,4 @@
-# Polyphony - Fiber-Based Concurrency for Ruby
+# Polyphony - lightweight concurrency for Ruby
 
 [INSTALL](#installing-polyphony) |
 [TUTORIAL](#getting-started) |
@@ -70,18 +70,18 @@ The reactor, in turn, may schedule other operations once they can be resumed. In
 that manner, multiple ongoing operations may be processed concurrently.
 
 There are multiple ways to start a concurrent operation, the most common of
-which is `Kernel#spawn`:
+which is `Kernel#coproc`:
 
 ```ruby
 require 'polyphony'
 
-spawn do
+coproc do
   puts "A going to sleep"
   sleep 1
   puts "A woken up"
 end
 
-spawn do
+coproc do
   puts "B going to sleep"
   sleep 1
   puts "B woken up"
@@ -90,7 +90,7 @@ end
 
 In the above example, both `sleep` calls will be executed concurrently, and thus
 the program will take approximately only 1 second to execute. Note the lack of
-any boilerplate relating to concurrency. Each `spawn` block starts a
+any boilerplate relating to concurrency. Each `coproc` block starts a
 *coprocess*, and is executed in sequential manner.
 
 > **Coprocesses - the basic unit of concurrency**: In Polyphony, concurrent
@@ -115,8 +115,8 @@ require 'polyphony'
 
 server = TCPServer.open(1234)
 while client = server.accept
-  # spawn starts a new coprocess on a separate fiber
-  spawn {
+  # coproc starts a new coprocess on a separate fiber
+  coproc {
     while data = client.read rescue nil
       client.write(data)
     end
@@ -129,7 +129,7 @@ This example demonstrates several features of Polyphony:
 - The code uses the native `TCPServer` class from Ruby's stdlib, to setup a TCP
   server. The result of `server.accept` is also a native `TCPSocket` object.
   There are no wrapper classes being used.
-- The only hint of the code being concurrent is the use of `Kernel#spawn`,
+- The only hint of the code being concurrent is the use of `Kernel#coproc`,
   which starts a new coprocess on a dedicated fiber. This allows serving
   multiple clients at once. Whenever a blocking call is issued, such as
   `#accept` or `#read`, execution is *yielded* to the event loop, which will
@@ -257,7 +257,7 @@ Pool = Polyphony::ResourcePool.new(limit: 5) {
 }
 
 1000.times {
-  spawn {
+  coproc {
     Pool.acquire { |db| p db.query('select 1') }
   }
 }
@@ -274,7 +274,7 @@ Pool = Polyphony::ResourcePool.new(limit: 5) {
 }
 
 1000.times {
-  spawn { p Pool.query('select 1') }
+  coproc { p Pool.query('select 1') }
 }
 ```
 
@@ -313,7 +313,7 @@ server = Net.tcp_listen(1234)
 throttler = throttle(rate: 10) # up to 10 times per second
 
 while client = server.accept
-  spawn {
+  coproc {
     throttler.call {
       while data = client.read
         client.write(data)

data/TODO.md

@@ -1,9 +1,13 @@
 # Roadmap:
 
-## 0.17 Full or almost full functionality of `IO` using monkey patching
+## 0.17 Implement non-blocking versions of `IO` API using monkey patching
 
-- testing - check conformance to Ruby `IO` API (as described in the Ruby docs)
-- implement as much as possible in C
+- Don't worry about performance or completeness of behaviour
+- Related global functions such as:
+  - `Kernel#system`
+  - `IO.popen`
+- testing - check conformance to Ruby `IO` API (arguments and return values as
+  described in the Ruby docs)
 
 ## 0.18 Working net/http, httparty
 
@@ -20,14 +24,19 @@
 
 ## 0.20 Working Rails application
 
+- app with database access (postgresql)
 - benchmarks!
 
-## 0.21 Testing
+## 0.21 Support for multi-threading
+
+- Separate event loop for each thread
+
+## 0.22 Testing
 
 - test thread / thread_pool modules
 - report test coverage
 
-## 0.22 Documentation
+## 0.23 Documentation
 
 # DNS
 

data/examples/core/channel_echo.rb

@@ -14,9 +14,9 @@ end
 
 chan1, chan2 = Polyphony::Channel.new, Polyphony::Channel.new
 
-echoer = spawn { echo(chan1, chan2) }
+echoer = coproc { echo(chan1, chan2) }
 
-spawn do
+coproc do
   puts "start receiver"
   while msg = chan2.receive
     puts msg
@@ -26,7 +26,7 @@ ensure
   puts "receiver stopped"
 end
 
-$main = spawn do
+$main = coproc do
   t0 = Time.now
   puts "send hello"
   chan1 << "hello"

data/examples/core/enumerator.rb

@@ -5,7 +5,7 @@ require 'polyphony'
 
 enum = [1,2,3].each
 
-spawn do
+coproc do
   while e = enum.next rescue nil
     puts e
     sleep 1

data/examples/core/fork.rb

@@ -8,7 +8,7 @@ puts "parent pid: #{Process.pid}"
 pid = Polyphony.fork do
   puts "child pid: #{Process.pid}"
 
-  spawn do
+  coproc do
     puts "child going to sleep 1..."
     sleep 1
     puts "child woke up 1"

data/examples/core/genserver.rb

@@ -5,7 +5,7 @@ require 'polyphony'
 
 class GenServer
   def self.start(receiver, *args)
-    coprocess = spawn do
+    coprocess = coproc do
       state = receiver.initial_state(*args)
       loop do
         msg = receive

data/examples/core/lock.rb

@@ -14,6 +14,6 @@ def loop_it(number, lock)
 end
 
 lock = Polyphony::Sync::Mutex.new
-spawn { loop_it(1, lock) }
-spawn { loop_it(2, lock) }
-spawn { loop_it(3, lock) }
+coproc { loop_it(1, lock) }
+coproc { loop_it(2, lock) }
+coproc { loop_it(3, lock) }

data/examples/core/multiple_spawn.rb

@@ -3,13 +3,13 @@
 require 'bundler/setup'
 require 'polyphony'
 
-spawn do
+coproc do
   puts "1 >"
   sleep(1)
   puts "1 <"
 end
 
-spawn do
+coproc do
   puts "2 >"
   sleep(1)
   puts "2 <"

data/examples/core/nested_async.rb

@@ -3,7 +3,7 @@
 require 'bundler/setup'
 require 'polyphony'
 
-spawn do
+coproc do
   puts "going to sleep"
   result = async do
     async do

data/examples/core/nested_multiple_spawn.rb

@@ -3,14 +3,14 @@
 require 'bundler/setup'
 require 'polyphony'
 
-spawn do
-  spawn do
+coproc do
+  coproc do
     puts "1 >"
     sleep(1)
     puts "1 <"
   end
 
-  spawn do
+  coproc do
     puts "2 >"
     sleep(1)
     puts "2 <"

data/examples/core/resource.rb

@@ -21,7 +21,7 @@ async def user(number)
 end
 
 100.times do |x|
-  spawn user(x)
+  coproc user(x)
 end
 
 t0 = Time.now

data/examples/core/resource_cancel.rb

@@ -26,7 +26,7 @@ def user(number)
 end
 
 6.times do |x|
-  spawn { user(x) }
+  coproc { user(x) }
 end
 
 t0 = Time.now

data/examples/core/resource_delegate.rb

@@ -25,7 +25,7 @@ async def meet(number)
   end
 end
 
-3.times { |x| spawn meet(x) }
+3.times { |x| coproc meet(x) }
 
 t0 = Time.now
 every(10) { puts "uptime: #{Time.now - t0}" }

data/examples/core/sleep_spawn.rb

@@ -3,14 +3,14 @@
 require 'bundler/setup'
 require 'polyphony'
 
-spawn {
+coproc {
   10.times { |i|
     sleep 0.1;
     p i
   }
 }
 
-spawn {
+coproc {
   puts "going to sleep..."
   sleep 1
   puts "woke up"

data/examples/core/spawn.rb

@@ -9,6 +9,6 @@ def my_sleep(t)
   puts "woke up"
 end
 
-spawn do
+coproc do
   async { my_sleep(1) }.await
 end

data/examples/core/spawn_cancel.rb

@@ -3,7 +3,7 @@
 require 'bundler/setup'
 require 'polyphony'
 
-spawn do
+coproc do
   puts "going to sleep..."
   cancel_after(1) do
     async {

data/examples/core/spawn_error.rb

@@ -9,11 +9,11 @@ def error(t)
   raise "hello #{t}"
 end
 
-def spawn_with_error
-  spawn { error(2) }
+def coproc_with_error
+  coproc { error(2) }
 end
 
-spawn do
+coproc do
   error(1)
 rescue => e
   e.cleanup_backtrace
@@ -23,6 +23,6 @@ rescue => e
   puts
 end
 
-spawn_with_error
+coproc_with_error
 
-puts "done spawning"
+puts "done coprocing"

data/examples/core/supervisor.rb

@@ -11,10 +11,10 @@ end
 
 puts "#{Time.now} waiting..."
 supervise do |s|
-  s.spawn my_sleep(1)
-  s.spawn my_sleep(2)
-  s.spawn my_sleep(3)
-  s.spawn {
+  s.coproc my_sleep(1)
+  s.coproc my_sleep(2)
+  s.coproc my_sleep(3)
+  s.coproc {
     puts "fiber count: #{Polyphony::FiberPool.size}"
   }
 end

data/examples/core/supervisor_with_cancel_scope.rb

@@ -14,9 +14,9 @@ puts "#{Time.now} going to sleep..."
 move_on_after(0.5) do
   supervise do |s|
     puts "supervise block"
-    s.spawn my_sleep(1)
-    s.spawn my_sleep(2)
-    s.spawn my_sleep(3)
+    s.coproc my_sleep(1)
+    s.coproc my_sleep(2)
+    s.coproc my_sleep(3)
   end
   puts "supervisor done"
 end

data/examples/core/supervisor_with_error.rb

@@ -8,12 +8,12 @@ async def my_sleep(t)
   raise "blah"
 end
 
-spawn do
+coproc do
   puts "#{Time.now} going to sleep..."
   supervise do |s|
-    s.spawn my_sleep(1)
-    s.spawn my_sleep(2)
-    s.spawn my_sleep(3)
+    s.coproc my_sleep(1)
+    s.coproc my_sleep(2)
+    s.coproc my_sleep(3)
   end
 rescue => e
   puts "exception from supervisor: #{e}"

data/examples/core/supervisor_with_manual_move_on.rb

@@ -12,13 +12,13 @@ end
 puts "#{Time.now} going to sleep..."
 result = supervise do |s|
   fiber = Fiber.current
-  spawn do
+  coproc do
     sleep(0.5)
     puts "stopping supervisor..."
     s.stop!
   end
-  s.spawn my_sleep(1)
-  s.spawn my_sleep(2)
-  s.spawn my_sleep(3)
+  s.coproc my_sleep(1)
+  s.coproc my_sleep(2)
+  s.coproc my_sleep(3)
 end
 puts "#{Time.now} woke up with #{result.inspect}"

data/examples/core/thread.rb

@@ -18,8 +18,8 @@ end
 
 def threaded
   t0 = Time.now
-  data = Polyphony::Thread.spawn { lengthy_op }.await
-  X.times { Polyphony::Thread.spawn { lengthy_op }.await }
+  data = Polyphony::Thread.coproc { lengthy_op }.await
+  X.times { Polyphony::Thread.coproc { lengthy_op }.await }
   puts "read threaded #{data.bytesize} bytes (#{Time.now - t0}s)"
 end
 

data/examples/core/thread_cancel.rb

@@ -13,10 +13,10 @@ def lengthy_op
   acc / count
 end
 
-spawn do
+coproc do
   t0 = Time.now
   cancel_after(0.01) do
-    data = Polyphony::Thread.spawn { lengthy_op }.await
+    data = Polyphony::Thread.coproc { lengthy_op }.await
     puts "read #{data.bytesize} bytes (#{Time.now - t0}s)"
   end
 rescue Exception => e