polyphony 0.43.8

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    polyphony (0.43.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.0)
+    builder (3.2.4)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.6)
+    docile (1.3.2)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.12.1)
+    forwardable-extended (2.6.0)
+    hiredis (0.6.3)
+    http_parser.rb (0.6.0)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.6)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-remote-theme (0.4.1)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      rubyzip (>= 1.3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    json (2.3.0)
+    just-the-docs (0.3.0)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (~> 2.0)
+      rake (>= 12.3.1, < 13.1.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    localhost (1.1.4)
+    mercenary (0.3.6)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.13.0)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_xml (0.6.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    pg (1.1.4)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rake-compiler (1.0.5)
+      rake
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    redis (4.1.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rouge (3.15.0)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    rubyzip (2.0.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hiredis (= 0.6.3)
+  http_parser.rb (~> 0.6.0)
+  httparty (= 0.17.0)
+  jekyll (~> 3.8.6)
+  jekyll-remote-theme (~> 0.4.1)
+  jekyll-seo-tag (~> 2.6.1)
+  just-the-docs (~> 0.3.0)
+  localhost (= 1.1.4)
+  minitest (= 5.13.0)
+  minitest-reporters (= 1.4.2)
+  pg (= 1.1.4)
+  polyphony!
+  rake-compiler (= 1.0.5)
+  redis (= 4.1.0)
+  rubocop (= 0.85.1)
+  simplecov (= 0.17.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Sharon Rosner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+<p align="center"><img src="docs/polyphony-logo.png" /></p>
+
+# Polyphony - Fine-Grained Concurrency for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/polyphony.svg)](http://rubygems.org/gems/polyphony)
+[![Modulation Test](https://github.com/digital-fabric/polyphony/workflows/Tests/badge.svg)](https://github.com/digital-fabric/polyphony/actions?query=workflow%3ATests)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/digital-fabric/polyphony/blob/master/LICENSE)
+
+[DOCS](https://digital-fabric.github.io/polyphony/) |
+[EXAMPLES](examples)
+
+> Polyphony \| pəˈlɪf\(ə\)ni \|
+> 1. _Music_ the style of simultaneously combining a number of parts, each
+>    forming an individual melody and harmonizing with each other.
+> 2. _Programming_ a Ruby gem for concurrent programming focusing on performance
+>    and developer happiness.
+
+## What is Polyphony
+
+Polyphony is a library for building concurrent applications in Ruby. Polyphony
+harnesses the power of [Ruby fibers](https://ruby-doc.org/core-2.5.1/Fiber.html)
+to provide a cooperative, sequential coroutine-based concurrency model. Under
+the hood, Polyphony uses [libev](https://github.com/enki/libev) as a
+high-performance event reactor that provides timers, I/O watchers and other
+asynchronous event primitives.
+
+## Features
+
+* Co-operative scheduling of concurrent tasks using Ruby fibers.
+* High-performance event reactor for handling I/O events and timers.
+* Natural, sequential programming style that makes it easy to reason about
+  concurrent code.
+* Abstractions and constructs for controlling the execution of concurrent code:
+  supervisors, cancel scopes, throttling, resource pools etc.
+* Code can use native networking classes and libraries, growing support for
+  third-party gems such as `pg` and `redis`.
+* Use stdlib classes such as `TCPServer`, `TCPSocket` and
+  `OpenSSL::SSL::SSLSocket`.
+* Competitive performance and scalability characteristics, in terms of both
+  throughput and memory consumption.
+
+## Documentation
+
+The complete documentation for Polyphony could be found on the
+[Polyphony website](https://digital-fabric.github.io/polyphony).
+
+## Contributing to Polyphony
+
+Issues and pull requests will be gladly accepted. Please use the [Polyphony git
+repository](https://github.com/digital-fabric/polyphony) as your primary point
+of departure for contributing.

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/clean"
+
+require "rake/extensiontask"
+Rake::ExtensionTask.new("polyphony_ext") do |ext|
+  ext.ext_dir = "ext/polyphony"
+end
+
+task :recompile => [:clean, :compile]
+
+task :default => [:compile, :test]
+task :test do
+  exec 'ruby test/run.rb'
+end
+
+task :stress_test do
+  exec 'ruby test/stress.rb'
+end
+
+task :docs do
+  exec 'RUBYOPT=-W0 jekyll serve -s docs -H ec2-35-158-110-38.eu-central-1.compute.amazonaws.com'
+end
+
+CLEAN.include "**/*.o", "**/*.so", "**/*.bundle", "**/*.jar", "pkg", "tmp"

data/TODO.md

@@ -0,0 +1,201 @@
+- Implement `LibevAgent#connect` API
+- Reimplement ResourcePool, Channel, Mutex using Queue
+-- Add `Fiber#schedule_with_priority` method, aliased by `Fiber#wakeup`
+- Implement agent interface is virtual function table
+- Implement proxy agent for plugging in a user-provided agent class
+
+- Debugging
+  - Eat your own dogfood: need a good tool to check what's going on when some
+    test fails
+  - Needs to work with Pry (can write perhaps an extension for pry)
+  - First impl in Ruby using `TracePoint` API
+  - Mode of operation:
+    - Two parts: tracer and controller
+      - The tracer keeps state
+      - The controller interacts with the user and tells the tracer what to do
+      - Tracer and controller interact using fiber message passing
+      - The controller lives on a separate thread
+      - The tracer invokes the controller at the appropriate point in time
+        according to the state. For example, when doing a `next` command, the
+        tracer will wait for a `:line` event to occur within the same stack
+        frame, or for the frame to be popped on a `:return` event, and only then
+        will it invoke the controller.
+      - While invoking the controller and waiting for its reply, the tracer
+        optionally performs a fiber lock in order to prevent other fibers from
+        advancing (the fiber lock is the default mode).
+    - The tracer's state is completely inspectable
+
+      ```ruby
+      PolyTrace.state
+      PolyTrace.current_fiber
+      PolyTrace.call_stack
+      ```
+
+    - Modes can be changed using an API, e.g.
+
+      ```ruby
+      PolyTrace.fiber_lock = false
+      ```
+
+    - Fibers can be interrogated using an API, or perhaps using some kind of
+      Pry command...
+
+    - Normal mode of operation is fiber modal, that is, trace only the currently
+      selected fiber. The currently selected fiber may be changed upon breakpoint
+
+  - Step over should return on the next line *for the same fiber*
+  - The event loop (all event loops?) should be suspended so timers are adjusted
+    accordingly, so on control passing to debugger we:
+
+    - call `ev_suspend()` for main thread ev_loop
+    - prompt and wait for input from user
+    - call `ev_resume()` for main thread ev_loop
+    - process user input
+
+    (We need to verify than `ev_suspend/resume` works for an ev_loop that's not
+    currently running.)
+  - Allow inspection of fiber tree, thread's run queue, fiber's scheduled values etc.
+
+  - UI
+    - `Kernel#breakpoint` is used to break into the debugger while running code
+
+      ```ruby
+      def test_sleep
+        f = spin { sleep 10 }
+        breakpoint
+        ...
+      end
+      ```
+
+      Hitting the breakpoint will show the current location in the source code
+      (with few lines before and after), and present a prompt for commands.
+    
+    - commands:
+      - `step` / `up` / `skip` / `continue` etc. - step into, step out, step over, run
+      - `switch` - switch fiber
+        - how do we select a fiber?
+          - from a list?
+          - from an expression: `Fiber.current.children`
+          - maybe just `select f1` (where f1 is a local var)
+
+- Allow locking the scheduler on to one fiber
+  - Add instance var `@fiber_lock`
+  - API is `Thread#fiber_lock` which sets the fiber_lock instance varwhile
+    running the block:
+
+    ```ruby
+    def debug_prompt
+      Thread.current.fiber_lock do
+        ...
+      end
+    end
+    ```
+  - When `@fiber_lock` is set, it is considered as the only one in the run
+    queue:
+
+    ```c
+    VALUE fiber_lock = rb_ivar_get(self, ID_ivar_fiber_lock);
+    int locked = fiber_lock != Qnil;
+
+    while (1) {
+      next_fiber = locked ? fiber_lock : rb_ary_shift(queue);
+      ...
+    }
+    ```
+
+
+
+
+
+
+
+- Docs
+  - landing page:
+    - links to the interesting stuff
+      - benchmarks
+  - explain difference between `sleep` and `suspend`
+  - discuss using `snooze` for ensuring responsiveness when executing CPU-bound work
+
+
+## 0.44
+
+### Some more API work, more docs
+
+- sintra app with database access (postgresql)
+
+- sidekiq: Plan of action
+  - see if we can get by just writing an adapter
+  - if not, fork sidekiq, make adjustments to Polyphony code
+  - test performance
+  - proceed from there
+
+
+## 0.45
+
+### Sinatra / Sidekiq
+
+- Pull out redis/postgres code, put into new `polyphony-xxx` gems
+
+## 0.46
+
+### Testing && Docs
+
+- More tests
+- Implement some basic stuff missing:
+  - override `IO#eof?` since it too reads into buffer
+  - real `IO#gets` (with buffering)
+  - `IO#read` (read to EOF)
+  - `IO.foreach`
+  - `Process.waitpid`
+
+## 0.47
+
+### Real IO#gets and IO#read
+
+## 0.48 DNS
+
+### DNS client
+
+```ruby
+ip_address = DNS.lookup('google.com', 'A')
+```
+
+Prior art:
+
+- https://github.com/alexdalitz/dnsruby
+- https://github.com/eventmachine/eventmachine/blob/master/lib/em/resolver.rb
+- https://github.com/gmodarelli/em-resolv-replace/blob/master/lib/em-dns-resolver.rb
+- https://github.com/socketry/async-dns
+
+### DNS server
+
+```ruby
+require 'polyphony/dns'
+server = Polyphony::DNS::Server.new do |transaction|
+  transaction.questions.each do |q|
+    respond(transaction, q[:domain], q[:resource_class])
+  end
+end
+
+server.listen(port: 5300)
+puts "listening on port 5300"
+```
+
+Prior art:
+
+- https://github.com/socketry/async-dns
+
+## Work on API
+
+- Add option for setting the exception raised on cancelling using `#cancel_after`:
+
+```ruby
+cancel_after(3, with_error: MyErrorClass) do
+  do_my_thing
+end
+# or a RuntimeError with message
+cancel_after(3, with_error: 'Cancelled due to timeout') do
+  do_my_thing
+end
+```
+