データベース定義書という本来は不必要だと個人的に考えるドキュメントをいかにして自動生成するか？ 作成したタスクはこちら https://gist.github.com/ayasuda/d5c03783e29f3ddb21b9

1. データベース定義書の更新っ
て再考の仕事ですよね！
やすだあつし

2. この発表は、rails アプリ
を作っているとある開発者
に起きたフィクションです

3. 「データベース定義書」
とは？

4. こういうの

5. 俺たちのExcel

6. 作らなくてよくね？

7. DHH「ドキュメント？書かな
いよ？そんなん頑張るなら、もっ
といいコード書けば？」（意訳）

8. せやな

10. 100+ tables

11. （仮）
同人誌のネット印刷サービスで、ページ
ごとに用紙とカラー・白黒を変えられる。
で、その印刷申し込み時に記録された発
注書のページごとの用紙・カラー記録テー
ブル

12. print_order_sheet_pap
er_items

14. 日本語、便利だね。
((ただし日本人に限る))

15. migration_comments
annotate_models

17. RDoc ならこんな感じ

18. YARD ならこんな感じ

19. rails-erd

21. これで見やすいかな？

22. ※「これじゃ開発者しか見な
いよね？」
※「エクセルでください」

23. 仕方がないので
rake task を書く。

24. (Gem にしたかったけど時間が足りな
くてできなかったとか言えない)
https://gist.github.com/ayasuda/
d5c03783e29f3ddb21b9

25. klasses
=
Dir[“app/models/**/*.rb”].
reject{|f|
f[‘concens/‘]}.
map{|f|
f.gsub(/^/app/models/(.+?).rb$/,
‘1’).
map{|m|
ActiveSupport::Inflector.camelize(m)}.
map{|k|
ActiveSupport::Inflector.constantize(k)}
こんな感じのコードで
ActiveRecord なクラスは取
れるので・・・

26. if
klass
<
ActiveRecord::Base
&&
!klass.abstract_class?
&&
klass.table_exists?

27. klass.columns.first.name
table_comment
=
klass.connection.retrive_table_comment(klass.table
_name)
column_comments
=
klass.connection.retrive_column_comments(klass.tab
le_name)
あとはklass.columns とかからいろい
ろ取得すればOK.
MigrationColumns 入れてれば、コメ
ントもこれで取れます。

28. あとは、
rubyXLで、テンプレー
トにあたい埋め込み
or axlsx で定義書作成

29. $rake dbdoc

31. こんな感じ？（できる
かな）

32. まとめ
• エクセルなんてなくなればいいのに
• はやくマイクロサービス化して、１アプリあたり２０
テーブル程度にしようぜ。そうすればこんな面倒なこ
とにならなかったと思うんだよね。やっぱり、文書
化ってなんかSEくさくて良くないとおもうんだ。
• サンプルコードは willnet/awesome_events を使わ
せていただきました。本当に有難うございました！