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

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

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

            set_callbacks name, CallbackChain.new(name, options)

            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 }
  

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

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

• :skip_after_callbacks_if_terminated — Определяет, будут ли после-обратные вызовы останавливаться опцией :terminator. По умолчанию после-обратные вызовы выполняются независимо от того, была ли прервана цепочка обратных вызовов или нет. Этот параметр не имеет эффекта, если опция :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 716
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

  set_callbacks(name, callbacks.dup.clear)
end

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

# File activesupport/lib/active_support/callbacks.rb, line 667
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

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

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

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

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

Параметры

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

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

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

# File activesupport/lib/active_support/callbacks.rb, line 691
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: -> { age > 18 }
end

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