Ruby on Rails の Command Line は豊富で、開発や運用に必要なタスクが揃っています。
カスタム Rake タスクも便利で、開発や運用に必要なタスクを追加することができます。
カスタム Rake タスクの数が増えると継続的な開発が困難になるので、規約を検討しました。
Rails Tasks CoC
主に検討した規約(CoC)は３つ
- Rake タスクの ネームスペース で、単一機能ごとに
.rakeファイルを分離する。 - Rake タスクの
.rakeファイルには、単一機能ごとのクラスの.callを記述する。 - Rake タスクの DB の操作は dry run で試行ができ、 trail で結果を確認できる。
Hands-on
- Rails 8 で追加され認証ジェネレータの Hands-on で Rails Tasks の CoC を紹介します。
Rails new
-
rails newコマンドで Rails に必要なファイルが作成されます。 - Rails Tasks はデフォルトでも 60 件以上 あります。
- 昔のRailsは
rake --tasksコマンドでしたが、今はrails --tasksも使えます。
- 昔のRailsは
$ rails new myapp && cd myapp
$ rails --tasks | wc -l # 61
Rails Generate Authentication
-
rails generate authenticationコマンドでcurrent,user,sessionのモデルやコントローラーなど必要なファイルが作成されます。 -
rails db:migrateコマンドでデータベースにusers,sessionsのテーブルが作成されます。
$ rails generate authentication
$ rails db:migrate
Custom Rails Tasks
- データベースの users のテーブルのレコードの作成に Custom Rake(Rails) Tasks を利用します。
-
rails generate task users createコマンドでlib/tasks/users.rakeファイルが作成されます。-
rails generate taskコマンドの第一引数はnamespaceで、 第二引数はtaskです。
-
$ rails generate task users create
-
rails --tasksコマンドを実行すると、bin/rails users:createが追加されています。
lib/tasks/users.rake
namespace :users do
desc "TODO"
task create: :environment do
end
end
Namespace
- Rake タスクを単一機能ごとに分離するために
namespaceを利用します。 -
mkdirコマンド とmvコマンドで単一機能の.rakeファイルを配置します。
mkdir lib/tasks/users
mv lib/tasks/users.rake lib/tasks/users/create.rake
-
tasks/users/createの順番になるようにtasksのnamespace上位階層に追加します。 -
rails --tasksコマンドを実行すると、bin/rails tasks:users:createが追加されています。
lib/tasks/users/create.rake
namespace :tasks do
namespace :users do
desc "create users"
task create: :environment do
end
end
end
Call
- ユーザーを作成する
Users::CreateTaskクラスの.callを記述します。 - ログの出力は
Rails.loggerを利用します。 -
rails --tasksコマンドを実行すると、bin/rails tasks:users:create[password]が追加されています。
lib/tasks/users/create.rake
# bin/rails tasks:users:create[123]
namespace :tasks do
namespace :users do
desc "create users"
task :create, %i[password] => :environment do |_task, args|
Rails.logger = Logger.new($stdout)
Rails.logger.info Users::CreateTask.call(password: args.password)
end
end
end
Application Tasks
- 単一機能ごとのクラスは
app/tasksにファイルを配置します。 -
ApplicationTaskクラスでcallメソッド のみを利用するようにprivate_class_methodで制御します。
$ mkdir app/tasks
$ touch app/tasks/application_task.rb
- attr_accessor で
dry_run,trailをインスタンス変数で読み書きできるようにします。
app/tasks/application_task.rb
class ApplicationTask
private_class_method :new
def self.call(*params)
new(*params).send(:call)
end
attr_accessor :dry_run, :trail
def initialize(params)
@dry_run = ENV['DRY_RUN'].present?
@trail = { dry_run:, params:, message: {} }
end
end
Users Create Task
- ユーザーを作成する
Users::CreateTaskクラスはapp/tasks/usersにファイルを配置します。
mkdir app/tasks/users
touch app/tasks/users/create_task.rb
app/tasks/users/create_task.rb
class Users::CreateTask < ApplicationTask
def initialize(params)
@password = params[:password]
super
end
def call
ActiveRecord::Base.transaction do
user = User.create_with(password: @password).find_or_create_by!(email_address: "dev+#{User.count + 1}@example.com")
trail[:message][:user] = { email_address: user.email_address }
raise ActiveRecord::Rollback if dry_run
end
trail
end
end
Users Create Tests
- テストは
testやspecにファイルを配置します。test/tasks/users/create_task_test.rbspec/tasks/users/create_task_spec.rb
(今回は割愛します。)
Rails Tasks Run
-
bin/rails tasks:users:create[123]コマンドで、ユーザーが作成されます。
$ bin/rails tasks:users:create[123]
dry run
-
dry runは引数やネームスペースで対応を検討しましたが、環境変数の利用がDRYに記述できるので採用しました。
$ DRY_RUN=true bin/rails tasks:users:create[123]
Rails Authentication
-
rails generate controller Home indexコマンドで Signed を確認するWelcomeページに必要なファイルが作成されます。
$ rails generate controller Home index
Views
-
Turbo を利用しているので
turbo_method: :deleteを設定します。
app/views/home/index.html.erb
<h1>Welcome</h1>
<p>Signed in as: <%= Current.user.email_address %></p>
<%= link_to 'Sign out', session_path, data: { turbo_method: :delete } %>
Routes
-
rootにhome#indexを設定します。
config/routes.rb
Rails.application.routes.draw do
resource :session
resources :passwords, param: :token
root "home#index"
end
Rails Server Run
-
rails serverコマンドで起動して http://localhost:3000/ にアクセスします。 - UnSigned の場合は http://localhost:3000/session/new にリダイレクトされます。
$ rails server
Sign in
- Rails Tasks で作成した メールアドレス と パスワード を入力します。
Signed in
- メールアドレス と パスワード が一致すると Welcome ページが表示されます。
まとめ
カスタム Rake タスク も CoC や DRY で 継続的な開発が保てるようにしましょう。
認証ジェネレータは Hands-on をするときに、必要なファイルが作成されるので便利です。
ポート株式会社 サービス開発部 Advent Calendar 2024 の10日目と並走しています。