【Rails】Rakeタスクの基本情報と作成・実行方法

はじめに

Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。

RailsアプリにおけるRakeタスクの使い方としては、リリース後にスポットでデータを投入したり、wheneverというGemと組み合わせて定期実行したい処理を定義したりといったことができます。

本記事では、Rakeタスクの作成方法や実行方法について説明します。

Rakeタスクの基本情報

Rakeのインストール

RakeはRailsに標準で同梱されていますが、何らかの理由でインストールされていない場合、Gemfileに以下を追記してbundle installを行います。

Gemfile

# 以下を追記
gem 'rake'

Rakeをインストールすると、プロジェクト直下にRakefileという設定ファイルが作成されます。Rakeの設定を変更したいときはこのファイルを修正します。

Rakefile

# Add your own tasks in files placed in lib/tasks ending in .rake,
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.

require_relative 'config/application'

Rails.application.load_tasks

Rakeタスクの確認

実行可能なRakeタスクの一覧を確認するには、以下のコマンドを実行します。

$ rails -T

上記のコマンドを実行すると、自分で作成したRakeタスクを含むRakeタスクの一覧が表示されます。一覧の中には、Railsに組み込まれているRakeタスクも含まれています。rails db:migrateなどいつも使用しているコマンドの実態は、Railsに組み込まれているRakeタスクだということがわかります。

なお、上記のコマンドはタスクの説明(description)が存在するRakeタスクのみを表示します。Railsに組み込まれているRakeタスクのうち、バージョンアップにより使用が非推奨となったRakeタスクについては説明が削除されており、上記のコマンドでは表示されません。説明のないRakeタスクも含めて一覧を確認するには、以下のコマンドを実行します。

$ rails -AT

指定可能なすべてのオプションを確認するには、以下のコマンドを実行します。

$ rake -H

Rakeタスクのヘルプのため、railsコマンドではなくrakeコマンドを使用していることにご注意ください。railsコマンドとrakeコマンドの違いについては、下記の「rails vs rake」セクションを参照してください。

rails vs rake

Railsにはrailsrakeという2つのコマンドがあります。Railsを始めたばかりの初学者にとって、なぜコマンドが2つあるのか、違いは何なのかがわからず、混乱してしまうかもしれません。

結論から言うと、Rails 5以降を使っているならrailsコマンドに統一して問題ありません。Rails 4までは、コマンドの種類によって2つのコマンドを使い分ける必要があったのですが、それでは面倒だということで、Rails 5からrailsコマンドに統一されました。

特にRakeタスクの解説記事なんかでは未だにrakeコマンドを使っている例が非常に多いのですが、Rakeタスクの実行だからといってrakeコマンドを使う必要はありません。将来、もしかしたらrakeコマンドが廃止され、完全にrailsコマンドに統一される可能性を考えると、なるべくrakeコマンドは使わないようにしたほうがいいでしょう。

Rails 5からrailsコマンドに統一されたため、rakeコマンドを使って解説している記事は情報が古い可能性があります(Rails 4までの情報の可能性がある)。もし、rakeコマンドを使っている情報を見つけた場合は、あまり参考にしないほうが無難かもしれません。

なお、Rails 4までrailsrakeをどう使い分けていたかについて詳しくは以下の記事を参照してください。

Rakeタスクの作成方法

Rakeタスクの作成

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

$ rails generate task articles

articlesは作成するタスク名を指定します。ここで指定したタスク名は、作成されるタスクファイルの名称になり、また、デフォルトの名前空間にもなります。名前空間については後述しますが、Rakeタスクの実行にも関わってくるため、それを踏まえて命名したほうがいいでしょう。とはいえ、ファイル名にしろ名前空間にしろ、作成後に変更することはできるので、この時点ではあまり深く考えなくても大丈夫です。

上記のコマンドを実行すると、lib/tasks/ディレクトリ配下にarticles.rbというファイルが作成されます。

articles.rb

namespace :articles do
end

Rakeタスクの構成

一般的なRakeタスクの構成は以下の通りです。

articles.rb

namespace :articles do
  desc 'Insert records into articles'
  task :insert_data do
    ...
  end

  ...
end

namespaceは名前空間を指定します。命名規則などは特にありませんが、ブロック内の各タスクを包括する名詞がいいでしょう。

