Rubyコーディング規約をいくつか調べた。 下記のコーディング規約は、日本語で記載されていて読みやすかったので参考にした。 github.com fork 元のドキュメントのほうが最新更新が新しいので気になった部分のソースも確認した。 github.com 構文 否定形のときはifよりunlessが好まれます。(もしくは||構文を使いましょう)。 本文が１行のときは、if/unless修飾子を利用するのが好まれます。 他の良い代替案としては&&/||を使った制御構文があります。 unlessをelse付きで使ってはいけません。 肯定条件を先にして書き換えましょう。 unless および unt…

やりたいこと RSpec用のRubocopを導入してRSpecのお作法を学び、導入する 導入方法 通常のRubocopと同様です。 gemの概要については公式リポジトリを見てください。 github.com Gemfileにrubocop-rspecを追加します。 # Gemfile group :development, :test do gem 'rspec-rails', require: false gem 'rubocop-rspec', require: false end .rubocop.yml にgemを読み込むように追記します。 # .rubocop.yml require…

こんにちは。メディアサービス開発部 Webアプリケーション開発課のシゲタです。 以前このブログでRuboCopのカスタムルールを作成する方法についての記事を書きました。 https://developers.bookwalker.jp/entry/2023/03/31/174906 カスタムルールとは個別のプロジェクトやチームのコーディングスタイルに合わせたRuboCopの拡張ルールのことです。 この記事を書いてから約一年程が経ち、私が参画しているプロジェクトでも実際にカスタムルールを運用し始めました。 今回は実際にカスタムルールを導入して得られた効果について紹介したいと思います。 カスタムル…

こんにちは。ソリューション技術部OTTサービスソリューション統括部LOGICAプロダクトグループの田上です。 最近、チームリーダー的な立場でソースコードレビューすることも多く、また不具合発生などにより過去の処理を読み解くことがよくあります。 その際、複雑でわかりにくいコードなどがあると処理を追うのに時間がかかり、また複雑なコードほどバグが発生する確率が高いです。 現在、私が使用しているRubyにはRubocopというコーディング規約を設定してチェックするツールがあります。 github.com Rubocopを導入するとコーディング規約で制限するので、全体的に書き方が統一され第三者が見たとき読…

タイミーでバックエンドエンジニアをしている新谷 id:euglena1215 です。 今回は社内で決めたコーディングルールに強制力を持たせるために CustomCop を作った話を紹介します。 背景 タイミーの Rails アプリケーションには /app/services ディレクトリがあり、 Service クラスが存在しています。 これまで社内で Service クラスは、なるべく使わない方が好ましいものの、どんな時に使っていいかは特段明言されていない状況でした。 その結果かは分かりませんが、一部の機能では Service クラスを多用し Service クラスが Service クラスを…

こんにちは。株式会社バトンズでエンジニアをしている鈴木です。 先日開発中にハマった出来事についてご紹介します。 要約 RubyMine 2023.3から、RuboCopのサーバーモードがサポートされるように RuboCopのサーバーモードのプロセスが起動していると、lint-stagedで実行したRuboCopが終了しない lint-stagedでRuboCopを実行する際に、--no-serverオプションを付与して解決 問題発生：RuboCopが終わらない・・・ 弊社バトンズのとあるサービスの開発では、Ruby関連のファイルのコミット時に、gitのpre-commitフックの仕組みで、Ru…

こんにちは、技術本部 Eight Engineering Unit でエンジニアをやっている茂木です。 普段はSansan株式会社で正社員としてフルコミットしつつ、情報系の大学に通っています。 今回は Reviewdog x RuboCop を使って、ローカル環境で Lint をかける機構を Eight に導入した話をしていきます。