Class: CouchRest::Callbacks::Callback

Inherits:
Object
  • Object
show all
Defined in:
lib/couchrest/mixins/callbacks.rb

Constant Summary collapse

@@_callback_sequence = 
0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Callback.



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/couchrest/mixins/callbacks.rb', line 118

def initialize(filter, kind, options, klass)
  @kind, @klass = 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

#filter ⇒ Object

Returns the value of attribute filter.



117
118
119
 
# File 'lib/couchrest/mixins/callbacks.rb', line 117

def filter
  @filter
end

#kind ⇒ Object

Returns the value of attribute kind.



117
118
119
 
# File 'lib/couchrest/mixins/callbacks.rb', line 117

def kind
  @kind
end

#klass ⇒ Object

Returns the value of attribute klass.



117
118
119
 
# File 'lib/couchrest/mixins/callbacks.rb', line 117

def klass
  @klass
end

#name ⇒ Object

Returns the value of attribute name.



117
118
119
 
# File 'lib/couchrest/mixins/callbacks.rb', line 117

def name
  @name
end

#options ⇒ Object

Returns the value of attribute options.



117
118
119
 
# File 'lib/couchrest/mixins/callbacks.rb', line 117

def options
  @options
end

#per_key ⇒ Object

Returns the value of attribute per_key.



117
118
119
 
# File 'lib/couchrest/mixins/callbacks.rb', line 117

def per_key
  @per_key
end

Instance Method Details

#_compile_per_key_options ⇒ Object 



177
178
179
180
181
182
183
184
185
 
# File 'lib/couchrest/mixins/callbacks.rb', line 177

def _compile_per_key_options
  key_options  = _compile_options(@per_key)

  @klass.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
    def _one_time_conditions_valid_#{@callback_id}?
      true #{key_options[0]}
    end
  RUBY_EVAL
end

#_update_filter(filter_options, new_options) ⇒ Object 



162
163
164
165
 
# File 'lib/couchrest/mixins/callbacks.rb', line 162

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(klass) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/couchrest/mixins/callbacks.rb', line 132

def clone(klass)
  obj                  = super()
  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, options = {}) ⇒ Object

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/couchrest/mixins/callbacks.rb', line 248

def end(key = nil, options = {})
  object = (options || {})[:object]

  return if key && !object.send("_one_time_conditions_valid_#{@callback_id}?")

  if @kind == :around || @kind == :after
    # if condition    # after_save :filter_name, :if => :condition
    #   filter_name
    # end
    if @kind == :after
      [@compiled_options[0], @filter, @compiled_options[1]].compact.join("\n")
    else
      "end"
    end
  end
end

#matches?(_kind, _filter) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
160
 
# File 'lib/couchrest/mixins/callbacks.rb', line 157

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

#next_id ⇒ Object 



153
154
155
 
# File 'lib/couchrest/mixins/callbacks.rb', line 153

def next_id
  @@_callback_sequence += 1
end

#normalize_options!(options) ⇒ Object 



144
145
146
147
148
149
150
151
 
# File 'lib/couchrest/mixins/callbacks.rb', line 144

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 



167
168
169
170
171
172
173
174
175
 
# File 'lib/couchrest/mixins/callbacks.rb', line 167

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, options = {}) ⇒ Object

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



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/couchrest/mixins/callbacks.rb', line 189

def start(key = nil, options = {})
  object, terminator = (options || {}).values_at(:object, :terminator)

  return if key && !object.send("_one_time_conditions_valid_#{@callback_id}?")

  terminator ||= false

  # options[0] is the compiled form of supplied conditions
  # options[1] is the "end" for the conditional

  if @kind == :before || @kind == :around
    if @kind == :before
      # if condition    # before_save :filter_name, :if => :condition
      #   filter_name
      # end
      filter = <<-RUBY_EVAL
        unless halted
          result = #{@filter}
          halted = (#{terminator})
        end
      RUBY_EVAL
      
      [@compiled_options[0], filter, @compiled_options[1]].compact.join("\n")
    else
      # 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}"
      txt, line = <<-RUBY_EVAL, __LINE__ + 1
        def #{name}(halted)
          #{@compiled_options[0] || "if true"} && !halted
            #{@filter} do
              yield self
            end
          else
            yield self
          end
        end
      RUBY_EVAL
      @klass.class_eval(txt, __FILE__, line)
      "#{name}(halted) do"
    end
  end
end