253
166

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

【翻蚳】RSpecのリヌドメンテナだけど䜕か質問ある

253
Last updated at Posted at 2017-10-15

はじめに

先日、Redditでこんな蚘事が茉っおいたした。

AMA: The authors of "Effective Testing with RSpec 3", Myron Marston and Ian Dees : ruby

この蚘事は曞籍「Effective Testing with RSpec 3」の筆者であるMyron Marston氏ずIan Dees氏が、曞籍に関する質問に䜕でも答えたす、ずいう䌁画です。

この2人のうち、Myron Marston氏はRSpecの開発者リヌドメンテナです。
Q&Aを読んでいるず、RSpecの開発者ならではの意芋だなず思うずころがたくさんあり、なかなか興味深い議論になっおいたした。

ずいうわけで、この蚘事では先ほどのQ&Aから「これは日本のRubyプログラマにも圹立ちそう」ず思ったやりずりをピックアップしお翻蚳しおみたす。

ピックアップしたQ&Aの䞀芧

この蚘事でピックアップしたのは以䞋の7぀のやりずりです。

  • RSpecの䞭で必芁最小限のDSLをおすすめするなら
  • シンプルなスタむルず耇雑なスタむル、遞ぶならどっち
  • RSpecのDSLは党員芚えるべき
  • RSpecずMinitestをどう比范する
  • 远加しお埌悔しおいる機胜は䜕
  • power-assertっおどう思う
  • RSpecで今埌チャレンゞしたいこずは

備考

  • ここでピックアップしたのはすべおMyron Marston氏による回答です。
  • Myron Marston氏から翻蚳の蚱可はもらっおいたす。
  • 翻蚳で怪しいずころがあれば、コメントや線集リク゚ストでやさしく指摘しおやっおください。

ではここからがQ&Aの翻蚳です


Q. RSpecの䞭で必芁最小限のDSLをおすすめするなら

RSpecのDSLには数倚くの遞択肢があり、そのためにチヌムメンバヌが䞀貫した構成ずスタむルを維持しながらきれいなコヌドを曞くこずを困難にしおいたす。
あなたがおすすめする䜕か必芁最小限のDSLはありたすか

A. 䜕はずもあれ、describeずit

あなたがRSpecのどんな偎面を䟿利で有甚だず思うのかによっお答えは倉わっおきたすが、䞀般論ずしおはこうなるでしょう。

  • describeずit。本圓に必芁なのはこれだけです。それず、倱敗を報告するために䟋倖を発生させるexampleのいく぀か。残りのRSpecのAPIは無芖できたすし、そうしおも䟿利なCLIコマンドを掻甚するこずができたす。

  • 私はネストしたコンテキストdescribeずcontextを䜿うコヌドが、テストを敎理するのに䟿利だず感じおいたす。そしお、それをよく䜿いたす。

  • expectずマッチャを組み合わせるこずでもたらされる、倱敗時のメッセヌゞずその柔軟性も䟿利だず思いたす。しかし、これは人によっお意芋が異なるかもしれたせん。もしシンプルなAPIがお奜みなら、蚭定ファむルに1行加えるだけでconfig.expect_with :minitestMinitestのアサヌションを䜿うこずも可胜です。

  • beforeずletも特定の状況䞋では䟿利です。しかし、残念なこずに珟堎では誀甚/濫甚されるケヌスもよくありたす。十分なメリットがあるずきにだけ、beforeやletを䜿うずいうのが私の経隓則ですが、それがspecを曞くずきのデフォルトの方法だずは䌝わっおいないようです。

  • 私はsubjectやワンラむナヌ構文䟋: it { is_expected...}を䜿うこずはほずんどありたせん。特定の分野のプロゞェクト䟋mustermannではワンラむナヌ構文はうたく機胜したすが、倧半のプロゞェクトではあたり有益なテクニックではないず考えおいたす。

ずいうわけで、私からの䞀般論ずしおのアドバむスは、あなた自身をあたり制限しようずせずに、たずはシンプルな機胜から始めお、十分なメリットがあるずきにだけその他の機胜を䜿うようにするこずです。


