Rails5で出力される「alias_method_chain is deprecated.」について

はじめに

直近のプロジェクトではRails5を使っているのですが、利用しているgem関連で下記のような警告が大量に出力されるので、少し調べてみました。
（「./bin/rails c」や「./bin/bundle exec rspec」を実行すると大量に出力されます。）

これは、Rails5からはActiveSupportのalias_method_chainが非推奨（deprecated）になり、代わりにModule#prependを使うように促しています。

alias_method_chainとは

まず、deprecatedになったalias_method_chainですが、下記のように利用します。

上記のコードは、alias_methodを使った場合は、下記と同等になります。

• helloメソッドがhello_with_worldメソッドに置き換わる。
• 元々のhelloメソッドはhello_without_worldメソッドとして使えるようになる。

実行結果を下記に記載しますが、置き換わっているのがわかると思います。

Module#prependとは

逆に推奨されているModule#prependの使い方ですが、下記のように使います。

• prependされた HelloWithWorldモジュール は、継承関係上 HelloUser クラスより手前に位置することになる。
• そのため、helloメソッドをオーバーライドしたような形になる。
• HelloWithWorldモジュール のメソッド内でsuperを呼び出すことで、元々のメソッドを呼び出すことができる。

実行結果とancestorsメソッドで継承関係を表示しておきます。
ちなみにancestorsメソッドは、クラスやモジュールのスーパークラスとincludeしているモジュールを、優先順で配列に格納して返してくれます。

Rubyリファレンス-Module#ancestors-

HelloWithWorld が HelloUser の前にあるのがわかると思います。

モンキーパッチなどを書くときに利用することになると思います。
（モンキーパッチなんて書かずに、githubにプルリクする方がよいですが。。。）

とりあえず、DEPRECATION WARNINGの出力をなくしたい

Rails5にしたものの、全てのgemに対して、この警告を消すための書き換えの対応をしていくのは大変。

この出力が目障りという方は、 config/application.rb に追記すれば、消すことができます。
（ただし、自己責任でお願いします。）

 

さいごに

deprecatedなメソッドは、今後のアップデートで利用できなくなることもありますので、しっかりと理解した上で利用し、可能であれば、置き換えていくようにしましょう。