Ruby on Railsのgem「Active Interaction」でコードの見通しをよくする

2018.12.10

ポイント

はじめに

ギルドワークスでは、Ruby on Railsで記述したプロジェクトが多く存在します。

その中で定番のGemfile構成（ライブラリ構成）があります。毎回全く同じ構成というよりは、都度新しいものを吟味しながら取り込もうとしていますが、1年ほど前から利用しているactive interactionが面白かったので紹介します。

active interactionとは

active interactionは、GoFのcommandパターンをベースに、ビジネスロジックを実装するためのクラス構成を与えるgemです。

普段だと、contorller や model に書いていたり、あるいはそれぞれの ActiveSupport::Concern で書いているロジックになっているものだと思われます。それを、active interactionのBaseクラスを継承したクラスをつくることで、見通しがよくなります。（ギルドワークスでは新たな service層として置いていることが多いです。

どのように使うか

呼び出し側

呼び出し側＝controller側では、定義したクラスの「run()」メソッドを呼び出します。「run()」の引数には、ActionContollerのoaramsをほぼそのまま渡すか、対象となるモデルの情報を載せたりします。以下、Accountモデルの更新（Update）の例です。（サイトのものを改変しています。

def update
  # 引数inputs(hash) の整理
  inputs = { account: Account..findbyid(params[:id]) }.reverse_merge(params[:account]) 
  outcome = UpdateAccount.run(inputs) 

if outcome.valid?
    redirect_to(outcome.result)
  else
    @account = outcome
    render(:edit)
  end
end

呼ばれる側

呼ばれる側は、 ActiveInteraction::Base を継承したクラスを実装します。

呼び出し側は「run()」でしたが、実装するメソッドは「execute()」です。

class UpdateAccount < ActiveInteraction::Base
　object :account
　string :firstname, :lastname, default: nil

　validates :firstname, presence: true, if: :firstname?
　validates :lastname, presence: true, if: :lastname?

　def execute
　　account.firstname = firstname if firstname?
　　account.lastname = lastname if lastname?

　　unless account.save
   　　errors.merge!(account.errors)
　　end
　　account
　end
end

クラスの先頭に書いてあるobjectやstringは、inputsで渡ってくる引数の宣言です。ここに記載している引数は、デフォルトで存在チェックなどを実施します。Rubyはあまり型を意識することはない動的型付け言語ですが、静的型付け言語のような宣言的記述をするのが特徴です。

validates は、 ActiveRecord::Model と同じものが利用できます。これもひとつ実装の見通しがよくなっている理由かと思います。

executeが実際の処理内容です。
run()が呼ばれてexecute()が実行されるの時点で、既に「指定したattributesの存在チェック」と「記述したvalidatesの実施」が実行されます。ため、executeにはいわゆるガード節を最低限にでき、本来のロジックの記述に集中できます。