Class: Card::StageDirector

Inherits:
Object
  • Object
show all
Includes:
Stage
Defined in:
lib/card/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::Stage::STAGES, Card::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.



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

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.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def act
  @act
end

#card ⇒ Object

Returns the value of attribute card.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def card
  @card
end

#main ⇒ Object Also known as: main?

Returns the value of attribute main.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def main
  @main
end

#parent ⇒ Object

Returns the value of attribute parent.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def parent
  @parent
end

#prior_store ⇒ Object

Returns the value of attribute prior_store.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def prior_store
  @prior_store
end

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

Returns the value of attribute running.



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

def running
  @running
end

#stage ⇒ Object

Returns the value of attribute stage.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def stage
  @stage
end

#subdirectors ⇒ Object

Returns the value of attribute subdirectors.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def subdirectors
  @subdirectors
end

#transact_in_stage ⇒ Object

Returns the value of attribute transact_in_stage.



49
50
51
 
# File 'lib/card/stage_director.rb', line 49

def transact_in_stage
  @transact_in_stage
end

Instance Method Details

#abort ⇒ Object 



139
140
141
 
# File 'lib/card/stage_director.rb', line 139

def abort
  @abort = true
end

#call_after_store(&block) ⇒ Object 



143
144
145
 
# File 'lib/card/stage_director.rb', line 143

def call_after_store &block
  @call_after_store << block
end

#catch_up_to_stage(next_stage) ⇒ Object 



125
126
127
128
129
130
131
132
133
 
# File 'lib/card/stage_director.rb', line 125

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 



82
83
84
85
86
87
 
# File 'lib/card/stage_director.rb', line 82

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

#integration_phase ⇒ Object 



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

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
  DirectorRegister.clear if main? && !@card.only_storage_phase
end

#main_director ⇒ Object 



156
157
158
159
160
161
162
 
# File 'lib/card/stage_director.rb', line 156

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

#need_act ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/card/stage_director.rb', line 147

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 



89
90
91
92
93
 
# File 'lib/card/stage_director.rb', line 89

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

#register ⇒ Object 



74
75
76
 
# File 'lib/card/stage_director.rb', line 74

def register
  Card::DirectorRegister.add self
end

#reset_stage ⇒ Object 



135
136
137
 
# File 'lib/card/stage_director.rb', line 135

def reset_stage
  @stage = -1
end

#storage_phase(&block) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/card/stage_director.rb', line 103

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 



164
165
166
167
168
169
170
171
172
 
# File 'lib/card/stage_director.rb', line 164

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 



78
79
80
 
# File 'lib/card/stage_director.rb', line 78

def unregister
  Card::DirectorRegister.delete self
end

#update_card(card) ⇒ Object 



174
175
176
177
178
 
# File 'lib/card/stage_director.rb', line 174

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

#validation_phase ⇒ Object 



95
96
97
98
99
100
101
 
# File 'lib/card/stage_director.rb', line 95

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