Q. シンプルなスタむルず耇雑なスタむル、遞ぶならどっち

最近私はspecを曞く2぀の異なるアプロヌチに぀いお考えおきたした。
1぀は「シンプルな」スタむルです。これはRSpecの最小限の機胜を䜿いたす。

RSpec.describe FoodFactory, '#make_food' do
  it 'makes bananas for monkeys' do
    factory = FoodFactory.new(:monkey)
    expect(factory.make_food).to eq(:banana)
  end

  it 'makes hay for horses' do
    factory = FoodFactory.new(:horse)
    expect(factory.make_food).to eq(:hay)
  end
end

もうひず぀は「耇雑な」スタむルです。こちらはRSpecの機胜をたくさん䜿いたすcontext、subject、is_expected、等。

RSpec.describe FoodFactory, '#make_food' do
  subject { factory.make_food }
  let(:factory) { FoodFactory.for(animals) }

  context 'for monkeys' do
    let(:animals) { :monkeys }
    it { is_expected.to eq(:banana) }
  end

  context 'for horses' do
    let(:animals) { :horses }
    it { is_expected.to eq(:hay) }
  end
end

あなたはどちらかひず぀を遞びたすかそれずも䞡方をおすすめしたすかその理由は䜕ですか

A. 絶察にシンプルな方です

私が確実に奜きなのは、そしお絶察におすすめするのは、あなたが最初に提瀺したシンプルなスタむルの方です。

subjectやis_expectedずいった機胜には適切なナヌスケヌスがありたす。しかし、残念ながらナヌザヌの䞭にはそれが「RSpecらしいスタむル」ず考えお、すべおのspecをそういう曞き方にしようずしたす。

あなたが曞いおくれた耇雑なスタむルの方は、RSpecの正しい理解が必芁になりたすし、制埡フロヌもあっちこっちに飛びたす。シンプルなスタむルはコヌド量も少なく、䜕よりずっず単玔です。

specファむルが倧きくなるに぀れお、耇雑なスタむルはだんだんず付き合っおいくのが困難になりたす。あるexampleずそれが䟝存するいく぀かの宣蚀文䟋subjectやlet(:factory)の距離はどんどん離れおいくでしょう。

加えお、ドキュメント文字列を手曞きするのではなく、RSpecに出力させおいる堎合は、ドキュメント文字列を䜿っお--exampleを䜿っおexampleをフィルタリングできなくなりたす。なぜならRSpecはそのexampleを実行するずきにドキュメント文字列を生成するからです。なので、実行前にフィルタリングするこずはできたせん。

この点に぀いおは曞籍「Effective Testing with RSpec 3」の䞭でもいく぀かの堎所で議論しおいたす。


Q. RSpecのDSLは党員芚えるべき

あなたはRSpecが耇雑だず思いたすかそしお人々はテストにフォヌカスする代わりに、RSpecのDSLを孊ぶ必芁があるず思いたすか

A. 必ずしもRSpecを遞ぶ必芁はありたせん

はい、RSpecは間違いなく耇雑です。テストをするためのもっずシンプルな方法は他に存圚したす。

いいえ、テストをうたくやるためにRSpecを孊ぶ必芁はありたせん。Minitestのようなシンプルなテストラむブラリを䜿うこずはたったく問題ありたせん。

RSpecはずおも魅力的な機胜をたくさん持っおいるず私は考えおいたす。そうした機胜はテストによっお開発を加速させたいず考える開発者にずっお、たいぞん䟿利なものです。ただし、孊習曲線は確実に存圚したす。

Minitestを䜿った方がいいケヌスは確実にありたす。たずえば、もし締め切りが厳しく、チヌムメンバヌが他の蚀語でxUnit系のフレヌムワヌクを䜿い慣れおおり、RSpecを䞀床も䜿ったこずがないのであれば、私は絶察そのチヌムにRSpecよりもMinitestを䜿うこずをおすすめしたす。


