standard-procedure-plumbing 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6074870313ece34eb4b9565602db4de70bb5b7e14e8a9051d85bb46b6fc64bf5
-  data.tar.gz: a81292b0ad9e87dfcce61d531e891c1b4ed25ccda3331ceb731c082c6e9c7c16
+  metadata.gz: 245665ccd98b92e9b49ae532c7efb1edb155b895e6db935cee4de16d8039a96c
+  data.tar.gz: 0a2b802e5e09dbc6f08259f0812c03bdb869002d90e04d5186f2ee716081ae44
 SHA512:
-  metadata.gz: 45827e921f7bc272e0688a6477d405a81e8c9ea64405078782fbf5aa45658066bf7f9c5503692f4f6eadfdbb08d21221eb4e0b0731654e4808e0f7ec1111f9bb
-  data.tar.gz: 1ba319545accf7051393845b1883d5eb69aeacba182c86f26ca6e95e7761711e922904d2ec5427872e8dcd6ccdf5fba25737fe5c20a887cc06ba23ab2184c81a
+  metadata.gz: 84678167d2319c1e6af1a502485351ec3cb5decc4a6313396a89503e0f04a52803062081eec15fafdf30b55b93ce5bf8cbd6109d4a4872feabeb78fd2d9c959a
+  data.tar.gz: 6a49385767a68aa48c44d110016312563b6517963fd7b338d3b6b0d2106b759d1dc22bd324bec573b3e2b4b1b57aa4dfbc2df19b6ce71e71ed0a51666e3bc3c0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.0] - 2024-08-28
+
+ - Added Plumbing::Valve
+ - Reimplemented Plumbing::Pipe to use Plumbing::Valve
+
 ## [0.2.2] - 2024-08-25
 
  - Added Plumbing::RubberDuck

data/CODE_OF_CONDUCT.md

@@ -1,84 +1,5 @@
 # Contributor Covenant Code of Conduct
 
-## Our Pledge
+**BE NICE**
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rahoulb@echodek.co. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+If people think you're being a dick, you're probably being a dick, so stop it.  

data/README.md

@@ -1,215 +1,387 @@
 # Plumbing
 
