何の因果かわかりませんが、お仕事でちょっと賢いリバースプロキシサーバ（以降、RPサーバ）を作る機会が２回ありました。
HTTPヘッダの内容によってプロキシ先のサーバを動的に切り替えるようなものです。
この要件を満たすため、RPサーバには以下のようなプログラムが必要になります。
１回目はRubyとI/O多重化のライブラリを使ってイベント駆動型のRPサーバを自作してみました。
が、振り返ってみるとこれは失敗でした。
プログラマがあまりやりたがらない作業のひとつとしてドキュメント作成がよく挙げられるかと思います。
〇〇仕様書とか〇〇設計書とか〇〇手順書などの作成作業ですね。
特に成果物がdocxやxlsxのようなプレーンテキストでない場合、次のような理由で気が滅入る方も多いのではないでしょうか。
Markdownでさくっと書いてそれっぽいものができれば、GitHubのWikiなどにぼちぼち書き溜めておいて最後にコンパイルするみたいなやり方ができるなぁとか、そうすればわざわざドキュメント専用リポジトリを作ったりする必要もないなぁとかモヤモヤしながらいろいろ調査・検討したので以下の4構成でまとめたいと思います。
チームで開発する際はコーディング規約を決めて行うことが多いと思います。
実際に書いたコードが規約に従っているかどうかを検査するため、筆者はRuboCopを使用しています。
コーディング規約そのものはWeb上に公開されているものを参考にして決めていますが、制限が厳しすぎる等の意見がチーム内であった場合は適宜規約を調整しています。
最近チーム内でABCSizeに基づく警告を出す閾値がもう少し高くても良いのではという意見が出たことをきっかけにいくつかのアプリケーションでの例を調べたので紹介します。