itsi-scheduler 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06da68bc85607dea16257e5043d45b1a9ea6f376c9ef8d41e2bda7f4a89a0dcb
-  data.tar.gz: 2932d32895a5bef79abd2156248bd2eb089944d19810389c1ee1086c0406bf5f
+  metadata.gz: c057b5de1665276930d7c09f81ccc6e1b81419cf7cd9a4b3c04a08d3b6d0976d
+  data.tar.gz: 32fb526429c78f471eb248d3800dff138e7021aec6f95b13ee30ff4a4297a570
 SHA512:
-  metadata.gz: 7419b864b913c1f80a50e8d3a7d061343382064bab38204e662a8e8eb4c3f5b31cbf26e473e74c7480c50bbfe04f792091c6960e903bbc3a7cfbb774a7f82e9e
-  data.tar.gz: c94af7791e8da99fb1f174662587358a6994305650943372ba36635140eecd0b7b00c83bea33c4e1178f5d2e760acbb01ac7dd82c38b4de03ac1087df4656dc7
+  metadata.gz: c2304a02521484da65165d2f08632d9b52be536246ccefb5993b1715e7adcbe6cbc42fda820dffcd1e10bb1082b93ca9317e7aec6205cdfb735b3a6c933a63d5
+  data.tar.gz: d1c3f48ba6ba4c71694a5e0ee3f72ebb2b4229bbf4fe4cde8756ec5d6ed4d1c971c6e1e791c36b1f3ee7816e2db0a712aa70704b9c77ad9d2695021829c769c8

data/Cargo.lock

@@ -213,7 +213,7 @@ checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
 [[package]]
 name = "itsi-scheduler"
