Module: CMDx::Workflow

Defined in:
lib/cmdx/workflow.rb

Overview

Provides workflow execution capabilities by organizing tasks into execution groups. Workflows allow you to define sequences of tasks that can be executed conditionally with breakpoint handling and context management.

Defined Under Namespace

Modules: ClassMethods Classes: ExecutionGroup

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

Extends the including class with workflow capabilities.

Examples:

class MyWorkflow
  include CMDx::Workflow
  # Now has access to task, tasks, and work methods
end

Parameters:

  • base (Class) —

    The class including this module

Rbs:

  • (Class base) -> void



111
112
113
 
# File 'lib/cmdx/workflow.rb', line 111

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#work ⇒ Object

Executes the workflow by processing all tasks in the pipeline. This method delegates execution to the Pipeline class which handles the processing of tasks with proper error handling and context management.

Examples:

class MyWorkflow
  include CMDx::Workflow
  task ValidateTask
  task ProcessTask
end

workflow = MyWorkflow.new
result = workflow.work

Rbs:

  • () -> void



130
131
132
 
# File 'lib/cmdx/workflow.rb', line 130

def work
  Pipeline.execute(self)
end