Class: ActiveModel::Observer

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
Singleton
Defined in:
activemodel/lib/active_model/observing.rb

Overview

Active Model Observers

Observer classes respond to life cycle callbacks to implement trigger-like behavior outside the original class. This is a great way to reduce the clutter that normally comes when the model class is burdened with functionality that doesn't pertain to the core responsibility of the class. Example:

class CommentObserver < ActiveModel::Observer
  def after_save(comment)
    Notifications.comment("admin@do.com", "New comment was posted", comment).deliver
  end
end

This Observer sends an email when a Comment#save is finished.

class ContactObserver < ActiveModel::Observer
  def after_create(contact)
    contact.logger.info('New contact added!')
  end

  def after_destroy(contact)
    contact.logger.warn("Contact with an id of #{contact.id} was destroyed!")
  end
end

This Observer uses logger to log when specific callbacks are triggered.

Observing a class that can't be inferred

Observers will by default be mapped to the class with which they share a name. So CommentObserver will be tied to observing Comment, ProductManagerObserver to ProductManager, and so on. If you want to name your observer differently than the class you're interested in observing, you can use the Observer.observe class method which takes either the concrete class (Product) or a symbol for that class (:product):

class AuditObserver < ActiveModel::Observer
  observe :account

  def after_update()
    AuditTrail.new(, "UPDATED")
  end
end

If the audit observer needs to watch more than one kind of object, this can be specified with multiple arguments:

class AuditObserver < ActiveModel::Observer
  observe :account, :balance

  def after_update(record)
    AuditTrail.new(record, "UPDATED")
  end
end

The AuditObserver will now act on both updates to Account and Balance by treating them both as records.

If you're using an Observer in a Rails application with Active Record, be sure to read about the necessary configuration in the documentation for ActiveRecord::Observer.

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from ActiveSupport::DescendantsTracker

clear, descendants, descendants, direct_descendants, direct_descendants, inherited

Constructor Details

- (Observer) initialize

Start observing the declared classes and their subclasses.



219
220
221
# File 'activemodel/lib/active_model/observing.rb', line 219

def initialize
  observed_classes.each { |klass| add_observer!(klass) }
end

Class Method Details

+ (Object) observe(*models)

Attaches the observer to the supplied model classes.



187
188
189
190
191
192
# File 'activemodel/lib/active_model/observing.rb', line 187

def observe(*models)
  models.flatten!
  models.collect! { |model| model.respond_to?(:to_sym) ? model.to_s.camelize.constantize : model }
  remove_possible_method(:observed_classes)
  define_method(:observed_classes) { models }
end

+ (Object) observed_class

The class observed by default is inferred from the observer's class name:

assert_equal Person, PersonObserver.observed_class


209
210
211
212
213
214
215
# File 'activemodel/lib/active_model/observing.rb', line 209

def observed_class
  if observed_class_name = name[/(.*)Observer/, 1]
    observed_class_name.constantize
  else
    nil
  end
end

+ (Object) observed_classes

Returns an array of Classes to observe.

You can override this instead of using the observe helper.

class AuditObserver < ActiveModel::Observer
  def self.observed_classes
    [Account, Balance]
  end
end


203
204
205
# File 'activemodel/lib/active_model/observing.rb', line 203

def observed_classes
  Array.wrap(observed_class)
end

Instance Method Details

- (Object) observed_class_inherited(subclass)

Special method sent by the observed class when it is inherited. Passes the new subclass.



237
238
239
240
# File 'activemodel/lib/active_model/observing.rb', line 237

def observed_class_inherited(subclass) #:nodoc:
  self.class.observe(observed_classes + [subclass])
  add_observer!(subclass)
end

- (Object) observed_classes

:nodoc:



223
224
225
# File 'activemodel/lib/active_model/observing.rb', line 223

def observed_classes #:nodoc:
  self.class.observed_classes
end

- (Object) update(observed_method, object, &block)

Send observed_method(object) if the method exists and the observer is enabled for the given object's class.



229
230
231
232
233
# File 'activemodel/lib/active_model/observing.rb', line 229

def update(observed_method, object, &block) #:nodoc:
  return unless respond_to?(observed_method)
  return if disabled_for?(object)
  send(observed_method, object, &block)
end