概要
今回は、Rubyの標準機能である「Optparse」の説明になります。
公式ドキュメントは以下になります。
Optparseとは？
rubyファイルを実行するときに、コマンドでオプションを指定することができるようにします。より正確に記述をすると「オプション解析をよしなに実施してくれる便利な機能」ということです。
実際の使用例を以下に用意しました。
使い方
サンプルコードは以下になります。
sample.rb
# optparseが使用できるようにrequireします
require 'optparse'
opt = OptionParser.new
# ショートオプションとロングオプションの設定
# 使用するオプションを「-p または -option」という名前に設定します
# どちらかだけ(-pのみ)の設定でも問題ありません
# また、オプションの説明文も追加できます（なくても問題ありません）
opt.on('-p', '--option', '文字入力ができます') { |v| p v }
# コマンドラインに入力した文字を解析（パース）します
# 今のままの場合「-p」という文字も入力した文字が保管されているARGVに入っているため、"-p"をARGVの中から除外します
opt.parse!(ARGV)
# -pのあとに入力した文字を配列の形で出力します
p ARGV
# -pのあとに入力したものをこのような形で一つのずつ出力できます
puts ARGV[1]
# もし、-pのあとに複数 文字をインプットした場合はこのような形で出力できます
puts ARGV[2]
以下のコマンドで実行できますので、皆様のPCで実行してみてください。
ruby sample.rb --option test
# オプションのあとに複数の文字をインプットすることもできます
ruby sample.rb -p test1 test2
補足
以下のコマンドを実施して optionの中に「-p」[--option]、そして説明文が含まれていることを確認できます。
# -h はデフォルトで使用できるヘルプオプション
ruby sample.rb -h
結果 以下のような表示がコンソールに表示されると思います。
Usage: test [options]
-p, --option 文字入力ができます