ruby_reactor 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863c83e92cbfab470e39107c580ceabce444133973b723662a89e5bf0211c3ab
-  data.tar.gz: 1209b5587efc055bc787731694a6dc2b7eab8b3d5a6ff729728aa29ea601e2e0
+  metadata.gz: d3ddfd9b6e65d03e5c00d7980563da39b4132fc1d5f0dbe14e5b782d039c7f68
+  data.tar.gz: 785cc8ac8d426433a00f378eafb8f312b343950ecf496e2af0a6fe9e48115c29
 SHA512:
-  metadata.gz: 146d14cd32b12c95764e493f2de2d826dbe074ec4e4b44613b788d748d52fe38644fd86f1590f6bb0b1a0d1840c2200ab29a6d8e78db27f8f6abf099faf74756
-  data.tar.gz: 3d5b7c43182ee2d1c5c06ba90b7e2177a3dffbecdc8fb3e91db14f99bcd02807ebfa98c0e240412b790ec1d69609dc30995d9ee1aea9c8cb8ecd69d4d0fb2ac7
+  metadata.gz: 549a49deff5d63e129c0b4c043cbc3987dbbb09b054907a5acb8941af85fedb5f9706bad8d56948bbc7ea889eba19174254962ca987e7835b4cd0a7bf3f9e165
+  data.tar.gz: 319399c2854cccb505fc7e8f6c964eeeb527bad375ed513b1a2c2ea89b77445283f287bbff5a0892902a56a5a56b5a9aff105a0164006abf407473ad3780a58d

data/README.md

@@ -5,16 +5,16 @@
 
 # RubyReactor
 
+A dynamic, dependency-resolving saga orchestrator for Ruby. Ruby Reactor implements the Saga pattern with compensation-based error handling and DAG-based execution planning. It leverages **Sidekiq** for asynchronous execution and **Redis** for state persistence.
+
+![Payment workflow reactor](documentation/images/payment_workflow.png)
+
 ## Why Ruby Reactor?
 
 Building complex business transactions often results in spaghetti code or brittle "god classes." Ruby Reactor solves this by implementing the **Saga Pattern** in a lightweight, developer-friendly package. It lets you define workflows as clear, dependency-driven steps without the boilerplate of heavy enterprise frameworks.
 
 The key value is **Reliability**: if any part of your workflow fails, Ruby Reactor automatically triggers compensation logic to undo previous steps, ensuring your system never ends up in a corrupted half-state. Whether you're coordinating microservices or monolith modules, you get atomic-like consistency with background processing built-in.
 
-A dynamic, dependency-resolving saga orchestrator for Ruby. Ruby Reactor implements the Saga pattern with compensation-based error handling and DAG-based execution planning. It leverages **Sidekiq** for asynchronous execution and **Redis** for state persistence.
-
-![Payment workflow reactor](documentation/images/payment_workflow.png)
-
 ## Features
 
 - **DAG-based Execution**: Steps are executed based on their dependencies, allowing for parallel execution of independent steps.
@@ -62,6 +62,7 @@ A dynamic, dependency-resolving saga orchestrator for Ruby. Ruby Reactor impleme
   - [Complex Workflows with Dependencies](#complex-workflows-with-dependencies)
   - [Error Handling and Compensation](#error-handling-and-compensation)
   - [Using Pre-defined Schemas](#using-pre-defined-schemas)
+  - [Testing](#testing)
 - [Documentation](#documentation)
 - [Future improvements](#future-improvements)
 - [Development](#development)
@@ -680,6 +681,29 @@ class SchemaValidatedReactor < RubyReactor::Reactor
 end
 ```
 
+### Testing
+
+RubyReactor provides testing utilities for RSpec. See the [Testing with RSpec](documentation/testing.md) guide for comprehensive documentation.
+
+```ruby
+RSpec.describe PaymentReactor do
+  it "processes payment successfully" do
+    subject = test_reactor(PaymentReactor, order_id: 123, amount: 99.99)
+    
+    expect(subject).to be_success
+    expect(subject).to have_run_step(:charge_card).after(:validate_order)
+    expect(subject.step_result(:charge_card)).to include(status: "completed")
+  end
+
+  it "handles payment failures with mocked steps" do
+    subject = test_reactor(PaymentReactor, order_id: 123, amount: 99.99)
+      .mock_step(:charge_card) { Failure("Card declined") }
+    
+    expect(subject).to be_failure
+    expect(subject.error).to include("Card declined")
+  end
+end
+```
 
 ## Documentation
 
@@ -706,6 +730,9 @@ Configure robust retry policies for your steps. This guide details the available
 ### [Interrupts](documentation/interrupts.md)
 Learn how to pause and resume reactors to handle long-running processes, manual approvals, and asynchronous callbacks. Patterns for correlation IDs, timeouts, and payload validation.
 
+### [Testing with RSpec](documentation/testing.md)
+Comprehensive guide to testing reactors with RubyReactor's testing utilities. Learn about the `TestSubject` class for reactor execution and introspection, step mocking for isolating dependencies, testing nested and composed reactors, and custom RSpec matchers like `be_success`, `have_run_step`, and `have_retried_step`.
+
 ### Examples
 - [Order Processing](documentation/examples/order_processing.md) - Complete order processing workflow example
 - [Payment Processing](documentation/examples/payment_processing.md) - Payment handling with compensation