YOSHINO日記

プログラミングに関すること

Rails:モデルに動的にメソッドを追加する

ActiveStorageのhas_fileの実装を見てみる。

Add attachments · rails/activestorage@aaf8415 · GitHub

ActiveStorageのhas_fileを例に考えてみます。

class User < ActiveRecord::Base
  has_file :avatar
end

上記のようにUserモデルにhas_file :avatarを記述します。

has_fileは以下のように定義されています。

require "yactivestorage/attachment"
require "action_dispatch/http/upload"

module Yactivestorage::Attachments
  def has_file(name)
    define_method(name) do
      (@yactivestorage_attachments ||= {}) [name] ||=
        Yactivestorage::Attachment.find_by(record_gid: to_gid.to_s, name: name)&.tap { |a| a.record = self }
    end

    define_method(:"#{name}=") do |attachable|
      case attachable
      when Yactivestorage::Blob
        blob = attachable
      when ActionDispatch::Http::UploadedFile
        blob = Yactivestorage::Blob.create_after_upload! \
          io: attachable.open,
          filename: attachable.original_filename,
          content_type: attachable.content_type
      when Hash
        blob = Yactivestorage::Blob.create_after_upload!(attachable)
      when NilClass
        blob = nil
      end

      (@yactivestorage_attachments ||= {})[name] = blob ?
        Yactivestorage::Attachment.create!(record_gid: to_gid.to_s, name: name, blob: blob)&.tap { |a| a.record = self } : nil
      end
    end
  end

今回の場合、”avatar”というメソッドと、"avatar="という2つのメソッドが動的に追加されます。

User.instance_methods.grep(/avatar/)                                                                                                                            
# => [:avatar=, :avatar]                         

動的に追加されたメソッドを使ってみる。

以下の例では、avatar=メソッドを使っています。

引数にはBlobのインスタンスです。

test "create attachment from existing blob" do
    @user.avatar = create_blob filename: "funky.jpg"
    assert_equal "funky.jpg", @user.avatar.filename.to_s
end

コードより明らかですが、”avatar=”は2つのことを行っています。

  1. Blobのレコードの作成
  2. Attachmentレコードの作成

そして、avatar=によって登録されたデータへ@user.avatarでアクセスすることができるようになります。