describeとRSpec.describeはどちらの書き方が良いのか

この記事は「ESM Advent Calendar 2021」の3日目の記事です。

はじめに

Railsアプリケーションをの開発でRSpecを使ってテストを書くことが多いです。私はRSpecを書くときに、トップレベルの階層の describe をdescribe ではなく RSpec.describe でいつも書いています。

トップレベルに describe を書くパターン。

descirbe User, type: :model do
  descirbe "foo" do
    # ...
  end
end

トップレベルに RSpec.describe を書くパターン。

RSpec.descirbe User, type: :model do
  descirbe "foo" do
    # ...
  end
end

どちらの書き方でも動作します。

ちなみに、rspec/rspec-core のREADMEでは RSpec.describe の書き方で統一されています。

どちらの書き方が推奨されているか気になったので、調べてみることにしました。

stack overflowでまさにこれの質問を見つけました。

回答によるとRSpec バージョン3からは describe の書き方制限するオプションが新たに加えられたそうです。

後方互換性を維持するためconfig.expose_dsl_globally がデフォルトで true になっており、 describe も RSpec.describe も書くことができるようにはなっています。

ただし、expose_dsl_globally = false を設定すると describe だと "undefined method 'describe'" にすることができます。

この辺りのバーション3系のアップデートを日本語でまとめている記事もありました。

また generator が作るspecファイルも RSpec.describe の書き方に書き換えられている。

調査から分かったこと

expose_dsl_globally = false とする代わりに、

RSpec.configure { |c| c.disable_monkey_patching! }

とすることでも describe の書き方を禁止することができます。

expose_dsl_globally = false よりも強力にモンキーパッチを禁止することができるため、私もあまり使ったことがなかった should や stub といったメソッドも禁止にできるようです。