cmdx 2.2.0 → 2.4.0

data/mkdocs.yml

@@ -121,38 +121,68 @@ plugins:
           - basics/chain.md: Execution chain tracking for related tasks within threads
         Interruptions:
           - interruptions/signals.md: Intentional task interruption using skip! and fail! methods
-          - interruptions/faults.md: CMDx::Fault raised by execute! with task class, signal, and cleaned backtrace
+          - interruptions/faults.md: execute! exceptions for failed tasks with result, task, context, chain, and cleaned backtrace
           - interruptions/exceptions.md: Complete exception hierarchy (Error, DeprecationError, ImplementationError, MiddlewareError, Fault) and execute vs execute! semantics
         Outcomes:
           - outcomes/result.md: Result objects exposing execution state, status, context, and metadata
           - outcomes/states.md: Execution lifecycle states (initialized, executing, complete, interrupted)
           - outcomes/statuses.md: Business outcome statuses (success, skipped, failed) and transitions
           - outcomes/errors.md: Structured per-attribute error container accumulated during input/output verification and exposed on result.errors
-        Attributes:
+        Contracts:
           - inputs/definitions.md: Attribute declarations (required/optional), validation, and type coercion
           - inputs/naming.md: Customizing accessor method names with prefixes and suffixes
           - inputs/coercions.md: Automatic type conversion for inputs (string to integer, date parsing, etc.)
           - inputs/validations.md: Input validation rules (presence, length, format, numeric, inclusion, exclusion)
           - inputs/defaults.md: Default values for optional inputs (static, dynamic, callable)
           - inputs/transformations.md: Value transformation after coercion but before validation
-        Features:
+          - outputs.md: Declaring expected context outputs that must be set after task execution
+        Hooks:
           - callbacks.md: Execution lifecycle callbacks (before_execution, on_success, on_failure, etc.)
           - middlewares.md: Cross-cutting concerns wrapping task execution (authentication, caching, timeouts)
+        Composition:
+          - workflows.md: Composing multiple tasks into sequential pipelines with conditional execution
+          - deprecation.md: Managing deprecated tasks with logging, warnings, or execution prevention
+        Resilience:
+          - stores.md: Shared key/value store for idempotency, rate limits, locks, and cross-worker coordination
+          - locks.md: Single-flight leases via Stores so concurrent workers do not run the same logical work
+          - idempotency.md: Preventing duplicate execution for retried jobs and webhooks with idempotent_by
+          - rate_limit.md: Admission control per window with fixed-window and leaky-bucket limiters
+          - circuit_breaker.md: Automatic circuit breaking for failing dependencies with threshold, cool-off, and window options
+          - retries.md: Automatic retry functionality for transient failures with jitter and selective retries
+        Observability:
           - logging.md: Structured logging with multiple formatters (JSON, KeyValue, Logstash, Line, Raw)
           - internationalization.md: Multi-language support for error messages and validations (90+ locales)
-          - retries.md: Automatic retry functionality for transient failures with jitter and selective retries
-          - deprecation.md: Managing deprecated tasks with logging, warnings, or execution prevention
-          - outputs.md: Declaring expected context outputs that must be set after task execution
-          - workflows.md: Composing multiple tasks into sequential pipelines with conditional execution
-        More:
+        Adoption:
           - testing.md: Best practices for testing CMDx tasks and workflows with RSpec
           - tips_and_tricks.md: Best practices, patterns, and techniques for maintainable CMDx applications
           - comparison.md: Comparison with other command/service object frameworks
           - v2-migration.md: Migration guide from CMDx 1.x to 2.0
+        Ecosystem:
+          - ecosystem.md: Satellite gems (cmdx-i18n, cmdx-rspec)
+        References:
+          - references.md: API docs, llms.txt exports, and repository AI skills
+        Cookbook:
+          - cookbook/index.md: Integration recipes for jobs, Rails, auth, observability, and more
+        "Cookbook: Rails and Active Record":
+          - cookbook/active_record_database_transaction.md: Wrap task work in an Active Record transaction
+          - cookbook/active_record_query_tagging.md: Tag SQL queries with task metadata
+          - cookbook/paper_trail_whatdunnit.md: Paper Trail attribution for running tasks
+        "Cookbook: API and integration":
+          - cookbook/graphql_resolvers.md: Resolve GraphQL fields with CMDx tasks
+          - cookbook/openapi_schema_generation.md: Generate OpenAPI schemas from task inputs
+          - cookbook/pub_sub_task_chaining.md: Chain tasks from pub/sub events
+        "Cookbook: Cross-cutting concerns":
+          - cookbook/background_execution.md: Run tasks via Active Job or Sidekiq
+          - cookbook/store_wrappers.md: Test doubles and instrumented store wrappers
+          - cookbook/flipper_feature_flags.md: Gate tasks behind Flipper feature flags
+          - cookbook/pundit_authorization.md: Authorize tasks with Pundit before work runs
+          - cookbook/timeout_guard.md: Bound task execution time with a timeout guard
+          - cookbook/sentry_error_tracking.md: Report CMDx faults to Sentry
+          - cookbook/opentelemetry_tracing.md: Distributed tracing for task execution
 nav:
   - Home: index.md
   - Documentation:
-    - Getting Started: getting_started.md
+    - Getting started: getting_started.md
     - Configuration: configuration.md
     - Basics:
       - Setup: basics/setup.md
