optparseライブラリについて

Ruby学習の一環で、optparseライブラリを使用する機会があった為、アウトプットも兼ねて記事にしてみました。初めに公式リファレンスの解説では以下のように記載されています。

optparse_test.rb

require 'optparse'
cmd = OptionParser.new

個人的にブロックを登録するというイメージが一番掴み辛かった。

optparse_test.rb

# コマンドライン上のオプション -h をブロックに格納
cmd.on('-h') { |val| }
# コマンドライン上のオプション -m をブロックに格納
cmd.on('-m') { |val| }

optparse_test.rb

cmd.parse!(ARGV)
p ARGV
p ARGV[0]
p ARGV.class
p ARGV[0].class
p "今は#{ARGV[0]}時#{ARGV[1]}分です"

❯ ruby optparse_test.rb -h 15 -m 30
["15", "30"]
"15"
Array
String
"今は15時30分です"

なお、parse!ではなくparseと記述すると、登録したオプション名まで一緒にパースされる

optiparse.rb

cmd.parse(ARGV)
p ARGV
p ARGV[0]

❯ ruby optparse_test.rb -h 15 -m 30
["-h", "15", "-m", "30"]
"-h"

"<ファイル名>.rb --help"では参照したファイルで使用できる(今回設定した)オプションの一覧が表示されます。

❯ ruby test_paper.rb --help
Usage: test_paper [options]
    -h
    -m

バージョン定数が定義されていると、"ruby <ファイル名>.rb --version"でバージョンが出力される。
(実際には与えられたARGVがパースされる前に定義、今回は変数cmdにOptionParserモジュールを設定した後に記述) optparse_test.rb

require 'optparse'
cmd = OptionParser.new
Version = "1.0.1"

❯ ruby optparse_test.rb --version
optparse_test 1.0.1

kent備忘ログ