【Rails】rake taskの作成とnamespace/task名の一手間プラクティス

こんにちは。

気がついたらもう冬です。気がついたらもう1年が終わります。
仕事もプライベートも紆余曲折を経て、成長を実感した1年でした。

どうもハチマキです。

はじめに

毎度悩む命名。rake taskを実装して感じた一手間プラクティス（こう書いたらわかりやすいかな）について書いていきます。サクッといきます！

rake taskの実装方法

こちらの記事を参考にさせて頂きました。非常にわかりやすかった。
RailsでRakeタスクの作成 - Qiita

namespace/task名の付け方ポイント

lib/tasks/hoge.rake

namespace :hoge do
  desc 'hoge の値を一括更新する'
  task : hoge_update_all do

file名(tasks/〇〇.rake) = namespaceは、シンプルかつ抽象度の高い命名にする

なぜか？

file名(tasks/〇〇.rake) = namespaceとtaskは、親子関係のような立ち位置だと考えたため

つまり、親要素にあたる file名(tasks/〇〇.rake) = namespaceを具体的な命名（例えば：hoge_update_all）にすると、複数taskが存在した場合に、命名の可読性が一気に落ちる。
よって、抽象度の高い命名の方がベターだと考えた

task名は、シンプルよりも具体的な命名にする

なぜか？

rake taskが複数にわたって作成された際、直感的に理解できる命名だと、深くコードを読む必要がなくなる。つまりコードリーディングの時間を削減できるから

ポイントは、「シンプルよりも具体的にする」ということです。つまりtaskを実行するとどんな処理が走るのか、詳細がわかる命名がベターと考えた

個人的には、この一手間があるかないかは、非常に重要だと感じた

• • • • • • • • • • • • • • • • • • • • • • -

最近のマイブームは、読書になりました。日々勉強です。

以上、ハチマキでした。