🛤️

今から Rails 6.x アプリケーションをつくるなら入れておきたい Gem やテクニック | 2020年10月版

2020/10/22に公開

Rails

tech

2022/1/31 追記
いまだにこの記事のPVがあるので Rails アプリケーション作るときに参考になりそうなリンクを追記しておきます。

【Rails】もっと早く知りたかったデバッグ用gem 'better_errors','binding_of_caller' | Qiita
- https://qiita.com/terufumi1122/items/a6f9a939dce25b2d9a3e
【Rails】better_errorsとbinding_of_callerで自分でエラーを解決できるようになろう【初心者向け】 | Qiita
　　- https://qiita.com/ryokky59/items/284892be879996e4f77c
Railsにおけるドメイン駆動設計の実践 | linyclar
　　- https://linyclar.github.io/software_development/ddd/rails/
Railsメモ | linyclar
- https://linyclar.github.io/rails_memos/
Ruby on Railsをかんたんスピードアップ | Techブログ | MNTSQ, Ltd.
- https://tech.mntsq.co.jp/entry/fast-ruby-on-rails
railsのdefaultでは用意されていない考え方や設計、リファクタリングについてのリンク集 | Qiita
- https://qiita.com/tos-miyake/items/8dffb16273726f538d49
お前らがModelと呼ぶアレをなんと呼ぶべきか。近辺の用語(EntityとかVOとかDTOとか)について整理しつつ考える | Qiita
- https://qiita.com/takasek/items/70ab5a61756ee620aee6

完全に偏った方針ですが、あくまで主観的な話で一般論ではないと言い訳した上で……

@ハックは使わない

Controller で @hoge に値を保持させておいて View で参照するのが rails way.
しかしこれが View で参照している物の把握を困難にする。
Controller の public method でやってしまうのはどうかという提案が以下。
Controller で render json.. とするだけのAPIなら不要。

参考
Removing the @ Hack in Rails Controllers - Medium
- https://medium.com/@eric.programmer/removing-the-hack-in-rails-controllers-52396463c40d
Rails: 提案「コントローラから@ハックを消し去ろう」（上記翻訳） - TechRacho
- https://techracho.bpsinc.jp/hachi8833/2018_06_14/58056

gem sorbet-rails で静的型チェックを導入

Ruby の動的型付けは便利だがエンジニアの途中参入時に混乱を生みやすい。
Ruby3 でも静的型チェックが導入されるが、当面 rails は ruby2.x なので
Sorbet を導入することで実現できる

参考
chanzuckerberg / sorbet-rails
- https://github.com/chanzuckerberg/sorbet-rails
Sorbetで「型のあるRuby」の開発体験を試そう
- https://blog.5thfloor.co.jp/2019/07/23/experiment-ruby-type-checking-with-sorbet/

リクエストパラメータのバリデーションは入れておく

参考
Rails でリクエストパラメータのバリデーション -
progrhyme's Tech Wiki
- Parameter クラスを作るなら
  - Railsにparameter層を導入する - Qiita
    - https://qiita.com/KentFujii/items/ec6fb21b34111fa7ec98
- バリデーションを助けてくれるgemを併用するのもいいかも（やりすぎぐらいがちょうどいい気がする)
  - https://github.com/nicolasblanco/rails_param
後述する gem committee を使うのもいい

手段はなんでもいいので swaggerUI を導入しておく

APIドキュメントがない状態で開発を続けるのは辛い。
今からRailsアプリケーションを始めるなら以下記事などを参考にスキーマ駆動開発で進めるのがいいだろう
gem committee を使ったRequest validation も視野に入ってくるので上記リクエストのバリデーション対応も不要になってくる。
OpenAPI generator でAPI定義を自動生成するような準備までやっておければ
開発効率にも貢献しやすい

Rails + RSpec + OpenAPI3 + Committeeでスキーマ駆動開発を運用するTips
- https://tech.timee.co.jp/entry/2020/07/05/150312
ぼくのかんがえたさいきょうのAPIドキュメント運用
- https://qiita.com/sakuraya/items/37e73581e90e137b6487
RailsのAPI開発にスキーマ駆動開発を導入して、品質と開発スピードを高める
- https://developers.freee.co.jp/entry/schma-driven-api
APIがカオスってたプロダクトでOpenAPI対応やってみた
- http://tolarian-academy.net/openapi-in-chaos/

とはいえ私個人はrswagで生成して SwaggerUI で確認するって方式も好きなので紹介まで

とにかくRails6でrswagを動かす - Qiita
- https://qiita.com/cheekykorkind/items/6c28832fe23938a92b50
Adding Swagger Docs to a Rails 6 API Using Rswag
- https://medium.com/@clarkjohnson_85334/adding-swagger-docs-to-a-rails-6-api-using-rswag-a3e8bc577986

そのほかGem

認証認可は device で安定
- https://github.com/heartcombo/devise
- 権限をつけたいなら cancancan
- https://github.com/CanCanCommunity/cancancan
- [Rails5]cancancanってなんぞ？ - Qiita
ransack はやはり便利
- Ransackのススメ - Qiita
WebAPI を作るならResponseの作成に jbuilder
- https://github.com/rails/jbuilder
- https://github.com/brianmario/yajl-ruby
- CORS 対応するなら rack-cors
- RailsでAPIにCORSを設定する - Qiita
- https://github.com/cyu/rack-cors
N+1 問題の検知には bullet
- https://github.com/flyerhzm/bullet
静的コード解析に rubocop
- rubocop-hq / rubocop-rails
  - https://github.com/rubocop-hq/rubocop-rails
- 【Rails】RuboCop 導入編（2020年10月版） - Qiita
  - https://qiita.com/piggydev/items/074e020e07af7ebc872d
- rubocopとは？ - Qiita
  - https://qiita.com/freestylehh46/items/f8dae4b962df681ed2ad
- RuboCop is 何？ - Qiita
  - https://qiita.com/tomohiii/items/1a17018b5a48b8284a8b
binding.pry が使えないとデバッグが辛すぎるので pry-rails
- pry-debugger もいる
  - これから Rails プロジェクトつくるなら pry-byebug かも
- スタックとレースも見たいなら pry-stack_explorer もいる
  - show-stack でスタックトレースみれるようになる
ユニットテストは rspec-rails
- https://github.com/rspec/rspec-rails
- RailsアプリへのRspecとFactory_botの導入手順 - Qiita
- Request Spec 書くなら rspec-request_describer も
- めんどくさいメールアドレスなどのダミーデータ生成には faker
  - https://github.com/faker-ruby/faker
- rspec での json のマッチングがダルいので rspec-json_matcher
  - https://github.com/r7kamura/rspec-json_matcher
  - rspec-json_matcherでJSONの検証を自由自在に行う - Qiita
- テストごとにDBをきれいにしたいので DatabaseRewinder
  - https://github.com/amatsuda/database_rewinder
Modelの自動コメント記述に Annotate
- https://github.com/ctran/annotate_models
- よう太の冒険: yardとannotateとkramdownでドキュメントに革命を起こす編 - ネオキャリア
ログ関連