検索結果

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

• 2.3.0

• 特異メソッド

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

...クトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
OptionParser.new do |opt|

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

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の...

• OptionParser

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

• 2.3.0

• 特異メソッド

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

...クトを引数としてブロックを評
価します。つまり、以下のような書き方が可能です。

//emlist[][ruby]{
require 'optparse'
OptionParser.new do |opt|

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

opt.parse!(ARGV)
end
//}

@param banner ヘルプ(サマリ)の...

• OptionParser

OptionParser#default_argv=(argv) (18703.0)

• 2.3.0

• インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で指定します。

...きに使われます。

@param argv デフォルトでパースしたい文字列の配列を指定します。

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

config = {}
opts = OptionParser.new
opts.on("-r", "--require LIBRARY"){|lib| config[:lib] = lib }

# パラメーター指定なしで実行
opt...

• OptionParser

OptionParser#default_argv -> [String] (18364.0)

• 2.3.0

• インスタンスメソッド

自身がデフォルトでパースする引数を文字列の配列で返します。

...列の配列で返します。

@param argv デフォルトでパースする文字列の配列を返します。

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

opts = OptionParser.new

# --hoo param1 --bar param2 をパラメーターに指定して実行
opts.default_argv # => ["--foo", "param1", "--ba...

• OptionParser

OptionParser#order!(argv = self.default_argv) -> [String] (853.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

絞り込み条件を変える

OptionParser#order!(argv = self.default_argv) {|s| ...} -> [String] (853.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を順番に破壊的にパースします。 argv からオプションがすべて取り除かれます。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#permute!(argv = self.default_argv) -> [String] (829.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を破壊的にパースします。argv からオプションがすべて取り除かれます。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv を返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

• OptionParser

OptionParser#parse!(argv = self.default_argv) -> [String] (805.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。

...実際は OptionParser::ParseError のサブク
ラスになります。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV...

• OptionParser

OptionParser#order(argv) -> [String] (499.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#order(argv) {|s| ...} -> [String] (499.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

絞り込み条件を変える

OptionParser#parse(argv) -> [String] (478.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV...

• OptionParser

OptionParser#permute(argv) -> [String] (478.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

• OptionParser

OptionParser#getopts(argv, *opts) -> Hash (418.0)

• 2.3.0

• インスタンスメソッド

引数をパースした結果を、Hash として返します。

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。

//emlist[][ruby]{
opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x...

• OptionParser

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

• 2.3.0

• 特異メソッド

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

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

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

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

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。


@see OptionParser#getopts

• OptionParser

OptionParser#order(*args) -> [String] (199.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

絞り込み条件を変える

OptionParser#order(*args) {|s| ...} -> [String] (199.0)

• 2.3.0

• インスタンスメソッド

与えられた argv を順番にパースします。 オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b') {|v| p :b }

opt.order(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somefile...

• OptionParser

OptionParser#parse(*args) -> [String] (178.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

ARGV...

• OptionParser

OptionParser#permute(*args) -> [String] (178.0)

• 2.3.0

• インスタンスメソッド

与えられた argv をパースします。 オプションではないコマンドの引数(下の例で言うと somefile)があってもパースを中断しません。 argv からオプションを取り除いたものを返します。

...実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[opt.rb][ruby]{
require 'optparse'
opt = OptionParser.new

opt.on('-a [VAL]') {|v| p :a }
opt.on('-b ') {|v| p :b }

opt.permute!(ARGV)
p ARGV
//}
↓
$ ruby opt.rb -a foo somef...

• OptionParser

OptionParser#getopts(*opts) -> Hash (118.0)

• 2.3.0

• インスタンスメソッド

引数をパースした結果を、Hash として返します。

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、
default_argv をパースします。

//emlist[][ruby]{
opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true # -a
# params["b"] = "1" # -b1
# params["foo"] = true # --foo
# params["bar"] = "x" # --bar x...

• OptionParser

OptionParser (79.0)

• 2.3.0

• クラス

コマンドラインのオプションを取り扱うためのクラスです。

...(3) opt.parse(ARGV) でコマンドラインを実際に parse する。

というような流れになります。

//emlist[][ruby]{
require "optparse"
ProgramConfig = Hash.new
opts = OptionParser.new
opts.on("-a"){|v| ProgramConfig[:a] = true } # オプション「-a」がコマンドライン...

絞り込み条件を変える

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

• 2.3.0

• 特異メソッド

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

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

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

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

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。


@see OptionParser#getopts

• OptionParser

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

• 2.3.0

• 特異メソッド

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

...たブロックを削除します。

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

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

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

• OptionParser

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

• OptionParser
• Regexp

OptionParser#reject(klass) -> () (43.0)

• 2.3.0

• インスタンスメソッド

OptionParser#accept で登録したクラスとブロックを 自身から削除します。

...ックを
自身から削除します。

@param klass 自身から削除したいクラスを指定します。

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

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

• OptionParser

OptionParser#ver -> String (43.0)

• 2.3.0

• インスタンスメソッド

program_name、version と release から生成したバージョンを表す文字列を返します。

...例][ruby]{
require "optparse"

OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.program_name = "Optparse Example"
opts.version = [0, 1]
opts.release = "2019-05-01"

opts.on_tail("--version", "Show version") do
puts opts.ver # => "Optparse Example 0.1 (2019-0...

• OptionParser

絞り込み条件を変える

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

• 2.3.0

• 特異メソッド

オプションの引数を文字列から Ruby のオブジェクトに変換するための ブロックを登録します。すべての OptionParser インスタンスに共通です。

...スタンスに変換されてから、OptionParser#on メソッドで登録したブロックに渡されます。

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

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

op...

• OptionParser
• Regexp