polyphony 0.22 → 0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27942af70470ad8751268c35230cf822e5b671305450edc19dc4b998409ca1b2
-  data.tar.gz: 94393e31d741b484e188730496980fd5fc44fd4ff632abf8abe7e9ba3117b71f
+  metadata.gz: 42975a9e638525d2264fbddea88ee0756fb7e7dbc5c0585c033b71a06a27711c
+  data.tar.gz: 2c233b91c02d60e1dc40fbacb1dbade17c591a9ddede854e71dc7b2a840dcfd0
 SHA512:
-  metadata.gz: 2d97e95fd9b8d5c9bf8f3224652c88f29a8e5e930918819647a4e66f2d09be6c190c43c88cf202c3f3211b41faedf5afc0c1c67922fe6e31e2453750b0566777
-  data.tar.gz: 4f86964e496dcc418ed23f45cffe88db4d93489dc6ab7616157456f309f117e1fe3f4e12a2edc06347ee3b7ca3af76f2e2ec461499c5bf05caf30eea281bb6bd
+  metadata.gz: 339373f341a10fa68bec7d39588407519c12e17f9b02f774b9179af9b682512c156aa254cac116d4f60d1528e4dae21cfe220e71bf998787c0f1b55c244ef959
+  data.tar.gz: 429a5960bbc3a38d23282ab1a8339b1ae556832fd098e34ae1a63fca36f4bc9f15f8996a715c70ac3363e01ea1858c2cf9de6b9296e90cf7f6a6c8a79f42c48c

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+0.23 2020-01-07
+---------------
+
+* Remove `API#pulse`
+* Better repeat timer, reimplement `API#every`
+* Move global API methods to separate module, include in `Object` instead of
+  `Kernel`
+* Improve setting root fiber and corresponding coprocess
+* Fix `ResourcePool#preheat!`
+* Rename `$Coprocess#list` to `Coprocess#map`
+* Fix `CancelScope#on_cancel`, remove `CancelScope#protect`
+* Remove `auto_run` mechanism. Just use `suspend`!
+* Optional coverage report for tests
+* More tests
+* Add `Coprocess.select` and `Supervisor#select` methods
+* Add `Coprocess.join` alias to `Coprocess.await` method
+* Add support for cancelling multiple coprocesses with a single cancel scope
+* Fix stopping a coprocess before it being scheduled for the first time
+* Rewrite `thread`, `thread_pool` modules
+* Add `Kernel#orig_sleep` alias to sync `#sleep` method
+* Add optional resume value to `Gyro::Async#signal!`
+* Patch Fiber#inspect to show correct block location
+* Add Gyro.run
+* Move away from callback-based API for `Gyro::Timer`, `Gyro::Signal`
+
 0.22 2020-01-02
 ---------------
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polyphony (0.22)
+    polyphony (0.23)
       http-2 (= 0.10.0)
       http_parser.rb (= 0.6.0)
       modulation (~> 0.25)
@@ -12,12 +12,14 @@ GEM
   specs:
     ansi (1.5.0)
     builder (3.2.4)
