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

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

        names.each do |name|
          class_attribute "_#{name}_callbacks", instance_writer: false
          set_callbacks name, CallbackChain.new(name, options)

          module_eval "            def _run_#{name}_callbacks(&block)
              __run_callbacks__(_#{name}_callbacks, &block)
            end
", __FILE__, __LINE__ + 1
        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 }
  

  В этом примере, если любой из обратных вызовов before validate возвращает false, то последующие обратные вызовы before и around не будут выполнены.

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

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

• :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} для данного экземпляра. В этом случае «тип» — «before», а «имя» — «save». В этом контексте :kind и :name имеют особое значение: :kind относится к типу обратного вызова (before/after/around), а :name — к методу, для которого определяются обратные вызовы.

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

  define_callbacks :save, scope: [:name]
  

  вызовет Audit#save.

ПРИМЕЧАНИЕ: method_name , передаваемые в `define_model_callbacks`, не должны заканчиваться символами `!`, `?` или `=`.

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

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

  self.set_callbacks name, callbacks.dup.clear
end

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

# File activesupport/lib/active_support/callbacks.rb, line 609
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 вызываются в обратном порядке.

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

Параметры

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

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

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

# File activesupport/lib/active_support/callbacks.rb, line 632
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 для управления тем, когда обратный вызов пропускается.

class Writer < Person
   skip_callback :validate, :before, :check_membership, if: -> { self.age > 18 }
end

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