bcdd-result 0.5.0 → 0.7.0

data/README.md

@@ -3,7 +3,7 @@
   <p align="center"><i>Empower Ruby apps with a pragmatic use of Railway Oriented Programming.</i></p>
   <p align="center">
     <img src="https://img.shields.io/badge/ruby->%3D%202.7.0-ruby.svg?colorA=99004d&colorB=cc0066" alt="Ruby">
-    <img src="https://badge.fury.io/rb/bcdd-result.svg" alt="bcdd-result gem version" height="18">
+    <a href="https://rubygems.org/gems/bcdd-result"><img src="https://badge.fury.io/rb/bcdd-result.svg" alt="bcdd-result gem version" height="18"></a>
   </p>
 </p>
 
@@ -35,17 +35,18 @@ Use it to enable the [Railway Oriented Programming](https://fsharpforfunandprofi
     - [`result.value_or`](#resultvalue_or)
   - [Result Data](#result-data)
     - [`result.data`](#resultdata)
+  - [Pattern Matching](#pattern-matching)
+    - [`Array`/`Find` patterns](#arrayfind-patterns)
+    - [`Hash` patterns](#hash-patterns)
   - [Railway Oriented Programming](#railway-oriented-programming)
     - [`result.and_then`](#resultand_then)
-    - [`BCDD::Result::Mixin`](#bcddresultmixin)
+    - [`BCDD::Result.mixin`](#bcddresultmixin)
       - [Class example (Instance Methods)](#class-example-instance-methods)
       - [Module example (Singleton Methods)](#module-example-singleton-methods)
-      - [Restrictions](#restrictions)
-  - [Pattern Matching](#pattern-matching)
-    - [`Array`/`Find` patterns](#arrayfind-patterns)
-    - [`Hash` patterns](#hash-patterns)
-    - [BCDD::Result::Expectations](#bcddresultexpectations)
-  - [`BCDD::Result::Expectations`](#bcddresultexpectations-1)
+      - [Important Requirement](#important-requirement)
+      - [Dependency Injection](#dependency-injection)
+      - [Add-ons](#add-ons)
+  - [`BCDD::Result::Expectations`](#bcddresultexpectations)
     - [Standalone *versus* Mixin mode](#standalone-versus-mixin-mode)
     - [Type checking - Result Hooks](#type-checking---result-hooks)
       - [`#success?` and `#failure?`](#success-and-failure)
@@ -58,6 +59,16 @@ Use it to enable the [Railway Oriented Programming](https://fsharpforfunandprofi
     - [Value checking - Result Creation](#value-checking---result-creation)
       - [Success()](#success)
       - [Failure()](#failure)
+      - [Pattern Matching Support](#pattern-matching-support)
+    - [`BCDD::Result::Expectations.mixin` add-ons](#bcddresultexpectationsmixin-add-ons)
+  - [`BCDD::Result::Context`](#bcddresultcontext)
+    - [Defining successes and failures](#defining-successes-and-failures)
+    - [`BCDD::Result::Context.mixin`](#bcddresultcontextmixin)
+      - [Class example (Instance Methods)](#class-example-instance-methods-1)
+      - [`and_expose`](#and_expose)
+      - [Module example (Singleton Methods)](#module-example-singleton-methods-1)
+    - [`BCDD::Result::Context::Expectations`](#bcddresultcontextexpectations)
+    - [Mixin add-ons](#mixin-add-ons)
 - [About](#about)
 - [Development](#development)
 - [Contributing](#contributing)
@@ -206,9 +217,8 @@ result.failure?(:error) # false
 
 ### Result Hooks
 
-Result hooks are methods that allow you to perform a block of code depending on the result type.
-
-To exemplify the them, I will implement a method that knows how to divide two numbers.
+Result hooks are methods that allow you to execute a block of code based on the type of result obtained.
+To demonstrate their use, I will implement a function that can divide two numbers.
 
 ```ruby
 def divide(arg1, arg2)
@@ -225,14 +235,15 @@ end
 
 #### `result.on`
 
-`BCDD::Result#on` will perform the block when the type matches the result type.
+When you use `BCDD::Result#on`, the block will be executed only when the type matches the result type.
 
-Regardless of the block being executed, the return of the method will always be the result itself.
+However, even if the block is executed, the method will always return the result itself.
 
-The result value will be exposed as the first argument of the block.
+The value of the result will be available as the first argument of the block.
 
 ```ruby
 result = divide(nil, 2)
+#<BCDD::Result::Failure type=:invalid_arg data='arg1 must be numeric'>
 
 output =
   result
@@ -265,21 +276,40 @@ result.object_id == output.object_id # true
 
 `BCDD::Result#on_type` is an alias of `BCDD::Result#on`.
 
+```ruby
+result = divide(nil, 2)
+#<BCDD::Result::Failure type=:invalid_arg data='arg1 must be numeric'>
+
+output =
+  result
+    .on_type(:invalid_arg) { |msg| puts msg }
+    .on_type(:division_by_zero) { |msg| puts msg }
+    .on_type(:division_completed) { |number| puts number }
+
+# The code above will print 'arg1 must be numeric' and return the result itself.
+
+result.object_id == output.object_id # true
+```
+
+*PS: The `divide()` implementation is [here](#result-hooks).*
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
 #### `result.on_success`
 
-`BCDD::Result#on_success` is very similar to the `BCDD::Result#on` hook. The main differences are:
+The `BCDD::Result#on_success` method is quite similar to the `BCDD::Result#on` hook, but with a few key differences:
 
-1. Only perform the block when the result is a success.
-2. If the type is missing it will perform the block for any success.
+1. It will only execute the block of code if the result is a success.
+2. If the type declaration is not included, the method will execute the block for any successful result, regardless of its type.
 
 ```ruby
-# It performs the block and return itself.
+# It executes the block and return itself.
 
 divide(4, 2).on_success { |number| puts number }
 
 divide(4, 2).on_success(:division_completed) { |number| puts number }
 
-# It doesn't perform the block, but return itself.
+# It doesn't execute the block, but return itself.
 
 divide(4, 4).on_success(:ok) { |value| puts value }
 
@@ -292,16 +322,19 @@ divide(4, 4).on_failure { |error| puts error }
 
 #### `result.on_failure`
 
-Is the opposite of `Result#on_success`.
+It is the opposite of `Result#on_success`:
+
+1. It will only execute the block of code if the result is a failure.
+2. If the type declaration is not included, the method will execute the block for any failed result, regardless of its type.
 
 ```ruby
-# It performs the block and return itself.
+# It executes the block and return itself.
 
 divide(nil, 2).on_failure { |error| puts error }
 
 divide(4, 0).on_failure(:invalid_arg, :division_by_zero) { |error| puts error }
 
-# It doesn't perform the block, but return itself.
+# It doesn't execute the block, but return itself.
 
 divide(4, 0).on_success { |number| puts number }
 
@@ -314,11 +347,11 @@ divide(4, 0).on_failure(:invalid_arg) { |error| puts error }
 
 #### `result.on_unknown`
 
-`BCDD::Result#on_unknown` will perform the block when no other hook (`#on`, `#on_type`, `#on_failure`, `#on_success`) has been executed.
+`BCDD::Result#on_unknown` will execute the block when no other hook (`#on`, `#on_type`, `#on_failure`, `#on_success`) has been executed.
 
-Regardless of the block being executed, the return of the method will always be the result itself.
+Regardless of the block being executed, the method will always return the result itself.
 
-The result value will be exposed as the first argument of the block.
+The value of the result will be available as the first argument of the block.
 
 ```ruby
 divide(4, 2)
@@ -335,7 +368,7 @@ divide(4, 2)
 
 #### `result.handle`
 
-This method will allow you to define blocks for each hook (type, failure, success), but instead of returning itself, it will return the output of the first match/block execution.
+This method lets you define blocks for each hook (type, failure, or success), but instead of returning itself, it will return the output of the first match/block execution.
 
 ```ruby
 divide(4, 2).handle do |result|
@@ -376,8 +409,8 @@ end
 
 **Notes:**
 * You can define multiple types to be handled by the same hook/block
-* If the type is missing, it will perform the block for any success or failure handler.
-* The `#type` and `#[]` handlers will require at least one type/argument.
+* If the type is missing, it will execute the block for any success or failure handler.
+* The `#type` and `#[]` handlers require at least one type/argument.
 
 *PS: The `divide()` implementation is [here](#result-hooks).*
 
@@ -385,13 +418,13 @@ end
 
 ### Result Value
 
-The most simple way to get the result value is by calling `BCDD::Result#value`.
+To access the result value, you can simply call `BCDD::Result#value`.
 
-But sometimes you need to get the value of a successful result or a default value if it is a failure. In this case, you can use `BCDD::Result#value_or`.
+However, there may be instances where you need to retrieve the value of a successful result or a default value if the result is a failure. In such cases, you can make use of `BCDD::Result#value_or`.
 
 #### `result.value_or`
 
-`BCCD::Result#value_or` returns the value when the result is a success, but if is a failure the block will be performed, and its outcome will be the output.
+`BCCD::Result#value_or` returns the value when the result is a success. However, if it is a failure, the given block will be executed, and its outcome will be returned.
 
 ```ruby
 def divide(arg1, arg2)
@@ -459,16 +492,75 @@ print_to_hash(**success_data) # [:success, :ok, 1]
 
 <p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
-### Railway Oriented Programming
+### Pattern Matching
+
+The `BCDD::Result` also provides support to pattern matching.
+
+In the further examples, I will use the `Divide` lambda to exemplify its usage.
+
+```ruby
+Divide = lambda do |arg1, arg2|
+  arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg1 must be numeric')
+  arg2.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg2 must be numeric')
+
+  return BCDD::Result::Failure(:division_by_zero, 'arg2 must not be zero') if arg2.zero?
+
+  BCDD::Result::Success(:division_completed, arg1 / arg2)
+end
+```
+
+#### `Array`/`Find` patterns
+
+```ruby
+case Divide.call(4, 2)
+in BCDD::Result::Failure[:invalid_arg, msg] then puts msg
+in BCDD::Result::Failure[:division_by_zero, msg] then puts msg
+in BCDD::Result::Success[:division_completed, value] then puts value
+end
+
+# The code above will print: 2
+
+case Divide.call(4, 0)
+in BCDD::Result::Failure[:invalid_arg, msg] then puts msg
+in BCDD::Result::Failure[:division_by_zero, msg] then puts msg
+in BCDD::Result::Success[:division_completed, value] then puts value
+end
 
-This feature/pattern is also known as ["Railway Oriented Programming"](https://fsharpforfunandprofit.com/rop/).
+# The code above will print: arg2 must not be zero
+```
 
-The idea is to chain blocks and creates a pipeline of operations that can be interrupted by a failure.
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
-In other words, the block will be executed only if the result is a success.
-So, if some block returns a failure, the following blocks will be skipped.
+#### `Hash` patterns
 
-Due to this characteristic, you can use this feature to express some logic as a sequence of operations. And have the guarantee that the process will stop by the first failure detection, and if everything is ok, the final result will be a success.
+```ruby
+case Divide.call(10, 2)
+in { failure: { invalid_arg: msg } } then puts msg
+in { failure: { division_by_zero: msg } } then puts msg
+in { success: { division_completed: value } } then puts value
+end
+
+# The code above will print: 5
+
+case Divide.call('10', 2)
+in { failure: { invalid_arg: msg } } then puts msg
+in { failure: { division_by_zero: msg } } then puts msg
+in { success: { division_completed: value } } then puts value
+end
+
+# The code above will print: arg1 must be numeric
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+### Railway Oriented Programming
+
+["Railway Oriented Programming (ROP)"](https://fsharpforfunandprofit.com/rop/)  is a programming technique that involves linking blocks together to form a sequence of operations, also known as a pipeline.
+If a failure occurs in any of the blocks, the pipeline is interrupted and subsequent blocks are skipped.
+
+The ROP technique allows you to structure your code in a way that expresses your logic as a series of operations, with the added benefit of stopping the process at the first detection of failure.
+
+If all blocks successfully execute, the final result of the pipeline will be a success.
 
 #### `result.and_then`
 
@@ -521,17 +613,17 @@ Divide.call(2, 2)
 
 <p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
-#### `BCDD::Result::Mixin`
+#### `BCDD::Result.mixin`
 
-It is a module that can be included/extended by any object. It adds two methods to the target object: `Success()` and `Failure()`. The main difference between these methods and `BCDD::Result::Success()`/`BCDD::Result::Failure()` is that the first ones will use the target object (who received the include/extend) as the result's subject.
+This method generates a module that can be included or extended by any object. It adds two methods to the target object: `Success()` and `Failure()`. The main difference between these methods and `BCDD::Result::Success()`/`BCDD::Result::Failure()` is that the former will utilize the target object (which has received the include/extend) as the result's subject.
 
-And because of this, you can use the `#and_then` method to call methods from the result's subject.
+As a result, you can utilize the `#and_then` method to invoke methods from the result's subject.
 
 ##### Class example (Instance Methods)
 
 ```ruby
 class Divide
-  include BCDD::Result::Mixin
+  include BCDD::Result.mixin
 
   attr_reader :arg1, :arg2
 
@@ -579,8 +671,7 @@ Divide.new(4, '2').call #<BCDD::Result::Failure type=:invalid_arg value="arg2 mu
 
 ```ruby
 module Divide
-  extend BCDD::Result::Mixin
-  extend self
+  extend self, BCDD::Result.mixin
 
   def call(arg1, arg2)
     validate_numbers(arg1, arg2)
@@ -615,100 +706,163 @@ Divide.call('4', 2) #<BCDD::Result::Failure type=:invalid_arg value="arg1 must b
 Divide.call(4, '2') #<BCDD::Result::Failure type=:invalid_arg value="arg2 must be numeric">
 ```
 
-##### Restrictions
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
-The unique condition for using the `#and_then` to call methods is that they must use the `Success()` and `Failure()` to produce their results.
+##### Important Requirement
 
-If you use `BCDD::Result::Subject()`/`BCDD::Result::Failure()`, or use result from another `BCDD::Result::Mixin` instance, the `#and_then` will raise an error because the subjects will be different.
+To use the `#and_then` method to call methods, they must use `Success()` and `Failure()` to produce the results.
 
-> **Note**: You still can use the block syntax, but all the results must be produced by the subject's `Success()` and `Failure()` methods.
+If you try to use `BCDD::Result::Subject()`/`BCDD::Result::Failure()`, or results from another `BCDD::Result.mixin` instance with `#and_then`, it will raise an error because the subjects will be different.
 
-<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+**Note:** You can still use the block syntax, but all the results must be produced by the subject's `Success()` and `Failure()` methods.
 
-### Pattern Matching
+```ruby
+module ValidateNonZero
+  extend self, BCDD::Result.mixin
 
-The `BCDD::Result` also provides support to pattern matching.
+  def call(numbers)
+    return Success(:ok, numbers) unless numbers.last.zero?
 
-In the further examples, I will use the `Divide` lambda to exemplify its usage.
+    Failure(:division_by_zero, 'arg2 must not be zero')
+  end
+end
 
-```ruby
-Divide = lambda do |arg1, arg2|
-  arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg1 must be numeric')
-  arg2.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg2 must be numeric')
+class Divide
+  include BCDD::Result.mixin
 
-  return BCDD::Result::Failure(:division_by_zero, 'arg2 must not be zero') if arg2.zero?
+  attr_reader :arg1, :arg2
 
-  BCDD::Result::Success(:division_completed, arg1 / arg2)
-end
-```
+  def initialize(arg1, arg2)
+    @arg1 = arg1
+    @arg2 = arg2
+  end
 
-#### `Array`/`Find` patterns
+  def call
+    validate_numbers
+      .and_then(:validate_non_zero)
+      .and_then(:divide)
+  end
 
-```ruby
-case Divide.call(4, 2)
-in BCDD::Result::Failure[:invalid_arg, msg] then puts msg
-in BCDD::Result::Failure[:division_by_zero, msg] then puts msg
-in BCDD::Result::Success[:division_completed, value] then puts value
-end
+  private
 
-# The code above will print: 2
+  def validate_numbers
+    arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg1 must be numeric') # This will raise an error
+    arg2.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
 
-case Divide.call(4, 0)
-in BCDD::Result::Failure[:invalid_arg, msg] then puts msg
-in BCDD::Result::Failure[:division_by_zero, msg] then puts msg
-in BCDD::Result::Success[:division_completed, value] then puts value
-end
+    BCDD::Result::Success(:ok, [arg1, arg2]) # This will raise an error
+  end
 
-# The code above will print: arg2 must not be zero
+  def validate_non_zero(numbers)
+    ValidateNonZero.call(numbers) # This will raise an error
+
+    # This would work:
+    # In this case we are handling the other subject result and returning our own
+    # ValidateNonZero.call(numbers).handle do |on|
+    #   on.success { |numbers| Success(:ok, numbers) }
+    #   on.failure { |err| Failure(:division_by_zero, err) }
+    # end
+  end
+
+  def divide((number1, number2))
+    Success(:division_completed, number1 / number2)
+  end
+end
 ```
 
 <p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
-#### `Hash` patterns
+##### Dependency Injection
+
+The `BCDD::Result#and_then` accepts a second argument that will be used to share a value with the subject's method. To receive this argument, the subject's method must have an arity of two, where the first argument will be the result value and the second will be the shared value.
 
 ```ruby
-case Divide.call(10, 2)
-in { failure: { invalid_arg: msg } } then puts msg
-in { failure: { division_by_zero: msg } } then puts msg
-in { success: { division_completed: value } } then puts value
-end
+require 'logger'
 
-# The code above will print: 5
+module Divide
+  extend self, BCDD::Result.mixin
 
-case Divide.call('10', 2)
-in { failure: { invalid_arg: msg } } then puts msg
-in { failure: { division_by_zero: msg } } then puts msg
-in { success: { division_completed: value } } then puts value
+  def call(arg1, arg2, logger: ::Logger.new(STDOUT))
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero, logger)
+      .and_then(:divide, logger)
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
+
+    Success(:ok, [arg1, arg2])
+  end
+
+  def validate_non_zero(numbers, logger)
+    if numbers.last.zero?
+      logger.error('arg2 must not be zero')
+
+      Failure(:division_by_zero, 'arg2 must not be zero')
+    else
+      logger.info('The numbers are valid')
+
+      Success(:ok, numbers)
+    end
+  end
+
+  def divide((number1, number2), logger)
+    division = number1 / number2
+
+    logger.info("The division result is #{division}")
+
+    Success(:division_completed, division)
+  end
 end
 
-# The code above will print: arg1 must be numeric
+Divide.call(4, 2)
+# I, [2023-10-11T00:08:05.546237 #18139]  INFO -- : The numbers are valid
+# I, [2023-10-11T00:08:05.546337 #18139]  INFO -- : The division result is 2
+#=> #<BCDD::Result::Success type=:division_completed value=2>
+
+Divide.call(4, 2, logger: Logger.new(IO::NULL))
+#=> #<BCDD::Result::Success type=:division_completed value=2>
 ```
 
 <p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
-#### BCDD::Result::Expectations
+##### Add-ons
 
-I'd like you to please read the following section to understand how to use this feature.
+The `BCDD::Result.mixin` also accepts the `with:` argument. It is a hash that will be used to define the methods that will be added to the target object.
 
-But if you are using Ruby >= 3.0, you can use the `in` operator to use the pattern matching to validate the result's value.
+**Continue**
+
+This addon will create the `Continue(value)` method, which will know how to produce a `Success(:continued, value)`. It is useful when you want to perform a sequence of operations but want to avoid returning a specific result for each step.
 
 ```ruby
 module Divide
-  extend BCDD::Result::Expectations.mixin(
-    success: {
-      numbers:            ->(value) { value in [Numeric, Numeric] },
-      division_completed: ->(value) { value in (Integer | Float) }
-    },
-    failure: { invalid_arg: String, division_by_zero: String }
-  )
+  extend self, BCDD::Result.mixin(with: :Continue)
 
-  def self.call(arg1, arg2)
-    arg1.is_a?(Numeric) or return Failure(:invalid_arg, 'arg1 must be numeric')
-    arg2.is_a?(Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
+  def call(arg1, arg2)
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero)
+      .and_then(:divide)
+  end
 
-    arg2.zero? and return Failure(:division_by_zero, 'arg2 must not be zero')
+  private
 
-    Success(:division_completed, arg1 / arg2)
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
+
+    Continue([arg1, arg2])
+  end
+
+  def validate_non_zero(numbers)
+    return Continue(numbers) unless numbers.last.zero?
+
+    Failure(:division_by_zero, 'arg2 must not be zero')
+  end
+
+  def divide((number1, number2))
+    Success(:division_completed, number1 / number2)
   end
 end
 ```
@@ -727,18 +881,18 @@ The _**standalone mode**_ creates an object that knows how to produce and valida
 
 ```ruby
 module Divide
-  Expected = BCDD::Result::Expectations.new(
+  Result = BCDD::Result::Expectations.new(
     success: %i[numbers division_completed],
     failure: %i[invalid_arg division_by_zero]
   )
 
   def self.call(arg1, arg2)
-    arg1.is_a?(Numeric) or return Expected::Failure(:invalid_arg, 'arg1 must be numeric')
-    arg2.is_a?(Numeric) or return Expected::Failure(:invalid_arg, 'arg2 must be numeric')
+    arg1.is_a?(Numeric) or return Result::Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(Numeric) or return Result::Failure(:invalid_arg, 'arg2 must be numeric')
 
-    arg2.zero? and return Expected::Failure(:division_by_zero, 'arg2 must not be zero')
+    arg2.zero? and return Result::Failure(:division_by_zero, 'arg2 must not be zero')
 
-    Expected::Success(:division_completed, arg1 / arg2)
+    Result::Success(:division_completed, arg1 / arg2)
   end
 end
 ```
@@ -748,11 +902,11 @@ In the code above, we define a constant `Divide::Expected`. And because of this
 Look what happens if you try to create a result without one of the expected types.
 
 ```ruby
-Divide::Expected::Success(:ok)
+Divide::Result::Success(:ok)
 # type :ok is not allowed. Allowed types: :numbers, :division_completed
 # (BCDD::Result::Expectations::Error::UnexpectedType)
 
-Divide::Expected::Failure(:err)
+Divide::Result::Failure(:err)
 # type :err is not allowed. Allowed types: :invalid_arg, :division_by_zero
 # (BCDD::Result::Expectations::Error::UnexpectedType)
 ```
@@ -804,11 +958,11 @@ Now that you know the two modes, let's understand how expectations can be benefi
 
 #### Type checking - Result Hooks
 
-The `BCDD::Result::Expectations` will check if the result's type is valid. This checking will be performed in all the methods that rely on the result's type, like `#success?`, `#failure?`, `#on`, `#on_type`, `#on_success`, `#on_failure`, `#handle`.
+The `BCDD::Result::Expectations` will check if the type of the result is valid. This checking will be performed in all methods that depend on the result’s type, such as `#success?`, `#failure?`, `#on`, `#on_type`, `#on_success`, `#on_failure`, and `#handle`.
 
 ##### `#success?` and `#failure?`
 
-When you check whether a result is a success or failure, `BCDD::Result::Expectations` will check whether the result type is valid/expected. Otherwise, an error will be raised.
+When checking whether a result is a success or failure, `BCDD::Result::Expectations` will also verify if the result type is valid/expected. In case of an invalid type, an error will be raised.
 
 **Success example:**
 
@@ -844,7 +998,7 @@ result.failure?(:err)
 
 ##### `#on` and `#on_type`
 
-If you use `#on` or `#on_type` to perform a block, `BCDD::Result::Expectations` will check whether the result type is valid/expected. Otherwise, an error will be raised.
+If you use `#on` or `#on_type` to execute a block, `BCDD::Result::Expectations` will check whether the result type is valid/expected. Otherwise, an error will be raised.
 
 ```ruby
 result = Divide.new.call(10, 2)
@@ -866,7 +1020,7 @@ result.on(:number) { |_| :this_type_does_not_exist }
 
 ##### `#on_success` and `#on_failure`
 
-If you use `#on_success` or `#on_failure` to perform a block, `BCDD::Result::Expectations` will check whether the result type is valid/expected. Otherwise, an error will be raised.
+If you use `#on_success` or `#on_failure` to execute a block, `BCDD::Result::Expectations` will check whether the result type is valid/expected. Otherwise, an error will be raised.
 
 ```ruby
 result = Divide.new.call(10, '2')
@@ -958,15 +1112,15 @@ Divide.call(4, 2)
 
 ```ruby
 module Divide
-  Expected = BCDD::Result::Expectations.new(success: :ok, failure: :err)
+  Result = BCDD::Result::Expectations.new(success: :ok, failure: :err)
 
   def self.call(arg1, arg2)
-    arg1.is_a?(Numeric) or return Expected::Failure(:invalid_arg, 'arg1 must be numeric')
-    arg2.is_a?(Numeric) or return Expected::Failure(:invalid_arg, 'arg2 must be numeric')
+    arg1.is_a?(Numeric) or return Result::Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(Numeric) or return Result::Failure(:invalid_arg, 'arg2 must be numeric')
 
-    arg2.zero? and return Expected::Failure(:division_by_zero, 'arg2 must not be zero')
+    arg2.zero? and return Result::Failure(:division_by_zero, 'arg2 must not be zero')
 
-    Expected::Success(:division_completed, arg1 / arg2)
+    Result::Success(:division_completed, arg1 / arg2)
   end
 end
 
@@ -1017,7 +1171,7 @@ end
 
 ```ruby
 module Divide
-  Expected = BCDD::Result::Expectations.new(
+  Result = BCDD::Result::Expectations.new(
     success: {
       numbers: ->(value) { value.is_a?(Array) && value.size == 2 && value.all?(Numeric) },
       division_completed: Numeric
@@ -1029,12 +1183,12 @@ module Divide
   )
 
   def self.call(arg1, arg2)
-    arg1.is_a?(Numeric) or return Expected::Failure(:invalid_arg, 'arg1 must be numeric')
-    arg2.is_a?(Numeric) or return Expected::Failure(:invalid_arg, 'arg2 must be numeric')
+    arg1.is_a?(Numeric) or return Result::Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(Numeric) or return Result::Failure(:invalid_arg, 'arg2 must be numeric')
 
-    arg2.zero? and return Expected::Failure(:division_by_zero, 'arg2 must not be zero')
+    arg2.zero? and return Result::Failure(:division_by_zero, 'arg2 must not be zero')
 
-    Expected::Success(:division_completed, arg1 / arg2)
+    Result::Success(:division_completed, arg1 / arg2)
   end
 end
 ```
@@ -1046,31 +1200,459 @@ The value validation will only be performed through the methods `Success()` and
 ##### Success()
 
 ```ruby
-Divide::Expected::Success(:ok)
+Divide::Result::Success(:ok)
 # type :ok is not allowed. Allowed types: :numbers, :division_completed (BCDD::Result::Expectations::Error::UnexpectedType)
 
-Divide::Expected::Success(:numbers, [1])
+Divide::Result::Success(:numbers, [1])
 # value [1] is not allowed for :numbers type (BCDD::Result::Expectations::Error::UnexpectedValue)
 
-Divide::Expected::Success(:division_completed, '2')
+Divide::Result::Success(:division_completed, '2')
 # value "2" is not allowed for :division_completed type (BCDD::Result::Expectations::Error::UnexpectedValue)
 ```
 
 ##### Failure()
 
 ```ruby
-Divide::Expected::Failure(:err)
+Divide::Result::Failure(:err)
 # type :err is not allowed. Allowed types: :invalid_arg, :division_by_zero (BCDD::Result::Expectations::Error::UnexpectedType)
 
-Divide::Expected::Failure(:invalid_arg, :arg1_must_be_numeric)
+Divide::Result::Failure(:invalid_arg, :arg1_must_be_numeric)
 # value :arg1_must_be_numeric is not allowed for :invalid_arg type (BCDD::Result::Expectations::Error::UnexpectedValue)
 
-Divide::Expected::Failure(:division_by_zero, msg: 'arg2 must not be zero')
+Divide::Result::Failure(:division_by_zero, msg: 'arg2 must not be zero')
 # value {:msg=>"arg2 must not be zero"} is not allowed for :division_by_zero type (BCDD::Result::Expectations::Error::UnexpectedValue)
 ```
 
 <p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
 
+##### Pattern Matching Support
+
+The value checking has support for handling pattern-matching errors, and the cleanest way to do it is using the one-line pattern matching operators (`=>` since Ruby 3.0) and (`in` Ruby 2.7).
+
+How does this operator work? They raise an error when the pattern does not match but returns nil when it matches.
+
+Because of this, you will need to enable `nil` as a valid value checking. You can do it by calling the `BCDD::Result::Contract.nil_as_valid_value_checking!` method.
+
+**Attention:**
+
+If you decide to enable this, you will do it at the beginning of your code or in an initializer. And remember, this will affect all kinds of result expectations (`BCDD::Result::Expectations` and `BCDD::Result::Context::Expectations`). So, it is recommended to use it only when you are using pattern matching for **ALL** the result's value validations.
+
+```ruby
+#
+# Put this line in an initializer or at the beginning of your code.
+# It is required if you decide to use pattern matching to validate all of your result's values.
+#
+BCDD::Result::Contract.nil_as_valid_value_checking!
+
+module Divide
+  extend BCDD::Result::Expectations.mixin(
+    success: {
+      division_completed: ->(value) { value => (Integer | Float) }
+    },
+    failure: { invalid_arg: String, division_by_zero: String }
+  )
+
+  def self.call(arg1, arg2)
+    arg1.is_a?(Numeric) or return Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
+
+    arg2.zero? and return Failure(:division_by_zero, 'arg2 must not be zero')
+
+    Success(:division_completed, String(arg1 / arg2))
+  end
+end
+
+Divide.call(10, 5)
+# value "5" is not allowed for :division_completed type ("5": Float === "5" does not return true) (BCDD::Result::Contract::Error::UnexpectedValue)
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+#### `BCDD::Result::Expectations.mixin` add-ons
+
+The `BCDD::Result::Expectations.mixin` also accepts the `with:` argument. It is a hash that will be used to define the methods that will be added to the target object.
+
+**Continue**
+
+It is similar to `BCDD::Result.mixin(with: :Continue)`, the key difference is that the `Continue(value)` will be ignored by the expectations. This is extremely useful when you want to use `Continue(value)` to chain operations, but you don't want to declare N success types in the expectations.
+
+```ruby
+class Divide
+  include BCDD::Result::Expectations.mixin(
+    with: :Continue,
+    success: :division_completed,
+    failure: %i[invalid_arg division_by_zero]
+  )
+
+  def call(arg1, arg2)
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero)
+      .and_then(:divide)
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:invalid_arg, 'arg2 must be numeric')
+
+    Continue([arg1, arg2])
+  end
+
+  def validate_non_zero(numbers)
+    return Continue(numbers) unless numbers.last.zero?
+
+    Failure(:division_by_zero, 'arg2 must not be zero')
+  end
+
+  def divide((number1, number2))
+    Success(:division_completed, number1 / number2)
+  end
+end
+
+result = Divide.new.call(4,2)
+# => #<BCDD::Result::Success type=:division_completed value=2>
+
+# The example below shows an error because the :ok type is not allowed.
+# But look at the allowed types have only one type (:division_completed).
+# This is because the :continued type is ignored by the expectations.
+#
+result.success?(:ok)
+# type :ok is not allowed. Allowed types: :division_completed (BCDD::Result::Expectations::Error::UnexpectedType)
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+### `BCDD::Result::Context`
+
+The `BCDD::Result::Context` is a `BCDD::Result`, meaning it has all the features of the `BCDD::Result`. The main difference is that it only accepts keyword arguments as a value, which applies to the `and_then`: The called methods must receive keyword arguments, and the dependency injection will be performed through keyword arguments.
+
+As the input/output are hashes, the results of each `and_then` call will automatically accumulate. This is useful in operations chaining, as the result of the previous operations will be automatically available for the next one. Because of this behavior, the `BCDD::Result::Context` has the `#and_expose` method to expose only the desired keys from the accumulated result.
+
+#### Defining successes and failures
+
+As the `BCDD::Result`, you can declare success and failures directly from `BCDD::Result::Context`.
+
+```ruby
+BCDD::Result::Context::Success(:ok, a: 1, b: 2)
+#<BCDD::Result::Context::Success type=:ok value={:a=>1, :b=>2}>
+
+BCDD::Result::Context::Failure(:err, message: 'something went wrong')
+#<BCDD::Result::Context::Failure type=:err value={:message=>"something went wrong"}>
+```
+
+But different from `BCDD::Result` that accepts any value, the `BCDD::Result::Context` only takes keyword arguments.
+
+```ruby
+BCDD::Result::Context::Success(:ok, [1, 2])
+# wrong number of arguments (given 2, expected 1) (ArgumentError)
+
+BCDD::Result::Context::Failure(:err, { message: 'something went wrong' })
+# wrong number of arguments (given 2, expected 1) (ArgumentError)
+
+#
+# Use ** to convert a hash to keyword arguments
+#
+BCDD::Result::Context::Success(:ok, **{ message: 'hashes can be converted to keyword arguments' })
+#<BCDD::Result::Context::Success type=:ok value={:message=>"hashes can be converted to keyword arguments"}>
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+#### `BCDD::Result::Context.mixin`
+
+As in the `BCDD::Result`, you can use the `BCDD::Result::Context.mixin` to add the `Success()` and `Failure()` methods to your classes/modules.
+
+Let's see this feature and the data accumulation in action:
+
+##### Class example (Instance Methods)
+
+```ruby
+class Divide
+  require 'logger'
+
+  include BCDD::Result::Context.mixin
+
+  def call(arg1, arg2, logger: ::Logger.new(STDOUT))
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero)
+      .and_then(:divide, logger: logger)
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:err, message: 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:err, message: 'arg2 must be numeric')
+
+    Success(:ok, number1: arg1, number2: arg2)
+  end
+
+  def validate_non_zero(number2:, **)
+    return Success(:ok) if number2.nonzero?
+
+    Failure(:err, message: 'arg2 must not be zero')
+  end
+
+  #
+  # The logger was injected via #and_then and keyword arguments
+  #
+  def divide(number1:, number2:, logger:)
+    result = number1 / number2
+
+    logger.info("The division result is #{result}")
+
+    Success(:ok, number: result)
+  end
+end
+
+Divide.new.call(10, 5)
+# I, [2023-10-27T01:51:46.905004 #76915]  INFO -- : The division result is 2
+#<BCDD::Result::Context::Success type=:ok value={:number=>2}>
+
+Divide.new.call('10', 5)
+#<BCDD::Result::Context::Failure type=:err value={:message=>"arg1 must be numeric"}>
+
+Divide.new.call(10, '5')
+#<BCDD::Result::Context::Failure type=:err value={:message=>"arg2 must be numeric"}>
+
+Divide.new.call(10, 0)
+#<BCDD::Result::Context::Failure type=:err value={:message=>"arg2 must not be zero"}>
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+##### `and_expose`
+
+This allows you to expose only the desired keys from the accumulated result. It can be used with any `BCDD::Result::Context` object.
+
+Let's add it to the previous example:
+
+```ruby
+class Divide
+  include BCDD::Result::Context.mixin
+
+  def call(arg1, arg2)
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero)
+      .and_then(:divide)
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:err, message: 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:err, message: 'arg2 must be numeric')
+
+    Success(:ok, number1: arg1, number2: arg2)
+  end
+
+  def validate_non_zero(number2:, **)
+    return Success(:ok) if number2.nonzero?
+
+    Failure(:err, message: 'arg2 must not be zero')
+  end
+
+  def divide(**input)
+    Success(:ok, number: input.values.reduce(:/), **input)
+  end
+end
+
+Divide.new.call(10, 5)
+#<BCDD::Result::Context::Success type=:division_completed value={:number=>2}>
+```
+
+As you can see, even with `divide` success exposing the division number with all the accumulated data (`**input`), the `#and_expose` could generate a new success with a new type and only with the desired keys.
+
+Remove the `#and_expose` call to see the difference. This will be the outcome:
+
+```ruby
+Divide.new.call(10, 5)
+#<BCDD::Result::Context::Success type=:ok value={:number=>2, :number1=>10, :number2=>5}>
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+##### Module example (Singleton Methods)
+
+Yes, the `BCDD::Result::Context.mixin` can produce singleton methods. Look for an example using a module (but it could be a class, too).
+
+```ruby
+module Divide
+  extend self, BCDD::Result::Context.mixin
+
+  def call(arg1, arg2)
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero)
+      .and_then(:divide)
+      .and_expose(:division_completed, [:number])
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:err, message: 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:err, message: 'arg2 must be numeric')
+
+    Success(:ok, number1: arg1, number2: arg2)
+  end
+
+  def validate_non_zero(number2:, **)
+    return Success(:ok) if number2.nonzero?
+
+    Failure(:err, message: 'arg2 must not be zero')
+  end
+
+  def divide(number1:, number2:)
+    Success(:ok, number: number1 / number2)
+  end
+end
+
+Divide.call(10, 5)
+#<BCDD::Result::Context::Success type=:division_completed value={:number=>2}>
+
+Divide.call('10', 5)
+#<BCDD::Result::Context::Failure type=:err value={:message=>"arg1 must be numeric"}>
+
+Divide.call(10, '5')
+#<BCDD::Result::Context::Failure type=:err value={:message=>"arg2 must be numeric"}>
+
+Divide.call(10, 0)
+#<BCDD::Result::Context::Failure type=:err value={:message=>"arg2 must not be zero"}>
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+#### `BCDD::Result::Context::Expectations`
+
+The `BCDD::Result::Context::Expectations` is a `BCDD::Result::Expectations` with the `BCDD::Result::Context` features.
+
+This is an example using the mixin mode, but the standalone mode is also supported.
+
+```ruby
+#
+# Put this line in an initializer or at the beginning of your code.
+# It is required if you decide to use pattern matching to validate all of your result's values.
+#
+BCDD::Result::Contract.nil_as_valid_value_checking!
+
+class Divide
+  include BCDD::Result::Context::Expectations.mixin(
+    success: {
+      division_completed: ->(value) { value => { number: Numeric } }
+    },
+    failure: {
+      invalid_arg:      ->(value) { value => { message: String } },
+      division_by_zero: ->(value) { value => { message: String } }
+    }
+  )
+
+  def call(arg1, arg2)
+    arg1.is_a?(Numeric) or return Failure(:invalid_arg, message: 'arg1 must be numeric')
+    arg2.is_a?(Numeric) or return Failure(:invalid_arg, message: 'arg2 must be numeric')
+
+    arg2.zero? and return Failure(:division_by_zero, message: 'arg2 must not be zero')
+
+    Success(:division_completed, number: arg1 / arg2)
+  end
+end
+
+Divide.new.call(10, 5)
+#<BCDD::Result::Context::Success type=:division_completed value={:number=>2}>
+```
+
+As in the `BCDD::Result::Expectations.mixin`, the `BCDD::Result::Context::Expectations.mixin` will add a Result constant in the target class. It can generate success/failure results, which ensure the mixin expectations.
+
+Let's see this using previous example:
+
+```ruby
+Divide::Result::Success(:division_completed, number: 2)
+#<BCDD::Result::Context::Success type=:division_completed value={:number=>2}>
+
+Divide::Result::Success(:division_completed, number: '2')
+# value {:number=>"2"} is not allowed for :division_completed type ({:number=>"2"}: Numeric === "2" does not return true) (BCDD::Result::Contract::Error::UnexpectedValue)
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
+#### Mixin add-ons
+
+The `BCDD::Result::Context.mixin` and `BCDD::Result::Context::Expectations.mixin` also accepts the `with:` argument. And it works the same way as the `BCDD::Result` mixins.
+
+**Continue**
+
+The `BCDD::Result::Context.mixin(with: :Continue)` or `BCDD::Result::Context::Expectations.mixin(with: :Continue)` adds a `Continue(**input)` that will be ignored by the expectations. This is extremely useful when you want to use `Continue()` to chain operations, but you don't want to declare N success types in the expectations.
+
+Let's use a mix of `BCDD::Result::Context` features to see in action with this add-on:
+
+```ruby
+#
+# Put this line in an initializer or at the beginning of your code.
+# It is required if you decide to use pattern matching to validate all of your result's values.
+#
+BCDD::Result::Contract.nil_as_valid_value_checking!
+
+module Divide
+  require 'logger'
+
+  extend self, BCDD::Result::Context::Expectations.mixin(
+    with: :Continue,
+    success: {
+      division_completed: ->(value) { value => { number: Numeric } }
+    },
+    failure: {
+      invalid_arg:      ->(value) { value => { message: String } },
+      division_by_zero: ->(value) { value => { message: String } }
+    }
+  )
+
+  def call(arg1, arg2, logger: ::Logger.new(STDOUT))
+    validate_numbers(arg1, arg2)
+      .and_then(:validate_non_zero)
+      .and_then(:divide, logger: logger)
+      .and_expose(:division_completed, [:number])
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return Failure(:invalid_arg, message: 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return Failure(:invalid_arg, message: 'arg2 must be numeric')
+
+    Continue(number1: arg1, number2: arg2)
+  end
+
+  def validate_non_zero(number2:, **)
+    return Continue() if number2.nonzero?
+
+    Failure(:division_by_zero, message: 'arg2 must not be zero')
+  end
+
+  def divide(number1:, number2:, logger:)
+    result = number1 / number2
+
+    logger.info("The division result is #{result}")
+
+    Continue(number: result)
+  end
+end
+
+Divide.call(14, 2)
+# I, [2023-10-27T02:01:05.812388 #77823]  INFO -- : The division result is 7
+#<BCDD::Result::Context::Success type=:division_completed value={:number=>7}>
+
+Divide.call('14', 2)
+#<BCDD::Result::Context::Failure type=:invalid_arg value={:message=>"arg1 must be numeric"}>
+
+Divide.call(14, '2')
+#<BCDD::Result::Context::Failure type=:invalid_arg value={:message=>"arg2 must be numeric"}>
+
+Divide.call(14, 0)
+#<BCDD::Result::Context::Failure type=:division_by_zero value={:message=>"arg2 must not be zero"}>
+```
+
+<p align="right"><a href="#-bcddresult">⬆️ &nbsp;back to top</a></p>
+
 ## About
 
 [Rodrigo Serradura](https://github.com/serradura) created this project. He is the B/CDD process/method creator and has already made similar gems like the [u-case](https://github.com/serradura/u-case) and [kind](https://github.com/serradura/kind/blob/main/lib/kind/result.rb). This gem is a general-purpose abstraction/monad, but it also contains key features that serve as facilitators for adopting B/CDD in the code.