Subscribed unsubscribe Subscribe Subscribe

鳩舎

レースしない

mount_doc という gem を公開しました

こんばんは、ニコニコ静画(電子書籍)でマンキンが無料で読めます!

さて、ということで社内で使っていたモジュールをもうちょい一般化した、mount_docというgemをリリースしました。

https://rubygems.org/gems/mount_doc

これは何をするのかいまいちぱっとわからない方向けに、サンプルのRailsアプリを作っておいたので、そちらを参考にしつつ読んでいただけると幸いです。

https://github.com/rosylilly/mount_doc_sample

git clone して bundle install して rails s してください。

なにをするのか

Railsアプリのコントローラのアクションに書かれたコメントからURLベースのドキュメントを生成します。

URLに紐付くドキュメント生成ツールがなかったのと、チームのエンジニアにwikiかけって言ってもホントに書くかわかんないし、人の書いたドキュメントをちゃんと読むかわからないし……(いや読んでくれるんですけど、そういうの強要するのエンジニアリングとして正しいんか?というのもあり)ということで、ならソースコードに埋め込んだれや、ということで作りました。

基本的にはYARD(yet another ruby documentation)の記法を元にしており、doc以下のファイルも読み込んで表示するので、Rails標準の rake doc と相性が悪いです。

あと、RailsってWAFなんだし、そのアプリ上にマウントして見れるようになってりゃいいじゃん。ということで routes.rb でマウントしています。現在独立して動くようにはなっていないので、それは考えどころだなぁ、という感覚。

とりあえずドキュメントを書かない・読まないのは不健全だと思うので、出来れば書くように、しかも勝手に目に入るようにしよう!ということでできたgemでした。