standard-procedure-plumbing 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ace6c01658b88c08c34d48406f983fdad449bc4f122b8dfed026853841b48d35
-  data.tar.gz: 96b4458d0c667e10bb47fb8881de2e21df0ff40243cf07ff30e2e22f29892625
+  metadata.gz: 95f2fc92882bb116a50fb4406b8d905b6783bfd0b2f74a4229162fd26a920668
+  data.tar.gz: a0db08496ca520d9ae6baf50495395b3f943869cc07105b8d5ef7cefc054f8bf
 SHA512:
-  metadata.gz: a5ee7af05314dbb45d9f46a302f6102f93237334224f82f1c34cdd5c252829039bf6b4bc18a562fcdb5d76a8ca229a484b0f3d3e123b7e5efd46d302f50c72b4
-  data.tar.gz: 005f6cee1eb899207659955ea5a4179133c65e07db913e8f3f9c730cfca8947684927c9b99b675e9f54dc4ea4820159d709d61b146113a993783cec2a0c5842c
+  metadata.gz: 976815454b96a52880605f34fc7d7ae801259bedaa7807c148f9edc951e9e8766d35e9cc0988d2f572aa7076bf78e9b90a666468b1438b0b80abe6cb3e3d9947
+  data.tar.gz: 6c9852305cf8ac858d853cdeac89c57c3424838d5ee51a130a989210ffdd8337d393dd710f61d8cf0a3212f4027383840c7919e44d61c6c86e8bfb9af53eac8f

data/README.md

@@ -469,6 +469,8 @@ You can also use the same `@object.as type` to type-check instances against modu
 
 ## Installation
 
