検索結果

REXML::Parsers::SAX2Parser#parse -> () (72307.0)

• 2.2.0

• インスタンスメソッド

REXML::Parsers::SAX2Parser.new で指定した XML を パースし、その結果によって REXML::Parsers::SAX2Parser#listen で 指定したコールバックを呼び出します。

REXML::Parsers::SAX2Parser.new で指定した XML を
パースし、その結果によって REXML::Parsers::SAX2Parser#listen で
指定したコールバックを呼び出します。

@raise REXML::ParseException XML文書のパースに失敗した場合に発生します
@raise REXML::UndefinedNamespaceException XML文書のパース中に、定義されていない名前空間
が現れた場合に発生します

• REXML::Parsers::SAX2Parser

REXML::Parsers::StreamParser#parse -> () (72307.0)

• 2.2.0

• インスタンスメソッド

入力をパースします。

入力をパースします。

このメソッドの中からコールバックが呼び出されます。

@raise REXML::ParseException XML文書のパースに失敗した場合に発生します
@raise REXML::UndefinedNamespaceException XML文書のパース中に、定義されていない名前空間
が現れた場合に発生します

• REXML::Parsers::StreamParser

REXML::Parsers::UltraLightParser#parse -> Array (72307.0)

• 2.2.0

• インスタンスメソッド

XML 文書のパース結果を配列による木で返します。

XML 文書のパース結果を配列による木で返します。

返される木構造配列については lib:rexml/parsers/ultralightparser#nodes
を参照してください。

@raise REXML::ParseException XML文書のパースに失敗した場合に発生します
@raise REXML::UndefinedNamespaceException XML文書のパース中に、定義されていない名前空間
が現れた場合に発生します

• REXML::Parsers::UltraLightParser

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

• 2.2.0

• インスタンスメソッド

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

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

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


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

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


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

• OptionParser

絞り込み条件を変える

JSON::Parser#parse -> object (63325.0)

• 2.2.0

• インスタンスメソッド

現在のソースをパースして結果を Ruby のオブジェクトとして返します。

現在のソースをパースして結果を Ruby のオブジェクトとして返します。

//emlist[例][ruby]{
require 'json'

class Person
attr_accessor :name, :age

def []=(key, value)
instance_variable_set("@#{key}", value)
end
end

parser = JSON::Parser.new(DATA.read, object_class: Person)
person = parser.parse
person.class # => Person
p...

• JSON::Parser

Psych::Parser#parse(yaml) -> self (63307.0)

• 2.2.0

• インスタンスメソッド

YAML ドキュメントをパースし、イベントハンドラに イベントを逐次通知します。

YAML ドキュメントをパースし、イベントハンドラに
イベントを逐次通知します。

@see Psych::Parser.new, Psych::Handler, Psych::Parser#handler

• Psych::Handler
• Psych::Parser

RSS::Parser#parse (63307.0)

• 2.2.0

• インスタンスメソッド

@todo

@todo

• RSS::Parser

Ripper#parse -> nil (54325.0)

• 2.2.0

• インスタンスメソッド

自身の持つ Ruby プログラムを解析します。常に nil を返します。

自身の持つ Ruby プログラムを解析します。常に nil を返します。

サブクラスでオーバライドして使用します。Ruby プログラムの解析は行います
が、そのままでは解析結果は利用できません。サブクラスでイベントハンドラ
の定義や本メソッドの戻り値の追加などで対応する必要があります。

@see Ripper.parse

• Ripper

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (54307.0)

• 2.2.0

• インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

• RDoc::Markdown
• RDoc::Markup::Document

絞り込み条件を変える

RDoc::Options#parse(argv) -> () (54307.0)

• 2.2.0

• インスタンスメソッド

コマンドライン引数を解析します。

コマンドライン引数を解析します。

@param argv コマンドライン引数を文字列の配列で指定します。


また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

• RDoc::Options

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (54307.0)

• 2.2.0

• インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

@param text 文字列を指定します。

@see RDoc::Text#normalize_comment

• RDoc::Text

Ripper::Filter#parse(init = nil) -> object (54307.0)

• 2.2.0

• インスタンスメソッド

