• 開発

ActiveRecordの便利機能previous_changes

ActiveRecordには便利なprevious_changesというメソッドがあります。
割と知名度が低いので、ここで使い方をご紹介します。

(08/26追記)
はてブでご指摘(?)頂きましたが、正確にはActiveRecordではなくActiveModel::Dirtyの機能です。

まずはchanges

previous_changesの前に基本のchangesです。
これは、saveする前に変更されたattributeを調べる機能です。

まずはfindした直後です。changed?は当然falseになります。

User.create(name: "Taro")
user = User.find(1)

user.changed?
# => false

user.changed
[]

user.changes
# => {}

user.changed_attributes
# => {}

attributeを書き換えてみましょう。changesが取得できるようになりました。

user.name = "Jiro"

user.changed?
# => true

user.changed
# => ["name"]

user.changes
# => {"name" => ["Taro", "Jiro"]}

user.changed_attributes
# => {"name" => "Taro"}

user.name_changed?
# => true

user.created_at_changed?
# => false

saveすると、changed?はまたfalseに戻ります。

user.save

user.changed?
# => false

ここでprevious_changes

ここで、さっきのchangesが欲しい!ということはよくありますよね。
典型的な例としては、after_save以降のタイミングで変更履歴を残したいなどがあげられます。

こんなときに、previous_changesが使えます。

user.previous_changes
# => {"name" => ["Taro", "Jiro"], "updated_at" => [Wed, 07 Aug 2013 02:15:34 UTC +00:00, Wed, 07 Aug 2013 02:24:55 UTC +00:00]}

シンプルで便利ですね。

なお、これはDBの履歴を持っているスーパーでワンダホーな機能ではなく、単にインスタンス変数として保存しているだけです。findした直後のインスタンスで取得したり、繰り返し呼んで古いデータを復元することはできません。念のため。


CONTACT

TechRachoでは、パートナーシップをご検討いただける方からの
ご連絡をお待ちしております。ぜひお気軽にご意見・ご相談ください。