Rubyのinheritedフックメソッド徹底解説――クラスの継承を制御するテクニック

こんにちは、子どもたちと保護者の皆さん……あれ、Rubyistの皆さんでしたね。以前の記事ではクラスの祖先チェーン（継承チェーン）について掘り下げました。今回は「親としての振る舞い」と継承についてさらに深く踏み込みます。inheritedフックメソッドの仕組みと、継承を禁止する方法について見ていきましょう。

子どもが継承するときの基礎知識：inheritedフックメソッド

まずは、クラスが親として宣言される瞬間から見てみましょう。Rubyには、あるクラスが別のクラスの親として宣言されたタイミングで、親クラス側から処理を行うための便利な仕組みが用意されています。

class Parent
  def self.inherited(subclass)
    puts "#{subclass} inherits from Parent"
  end
end

class Child < Parent
end

このコードを実行すると「Child inherits from Parent」と出力されます。これは、ChildクラスがParentクラスを継承した時点でParent.inheritedメソッドが呼び出されるためです。注目すべきは、このメソッドがサブクラス（ここではChild）を引数として受け取るという点です。この仕組みにより、実際に継承された場合にのみ実行される一連の振る舞いを、親クラス側にあらかじめ定義しておくことができます。ここでいう「振る舞い」とは、継承する側・される側のクラスに対して、変数やメソッド、定数を定義・変更・削除することを指します。

それでは次に、parent_nameメソッドをその場で動的に定義してみましょう。

class Parent
  def self.inherited(subclass)
    subclass.define_method :parent_name do
      "Daddy"
    end
  end
end

class Child < Parent
end

Child.new.parent_name # => "Daddy"

ここでは、ChildクラスがParentクラスを継承したタイミングで、Childクラスにメソッドを定義しています。ポイントは、このメソッドをParentクラスに直接追加してはいないということです。メソッドは、他のクラスがParentを継承したときに初めて定義されます。

理論はここまでにして、次はRubyistの日常でもっと実践的な例を見てみましょう。

クラスの継承を禁止するには

Ruby on Railsでは、データベースマイグレーションはActiveRecord::Migrationクラスによって処理されます。試しに、このクラスから直接継承してみます。

class AddFirstnameToUsers < ActiveRecord::Migration
end
 
# => StandardError (Directly inheriting from ActiveRecord::Migration is not supported..)

このエラーが発生するのは、Ruby on Railsがこのクラスからの継承を防ぐ仕組みを内部に持っているためです。では、なぜRailsはこのような機構を実装しているのでしょうか？

マイグレーションは、特定のバージョンのRuby on Railsと強く結びついています。実際、このクラスが提供するAPIは、バージョン間で微妙に変更されることがあります。そのため、Railsのアップグレード時にマイグレーションが壊れてしまうのを避けるべく、フレームワーク側で「特定のバージョンのActiveRecord::Migrationクラスを選択させる」ようになっています。これにより、マイグレーションが安定して動作することが保証されるのです。

class AddFirstnameToUsers < ActiveRecord::Migration[4.2]
end

上記の例では、マイグレーションはRuby on Rails 4.2で提供されるActiveRecord::MigrationのAPIに紐づけられています。したがって、アプリケーションを5.0へアップグレードしても、マイグレーションは引き続き4.2版のActiveRecord::Migration APIで動作するため、問題なく実行され続けます。

継承の禁止はどう実装されているのか

ここまででなぜ継承を禁止しているのかが理解できました。続いて、ActiveRecord::Migrationがどのように継承を防いでいるのかを見ていきます。そのロジックはすべて、ActiveRecord::Migration.inheritedメソッドの中に定義されています。

module ActiveRecord
  class Migration
    def self.inherited(subclass) #:nodoc:
      super
      if subclass.superclass == Migration
        raise StandardError, "Directly inheriting from ActiveRecord::Migration is not supported. " \
          "Please specify the Rails release the migration was written for:\n" \
          "\n" \
          "  class #{subclass} < ActiveRecord::Migration[4.2]"
      end
    end
  end
end

ご覧のとおり、このフックメソッドは、サブクラス（AddFirstnameToUsers）がActiveRecord::Migrationを直接継承しているかどうかをチェックし、直接継承していた場合はエラーを発生させます。まさに継承を制御するための理想的なエントリーポイントと言えるでしょう。

まとめ

今回は、継承とその禁止に関する基本を学びました。inheritedフックメソッドは、継承する側・される側のクラスと動的にやり取りできる、非常に強力で便利な仕組みです。

実務で継承を扱う際には細心の注意が必要です。既存のメソッドやクラスを削除したりオーバーライドしたりするときは慎重に行いましょう。予期しない副作用を招く可能性があります。最悪の場合、子どもがあなたを「パパ」と呼んでくれなくなるかもしれませんよ。

以上、今日の記事はここまでです！