Class: Card::ActManager::StageDirector

Inherits:
Object
  • Object
show all
Includes:
Stage
Defined in:
lib/card/act_manager/stage_director.rb

Overview

A 'StageDirector' executes the stages of a card when the card gets created, updated or deleted. For subcards, i.e. other cards that are changed in the same act, a StageDirector has StageSubdirectors that take care of the stages for those cards

In general a stage is executed for all involved cards before the StageDirector proceeds with the next stage. Only exception is the finalize stage. The finalize stage of a subcard is executed immediately after its store stage. When all subcards are finalized the supercard's finalize stage is executed.

If a subcard is added in a stage then it catches up at the end of the stage to the current stage. For example if you add a subcard in a card's :prepare_to_store stage then after that stage the stages :initialize, :prepare_to_validate, :validate and :prepare_to_store are executed for the subcard.

Stages are executed with pre-order depth-first search. That means if A has subcards AA and AB; AAA is subcard of AA and ABA subcard of AB then the order of execution is A -> AA -> AAA -> AB -> ABA

A special case can happen in the store phase. If the id of a subcard is needed for a supercard (for example as left_id or as type_id) and the subcard doesn't have an id yet (because it gets created in the same act) then the subcard's store stage is executed before the supercard's store stage

Direct Known Subclasses

StageSubdirector

Constant Summary

Constants included from Stage

Card::ActManager::Stage::STAGES, Card::ActManager::Stage::STAGE_INDEX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Stage

#after?, #before?, #in?, #stage_index, #stage_ok?, #stage_symbol

Constructor Details

#initialize(card, opts = {}, main = true) ⇒ StageDirector

Returns a new instance of StageDirector.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/card/act_manager/stage_director.rb', line 57

def initialize card, opts={}, main=true
  @card = card
  @card.director = self
  # for read actions there is no validation phase
  # so we have to set the action here
  @card.identify_action

  @stage = nil
  @running = false
  @prepared = false
  @parent = opts[:parent]
  # has card to be stored before the supercard?
  @prior_store = opts[:priority]
  @call_after_store = []
  @main = main
  @subdirectors = SubdirectorArray.initialize_with_subcards(self)
  register
end

Instance Attribute Details

#act ⇒ Object

Returns the value of attribute act.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def act
  @act
end

#card ⇒ Object

Returns the value of attribute card.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def card
  @card
end

#main ⇒ Object Also known as: main?

Returns the value of attribute main.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def main
  @main
end

#parent ⇒ Object

Returns the value of attribute parent.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def parent
  @parent
end

#prior_store ⇒ Object

Returns the value of attribute prior_store.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def prior_store
  @prior_store
end

#running ⇒ Object (readonly) Also known as: running?

Returns the value of attribute running.



53
54
55
 
# File 'lib/card/act_manager/stage_director.rb', line 53

def running
  @running
end

#stage ⇒ Object

Returns the value of attribute stage.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def stage
  @stage
end

#subdirectors ⇒ Object

Returns the value of attribute subdirectors.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def subdirectors
  @subdirectors
end

#transact_in_stage ⇒ Object

Returns the value of attribute transact_in_stage.



51
52
53
 
# File 'lib/card/act_manager/stage_director.rb', line 51

def transact_in_stage
  @transact_in_stage
end

Instance Method Details

#abort ⇒ Object 



141
142
143
 
# File 'lib/card/act_manager/stage_director.rb', line 141

def abort
  @abort = true
end

#call_after_store(&block) ⇒ Object 



145
146
147
 
# File 'lib/card/act_manager/stage_director.rb', line 145

def call_after_store &block
  @call_after_store << block
end

#catch_up_to_stage(next_stage) ⇒ Object 



127
128
129
130
131
132
133
134
135
 
# File 'lib/card/act_manager/stage_director.rb', line 127

def catch_up_to_stage next_stage
  if @transact_in_stage
    return if @transact_in_stage != next_stage
    next_stage = :integrate_with_delay
  end
  upto_stage(next_stage) do |stage|
    run_single_stage stage
  end
end

#delete ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/card/act_manager/stage_director.rb', line 84

def delete
  @card.director = nil
  @subdirectors.clear
  @stage = nil
  @action = nil
end

#integration_phase ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/card/act_manager/stage_director.rb', line 113

def integration_phase
  return if @abort
  @card.restore_changes_information
  run_single_stage :integrate
  run_single_stage :integrate_with_delay
rescue => e  # don't rollback
  Card::Error.current = e
  @card.notable_exception_raised
  return false
ensure
  @card.changes_applied unless @abort
  ActManager.clear if main? && !@card.only_storage_phase
end

#main_director ⇒ Object 



158
159
160
161
162
163
164
 
# File 'lib/card/act_manager/stage_director.rb', line 158

def main_director
  if main?
    self
  else
    ActManager.act_director || (@parent && @parent.main_director)
  end
end

#need_act ⇒ Object 



149
150
151
152
153
154
155
156
 
# File 'lib/card/act_manager/stage_director.rb', line 149

def need_act
  act_director = main_director
  unless act_director
    raise Card::Error, "act requested without a main stage director"
  end
  act_director.act ||= Card::Act.create(ip_address: Env.ip)
  @card.current_act = @act = act_director.act
end

#prepare_for_phases ⇒ Object 



91
92
93
94
95
 
# File 'lib/card/act_manager/stage_director.rb', line 91

def prepare_for_phases
  @card.prepare_for_phases unless @prepared
  @prepared = true
  @subdirectors.each(&:prepare_for_phases)
end

#register ⇒ Object 



76
77
78
 
# File 'lib/card/act_manager/stage_director.rb', line 76

def register
  ActManager.add self
end

#reset_stage ⇒ Object 



137
138
139
 
# File 'lib/card/act_manager/stage_director.rb', line 137

def reset_stage
  @stage = -1
end

#storage_phase(&block) ⇒ Object 



105
106
107
108
109
110
111
 
# File 'lib/card/act_manager/stage_director.rb', line 105

def storage_phase &block
  catch_up_to_stage :prepare_to_store
  run_single_stage :store, &block
  run_single_stage :finalize
ensure
  @from_trash = nil
end

#to_s ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/card/act_manager/stage_director.rb', line 166

def to_s
  str = @card.name.to_s.clone
  if @subdirectors
    subs = subdirectors.map(&:card)
                       .map { |card| "  #{card.name}" }.join "\n"
    str << "\n#{subs}"
  end
  str
end

#unregister ⇒ Object 



80
81
82
 
# File 'lib/card/act_manager/stage_director.rb', line 80

def unregister
  ActManager.delete self
end

#update_card(card) ⇒ Object 



176
177
178
179
180
 
# File 'lib/card/act_manager/stage_director.rb', line 176

def update_card card
  old_card = @card
  @card = card
  ActManager.card_changed old_card
end

#validation_phase ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/card/act_manager/stage_director.rb', line 97

def validation_phase
  run_single_stage :initialize
  run_single_stage :prepare_to_validate
  run_single_stage :validate
  @card.expire_pieces if @card.errors.any?
  @card.errors.empty?
end