【Ruby on Rails】Rakeタスクの実装について解説します

Ruby

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 Ruby on RailsでRakeタスクの実装について丁寧に解説します。
Rakeタスクを新規作成するコマンドは、以下の記事をご参考ください。

前提条件:実行環境について

実行環境は以下の通りです。

OS Windows10
Rubyのバージョン 2.6.6
Ruby on Railsのバージョン 6.0.3.5

この記事ではRuby on Railsのプロジェクトは

C:\rails_study\sample

に作成しています。

Rakeタスクの実装について解説

Rakeタスクの実装について解説します。

Rakeタスクは、以下のように実装します。

上記サンプルのざっくりとした意味は下記になります。

上記の中で

  • namespace
  • desc

をピックアップして解説します。

namespaceとは

【namespace】とは、名前空間です。
名前空間を一言で言うとグループ化です。
【namespace】をうまく使って分けると、管理するのがとても楽になります。

ちなみに名前空間は入れ子にすることも可能です。

descとは

【desc】とは、「description」のことで和訳すると説明です。
意味の通りここにRakeタスクの説明を記載します。
サンプルには英字で記載していますが、日本語もOKです。

作成したRakeタスクを確認する

この記事ではファイル名が【sample_task.rake】で、以下の内容のRakeタスクを作成したとして進めます。

Rakeタスクの作成が完了したら、正しく定義できているかを確認します。
確認する方法は、railsコマンドを一覧で表示させれば確認できます。
railsコマンドは

です。
詳しくは、こちらの記事をご参考ください。

コマンドをたたいて表示された一覧のなかに

と表示されているので、正しく定義できていることを確認できました。

作成したRakeタスクを実行する

作成したRakeタスクを実行します。
実行するためのコマンドは

で表示されていたコマンドです。

この記事だと

をたたくと

と表示されたので、正しく動くことが確認できました。

まとめ:Ruby on RailsでRakeタスクの実装してみよう

以上がRuby on RailsでRakeタスクの実装の解説でした!

あなたのご参考になったのなら、とても嬉しいです(*´▽`*)
ではでは~(・ω・)ノシ

コメント

タイトルとURLをコピーしました