standard-procedure-plumbing 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 245665ccd98b92e9b49ae532c7efb1edb155b895e6db935cee4de16d8039a96c
-  data.tar.gz: 0a2b802e5e09dbc6f08259f0812c03bdb869002d90e04d5186f2ee716081ae44
+  metadata.gz: 9a111ce599942b5e33b6928cede476b75e56fd6574625bf50ca82d6d75f3e718
+  data.tar.gz: b1b4c48062aec9d77ec3b917c25723fae8ff2cc4075d9f91c699da3f165b7c84
 SHA512:
-  metadata.gz: 84678167d2319c1e6af1a502485351ec3cb5decc4a6313396a89503e0f04a52803062081eec15fafdf30b55b93ce5bf8cbd6109d4a4872feabeb78fd2d9c959a
-  data.tar.gz: 6a49385767a68aa48c44d110016312563b6517963fd7b338d3b6b0d2106b759d1dc22bd324bec573b3e2b4b1b57aa4dfbc2df19b6ce71e71ed0a51666e3bc3c0
+  metadata.gz: 6d2de706d57ef380e67fcd9d79b3d202ca0741f7ed24552ad62bc63944f1c0a82cdd6123560a6d79a85099218db5c9c966ee602a0ef281ea7d5b0305e1f5a707
+  data.tar.gz: 47de86307b817c0d0399bc06bcac5f78eea3629b93725b785f1dc6a442a300a03ceadde6627f2d198ea296524f584f29a90fa3ec52e5e635507c024241fec5da

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.3.1] - 2024-09-03
+
+ - Added `ignore_result` for queries on Plumbing::Valves
+
 ## [0.3.0] - 2024-08-28
 
  - Added Plumbing::Valve

data/README.md

@@ -156,7 +156,12 @@ An [actor](https://en.wikipedia.org/wiki/Actor_model) defines the messages an ob
 
 [Plumbing::Valve](/lib/plumbing/valve.rb) ensures that all messages received are channelled into a concurrency-safe queue. This allows you to take an existing class and ensures that messages received via its public API are made concurrency-safe.  
 
-Include the Plumbing::Valve module into your class, define the messages the objects can respond to and set the `Plumbing` configuration to set the desired concurrency model.  Messages themselves are split into two categories: commands and queries.  Commands have no return value so when the message is sent, the caller does not block and execution continues immediately.  Queries return a value so the caller must block until the actor has returned a value.  
+Include the Plumbing::Valve module into your class, define the messages the objects can respond to and set the `Plumbing` configuration to set the desired concurrency model.  Messages themselves are split into two categories: commands and queries.  
+
+- Commands have no return value so when the message is sent, the caller does not block, the task is called asynchronously and the caller continues immediately
+- Queries return a value so the caller blocks until the actor has returned a value
+- However, if you call a query and pass `ignore_result: true` then the query will not block, although you will not be able to access the return value - this is for commands that do something and then return a result based on that work (which you may or may not be interested in - see Plumbing::Pipe#add_observer)
+- None of the above applies if the `Plumbing mode` is set to `:inline` (which is the default) - in this case, the actor behaves like normal ruby code
 
 Instead of constructing your object with `.new`, use `.start`.  This builds a proxy object that wraps the target instance and dispatches messages through a safe mechanism.  Only messages that have been defined as part of the valve are available in this proxy - so you don't have to worry about callers bypassing the valve's internal context.  
 
@@ -175,7 +180,7 @@ Also be aware that if you use valves in one place, you need to use them everywhe
     attr_reader :name, :job_title
 
     include Plumbing::Valve
-    query :name, :job_title
+    query :name, :job_title, :greet_slowly
     command :promote
 
     def initialize(name)
@@ -187,6 +192,11 @@ Also be aware that if you use valves in one place, you need to use them everywhe
       sleep 0.5
       @job_title = "Sales manager"
     end
+
+    def greet_slowly 
+      sleep 0.2
+      "H E L L O"
+    end
   end
 ```
 
@@ -206,6 +216,12 @@ Also be aware that if you use valves in one place, you need to use them everywhe
   # this will block for 0.5 seconds
   puts @person.job_title
   # => "Sales manager"
+
+  @person.greet_slowly 
+  # this will block for 0.2 seconds before returning "H E L L O"
+
+  @person.greet_slowly(ignore_result: true)
+  # this will block for 0.2 seconds (as the mode is :inline) before returning nil
 ```
 
 [Using fibers](/spec/examples/valve_spec.rb) with concurrency but no parallelism
@@ -226,6 +242,12 @@ Also be aware that if you use valves in one place, you need to use them everywhe
   # this will return immediately without blocking
   puts @person.job_title
   # => "Sales manager" (this will block for 0.5s because #job_title query will not start until the #promote command has completed)
+
+  @person.greet_slowly 
+  # this will block for 0.2 seconds before returning "H E L L O"
+
+  @person.greet_slowly(ignore_result: true)
+  # this will not block and returns nil
 ```
 
 ## Plumbing::Pipe - a composable observer

data/checksums/standard-procedure-plumbing-0.3.1.gem.sha512

@@ -0,0 +1 @@
+966c4bcf848d26272cf0b3bb3d74c9724aa9899a8bcbf5e25a6ce20608de1f529dc766056aa0cb99fbe1c7d6e16afe72acbcc0619fc14f57f01eb7921be7b653

data/lib/plumbing/valve/async.rb

@@ -30,6 +30,7 @@ module Plumbing
         rescue
           nil
         end
+        nil
       end
 
       private

data/lib/plumbing/valve/inline.rb

@@ -13,6 +13,7 @@ module Plumbing
       # Tell the target to execute the given message
       def tell(message, ...)
         @target.send(message, ...)
+        nil
       end
     end
   end

data/lib/plumbing/valve.rb

@@ -51,8 +51,8 @@ module Plumbing
       def build_proxy_class
         Class.new(proxy_base_class).tap do |proxy_class|
           queries.each do |query|
-            proxy_class.define_method query do |*args, **params, &block|
-              ask(query, *args, **params, &block)
+            proxy_class.define_method query do |*args, ignore_result: false, **params, &block|
+              ignore_result ? tell(query, *args, **params, &block) : ask(query, *args, **params, &block)
             end
           end
 

data/lib/plumbing/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-plumbing
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies: []
 description: A composable event pipeline and sequential pipelines of operations
 email:
@@ -33,6 +33,7 @@ files:
 - checksums/standard-procedure-plumbing-0.2.1.gem.sha512
 - checksums/standard-procedure-plumbing-0.2.2.gem.sha512
 - checksums/standard-procedure-plumbing-0.3.0.gem.sha512
+- checksums/standard-procedure-plumbing-0.3.1.gem.sha512
 - lib/plumbing.rb
 - lib/plumbing/config.rb
 - lib/plumbing/custom_filter.rb