descはタスクの説明を記述します。日本語でも構いません。省略することもできますが、説明のないタスクはrails -Tコマンドで一覧に表示されないのでご注意ください(詳細は「Rakeタスクの確認」セクションを参照してください)。

taskはタスクの名称を指定します。命名規則などは特にありませんが、当該タスクが実現する動詞がいいでしょう。

Rakeタスクは以下のようにコマンドを実行します。

$ rails articles:insert_data

このように、名前空間とタスクの名称がちょうど主語と述語のようになっており、コマンドを見ただけで何に対して何をするのかが一目瞭然です。Rails組み込みのタスクを例に挙げると、rails db:migratedbに対してmigrateを行うタスクであることがすぐにわかります。

Rakeタスクの実装

作成したRakeタスクに処理を追加していきます。今回は例としてDBに任意のデータを作成するタスクを実装します。

articles.rb

namespace :articles do
  # 以下を追記
  desc 'Insert records into articles'
  task :insert_data => :environment do
    records = [
      {
        title: 'title-1',
        content: 'content-1'
      },
      {
        title: 'title-2',
        content: 'content-2'
      },
    ]

    begin
      current = nil
      ApplicationRecord.transaction do
        records.each do |record|
          current = record
          Articles.create!(
            title: record[:title],
            content: record[:content],
          )
        end
      end
    rescue ActiveRecord::RecordInvalid => e
      puts e
      puts current
    end
  end
end

RakeタスクでActiveRecordを扱う場合、task:environmentオプションをつける必要があります。

新規レコードの作成や既存レコードの更新/削除を行う場合、まずbegin 〜 rescue 〜 endブロックを置き、その中にApplicationRecord.transaction 〜 endブロックを置き、さらにその中でレコード処理(作成/更新/削除)を行うようにします。

レコード処理中にエラーが発生した場合、まずApplicationRecord.transaction 〜 endブロックで例外が捕捉され、トランザクションのロールバックが行われます。ロールバックが完了すると再び例外が投げられ、今度はbegin 〜 rescue 〜 endブロックで例外が捕捉され、rescueの処理が実行されます。

レコード処理(作成/更新/削除)は、必ずcreate! update! destroy!を使用します。create update destroyはエラーが発生したときに例外ではなくfalseを返すため、例外を捕捉することができません。

Rakeタスク内で別のRakeタスクを実行

あるRakeタスクから別のRakeタスクを実行する必要がある場合、以下のように実装します。

namespace :tasks do
  task :task_1, [:word] do |_, args|
    puts "Hello, #{args.word}"
  end

  task :task_2 do
    Rake::Task['tasks:task_1'].invoke('Rails')
  end
end

これらのRakeタスクは以下のように実行することができます。

$ rails tasks:task_1[Ruby]
Hello, Ruby

$ rails tasks:task_2
Hello, Rails

Rakeタスクの実行方法

Rakeタスクの実行

Rakeタスクは以下のようにコマンドを実行します。

$ rails articles:insert_data

Rakeタスクに引数を渡す

例えば、以下のような引数を受け取るRakeタスクがあるとします。

articles.rb

namespace :articles do
  # 以下を追記
  desc 'Insert records into articles'
  task :insert_data, [:title, :content] => :environment do [_, args]
    begin
      ApplicationRecord.transaction do
        Articles.create!(
          title: args.title,
          content: args.content,
        )
      end
    rescue ActiveRecord::RecordInvalid => e
      puts e
      puts args
    end
  end
end

このタスクを実行するには、以下のコマンドを実行します。

$ rails articles:insert_data[title,content]

注意点として、引数の間にスペースを含めることはできません。insert_data[title, content]のように引数と引数の間に半角スペースが含まれているとエラーとなります。

Rakeタスクで引数を受け取る他の方法として、STDIN.getsを使用して対話的にRakeタスクを実行することもできます。

まとめ

Rakeタスクの使い方としては、リリース後にスポットでデータを投入したり、wheneverというGemと組み合わせて定期実行したい処理を定義したりといったことができます。

スポットでデータを投入するようなタスクは、特定のタイミングでしか実行されない(=使用頻度が低い)ため、ローカル環境やステージング環境で正常に動作することを確認するだけでも問題ないと思いますが、定期的に実行するタスクは厳格にテストファイルを作成したほうがいいでしょう。

本記事を参考にして、Rakeタスクを活用していただければと思います。

関連記事

【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58