Form object pattern in Ruby on Rails

Introduction

The form object pattern helps keep your code clean by separating form handling from your database models. It makes complex forms easier to manage and test.

When a form needs to update multiple models at once.

When you want to keep your database models simple and focused.

When you have complex validation logic that doesn't fit well in a single model.

When you want to reuse form logic across different parts of your app.

When you want to test form behavior without touching the database.

Syntax

Ruby on Rails

class MyForm
  include ActiveModel::Model

  attr_accessor :field1, :field2

  validates :field1, presence: true

  def save
    return false unless valid?
    # custom save logic here
  end
end

Use include ActiveModel::Model to get model-like behavior without a database table.

Define attr_accessor for form fields you want to handle.

Examples

A form object for user signup that validates email and password confirmation, then creates a User.

Ruby on Rails

class SignupForm
  include ActiveModel::Model

  attr_accessor :email, :password, :password_confirmation

  validates :email, presence: true
  validates :password, confirmation: true

  def save
    return false unless valid?
    User.create(email: email, password: password)
  end
end

This form object handles order creation with validations for product and quantity.

Ruby on Rails

class OrderForm
  include ActiveModel::Model

  attr_accessor :product_id, :quantity, :user_id

  validates :product_id, :quantity, presence: true

  def save
    return false unless valid?
    Order.create(product_id: product_id, quantity: quantity, user_id: user_id)
  end
end

Sample Program

This ContactForm object collects user input, validates presence of all fields, and simulates saving by returning true. It prints success or error messages.

Ruby on Rails

class ContactForm
  include ActiveModel::Model

  attr_accessor :name, :email, :message

  validates :name, :email, :message, presence: true

  def save
    return false unless valid?
    # Imagine sending an email here
    true
  end
end

# Usage example
form = ContactForm.new(name: "Alice", email: "[e-mail]", message: "Hello!")
if form.save
  puts "Form saved successfully"
else
  puts "Form has errors: #{form.errors.full_messages.join(", ")}"
end

Important Notes

Form objects do not connect directly to the database like ActiveRecord models.

They are great for complex forms that touch multiple models or need custom validation.

Remember to test form objects separately from your database models.

Summary

Form objects keep form logic separate from database models.

They use ActiveModel::Model to behave like models without a table.

They help manage complex forms and validations cleanly.

Practice

1. What is the main purpose of using a Form Object in Rails?

easy

A. To speed up database queries

B. To replace ActiveRecord models completely

C. To separate form validation and logic from database models

D. To generate HTML forms automatically

Solution

1. Step 1: Understand the role of form objects

   Form objects are used to keep form-related logic and validations separate from the database models.

2. Step 2: Compare with other options

   They do not replace ActiveRecord models or speed up queries, nor do they generate HTML forms automatically.

3. Final Answer:

   To separate form validation and logic from database models -> Option C

4. Quick Check:

   Form object purpose = Separation of form logic [OK]

Hint: Form objects separate form logic from models [OK]

Common Mistakes:

• Thinking form objects replace database models
• Assuming form objects speed up queries
• Confusing form objects with view helpers

2. Which module is commonly included in a Rails form object to provide model-like behavior?

easy

A. ActiveModel::Model

B. ActiveRecord::Base

C. ActionController::Base

D. ActiveSupport::Concern

Solution

1. Step 1: Identify the module for model-like behavior without DB

   The ActiveModel::Model module allows plain Ruby objects to behave like ActiveRecord models, including validations.

2. Step 2: Eliminate other options

   ActiveRecord::Base is for database models, ActionController::Base is for controllers, and ActiveSupport::Concern is for mixins.

3. Final Answer:

   ActiveModel::Model -> Option A

4. Quick Check:

   Form object module = ActiveModel::Model [OK]

Hint: Form objects include ActiveModel::Model for validations [OK]

Common Mistakes:

• Using ActiveRecord::Base in form objects
• Confusing controller modules with model modules
• Forgetting to include any module

3. Given this form object code, what will user_form.valid? return if email is blank?

class UserForm
  include ActiveModel::Model
  attr_accessor :email
  validates :email, presence: true
end

user_form = UserForm.new(email: '')
user_form.valid?

medium

A. true

B. false

C. nil

D. Raises an error

Solution

1. Step 1: Check validation rules

   The form object requires email to be present (not blank).

2. Step 2: Evaluate given input

   The email is an empty string, which fails the presence validation, so valid? returns false.

3. Final Answer:

   false -> Option B

4. Quick Check:

   Blank email fails presence validation = false [OK]

Hint: Presence validation fails on blank string [OK]

Common Mistakes:

• Assuming blank string passes presence validation
• Expecting valid? to raise error on blank
• Confusing nil and empty string behavior

4. Identify the error in this form object code:

class OrderForm
  include ActiveModel::Model
  attr_accessor :quantity
  validates :quantity, numericality: { greater_than: 0 }

  def save
    if valid?
      Order.create(quantity: quantity)
    end
  end
end

medium

A. Missing return value in save method

B. Order model is not defined

C. quantity is a string, needs conversion before validation

D. No error, code is correct

Solution

1. Step 1: Verify syntax and structure

   The code properly includes ActiveModel::Model, defines attr_accessor, and sets up numericality validation. Syntax is valid.

2. Step 2: Confirm behavior

   Numericality validation internally handles string-to-number conversion (e.g., '5' validates as > 0). The save method returns the Order instance (truthy) on success or nil/falsey otherwise, which works in conditionals.

3. Final Answer:

   No error, code is correct -> Option D

4. Quick Check:

   Numericality handles strings; save pattern acceptable [OK]

Hint: Rails numericality validator handles numeric strings automatically [OK]

Common Mistakes:

• Thinking strings need manual conversion for numericality
• Overthinking save method's return value
• Assuming undefined models cause errors in examples

5. You want to create a form object that handles user registration with email, password, and password_confirmation. Which approach correctly ensures password confirmation validation and saves the user if valid?

class RegistrationForm
  include ActiveModel::Model
  attr_accessor :email, :password, :password_confirmation

  validates :email, presence: true
  validates :password, presence: true, confirmation: true

  def save
    if valid?
      User.create(email: email, password: password)
    end
  end
end

hard

A. This code correctly validates and saves the user with password confirmation

B. Missing manual check for password_confirmation equality

C. Should use validates_confirmation_of :password_confirmation instead

D. Must call super in save method to save user

Solution

1. Step 1: Check validations for password confirmation

   The confirmation: true option on password automatically validates that password_confirmation matches.

2. Step 2: Verify save method logic

   The save method calls valid? and creates the user if valid, which is the correct pattern.

3. Final Answer:

   This code correctly validates and saves the user with password confirmation -> Option A

4. Quick Check:

   Password confirmation validation works with confirmation: true [OK]

Hint: Use confirmation: true for password confirmation validation [OK]

Common Mistakes:

• Manually checking password_confirmation equality
• Using deprecated validates_confirmation_of syntax
• Forgetting to call valid? before save