OSSにみるレールの外側

Railsを使う大きなメリットの1つは、「ここはこう書く」Rails wayがあることで、（自分を含む）他人が書いたコードでも読みやすい点にあると思っています。このことは、完全リモートワークの弊社でRailsを使う理由のひとつでもあります。
では、同じように地理的に離れた場所にいる多くの開発者が参加するOSS開発の現場において、Rails wayから離れたコードをどのように扱っているのでしょうか？それを知ることはリモートワークでRails開発をする上でのヒントになるかも知れないと考え、今回 GitLab / Discourse / Mastodon という3つのRailsプロジェクトについてコードリーディングを行いました。

Transcript

1. OSS にみる レール の外側 竹内雄一 Takeyu Web Inc.
2. @takeyuweb 2008年〜フリーランス 2016年 法人成り Rails おじさん（Rails 1.0系～） Saitama.rb発起人
3. Takeyu Web Inc.
4. Takeyu Web Inc. フルリモートとフルフレックスにこだ わってるRails受託会社
5. リモートワークとRails リモートワークではコミュニケーション の敷居が高い レールがあることは、リモートに向いて いる（と、思っている）
6. レールに乗る 他人（過去の自分含む）にコードを読 むヒントを与えることができる
7. そんなレールから外れるとい うこと 『常識』が通用しなくなる？ 世界中の開発者が参加するOSSで はどうやっているか？ リモートワークのヒントもあるのでは
8. 今回見たOSS Name Stars Contributors GitLab 21,029 1,545 Discourse 25,573 649 Mastodon 14,031 476
9. 見ること appの中身 rails new したときデフォルトで作 られるもの以外 その他
10. GitLab https://github.com/gitlabhq/gitlabhq 21,029 Stars 1,545 Contributors
11. GitLab のapp (1) finders graphql policies presenters serializers
12. GitLab のapp (2) services uploaders validators workers
13. GitLab のapp いっぱいある！ 独自のディレクトリについて README.md がしっかり書いてある
14. GitLab の xxxx/README.md 読めば使い方はわかる Wikiなど外部リソースへ誘導されな い 必要なときにすぐ存在を見つけられ て良い
15. xxxx/README.md に書いてある こと いつ使うか？ なんで標準のじゃアカンのか 具体的に何が嬉しいか コードの書き方
16. app/presenters/README.md app/presenters/README.md
17. GitLab lib gemで提供されるようなものなど、特定 の目的のために使うクラス群。こちら は README.md はない api Grape::API backup バックアップ処理いろいろ database / file etc banzai Markdown => HTML renderer etc…
18. GitLab その他 Migration の spec 独自Cops 整理された routes
19. Migration の spec db/migrations/*.rb ごとに実行前後 どうなるべきか？の spec がある db/migrate/ 20170713104829_add_foreign_key_to_m erge_requests.rb spec/migrations/ add_foreign_key_to_merge_requests_sp ec.rb
20. 独自Cops プロジェクトでやってはいけないこと、 やるべきことについてCopsで指摘して れる
21. RuboCop::Cop::GitLab::Find erWithFindBy rubocop/cop/gitlab/ finder_with_find_by.rb # 通常こうやって #execute を使うんだけど results = DummyFinder.new(some_args).execute # find_by と組み合わせて使うときは DummyFinder.new(some_args).execute.find_by!(1) # こう書くようにしようね DummyFinder.new(some_args).find_by!(1)
22. 独自Cops の spec spec/rubocop/**_spec.rb 独自Copsが具体的になにを警備して いるかわかりやすくてよい
23. 整理された routes (1) config/routes.rb Rails.application.routes.draw do # (snip) draw :api draw :sidekiq draw :help
24. 整理された routes (2) config/routes/api.rb GraphQL と REST API constraints(::Constraints::FeatureConstrainer.new(:graphql)) do post '/api/graphql', to: 'graphql#execute' mount GraphiQL::Rails::Engine, at: '/-/graphql-explorer', graphql_path: '/api/graphql' end API::API.logger Rails.logger mount API::API => '/'
25. GitLab のまとめ 「うちではこう書いてください」みたい なの、多い 理由と書き方について詳しく説明があるの で辛くはない Rails標準におけるActiveRecordの 書き方みたいに、GitLabのFinderの 書き方のような決まり事がはっきり している 独自Copで決まり事を守っているか
26. GitLab のまとめ 意識高い（系ではない）印象
27. Discourse https://github.com/discourse/ discourse 25,573 Stars 649 Contributors
28. Discourse の app (1) serializers services
29. Discourse の app (2) app を見ても 「ウッ」ってならない 標準のようでそうでもないものもあ る app/jobs
30. Discourse の app/serializers active_model_serializers gem
31. Discourse の app/jobs (1) ActiveJobではない include Sidekiq::Worker した共 通の基底クラスを持つクラス群 それなりに厚い 独自の仕組み Job::Base#execute
32. Discourse の app/jobs (2) readonly modeへの対応 onceoff
33. Discourse の app/jobs 追加 ディレクトリ名かぶりは ActiveJob が後からだからでは ActiveJob に機能が足りないから仕 方ない わかる 別にそれ自体はよい、ActiveJobで済むな らそれでいいが、だめなら他の方法は否 定しない
34. Discoures の app/services 自由に作られている印象。基底クラス や .new.execute のような決まりはな い。カオス。 UserMerger SearchIndexer HandleChunkUpload DestroyTask
35. Discourse の lib scheduler validators wizard auth/authenticator etc
36. Discourse の その他 Danger
37. Danger Danger http://danger.systems/ CI上で動作、PRに対して自動で指 摘 PR自体の問題「テスト書いてないけ ど？」「こんなのレビューできないよ」 みたいなの ルールをRubyで書ける （Dangerfile。次ページ。）
38. Discourse の Dangerfile （抜 粋） if git.lines_of_code > 500 warn("This PR seems big, we prefer smaller PR. Please be sure this is needed and can't be split in smaller PRs.") end
39. Discourse のまとめ 「うちではこう書いてください」みたい なのはあまりない なるべくレールに載る意識を感じる app/services にモヤモヤ
40. Mastodon https://github.com/tootsuite/ mastodon 14,031 Stars 476 Contributors
41. Mastodon の app chewy lib policies presenters serializers services validators
42. Mastodon の app/chewy chewy gem Elasticsearch
43. Mastodon の app/lib なぜ Rails.root.join("lib") で ないのか？よくわからない lib はほとんど使っていない
44. Mastodon の app/lib について 追記 /lib だとオートリロードが働かない Railsの /lib はタスクを書く場所み たいな雰囲気があるので /app 以 下に置く気持ちはわかる
45. Mastodon の app/policies 権限管理 pundit gem
46. Mastodon の app/presenters ActiveModelSerializers::Model だったりそうでなかったり シリアライズに使ったり、 ActiveRecordモデル間の関係（フォ ロワー、ブロック etc..）を表示用に まとめたり
47. Mastodon の app/serializers active_model_serializers gem
48. Mastodon の app/services パブリックなインスタンスメソッドは #callのみ class HogeService < BaseService HogeService.new.call(arg1, arg2, arg3)
49. Mastodon の app/workers Sidekiq::Worker
50. Mastodon の まとめ app/services は読みやすいし、使 い方がはっきりしていて心理的負担 が少ない が、他はなんだかよくわからん bundle install がなかなか通らな くてつらい
51. 余談：脱線事故（僕の失敗） 記事で読んだから試しに使ってみた あとから別にいらなかった そもそも正しく使えてない ルールが明確でなく各自自由に書 いちゃう→カオス 依存gemが増えてアップデート辛い
52. まとめ フレームワーク的に使ってほしいも のは app 直下、そうでないものは lib 本当に必要か？ 新しいレールを敷く 人は弱いので RuboCop Danger な どツールの力を借りる
53. 宣伝（1） Saitama.rb やってます！ 埼玉県在住のRubyist 毎月第3土曜日 13:00～ 大宮駅東口徒歩1分 初心者から（ときどき）Railsコミッ ターまで
54. 宣伝（2） Rails受託案件募集してます！ 11月～ぐらい 週3～ リモート 準委任（条件はご相談ください）