Rspec/Capybara統合テストでエラーが起こる。undefined method `each' for nil:NilClass

Question

前提・実現したいこと

マンダラートのアプリを作っています。
マンダラートとはアイデア出しの手法の一つで
こんな感じで、連想してアイデアを出してくような感じ。

やりたいことは
spec/system/mandalarts_spec.rb
のテストを通したいです

もっといえば

mandalarts_controller

    if @mandalarts == []
      @mandalarts = []
      $mandalart_blocks_num.times do |mandalart|
        mandalart = Mandalart.create(text: '')
        @mandalarts << mandalart
      end
    end

のここがちゃんと動作するか確認したいです。

配列が空だったら、ちゃんと配列の要素が $mandalart_blocks_num分(9つ)分あるかテストしたいです。

発生している問題・エラーメッセージ

     # ./spec/system/mandalarts_spec.rb:9:in `block (3 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NoMethodError:
     #   undefined method `each' for nil:NilClass
     #   ./app/views/mandalarts/index.html.erb:15:in `_app_views_mandalarts_index_html_erb___880990826294763201_47149230060780'

spec/system/mandalarts_spec.rb

require 'rails_helper'

RSpec.describe "Mandalarts", type: :system do
    
    #@mandalart = FactoryBot.create(:mandalart)
    
  context "マンダラートが書ける時" do
    it "マンダラート記入の流れ" do
      visit root_path

visit root_pathでエラーが起こってます。

該当のソースコード

spec/system/mandalarts_spec.rb

require 'rails_helper'

RSpec.describe "Mandalarts", type: :system do
    
    #@mandalart = FactoryBot.create(:mandalart)
    
  context "マンダラートが書ける時" do
    it "マンダラート記入の流れ" do
      visit root_path
      binding.pry
      save_and_open_page
      expect(page.all('td').count).to eq $mandalart_blocks_num
      # マンダラートが$mandalart_blocks_num分ある。
      expect(page).to have_content('記入')
      # マンダラートの記入ボタンがある
      click_on "記入",match: :first
      
      expect(current_path).to eq(edit_mandalart_path(mandalart))
      # 記入ボタンをクリックしたら、mandalarats/edit.html.erbに遷移
      fill_in 'text', with: "aaaa"
      find('input[name="commit"]').click
      expect(current_path).to eq(root_path)
      # フォームにテキストを入力して、inputタグをクリックしたら
      # root_pathに遷移
      expect(page).to have_content('aaaa')
      # 先程入力したaaaaがある
    end


  end
end

mandalarts_controller.rb

  def index


    # 最初から配列の要素を9つ入れとく
    # 配列の要素の中身があれば、何もしない
    # 配列の要素の中身があれば、""の要素を入れとく


    @mandalarts = Mandalart.all

    if @mandalarts == []
      @mandalarts = []
      $mandalart_blocks_num.times do |mandalart|
        mandalart = Mandalart.create(text: '')
        @mandalarts << mandalart
      end
    end
  end

mandalarts/index.html.erb

<table class="mandalart-table">

    <tr>
      <% @mandalarts[0..2].each do |mandalart| %>
        <td>
            <div class="mandalart-text">
              <%= mandalart.text%>
            </div>
            <%= link_to "記入", edit_mandalart_path(mandalart.id)%>
        </td>
      <% end %>
    </tr>

    <tr>
       <% @mandalarts[3..5].each do |mandalart| %>
      <td>
        <div class="mandalart-text">
          <%= mandalart.text%>
        </div>
          <%= link_to "記入", edit_mandalart_path(mandalart.id)%>
      </td>
        <% end %>
    </tr>

    <tr>
       <% @mandalarts[6..8].each do |mandalart| %>
      <td>
        <div class="mandalart-text">
          <%= mandalart.text%>
        </div>
          <%= link_to "記入", edit_mandalart_path(mandalart.id)%>
      </td>
        <% end %>
    </tr>

</table>

routes.rb

Rails.application.routes.draw do
  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
  root to: "mandalarts#index"
  resources :mandalarts
end

試したこと

試したことというか考えられることとしては、

spec/system/mandalarts_spec.rb

visit root_path

で

     #   undefined method `each' for nil:NilClass
     #   ./app/views/mandalarts/index.html.erb:15

というエラーが起きてますので、

visit　は

リクエストをせずに、言い換えれば
ルーティングやコントローラーを介さず
ただ単に画面遷移をするだけなので、
コントローラーが起動してない。といったことが考えられます。

コントローラーでは、

mandalarts_controller

    @mandalarts = Mandalart.all

    if @mandalarts == []
      @mandalarts = []
      $mandalart_blocks_num.times do |mandalart|
        mandalart = Mandalart.create(text: '')
        @mandalarts << mandalart
      end
    end

このように、配列の中身がなければ、$mandalart_blocks_num分(9つ)配列の要素を作成するので、undefined method `each' for nil:NilClassエラーを起こさないようになっています。
ですが、visit root_pathをした瞬間にエラーになってしまいます。
色々sava_and_open_pageとか
binding.pryとかしたいですが、visit root_path　になった瞬間エラーになるので、
効果的にデバッグも難しいです。ごめんなさい。

その他考えられる原因は、capybara.rb等の各種設定が間違ってるのかもしれませんが、それは私の今の技術力じゃデバッグは難しいです。

https://github.com/Harasou21/ideaFrameworks/tree/feature/mandalart/spec

設定はお手数ですが、上記のgithubを参考にしてもらえればと思います。

補足情報（FW/ツールのバージョンなど）

Rails 6.1.4.1,Ruby 2.6.5,selenium-webdriver (4.1.0), capybara (>= 3.26)

Answer 1

~~if @mandalarts == []の行が間違っています。@mandalarts = Mandalart.allで得られるオブジェクトは配列ではなく、ActiveRecord::Relationというオブジェクトです。ですので、このif文は常にfalseとなります。 ~~

意図と達成するには、該当のif文をif @mandalarts.blank?にするとよいでしょう。

当初の想定は私の勘違いでした。改めて状況を確認してみたのですが、やはり @winderboum さんがおっしゃるようにテスト環境にのみすでに1件または2件のデータが保存されてしまっているとしか考えられません。

もうちょっと深掘りすると、このindexメソッドはGETでアクセスされるものであるにも関わらず、「データがないならデータを作る」という振る舞いをしてしまいます。これは冪等性を満たしていません。また、すでにデータが1件でも存在するなら何もしませんが、それでは「データが9件必要である」という要件を満たせません。
このような「一定の初期データが必要である」という状況では、開発環境ではseedと呼ばれる仕組みが、テスト環境ではfixtureまたはfactoryと呼ばれる仕組みが、それぞれ使われます。

seedについては
公式ガイドを参照してください。

factoryについてはすでに利用されているようですが、system specのbeforeブロックでFactoryBot.create_list :mandalart, 9)を実行することで毎回9件のレコードを保存できます。

ついでに、本番環境では基本的に1度保存したデータは削除されないため、手動で9件のデータを作成することで問題ないかと思われます。

【追記】
エラーがなぜ15行目で起きているかについて説明します。
Rubyでは[][0..2] # => []という実行結果になります。これはつまり、「空の配列に対して範囲アクセスをした場合、範囲に0が含まれていると空の配列が返ってくる」ということです。一方、範囲が0を含まないと[][3..5] # => nilのようになります。
このため、最初のループではエラーは起きず（しかし要素がないので何も起きない）、2回目のループでエラーが起きます。

Comments

[winterboum]

@mandalarts = Mandalart.all では relationですが、
@mandalarts == [] とした時点でDBへの参照がおこなわれて、配列として参照されます。
ので、 Mandalart が空のときは True になります。

[okuramasafumi]

なんと、試してみたら確かにそうなりました…ありがとうございます！
回答は訂正しますが、だとすると原因がちょっとわからないですね…

[winterboum]

ええ、
DBにゴミがあるのかなぁ、、ぐらいしか。

Answer 2

@mandalarts[0..2] では通り@mandalarts[3..5]がnilということは、@mandalarts の要素数が 0以上 2以下 ということです。
0でしたら if @mandalarts == [] で作られますから、all でひろうと１，２取れてしまうのでは無いですか？
もしくは $mandalart_blocks_num が正しくないか。
テストなので、初めはdatabaseは空なのが期待されますが、もしかしてゴミが混じっているとか。
実際系では空でない場合もあり、ですから if @mandalarts == [] ではなく if @mandalarts.count < 9 にして、($mandalart_blocks_num - @mandalars.count).times としては？

Comments

[divclass123]

ありがとうございます！
visit root_pathでちゃんとmandalarts_controller#indexを介してるんですね。
それゆえbinding.pryで@mandalartsの中身を見てみたら、
2件データが入っていて、ifを突破されていましたね。
エラーの原因がわかりました。ここまできたらデバッグは簡単になりました。
本当にありがとうございます。
winterboumさんのコードを書かせていただきます。

Rubyでは[][0..2] # => []という実行結果になります。これはつまり、「空の配列に対して範囲アクセスをした場合、範囲に0が含まれていると空の配列が返ってくる」

なんか初心者の自分から見ると特殊な感じですね。[0..2]でエラーが起こらないのも実は結構疑問でしたので、勉強になりました。ありがとうございます。

ベストアンサーを選ぶの非常に難しいですが、汎用性のあるコードを頂いたwinterboumさんにさせていただきます。okuramasafumiさんも本当にありがとうございます。

[divclass123]

NoMethodError: undefined method `<<' for #<Mandalart::ActiveRecord_Relation:0x000055f2bd5bb070>

といったエラーが起こったので、

```

def index

# 最初から配列の要素を9つ入れとく
# 配列の要素の中身があれば、何もしない
# 配列の要素の中身があれば、""の要素を入れとく

@mandalarts = Mandalart.all

if @mandalarts.count < $mandalart_blocks_num
($mandalart_blocks_num - @mandalarts.count).times do |mandalart|
Mandalart.create(text: '')
end
@mandalarts = Mandalart.all
end

end

```

最終的にこのようなコードになりました！

おかげさまでテストもパスできそうです！ありがとうございます！