async-actor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e9de464bc62b1ee6737b902f4dd92d669a8b001011ca92e80e2937b4323cbbc
+  data.tar.gz: b1acc7ef2be6d0f8e192cccdc640e5d26456bc1f2254fe79910b77490ff332c2
+SHA512:
+  metadata.gz: a183a688047b5c1309b9c611146b3cb09d4ca2298f75ff01340fa4bf1dbf908ae22135056bafc3556ca2db702b8d13fd84977cffd210672f7cc4350db676956a
+  data.tar.gz: '09e2cd6172518386c72d1f24457c1c071912c41cb7008488c4b8ca666a1560849cc033778f9af9f0b3d8337c689d5fdae59e44a9a5b6623dd4252b660679441b'

data/lib/async/actor/proxy.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'async'
+
+require_relative 'variable'
+
+module Async
+	module Actor
+		class Proxy < BasicObject
+			class Finalizer
+				def initialize(queue, thread)
+					@queue = queue
+					@thread = thread
+				end
+				
+				def call(id)
+					@queue.close
+					@thread.join
+				end
+			end
+			
+			def initialize(target)
+				@target = target
+				
+				@queue = ::Thread::Queue.new
+				@thread = __start__
+				
+				# Define a finalizer to ensure the thread is closed:
+				::ObjectSpace.define_finalizer(self, Finalizer.new(@queue, @thread))
+			end
+			
+			# @parameter return_value [Symbol] One of :ignore, :promise or :wait.
+			def method_missing(*arguments, return_value: :wait, **options, &block)
+				unless return_value == :ignore
+					result = Variable.new
+				end
+				
+				@queue.push([arguments, options, block, result])
+				
+				if return_value == :promise
+					return result
+				else
+					return result&.get
+				end
+			end
+			
+			protected
+			
+			def __start__
+				::Thread.new do
+					::Kernel.Sync do |task|
+						while operation = @queue.pop
+							task.async do
+								arguments, options, block, result = operation
+								Variable.fulfill(result) do
+									@target.public_send(*arguments, **options, &block)
+								end
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/actor/variable.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Async
+	module Actor
+		class Variable
+			def self.fulfill(variable)
+				variable.set(yield)
+				variable = nil
+			rescue => error
+				variable&.fail(error)
+				variable = nil
+			ensure
+				# throw, etc:
+				variable&.fail(RuntimeError.new("Invalid flow control!"))
+			end
+			
+			def initialize
+				@set = nil
+				@value = nil
+				
+				@guard = Thread::Mutex.new
+				@condition = Thread::ConditionVariable.new
+			end
+			
+			def set(value)
+				@guard.synchronize do
+					raise "Variable already set!" unless @set.nil?
+					
+					@set = true
+					@value = value
+					@condition.broadcast
+				end
+			end
+			
+			def fail(error)
+				@guard.synchronize do
+					raise "Variable already set!" unless @set.nil?
+					
+					@set = false
+					@error = error
+					@condition.broadcast
+				end
+			end
+			
+			def get
+				@guard.synchronize do
+					while @set.nil?
+						@condition.wait(@guard)
+					end
+					
+					if @set
+						return @value
+					else
+						raise @error
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/actor/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+module Async
+	module Actor
+		VERSION = "0.1.0"
+	end
+end

data/lib/async/actor.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require_relative 'actor/version'
+require_relative 'actor/proxy'
+
+module Async
+	module Actor
+		def self.new(instance)
+			Proxy.new(instance)
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023, by Samuel Williams.  
+
+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,33 @@
+# Async::Actor
+
+Provides a simple actor model for asynchronous programming.
+
+[![Development Status](https://github.com/socketry/async-actor/workflows/Test/badge.svg)](https://github.com/socketry/async-actor/actions?workflow=Test)
+
+## Motivation
+
+Async provides a strongly opinionated model for asynchronous programming while trying to be transparent to the user. However, in cases where the scope (life time) of the asynchronous work does not align with the scope of the application code, it can be tricky to combine the two. For example, you may want to introduce a background message queue or job processing system, which takes advantage of async, without changing the execution model of the calling code. The jobs or message queue will almost certainly outlive the scope of the calling code, so it can be advantageous to separate the two.
+
+This is where `Async::Actor` comes in. It provides a simple actor model, which uses an event driven message queue running inside an Async event loop. This separates the life cycle of the calling code and the actor and can be used to introduce asynchronous processing into existing code with minimal changes.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/async-actor/) for more details.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: async-actor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2023-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/async/actor.rb
+- lib/async/actor/proxy.rb
+- lib/async/actor/variable.rb
+- lib/async/actor/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/async-actor/
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/async-actor/
+  funding_uri: https://github.com/sponsors/ioquatix
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: A multi-threaded actor implementation where each actor has it's own event
+  loop.
+test_files: []