+    docile (1.3.2)
     hiredis (0.6.3)
     http-2 (0.10.0)
     http_parser.rb (0.6.0)
     httparty (0.17.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    json (2.1.0)
     localhost (1.1.4)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
@@ -37,6 +39,11 @@ GEM
       rake
     redis (4.1.0)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     websocket (1.2.8)
 
 PLATFORMS
@@ -52,6 +59,7 @@ DEPENDENCIES
   polyphony!
   rake-compiler (= 1.0.5)
   redis (= 4.1.0)
+  simplecov (= 0.17.1)
   websocket (= 1.2.8)
 
 BUNDLED WITH

data/TODO.md

@@ -1,31 +1,3 @@
-# Add ability to cancel multiple coprocesses
-
-```ruby
-scope = CancelScope.new
-
-3.times { |i|
-  spin {
-    puts "sleep for #{i + 1}s"
-    scope.call { sleep i + 1 }
-    puts "woke up"
-  }
-}
-
-sleep 0.5
-scope.cancel!
-```
-
-# Add ability to wait for signal
-
-```ruby
-sig = Gyro::Signal('SIGUP')
-
-loop do
-  sig.await
-  restart
-end
-```
-
 # HTTP Client Agent
 
 The concurrency model and the fact that we want to serve the response object on
@@ -71,14 +43,12 @@ end
 
 # Roadmap:
 
-## 0.22 Redesign of Gyro scheduling system
+## 0.24 Move HTTP code into separate gem
 
-- Schedulerless design - no separate fiber for running ev loop
-- Blocking operations directly transfer to first scheduled fiber
-- Scheduled fibers managed using linked list, switching directly from one to the
-  other
+- Pull out HTTP/websocket code, put into new `polyphony-http` gem
+- Pull out redis/postgres code, put into new `polyphony-contrib` gem
 
-## 0.23 Full Rack adapter implementation
+## 0.25 Full Rack adapter implementation
 
 - Work better mechanism supervising multiple coprocesses (`when_done` feels a
   bit hacky)
@@ -86,21 +56,26 @@ end
 - Homogenize HTTP 1 and HTTP 2 headers - upcase ? downcase ?
 - find some demo Rack apps and test with Polyphony
 
-## 0.24 Working Sinatra application
+## 0.26 Working Sinatra application
 
 - app with database access (postgresql)
 - benchmarks!
 
-## 0.25 Support for multi-threading
+## 0.27 Support for multi-threading
 
 - Separate event loop for each thread
 
-## 0.26 Testing
+## 0.28 Testing
 
 - test thread / thread_pool modules
 - report test coverage
 
-## 0.27 Documentation
+## 0.29 Documentation
+
+## 0.30 Integration
+
+- Sidekick
+- Rails?
 
 # DNS
 

data/docs/summary.md

@@ -15,11 +15,25 @@
 * [Exception Handling](technical-overview/exception-handling.md)
 * [Frequently Asked Questions](technical-overview/faq.md)
 
-## Using Polyphony
-
-* [Coprocesses](#)
-* [Supervisors](#)
-* [Cancel Scopes](#)
+## How To
+
+* [Make an echo server](howto/echo-server.md)
+* [Make an HTTP server](howto/http-server.md)
+* [Make a Websocket server](howto/websocket-server.md)
+* [Use timers](howto/timers.md)
+* [Throttle recurrent operations](howto/throttle.md)
+* [Cancel ongoing operations](howto/cancel.md)
+* [Control coprocesses](howto/coprocesses.md)
+* [Synchronize concurrent operations](howto/synchronize.md)
+* [Perform CPU-bound operations](howto/cpu-bound.md)
+* [Control backpressure](howto/backpressure.md)
+* [Fork worker processes](howto/worker-processes.md)
+
+## Polyphony extensions
+
+* [Postgresql](extensions/pg)
+* [Redis](extensions/redis)
+* [IRB](extensions/irb)
 * [Throttlers](#)
 * [Resource Pools](#)
 * [Synchronisation](#)

data/docs/technical-overview/faq.md

@@ -80,6 +80,18 @@ The API for `Fiber.yield`/`Fiber#resume` is stateful and is intended for the asy
 
 Polyphony is currently at an experimental stage, and its different APIs are still in flux. For that reason, all the different parts of Polyphony are currently kept in a single gem. Once things stabilize, and as Polyphony approaches version 1.0, it will be split into separate gems, each with its own functionality.
 
+## Can I use Polyphony in a multithreaded program?
+
+Not yet. We plan to support multiple threads when Ruby 3.0 is ready.
+
+## Can I run Rails using Polyphony?
+
+Not yet. We do plan to support running Rails when our multithreaded support is ready (see above).
+
+## How can I contribute to Polyphony?
+
+The Polyphony repository is at https://github.com/digital-fabric/polyphony. Feel free to create issues and contribute pull requests.
+
 ## Who is behind this project?
 
 I'm Sharon Rosner, an independent software developer living in France. Here's my [github profile](https://github.com/ciconia). You can contact me by writing to [noteflakes@gmail.com](mailto:ciconia@gmail.com).

data/examples/core/01-spinning-up-coprocesses.rb

@@ -2,9 +2,7 @@
 
 require 'bundler/setup'
 
-# In order to automatically start the reactor, we need to require
-# `polyphony/auto_run`. Otherwise, we can just require `polyphony`
-require 'polyphony/auto_run'
+require 'polyphony'
 
 def nap(tag, t)
   puts "#{Time.now} #{tag} napping for #{t} seconds..."
@@ -16,6 +14,4 @@ end
 spin { nap(:a, 1) }
 spin { nap(:b, 2) }
 
-# Having required `polyphony/auto_run`, once our program is done, the
-# libev-based event reactor is started, and runs until there's no more work left
-# for it to handle.
+suspend

data/examples/core/02-awaiting-coprocesses.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 sleeper = spin do
   puts 'going to sleep'
@@ -16,3 +16,5 @@ waiter = spin do
   sleeper.await
   puts 'done waiting'
 end
+
+waiter.await

data/examples/core/03-interrupting.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 # Let's see how a long-running blocking operation can be interrupted. Polyphony
 # provides several APIs for interrupting an ongoing operation, and distinguishes
@@ -32,3 +32,5 @@ spin do
     nap(:move_on, 2)
   end
 end
+
+suspend

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

@@ -2,7 +2,6 @@
 
 require 'bundler/setup'
 
-# Notice we require 'polyphony' and not 'polyphony/auto_run'
 require 'polyphony'
 
 def nap(tag, t)
@@ -13,6 +12,5 @@ end
 
 spin { nap(:a, 1) }
 
-# If polyphony/auto_run has not been `require`d, the reactor fiber needs to be
-# started manually. This is done by transferring control to it using `suspend`:
+# Wait for any coprocess still alive
 suspend

data/examples/core/cancel.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 begin
   puts 'going to sleep...'

data/examples/core/channel_echo.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 def echo(cin, cout)
   puts 'start echoer'
@@ -41,3 +41,5 @@ $main = spin do
   chan2.close
   puts "done #{Time.now - t0}"
 end
+
+suspend

data/examples/core/defer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 defer do
   puts 'two'
@@ -10,3 +10,5 @@ defer do
 end
 
 puts 'one'
+
+suspend

data/examples/core/enumerator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 enum = [1, 2, 3].each
 
@@ -11,3 +11,5 @@ spin do
     sleep 0.1
   end
 end
+
+suspend

data/examples/core/error_bubbling.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'polyphony'
+
+::Exception.__disable_sanitized_backtrace__ = true
+
+def test
+  # error is propagated to calling coprocess
+  raised_error = nil
+  spin do
+    spin do
+      raise 'foo'
+    end
+    puts "before snooze"
+    snooze # allow nested coprocess to run before finishing
+    puts "after snooze"
+  end
+  suspend
+rescue Exception => e
+  raised_error = e
+ensure
+  puts "raised_error: #{raised_error.inspect}"
+  # puts "msg: #{raised_error.message.inspect}"
+end
+
+test
+begin
+  puts "last suspend"
+  #suspend
+  Gyro.run
+rescue => e
+  puts "!" * 60
+  puts "Error after last suspend: #{e.inspect}"
+end

data/examples/core/fork.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 puts "parent pid: #{Process.pid}"
 

data/examples/core/genserver.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 class GenServer
   def self.start(receiver, *args)

data/examples/core/lock.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 def loop_it(number, lock)
   loop do
@@ -17,3 +17,5 @@ lock = Polyphony::Sync::Mutex.new
 spin { loop_it(1, lock) }
 spin { loop_it(2, lock) }
 spin { loop_it(3, lock) }
+
+suspend

data/examples/core/move_on.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 Exception.__disable_sanitized_backtrace__ = true
 
 puts 'going to sleep...'

data/examples/core/move_on_twice.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 puts 'going to sleep...'
 move_on_after(1) do

data/examples/core/move_on_with_ensure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 
 puts 'going to sleep...'
 move_on_after(0.5) do

data/examples/core/move_on_with_value.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'polyphony/auto_run'
+require 'polyphony'
 Exception.__disable_sanitized_backtrace__ = true
 
 def blocking_operation