Form helpers (form_with) in Ruby on Rails

Introduction

Form helpers like form_with make it easy to create forms in Rails. They handle HTML form tags and connect forms to your data.

When you want to create a form to add or edit a database record.

When you need a form that submits data to your Rails controller.

When you want Rails to automatically handle form field names and values.

When you want to easily add validations and error messages to forms.

When you want to create forms that work with AJAX for a smoother user experience.

Syntax

Ruby on Rails

form_with(model: @record, local: true) do |form|
  # form fields here
end

The model: option links the form to a specific data object.

Use local: true to submit the form with a normal HTTP request instead of AJAX.

Examples

A simple form for a User model with a name field and a submit button.

Ruby on Rails

form_with(model: @user, local: true) do |form|
  form.text_field :name
  form.submit "Save"
end

A form that sends a GET request to a search URL, not tied to a model.

Ruby on Rails

form_with(url: '/search', method: :get, local: true) do |form|
  form.text_field :query
  form.submit "Search"
end

A form for editing an article's content. Defaults to AJAX submission.

Ruby on Rails

form_with(model: @article) do |form|
  form.text_area :content
  form.submit
end

Sample Program

This example shows a Rails controller and view using form_with to create a new article. The form fields match the article's attributes. When submitted, it saves the article or shows errors.

Ruby on Rails

class ArticlesController < ApplicationController
  def new
    @article = Article.new
  end

  def create
    @article = Article.new(article_params)
    if @article.save
      redirect_to @article
    else
      render :new
    end
  end

  private

  def article_params
    params.require(:article).permit(:title, :body)
  end
end

# In app/views/articles/new.html.erb
<%= form_with(model: @article, local: true) do |form| %>
  <div>
    <%= form.label :title %><br>
    <%= form.text_field :title %>
  </div>
  <div>
    <%= form.label :body %><br>
    <%= form.text_area :body %>
  </div>
  <div>
    <%= form.submit "Create Article" %>
  </div>
<% end %>

Important Notes

Always use form_with with a model to get automatic field naming and error handling.

Use local: true if you want a normal form submission instead of AJAX.

Labels improve accessibility by linking text to form fields.

Summary

form_with helps build forms easily in Rails.

It connects forms to models for automatic data handling.

Use local: true to disable AJAX if needed.

Practice

1. What is the main purpose of form_with in Rails?

easy

A. To create database tables automatically

B. To style buttons with CSS

C. To run JavaScript code on form submission

D. To create HTML forms that connect to models easily

Solution

1. Step 1: Understand what form_with does

   form_with is a helper in Rails that builds forms linked to models for easy data handling.

2. Step 2: Compare options

   Only To create HTML forms that connect to models easily describes creating forms connected to models. Others describe unrelated tasks.

3. Final Answer:

   To create HTML forms that connect to models easily -> Option D

4. Quick Check:

   form_with builds model forms = A [OK]

Hint: Remember: form_with builds forms linked to models [OK]

Common Mistakes:

• Thinking form_with styles buttons
• Confusing form_with with JavaScript functions
• Assuming form_with creates database tables

2. Which is the correct syntax to create a form for a @post model using form_with with local submission?

easy

A. form_with @post, remote: true do |form|

B. form_with model: @post, local: true do |form|

C. form_for @post, local: true do |form|

D. form_with model: @post, ajax: false do |form|

Solution

1. Step 1: Identify correct form_with syntax

   The correct syntax uses model: @post and local: true to disable AJAX.

2. Step 2: Check options for correctness

   form_with model: @post, local: true do |form| matches correct syntax. form_with @post, remote: true do |form| uses remote: true (AJAX enabled). form_for @post, local: true do |form| uses deprecated form_for. form_with model: @post, ajax: false do |form| uses invalid ajax option.

3. Final Answer:

   form_with model: @post, local: true do |form| -> Option B

4. Quick Check:

   Use model: and local: true for local form [OK]

Hint: Use model: and local: true for local forms [OK]

Common Mistakes:

• Using remote: true instead of local: true
• Using deprecated form_for helper
• Using invalid options like ajax: false

3. Given this code snippet:

form_with model: @user, local: true do |form|
  form.text_field :name
  form.submit 'Save'
end

What will happen when the user submits the form?

medium

A. The form submits data with a normal HTTP POST request

B. The form will not submit because of syntax error

C. The form sends data via AJAX without page reload

D. The form submits data but reloads the page with errors

Solution

1. Step 1: Analyze the local: true option

   Setting local: true disables AJAX, so the form submits with a normal HTTP request.

2. Step 2: Understand form submission behavior

   The form sends data via HTTP POST and reloads or redirects normally, no AJAX involved.

3. Final Answer:

   The form submits data with a normal HTTP POST request -> Option A

4. Quick Check:

   local: true means normal POST submission [OK]

Hint: local: true disables AJAX, so form submits normally [OK]

Common Mistakes:

• Assuming local: true enables AJAX
• Confusing syntax errors with correct code
• Thinking form reloads only on errors

4. Identify the error in this form_with usage:

form_with model: @article, local: true do |f|
  f.text_field :title
  f.submit
end

Why might this form not work as expected?

medium

A. The block variable f is invalid

B. Using local: true disables form submission

C. Missing = before form_with in ERB template

D. The form is missing a closing end keyword

Solution

1. Step 1: Check ERB syntax for form_with

   In ERB templates, form_with must be preceded by = to output the form HTML.

2. Step 2: Analyze other options

   Using local: true disables form submission is wrong because local: true enables normal submission. The block variable f is invalid is wrong; f is a valid block variable. The form is missing a closing end keyword is incorrect; the block is properly closed.

3. Final Answer:

   Missing = before form_with in ERB template -> Option C

4. Quick Check:

   Use <%= form_with ... %> to render form [OK]

Hint: Always use <%= form_with ... %> to render form in ERB [OK]

Common Mistakes:

• Omitting = in ERB for form_with
• Thinking local: true disables submission
• Confusing block variable names
• Forgetting to close the block

5. You want to create a form for a new @comment that submits without page reload using AJAX. Which is the correct way to write form_with?

hard

A. = form_with model: @comment do |form|

B. = form_with model: @comment, remote: true do |form|

C. = form_with @comment, local: false do |form|

D. = form_with model: @comment, local: true do |form|

Solution

1. Step 1: Understand AJAX behavior in form_with

   By default, form_with submits via AJAX unless local: true is set.

2. Step 2: Analyze options for AJAX submission

   = form_with model: @comment do |form| uses default AJAX submission. = form_with model: @comment, local: true do |form| disables AJAX with local: true. = form_with model: @comment, remote: true do |form| uses invalid remote: true (deprecated). = form_with @comment, local: false do |form| uses local: false which is not a valid option.

3. Final Answer:

   = form_with model: @comment do |form| -> Option A

4. Quick Check:

   Default form_with submits via AJAX unless local: true [OK]

Hint: Omit local: true for AJAX; default is AJAX submission [OK]

Common Mistakes:

• Using local: true disables AJAX
• Using deprecated remote: true option
• Setting invalid local: false option