はじめに
request specを書いているときに、エラーぶつかりました。その原因がletとlet!の違いによるものでした。
当時は違いを理解できていなかったため、エラーにかかって向き合う時間ができてよかったと思っています。
今回得た学びをまとめます。
開発環境
ruby '3.0.0'
Rails 6.0.3.4
エラー原因
コントローラのテストをrequest specで実行する際、以下のようなソースで、indexアクションを検証していました。
request.rb
RSpec.describe "Gadjets", type: :request do
let(:user) {FactoryBot.create(:user, :a)}
let(:category) {FactoryBot.create(:category)}
let(:gadjet) {FactoryBot.create(:gadjet, user_id: user.id, category_id: category.id)}
describe "Action test" do
context "index" do
it "ログインユーザの場合。リクエストが成功すること" do
sign_in user
get gadjets_path
expect(response.status).to eq(200)
end
it "ログインユーザの場合。gadjet_titleが表示されること" do
sign_in user
get gadjets_path
expect(response.body).to include "#{gadjet.gadjet_title}"
end
it "ログインしていないユーザの場合、302レスポンスであること" do
get gadjets_path
expect(response.status).to eq(302)
end
end
index.html.erb
<% if @gadjets.present? %> <%# ログインしているユーザが投稿したgadjetがあるかを判定するフラグ%>
<% @gadjets.each do |gadjet| %>
＊＊省略＊＊
<p class="card-text"><%= gadjet.gadjet_title.truncate(15) %></p
＊＊省略＊＊
<% end %>
<% else %>
<%= current_user.user_name %>が投稿したgadjetはありません
<% end %>
@gadjetsが存在すれば「gadjet_title」を表示し、存在しなければ「（ユーザ名）が投稿したgadjetはありません」と表示するものです。
ここのテストを実施した際に、結果は失敗でした。
it "ログインユーザの場合。gadjet_titleが表示されること" do
sign_in user
get gadjets_path
expect(response.body).to include "#{gadjet.gadjet_title}"
end
エラー
Failed examples:
rspec ./spec/requests/gadjets_request.rb:17 # Gadjets Action test index ログインユーザの場合。gadjet_titleが表示されること
<div class="col-md-4">
satoshiが投稿したgadjetはありません
</div>
どうやら”if @gadjets.present?”でｅｌｓｅ（存在しない）を通っているみたいです。
しかし、request.rbにてletで:gadjetを定義し、インスタンスを作成しているのだが。。。
原因は遅延評価による特性のためでした。
let と let! の違い（遅延評価） エラー解決まで
letで定義（遅延評価）すると、必要なときだけのみ評価されます。（letで定義した変数が参照されたタイミングで評価される）。
つまり必要ないときまで処理しないので余計な処理をせず結果的に、パフォーマンスが上がる。
それに比べlet!で定義するとテストを行う前(before doと同じタイミング)に評価されます。
また"it"ごとに変数が初期化されます。つまり無駄な初期化の時間が生まれる可能性があるため、無闇に使うのは控えたい。。
今回のケースで言えば、request.rbで
"sign_in user"の記載でlet(:user) {FactoryBot.create(:user, :a)}が評価されることになります。
":user"は参照されたため、評価されたのですが、肝心の":gadjet"は、参照されていないため、評価されていないことになります。
it "ログインユーザの場合。gadjet_titleが表示されること" do
sign_in user #userを参照している
get gadjets_path #index画面に遷移した時点で、":gadjetを参照していないため、”if @gadjets.present?”がelseになる
expect(response.body).to include "#{gadjet.gadjet_title}"
end
そのため、let を let! に変更しテスト実行と同時に評価するよう変更したところ成功しました。
request.rb
RSpec.describe "Gadjets", type: :request do
let(:user) {FactoryBot.create(:user, :a)}
let(:category) {FactoryBot.create(:category)}
let!(:gadjet) {FactoryBot.create(:gadjet, user_id: user.id, category_id: category.id)} #!を追加
describe "Action test" do
context "index" do
it "ログインユーザの場合。リクエストが成功すること" do
sign_in user
get gadjets_path
expect(response.status).to eq(200)
end
it "ログインユーザの場合。gadjet_titleが表示されること" do
sign_in user
get gadjets_path
expect(response.body).to include "#{gadjet.gadjet_title}"
end
it "ログインしていないユーザの場合、302レスポンスであること" do
get gadjets_path
expect(response.status).to eq(302)
end
end
終わりに
個人的に、うやむやになっていた部分が今回エラーにかかったことで、理解が深まりました。
初学者にとって、遅延評価はつまづきやすいポイントだと思います。
少しでも参考になれば幸いです。
特定のテストを実行
特定のテストを実行には２つあり、１つは実行したいテストのファイル名と行数を指定する方法。
ターミナル.
$ rspec spec/models/user_spec.rb:8
２つ目はテストコードitの前にfをつけるだけでそのテストのみ実行される方法。
task_spec.rb
require 'rails_helper'
RSpec.describe Task, type: :model do
describe 'validaton' do
fit 'タスクを問題なく作成' do. #fitとなっているこのテストだけ実行される。
task = build(:task)
expect(task).to be_valid
expect(task.errors).to be_empty
end
it 'タイトル空欄は無効' do
task = build(:task,title: "")
expect(task).to be_invalid
expect(task.errors[:title]).to eq ["can't be blank"]
end
end
end
ターミナルで入力するよりも、fitと入力したほうが簡単なので、これが使えるように設定していく。
spec_helperを編集
spec_helper.rb
RSpec.configure do |config|
config.filter_run_when_matching :focus
#↑コメントアウトされているはずなので解除
end
これで、fdescribe, fcontext, fit のように使うことができる。
参考記事
RSpecで特定のテストを実行する方法
