Class: Eco::API::Session::Config::Workflow
- Extended by:
- Common::ClassHierarchy
- Defined in:
- lib/eco/api/session/config/workflow.rb
Constant Summary collapse
- WORKFLOW_MODEL =
:options, {load: [{input: %i[get filter]}, {people: %i[get filter]}, :filter]}, :usecases, :launch_jobs, {post_launch: %i[usecases launch_jobs]}, :report, :end, :close ].freeze
Instance Attribute Summary collapse
-
#config ⇒ Object
readonly
Returns the value of attribute config.
Attributes included from Common::ClassHierarchy
Class Method Summary collapse
Instance Method Summary collapse
-
#after(key = nil) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
Used in configuration time add previous
callbacks
after theon
callback of the (sub)stagekey
is actuallyrun
. -
#before(key = nil) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
Used in configuration time add previous
callbacks
before theon
callback of the (sub)stagekey
is actuallyrun
. -
#exit_handle(&block) ⇒ Object
Called on
SystemExit
exception. -
#for(key = nil) {|stage_workflow| ... } ⇒ Eco::API::Session::Config::Workflow
(also: #with)
Used in configuration time to configure the workflow of the target (sub)stage
key
. -
#initialize(name = nil, config:, _parent: self) ⇒ Workflow
constructor
rubocop:disable Lint/UnderscorePrefixedVariableName.
- #name(with_path: false) ⇒ Object
-
#on(key = nil) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
Used in configuration time to define the behaviour the target (sub)stage
key
. -
#pending? ⇒ Boolean
Has this stage run yet?.
-
#rescue {|exception, io| ... } ⇒ Eco::API::Session::Config::Workflow
(also: #exception)
When there is an
Exception
, you might have defined somecallback
to do something with it (i.e. register, email). -
#run(key = nil, io:) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
Used in run time to execute the workflow of the (sub)stage
key
. -
#skip! ⇒ Object
Do not run this stage!.
-
#skip? ⇒ Boolean
Has this stage been marked as to be skipped.
Methods included from Common::ClassHierarchy
Methods included from Common::ClassHelpers
#class_resolver, #descendants, #descendants?, #inheritable_attrs, #inheritable_class_vars, #inherited, #instance_variable_name, #new_class, #resolve_class, #to_constant
Constructor Details
#initialize(name = nil, config:, _parent: self) ⇒ Workflow
rubocop:disable Lint/UnderscorePrefixedVariableName
43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/eco/api/session/config/workflow.rb', line 43 def initialize(name = nil, config:, _parent: self) # rubocop:disable Lint/UnderscorePrefixedVariableName @config = config @name = name @stages = {} @_parent = _parent @pending = true # moments @on = nil @before = [] @after = [] end |
Instance Attribute Details
#config ⇒ Object (readonly)
Returns the value of attribute config.
41 42 43 |
# File 'lib/eco/api/session/config/workflow.rb', line 41 def config @config end |
Class Method Details
.model ⇒ Object
23 24 25 |
# File 'lib/eco/api/session/config/workflow.rb', line 23 def model super || {} end |
.stages ⇒ Object
19 20 21 |
# File 'lib/eco/api/session/config/workflow.rb', line 19 def stages model_attrs end |
.validate_stage(stage) ⇒ Object
27 28 29 |
# File 'lib/eco/api/session/config/workflow.rb', line 27 def validate_stage(stage) "Unknown Workflow stage '#{stage}'. Should be any of #{stages}" unless stages.include?(stage) end |
Instance Method Details
#after(key = nil) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
- it will not
yield
it immediately, but when the workflow reaches the target stage - in this case, you can define multiple
callbacks
Used in configuration time add previous callbacks
after the on
callback
of the (sub)stage key
is actually run
190 191 192 193 194 195 196 197 198 |
# File 'lib/eco/api/session/config/workflow.rb', line 190 def after(key = nil, &block) raise ArgumentError, "A block should be given." unless block_given? if key stage(key).after(&block) else @after.push(block) end self end |
#before(key = nil) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
- it will not
yield
it immediately, but when the workflow reaches the target stage - in this case, you can define multiple
callbacks
Used in configuration time add previous callbacks
before the on
callback of the (sub)stage key
is actually run
166 167 168 169 170 171 172 173 174 |
# File 'lib/eco/api/session/config/workflow.rb', line 166 def before(key = nil, &block) raise ArgumentError, "A block should be given." unless block_given? if key stage(key).before(&block) else @before.push(block) end self end |
#exit_handle(&block) ⇒ Object
Called on SystemExit
exception
146 147 148 149 150 |
# File 'lib/eco/api/session/config/workflow.rb', line 146 def exit_handle(&block) return @exit_handle unless block @exit_handle = block self end |
#for(key = nil) {|stage_workflow| ... } ⇒ Eco::API::Session::Config::Workflow Also known as: with
- if a
block
is provided it willyield
the target stage immediately - a
block
is only required whenkey
has not been specified.
Used in configuration time to configure the workflow of the target (sub)stage key
98 99 100 101 102 103 104 105 |
# File 'lib/eco/api/session/config/workflow.rb', line 98 def for(key = nil, &block) raise ArgumentError, "With no 'key', a block should be given." unless key || block_given? tap do next yield(self) unless key next stage(key).for(&block) if block_given? return stage(key) end end |
#name(with_path: false) ⇒ Object
57 58 59 60 |
# File 'lib/eco/api/session/config/workflow.rb', line 57 def name(with_path: false) return @name if !with_path || root? [@_parent.name(with_path: true), @name].compact.join('.') end |
#on(key = nil) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
if a block
is provided it will not yield
the target stage immediately,
but when the workflow reaches the stage
Used in configuration time to define the behaviour the target (sub)stage key
119 120 121 122 123 124 125 126 127 |
# File 'lib/eco/api/session/config/workflow.rb', line 119 def on(key = nil, &block) raise ArgumentError, "A block should be given." unless block_given? if key stage(key).on(&block) else @on = block end self end |
#pending? ⇒ Boolean
it does not include sub-stages that run before
Has this stage run yet?
65 66 67 |
# File 'lib/eco/api/session/config/workflow.rb', line 65 def pending? @pending end |
#rescue {|exception, io| ... } ⇒ Eco::API::Session::Config::Workflow Also known as: exception
When there is an Exception
, you might have defined some callback
to do something with it (i.e. register, email)
137 138 139 140 141 |
# File 'lib/eco/api/session/config/workflow.rb', line 137 def rescue(&block) return @rescue unless block @rescue = block self end |
#run(key = nil, io:) {|stage_workflow, io| ... } ⇒ Eco::API::Session::Config::Workflow
if a block
is not provided:
- it will run the
before
callbacks defined during the configuration time - it will run the workflow of any defined substage of the
key
stage - it will run the
on
callback defined during the configuration time - it will mark the stage as not
pending?
. - it will run the
after
callbacks defined during the configuration time
if a block
is provided:
- it will not run the workflow of the substages to
key
stage - it will not run the
callback
foron
defined during the configuration time - it will rather
yield
the target stage after all thebefore
callbacks have been run - aside of this, the rest will be the same as when the block is provided (see previous note)
[if the object returned by before
, after
and run
callbacks
is not an Eco::API::UseCases::BaseIO
, the original io
object will be returned instead.
Used in run time to execute the workflow of the (sub)stage key
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/eco/api/session/config/workflow.rb', line 223 def run(key = nil, io:, &block) raise "Missing BaseIO object" unless io.is_a?(Eco::API::UseCases::BaseIO) rescuable(io) do if key io = io_result(io: io) do stage(key).run(io: io, &block) end elsif pending? io = run_before(io) io = run_it(io, &block) unless skip? io = run_after(io) end io ensure @pending = false end end |
#skip! ⇒ Object
Do not run this stage!
70 71 72 73 |
# File 'lib/eco/api/session/config/workflow.rb', line 70 def skip! @skip = true @pending = false end |
#skip? ⇒ Boolean
Has this stage been marked as to be skipped
80 81 82 83 84 |
# File 'lib/eco/api/session/config/workflow.rb', line 80 def skip? return @skip if instance_variable_defined?(:@skip) return false if root? @_parent.skip? end |