модуль ActiveSupport::Callbacks::ClassMethods

# File activesupport/lib/active_support/callbacks.rb, line 940
        def define_callbacks(*names)
          options = names.extract_options!

          names.each do |name|
            name = name.to_sym

            ([self] + self.descendants).each do |target|
              target.set_callbacks name, CallbackChain.new(name, options)
            end

            module_eval <<-RUBY, __FILE__, __LINE__ + 1
              def _run_#{name}_callbacks(&block)
                run_callbacks #{name.inspect}, &block
              end

              def self._#{name}_callbacks
                get_callbacks(#{name.inspect})
              end

              def self._#{name}_callbacks=(value)
                set_callbacks(#{name.inspect}, value)
              end

              def _#{name}_callbacks
                __callbacks[#{name.inspect}]
              end
            RUBY
          end
        end

Определяет наборы событий в жизненном цикле объекта, поддерживающие обратные вызовы.

define_callbacks :validate
define_callbacks :initialize, :save, :destroy

Параметры

• :terminator - Определяет, когда фильтр перед (before) остановит цепочку обратных вызовов, предотвращая вызов последующих фильтров перед (before) и вокруг (around) и срабатывание события. Это должна быть лямбда-функция для выполнения. Текущий объект и результат лямбды обратного вызова будут переданы лямбда-функции-терминатору.

  define_callbacks :validate, terminator: ->(target, result_lambda) { result_lambda.call == false }
  

  В этом примере, если любой обратный вызов перед валидацией возвращает false, последующие обратные вызовы перед (before) и вокруг (around) не будут выполнены.

  По умолчанию терминатор прерывает цепочку, когда обратный вызов вызывает :abort.

• :skip_after_callbacks_if_terminated - Определяет, должны ли обратные вызовы после (after) прерываться параметром :terminator. По умолчанию обратные вызовы после (after) выполняются независимо от того, была ли прервана цепочка обратных вызовов или нет. Этот параметр не имеет эффекта, если параметр :terminator установлен в nil.

• :scope - Указывает, какие методы должны выполняться, когда объект используется как обратный вызов.

  class Audit
    def before(caller)
      puts 'Audit: before is called'
    end
  
    def before_save(caller)
      puts 'Audit: before_save is called'
    end
  end
  
  class Account
    include ActiveSupport::Callbacks
  
    define_callbacks :save
    set_callback :save, :before, Audit.new
  
    def save
      run_callbacks :save do
        puts 'save in main'
      end
    end
  end
  

  В приведенном выше случае, всякий раз, когда вы сохраняете аккаунт, вызывается метод Audit#before. С другой стороны

  define_callbacks :save, scope: [:kind, :name]
  

  вызовет Audit#before_save вместо этого. Это происходит при вызове #{kind}_#{name} для данного экземпляра. В этом случае «kind» — «before», а «name» — «save». В этом контексте :kind и :name имеют специальное значение: :kind относится к типу обратного вызова (before/after/around), а :name относится к методу, для которого определяются обратные вызовы.

  Объявление, подобное

  define_callbacks :save, scope: [:name]
  

  вызовет Audit#save.

Примечания

names переданное в define_callbacks не должно заканчиваться на !, ? или =.

Вызов define_callbacks несколько раз с одинаковым names перезапишет предыдущие зарегистрированные обратные вызовы с помощью set_callback.

# File activesupport/lib/active_support/callbacks.rb, line 850
def reset_callbacks(name)
  callbacks = get_callbacks name

  self.descendants.each do |target|
    chain = target.get_callbacks(name).dup
    callbacks.each { |c| chain.delete(c) }
    target.set_callbacks name, chain
  end

  set_callbacks(name, callbacks.dup.clear)
end

Удаляет все установленные обратные вызовы для данного события.

# File activesupport/lib/active_support/callbacks.rb, line 776
def set_callback(name, *filter_list, &block)
  type, filters, options = normalize_callback_params(filter_list, block)

  self_chain = get_callbacks name
  mapped = filters.map do |filter|
    Callback.build(self_chain, filter, type, options)
  end

  __update_callbacks(name) do |target, chain|
    options[:prepend] ? chain.prepend(*mapped) : chain.append(*mapped)
    target.set_callbacks name, chain
  end
end

Устанавливает обратный вызов для данного события.

set_callback :save, :before, :before_method
set_callback :save, :after,  :after_method, if: :condition
set_callback :save, :around, ->(r, block) { stuff; result = block.call; stuff }

Второй аргумент указывает, должен ли обратный вызов выполняться :before, :after, или :around событие. Если опущен, предполагается :before . Это означает, что первый пример выше также может быть записан как:

set_callback :save, :before_method

Обратный вызов может быть указан как символ, обозначающий метод экземпляра; как процедура, лямбда или блок; или как объект, отвечающий на определенный метод, определяемый аргументом :scope в define_callbacks.

Если задана процедура, лямбда или блок, их тело оценивается в контексте текущего объекта. Оно также может необязательно принимать текущий объект в качестве аргумента.

Обратные вызовы перед (before) и вокруг (around) вызываются в порядке их установки; обратные вызовы после (after) вызываются в обратном порядке.

Обратные вызовы вокруг (around) могут получить доступ к возвращаемому значению от события, если оно не было остановлено, из вызова yield.

Параметры

• :if - Символ или массив символов, каждый из которых назначает метод экземпляра или процедуру; обратный вызов будет вызван только тогда, когда все они вернут значение true.

  Если задана процедура, ее тело оценивается в контексте текущего объекта. Оно также может необязательно принимать текущий объект в качестве аргумента.

• :unless - Символ или массив символов, каждый из которых назначает метод экземпляра или процедуру; обратный вызов будет вызван только тогда, когда все они вернут значение false.

  Если задана процедура, ее тело оценивается в контексте текущего объекта. Оно также может необязательно принимать текущий объект в качестве аргумента.

• :prepend - Если true, обратный вызов будет добавлен в начало существующей цепочки, а не в конец.

# File activesupport/lib/active_support/callbacks.rb, line 825
def skip_callback(name, *filter_list, &block)
  type, filters, options = normalize_callback_params(filter_list, block)

  options[:raise] = true unless options.key?(:raise)

  __update_callbacks(name) do |target, chain|
    filters.each do |filter|
      callback = chain.find { |c| c.matches?(type, filter) }

      if !callback && options[:raise]
        raise ArgumentError, "#{type.to_s.capitalize} #{name} callback #{filter.inspect} has not been defined"
      end

      if callback && (options.key?(:if) || options.key?(:unless))
        new_callback = callback.merge_conditional_options(chain, if_option: options[:if], unless_option: options[:unless])
        chain.insert(chain.index(callback), new_callback)
      end

      chain.delete(callback)
    end
    target.set_callbacks name, chain
  end
end

Пропустить ранее установленный обратный вызов. Как и в set_callback, могут быть переданы параметры :if или :unless для управления временем пропуска обратного вызова.

Примечание: этот пример использует PersonRecord и #saving_message, которые вы можете увидеть определёнными здесь

class Writer < PersonRecord
  attr_accessor :age
  skip_callback :save, :before, :saving_message, if: -> { age > 18 }
end

Если параметр if возвращает true, обратный вызов пропускается.

writer = Writer.new
writer.age = 20
writer.save

Вывод:

- save
saved

Если параметр if возвращает false, обратный вызов НЕ пропускается.

young_writer = Writer.new
young_writer.age = 17
young_writer.save

Вывод:

saving...
- save
saved

Будет возбуждено исключение ArgumentError, если обратный вызов ещё не был установлен (если не установлен параметр :raise в false).