自身の持つ Ruby プログラムの解析を開始します。各種イベントハンドラで処 理を行った結果を返します。

自身の持つ Ruby プログラムの解析を開始します。各種イベントハンドラで処
理を行った結果を返します。

@param init 任意の値を指定できます。この値がイベントハンドラに渡されていきます。

引数 init を初期値としてイベントハンドラに渡されていきます。各種イベン
トハンドラの戻り値は次のイベントハンドラに渡されます。
Enumerable#inject のように、最終的な結果を戻り値として返します。

@see Ripper::Filter#on_default, Ripper::Filter#on_XXX

• Ripper::Filter

Ripper::Lexer#parse -> [[Integer, Integer], Symbol, String] (54307.0)

• 2.2.0

• インスタンスメソッド

自身の持つ Ruby プログラムをトークンに分割し、そのリストを返します。た だし Ripper::Lexer#lex と違い、結果をソートしません。

自身の持つ Ruby プログラムをトークンに分割し、そのリストを返します。た
だし Ripper::Lexer#lex と違い、結果をソートしません。

ライブラリ内部で使用します。

• Ripper::Lexer

WEBrick::HTTPRequest#parse(socket = nil) -> () (54307.0)

• 2.2.0

• インスタンスメソッド

指定された socket からクライアントのリクエストを読み込み、 自身のアクセサなどを適切に設定します。

指定された socket からクライアントのリクエストを読み込み、
自身のアクセサなどを適切に設定します。

@param socket クライアントに接続された IO オブジェクトを指定します。

• WEBrick::HTTPRequest

絞り込み条件を変える

OptionParser::Arguable#parse! -> [String] (27373.0)

• 2.2.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#parse! を参照して下さい。

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#parse! を参照して下さい。

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

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