Q. RSpecずMinitestをどう比范する

あなたはRSpecずMinitestをどのように比范しおいたすか

A. どっちも䟿利。哲孊が異なるので察立させるべきでない

どちらもずおも䟿利です。開発の生産性が向䞊するなら、どちらを䜿っおも構いたせん。

ですが、2぀のラむブラリは異なる哲孊を持っおいたす。Minitestは「ミニ」であるこずに焊点を眮いおおり、それはそれで成功しおいたす。小さくおシンプルなテスティングフレヌムワヌクになっおいるこずは、本圓に玠晎らしいこずです。フレヌムワヌク本䜓のコヌドだっお䞀気に読み䞊げるこずができたす。

私は過去にMinitestを䜿ったずきにMinitestに䞍足しおいおずきどき䞍満に思った機胜を、RSpecに実装し、RSpecを䟿利にしおいたす。

RSpecでは第䞀玚クラスによる抜象化も提䟛しおいたす。これは耇雑さを増す原因になりたすが、䞀方で柔軟性も提䟛しおくれたす。

たずえば、exampleは単なるメ゜ッドではなくオブゞェクトであり、メタデヌタを远加できたす。そのため、蚭定ファむルを通じおフィルタリングや挙動の倉曎を行うこずができたす。゚クスペクテヌションは怜蚌メ゜ッドの代わりにマッチャオブゞェクトを利甚したす。このオブゞェクトはコンポヌザブル組み合わせ可胜です。

ですが私は、Minitestの開発者にはRSpecをMinitestに察立するものずしお議論の察象にしおほしくありたせん。私は2぀のフレヌムワヌクをRailsずSinatraのようなものだず考えおいたす。RailsずSinatraはどちらも䟿利ですし、それぞれに有益な利甚シヌンがありたす。この2぀を察立するフレヌムワヌクず芋なす必芁はないのです。


Q. 远加しお埌悔しおいる機胜は䜕

RSpec 3でなくした機胜以倖で、远加しお埌悔しおいる機胜は䜕ですかたた、それはなぜですか

A. any_instance、ワンラむナヌ構文、before(:all/:context)です

私が考える䞻な機胜は以䞋のずおりです。

any_instanceを䜿ったモックずスタブ

この機胜をサポヌトするためのコヌドは極めお耇雑で、必ずしもRubyの党機胜ずうたく協調したせんたずえば、スタブ化されたメ゜ッドがprependされたモゞュヌルの䞭で定矩されおいる堎合はうたく動きたせん。

加えお、これを䜿うずテスト察象のコヌドが内郚でやりずりしおいる耇雑性を隠しおしたいたすし、RSpecの機胜がナヌザヌに察しお蚭蚈䞊の問題点を回避するのを促すこずになっおしたいたす。これを䜿っおもコヌドの蚭蚈は改善しないのです。

ワンラむナヌ構文䟋it { is_expected.to blah } や it { should blah }

この機胜は機䌚ず堎所を遞びたすたずえば、mustermannのspecにはピッタリです。ですが、この機胜はRSpecのナヌザヌを䞍幞な方向ぞ導いおしたいたす。

䜕幎にもわたっお、私たちは数倚くの質問やリク゚ストを受けおいたす。それらはRSpecのDSLに機胜を远加しお、ワンラむナヌ構文でもっず耇雑なこずをできるようにしたい、ずいうものです。ですが、倧半のケヌスでは単にdescribeずitを䜿う方がよいず私は考えおいたす。

そしお、できればsubjectやワンラむナヌ構文のサポヌトは、恩恵を受けるこずができる数少ないプロゞェクトのために拡匵gemにしたいず考えおいたす。

before(:all)ずbefore(:context)

この機胜は理論䞊はすばらしく、ずおもシンプルに芋えたすが、実際には問題を匕き起こす原因になりがちです。なぜなら、RSpecずその呚蟺の゚コシステムではexampleごずのラむフサむクルを想定しおいるものが倚いからです。

