Class: Browserctl::WorkflowDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/browserctl/workflow.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ WorkflowDefinition

Returns a new instance of WorkflowDefinition.



120
121
122
123
124
125
 
# File 'lib/browserctl/workflow.rb', line 120

def initialize(name)
  @name = name
  @description = nil
  @param_defs  = {}
  @steps       = []
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



118
119
120
 
# File 'lib/browserctl/workflow.rb', line 118

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



118
119
120
 
# File 'lib/browserctl/workflow.rb', line 118

def name
  @name
end

#param_defs ⇒ Object (readonly)

Returns the value of attribute param_defs.



118
119
120
 
# File 'lib/browserctl/workflow.rb', line 118

def param_defs
  @param_defs
end

#steps ⇒ Object (readonly)

Returns the value of attribute steps.



118
119
120
 
# File 'lib/browserctl/workflow.rb', line 118

def steps
  @steps
end

Instance Method Details

#call(params, client) ⇒ Object 



146
147
148
149
 
# File 'lib/browserctl/workflow.rb', line 146

def call(params, client)
  ctx = WorkflowContext.new(resolve_params(params), client)
  execute_steps(ctx)
end

#compose(workflow_name) ⇒ Object

Raises:



139
140
141
142
143
144
 
# File 'lib/browserctl/workflow.rb', line 139

def compose(workflow_name)
  source = REGISTRY[workflow_name.to_s]
  raise WorkflowError, "workflow '#{workflow_name}' not found for composition" unless source

  @steps.concat(source.steps)
end

#desc(text) ⇒ Object 



127
128
129
 
# File 'lib/browserctl/workflow.rb', line 127

def desc(text)
  @description = text
end

#param(name, required: false, secret: false, default: nil) ⇒ Object 



131
132
133
 
# File 'lib/browserctl/workflow.rb', line 131

def param(name, required: false, secret: false, default: nil)
  @param_defs[name] = ParamDef.new(name: name, required: required, secret: secret, default: default)
end

#step(label, retry_count: 0, timeout: nil, &block) ⇒ Object 



135
136
137
 
# File 'lib/browserctl/workflow.rb', line 135

def step(label, retry_count: 0, timeout: nil, &block)
  @steps << StepDef.new(label: label, block: block, retry_count: retry_count, timeout: timeout)
end