ractor-dispatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d467750fb7358768f6bdaefc11134e62f60fe642198cf28141ee160563caf43
+  data.tar.gz: 3974b307afe4d1f32fb1a3aa7989712465fb496a2c98fc475463f606cde1e9d8
+SHA512:
+  metadata.gz: 38c7e36f435c8e9bfbba832bd8ceb313bddcf59d781f939e3079e88aae725c08f112db7ebeb39ad14982467010a5af1f57883443f568b55392a1c6b443415fd1
+  data.tar.gz: e4d1c7e84f803565684a0b789908d576c0a9f765d2147fb457e8a8a6b50a92d8820722e0d800efe9c2a9e58b1af3a2a2424ff897fb908b39f524f48bfc1f3b27

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"ractor-dispatch" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["john@hawthorn.email"](mailto:"john@hawthorn.email").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 John Hawthorn
+
+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,95 @@
+# Ractor::Dispatch
+
+Dispatch work to a specific Ractor and get results back. The primary use case
+is an "escape hatch" for code running in non-main Ractors that needs to execute
+something only the main Ractor can do (access globals, unshareable constants,
+ENV, etc).
+
+## Usage
+
+```ruby
+require "ractor/dispatch"
+
+Ractor.new do
+  # Synchronous — blocks until the main Ractor returns the result
+  home = Ractor::Dispatch.main.run { ENV["HOME"] }
+  puts home
+
+  # Async — returns a Future immediately
+  future = Ractor::Dispatch.main.submit { ENV["PATH"] }
+  # ... do other work ...
+  path = future.value
+end.join
+```
+
+The passed block is automatically made into a shareable proc. Because shareable
+procs can close over frozen/shareable values, this works naturally with frozen
+string literals and other shareable objects.
+
+### Error handling
+
+Exceptions raised by the block are propagated back to the caller:
+
+```ruby
+Ractor.new do
+  Ractor::Dispatch.main.run { raise "oops" } # => raises RuntimeError "oops"
+end.join
+```
+
+### Shutdown
+
+```ruby
+Ractor::Dispatch.main.shutdown # closes the work port, background thread exits
+```
+
+### Custom executors
+
+`Ractor::Dispatch.main` is a convenience for the common case. You can also
+create your own executor on any Ractor:
+
+```ruby
+executor = Ractor::Dispatch::Executor.new
+
+Ractor.new(executor) do |ex|
+  ex.run { ENV["HOME"] }
+end.join
+```
+
+## How it works
+
+`Ractor::Dispatch.main` lazily creates an `Executor` on the main Ractor.
+`Executor.new` creates a `Ractor::Port` and spawns a background `Thread` on
+the current Ractor that loops receiving work from the port. The Executor is
+then made shareable so it can be passed to other Ractors.
+
+When `submit` is called, the block is made into a shareable proc, the caller
+creates a reply `Ractor::Port`, sends `[callable, args, reply_port]` to the
+executor's work port, and returns a `Future` wrapping the reply port. The
+background thread receives the job, executes it, and sends the result back on
+the reply port.
+
+The key `Ractor::Port` property that makes this work: **any Ractor can send
+to a port, but only the creating Ractor can receive from it**. This means
+reply ports naturally route results back to the correct caller.
+
+## Requirements
+
+Requires Ruby with `Ractor::Port` support (Ruby 4.0+).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/ractor-dispatch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jhawthorn/ractor-dispatch/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ractor::Dispatch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jhawthorn/ractor-dispatch/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/ractor/dispatch/executor.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Ractor
+  module Dispatch
+    class Executor
+      def initialize
+        @port = Ractor::Port.new
+
+        Thread.new do
+          loop do
+            callable, reply_port = @port.receive
+            begin
+              result = callable.call
+              reply_port << [:ok, result]
+            rescue => e
+              reply_port << [:error, e]
+            rescue Ractor::ClosedError
+              # caller went away, discard
+            end
+          end
+        rescue Ractor::ClosedError
+          # port closed via shutdown
+        end
+
+        Ractor.make_shareable(self)
+      end
+
+      def submit(&block)
+        callable = Ractor.shareable_proc(&block)
+        reply_port = Ractor::Port.new
+        @port << [callable, reply_port]
+        Future.new(reply_port)
+      end
+
+      def run(&block)
+        submit(&block).value
+      end
+
+      def shutdown
+        @port.close
+      end
+    end
+  end
+end

data/lib/ractor/dispatch/future.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Ractor
+  module Dispatch
+    class Future
+      def initialize(port)
+        @port = port
+        @mutex = Mutex.new
+      end
+
+      def value
+        @mutex.synchronize do
+          unless defined?(@resolved)
+            @resolved = true
+            status, val = @port.receive
+            @port.close
+            if status == :error
+              @error = val
+            else
+              @value = val
+            end
+          end
+        end
+
+        raise @error if @error
+        @value
+      end
+
+      def resolved?
+        @mutex.synchronize { defined?(@resolved) }
+      end
+    end
+  end
+end

data/lib/ractor/dispatch/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Ractor
+  module Dispatch
+    VERSION = "0.1.0"
+  end
+end

data/lib/ractor/dispatch.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "dispatch/version"
+require_relative "dispatch/future"
+require_relative "dispatch/executor"
+
+class Ractor
+  module Dispatch
+    class Error < StandardError; end
+
+    @main = Executor.new
+
+    def self.main
+      @main
+    end
+  end
+end

data/sig/ractor/dispatch.rbs

@@ -0,0 +1,6 @@
+module Ractor
+  module Dispatch
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: ractor-dispatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight library for dispatching work to a specific Ractor. Useful
+  as an escape hatch when code running in non-main Ractors needs to execute something
+  only the main Ractor can do.
+email:
+- john@hawthorn.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ractor/dispatch.rb
+- lib/ractor/dispatch/executor.rb
+- lib/ractor/dispatch/future.rb
+- lib/ractor/dispatch/version.rb
+- sig/ractor/dispatch.rbs
+homepage: https://github.com/jhawthorn/ractor-dispatch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jhawthorn/ractor-dispatch
+  source_code_uri: https://github.com/jhawthorn/ractor-dispatch
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Dispatch work to a specific Ractor and get results back
+test_files: []