LoginSignup
8

posted at

updated at

リニューアルしたRSpecの公式ドキュメント(旧Relish)を読む方法

はじめに

RSpecではこれまで https://relishapp.com/rspec というサイトで公式ドキュメントが公開されていました。しかし、このページはいろいろあって現在はアクセスできません。

「いろいろあって」はざっくり説明するとこんな感じです↓

しかし、先日めでたくこの公式ドキュメントが復活しました🎉
この記事ではこの公式ドキュメントのアクセス方法を説明します。

新しい公式ドキュメントを読む方法

https://rspec.info/ から "View Documentation" のリンクをクリックします。

Screenshot 2023-03-22 at 17.15.13.png

もしくは https://rspec.info/documentation/ に直接アクセスします。

すると以下のようなページが表示されます。

Screenshot 2023-03-22 at 17.18.46.png

僕は「で、ここからどうしたらいいの?? :thinking: 」と思ってしまったんですが、"Examples"の欄にマウスカーソルを当てると、バージョン選択のメニューが表示されます(といっても以下の表示例ではバージョン3.12のひとつだけです)。

68747470733a2f2f71696974612d696d6167652d73746f72652e73332e61702d6e6f727468656173742d312e616d617a6f6e6177732e636f6d2f302f373436352f30376333663462302d653161642d666433662d633866382d3965633731613732616334612e706e67.png

ここでプルダウンメニューから読みたいバージョンをクリックすると、以前 https://relishapp.com/rspec で公開されていたものと同じ公式ドキュメントを参照することができます。

Screenshot 2023-03-22 at 17.22.07.png

上の例で表示しているページには https://rspec.info/features/3-12/rspec-core/ で直接アクセスすることもできます。

https://relishapp.com/rspec の頃と同様に、ドキュメントは

  • rspec-core
  • rspec-expectations
  • rspec-mocks
  • rspec-rails

の4種類に分かれているので、それぞれプルダウンから選択可能です。

Screenshot 2023-03-22 at 17.27.51.png

もしくはドキュメント右上のプルダウンメニューから、表示したいドキュメントを切り替えることもできます。

Screenshot 2023-03-22 at 17.28.59.png

参考までに、各ドキュメントへの直リンクを以下に貼っておきます。

Q. RDocとExamplesの違いは何?

以下の"Documentation"欄には"RDoc"と"Examples (Relish / Gherkin)"があります。

Screenshot 2023-03-22 at 17.18.46.png

RDocの方を開くと、RSpecのAPIドキュメントが表示されます。

Screenshot 2023-03-22 at 17.33.14.png

どちらも公式ドキュメントであることには違いはないのですが、個人的に実践的なユースケースに沿ったRSpecの記述例が載っている"Examples"(以前のRelish)を参照することが多いです(RDocを見に行くことは滅多にないかも?)。

まとめ

というわけで、この記事ではリニューアルしたRSpecの公式ドキュメントを読む方法を紹介しました。

復活までもっと時間がかかるかと思いましたが、思ったより早く復活してくれて良かったです。

Matt Wynne氏、およびRSpec開発チームのみなさん、どうもありがとうございます!!

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
What you can do with signing up
8