検索結果

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) -> OptionParser (21209.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

OptionParser オブジェクトを生成して返します。

...
OptionParser オブジェクトを生成して返します。

ブロックが与えられた場合、生成した OptionParser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
Optio...

...nParser.new do |opt|

opt.on('-a') {|v| p v }
opt.on('-b') {|v| p v }

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の最初の部分に表示される、アプリケーションの説明などを文字列で与えます。

@param width サマリの幅を整数で与えます...

OptionParser.new(banner = nil, width = 32, indent = ' ' * 4) {|opt| ...} -> OptionParser (21209.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

OptionParser オブジェクトを生成して返します。

...
OptionParser オブジェクトを生成して返します。

ブロックが与えられた場合、生成した OptionParser オブジェクトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
Optio...

...nParser.new do |opt|

opt.on('-a') {|v| p v }
opt.on('-b') {|v| p v }

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の最初の部分に表示される、アプリケーションの説明などを文字列で与えます。

@param width サマリの幅を整数で与えます...

OptionParser.getopts(*opts) -> Hash (3017.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

...。(self.new.getopts と同じです)

@param argv パースしたい配列を指定します。

@param opts 引数を文字列で指定します。

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseErro...

...r のサブク
ラスになります。


@see OptionParser#getopts...

OptionParser.getopts(argv, *opts) -> Hash (3017.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

引数をパースした結果を、Hash として返します。(self.new.getopts と同じです)

...。(self.new.getopts と同じです)

@param argv パースしたい配列を指定します。

@param opts 引数を文字列で指定します。

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseErro...

...r のサブク
ラスになります。


@see OptionParser#getopts...

OptionParser#load(filename = nil) -> bool (3013.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

...指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

パースが成功した場合に true を返します。
ファイルが存在しなかった場合に false を返します。

@param filename 各行をパースしたい...

...~/.options/ に
プログラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

//emlist[例][ruby]{
require "optparse"

IO.write("options.txt", %w(-a --b).join("\n"))
options = { a: false, b: false }
OptionParser.new do |o...

...pt|
opt.on('-a') { |v| options[:a] = v }
opt.on('--b') {|v| options[:b] = v }
opt.load("options.txt") # => true
opt.load("not_exist.txt") # => false
end

p options # => {:a=>true, :b=>true}
//}...

絞り込み条件を変える

OptionParser#on_tail(*arg, &block) -> self (3013.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

...登録します。

--version や --help の説明をサマリの最後に表示したい時に便利です。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-...

...opts.on_tail("-h", "--help")
end

puts opts.help

# => Usage: test [options]
# -i, --init
# -u, --update
# -h, --help
//}

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new
opts.on_tail("-h", "--help", "Show this message") do
puts opts
exit
end

opts.on_tail("--version",...

..."Show version") do
puts OptionParser::Version.join('.')
exit
end
//}

@see OptionParser#on, OptionParser#on_head...

OptionParser.reject(klass) -> () (3013.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

OptionParser.accept メソッドで登録したブロックを削除します。

...
OptionParser.accept メソッドで登録したブロックを削除します。

@param klass 削除したいクラスオブジェクトを指定します。

//emlist[例][ruby]{
require "optparse"
require "time"

def parse(option_parser)
option_parser.on("-t", "--time [TIME]", Time) do |time|...

...time.class
end
option_parser.parse(ARGV)
end

OptionParser.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

opts1 = OptionParser.new
parse(opts1) # => Time
OptionParser.reject(Time)
opts2 = OptionParser.new
parse(opts2) # => unsu...

OptionParser#accept(klass, pat = /.*/) {|str| ...} -> () (3007.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

OptionParser.accept と同様ですが、 登録したブロックはレシーバーに限定されます。

...
OptionParser.accept と同様ですが、
登録したブロックはレシーバーに限定されます。

@param klass クラスオブジェクトを与えます。

@param pat match メソッドを持ったオブジェクト(Regexp オブジェクトなど)を与えます。

//emlist[例][rub...

...y]{
require "optparse"
require "time"

opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

opts.on("-t", "--time [TIME]", Time) do |time|
p time.class # => Time
end

opts.parse!(ARGV)
//}...

• Regexp

OptionParser#banner -> String (3007.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

サマリの最初に表示される文字列を返します。

...します。

//emlist[例][ruby]{
require "optparse"

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

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

p opts.banner # => "Usage: example.rb [options]"
//}...

OptionParser#banner=(heading) (3007.0)

• 2.4.0

• インスタンスメソッド

サマリの最初に表示される文字列を指定します。

...y]{
require "optparse"

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

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

opts.banner # => "Usage: example.rb [options]"
//}...

絞り込み条件を変える