+## Configuration 
+
+The most important configuration setting is the `mode`, which governs how messages are handled by Valves.   
+
+By default it is `:inline`, so every command or query is handled synchronously.  
+
+If it is set to `:async`, commands and queries will be handled using fibers (via the [Async gem](https://socketry.github.io/async/index.html)).
+
+The `timeout` setting is used when performing queries - it defaults to 30s.  
+
+```ruby
+  require "plumbing"
+  puts Plumbing.config.mode 
+  # => :inline
+
+  Plumbing.configure mode: :async, timeout: 10
+
+  puts Plumbing.config.mode 
+  # => :async
+```
+
+If you are running a test suite, you can temporarily update the configuration by passing a block.  
+
+```ruby
+  require "plumbing"
+  puts Plumbing.config.mode 
+  # => :inline
+
+  Plumbing.configure mode: :async do 
+    puts Plumbing.config.mode 
+    # => :async
+    first_test
+    second_test
+  end
+
+  puts Plumbing.config.mode 
+  # => :inline
+```
+
 ## Plumbing::Pipeline - transform data through a pipeline
 
-Define a sequence of operations that proceed in order, passing their output from one operation as the input to another.
+Define a sequence of operations that proceed in order, passing their output from one operation as the input to another.  [Unix pipes](https://en.wikipedia.org/wiki/Pipeline_(Unix)) in Ruby.  
 
 Use `perform` to define a step that takes some input and returns a different output.  
-Use `execute` to define a step that takes some input and returns that same input.  
-Use `embed` to define a step that uses another `Plumbing::Chain` class to generate the output.  
-
-If you have [dry-validation](https://dry-rb.org/gems/dry-validation/1.10/) installed, you can validate your input using a `Dry::Validation::Contract`.  
+  Specify `using` to re-use an existing `Plumbing::Pipeline` as a step within this pipeline.  
+Use `execute` to define a step that takes some input, performs an action but passes the input, unchanged, to the next step.  
 
-If you don't want to use dry-validation, you can instead define a `pre_condition` (although there's nothing to stop you defining a contract as well as pre_conditions - with the contract being verified first).  
+If you have [dry-validation](https://dry-rb.org/gems/dry-validation/1.10/) installed, you can validate your input using a `Dry::Validation::Contract`.  Alternatively, you can define a `pre_condition` to test that the inputs are valid.  
 
 You can also verify that the output generated is as expected by defining a `post_condition`.  
 
 ### Usage:
 
+[Building an array using multiple steps with a pre-condition and post-condition](/spec/examples/pipeline_spec.rb)
+
 ```ruby
-require "plumbing"
-class BuildSequence < Plumbing::Pipeline 
-  pre_condition :must_be_an_array do |input| 
-    # you could replace this with a `validate` definition (using a Dry::Validation::Contract) if you prefer
-    input.is_a? Array 
-  end
+  require "plumbing"
+  class BuildArray < Plumbing::Pipeline
+    perform :add_first
+    perform :add_second
+    perform :add_third
+
+    pre_condition :must_be_an_array do |input|
+      input.is_a? Array
+    end
 
-  post_condition :must_have_three_elements do |output|
-    # this is a stupid post-condition but 🤷🏾‍♂️, this is just an example
-    output.length == 3
-  end
+    post_condition :must_have_three_elements do |output|
+      output.length == 3
+    end
 
-  perform :add_first
-  perform :add_second
-  perform :add_third
+    private
 
-  private 
+    def add_first(input) = input << "first"
 
-  def add_first input 
-    input << "first"
+    def add_second(input) = input << "second"
+
+    def add_third(input) = input << "third"
   end
 
-  def add_second input 
-    input << "second" 
+  BuildArray.new.call []
+  # => ["first", "second", "third"]
+
+  BuildArray.new.call 1
+  # => Plumbing::PreconditionError("must_be_an_array")
+
+  BuildArray.new.call ["extra element"]
+  # => Plumbing::PostconditionError("must_have_three_elements")
+```
+
+[Validating input parameters with a contract](/spec/examples/pipeline_spec.rb)
+```ruby
+  require "plumbing"
+  require "dry/validation"
+
+  class SayHello < Plumbing::Pipeline
+    validate_with "SayHello::Input"
+    perform :say_hello
+
+    private
+
+    def say_hello input
+      "Hello #{input[:name]} - I will now send a load of annoying marketing messages to #{input[:email]}"
+    end
+
+    class Input < Dry::Validation::Contract
+      params do
+        required(:name).filled(:string)
+        required(:email).filled(:string)
+      end
+      rule :email do
+        key.failure("must be a valid email") unless /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i.match? value
+      end
+    end
   end
 
-  def add_third input 
-    input << "third"
+  SayHello.new.call(name: "Alice", email: "alice@example.com")
+  # => Hello Alice - I will now send a load of annoying marketing messages to alice@example.com 
+
+  SayHello.new.call(some: "other data")
+  # => Plumbing::PreConditionError
+```
+
+[Building a pipeline through composition](/spec/examples/pipeline_spec.rb)
+
+```ruby
+  require "plumbing"
+  class ExternalStep < Plumbing::Pipeline
+    perform :add_item_to_array
+
+    private
+
+    def add_item_to_array(input) = input << "external"
   end
-end
 
-BuildSequence.new.call []
-# => ["first", "second", "third"]
+  class BuildSequenceWithExternalStep < Plumbing::Pipeline
+    perform :add_first
+    perform :add_second, using: "ExternalStep"
+    perform :add_third
+
+    private
 
-BuildSequence.new.call 1
-# => Plumbing::PreconditionError("must_be_an_array")
+    def add_first(input) = input << "first"
+
+    def add_third(input) = input << "third"
+  end
 
-BuildSequence.new.call ["extra element"]
-# => Plumbing::PostconditionError("must_have_three_elements")
+  BuildSequenceWithExternalStep.new.call([])
+  # => ["first", "external", "third"]
 ```
 
+## Plumbing::Valve - safe asynchronous objects
 
-## Plumbing::Pipe - a composable observer
+An [actor](https://en.wikipedia.org/wiki/Actor_model) defines the messages an object can receive, similar to a regular object.  However, a normal object if accessed concurrently can have data consistency issues and race conditions leading to hard-to-reproduce bugs.  Actors, however, ensure that, no matter which thread (or fiber) is sending the message, the internal processing of the message (the method definition) is handled sequentially.  This means the internal state of an object is never accessed concurrently, eliminating those issues.  
 
-[Observers](https://ruby-doc.org/3.3.0/stdlibs/observer/Observable.html) in Ruby are a pattern where objects (observers) register their interest in another object (the observable).  This pattern is common throughout programming languages (event listeners in Javascript, the dependency protocol in [Smalltalk](https://en.wikipedia.org/wiki/Smalltalk)).
+[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.  
 
-[Plumbing::Pipe](lib/plumbing/pipe.rb) makes observers "composable".  Instead of simply registering for notifications from the observable, we observe a stream of notifications, which could be produced by multiple observables, all being sent through the same pipe.  We can then chain observers together, composing a "pipeline" of operations from a single source of events.
+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.  
 
-### Usage
+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.  
+
+Even when using actors, there is one condition where concurrency may cause issues.  If object A makes a query to object B which in turn makes a query back to object A, you will hit a deadlock.  This is because A is waiting on the response from B but B is now querying, and waiting for, A.  This does not apply to commands because they do not wait for a response.  However, when writing queries, be careful who you interact with - the configuration allows you to set a timeout (defaulting to 30s) in case this happens.  
+
+Also be aware that if you use valves in one place, you need to use them everywhere - especially if you're using threads or ractors (coming soon).  This is because as the valve sends messages to its collaborators, those calls will be made from within the valve's internal context.  If the collaborators are also valves, the subsequent messages will be handled correctly, if not, data consistency bugs could occur.  
+
+### Usage 
+
+[Defining an actor](/spec/examples/valve_spec.rb)
 
-A simple observer:
 ```ruby
-require "plumbing"
+  require "plumbing"
+  
+  class Employee
+    attr_reader :name, :job_title
+
+    include Plumbing::Valve
+    query :name, :job_title
+    command :promote
+
+    def initialize(name)
+      @name = name
+      @job_title = "Sales assistant"
+    end
 
-@source = Plumbing::Pipe.start
+    def promote
+      sleep 0.5
+      @job_title = "Sales manager"
+    end
+  end
+```
 
-@observer = @source.add_observer do |event|
-  puts event.type
-end
+[Acting inline](/spec/examples/valve_spec.rb) with no concurrency
 
-@source.notify "something_happened", message: "But what was it?"
-# => "something_happened"
+```ruby
+  require "plumbing"
+    
+  @person = Employee.start "Alice"
+
+  puts @person.name
+  # => "Alice"
+  puts @person.job_title
+  # => "Sales assistant"
+
+  @person.promote
+  # this will block for 0.5 seconds
+  puts @person.job_title
+  # => "Sales manager"
 ```
 
-Simple filtering:
+[Using fibers](/spec/examples/valve_spec.rb) with concurrency but no parallelism
+
 ```ruby
-require "plumbing"
+  require "plumbing"
+  require "async"
+
+  Plumbing.configure mode: :async 
+  @person = Employee.start "Alice"
+
+  puts @person.name
+  # => "Alice"
+  puts @person.job_title
+  # => "Sales assistant"
+
+  @person.promote
+  # 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)
+```
+
+## Plumbing::Pipe - a composable observer
+
+[Observers](https://ruby-doc.org/3.3.0/stdlibs/observer/Observable.html) in Ruby are a pattern where objects (observers) register their interest in another object (the observable).  This pattern is common throughout programming languages (event listeners in Javascript, the dependency protocol in [Smalltalk](https://en.wikipedia.org/wiki/Smalltalk)).
 
-@source = Plumbing::Pipe.start
+[Plumbing::Pipe](lib/plumbing/pipe.rb) makes observers "composable".  Instead of simply just registering for notifications from a single observable, we can build sequences of pipes.  These sequences can filter notifications and route them to different listeners, or merge multiple sources into a single stream of notifications.  
 
-@filter = Plumbing::Filter.start source: @source do |event|
-  %w[important urgent].include? event.type 
-end
+Pipes are implemented as valves, meaning that event notifications can be dispatched asynchronously.  The observer's callback will be triggered from within the pipe's internal context so you should immediately trigger a command on another valve to maintain safety.  
 
-@observer = @filter.add_observer do |event|
-  puts event.type
-end
+### Usage
+
+[A simple observer](/spec/examples/pipe_spec.rb):
+```ruby
+  require "plumbing"
 
-@source.notify "important", message: "ALERT! ALERT!"
-# => "important"
+  @source = Plumbing::Pipe.start
+  @observer = @source.add_observer do |event|
+    puts event.type
+  end
 
-@source.notify "unimportant", message: "Nothing to see here"
-# => <no output>
+  @source.notify "something_happened", message: "But what was it?"
+  # => "something_happened"
 ```
 
-Custom filtering:
+[Simple filtering](/spec/examples/pipe_spec.rb):
 ```ruby
-require "plumbing"
+  require "plumbing"
 
-class EveryThirdEvent < Plumbing::CustomFilter
-  def initialize source:
-    super source: source
-    @events = []
+  @source = Plumbing::Pipe.start
+  @filter = Plumbing::Filter.start source: @source do |event|
+    %w[important urgent].include? event.type 
+  end
+  @observer = @filter.add_observer do |event|
+    puts event.type
   end
 
-  def received event
-    @events << event
-    # if we've already stored 2 events in the buffer then broadcast the newest event and clear the buffer
-    if @events.count >= 2
-      @events.clear
-      self << event
+  @source.notify "important", message: "ALERT! ALERT!"
+  # => "important"
+  @source.notify "unimportant", message: "Nothing to see here"
+  # => <no output>
+```
+
+[Custom filtering](/spec/examples/pipe_spec.rb):
+```ruby
+  require "plumbing"
+  class EveryThirdEvent < Plumbing::CustomFilter
+    def initialize source:
+      super source: source
+      @events = []
     end
-  end
-end
 
-@source = Plumbing::Pipe.start
-@filter = EveryThirdEvent.new(source: @source)
+    def received event
+      # store this event into our buffer
+      @events << event
+      # if this is the third event we've received then clear the buffer and broadcast the latest event
+      if @events.count >= 3
+        @events.clear
+        self << event
+      end
+    end
+  end
 
-@observer = @filter.add_observer do |event|
-  puts event.type
-end
+  @source = Plumbing::Pipe.start
+  @filter = EveryThirdEvent.start(source: @source)
+  @observer = @filter.add_observer do |event|
+    puts event.type
+  end
 
-1.upto 10 do |i|
-  @source.notify i.to_s
-end
-# => "3"
-# => "6"
-# => "9"
+  1.upto 10 do |i|
+    @source.notify i.to_s
+  end
+  # => "3"
+  # => "6"
+  # => "9"
 ```
 
-Joining multiple sources
+[Joining multiple sources](/spec/examples/pipe_spec.rb):
 ```ruby
-require "plumbing"
+  require "plumbing"
 
-@first_source = Plumbing::Pipe.start
-@second_source = Plumbing::Pipe.start
+  @first_source = Plumbing::Pipe.start
+  @second_source = Plumbing::Pipe.start
 
-@junction = Plumbing::Junction.start @first_source, @second_source
+  @junction = Plumbing::Junction.start @first_source, @second_source
 
-@observer = @junction.add_observer do |event|
-  puts event.type
-end
+  @observer = @junction.add_observer do |event|
+    puts event.type
+  end
 
-@first_source.notify "one"
-# => "one"
-@second_source.notify "two"
-# => "two"
+  @first_source.notify "one"
+  # => "one"
+  @second_source.notify "two"
+  # => "two"
 ```
 
-Dispatching events asynchronously (using Fibers)
+[Dispatching events asynchronously (using Fibers)](/spec/examples/pipe_spec.rb):
 ```ruby
-require "plumbing"
-require "plumbing/event_dispatcher/fiber"
-require "async"
+  require "plumbing"
+  require "async"
 
-# `limit` controls how many fibers can dispatch events concurrently - the default is 4
-@first_source = Plumbing::Pipe.start dispatcher: Plumbing::EventDispatcher::Fiber.new limit: 8
-@second_source = Plumbing::Pipe.start dispatcher: Plumbing::EventDispatcher::Fiber.new limit: 2
+  Plumbing.configure mode: :async 
 
-@junction = Plumbing::Junction.start @first_source, @second_source, dispatcher: Plumbing::EventDispatcher::Fiber.new
+  Sync do 
+    @first_source = Plumbing::Pipe.start 
+    @second_source = Plumbing::Pipe.start
 
-@filter = Plumbing::Filter.start source: @junction, dispatcher: Plumbing::EventDispatcher::Fibernew do |event|
-  %w[one-one two-two].include? event.type 
-end
+    @junction = Plumbing::Junction.start @first_source, @second_source
 
-Sync do 
-  @first_source.notify "one-one"
-  @first_source.notify "one-two"
-  @second_source.notify "two-one"
-  @second_source.notify "two-two"
-end
-```
+    @filter = Plumbing::Filter.start source: @junction do |event|
+      %w[one-one two-two].include? event.type 
+    end
 
+    @first_source.notify "one-one"
+    @first_source.notify "one-two"
+    @second_source.notify "two-one"
+    @second_source.notify "two-two"
+  end
+```
 
 ## Plumbing::RubberDuck - duck types and type-casts
 
-Define an [interface or protocol](https://en.wikipedia.org/wiki/Interface_(object-oriented_programming) specifying which messages you expect to be able to send.  Then cast an object into that type, which first tests that the object can respond to those messages and limits you to sending those messages and no others.  
+Define an [interface or protocol](https://en.wikipedia.org/wiki/Interface_(object-oriented_programming)) specifying which messages you expect to be able to send.  Then cast an object into that type, which first tests that the object can respond to those messages and then builds a proxy that responds to just those messages and no others (so no-one can abuse the specific type-casting you have specified).  However, if you take one of these proxies, you can safely re-cast it as another type (as long as the original target object is castable).
 
 
 ### Usage 
 
 Define your interface (Person in this example), then cast your objects (instances of PersonData and CarData).  
 
+[Casting objects as duck-types](/spec/examples/rubber_duck_spec.rb):
 ```ruby
-require "plumbing"
-
-Person = Plumbing::RubberDuck.define :first_name, :last_name, :email 
-
-PersonData = Struct.new(:first_name, :last_name, :email, :favourite_food)
-CarData = Struct.new(:make, :model, :colour)
-
-@porsche_911 = CarData.new "Porsche", "911", "black"
-@person = @porsche_911.as Person
-# => Raises a TypeError 
-
-@alice = PersonData.new "Alice", "Aardvark", "alice@example.com", "Ice cream"
-@person = @alice.as Person
-@person.first_name
-# => "Alice"
-@person.email 
-# => "alice@example.com"
-@person.favourite_food
-# => NoMethodError - even though :favourite_food is a field in PersonData, it is not included in the definition of Person so cannot be accessed through the RubberDuck type
+  require "plumbing"
+
+  Person = Plumbing::RubberDuck.define :first_name, :last_name, :email 
+  LikesFood = Plumbing::RubberDuck.define :favourite_food 
+
+  PersonData = Struct.new(:first_name, :last_name, :email, :favourite_food)
+  CarData = Struct.new(:make, :model, :colour)
+
+  @porsche_911 = CarData.new "Porsche", "911", "black"
+  @person = @porsche_911.as Person
+  # => Raises a TypeError as CarData does not respond_to #first_name, #last_name, #email
+
+  @alice = PersonData.new "Alice", "Aardvark", "alice@example.com", "Ice cream"
+  @person = @alice.as Person
+  @person.first_name
+  # => "Alice"
+  @person.email 
+  # => "alice@example.com"
+  @person.favourite_food
+  # => NoMethodError - #favourite_food is not part of the Person rubber duck (even though it is part of the underlying PersonData struct)
+
+  # Cast our Person into a LikesFood rubber duck
+  @hungry = @person.as LikesFood 
+  @hungry.favourite_food 
+  # => "Ice cream"
 ```
 
 ## Installation

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

@@ -0,0 +1 @@
+f9f003afc58c61f5cf75127e1c92e95aebeb8f414e47bbd80661cedfbe379709ba22246f759e6ba1c8a8986f57ef6cb5d615157633e18abc6a3fa518325dc544

data/lib/plumbing/config.rb

@@ -0,0 +1,51 @@
+# Pipes, pipelines, valves and rubber ducks
+module Plumbing
+  Config = Data.define :mode, :valve_proxy_classes, :timeout do
+    def valve_proxy_class_for target_class
+      valve_proxy_classes[target_class]
+    end
+
+    def register_valve_proxy_class_for target_class, proxy_class
+      valve_proxy_classes[target_class] = proxy_class
+    end
+  end
+  private_constant :Config
+
+  # Access the current configuration
+  # @return [Config]
+  def self.config
+    configs.last
+  end
+
+  # Configure the plumbing
+  # @param params [Hash] the configuration options
+  # @option mode [Symbol] the mode to use (:inline is the default, :async uses fibers)
+  # @option timeout [Integer] the timeout (in seconds) to use (30s is the default)
+  # @yield optional block - after the block has completed its execution, the configuration is restored to its previous state (useful for test suites)
+  def self.configure(**params, &block)
+    new_config = Config.new(**config.to_h.merge(params).merge(valve_proxy_classes: {}))
+    if block.nil?
+      set_configuration_to new_config
+    else
+      set_configuration_and_yield new_config, &block
+    end
+  end
+
+  def self.set_configuration_to config
+    configs << config
+  end
+  private_class_method :set_configuration_to
+
+  def self.set_configuration_and_yield(new_config, &block)
+    set_configuration_to new_config
+    yield
+  ensure
+    configs.pop
+  end
+  private_class_method :set_configuration_and_yield
+
+  def self.configs
+    @configs ||= [Config.new(mode: :inline, timeout: 30, valve_proxy_classes: {})]
+  end
+  private_class_method :configs
+end

data/lib/plumbing/custom_filter.rb

@@ -0,0 +1,15 @@
+module Plumbing
+  # A pipe that can be subclassed to filter events from a source pipe
+  class CustomFilter < Pipe
+    # Chain this pipe to the source pipe
+    # @param source [Plumbing::Observable] the source from which to receive and filter events
+    def initialize source:
+      super()
+      source.as(Observable).add_observer { |event| received event }
+    end
+
+    protected
+
+    def received(event) = raise NoMethodError.new("Subclass should define #received")
+  end
+end

data/lib/plumbing/event.rb

@@ -1,5 +1,4 @@
 module Plumbing
   # An immutable data structure representing an Event
-  Event = Data.define :type, :data do
-  end
+  Event = Data.define :type, :data
 end

data/lib/plumbing/filter.rb

@@ -1,20 +1,20 @@
+require_relative "custom_filter"
 module Plumbing
   # A pipe that filters events from a source pipe
-  class Filter < Pipe
+  class Filter < CustomFilter
     # Chain this pipe to the source pipe
-    # @param source [Plumbing::Pipe]
+    # @param source [Plumbing::Observable] the source from which to receive and filter events
     # @param &accepts [Block] a block that returns a boolean value - true to accept the event, false to reject it
-    def initialize source:, dispatcher: nil, &accepts
-      super(dispatcher: dispatcher)
+    # @yield [Plumbing::Event] event the event that is currently being processed
+    # @yieldreturn [Boolean] true to accept the event, false to reject it
+    def initialize source:, &accepts
+      super(source: source)
       @accepts = accepts.as(Callable)
-      source.as(Observable).add_observer do |event|
-        filter_and_republish event
-      end
     end
 
-    private
+    protected
 
-    def filter_and_republish event
+    def received(event)
       return nil unless @accepts.call event
       dispatch event
     end

data/lib/plumbing/junction.rb

@@ -2,9 +2,9 @@ module Plumbing
   # A pipe that filters events from a source pipe
   class Junction < Pipe
     # Chain multiple sources to this pipe
-    # @param [Array<Plumbing::Pipe>]
-    def initialize *sources, dispatcher: nil
-      super(dispatcher: dispatcher)
+    # @param sources [Array<Plumbing::Observable>] the sources which will be joined and relayed
+    def initialize *sources
+      super()
       @sources = sources.collect { |source| add(source) }
     end
 

data/lib/plumbing/pipe.rb

@@ -1,12 +1,10 @@
 module Plumbing
   # A basic pipe
   class Pipe
-    require_relative "event_dispatcher"
+    include Plumbing::Valve
 
-    # Subclasses should call `super()` to ensure the pipe is initialised corrected
-    def initialize dispatcher: nil
-      @dispatcher = dispatcher.nil? ? EventDispatcher.new : dispatcher.as(DispatchesEvents)
-    end
+    command :notify, :<<, :remove_observer, :shutdown
+    query :add_observer, :is_observer?
 
     # Push an event into the pipe
     # @param event [Plumbing::Event] the event to push into the pipe
@@ -25,40 +23,33 @@ module Plumbing
     end
 
     # Add an observer to this pipe
-    # @param callable [Proc] (optional)
-    # @param &block [Block] (optional)
-    # @return an object representing this observer (dependent upon the implementation of the pipe itself)
     # Either a `callable` or a `block` must be supplied.  If the latter, it is converted to a [Proc]
-    def add_observer(observer = nil, &)
-      @dispatcher.add_observer(observer, &)
+    # @param callable [#call] (optional)
+    # @param &block [Block] (optional)
+    # @return [#call]
+    def add_observer(observer = nil, &block)
+      observer ||= block.to_proc
+      observers << observer.as(Callable).target
+      observer
     end
 
     # Remove an observer from this pipe
-    # @param observer
-    # This removes the given observer from this pipe.  The observer should have previously been returned by #add_observer and is implementation-specific
+    # @param observer [#call] remove the observer from this pipe (where the observer was previously added by #add_observer)
     def remove_observer observer
-      @dispatcher.remove_observer observer
+      observers.delete observer
     end
 
     # Test whether the given observer is observing this pipe
-    # @param observer
-    # @return [boolean]
+    # @param [#call] observer
+    # @return [Boolean]
     def is_observer? observer
-      @dispatcher.is_observer? observer
+      observers.include? observer
     end
 
     # Close this pipe and perform any cleanup.
     # Subclasses should override this to perform their own shutdown routines and call `super` to ensure everything is tidied up
     def shutdown
-      # clean up and release any observers, just in case
-      @dispatcher.shutdown
-    end
-
-    # Start this pipe
-    # Subclasses may override this method to add any implementation specific details.
-    # By default any supplied parameters are called to the subclass' `initialize` method
-    def self.start(*, **, &)
-      new(*, **, &)
+      observers.clear
     end
 
     protected
@@ -68,7 +59,16 @@ module Plumbing
     # Enumerates all observers and `calls` them with this event
     # Discards any errors raised by the observer so that all observers will be successfully notified
     def dispatch event
-      @dispatcher.dispatch event
+      observers.each do |observer|
+        observer.call event
+      rescue => ex
+        puts ex
+        ex
+      end
+    end
+
+    def observers
+      @observers ||= []
     end
   end
 end

data/lib/plumbing/pipeline/contracts.rb

@@ -1,14 +1,24 @@
 module Plumbing
   class Pipeline
+    # Validate input and output data with pre and post conditions or [Dry::Validation::Contract]s
     module Contracts
+      # @param name [Symbol] the name of the precondition
+      # @param &validator [Block] a block that returns a boolean value - true to accept the input, false to reject it
+      # @yield [Object] input the input data to be validated
+      # @yieldreturn [Boolean] true to accept the input, false to reject it
       def pre_condition name, &validator
         pre_conditions[name.to_sym] = validator
       end
 
+      # @param [String] contract_class the class name of the [Dry::Validation::Contract] that will be used to validate the input data
       def validate_with contract_class
         @validation_contract = contract_class
       end
 
+      # @param name [Symbol] the name of the postcondition
+      # @param &validator [Block] a block that returns a boolean value - true to accept the input, false to reject it
+      # @yield [Object] output the output data to be validated
+      # @yieldreturn [Boolean] true to accept the output, false to reject it
       def post_condition name, &validator
         post_conditions[name.to_sym] = validator
       end

data/lib/plumbing/pipeline/operations.rb

@@ -1,10 +1,26 @@
 module Plumbing
   class Pipeline
+    # Defining the operations that will be performed on the input data
     module Operations
+      # Add an operation to the pipeline
+      # Operations are processed in order, unless interrupted by an exception
+      # The output from the previous operation is fed in as the input to the this operation
+      # and the output from this operation is fed in as the input to the next operation
+      #
+      # @param method [Symbol] the method to be called on the input data
+      # @param using [String, Class] the optional class name or class that will be used to perform the operation
+      # @param &implementation [Block] the optional block that will be used to perform the operation (instead of calling a method)
+      # @yield [Object] input the input data to be processed
+      # @yieldreturn [Object] the output data
       def perform method, using: nil, &implementation
         using.nil? ? perform_internal(method, &implementation) : perform_external(method, using)
       end
 
+      # Add an operation which does not alter the input data to the pipeline
+      # The output from the previous operation is fed in as the input to the this operation
+      # but the output from this operation is discarded and the previous input is fed in to the next operation
+      #
+      # @param method [Symbol] the method to be called on the input data
       def execute method
         implementation ||= ->(input, instance) do
           instance.send(method, input)
@@ -13,6 +29,7 @@ module Plumbing
         operations << implementation
       end
 
+      # Internal use only
       def _call input, instance
         validate_contract_for input
         validate_preconditions_for input

data/lib/plumbing/pipeline.rb

@@ -7,6 +7,9 @@ module Plumbing
     extend Plumbing::Pipeline::Contracts
     extend Plumbing::Pipeline::Operations
 
+    # Start the pipeline operation with the given input
+    # @param input [Object] the input data to be processed
+    # @return [Object] the output data
     def call input
       self.class._call input, self
     end

data/lib/plumbing/rubber_duck/object.rb

@@ -1,6 +1,8 @@
 module Plumbing
   class RubberDuck
     ::Object.class_eval do
+      # Cast the object to a duck-type
+      # @return [Plumbing::RubberDuck::Proxy] the duck-type proxy
       def as duck_type
         duck_type.proxy_for self
       end

data/lib/plumbing/rubber_duck/proxy.rb

@@ -1,5 +1,6 @@
 module Plumbing
   class RubberDuck
+    # Proxy object that forwards the duck-typed methods to the target object
     class Proxy
       attr_reader :target
 
@@ -8,6 +9,8 @@ module Plumbing
         @duck_type = duck_type
       end
 
+      # Convert the proxy to the given duck-type, ensuring that existing proxies are not duplicated
+      # @return [Plumbing::RubberDuck::Proxy] the proxy for the given duck-type
       def as duck_type
         (duck_type == @duck_type) ? self : duck_type.proxy_for(target)
       end

data/lib/plumbing/rubber_duck.rb

@@ -9,16 +9,25 @@ module Plumbing
       @proxy_classes = {}
     end
 
+    # Verify that the given object responds to the required methods
+    # @param object [Object] the object to verify
+    # @return [Object] the object if it passes the verification
+    # @raise [TypeError] if the object does not respond to the required methods
     def verify object
       missing_methods = @methods.reject { |method| object.respond_to? method }
       raise TypeError, "Expected object to respond to #{missing_methods.join(", ")}" unless missing_methods.empty?
       object
     end
 
+    # Test if the given object is a proxy
+    # @param object [Object] the object to test
+    # @return [Boolean] true if the object is a proxy, false otherwise
     def proxy_for object
       is_a_proxy?(object) || build_proxy_for(object)
     end
 
+    # Define a new rubber duck type
+    # @param *methods [Array<Symbol>] the methods that the duck-type should respond to
     def self.define *methods
       new(*methods)
     end

data/lib/plumbing/valve/async.rb

@@ -0,0 +1,42 @@
+require "async"
+require "async/semaphore"
+require "timeout"
+
+module Plumbing
+  module Valve
+    class Async
+      attr_reader :target
+
+      def initialize target
+        @target = target
+        @queue = []
+        @semaphore = ::Async::Semaphore.new(1)
+      end
+
+      # Ask the target to answer the given message
+      def ask(message, *args, **params, &block)
+        task = @semaphore.async do
+          @target.send message, *args, **params, &block
+        end
+        Timeout.timeout(timeout) do
+          task.wait
+        end
+      end
+
+      # Tell the target to execute the given message
+      def tell(message, *args, **params, &block)
+        @semaphore.async do |task|
+          @target.send message, *args, **params, &block
+        rescue
+          nil
+        end
+      end
+
+      private
+
+      def timeout
+        Plumbing.config.timeout
+      end
+    end
+  end
+end

data/lib/plumbing/valve/inline.rb

@@ -0,0 +1,19 @@
+module Plumbing
+  module Valve
+    class Inline
+      def initialize target
+        @target = target
+      end
+
+      # Ask the target to answer the given message
+      def ask(message, ...)
+        @target.send(message, ...)
+      end
+
+      # Tell the target to execute the given message
+      def tell(message, ...)
+        @target.send(message, ...)
+      end
+    end
+  end
+end

data/lib/plumbing/valve/message.rb

@@ -0,0 +1,5 @@
+module Plumbing
+  module Valve
+    Message = Struct.new :message, :args, :params, :block, :result, :status
+  end
+end

data/lib/plumbing/valve.rb

@@ -0,0 +1,71 @@
+require_relative "valve/inline"
+
+module Plumbing
+  module Valve
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Create a new valve instance and build a proxy for it using the current mode
+      # @return [Plumbing::Valve::Base] the proxy for the valve instance
+      def start(*, **, &)
+        build_proxy_for(new(*, **, &))
+      end
+
+      # Define the queries that this valve can answer
+      # @param names [Array<Symbol>] the names of the queries
+      def query(*names) = queries.concat(names.map(&:to_sym))
+
+      # List the queries that this valve can answer
+      def queries = @queries ||= []
+
+      # Define the commands that this valve can execute
+      # @param names [Array<Symbol>] the names of the commands
+      def command(*names) = commands.concat(names.map(&:to_sym))
+
+      # List the commands that this valve can execute
+      def commands = @commands ||= []
+
+      def inherited subclass
+        subclass.commands.concat commands
+        subclass.queries.concat queries
+      end
+
+      private
+
+      def build_proxy_for(target)
+        proxy_class_for(target.class).new(target)
+      end
+
+      def proxy_class_for target_class
+        Plumbing.config.valve_proxy_class_for(target_class) || register_valve_proxy_class_for(target_class)
+      end
+
+      def proxy_base_class = const_get "Plumbing::Valve::#{Plumbing.config.mode.to_s.capitalize}"
+
+      def register_valve_proxy_class_for target_class
+        Plumbing.config.register_valve_proxy_class_for(target_class, build_proxy_class)
+      end
+
+      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)
+            end
+          end
+
+          commands.each do |command|
+            proxy_class.define_method command do |*args, **params, &block|
+              tell(command, *args, **params, &block)
+              nil
+            rescue
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plumbing/version.rb

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

data/lib/plumbing.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Plumbing
+  require_relative "plumbing/config"
+  require_relative "plumbing/valve"
   require_relative "plumbing/rubber_duck"
   require_relative "plumbing/types"
   require_relative "plumbing/error"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-plumbing
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-25 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies: []
 description: A composable event pipeline and sequential pipelines of operations
 email:
@@ -32,11 +32,12 @@ files:
 - checksums/standard-procedure-plumbing-0.2.0.gem.sha512
 - 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
 - lib/plumbing.rb
+- lib/plumbing/config.rb
+- lib/plumbing/custom_filter.rb
 - lib/plumbing/error.rb
 - lib/plumbing/event.rb
-- lib/plumbing/event_dispatcher.rb
-- lib/plumbing/event_dispatcher/fiber.rb
 - lib/plumbing/filter.rb
 - lib/plumbing/junction.rb
 - lib/plumbing/pipe.rb
@@ -47,6 +48,10 @@ files:
 - lib/plumbing/rubber_duck/object.rb
 - lib/plumbing/rubber_duck/proxy.rb
 - lib/plumbing/types.rb
+- lib/plumbing/valve.rb
+- lib/plumbing/valve/async.rb
+- lib/plumbing/valve/inline.rb
+- lib/plumbing/valve/message.rb
 - lib/plumbing/version.rb
 - sig/plumbing.rbs
 homepage: https://github.com/standard-procedure/plumbing

data/lib/plumbing/event_dispatcher/fiber.rb

@@ -1,61 +0,0 @@
-require "async/task"
-require "async/semaphore"
-
-module Plumbing
-  class EventDispatcher
-    class Fiber < EventDispatcher
-      def initialize limit: 4
-        super()
-        @semaphore = Async::Semaphore.new(limit)
-        @queue = Set.new
-        @paused = false
-      end
-
-      def dispatch event
-        @queue << event
-        dispatch_events unless @paused
-      end
-
-      def pause
-        @paused = true
-      end
-
-      def resume
-        @paused = false
-        dispatch_events
-      end
-
-      def queue_size
-        @queue.size
-      end
-
-      def shutdown
-        super
-        @queue.clear
-      end
-
-      private
-
-      def dispatch_events
-        @semaphore.async do |task|
-          events = @queue.dup
-          @queue.clear
-          events.each do |event|
-            dispatch_event event, task
-          end
-        end
-      end
-
-      def dispatch_event event, task
-        @observers.each do |observer|
-          task.async do
-            observer.call event
-          rescue => ex
-            puts ex
-            ex
-          end
-        end
-      end
-    end
-  end
-end

data/lib/plumbing/event_dispatcher.rb

@@ -1,34 +0,0 @@
-module Plumbing
-  class EventDispatcher
-    def initialize observers: []
-      @observers = observers.as(Collection)
-    end
-
-    def add_observer observer = nil, &block
-      observer ||= block.to_proc
-      @observers << observer.as(Callable).target
-      observer
-    end
-
-    def remove_observer observer
-      @observers.delete observer
-    end
-
-    def is_observer? observer
-      @observers.include? observer
-    end
-
-    def dispatch event
-      @observers.each do |observer|
-        observer.call event
-      rescue => ex
-        puts ex
-        ex
-      end
-    end
-
-    def shutdown
-      @observers = []
-    end
-  end
-end