@@ -168,36 +198,61 @@ nav:
       - States: outcomes/states.md
       - Statuses: outcomes/statuses.md
       - Errors: outcomes/errors.md
-    - Inputs:
+    - Contracts:
       - Definitions: inputs/definitions.md
       - Naming: inputs/naming.md
       - Coercions: inputs/coercions.md
       - Validations: inputs/validations.md
       - Defaults: inputs/defaults.md
       - Transformations: inputs/transformations.md
-    - Features:
+      - Outputs: outputs.md
+    - Hooks:
       - Callbacks: callbacks.md
       - Middlewares: middlewares.md
+    - Composition:
+      - Workflows: workflows.md
+      - Deprecation: deprecation.md
+    - Resilience:
+      - Stores: stores.md
+      - Locks: locks.md
+      - Idempotency: idempotency.md
+      - Rate limit: rate_limit.md
+      - Circuit breaker: circuit_breaker.md
+      - Retries: retries.md
+    - Observability:
       - Logging: logging.md
       - Internationalization: internationalization.md
-      - Retries: retries.md
-      - Deprecation: deprecation.md
-      - Outputs: outputs.md
-      - Workflows: workflows.md
-    - More:
+    - Adoption:
       - Testing: testing.md
-      - Tips and Tricks: tips_and_tricks.md
+      - Tips and tricks: tips_and_tricks.md
       - Comparison: comparison.md
       - v1 → v2 Migration: v2-migration.md
-      - Examples: https://github.com/drexed/cmdx/blob/main/examples/index.md
+    - Ecosystem:
+      - cmdx-i18n: https://github.com/drexed/cmdx-i18n
+      - cmdx-rspec: https://github.com/drexed/cmdx-rspec
     - References:
       - API Documentation: https://drexed.github.io/cmdx/api/index.html
       - llms.txt: https://drexed.github.io/cmdx/llms.txt
       - llms-full.txt: https://drexed.github.io/cmdx/llms-full.txt
       - AI Skills: https://github.com/drexed/cmdx/blob/main/skills
-    - Ecosystem:
-      - cmdx-i18n: https://github.com/drexed/cmdx-i18n
-      - cmdx-rspec: https://github.com/drexed/cmdx-rspec
+  - Cookbook:
+    - Overview: cookbook/index.md
+    - Rails and Active Record:
+      - Active Record Database Transaction: cookbook/active_record_database_transaction.md
+      - Active Record Query Tagging: cookbook/active_record_query_tagging.md
+      - Paper Trail Whatdunnit: cookbook/paper_trail_whatdunnit.md
+    - API and integration:
+      - GraphQL Resolvers: cookbook/graphql_resolvers.md
+      - OpenAPI Schema Generation: cookbook/openapi_schema_generation.md
+      - PubSub Task Chaining: cookbook/pub_sub_task_chaining.md
+    - Cross-cutting concerns:
+      - Background Execution: cookbook/background_execution.md
+      - Store Wrappers: cookbook/store_wrappers.md
+      - Flipper Feature Flags: cookbook/flipper_feature_flags.md
+      - Pundit Authorization: cookbook/pundit_authorization.md
+      - Timeout Guard: cookbook/timeout_guard.md
+      - Sentry Error Tracking: cookbook/sentry_error_tracking.md
+      - OpenTelemetry Tracing: cookbook/opentelemetry_tracing.md
   - Blog: blog/index.md
 
 extra:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmdx
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Juan Gomez
@@ -204,10 +204,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - lib/cmdx.rb
 - lib/cmdx/.DS_Store
 - lib/cmdx/callbacks.rb
 - lib/cmdx/chain.rb
+- lib/cmdx/circuit_breaker.rb
 - lib/cmdx/coercions.rb
 - lib/cmdx/coercions/array.rb
 - lib/cmdx/coercions/big_decimal.rb
@@ -236,8 +238,13 @@ files:
 - lib/cmdx/executors/thread.rb
 - lib/cmdx/fault.rb
 - lib/cmdx/i18n_proxy.rb
+- lib/cmdx/idempotency.rb
 - lib/cmdx/input.rb
 - lib/cmdx/inputs.rb
+- lib/cmdx/limiters.rb
+- lib/cmdx/limiters/fixed_window.rb
+- lib/cmdx/limiters/leaky_bucket.rb
+- lib/cmdx/lock.rb
 - lib/cmdx/log_formatters/json.rb
 - lib/cmdx/log_formatters/key_value.rb
 - lib/cmdx/log_formatters/line.rb
@@ -253,6 +260,7 @@ files:
 - lib/cmdx/outputs.rb
 - lib/cmdx/pipeline.rb
 - lib/cmdx/railtie.rb
+- lib/cmdx/rate_limit.rb
 - lib/cmdx/result.rb
 - lib/cmdx/retriers.rb
 - lib/cmdx/retriers/bounded_random.rb
@@ -266,6 +274,10 @@ files:
 - lib/cmdx/runtime.rb
 - lib/cmdx/settings.rb
 - lib/cmdx/signal.rb
+- lib/cmdx/store_key.rb
+- lib/cmdx/stores.rb
+- lib/cmdx/stores/memory.rb
+- lib/cmdx/stores/redis.rb
 - lib/cmdx/task.rb
 - lib/cmdx/telemetry.rb
 - lib/cmdx/util.rb