o = nil
ARGV.options.on('-...

• OptionParser::Arguable

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

• 2.2.0

• インスタンスメソッド

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

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

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。


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

• OptionParser

RDoc::Parser#parse_files_matching(regexp) -> () (27325.0)

• 2.2.0

• インスタンスメソッド

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、
自身を登録します。

@param regexp 正規表現を指定します。

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end

• RDoc::Parser

Racc::Parser#do_parse (27307.0)

• 2.2.0

• インスタンスメソッド

@todo

@todo

• Racc::Parser

Racc::Parser#yyparse(recv, mid) (27304.0)

• 2.2.0

• インスタンスメソッド

@todo

@todo

• Racc::Parser

絞り込み条件を変える

RDoc::Options#option_parser -> OptionParser | nil (18604.0)

• 2.2.0

• インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。

コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。

• OptionParser
• RDoc::Options

URI::Generic#parser -> URI::Parser (18604.0)

• 2.2.0

• インスタンスメソッド

selfのパーサを返します。未定義であった場合は URI::DEFAULT_PARSER を返します。

selfのパーサを返します。未定義であった場合は URI::DEFAULT_PARSER を返します。

• URI::Generic

String#parse_csv(**options) -> [String] (18445.0)

• 2.2.0

• インスタンスメソッド

CSV.parse_line(self, options) と同様です。

CSV.parse_line(self, options) と同様です。

1 行の CSV 文字列を、文字列の配列に変換するためのショートカットです。

@param options CSV.new と同様のオプションを指定します。

//emlist[][ruby]{
require "csv"

p "Matz,Ruby\n".parse_csv # => ["Matz", "Ruby"]
p "Matz|Ruby\r\n".parse_csv(col_sep: '|', row_sep: "\r\n") # => ...

• CSV.parse_line
• String

Psych::ScalarScanner#parse_time(string) -> Time (18307.0)

• 2.2.0

• インスタンスメソッド

文字列を Time オブジェクトに変換します。

文字列を Time オブジェクトに変換します。

@param string 変換文字列

• Psych::ScalarScanner

RDoc::Options#option_parser=(val) (18304.0)

• 2.2.0

• インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。

コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。

@param val OptionParser オブジェクトを指定します。

• OptionParser
• RDoc::Options

絞り込み条件を変える

REXML::Parsers::PullParser#peek(depth = 0) -> REXML::Parsers::PullEvent | nil (18304.0)

• 2.2.0

• インスタンスメソッド

イベントキューの先頭から depth 番目のイベントを取り出します。

イベントキューの先頭から depth 番目のイベントを取り出します。

一番先頭のイベントは 0 で表します。

このメソッドでは列そのものの状態は変化しません。

先頭から depth 番目のイベントが存在しない(XML文書の末尾の
さらに先を見ようとした場合)は nil を返します。

@param depth 先頭から depth 番目のイベントを取り出します

@raise REXML::ParseException XML文書のパースに失敗した場合に発生します
@raise REXML::UndefinedNamespaceException XML文書のパース中に、定義されていない...

• REXML::Parsers::PullParser

REXML::Parsers::PullParser#pull -> REXML::Parsers::PullEvent (18304.0)

• 2.2.0

• インスタンスメソッド

イベントキューの先頭のイベントを取り出し、キューからそれを取り除きます。

イベントキューの先頭のイベントを取り出し、キューからそれを取り除きます。

@raise REXML::ParseException XML文書のパースに失敗した場合に発生します
@raise REXML::UndefinedNamespaceException XML文書のパース中に、定義されていない名前空間
が現れた場合に発生します

• REXML::Parsers::PullParser

WEBrick::HTTPRequest#unparsed_uri -> String (18304.0)

• 2.2.0

• インスタンスメソッド

リクエストの URI を文字列で返します。

リクエストの URI を文字列で返します。

• WEBrick::HTTPRequest

OptionParser::ParseError#recover(argv) -> Array (18022.0)

• 2.2.0

• インスタンスメソッド

argv の先頭に self.args を戻します。

argv の先頭に self.args を戻します。

argv を返します。

@param argv OptionParser#parse に渡したオブジェクトなどの配列を指定します。

@return argv を返します。

• OptionParser::ParseError

OptionParser::ParseError#args -> Array (18004.0)

• 2.2.0

• インスタンスメソッド

エラーのあったオプションの一覧を配列で返します。

エラーのあったオプションの一覧を配列で返します。

@return エラーのあったオプションの一覧。

• OptionParser::ParseError

絞り込み条件を変える

OptionParser::ParseError#inspect -> String (18004.0)

• 2.2.0

• インスタンスメソッド

自身を人間が読みやすい形の文字列表現にして返します。

自身を人間が読みやすい形の文字列表現にして返します。

@return 文字列を返します。

@see Object#inspect

• OptionParser::ParseError

OptionParser::ParseError#message -> String (18004.0)

• 2.2.0

• インスタンスメソッド

標準エラーに出力するメッセージを返します。

標準エラーに出力するメッセージを返します。

@return 文字列を返します。

• OptionParser::ParseError

OptionParser::ParseError#reason -> String (18004.0)

• 2.2.0

• インスタンスメソッド

エラーの内容を文字列で返します。

エラーの内容を文字列で返します。

@return 文字列を返します。

• OptionParser::ParseError

OptionParser::ParseError#reason=(reason) (18004.0)

• 2.2.0

• インスタンスメソッド

エラーの内容を指定します。

エラーの内容を指定します。

@param reason 文字列を指定します。

• OptionParser::ParseError

OptionParser::ParseError#set_backtrace(array) -> [String] (18004.0)

• 2.2.0

• インスタンスメソッド

自身に array で指定したバックトレースを設定します。

自身に array で指定したバックトレースを設定します。

@param array バックトレースを文字列の配列で指定します。

@return array を返します。

• OptionParser::ParseError

絞り込み条件を変える

OptionParser::ParseError#set_option(opt, eq) -> self (18004.0)

• 2.2.0

• インスタンスメソッド

エラーのあったオプションを指定します。

エラーのあったオプションを指定します。

eq が真の場合、self が管理するエラーのあったオプションの一覧の先頭を
opt で置き換えます。そうでない場合は先頭に opt を追加します。

@param opt エラーのあったオプションを指定します。

@param eq self が管理するエラーのあったオプションの一覧の先頭を置き換え
るかどうかを指定します。

@return self を返します。

• OptionParser::ParseError

OptionParser::ParseError#to_s -> String (18004.0)

• 2.2.0

• インスタンスメソッド

標準エラーに出力するメッセージを返します。

標準エラーに出力するメッセージを返します。

@return 文字列を返します。

• OptionParser::ParseError

REXML::Parsers::PullParser#each {|event| ... } -> () (18004.0)

• 2.2.0

• インスタンスメソッド

XMLをパースし、得られたイベント列を引数として順にブロックを呼び出します。

XMLをパースし、得られたイベント列を引数として順にブロックを呼び出します。

@raise REXML::ParseException XML文書のパースに失敗した場合に発生します
@raise REXML::UndefinedNamespaceException XML文書のパース中に、定義されていない名前空間
が現れた場合に発生します

• REXML::Parsers::PullParser

REXML::Parsers::PullParser#empty? -> bool (18004.0)

• 2.2.0

• インスタンスメソッド

未処理のイベントが残っていない場合に真を返します。

未処理のイベントが残っていない場合に真を返します。

@see REXML::Parsers::PullParser#has_next?

• REXML::Parsers::PullParser

REXML::Parsers::PullParser#has_next? -> bool (18004.0)

• 2.2.0

• インスタンスメソッド

未処理のイベントが残っている場合に真を返します。

未処理のイベントが残っている場合に真を返します。

@see REXML::Parsers::PullParser#empty?

• REXML::Parsers::PullParser

絞り込み条件を変える

REXML::Parsers::PullParser#unshift(token) -> () (18004.0)

• 2.2.0

• インスタンスメソッド

イベントキューの先頭に token を追加します。

イベントキューの先頭に token を追加します。

@param token 先頭に追加するイベント(REXML::Parsers::PullEvent オブジェクト)

• REXML::Parsers::PullEvent
• REXML::Parsers::PullParser

REXML::Parsers::SAX2Parser#deafen(listener) -> () (18004.0)

• 2.2.0

• インスタンスメソッド

REXML::Parsers::SAX2Parser#listen で指定した listener を 取り除きます。

REXML::Parsers::SAX2Parser#listen で指定した listener を
取り除きます。

@param listener 取り除く listener

• REXML::Parsers::SAX2Parser

REXML::Parsers::SAX2Parser#listen(ary) { ... } -> () (18004.0)

• 2.2.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::SAX2Parser#listen(ary, listener) -> () (18004.0)

• 2.2.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::SAX2Parser#listen(listener) -> () (18004.0)

• 2.2.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

絞り込み条件を変える

REXML::Parsers::SAX2Parser#listen(sym) { ... } -> () (18004.0)

• 2.2.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::SAX2Parser#listen(sym, ary) { ... } -> () (18004.0)

• 2.2.0

• インスタンスメソッド

コールバックをパーサに登録します。

コールバックをパーサに登録します。

引数の種類やブロックの有無でどのような場合に何がコールバックされかが
変わります。

ブロックを指定した場合はそのブロックがコールバックされます。
ブロックを指定しない場合は REXML::SAX2Listener を include した
クラスのオブジェクトを指定します。

sym は以下のシンボルが指定でき、どの場合にコールバックが呼び出されるかを
指定します。どのような場合にどのような引数でコールバックが呼び出されるか
については、
REXML::SAX2Listener の対応するメソッドで詳しく説明されていますので
そちらを参照してください。...

• REXML::Parsers::SAX2Parser
• REXML::SAX2Listener

REXML::Parsers::UltraLightParser#rewind -> () (18004.0)

• 2.2.0

• インスタンスメソッド

REXML::Parsers::UltraLightParser.new で指定した stream を rewind してもう一度パースできる状態にします。

REXML::Parsers::UltraLightParser.new で指定した stream を
rewind してもう一度パースできる状態にします。

• REXML::Parsers::UltraLightParser

OptionParser::Arguable#options -> OptionParser (9322.0)

• 2.2.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。

ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

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

o = nil
ARG...

• OptionParser
• OptionParser::Arguable
• OptionParser::ParseError

Psych::Parser#mark -> Psych::Parser::Mark (9304.0)

• 2.2.0

• インスタンスメソッド

パーサが現在読み込んでいる入力上の位置を Psych::Parser::Mark オブジェクト で返します。

パーサが現在読み込んでいる入力上の位置を Psych::Parser::Mark オブジェクト
で返します。

• Psych::Parser
• Psych::Parser::Mark

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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|
p time.class
end
option_parser.parse(ARGV)
end

opts = OptionParser.new
o...

• OptionParser

OptionParser#default_argv=(argv) (9058.0)

• 2.2.0

• インスタンスメソッド

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

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

OptionParser#parse の引数が指定されなかったときに使われます。

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

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

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

# パラメーター指定なしで実行
opts.default_argv # => []
opts.p...

• OptionParser

OptionParser#environment(env) -> [String] (9052.0)

• 2.2.0

• インスタンスメソッド

環境変数 env に対して Shellwords.#shellwords を呼 んで配列にしてから parse を行ないます。

環境変数 env に対して
Shellwords.#shellwords を呼
んで配列にしてから parse を行ないます。

@param env 環境変数名を文字列で与えます。

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

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

config = ...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

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

@param filename 各行をパースしたいファイルの名前を文字列で指定します。
指定されないか nil である場合、~/.options/ に
プログラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

//emlist[例][ruby]{
re...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

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

@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 OptionP...

• OptionParser
• Regexp

絞り込み条件を変える

OptionParser#on(long, *rest) {|v| ...} -> self (9025.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

• OptionParser
• OptionParser::InvalidArgument

OptionParser#on(long, pat = /.*/, desc = "") {|v| ...} -> self (9025.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

pat にはオプションの引数に許すパターンを表す正規表現で与えます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。

opts.on("--username VALUE", /[a-zA-Z0-9_]+/){|name| ...}
# ruby command --username=ruby_user
# ruby command...

• OptionParser

OptionParser#on(short, *rest) {|v| ...} -> self (9025.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

• OptionParser
• OptionParser::InvalidArgument

OptionParser#on(short, long, *rest) {|v| ...} -> self (9025.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

コマンドに与えられた引数が配列やハッシュに含まれない場合、例外
OptionParser::InvalidArgument が OptionParser#parse 実行時
に発生します。

@param short ショートオプションを表す文字列を指定します。

@param long ロングオプションを表す文字列を指定します。

@param rest 可能な引数を列挙した配列やハッシュを与えます。文字列を与えた場合は、
サマリ...

• OptionParser
• OptionParser::InvalidArgument

OptionParser#on(short, long, pat = /.*/, desc = "") {|v| ...} -> self (9025.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

pat にはオプションの引数に許すパターンを表す正規表現で与えます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。

opts.on("--username VALUE", /[a-zA-Z0-9_]+/){|name| ...}
# ruby command --username=ruby_user
# ruby command...

• OptionParser

絞り込み条件を変える

OptionParser#on(short, pat = /.*/, desc = "") {|v| ...} -> self (9025.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

pat にはオプションの引数に許すパターンを表す正規表現で与えます。
コマンドに与えられた引数がパターンにマッチしない場合、
例外 OptionParser::InvalidArgument が parse 実行時に投げられます。

opts.on("--username VALUE", /[a-zA-Z0-9_]+/){|name| ...}
# ruby command --username=ruby_user
# ruby command...

• OptionParser

OptionParser#ver -> String (9022.0)

• 2.2.0

• インスタンスメソッド

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

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

//emlist[例][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 v...

• OptionParser

OptionParser::Arguable#options {|opt| ... } -> object | nil (9022.0)

• 2.2.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。

ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

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

o = nil
ARG...

• OptionParser
• OptionParser::Arguable
• OptionParser::ParseError

OptionParser#on(long, desc = "") {|v| ... } -> self (9010.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

複数の異なるオプションに同じブロックを一度に登録することもできます。

opt.on('-v', '-vv')...

• OptionParser

OptionParser#on(long, klass = String, desc = "") {|v| ...} -> self (9010.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

• ArgumentError
• OptionParser
• OptionParser::InvalidArgument

絞り込み条件を変える

OptionParser#on(short, desc = "") {|v| ... } -> self (9010.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

複数の異なるオプションに同じブロックを一度に登録することもできます。

opt.on('-v', '-vv')...

• OptionParser

OptionParser#on(short, klass = String, desc = "") {|v| ...} -> self (9010.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

• ArgumentError
• OptionParser
• OptionParser::InvalidArgument

OptionParser#on(short, long, desc = "") {|v| ... } -> self (9010.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

ショートオプションとロングオプションを同時に登録することもできます。
opts.on("-r", "--require LIBRARY"){|lib| ...}
これは以下と同値です。
opts.on("-r LIBRARY"){|lib| ...}
opts.on("--require LIBRARY"){|lib| ...}

複数の異なるオプションに同じブロックを一度に登録することもできます。

opt.on('-v', '-vv')...

• OptionParser

OptionParser#on(short, long, klass = String, desc = "") {|v| ...} -> self (9010.0)

• 2.2.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

オプションを取り扱うためのブロックを自身に登録します。
ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

klass にはクラスを与えます。どのようなクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定された
場合、例外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::I...

• ArgumentError
• OptionParser
• OptionParser::InvalidArgument

JSON::Parser#source -> String (9004.0)

• 2.2.0

• インスタンスメソッド

現在のソースのコピーを返します。

現在のソースのコピーを返します。

//emlist[例][ruby]{
require 'json'

parser = JSON::Parser.new(DATA.read)
print parser.source

# => {
# => "Tanaka": {
# => "name":"tanaka",
# => "age":20
# => },
# => "Suzuki": {
# => "name":"suzuki",
# => "age":25
# => }
# => }

__END__
{
"Tanaka": {
...

• JSON::Parser

絞り込み条件を変える

OptionParser#banner -> String (9004.0)

• 2.2.0

• インスタンスメソッド

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

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

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

//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 # =...

• OptionParser

OptionParser#banner=(heading) (9004.0)

• 2.2.0

• インスタンスメソッド

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

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

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

//emlist[例][ruby]{
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|
option...

• OptionParser

OptionParser#default_argv -> [String] (9004.0)

• 2.2.0

• インスタンスメソッド

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

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

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

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

opts = OptionParser.new

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

• OptionParser

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

• 2.2.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 (9004.0)

• 2.2.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#help -> String (9004.0)

• 2.2.0

• インスタンスメソッド

サマリの文字列を返します。

サマリの文字列を返します。

//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

puts opts.help

# => Usage: example.rb [options]
# -v...

• OptionParser

OptionParser#on_head(*arg, &block) -> self (9004.0)

• 2.2.0

• インスタンスメソッド

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

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

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

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

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

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

puts opts.help

# => ...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

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

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

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tai...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。
ブロックが与えられている場合は、パースを中断せずに
引数をブロックに渡してブロックを評価し、パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができません。
-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配列で指定...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

オプションではないコマンドの引数(下の例で言うと somefile)に出会うと、パースを中断します。
ブロックが与えられている場合は、パースを中断せずに
引数をブロックに渡してブロックを評価し、パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができません。
-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配列で指定...

• OptionParser

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

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

ブロックが与えられている場合は、パースを中断せずに引数をブロックに渡してブロックを評価し、
パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができま
せん。-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配列で指定します。

@param a...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

ブロックが与えられている場合は、パースを中断せずに引数をブロックに渡してブロックを評価し、
パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができま
せん。-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配列で指定します。

@param a...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

ブロックが与えられている場合は、パースを中断せずに引数をブロックに渡してブロックを評価し、
パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができま
せん。-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配列で指定します。

@param a...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

ブロックが与えられている場合は、パースを中断せずに引数をブロックに渡してブロックを評価し、
パースを継続します。argv を返します。

下の例で言うと、コマンドの引数 somefile よりも後ろにオプションを置くことができま
せん。-b もコマンドのオプションではない引数として扱われてしまいます。

@param argv パースしたい引数を文字列の配列で指定します。

@param a...

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param argv パースしたい引数を文字列の配列で指定します。


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

• OptionParser

絞り込み条件を変える

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

• 2.2.0

• インスタンスメソッド

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

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

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


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

• OptionParser

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

• 2.2.0

• インスタンスメソッド

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

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

下の例で言うと、order と違いコマンドの引数 somefile よりも後ろにオプションを置くことが
できます。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。


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

• OptionParser

OptionParser#program_name -> String (9004.0)

• 2.2.0

• インスタンスメソッド

プログラムの名前を文字列で返します。

プログラムの名前を文字列で返します。

デフォルトは $0 が使われます。

@return プログラムの名前を文字列で返します。

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

OptionParser.new do |opts|
p $0 # => /path/to/filename.rb
p opts.program_name # => filename
end
//}

• OptionParser

OptionParser#program_name=(name) (9004.0)

• 2.2.0

• インスタンスメソッド

プログラムの名前を文字列で指定します。

プログラムの名前を文字列で指定します。

@param name プログラムの名前を文字列で指定します。

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

OptionParser.new do |opts|
$0 # => /path/to/filename.rb
opts.program_name # => filename
opts.program_name = 'test' # => "test"
opts.program_name # => "test"...

• OptionParser

OptionParser#release -> String (9004.0)

• 2.2.0

• インスタンスメソッド

プログラムのリリースを文字列で返します。

プログラムのリリースを文字列で返します。

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

OptionParser.new do |opts|
opts.release # => nil
opts.release = "2019-05-01"
opts.release # => "2019-05-01"
end
//}

• OptionParser

絞り込み条件を変える

OptionParser#release=(rel) (9004.0)

• 2.2.0

• インスタンスメソッド

プログラムのリリースを文字列で指定します。

プログラムのリリースを文字列で指定します。

@param rel プログラムのリリースを文字列で指定します。


@see OptionParser#ver

• OptionParser

OptionParser#separator(sep) -> () (9004.0)

• 2.2.0

• インスタンスメソッド

サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。

@param sep サマリの区切りを文字列で指定します。

//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"

opts.separator ""
opts.separator...

• OptionParser

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> () (9004.0)

• 2.2.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。

@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

@param width サマリの幅を整数で指定します。

@param max サマリの最大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//emlist[例][ruby]{
requ...

• OptionParser

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> () (9004.0)

• 2.2.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。

@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

@param width サマリの幅を整数で指定します。

@param max サマリの最大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//emlist[例][ruby]{
requ...

• OptionParser

OptionParser#summary_indent -> String (9004.0)

• 2.2.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で返します。

サマリを表示する時のインデントを文字列で返します。

@return サマリを表示する時のインデントを文字列で返します。

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

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

opts.summary_indent # => " "
opts.summarize
# => [" -i,...

• OptionParser

絞り込み条件を変える

OptionParser#summary_indent=(indent) (9004.0)

• 2.2.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で指定します。

サマリを表示する時のインデントを文字列で指定します。

@param indent サマリを表示する時に使われるインデントを文字列で指定します。

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

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

opts.summary_indent # => " "
opts.summarize
# ...

• OptionParser

OptionParser#summary_width -> Integer (9004.0)

• 2.2.0

• インスタンスメソッド

サマリを表示するときの幅を整数で返します。

サマリを表示するときの幅を整数で返します。

@return サマリを表示するときの幅を整数で返します。

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

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

opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n", " ...

• OptionParser

OptionParser#summary_width=(width) (9004.0)

• 2.2.0

• インスタンスメソッド

サマリを表示するときの幅を整数で指定します。

サマリを表示するときの幅を整数で指定します。

@param width サマリを表示するときの幅を整数で指定します。

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

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

opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n"...

• OptionParser

OptionParser#to_a -> [String] (9004.0)

• 2.2.0

• インスタンスメソッド

サマリの各行を要素とした配列を返します。

サマリの各行を要素とした配列を返します。

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

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

opts.to_a # => ["Usage: test [options]", " -i, --init\n", " -u, --update\n", " -h, --help\n"]
//}

• OptionParser

OptionParser#to_s -> String (9004.0)

• 2.2.0

• インスタンスメソッド

サマリの文字列を返します。

サマリの文字列を返します。

//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

puts opts.help

# => Usage: example.rb [options]
# -v...

• OptionParser

絞り込み条件を変える