Rubyメタプログラミング入門：Rails・Sinatra・Paperclipの実例で学ぶ

Rubyのメタプログラミングについて、これまでに読んだことや耳にしたことがある方は多いでしょう。

しかし……

具体的なコード例がなければ、その仕組みは少し分かりにくいものです。

そこで本記事では、Rubyメタプログラミングを活用している有名なオープンソースプロジェクトを実際に見ていきます。

取り上げるのは次のプロジェクトです：

• Rails
• Sinatra
• Paperclip gem

これらはすべて、何らかの形でメタプログラミングを使っています。

それでは、実際のコードを読み解きながら、それぞれが何を行っているのかを詳しく見ていきましょう！

Railsの例

Railsはメタプログラミングを多用しているため、学習の出発点として最適です。

たとえば、Railsアプリで現在の環境（environment）を確認したいとき、次のように書きます。

Rails.env.production?

しかし、このenvとは何でしょうか？　そして、どうやって動いているのでしょうか？

答えはStringInquirerクラスにあります。これはStringのサブクラスで、method_missingを使うことで、env == "production"のような比較ではなく、env.production?という直感的な形式で呼び出せるようにしています。

実際のコードは次のようになっています：

def method_missing(method_name, *arguments)
  if method_name[-1] == '?'
    self == method_name[0..-2]
  else
    super
  end
end

このコードが意味するのは、「メソッド名がクエスチョンマーク（?）で終わっていれば文字列との比較を行い、そうでなければ祖先チェーンをさかのぼって通常の処理に委ねる」ということです。

元のコードは公式リポジトリで確認できます。

Sinatraのデリゲーション（委譲）

Sinatraを使ったことがある方なら、ルート（route）の定義方法が2つあることをご存じかもしれません。

• どのクラスにも属さず、get / postメソッドを直接使う方法
• Sinatra::Applicationを継承したクラスを定義する方法

SinatraのDSL（ドメイン固有言語）メソッドはSinatra::Applicationの中で定義されています。では、どうしてこのクラスの外でも同じメソッドが使えるのでしょうか？

実は、ここでは2つの仕組みが組み合わさっています：

• メタプログラミング
• モジュールによる拡張（extend）

Sinatraはbase.rbの中でSinatra::Delegatorモジュールを定義しており、これを使ってメソッド呼び出しをtargetへ委譲します。

デフォルトでは、このtargetはSinatra::Applicationに設定されています。

以下は、Sinatra::Delegator内で定義されているdelegateクラスメソッドを簡略化したものです：

def self.delegate(*methods)
  methods.each do |method_name|
   define_method(method_name) do |*args, &block|
     Delegator.target.send(method_name, *args, &block)
   end
  end
end

delegate :get, :patch, :put, :post, :delete

このコードは、define_methodを使って一連のメソッドを動的に生成し、それらの呼び出しをSinatra::Application（Delegator.targetのデフォルト値）へ転送しています。

さらに、mainオブジェクトがSinatra::Delegatorで定義されたメソッドによって拡張されることで、Sinatra::Applicationクラスの外でもSinatraのDSLが利用できるようになるのです。

なお、Rubyにはメソッド委譲のための標準ライブラリとしてDelegatorとForwardableの2つが用意されていることも、覚えておくと便利です。

Paperclip gem

Paperclipは、アプリケーションでファイルアップロードを扱えるようにするgemです。アップロードされたファイルはActiveRecordモデルと関連付けられます。

モデルに添付ファイルを定義するには、has_attached_fileメソッドを使います。

次のように書きます：

class User
  has_attached_file :avatar, :styles => { :normal => "100x100#" }
end

このメソッドはpaperclip.rb内で定義されており、メタプログラミングを使ってモデル上に新しいメソッドを動的に定義します。

このメソッドを通じて、ファイル添付オブジェクト（Paperclip::Attachmentクラスのインスタンス）にアクセスできます。

たとえば、添付ファイル名が:avatarであれば、Paperclipはモデルにavatarメソッドを自動的に定義します。

これを担当しているのが、次のdefine_instance_getterメソッドです：

# @name  => 添付ファイルの名前
# @klass => このメソッドが定義されるActiveRecordモデル

def define_instance_getter
  name    = @name
  options = @options

  @klass.send :define_method, @name do |*args|
    ivar = "@attachment_#{name}"
    attachment = instance_variable_get(ivar)

    if attachment.nil?
      attachment = Attachment.new(name, self, options)
      instance_variable_set(ivar, attachment)
    end
  end
end

このコードから読み取れるのは、添付ファイルオブジェクトが@attachment_#{name}というインスタンス変数に格納されているという点です。

先ほどの例であれば、@attachment_avatarが該当します。

その後、この添付ファイルがすでに存在するかどうかをチェックし、存在しなければ新しいAttachmentオブジェクトを生成してインスタンス変数にセットします。これにより、同じオブジェクトが再利用され、無駄な生成を防げます。

元のソースコードはGitHubで確認できます。

まとめ

ご覧いただいたように、メタプログラミングは非常に強力で柔軟なテクニックです。method_missingやdefine_methodを活用することで、DSLの構築やコードの重複削減など、さまざまな場面で活躍します。

しかし、使おうと思ったときには「大きな力には、大きな責任が伴う」という有名な言葉を思い出してください。乱用すると可読性やデバッグのしやすさが損なわれるため、適切なバランスが重要です。

この記事が役に立ったなら、ぜひニュースレターの購読もお忘れなく 🙂