stepped 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0687ebc619500dd18bf435c8fb6a67a5523590b811bb51c6f8532f1411ebd93a'
-  data.tar.gz: 68d54113a3ef201aad85b083378848bfa633c5f5bbe41cdcd52e2a63a6b10f03
+  metadata.gz: a2b28a4bc4ba842e620bd426a1b887a0f25915dfae3dd9647090ba2b59053b8a
+  data.tar.gz: 5a324cda715b346839300aacb530852532700f4c656946d162ae35a255d2f1c7
 SHA512:
-  metadata.gz: f975911ec89661747af26a32e98063e0e7c567a18c0d08e9f7113f7623cdba777a32a9e98af656612418a2e7640a9bbbe8bef3e415eb3f0189cd97bfbc54175e
-  data.tar.gz: 90064479821a90ff7d2c13c2925f6903e962987092b25ae23985d525e1e79acd2b63a4a28a12b5b9024913e1898918ade9f0c2c2c8870c6ec768e45e43dbd5e7
+  metadata.gz: f9926045bb5cfa3ded4e3eedfbcc1b97e9e0293b8bf55b3f7f7177f69cbcdaf21e3f5f1e760e2808f513140a081876eeac598b2f5f30f16aa40cc546f4c1ca05
+  data.tar.gz: da2bbcf38f26a74e8cfa76513912253dffa758abb9e8c928c40b5509a78c69e3055b8856de847e35955f43fd28f1f20884ebc3ff89145cceb81614ef5844f160

data/README.md

@@ -2,11 +2,16 @@
 
 Stepped is a Rails engine for orchestrating complex workflows as a tree of actions. Each action is persisted, runs through Active Job, and can fan out into more actions while keeping the parent action moving step-by-step as dependencies complete.
 
-The core ideas are:
+<img width="1024" height="1024" alt="stepped-actions" src="https://github.com/user-attachments/assets/32577a1e-1240-44ec-af0a-493a48ec70ef" />
+
+Stepped was extracted out of [Envirobly](https://klevo.sk/projects/envirobly-efficient-application-hosting-platform/) where it powers tasks like application deployment, that involve complex, out-of-the-band tasks like DNS provisioning, retries, waiting for instances to boot, running health checks and all the fun of a highly distributed networked system.
+
+## Concepts
 
 - **Action trees**: define a root action with multiple steps; each step can enqueue more actions and the step completes only once all the actions within it complete.
+- **Models are the Actors**: in Rails, your business logic usually centers around database-persisted models. Stepped takes advantage of this and allows you to define and run actions on all your models, out of the box.
 - **Concurrency lanes**: actions with the same `concurrency_key` share a `Stepped::Performance`, so only one runs at a time while others queue up (with automatic superseding of older queued work).
-- **Reuse**: optional `checksum` lets Stepped skip work that is already achieved, or share a currently-performing action with multiple parents.
+- **Reuse**: optional `checksum` lets Stepped skip work that is already achieved, or share a currently-performing action with multiple parents. Imagine you need to launch multiple workflows with different outcomes, that all depend on the outcome of the same action, somewhere in the action tree. Stepped makes this easy and efficient.
 - **Outbound completion**: actions can be marked outbound (or implemented as a job) and completed later by an external event.
 
 ## Installation
@@ -212,7 +217,9 @@ Under the hood, completion forwards to the current outbound action for that acto
 
 ## Job-backed actions
 
-If you prefer to implement an action as an Active Job, declare it with `job:`. Job-backed actions are treated as outbound and are expected to call `action.complete!` when finished:
+This is especially useful if you'd like to have (delayed) retries on certain errors, that ActiveJob supports out of the box. 
+
+You can declare it with `job:`. Job-backed actions are treated as outbound and are expected to call `action.complete!` when finished. The action instance is passed as the first and only argument. To work with the action arguments, use the familiar `action.arguments`:
 
 ```ruby
 class TowJob < ActiveJob::Base
@@ -230,11 +237,14 @@ class Car < ApplicationRecord
 end
 ```
 
-You can extend existing actions (including job-backed ones) by prepending steps:
+You can extend existing actions by prepending steps. This is especially useful when a parent class defines an action,
+that you want to modify in a child class. For example:
 
 ```ruby
-Car.prepend_stepped_action_step :tow do
-  honk
+class SportsCar < Car
+  prepend_stepped_action_step :tow do |step|
+    step.do :something_special
+  end
 end
 ```
 

data/lib/stepped/version.rb

@@ -1,3 +1,3 @@
 module Stepped
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stepped
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Robert Starsi
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 email:
 - klevo@klevo.sk
 executables: []
@@ -78,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Rails engine for orchestrating complex action trees.
 test_files: []