はじめに
こんにちは、メドピアの駆け出しエンジニアの川﨑です。
最近我が広島カープが日本シリーズ進出を決めて機嫌が良いのでブログ書きたいと思います。
今回僕がお届けするのは、先月の9月14日 「Rails開発での技術的負債との付き合い方」 をテーマに開催された 「MedBeer」 にて、 Classi株式会社のCTOである佐々木 達也(@sasata299)さんの発表にて紹介された「整地部」がMedPeerでもできたよ!というお話です。
整地部とは?
整地部の定義に関しては、以下にある佐々木 達也さん の興奮する資料が分かりやすいです。
一言で言うと
技術的負債となっているコードを少しずつでも良くしたい人たちの集まり
です。
どんな風に進めたか?
記念すべき第一回は、弊社Railsの技術顧問である前島(@willnet)さんがいらっしゃる水曜日に開催されました。
進め方としては、僕が前々から直したいと思っていた箇所を自分なりに修正したPRを作っていたので、そのPRを元にモブプロで洗練させる形をとりました。
今回の整地対象は?
MedPeerでは製薬企業様から医師の方々へ向けた講演会をWeb上で行えるサービスを展開しており、講演会サービスのTOPページではオススメの講演会をスライドで表示しています。
そのスライドに表示する講演会の情報を抽出するロジックが今回の整地対象となりました。
対象となった理由は以下の通りです。
- 講演会の情報を抽出するロジックが少し複雑
- ロジックが書かれているモデルが300行を超え肥大している
- ActiveRecord のメソッドを使えば良いところが散見される
- メソッド/変数/定数の名前がわかりにくい
どんなことをしたのか?
前提として
・ロジックが書かれているモデルが300行を超え肥大している
という問題に辛さを感じていたので、以下前島さんの記事を参考にしつつ、対象の処理を単機能として一つのクラスへ切り出す方針で進みました。
クラスに切り出した後は主に以下のことを行いました。
- 1メソッドでやるべきでない処理を分けてわかりやすくする
- メソッド/変数/定数の名前をいい感じにする
- ActiveRecord のメソッドを使った方が良いところは使うようにする
実例
ここで実際に整地された例を一つご紹介します。
今回クラスへ切り出したコードの中で次のようなメソッドがありました。
def today_conferences(conferences) newly_start_at(conferences.find_all { |c| c.start_at.today? }, TODAY_RECOMMENDATION_COUNT) end def newly_start_at(conferences, limit) conferences.sort_by(&:start_at)[0..limit] end
このメソッドでやりたいことは次の通りです。
- 取得した講演会から当日開催のものだけ抽出
- 開催日の昇順ソート
- 先頭からlimit取得
やりたいことは実装できていますが辛いですね。
今回は ActiveRecord のメソッド where
,order
,limit
を使って次のように修正を行いました。
def today_conferences conferences.where(start_at: Time.zone.today.all_day) .order(:start_at) .limit(TODAY_RECOMMENDATION_COUNT) end
Rubyの世界でのごちゃごちゃした処理がなくスッキリ書けているので、やりたいことが明確になり可読性が上がったかと思います。
実際やってみた感想
実際やってみて特にデメリットは感じないほど良い活動だったと思います。
メリットはたくさんありましたが、個人的に強く感じたことは次の2点です。
- レベルが高いエンジニアの方と一緒にモブプロするのすごい勉強になる
- プロジェクトへ貢献するチャンス(特に僕のような新人エンジニア)
一つ目はそのままの意味で、実装するときの考え方や気をつけることを学べる場にもなると思います。
二つ目についてですが、新人エンジニアは実力的にプロジェクトへ大きく貢献することが難しいと思います。
そういった状況でも、整地部の活動へ積極的に参加することで、技術的負債を作らない方法を学びながらプロジェクトに貢献できる点がメリットだと感じています。
今後はどんな感じで進めて行くのか?
実際に活動してみて割と大きな修正が必要なものが見えてきたこともあり、今後は以下のような方法で活動を進めて行く予定です。
・活動頻度は1回1.5h/隔週 ・大きな修正は技術力の高いエンジニアでモブプロ ・新人エンジニアは上記モブプロを見て勉強したり、自分で修正できる箇所があれば整地する(必要であればペアプロ依頼)
また、工夫ではないですが、整地活動をする上でやっておいた方が良いこととして、以下2点を意識すると良いと思いました。
・新人エンジニア場合、余裕があれば事前に自分なりに修正したPRを作っておく ・小さいもので良いので、1つはPRを作るところまで対応する
今後の活動へ向けた気持ち
当然ですが大きな成果が出たりする活動ではないので、地道に続けていくことが重要だと思います。
佐々木 達也さんの発表でもありましたが、小さな修正を続けて成功体験を増やしていくことがとても重要だと感じておりますので、僕自身も積極的に活動へ参加したいと思っております。
おわりに
今回はMedPeerで始まった新たな取り組みについてのご紹介でした。
技術的負債は作らないのが一番ですが、長くシステムを運用していく中で浮き彫りになってくるものもあるかと思います。
技術的負債に目をつぶらず、積極的に立ち向かうチームが社内にできたことそのものがとても素晴らしいことだと感じています。
今後も負債に負けない柔軟で堅牢なシステムを維持するべく整地部は突き進みます!!!
(☝︎ ՞ਊ ՞)☝︎是非読者になってください
メドピアでは一緒に働く仲間を募集しています。 ご応募をお待ちしております!
■募集ポジションはこちら
https://medpeer.co.jp/recruit/entry/
■開発環境はこちら