cmdx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aed549d510aee08ccdb114f75b51b7aefe1a9776905f53e75ec5c39477932350
+  data.tar.gz: b57596b1393185082d94616f8c08494d030a2d78bb85610674363a365efa15f5
+SHA512:
+  metadata.gz: 7d123c5a08fc89494b759eddea90e614858e55db733a3690e899de46b5e6e93e574a9bf2d9899f4f9c9c118686d5ff2f84cfd75b110ce242b79d7627ae3dfbd8
+  data.tar.gz: 17e336e03307f3dddaf7dba53d4a201f031f54348bc0e43059a17ace90cf7f4a762ad6e97ec731b32d1064616c978948867e8aa746ff96f52e93996376828a7c

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.rubocop.yml

@@ -0,0 +1,64 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 3.1.0
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/**/*'
+    - '*.gemspec'
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/SpecFilePathFormat:
+  CustomTransform:
+    CMDx: cmdx
+RSpec/VerifiedDoubleReference:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always_true
+  SafeAutoCorrect: true
+Style/OpenStructUse:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Juan Gomez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# CMDx
+
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)
+
+[![Gem Version](https://badge.fury.io/rb/cmdx.svg)](https://badge.fury.io/rb/cmdx)
+[![CI](https://github.com/drexed/cmdx/actions/workflows/ruby.yml/badge.svg)](https://github.com/drexed/cmdx/actions/workflows/ruby.yml)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
+
+`CMDx` is a framework for expressive processing of business logic. Design
+code of varying levels of complexity that is built through branching and
+composition, informative halting, and exhaustive tracing/debugging.
+
+## Installation
+
+**Prerequisites:** This gem requires Ruby `>= 3.1` to be installed.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cmdx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmdx
+
+## Table of contents
+
+- [Getting Started](https://github.com/drexed/cmdx/blob/main/docs/getting_started.md)
+- [Configuration](https://github.com/drexed/cmdx/blob/main/docs/configuration.md)
+- Basics
+  - [Setup](https://github.com/drexed/cmdx/blob/main/docs/basics/setup.md)
+  - [Call](https://github.com/drexed/cmdx/blob/main/docs/basics/call.md)
+  - [Context](https://github.com/drexed/cmdx/blob/main/docs/basics/context.md)
+  - [Run](https://github.com/drexed/cmdx/blob/main/docs/basics/run.md)
+- Interruptions
+  - [Halt](https://github.com/drexed/cmdx/blob/main/docs/interruptions/halt.md)
+  - [Faults](https://github.com/drexed/cmdx/blob/main/docs/interruptions/faults.md)
+  - [Exceptions](https://github.com/drexed/cmdx/blob/main/docs/interruptions/exceptions.md)
+- Parameters
+  - [Definitions](https://github.com/drexed/cmdx/blob/main/docs/parameters/definitions.md)
+  - [Namespacing](https://github.com/drexed/cmdx/blob/main/docs/parameters/namespacing.md)
+  - [Coercions](https://github.com/drexed/cmdx/blob/main/docs/parameters/coercions.md)
+  - [Validations](https://github.com/drexed/cmdx/blob/main/docs/parameters/validations.md)
+  - [Defaults](https://github.com/drexed/cmdx/blob/main/docs/parameters/defaults.md)
+- Outcomes
+  - [Result](#results)
+  - [States](https://github.com/drexed/cmdx/blob/main/docs/outcomes/states.md)
+  - [Statuses](https://github.com/drexed/cmdx/blob/main/docs/outcomes/statuses.md)
+- [Hooks](https://github.com/drexed/cmdx/blob/main/docs/hooks.md)
+- [Batch](https://github.com/drexed/cmdx/blob/main/docs/batch.md)
+- [Logging](https://github.com/drexed/cmdx/blob/main/docs/logging.md)
+- [Tips & Tricks](https://github.com/drexed/cmdx/blob/main/docs/tips_and_tricks.md)
+- [Example](https://github.com/drexed/cmdx/blob/main/docs/example.md)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drexed/cmdx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CMDx project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drexed/cmdx/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docs/basics/call.md

@@ -0,0 +1,31 @@
+# Basics - Call
+
+Calling a task executes the logic within it. Tasks can only be executed via
+the `call` and `call!` class methods.
+
+## Non-bang
+
+The `call` method will always return a `CMDx::Result` object after execution.
+
+```ruby
+ProcessOrderTask.call #=> <CMDx::Result ...>
+```
+
+## Bang
+
+The bang `call!` method raises a `CMDx::Fault` based exception depending on the defined
+`task_halt` status options, otherwise it will return a `CMDx::Result` object. This
+form of call is useful in background jobs where retries are done via the exception mechanism.
+
+```ruby
+ProcessOrderTask.call! #=> raises CMDx::Failed
+```
+
+> [!IMPORTANT]
+> Tasks are single use objects, once they have been called they are frozen and cannot be called again
+> as result object will be returned. Build a new task call to execute a new instance of the same task.
+
+---
+
+- **Prev:** [Basics - Setup](https://github.com/drexed/cmdx/blob/main/docs/basics/setup.md)
+- **Next:** [Basics - Context](https://github.com/drexed/cmdx/blob/main/docs/basics/context.md)

data/docs/basics/context.md

@@ -0,0 +1,67 @@
+# Basics - Context
+
+The task `context` provides a form of storage to the task objects themselves.
+
+## Loading
+
+Loading a task with data is as simple as passing objects in a key value format.
+The context object is a custom version of an [OpenStruct](https://github.com/ruby/ostruct)
+called a `LazyStruct` with no limitations for what can be stored.
+
+```ruby
+ProcessOrderTask.call(email: "bob@bigcorp.com", order: order)
+```
+
+## Access
+
+Tasks with a loaded context can be accessed within a task itself. Read, set and
+alter the context attributes anywhere within the task object.
+
+```ruby
+class ProcessOrderTask < CMDx::Task
+
+  def call
+    # Reading from context storage:
+    context.email #=> "bob@bigcorp.com"
+    ctx.order     #=> <Order #a1b2c3d>
+    context.idk   #=> nil
+
+    # Writing to context storage:
+    context.first_name = "Bob"
+    ctx.middle_name ||= "Biggie"
+    context.merge!(last_name: "Boomer")
+  end
+
+end
+```
+
+[Learn more](https://github.com/drexed/cmdx/blob/main/lib/cmdx/lazy_struct.rb)
+about the `LazyStruct` public API for interacting with the context.
+
+> [!NOTE]
+> Attributes that are **NOT** loaded into the context will return `nil`.
+
+## Passing
+
+Context objects can be passed to other tasks which allows you to build small tasks
+that passes data around as part of a higher level task.
+
+```ruby
+# Within task:
+class ProcessOrderTask < CMDx::Task
+
+  def call
+    SendEmailConfirmationTask.call(context)
+  end
+
+end
+
+# After call:
+result = ProcessOrderTask.call(email: "bob@bigcorp.com", order: order)
+NotifyPartnerWarehousesTask.call(result.ctx)
+```
+
+---
+
+- **Prev:** [Basics - Call](https://github.com/drexed/cmdx/blob/main/docs/basics/call.md)
+- **Next:** [Basics - Run](https://github.com/drexed/cmdx/blob/main/docs/basics/run.md)

data/docs/basics/run.md

@@ -0,0 +1,34 @@
+# Basics - Run
+
+A run represents a group of tasks executed as part of collection.
+
+When building complex tasks, it's best to pass the parents context to subtasks
+(unless necessary or preventative) so that it gains automated indexing and the
+parents `run_id`. This makes it easy to identify all tasks involved in one
+execution from logging and stdout console calls.
+
+```ruby
+class ProcessOrderTask < CMDx::Task
+
+  def call
+    # Subtasks inherit the ProcessOrderTask run_id:
+    SendEmailConfirmationTask.call(context)
+    NotifyPartnerWarehousesTask.call(context)
+  end
+
+end
+
+result = ProcessOrderTask.call
+puts result.run.to_s
+
+#   Task name                     Index   Run ID      Task ID   etc
+# -----------------------------------------------------------------
+#=> ProcessOrderTask              0       foobar123   abc123    ...
+#=> SendEmailConfirmationTask     1       foobar123   def456    ...
+#=> NotifyPartnerWarehousesTask   2       foobar123   ghi789    ...
+```
+
+---
+
+- **Prev:** [Basics - Context](https://github.com/drexed/cmdx/blob/main/docs/basics/context.md)
+- **Next:** [Interruptions - Halt](https://github.com/drexed/cmdx/blob/main/docs/interruptions/halt.md)

data/docs/basics/setup.md

@@ -0,0 +1,32 @@
+# Basics - Setup
+
+A task represents a unit of work to execute. While `CMDx` offers a plethora
+of features, a `call` method is the only thing required to execute a task.
+
+```ruby
+class ProcessOrderTask < CMDx::Task
+
+  def call
+    # Do work...
+  end
+
+  private
+
+  # Business logic...
+
+end
+```
+
+> [!TIP]
+> While complexity designed into a task is up to the engineer, it's
+> suggested that tasks be small and composed into higher level tasks.
+
+## Generator
+
+Run `rails g cmdx:task [NAME]` to create a task template file under `app/cmds`.
+Tasks will inherit from `ApplicationTask` if available or fall back to `CMDx::Task`.
+
+---
+
+- **Prev:** [Configuration](https://github.com/drexed/cmdx/blob/main/docs/configuration.md)
+- **Next:** [Basics - Call](https://github.com/drexed/cmdx/blob/main/docs/basics/call.md)

data/docs/batch.md

@@ -0,0 +1,53 @@
+# Batch
+
+A CMDx::Batch is a task that calls other tasks in a linear fashion. The
+context is passed down to each task, building on it knowledge with
+each step. This is useful for composing multiple steps into one call.
+
+> [!WARNING]
+> Do **NOT** define a call method in this class. The batch class automatically
+> defines the call logic.
+
+```ruby
+class BatchProcessCheckout < CMDx::Batch
+
+  # Task level settings:
+  task_settings!(batch_halt: CMDx::Result::FAILED)
+
+  # Single declaration:
+  process FinalizeInvoiceTask
+
+  # Multiple declarations:
+  process SendConfirmationEmailTask, SendConfirmationTextTask
+
+  # With options (applies to all declared in that group):
+  process BatchNotifyPartnerWarehouses, batch_halt: [CMDx::Result::SKIPPED, CMDx::Result::FAILED]
+  process BatchNotifyUsaWarehouses, unless: proc { context.invoice.fulfilled_in_house? }
+
+end
+```
+
+> [!IMPORTANT]
+> Process steps are executed in the order they are declared (FIFO: first in, first out).
+
+The `process` method support the following options:
+
+| Option        | Description |
+| ------------- | ----------- |
+| `:if`         | Specifies a callable method, proc or string to determine if processing steps should occur. |
+| `:unless`     | Specifies a callable method, proc, or string to determine if processing steps should not occur. |
+| `:batch_halt` | Sets which result statuses processing of further steps should be prevented. (default: `CMDx::Result::FAILED`) |
+
+> [!NOTE]
+> Batches stop execution on `failed` by default. This is due to the concept
+> of `skipped` being a bypass mechanism, rather than a choke point in execution.
+
+## Generator
+
+Run `rails g cmdx:batch [NAME]` to create a batch task template file under `app/cmds`.
+Tasks will inherit from `ApplicationBatch` if available or fall back to `CMDx::Batch`.
+
+---
+
+- **Prev:** [Hooks](https://github.com/drexed/cmdx/blob/main/docs/hooks.md)
+- **Next:** [Logging](https://github.com/drexed/cmdx/blob/main/docs/logging.md)

data/docs/configuration.md

@@ -0,0 +1,57 @@
+# Configuration
+
+Configuration of tasks can be done at global and task levels.
+
+## Global settings
+
+Run `rails g cmdx:install` to generate a configuration file within the
+`config/initializers` directory. These settings will be preloaded into all tasks.
+
+```ruby
+CMDx.configure do |config|
+  # Define which statuses a bang `call!` will halt and raise a fault.
+  # This option can accept an array of statuses.
+  config.task_halt = CMDx::Result::FAILED
+
+  # Enable task timeouts to prevent call execution beyond a defined threshold.
+  config.task_timeout = nil
+
+  # Define which statuses a batch task will halt execution from proceeding to the next step.
+  # By default skipped tasks are treated as a NOOP so processing is continued.
+  # This option can accept an array of statuses.
+  config.batch_halt = CMDx::Result::FAILED
+
+  # Enable batch timeouts to prevent call execution beyond a defined threshold.
+  # TIP: remember to account for all defined tasks when setting this value
+  config.batch_timeout = nil
+
+  # A list of available log formatter can be found at:
+  # https://github.com/drexed/cmdx/tree/main/lib/cmdx/log_formatters
+  config.logger = Logger.new($stdout, formatter: CMDx::LogFormatters::Line.new)
+end
+```
+
+## Task settings
+
+Finely tune tasks via class level settings.
+
+```ruby
+class ProcessOrderTask < CMDx::Task
+
+  # Task level settings:
+  task_settings!(task_timeout: 1, tags: ["v1", "DEPRECATED"])
+
+  def call
+    # Do work...
+  end
+
+end
+```
+
+> [!NOTE]
+> `tags` is a task level setting only. Tags will automatically be appended to logs.
+
+---
+
+- **Prev:** [Configuration](https://github.com/drexed/cmdx/blob/main/docs/configuration.md)
+- **Next:** [Basics - Setup](https://github.com/drexed/cmdx/blob/main/docs/basics/setup.md)