[Rails]ActiveModel::Callbacksモジュールについて｜Playground発！アプリ開発会社の技術ブログ

今回は実務で使ったActiveModel::Callbacksモジュールのdefine_model_callbacksメソッドについてまとめていこうと思います。

結論から言うと、ActiveModel::Callbacksモジュールは、Active ModelでActive Recordと同じようなコールバック機能の実装を簡単にしてくれるモジュールのことです。

1 ActiveModelとは
2 ActiveModel::Callbacksとは
3 その他のコールバックについて
4 最後に

ActiveModelとは

モデルに関するモジュール群を提供しているライブラリで、ActiveRecordの実装にも利用されています。

通常、modelとテーブルは対になってるのですが、ActiveModelを利用することで、データベースと紐づかないモデルを作成することができます。

どういった時に利用するかと言いますと、モデルやコントローラが肥大化しないように機能ごとにモジュールとして分けて作成したときです。その時は、Railsのフレームワークから一度外れてしまうので、ActiveRecordと同じようにオブジェクトを扱うためにはこのモジュールをミックスインする必要があります。

ActiveModel::Callbacksとは

冒頭でも述べましたが、ActiveModel::Callbacksモジュールは、任意のクラスにコールバック機能の実装を簡単にしてくれるモジュールのことです。

このモジュールにより、必要なタイミングで実行されるコールバックを定義することができるようになります。

ActiveRecordのモデルであれば、自動的にコールバックを仕込むことができたのですが、ActiveModelの場合は、一旦Railsのレールから外れているため、ActiveRecordモデルと同じように扱いたいのであればモジュールであるActiveModel::Callbacksをextendして使う必要があります。

class Board
  extend ActiveModel::Callbacks

  define_model_callbacks :run

  def run
    run_callbacks :run do
      true # runメソッドの中身をここに記述する
    end
  end

end

define_model_callbacksメソッドは、ActiveModel::Callbacksをextendして、コールバックの対象となるメソッドの名前を指定してやることでそのメソッドを実行することができます。

define_model_callbacksメソッドは、3つの標準コールバック(before, around, after)の全てのコールバックを提供してくれるメソッドになります。

コールバックしたいタイミングを限定したい時はこのように書くことができます。

class Board
  extend ActiveModel::Callbacks

  define_model_callbacks :run, only: %i[after, before]

  def run
    run_callbacks :run do
      true # runメソッドの中身をここに記述する
    end
  end

end