【Rails】デザインパターン「Form Object」の基本情報と実装方法

はじめに

Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。

MVCフレームワークでありがちなアンチパターンの一つとして「ファットコントローラー」があります。これは読んで字のごとく、コントローラーにいろいろな処理を詰め込んでしまった結果、コントローラーが肥大化してしまっている状態です。

ファットコントローラーを解消する手段として、コントローラー内の処理をモデルなどに移動する方法があります。しかし、それもいつかは限界が来て今度は「ファットモデル」という別のアンチパターンに陥る可能性が出てきます。

MVCフレームワークでは"Skinny Controllers, Fat Models"、つまり「痩せたコントローラー、太ったモデル」が推奨されています。コントローラーを太らせるよりモデルを太らせるほうがよいということです。

しかし、だからといって何千行、何万行もあるモデルでは全体の見通しが悪く、可読性・保守性が低いと言わざるを得ません。

そこで、MVCフレームワークでシステム開発を行う際には「デザインパターン」の設計が重要になってきます。コントローラーやモデルではない別のロジック層を用意し、処理を適切に分散することで可読性・保守性が向上します。

デザインパターンには多くのロジック層が存在します。この記事では「Form Object」について説明します。

Form Objectについて

概要

Form Objectとは、フォームに関連する処理を独立したクラスに集約するデザインパターンのことです。これを活用することで、以下のようなメリットが得られます。

  • コントローラーからフォームの処理を分離できるので、コントローラーのコードが簡潔になる
  • フォームの処理をテストしやすくなるので、アプリケーションの品質が向上する
  • フォームの処理を再利用しやすくなるので、DRYの原則に沿ったコーディングが可能になる

実装例

ユーザー登録フォームを例にForm Objectを実装します。

app/forms/user_registration_form.rb

class UserRegistrationForm
  include ActiveModel::Model

  attr_accessor :name, :email, :password

  validates :name, presence: true
  validates :email, presence: true, format: { with: URI::MailTo::EMAIL_REGEXP }
  validates :password, presence: true, length: { minimum: 6 }

  def save
    user = User.new(name: name, email: email, password: password)
    user.save
  end
end

app/controllers/users_controller.rb

class UsersController < ApplicationController
  def new
    @form = UserRegistrationForm.new
  end

  def create
    @form = UserRegistrationForm.new(user_params)
    if @form.save
      # 成功時の処理
    else
      render :new
    end
  end

  private

  def user_params
    params.require(:user_registration_form).permit(:name, :email, :password)
  end
end

コントローラーでは、Form Objectのインスタンスを生成し、フォームの処理を委譲しています。これにより、コントローラーのコードが簡潔になり、フォームの処理を独立して管理できるようになります。

Form Objectを効果的に活用するためのポイントは以下の通りです。

  • ActiveModel::Modelモジュールを組み込んで、Railsのフォームヘルパーと連携する
  • フォームに関連するバリデーションやデータ保存処理を定義する
  • フォームオブジェクトの命名は、フォームの目的が明確に伝わるよう工夫する
  • フォームオブジェクトはコントローラーからインスタンス化し、フォームの処理を委譲する

まとめ

Form Objectは、複雑なフォームを扱う場合や、バリデーションやデータ保存処理が複雑な場合に特に効果的です。また、フォームの処理を再利用したい場合にも活用できます。

ただし、Form Objectを過剰に使うと、アプリケーションの構造が複雑になる可能性があるので注意が必要です。適切な粒度でForm Objectを設計することが重要です。

Railsアプリケーションのフォーム管理を効率化するために、Form Objectパターンを活用してみてはいかがでしょうか。コントローラーのコードが簡潔になり、フォームの処理が再利用しやすくなるので、メンテナンス性の高いアプリケーションを構築できるはずです。

関連記事

【Rails】RSpecを使った自動テスト《システムスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 17:07
【Rails】RSpecを使った自動テスト《リクエストスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 16:06
【Rails】RSpecを使った自動テスト《コントローラースペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 15:39
【Rails】RSpecを使った自動テスト《モデルスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 11:50
【Rails】RSpecを使った自動テスト《基本編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月10日 17:49
【Rails】デザインパターン「Concern」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月10日 13:32
【Rails】デザインパターン「Service Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 19:59
【Rails】Dockerを使用してRuby on Railsの開発環境を構築
# はじめに Ruby on Railsは強力なWebアプリケーションフレームワークですが、開発環境の構築には時間がかかることがあります。特に、チーム全体で一貫した環境を維持することは困難な場合があります。 Dockerを使用することで、R [...]
2024年7月5日 18:49