【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】

はじめに

RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。

入力フォームの内容を書き換えるにはCapybaraのfill_inメソッドを使います。

fill_in 'ラベル', with: '書き換える内容'

今回は編集画面のため、画面にアクセスした時点で既存レコードの内容がセットされています。fill_inメソッドが実行されると、既存レコードの内容は削除され、withで指定した内容に書き換えられます。

しかし、条件は不明ですが、指定した内容で書き換えられるのではなく、既存レコードの内容+指定した内容がセットされるという事象に遭遇しました。

今回は、fill_inメソッドを実行すると既存レコードの内容+指定した内容がセットされる事象の原因と対処について記載します。

  • Capybara 3.33.0
  • Selenium-WebDriver 3.142.7

既存レコードの内容+指定した内容がセットされる

事象

事象が発生したコードは以下のようになります。

_form.html.erb

<%= form.label, :field_1, 'フィールド1' %>
<%= form.text_field :field_1%>

<%= form.label, :field_2, 'フィールド2' %>
<%= form.text_field :field_2%>

feature_spec.rb

fill_in 'フィールド1', with: 'updated_field_1'
fill_in 'フィールド2', with: 'updated_field_2'

特筆すべきこともない、いたってシンプルでオーソドックスなコードかと思います。編集画面のため、画面にアクセスした時点でフィールド1およびフィールド2には既存レコードの内容がセットされており、それをfill_inメソッドで書き換えようとしたのですが、フィールド2は想定通り指定した内容で書き換えられましたが、なぜかフィールド1だけ既存レコードの内容+指定した内容がセットされてしまいました。

対象フィールド fill_in実行前 fill_in実行後
フィールド1 (既存レコードの内容) (既存レコードの内容)updated_field_1
フィールド2 (既存レコードの内容) updated_field_2

原因

おそらく、Capybaraのバグではないかと思います。以下のIssueで言及されています(Capybaraのリポジトリではないですが)。以下のIssueにおいて、NGMarmaduke氏が原因と思われる該当コードを特定しています。

対処

上記のIssueに書いてありますが、fill_inメソッドにfill_options: { clear: :backspace }オプションを追加することで、指定した内容で書き換えられるようになります。その他、直前で空文字をセットするとか、バックスペースキーを入力するとかいくつか対処法があるようですが、一行で書ける方法がエレガントでいいと思います。

feature_spec.rb

# オプション指定
fill_in 'フィールド1', with: 'updated_field_1', fill_options: { clear: :backspace }

# 直前で空文字をセット
fill_in 'フィールド1', with: ''
fill_in 'フィールド1', with: 'updated_field_1'

# 直前でバックスペースキーを入力
find('フィールド1').send_keys :backspace
fill_in 'フィールド1', with: 'updated_field_1'

まとめ

今回は、fill_inメソッドを実行すると既存レコードの内容+指定した内容がセットされる事象において、その原因と対処法について記載しました。

本事象については2016年2月にIssueで言及されているにもかかわらず、未だにCapybaraで対処されていない(たぶん)ことを鑑みると、バグではないのかもしれません。ただ、私の環境では事象が発生する条件がわからなかったので、事象が発生した場合は本記事の通り対処する必要があります。

本記事の内容を参考にしていただければと思います。

関連記事

【Rails】Paranoiaを使用した論理削除(ソフトデリート)
# はじめに Paranoiaは、Railsアプリケーションで論理削除(ソフトデリート)を実現するためのGemです。 論理削除は、データベースのレコードを物理的に削除するのではなく、削除フラグを設定することで「削除済み」とみなす方法です。こ [...]
2024年7月20日 21:33
【Rails】activerecord-multi-tenantを使用したマルチテナントアプリケーションの作成
# はじめに マルチテナントアプリケーションでは、複数の顧客(テナント)が同じアプリケーションを利用するため、データの分離が必要です。 activerecord-multi-tenantは、このようなマルチテナント環境をサポートするための便 [...]
2024年7月18日 16:50
【Rails】RubyとRailsにおけるattr_reader, attr_writer, attr_accessorの概念と使用方法
# はじめに RubyとRailsの開発において、`attr_reader`,`attr_writer`,`attr_accessor`は非常に便利なメソッドです。これらは、クラス内でインスタンス変数に対するゲッターおよびセッターメソッドを簡単に [...]
2024年7月17日 18:11
【Rails】RubyとRailsにおけるyieldの概念と使用方法
# はじめに RubyとRailsにおける`yield`は、メソッドやテンプレートの中で動的にコードブロックを実行する能力を提供し、これによってコードの再利用性と拡張性が大幅に向上します。本記事では、RubyとRailsにおける`yield`の概 [...]
2024年7月17日 13:15
【Rails】AASMを使用してオブジェクトの状態遷移を効率的に管理
# はじめに Railsアプリケーションにおいて、オブジェクトの状態管理は重要な課題の一つです。AASM (Acts As State Machine) gemは、複雑な状態遷移を効率的に管理します。本記事では、AASMの基本的な使い方を解説して [...]
2024年7月16日 18:00
【Rails】RSpec + Swagger + rswagでアプリケーションのAPIをテストおよびドキュメント化する方法
# はじめに Railsアプリケーションの開発において、APIのテストとドキュメント化は重要な要素です。 RSpecはテストフレームワークとして広く利用されており、SwaggerはAPIの設計とドキュメント化を支援します。これらを統合するr [...]
2024年7月16日 14:27
【Rails】mailcatcherを使用して開発環境でメール送信をテストする方法
# はじめに mailcatcherは、開発環境でのメール送信をキャプチャするためのツールです。ローカルで送信されたメールをブラウザ上で簡単に確認できるようにします。mailcatcherをRailsアプリケーションで使用する方法について説明しま [...]
2024年7月15日 16:37
【Rails】impressionistを使用してページビューやクリック数を追跡する方法
# はじめに impressionist Gemを使用してRailsアプリケーションでページビューやクリック数を追跡する方法について説明します。 # 実装方法 ## impressionist Gemのインストール まず、impre [...]
2024年7月15日 14:18