Class: ActiveSupport::Callbacks::Callback

Inherits:
Object
  • Object
show all
Defined in:
activesupport/lib/active_support/callbacks.rb

Overview

:nodoc:#

Constant Summary collapse

@@_callback_sequence =
0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(chain, filter, kind, options, klass) ⇒ Callback

Returns a new instance of Callback


97
98
99
100
101
102
103
104
105
106
107
108
# File 'activesupport/lib/active_support/callbacks.rb', line 97

def initialize(chain, filter, kind, options, klass)
  @chain, @kind, @klass = chain, kind, klass
  normalize_options!(options)

  @per_key              = options.delete(:per_key)
  @raw_filter, @options = filter, options
  @filter               = _compile_filter(filter)
  @compiled_options     = _compile_options(options)
  @callback_id          = next_id

  _compile_per_key_options
end

Instance Attribute Details

#chainObject

Returns the value of attribute chain


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def chain
  @chain
end

#filterObject

Returns the value of attribute filter


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def filter
  @filter
end

#kindObject

Returns the value of attribute kind


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def kind
  @kind
end

#klassObject

Returns the value of attribute klass


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def klass
  @klass
end

#optionsObject

Returns the value of attribute options


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def options
  @options
end

#per_keyObject

Returns the value of attribute per_key


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def per_key
  @per_key
end

#raw_filterObject

Returns the value of attribute raw_filter


95
96
97
# File 'activesupport/lib/active_support/callbacks.rb', line 95

def raw_filter
  @raw_filter
end

Instance Method Details

#_compile_per_key_optionsObject


159
160
161
162
163
164
165
166
167
# File 'activesupport/lib/active_support/callbacks.rb', line 159

def _compile_per_key_options
  key_options  = _compile_options(@per_key)

  @klass.class_eval "def _one_time_conditions_valid_\#{@callback_id}?\ntrue if \#{key_options}\nend\n", __FILE__, __LINE__ + 1
end

#_update_filter(filter_options, new_options) ⇒ Object


144
145
146
147
# File 'activesupport/lib/active_support/callbacks.rb', line 144

def _update_filter(filter_options, new_options)
  filter_options[:if].push(new_options[:unless]) if new_options.key?(:unless)
  filter_options[:unless].push(new_options[:if]) if new_options.key?(:if)
end

#clone(chain, klass) ⇒ Object


110
111
112
113
114
115
116
117
118
119
120
121
# File 'activesupport/lib/active_support/callbacks.rb', line 110

def clone(chain, klass)
  obj                  = super()
  obj.chain            = chain
  obj.klass            = klass
  obj.per_key          = @per_key.dup
  obj.options          = @options.dup
  obj.per_key[:if]     = @per_key[:if].dup
  obj.per_key[:unless] = @per_key[:unless].dup
  obj.options[:if]     = @options[:if].dup
  obj.options[:unless] = @options[:unless].dup
  obj
end

#end(key = nil, object = nil) ⇒ Object

This will supply contents for around and after filters, but not before filters (for the backward pass).


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'activesupport/lib/active_support/callbacks.rb', line 228

def end(key=nil, object=nil)
  return if key && !object.send("_one_time_conditions_valid_#{@callback_id}?")

  case @kind
  when :after
    # after_save :filter_name, :if => :condition
    "if \#{@compiled_options}\n\#{@filter}\nend\n"
  when :around
    "value\nend\n"
  end
end

#matches?(_kind, _filter) ⇒ Boolean

Returns:

  • (Boolean)

140
141
142
# File 'activesupport/lib/active_support/callbacks.rb', line 140

def matches?(_kind, _filter)
  @kind == _kind && @filter == _filter
end

#nameObject


132
133
134
# File 'activesupport/lib/active_support/callbacks.rb', line 132

def name
  chain.name
end

#next_idObject


136
137
138
# File 'activesupport/lib/active_support/callbacks.rb', line 136

def next_id
  @@_callback_sequence += 1
end

#normalize_options!(options) ⇒ Object


123
124
125
126
127
128
129
130
# File 'activesupport/lib/active_support/callbacks.rb', line 123

def normalize_options!(options)
  options[:if] = Array.wrap(options[:if])
  options[:unless] = Array.wrap(options[:unless])

  options[:per_key] ||= {}
  options[:per_key][:if] = Array.wrap(options[:per_key][:if])
  options[:per_key][:unless] = Array.wrap(options[:per_key][:unless])
end

#recompile!(_options, _per_key) ⇒ Object


149
150
151
152
153
154
155
156
157
# File 'activesupport/lib/active_support/callbacks.rb', line 149

def recompile!(_options, _per_key)
  _update_filter(self.options, _options)
  _update_filter(self.per_key, _per_key)

  @callback_id      = next_id
  @filter           = _compile_filter(@raw_filter)
  @compiled_options = _compile_options(@options)
                      _compile_per_key_options
end

#start(key = nil, object = nil) ⇒ Object

This will supply contents for before and around filters, and no contents for after filters (for the forward pass).


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
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
# File 'activesupport/lib/active_support/callbacks.rb', line 171

def start(key=nil, object=nil)
  return if key && !object.send("_one_time_conditions_valid_#{@callback_id}?")

  # options[0] is the compiled form of supplied conditions
  # options[1] is the "end" for the conditional
  #
  case @kind
  when :before
    # if condition    # before_save :filter_name, :if => :condition
    #   filter_name
    # end
    "if !halted && \#{@compiled_options}\n# This double assignment is to prevent warnings in 1.9.3 as\n# the `result` variable is not always used except if the\n# terminator code refers to it.\nresult = result = \#{@filter}\nhalted = (\#{chain.config[:terminator]})\nif halted\nhalted_callback_hook(\#{@raw_filter.inspect.inspect})\nend\nend\n"
  when :around
    # Compile around filters with conditions into proxy methods
    # that contain the conditions.
    #
    # For `around_save :filter_name, :if => :condition':
    #
    # def _conditional_callback_save_17
    #   if condition
    #     filter_name do
    #       yield self
    #     end
    #   else
    #     yield self
    #   end
    # end
    #
    name = "_conditional_callback_#{@kind}_#{next_id}"
    @klass.class_eval "def \#{name}(halted)\nif \#{@compiled_options} && !halted\n\#{@filter} do\nyield self\nend\nelse\nyield self\nend\nend\n",  __FILE__, __LINE__ + 1
    "#{name}(halted) do"
  end
end