+Note: this gem is licensed under the [LGPL](/LICENCE).  This may or may not make it unsuitable for use by you or your company.
+
 Install the gem and add to the application's Gemfile by executing:
 
 ```sh

data/lib/plumbing/actor/async.rb

@@ -14,9 +14,9 @@ module Plumbing
       end
 
       # Send the message to the target and wrap the result
-      def send_message message_name, *args, &block
+      def send_message(message_name, *, **, &)
         task = @semaphore.async do
-          @target.send message_name, *args, &block
+          @target.send(message_name, *, **, &)
         end
         Result.new(task)
       end
@@ -28,9 +28,7 @@ module Plumbing
 
       def within_actor? = true
 
-      def stop
-        # do nothing
-      end
+      def stop = nil
 
       Result = Data.define(:task) do
         def value

data/lib/plumbing/actor/inline.rb

@@ -6,8 +6,8 @@ module Plumbing
       end
 
       # Send the message to the target and wrap the result
-      def send_message(message_name, *, &)
-        value = @target.send(message_name, *, &)
+      def send_message(message_name, *, **, &)
+        value = @target.send(message_name, *, **, &)
         Result.new(value)
       rescue => ex
         Result.new(ex)
@@ -20,9 +20,7 @@ module Plumbing
 
       def within_actor? = true
 
-      def stop
-        # do nothing
-      end
+      def stop = nil
 
       Result = Data.define(:result) do
         def value = result.is_a?(Exception) ? raise(result) : result

data/lib/plumbing/actor/rails.rb

@@ -5,8 +5,8 @@ module Plumbing
     class Rails < Threaded
       protected
 
-      def future(&)
-        Concurrent::Promises.future do
+      def in_context(&)
+        super do
           Rails.application.executor.wrap(&)
         end
       end

data/lib/plumbing/actor/threaded.rb

@@ -16,12 +16,10 @@ module Plumbing
       end
 
       # Send the message to the target and wrap the result
-      def send_message message_name, *args, &block
-        Message.new(@target, message_name, Plumbing::Actor.transporter.marshal(*args), block, Concurrent::MVar.new).tap do |message|
-          @mutex.synchronize do
-            @queue << message
-            send_messages if @queue.any?
-          end
+      def send_message(message_name, *args, **params, &block)
+        Message.new(@target, message_name, Plumbing::Actor.transporter.marshal(*args, **params), block, Concurrent::MVar.new).tap do |message|
+          @queue << message
+          send_messages
         end
       end
 
@@ -38,15 +36,18 @@ module Plumbing
 
       protected
 
-      def future(&) = Concurrent::Promises.future(&)
+      def in_context(&)
+        Concurrent::Promises.future do
+          @mutex.synchronize(&)
+        end
+      end
 
       private
 
       def send_messages
-        future do
-          @mutex.synchronize do
-            message = @queue.shift
-            message&.call
+        in_context do
+          while (message = @queue.shift)
+            message.call
           end
         end
       end

data/lib/plumbing/actor.rb

@@ -64,8 +64,8 @@ module Plumbing
       def build_proxy_class
         Class.new(proxy_base_class).tap do |proxy_class|
           async_messages.each do |message|
-            proxy_class.define_method message do |*args, &block|
-              send_message(message, *args, &block)
+            proxy_class.define_method message do |*args, **params, &block|
+              send_message(message, *args, **params, &block)
             end
           end
         end

data/lib/plumbing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plumbing
-  VERSION = "0.4.1"
+  VERSION = "0.4.3"
 end

data/spec/plumbing/actor_spec.rb

@@ -112,39 +112,115 @@ RSpec.describe Plumbing::Actor do
 
     def do_safety_check = @on_safety_check&.call
   end
-  # standard:enable Lint/ConstantDefinitionInBlock
 
-  it "knows which async messages are understood" do
-    expect(Counter.async_messages).to eq [:name, :count, :slow_query, :slowly_increment, :raises_error]
-  end
+  class ParameterHandler
+    include Plumbing::Actor
+    async :set_values, :args, :params, :block
+    attr_reader :args, :params, :block
+
+    def initialize
+      @args = nil
+      @params = nil
+      @block = nil
+    end
 
-  it "reuses existing proxy classes" do
-    @counter = Counter.start "inline counter", initial_value: 100
-    @proxy_class = @counter.class
+    private
 
-    @counter = Counter.start "another inline counter", initial_value: 200
-    expect(@counter.class).to eq @proxy_class
+    def set_values *args, **params, &block
+      @args = args
+      @params = params
+      @block = block
+    end
   end
+  # standard:enable Lint/ConstantDefinitionInBlock
+
+  [:inline, :async, :threaded].each do |mode|
+    context "In #{mode} mode" do
+      it "knows which async messages are understood" do
+        expect(Counter.async_messages).to eq [:name, :count, :slow_query, :slowly_increment, :raises_error]
+      end
 
-  it "includes async messages from the superclass" do
-    expect(StepCounter.async_messages).to eq [:name, :count, :slow_query, :slowly_increment, :raises_error, :step_value]
+      it "reuses existing proxy classes" do
+        @counter = Counter.start "inline counter", initial_value: 100
+        @proxy_class = @counter.class
 
-    @step_counter = StepCounter.start "step counter", initial_value: 100, step_value: 10
+        @counter = Counter.start "another inline counter", initial_value: 200
+        expect(@counter.class).to eq @proxy_class
+      end
 
-    expect(@step_counter.count.value).to eq 100
-    expect(@step_counter.step_value.value).to eq 10
-    @step_counter.slowly_increment
-    expect(@step_counter.count.value).to eq 110
-  end
+      it "includes async messages from the superclass" do
+        expect(StepCounter.async_messages).to eq [:name, :count, :slow_query, :slowly_increment, :raises_error, :step_value]
+
+        @step_counter = StepCounter.start "step counter", initial_value: 100, step_value: 10
+
+        expect(@step_counter.count.value).to eq 100
+        expect(@step_counter.step_value.value).to eq 10
+        @step_counter.slowly_increment
+        expect(@step_counter.count.value).to eq 110
+      end
+
+      it "can access its own proxy" do
+        @actor = WhoAmI.start
 
-  it "can access its own proxy" do
-    @actor = WhoAmI.start
+        expect(await { @actor.me_as_self }).to_not eq @actor
+        expect(await { @actor.me_as_actor }).to eq @actor
+      end
+      it "sends a single positional parameter" do
+        @parameter_handler = ParameterHandler.start
+
+        @parameter_handler.set_values "this"
+        expect(await { @parameter_handler.args }).to eq ["this"]
+      end
 
-    expect(await { @actor.me_as_self }).to_not eq @actor
-    expect(await { @actor.me_as_actor }).to eq @actor
+      it "sends multiple positional parameters" do
+        @parameter_handler = ParameterHandler.start
+
+        @parameter_handler.set_values "this", "that"
+        expect(await { @parameter_handler.args }).to eq ["this", "that"]
+      end
+
+      it "sends keyword parameters" do
+        @parameter_handler = ParameterHandler.start
+
+        @parameter_handler.set_values something: "for nothing", cat: "dog", number: 123
+        expect(await { @parameter_handler.params }).to eq({something: "for nothing", cat: "dog", number: 123})
+      end
+
+      it "sends a mix of positional and keyword parameters" do
+        @parameter_handler = ParameterHandler.start
+
+        @parameter_handler.set_values "what do you say", 123, something: "for nothing"
+        expect(await { @parameter_handler.args }).to eq ["what do you say", 123]
+        expect(await { @parameter_handler.params }).to eq({something: "for nothing"})
+      end
+
+      it "sends a block parameter" do
+        @parameter_handler = ParameterHandler.start
+
+        @parameter_handler.set_values do
+          "HELLO"
+        end
+
+        @block = await { @parameter_handler.block }
+        expect(@block.call).to eq "HELLO"
+      end
+
+      it "sends a mix of positional and keyword parameters with a block" do
+        @parameter_handler = ParameterHandler.start
+
+        @parameter_handler.set_values "what do you say", 123, something: "for nothing" do
+          "BOOM"
+        end
+
+        expect(await { @parameter_handler.args }).to eq ["what do you say", 123]
+        expect(await { @parameter_handler.params }).to eq({something: "for nothing"})
+        @block = await { @parameter_handler.block }
+        expect(@block.call).to eq "BOOM"
+      end
+    end
   end
 
-  context "inline" do
+  context "Inline mode only" do
     around :example do |example|
       Plumbing.configure mode: :inline, &example
     end
@@ -182,7 +258,7 @@ RSpec.describe Plumbing::Actor do
   end
 
   [:threaded, :async].each do |mode|
-    context mode.to_s do
+    context "Asynchronously (#{mode})" do
       around :example do |example|
         Sync do
           Plumbing.configure mode: mode, &example
@@ -246,7 +322,7 @@ RSpec.describe Plumbing::Actor do
     end
   end
 
-  context "threaded" do
+  context "Threaded mode only" do
     around :example do |example|
       Plumbing.configure mode: :threaded, &example
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-plumbing
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: globalid