Rubyでオプションを扱う'optparse'を使ったコードの書き方

はじめに

Rubyoptparseを用いるとコマンドからの実行時にオプションを指定することが出来ます。
今回はその使い方について紹介します。

optparseの使い方

流れは以下の様になります。
1. OptionParserオブジェクトを作成する。
2. optにオプションを使用するブロックを登録する。
3. opt.parse(ARGV)でコマンドラインを実際にparseする。

これを踏まえて実際にコードを書いてみましょう。
例として、指定したオプションの引数を出力するコードを書いていきます。

# ライブラリを読み込み
require 'optparse'
# 1.オブジェクト作成
opt = OptionParser.new
# 2.optにオブジェクト登録 今回は`-m`とする
opt.on('-m') { |v| v }
# 3.ブロックの戻り値がARGVに渡される
opt.parse!(ARGV)

# ARGVを出力
p ARGV


このファイルをuse_optparse.rbとして保存して実行してみます。
すると以下の様な結果になるはずです。

# ruby use_optparse.rb -m 15
["15"]

しっかりと-mオプションの引数が出力されています。

まとめ

今回はoptparseの使い方についてまとめました。
これを用いるとプログラムの実行結果に幅を持たせることができます。
よろしければ使ってみてください。

参考URL

library optparse (Ruby 3.3 リファレンスマニュアル)