如何輕鬆使用optionparser處理命令行參數

一、什麼是optionparser

optionparser是一個方便易用的Ruby命令行參數處理庫，它可以根據您的參數規則和約定自動生成幫助信息，並以此驗證和處理您的命令行參數。它旨在提供快速，簡單和靈活的命令行解析器。

下面是一個簡單的 example.rb，使用optionparser庫來解析命令行參數：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end
  opts.on("-n", "--name NAME", "Your name") do |n|
    options[:name] = n
  end
end.parse!

puts "Hello, #{options[:name]}" if options[:name]
puts "Running verbosely" if options[:verbose]

二、optionparser的基本用法

在上面的example.rb中，我們使用OptionParser.new方法來創建一個新的OptionParser實例，使用opts.on方法來定義選項和參數。在 opts.on 方法的第一個參數中，我們列出了立即觸發此選項的字符串，然後在第二個參數中，我們定義了我們的選項的用途。

在解析器定義完畢後，我們調用parse! 方法來真正解析命令行參數，並在解析結束後定義一個Hash來存儲選項。

使用 i 參數來編寫代碼實現的功能，再次運行code：

ruby example.rb -n John -v

可以得到以下輸出結果：

Hello, John
Running verbosely

三、optionparser庫的高級用法

除了基本用法外，optionparser內置了許多高級方法來幫助您處理更複雜的命令行參數解析。以下是optionparser的一些高級功能。

1. 隱藏參數

您可以使用 opts.on 方法以外的其他方法來處理無關選項。例如，您可能需要在 opts.on 方法中定義單個選項，但仍然需要訪問該選項之外的其他參數。

下面的示例將隱式處理文件路徑參數：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options] file1 file2 ..."

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end
end.parse!

if ARGV.count > 0
  puts "Files to process: #{ARGV.join(', ')}"
else
  puts "No files to process."
end

puts "Running verbosely" if options[:verbose]

使用以下命令運行代碼：

ruby example.rb -v file1.txt file2.txt

將得到以下輸出結果：

Files to process: file1.txt, file2.txt
Running verbosely

2. 參數處理器

使用選項時，您可能希望對傳遞給選項作為參數的值進行某些處理。

例如，您可以使用Integer.parse 方法將字符串轉換為整數：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-a", "--age AGE", Integer, "Your age") do |a|
    options[:age] = a
  end
end.parse!

puts "You are #{options[:age]} years old." if options[:age]

使用以下命令運行代碼：

ruby example.rb -a 30

將得到以下輸出結果：

You are 30 years old.

3. 參數解析器

參數解析器是一種嘗試將傳遞給選項的字符串值轉換為期望類型的一種方法。

以下代碼示例演示了如何使用 Date.parse 來解析日期字符串作為選項參數：

require 'optparse'
require 'date'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-b", "--birthdate BIRTHDATE", Date, "Your birthdate") do |b|
    options[:birthdate] = b
  end
end.parse!

puts "Your birthdate is: #{options[:birthdate].strftime("%B %d, %Y")}" if options[:birthdate]

使用以下命令運行代碼：

ruby example.rb -b "1970-01-01"

將得到以下輸出結果：

Your birthdate is: January 01, 1970

4. 顯示幫助信息

OptionParser提供了一個 –help 選項，它會自動生成您定義的選項清單。如果您定義了一個新選項，則它將顯示在列表中；否則它將顯示為通用文本。

下面的示例將演示如何生成幫助文本：

require 'optparse'

options = {}
OptionParser.new do |opts|
  opts.banner = "Usage: example.rb [options]"

  opts.on("-a", "--age AGE", Integer, "Your age") do |a|
    options[:age] = a
  end

  opts.on("-n", "--name NAME", "Your name") do |n|
    options[:name] = n
  end

  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
    options[:verbose] = v
  end

  opts.on("-h", "--help", "Prints this help") do
    puts opts
    exit
  end
end.parse!

puts "Hello, #{options[:name]}" if options[:name]
puts "You are #{options[:age]} years old." if options[:age]
puts "Running verbosely" if options[:verbose]

使用如下命令運行代碼：

ruby example.rb -h

將得到以下輸出結果：

Usage: example.rb [options]
        --age AGE                    Your age
        --name NAME                  Your name
    -v, --[no-]verbose                Run verbosely
    -h, --help                       Prints this help