Class: Eco::API::Session::Config::Workflow
- Inherits:
-
Object
- Object
- 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: [:get, :filter]}, {people: [:get, :filter]}, :filter]}, :usecases, :launch_jobs, {post_launch: [:usecases, :launch_jobs]}, :report, :end, :close ]
Instance Attribute Summary collapse
-
#config ⇒ Object
readonly
Returns the value of attribute config.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
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
. -
#for(key = nil) {|stage_workflow| ... } ⇒ Eco::API::Session::Config::Workflow
Used in configuration time to configure the workflow of the target (sub)stage
key
. -
#initialize(name = nil, _parent: self, config:) ⇒ Workflow
constructor
A new instance of Workflow.
-
#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
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, _parent: self, config:) ⇒ Workflow
Returns a new instance of Workflow.
44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/eco/api/session/config/workflow.rb', line 44 def initialize(name = nil, _parent: self, config:) @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 |
#name ⇒ Object (readonly)
Returns the value of attribute name.
42 43 44 |
# File 'lib/eco/api/session/config/workflow.rb', line 42 def name @name end |
Class Method Details
.model ⇒ Object
22 23 24 |
# File 'lib/eco/api/session/config/workflow.rb', line 22 def model super || {} end |
.stages ⇒ Object
18 19 20 |
# File 'lib/eco/api/session/config/workflow.rb', line 18 def stages model_attrs end |
.validate_stage(stage) ⇒ Object
26 27 28 |
# File 'lib/eco/api/session/config/workflow.rb', line 26 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
166 167 168 169 170 171 172 173 174 |
# File 'lib/eco/api/session/config/workflow.rb', line 166 def after(key = nil, &block) raise "A block should be given." unless block if !key @after.push(block) else stage(key).after(&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
144 145 146 147 148 149 150 151 152 |
# File 'lib/eco/api/session/config/workflow.rb', line 144 def before(key = nil, &block) raise "A block should be given." unless block if !key @before.push(block) else stage(key).before(&block) end self end |
#for(key = nil) {|stage_workflow| ... } ⇒ Eco::API::Session::Config::Workflow
if a block
is provided it will yield
the target stage immediately
Used in configuration time to configure the workflow of the target (sub)stage key
90 91 92 93 94 95 96 97 98 |
# File 'lib/eco/api/session/config/workflow.rb', line 90 def for(key = nil) raise "A block should be given." unless block_given? if !key yield(self) else stage(key).for(&Proc.new) end self 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
110 111 112 113 114 115 116 117 118 |
# File 'lib/eco/api/session/config/workflow.rb', line 110 def on(key = nil, &block) raise "A block should be given." unless block if !key @on = block else stage(key).on(&block) end self end |
#pending? ⇒ Boolean
it does not include sub-stages that run before
Has this stage run yet?
61 62 63 |
# File 'lib/eco/api/session/config/workflow.rb', line 61 def pending? @pending end |
#rescue {|exception, io| ... } ⇒ Eco::API::Session::Config::Workflow
When there is an Exception
, you might have defined some callback
to do something with it (i.e. register, email)
126 127 128 129 130 |
# File 'lib/eco/api/session/config/workflow.rb', line 126 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)
Used in run time to execute the workflow of the (sub)stage key
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/eco/api/session/config/workflow.rb', line 198 def run(key = nil, io:, &block) raise "Missing BaseIO object" unless io.is_a?(Eco::API::UseCases::BaseIO) begin if key io = stage(key).run(io: io, &block) elsif pending? @before.each do |c| io = c.call(self, io).tap do |i_o| unless i_o.is_a?(Eco::API::UseCases::BaseIO) msg = "Workflow callaback before('#{name}') should return Eco::API::UseCases::BaseIO object." msg += " Given #{i_o.class}" msg += " • Callback source location: '#{c.source_location}'" raise ArgumentError.new(msg) end end end unless skip? io.session.logger.debug("(Workflow: #{path}) running now") if block io = block.call(self, io) else existing_stages.each {|stg| io = stg.run(io: io)} unless ready? msg = "(Workflow: #{path}) 'on' callback is not defined, nor block given" io.session.logger.debug(msg) end io = @on.call(self, io) if ready? end @pending = false end @after.each do |c| io = c.call(self, io).tap do |i_o| unless i_o.is_a?(Eco::API::UseCases::BaseIO) msg = "Workflow callaback after('#{name}') should return Eco::API::UseCases::BaseIO object." msg += " Given #{i_o.class}" msg += " • Callback source location: '#{c.source_location}'" raise ArgumentError.new(msg) end end end end rescue SystemExit exit rescue Interrupt => i raise rescue Exception => e self.rescue.call(e, io) if self.rescue raise end io end |
#skip! ⇒ Object
Do not run this stage!
66 67 68 69 |
# File 'lib/eco/api/session/config/workflow.rb', line 66 def skip! @skip = true @pending = false end |
#skip? ⇒ Boolean
Has this stage been marked as to be skipped
76 77 78 79 80 |
# File 'lib/eco/api/session/config/workflow.rb', line 76 def skip? return @skip if instance_variable_defined?(:@skip) return false if root? @_parent.skip? end |