модуль ActiveSupport::Callbacks

Обработчики событий Active Support

Обработчики — это крючки кода, которые выполняются в ключевые моменты жизненного цикла объекта. Типичный случай использования — определение набора обработчиков базовым классом, относящихся к предоставляемой функциональности, чтобы подклассы могли устанавливать обработчики, улучшающие или изменяющие базовую функциональность, без необходимости переопределять методы базового класса.

Использование этого модуля позволяет определять события в жизненном цикле объекта, которые будут поддерживать обработчики (через ClassMethods#define_callbacks), устанавливать методы экземпляра, проги или объекты обработчиков, которые будут вызываться (через ClassMethods#set_callback), и запускать установленные обработчики в соответствующее время (через run_callbacks).

По умолчанию обработчики прерываются с помощью :abort. Подробности см. в ClassMethods#define_callbacks.

Поддерживаются три типа обработчиков: обработчики «до» (before), выполняющиеся до определенного события; обработчики «после» (after), выполняющиеся после события; и обработчики «вокруг» (around), блоки, окружающие событие, вызывая его при yield. Код обработчиков может быть помещён в методы экземпляра, проги или лямбды, или объекты обработчиков, которые отвечают на определённые предварительно заданные методы. Подробности см. в ClassMethods#set_callback.

class Record
  include ActiveSupport::Callbacks
  define_callbacks :save

  def save
    run_callbacks :save do
      puts "- save"
    end
  end
end

class PersonRecord < Record
  set_callback :save, :before, :saving_message
  def saving_message
    puts "saving..."
  end

  set_callback :save, :after do |object|
    puts "saved"
  end
end

person = PersonRecord.new
person.save

Вывод:

saving...
- save
saved

Константы

CALLBACK_FILTER_TYPES

Открытые методы экземпляра

run_callbacks(kind, type = nil) { || ... } Показать исходный код

# File activesupport/lib/active_support/callbacks.rb, line 96
def run_callbacks(kind, type = nil)
  callbacks = __callbacks[kind.to_sym]

  if callbacks.empty?
    yield if block_given?
  else
    env = Filters::Environment.new(self, false, nil)

    next_sequence = callbacks.compile(type)

    # Common case: no 'around' callbacks defined
    if next_sequence.final?
      next_sequence.invoke_before(env)
      env.value = !env.halted && (!block_given? || yield)
      next_sequence.invoke_after(env)
      env.value
    else
      invoke_sequence = Proc.new do
        skipped = nil

        while true
          current = next_sequence
          current.invoke_before(env)
          if current.final?
            env.value = !env.halted && (!block_given? || yield)
          elsif current.skip?(env)
            (skipped ||= []) << current
            next_sequence = next_sequence.nested
            next
          else
            next_sequence = next_sequence.nested
            begin
              target, block, method, *arguments = current.expand_call_template(env, invoke_sequence)
              target.send(method, *arguments, &block)
            ensure
              next_sequence = current
            end
          end
          current.invoke_after(env)
          skipped.pop.invoke_after(env) while skipped&.first
          break env.value
        end
      end

      invoke_sequence.call
    end
  end
end

Выполняет обработчики для заданного события.

Вызывает обработчики «до» и «вокруг» в порядке их установки, передаёт блок (если он задан), а затем выполняет обработчики «после» в обратном порядке.

Если цепочка обработчиков была прервана, возвращает false. В противном случае возвращает результат блока, nil если обработчики не были установлены, или true если обработчики были установлены, но блок не задан.

run_callbacks :save do
  save
end