Rails の CLI ツールの書き方/writing-rails-cli-tool

Transcript

1. Rails の CLI ツールの 書き方 森塚 真年(@sanfrecce_osaka) 2025/08/16 Kyoto.rb #kyotorb
2. 自己紹介 森塚 真年 GitHub: @sanfrecce-osaka Twitter(X) ・Qiita: @sanfrecce_osaka 趣味: コミュニティ・勉強会 Machida.rb Hirakata.rb 株式会社Leaner Technologies Ruby3.4/Rails8.0 Next.js 14.2
3. 最近の関心事 Rails アプリケーションでの型チェックの Rail Zenn Book にまとめ中( まだ未公開) 最終的に steep-on-rails みたいに gem に( 願望) OpenAPI 3.1
4. 本編
5. Rails の CLI ツール
6. 何で書いてますか？ rake タスク thor タスク rails コマンド
7. rake タスク namespace :build do # :test が事前タスク # [:version] が引数 # :package がタスク名 task :package, [:version] => :test do |t, args| # ... end end $ rake build:package[1.2.3]
8. 👍 デフォルトで使える 👍 Rails ガイドにものっている cf. 👍 多くの利用実績 cf. 😭 引数が扱いづらい 😭 DSL が難しい カスタムRake タスク Data Migration on Rails
9. ちなみに
10. rake タスクで拡張した rails stats # lib/tasks/custom_stats.rake task stas: :environment do STATS_DIRECTORIES.insert( 13, %w[Services app/services], %w[Libs app/libs] ) end
11. Rails 8 では適用されない！ https://github.com/rails/rails/pull/47713 https://github.com/rails/rails/pull/52226
12. thor タスク class Build < Thor desc 'package [version]', 'Build the specified version of th method_option :dry_run, type: :boolean, default: false, desc: 'dry run def package(version) invoke :test # ... end def test # ... end end $ bundle exec thor build:package --dry-run 1.2.3 Thor がRails に入っている話 - TechRacho rails/thor Wiki
13. 👍 引数やオプションを設定しやすい 👍 引数が扱いやすい 👍 オプションも設定でき型の指定ができる 👍 DSL がわかりやすい 😭 rails コマンドで実行・確認できない 😭 model を扱う際に require が必要
14. $ bundle exec thor list build ----- thor build:package [version] # Build the specified version of $ bundle exec thor help build:package Usage: thor build:package [version] Options: [--dry-run], [--no-dry-run], [--skip-dry-run] # dry run mode # Default: fal Build the specified version of the package.
15. rails コマンドと 同じように扱いたい！
16. rails コマンド Rails::Command::Base を継承する Rails::Command::Base は Thor を継承している require 'rails/command' module Tasks class Build < Rails::Command::Base namespace :build desc 'package [version]', 'Build the specified version of method_option :dry_run, type: :boolean, default: false, desc: 'dry r def package(version) invoke :test # ... end def test
17. 👍 thor と同じ使い心地 👍 rails コマンドで統一できる 👍 model を扱う際に require が不要 🤔 Rails ガイドには記載がない API Doc はあるので private API ということはな さそう？
18. $ bin/rails -h # 省略 All commands can be run with -h (or --help) for more informati In addition to those commands, there are: # 省略 build:package Build the specified version of $ bin/rails build:package -h Usage: bin/rails build:package [version] Options: [--dry-run], [--no-dry-run], [--skip-dry-run] # dry run mode # Default: fal Build the specified version of the package.
19. 余談 その1
20. irb がコマンドをメソッドからクラスに置き換えた 話を少し思い出した https://github.com/ruby/irb/pull/873 https://github.com/ruby/irb/pull/824 https://github.com/ruby/irb/pull/925
21. 余談 その2
22. 設計もろもろ part1 タスクやコマンドは割と実装をクラスに切り出 さず書かれがち テストしづらいので実装の詳細はクラスに切り 出してほしい 特に Rake Thor や Rails コマンドもクラスの初期化がどう 行われるかを調べないといけない
23. 設計もろもろ part2 Job や Mailer も同様 全部 MVC で考えると Controller の責務 Controller は DDD でいうユースケース( アプリケ ーションサービス) 層
24. 設計もろもろ part3 Rails だから実装ファイルの置き方は app/models/task/**_task.rb とか app 配下にディレクトリを切るのは MVC にレ イヤーを追加するのと同義 lib から model 参照するのはどうなの？ lib/tasks から AR の model 参照したりしてる しいいいのでは
25. ご清聴 ありがとうございました。