optparseでコマンドのオプションを使う

optparseとは

optparseとは、Rubyでコマンドのオプションを使うためのライブラリ。

optparseの使い方

  1. ライブラリを読み込む
  2. Optparserクラスをインスタンス化する
  3. コマンドのオプションを設定する
  4. parseを実行する

ライブラリを読み込む

requireを使ってライブラリを読み込む。

require 'optparse'

Optparserクラスをインスタンス化する

opt = Optparser.new

コマンドのオプションを設定する

コマンドのオプションを設定するには、Optparserクラスのonメソッドを使う。 このメソッドによって、オプションに対して実行する処理を設定できる。実際にはoptオブジェクトにオプションを登録している。

opt.on('コマンドのオプション') {'処理'}

オプションに引数を渡したい場合は次のように書く。

# 引数必須
opt.on('コマンドのオプション 引数') {'処理'}

# 引数省略可
opt.on('コマンドのオプション [引数]') {'処理'}

この段階では処理を設定しただけなのでオプションの処理は実行はされない。処理が実行されるようにするためにはparseメソッドを使う。

parseを実行する

parseメソッドを実行しておくことで、コマンドのオプションが指定されていれば、登録されていた処理が実行される。

opt.parse(ARGV)

ARGVRubyスクリプトに与えられた引数を表す配列。つまりparseメソッドの引数に、コマンドを実行した時の引数が渡される。

参考

https://akng-engineer.hatenablog.com/entry/2021/12/02/225959 https://docs.ruby-lang.org/ja/latest/library/optparse.html https://docs.ruby-lang.org/ja/latest/method/Object/c/ARGV.html