standard-procedure-plumbing 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6074870313ece34eb4b9565602db4de70bb5b7e14e8a9051d85bb46b6fc64bf5
-  data.tar.gz: a81292b0ad9e87dfcce61d531e891c1b4ed25ccda3331ceb731c082c6e9c7c16
+  metadata.gz: 9a111ce599942b5e33b6928cede476b75e56fd6574625bf50ca82d6d75f3e718
+  data.tar.gz: b1b4c48062aec9d77ec3b917c25723fae8ff2cc4075d9f91c699da3f165b7c84
 SHA512:
-  metadata.gz: 45827e921f7bc272e0688a6477d405a81e8c9ea64405078782fbf5aa45658066bf7f9c5503692f4f6eadfdbb08d21221eb4e0b0731654e4808e0f7ec1111f9bb
-  data.tar.gz: 1ba319545accf7051393845b1883d5eb69aeacba182c86f26ca6e95e7761711e922904d2ec5427872e8dcd6ccdf5fba25737fe5c20a887cc06ba23ab2184c81a
+  metadata.gz: 6d2de706d57ef380e67fcd9d79b3d202ca0741f7ed24552ad62bc63944f1c0a82cdd6123560a6d79a85099218db5c9c966ee602a0ef281ea7d5b0305e1f5a707
+  data.tar.gz: 47de86307b817c0d0399bc06bcac5f78eea3629b93725b785f1dc6a442a300a03ceadde6627f2d198ea296524f584f29a90fa3ec52e5e635507c024241fec5da

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.3.1] - 2024-09-03
+
+ - Added `ignore_result` for queries on Plumbing::Valves
+
+## [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,409 @@
 # 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.  
+  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 have [dry-validation](https://dry-rb.org/gems/dry-validation/1.10/) installed, you can validate your input using a `Dry::Validation::Contract`.  
-
-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
+
+    def add_first(input) = input << "first"
 
-BuildSequence.new.call 1
-# => Plumbing::PreconditionError("must_be_an_array")
+    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.  
 
-### Usage
+- 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.  
+
+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)
+
+```ruby
+  require "plumbing"
+  
+  class Employee
+    attr_reader :name, :job_title
+
+    include Plumbing::Valve
+    query :name, :job_title, :greet_slowly
+    command :promote
+
+    def initialize(name)
+      @name = name
+      @job_title = "Sales assistant"
+    end
+
+    def promote
+      sleep 0.5
+      @job_title = "Sales manager"
+    end
+
+    def greet_slowly 
+      sleep 0.2
+      "H E L L O"
+    end
+  end
+```
+
+[Acting inline](/spec/examples/valve_spec.rb) with no concurrency
 
-A simple observer:
 ```ruby
-require "plumbing"
+  require "plumbing"
+    
+  @person = Employee.start "Alice"
+
+  puts @person.name
+  # => "Alice"
+  puts @person.job_title
+  # => "Sales assistant"
 
-@source = Plumbing::Pipe.start
+  @person.promote
+  # this will block for 0.5 seconds
+  puts @person.job_title
+  # => "Sales manager"
 
-@observer = @source.add_observer do |event|
-  puts event.type
-end
+  @person.greet_slowly 
+  # this will block for 0.2 seconds before returning "H E L L O"
 
-@source.notify "something_happened", message: "But what was it?"
-# => "something_happened"
+  @person.greet_slowly(ignore_result: true)
+  # this will block for 0.2 seconds (as the mode is :inline) before returning nil
 ```
 
-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)
+
+  @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
 
-@source = Plumbing::Pipe.start
+[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::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.  
+
+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.  
 
-@filter = Plumbing::Filter.start source: @source do |event|
-  %w[important urgent].include? event.type 
-end
+### Usage
 
-@observer = @filter.add_observer do |event|
-  puts event.type
-end
+[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
+
+  @source.notify "important", message: "ALERT! ALERT!"
+  # => "important"
+  @source.notify "unimportant", message: "Nothing to see here"
+  # => <no output>
+```
 
-  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
+[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