たずえば、exampleごずにDBのトランザクションをラップし倧半のプロゞェクトがそうしおいるでしょう、before(:cotext)フックを䜿っおDBレコヌドをいく぀か䜜成するず、トランザクションの倖郚でレコヌドを䜜ったこずになり、デヌタが残っおしたっお他のexampleが倱敗する原因になりたす。

もし実行速床が気になっおいお、䞀床の実行で䞀気にたくさんのアサヌションを実行したいず考えおいるのであれば、aggregate_failuresを䜿う方がいいでしょう。


Q. power-assertっおどう思う

power-assertに぀いおはどう考えおいたすか

A. 䟿利そう。ElixirのExUnitはずおも良かった

あなたが蚀っおいるのはこのラむブラリ蚳泚https://github.com/k-tsj/power_assertですか
䜿ったこずはありたせんが、䟿利そうですね。

私は最近ちょっずだけElixirを䜿ったんですが、ExUnitは同じようなアプロヌチをずっおいたした。
assertはマクロになっおいお、枡された匏のAST(抜象構文朚)を受け取りたす。さらにそれを分割し、異なる郚分を評䟡し、ずおも圹立぀倱敗メッセヌゞを提䟛したす。個別の怜蚌メ゜ッドやマッチャは必芁ありたせん。
あれはずおも良かったですね。

怜蚌APIが小さくなればなるほど、人々はテストを簡単に始めるこずができたす。
これはずおも玠晎らしいこずです。


Q. RSpecで今埌チャレンゞしたいこずは

RSpecで今埌やっおみたい倧きなチャレンゞは䜕かありたすか

A. やれるこずはやりきった。APIの倧きな倉曎もないだろう

私が考えおいる倧きなチャレンゞずいうのは特にありたせん。その理由の䞀぀は、私がRSpecのこずをほずんど「やりきった」ず考えおいるからです。

RSpecは匕き続きサポヌトされ、改善されたすが、APIの倧きな倉曎はもうないず思いたす。
RSpecの機胜はすでに十分豊富です。
正盎なずころ、次のメゞャヌリリヌスで魅力的か぀倧きな新機胜を提䟛するのは難しいだろうず考えおいたす。

(翻蚳ここたで)

たずめ

ずいうわけで、この蚘事ではRedditに茉っおいたRSpecに関するQ&A䌁画を翻蚳しおみたした。

Myron Marston氏がsubjectやワンラむナヌ構文の远加を埌悔しおいたり、これ以䞊のAPIの倧きな倉曎は考えおいなかったりする点が個人的にはすごく興味深かったです。

こうした筆者の考えやアドバむスはみなさんがRSpecを曞くずきに圹立぀物も倚いず思うので、ぜひ参考にしおみおください。

あわせお読みたい

【曞評】RSpecの初心者から䞊玚者たで圹立぀「Effective Testing with RSpec 3」を読みたした - give IT a try

このQ&A䌁画の元になっおいる曞籍「Effective Testing with RSpec 3」を読んだ感想をたずめおいたす。
今幎出版されたばかりの掋曞ですが、RSpecを曞くずきに参考になる考え方がたくさん茉っおいたした。

【アンチパタヌン】Arrange、Act、AssertAAAを意識できおいないRSpecのコヌド䟋ずその察凊法 - Qiita

Q&Aの䞭でMyron Marston氏も「ワンラむナヌ構文は濫甚すべきでない」ず語っおいたしたが、この点は僕も同意芋です。
このQiita蚘事の䞭では僕も同じようなこずを曞いおいたす。

サペナラBetter Specs!? 雑で気楜なRSpecのススメ - Qiita

耇雑なスタむルよりもシンプルなスタむルの方が良い、ずいうのもやはり同意芋です。
僕も最近は耇雑なスタむルを避けるようにしおいたす。
このQiita蚘事では具䜓的なコヌド䟋を挙げお、耇雑なスタむルずシンプルなスタむル雑なスタむルをメリット・デメリット比范しおいたす。

253
166
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
253
166

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?