-version = "0.2.10"
+version = "0.2.11"
 dependencies = [
  "bytes",
  "derive_more",

data/ext/itsi_scheduler/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "itsi-scheduler"
-version = "0.2.10"
+version = "0.2.11"
 edition = "2021"
 authors = ["Wouter Coppieters <wc@pico.net.nz>"]
 license = "MIT"

data/ext/itsi_server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "itsi-server"
-version = "0.2.10"
+version = "0.2.11"
 edition = "2021"
 authors = ["Wouter Coppieters <wc@pico.net.nz>"]
 license = "MIT"

data/ext/itsi_server/src/lib.rs

@@ -86,6 +86,8 @@ fn init(ruby: &Ruby) -> Result<()> {
     response.define_method("<<", method!(ItsiHttpResponse::send_frame, 1))?;
     response.define_method("write", method!(ItsiHttpResponse::send_frame, 1))?;
     response.define_method("read", method!(ItsiHttpResponse::recv_frame, 0))?;
+    response.define_method("flush", method!(ItsiHttpResponse::flush, 0))?;
+    response.define_method("closed?", method!(ItsiHttpResponse::is_closed, 0))?;
     response.define_method(
         "send_and_close",
         method!(ItsiHttpResponse::send_and_close, 1),

data/ext/itsi_server/src/ruby_types/itsi_http_response.rs

@@ -272,6 +272,14 @@ impl ItsiHttpResponse {
         // not implemented
     }
 
+    pub fn flush(&self) {
+        // no-op
+    }
+
+    pub fn is_closed(&self) -> bool {
+        self.data.response_writer.write().is_none()
+    }
+
     pub fn send_and_close(&self, frame: Bytes) -> MagnusResult<()> {
         let result = self.send_frame_into(ByteFrame::End(frame), &self.data.response_writer);
         self.data.response_writer.write().take();

data/lib/itsi/scheduler/version.rb

@@ -2,6 +2,6 @@
 
 module Itsi
   class Scheduler
-    VERSION = "0.2.10"
+    VERSION = "0.2.11"
   end
 end

data/lib/itsi/scheduler.rb

@@ -4,7 +4,35 @@ require_relative "scheduler/version"
 require_relative "scheduler/itsi_scheduler"
 
 module Itsi
+  module ScheduleUtils
+    def schedule(&block)
+      return to_enum(:schedule) unless block_given?
+
+      Object.schedule do
+        each { |item| Object.schedule { block.call(item) } }
+      end
+    end
+  end
+
   class Scheduler
+    def self.enable_schedule_keyword!
+      Object.define_method(:schedule) do |&blk|
+        result = nil
+        return result unless blk
+
+        if Fiber.scheduler.nil?
+          Thread.new do
+            Fiber.set_scheduler Itsi::Scheduler.new
+            Fiber.schedule { result = blk[] }
+          end.join
+        else
+          Fiber.schedule { result = blk[] }
+        end
+        result
+      end
+      Enumerable.include(ScheduleUtils)
+    end
+
     class Error < StandardError; end
 
     def self.resume_token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itsi-scheduler
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Wouter Coppieters
@@ -35,7 +35,6 @@ files:
 - ".rubocop.yml"
 - Cargo.lock
 - Cargo.toml
-- README.md
 - Rakefile
 - ext/itsi_acme/Cargo.toml
 - ext/itsi_acme/examples/high_level.rs

data/README.md

@@ -1,76 +0,0 @@
----
-title: Itsi Scheduler
-type: docs
-weight: 4
-sidebar:
-  exclude: true
----
-<img src="itsi-scheduler-100.png"  width="80px" style="display: block; margin-left: auto; margin-right: auto;">
-
-`Itsi Scheduler` is an implementation of a Ruby [Fiber Scheduler](https://docs.ruby-lang.org/en/3.2/Fiber/Scheduler.html).
-
-When combined with Itsi Server, you can write endpoints that look just like regular synchronous Ruby code. Behind the scenes, the scheduler will transparently pause and resume fibers to prevent threads from blocking, greatly increasing throughput for I/O-heavy workloads
-
-If you're purely after a lightweight, yet efficient Ruby scheduler,
-you can use Itsi Scheduler as a standalone scheduler for any Ruby application.
-
-Just use `Fiber.set_scheduler` to set an instance `Itsi::Scheduler` as a scheduler to opt in to this IO weaving behavior
-*automatically* for all blocking IO.
-
-### Primer on Fiber Schedulers
-
-Fiber schedulers are a way to automatically manage the execution of non-blocking fibers in Ruby. A scheduler is responsible for the automatic pausing and resumption of Fibers based
-on whether or not they are awaiting IO operations.
-Ruby's Fiber scheduler implementation automatically invokes the current Fiber scheduler (if it exists) for each blocking operation, allowing it to seamlessly drive the execution of huge numbers of simultaneous non-blocking fibers
-while ensuring the main thread is never blocked on IO.
-
-This behind the scenes magic allows Ruby to provide async IO (just like we find in languages with `async/await` like `Rust`, `C#`, `JavaScript`) *but* with the added beauty
-that synchronous and asynchronous code is identical! (I.e. Ruby's functions are [colorless](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function/))
-
-## Getting Started
-To install and use Itsi Scheduler follow the instructions below:
-
-
-### 1 - Install Itsi Scheduler
-
-**Prerequisites**
-
-You'll need at least `build-essential` and `libclang-dev` installed to build Itsi on Linux.
-E.g.
-```bash
-apt-get install build-essential libclang-dev
-```
-
-Then use `gem` to install the Itsi package. This will in turn install both the
-`itsi-server` gem, and the `itsi-scheduler` gem.
-
-
-```bash
-gem install itsi-scheduler
-```
-
-
-### 2 - Use Itsi Scheduler
-
-Great! You now have Itsi Scheduler installed.
-Now you can run code like this:
-
-```ruby
-require 'itsi/scheduler'
-require 'socket'
-results = Thread.new do
-  Fiber.set_scheduler Itsi::Scheduler.new
-  results = []
-  Fiber.schedule do
-    results << Addrinfo.getaddrinfo("www.ruby-lang.org", 80, nil, :STREAM)
-  end
-  Fiber.schedule do
-    results << Addrinfo.getaddrinfo("www.google.com", 80, nil, :STREAM)
-  end
-  results
-end.value
-
-puts results.map(&:inspect)
-```
-
-to run many blocking operations simultaneously all while occupying only a single Ruby thread!