form_withのlocal: trueって必要なん？これ何なん？（Ruby on Rails）

Last updated at 2021-05-23Posted at 2021-02-25

はじめに：私が犯した罪と償い

社内研修の一環で、プチIoTシステムを開発しています。
そんな中、自分のエラーの解消に大先輩3人の60分を溶かしてしまったので、せめてもの償いのために、学んだことをメモしておきます。

おかげで、

Railsのメソッドform_withの引数local: trueが何の役に立っているのか
アプリ作成時のネットワーク通信のこと

が痛いほどわかりました。

環境
Rails6.0.3, macOS Catalina 10.15.7

何のエラー出してたん？

supplierモデルに対する、新規登録（new/create）のフォームで、バリデーションが通らなかった時にエラーメッセージをビューで表示したい！
ただそれだけのことでした。しかし仕込んだそのエラーメッセージが表示されません！

うまくいっていなかったビューはこちら。１行目にご注目。

new.html.erb

<%= form_with model: @supplier do |form| %>

  <% if form.object.errors.any? %>
    <div id="error_explanation">
      <div class="alert alert-danger">
        エラーが <%= form.object.errors.count %> 個あります。 
      </div>
      <ul>
      <% form.object.errors.full_messages.each do |msg| %>
        <li><%= msg %></li>
      <% end %>
      </ul>
    </div>
  <% end %>

  <div class="mb-3">
    <%= form.label :会社名, for: 'company', class: 'col-sm-2 col-form-label' %>
    <%= form.text_field :name, class: 'form-control', id: 'company', placeholder: '株式会社 喧嘩上等' %>
  </div>
  <div class="mb-3">
    <%= form.label :メールアドレス, for: 'email', class: 'col-sm-2 col-form-label' %>
    <%= form.text_field :email, class: 'form-control', id: 'email', placeholder: 'order@example.com' %>
    </div>

  <%= form.submit '送信', class: 'btn' %>
<% end %>

私は、Railsチュートリアル出身なのですが、そこではform_withにlocal: trueという引数を渡していました。しかし、ネットでform_withの使い方を他で改めて調べてみたところ、この引数がなくても新規レコードの登録処理ができそうだったので、省いてみちゃえ！と出来心が全ての事の始まりでした。実際、これでデータベースまでの登録はきちんとできていて、なんだlocalパラメータいらないんじゃん。となっていました。

一方.....if form.object.errors.any?を入れても、エラー表示は一切できませんでした。

ちなみにコントローラはこんな感じ。問題なさそう。

supplier.controller.rb

class SuppliersController < ApplicationController

  def new
    @supplier = Supplier.new
  end

  def create
    @supplier = Supplier.new(supplier_params)
    if @supplier.save
      redirect_to suppliers_path
    else
      render 'new'
    end   
  end

end

binding.irbをビューやコントローラなど至る箇所に埋め込んでは、各変数に値が入っているかどうかをチェック。
form.objectには値もある。@supplierにしても同じ。errors.any?もtrueを返している。何故なんだ。タイポもなさそう。先輩たちの時間をどんどん溶かしてしまっています...。

解決：「クルクルしてない！」

「クルクルしてない！」
問題の原因が全くわからず途方にくれていた末に、ある先輩が上記のセリフを発せられました。
フォームの送信ボタンを教えても画面がリロードしないことを変に思ったようで、そこからフォームの動きが怪しいとなりました。そこでlocal: trueを追記したのです。

new.html.erb

<%= form_with(model: @supplier, local: true) do |form| %>

以下略

学び１：`local: true`とは？

form_withはRailsの比較的新しいメソッド。このメソッドではデフォルトがAjax通信で、非同期通信になってしまうのです。（これはRails 5.1〜6.0の仕様でRails 6.1からは同期通信がデフォルトに戻っているそうです。当記事はRails6.0.3です。→参考。@jnchito さん、ありがとうございます！）それはつまり、必要な箇所だけページが更新され、その他の箇所はそのままになるという事。だからエラーメッセージのHTML部分が加えられなかったのです。
ここにlocal: trueと引数を渡す事で、これが通常のHTTPリクエストになり、ページ全体が返ってきてページがリロードされ、エラーメッセージも表示されるようになります。