検索結果

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

• 2.3.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] (63655.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Ripper::Lexer

Ripper#parse -> nil (54691.0)

• 2.3.0

• インスタンスメソッド

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

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

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

@see Ripper.parse

• Ripper

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

• 2.3.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] (27661.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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


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

• OptionParser

絞り込み条件を変える

URI::MailTo#to_mailtext -> String (27430.0)

• 2.3.0

• インスタンスメソッド

URI オブジェクトからメールテキスト文字列を生成します。

URI オブジェクトからメールテキスト文字列を生成します。

例:
require 'uri'
p mailto = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
print mailto.to_mailtext

=> #<URI::MailTo:0x20104a0e URL:mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr>
To: ruby-list@ruby-lang.org
Sub...

• URI::MailTo

OptionParser#default_argv=(argv) (27376.0)

• 2.3.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#load(filename = nil) -> bool (27370.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser

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

• 2.3.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#default_argv -> [String] (27322.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

opts = OptionParser.new

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

• OptionParser

絞り込み条件を変える

OptionParser#help -> String (27322.0)

• 2.3.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#release -> String (27322.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

• OptionParser

Net::HTTPHeader#each_value {|value| .... } -> () (18658.0)

• 2.3.0

• インスタンスメソッド

保持しているヘッダの値をブロックに渡し、呼びだします。

保持しているヘッダの値をブロックに渡し、呼びだします。

渡される文字列は ", " で連結したものです。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_value { |value| puts value }

# => gzip;q=1.0,deflate;q=0.6,identity;q=0.3
# => */*
# => Ruby
//}

• Net::HTTPHeader

Net::HTTPHeader#content_length=(len) (18640.0)

• 2.3.0

• インスタンスメソッド

Content-Length: ヘッダフィールドに値を設定します。

Content-Length: ヘッダフィールドに値を設定します。

len に nil を与えると Content-Length: ヘッダフィールドを
削除します。

@param len 設定する値を整数で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_length # => nil
req.content_length = ...

• Net::HTTPHeader

Net::HTTPResponse#value -> nil (18376.0)

• 2.3.0

• インスタンスメソッド

レスポンスが 2xx(成功)でなかった場合に、対応する 例外を発生させます。

レスポンスが 2xx(成功)でなかった場合に、対応する
例外を発生させます。

@raise HTTPError レスポンスが 1xx であるか、 net/http が知らない
種類のレスポンスである場合に発生します。
@raise HTTPRetriableError レスポンスが 3xx である場合に発生します。
@raise HTTPServerException レスポンスが 4xx である場合に発生します。
@raise HTTPFatalError レスポンスが 5xx である場合に発生します。

//emlist[例 レスポンスが 2xx(成功)...

• Net::HTTPResponse

絞り込み条件を変える

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (18352.0)

• 2.3.0

• インスタンスメソッド

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Ruby
• RDoc::TopLevel

CSV::FieldInfo#line -> Integer (18340.0)

• 2.3.0

• インスタンスメソッド

行番号を返します。

行番号を返します。

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

csv = CSV.new("date1,date2,date3\n2018-07-09,2018-07-10\n2018-08-09,2018-08-10", headers: true)
csv.convert do |field,field_info|
p field_info.line
Date.parse(field)
end
p csv.to_a

# => 2
# => 2
# => 3
# => 3
# => [#<CSV::Row "date1":#<Date: 2018-07...

• CSV::FieldInfo

Net::HTTPHeader#content_length -> Integer|nil (18340.0)

• 2.3.0

• インスタンスメソッド

Content-Length: ヘッダフィールドの表している値を整数で返します。

Content-Length: ヘッダフィールドの表している値を整数で返します。

ヘッダが設定されていない場合には nil を返します。

@raise Net::HTTPHeaderSyntaxError フィールドの値が不正である場合に
発生します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
re...

• Net::HTTPHeader

Net::HTTPHeader#delete(key) -> [String] | nil (18340.0)

• 2.3.0

• インスタンスメソッド

key ヘッダフィールドを削除します。

key ヘッダフィールドを削除します。

@param key 削除するフィールド名
@return 取り除かれたフィールドの値を返します。
key ヘッダフィールドが存在しなかった場合には
nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_length = 10
req.content_length...

• Net::HTTPHeader

Net::HTTPHeader#each_capitalized_name {|name| .... } -> () (18340.0)

• 2.3.0

• インスタンスメソッド

保持しているヘッダ名を正規化 ('x-my-header' -> 'X-My-Header') して、ブロックに渡します。

保持しているヘッダ名を正規化
('x-my-header' -> 'X-My-Header')
して、ブロックに渡します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_capitalized_name { |key| puts key }

# => Accept-Encoding
# => Accept
# => User-Agent
//}

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#get_fields(key) -> [String] (18340.0)

• 2.3.0

• インスタンスメソッド

key ヘッダフィールドの値 (文字列) を配列で返します。

key ヘッダフィールドの値 (文字列) を配列で返します。

たとえばキー 'content-length' に対しては ['2048'] のような
文字列が得られます。一種類のヘッダフィールドが一つのヘッダの中
に複数存在することがありえます。
key は大文字小文字を区別しません。

@param key ヘッダフィール名を文字列で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(ur...

• Net::HTTPHeader

Net::HTTPHeader#range_length -> Integer|nil (18340.0)

• 2.3.0

• インスタンスメソッド

Content-Range: ヘッダフィールドの表している長さを整数で返します。

Content-Range: ヘッダフィールドの表している長さを整数で返します。

ヘッダが設定されていない場合には nil を返します。

@raise Net::HTTPHeaderSyntaxError Content-Range: ヘッダフィールド
の値が不正である場合に
発生します。


//emlist[例][ruby]{
require 'net/http'

uri = UR...

• Net::HTTPHeader

OptionParser::Arguable#getopts(short_opt, *long_opt) -> Hash (18340.0)

• 2.3.0

• インスタンスメソッド

指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。

指定された short_opt や long_opt に応じて自身をパースし、結果を Hash として返します。

コマンドラインに - もしくは -- を指定した場合、それ以降の解析を行ないません。

@param short_opt ショートネームのオプション(-f や -fx)を文字列で指定します。オプションが -f と -x の
2つの場合は "fx" の様に指定します。ここでオプションがないときは空文字列を指定します。
オプションが引数をとる場合は直後に ":" を付けます。

@param long_opt ロン...

• OptionParser::Arguable

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

• 2.3.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::Arguable#options {|opt| ... } -> object | nil (18340.0)

• 2.3.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

絞り込み条件を変える

REXML::StreamListener#entitydecl(content) -> () (18340.0)

• 2.3.0

• インスタンスメソッド

DTDの実体宣言をパースしたときに呼び出されるコールバックメソッドです。

DTDの実体宣言をパースしたときに呼び出されるコールバックメソッドです。

@param content 実体宣言が配列で渡されます

実体宣言の書き方によって content に渡されるデータの形式が異なります。

//emlist[][ruby]{
require 'rexml/parsers/baseparser'
require 'rexml/parsers/streamparser'
require 'rexml/streamlistener'
xml = <<EOS
<!DOCTYPE root [
<!ENTITY % YN '"Yes"'>
<!ENTITY % YN 'Yes...

• REXML::StreamListener

URI::MailTo#to_rfc822text -> String (18130.0)

• 2.3.0

• インスタンスメソッド

URI オブジェクトからメールテキスト文字列を生成します。

URI オブジェクトからメールテキスト文字列を生成します。

例:
require 'uri'
p mailto = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
print mailto.to_mailtext

=> #<URI::MailTo:0x20104a0e URL:mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr>
To: ruby-list@ruby-lang.org
Sub...

• URI::MailTo

OptionParser#to_s -> String (18022.0)

• 2.3.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::Arguable#order! -> [String] (18022.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser::Arguable

OptionParser::Arguable#order! {|s| ... } -> [String] (18022.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser::Arguable

絞り込み条件を変える

OptionParser::Arguable#permute! -> [String] (18022.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser::Arguable

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

• 2.3.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| ... } -> () (9622.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

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

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

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

• OptionParser

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

• 2.3.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, long, pat = /.*/, desc = "") {|v| ...} -> self (9412.0)

• 2.3.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 (9412.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

• OptionParser

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

• 2.3.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#on(long, *rest) {|v| ...} -> self (9397.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

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

• OptionParser
• OptionParser::InvalidArgument

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

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

• OptionParser
• OptionParser::InvalidArgument

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

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

• OptionParser
• OptionParser::InvalidArgument

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• ArgumentError
• OptionParser
• OptionParser::InvalidArgument

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

• 2.3.0

• インスタンスメソッド

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

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

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

• ArgumentError
• OptionParser
• OptionParser::InvalidArgument

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

• 2.3.0

• インスタンスメソッド

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

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

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

• ArgumentError
• OptionParser
• OptionParser::InvalidArgument

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

• 2.3.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

CSV::FieldInfo#header -> String | nil (9340.0)

• 2.3.0

• インスタンスメソッド

利用可能な場合はヘッダを表す文字列を返します。

利用可能な場合はヘッダを表す文字列を返します。

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

csv = CSV.new("date1,date2\n2018-07-09,2018-07-10", headers: true)
csv.convert do |field,field_info|
p field_info.header
Date.parse(field)
end
p csv.first

# => "date1"
# => "date2"
# => #<CSV::Row "date1":#<Date: 2018-07-09 ((2458309j,...

• CSV::FieldInfo

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser

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

• 2.3.0

• インスタンスメソッド

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

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

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

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


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

• OptionParser

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

• 2.3.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, desc = "") {|v| ... } -> self (9337.0)

• 2.3.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, desc = "") {|v| ... } -> self (9337.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser

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

• 2.3.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

Kernel#JSON(object, options = {}) -> object (9124.0)

• 2.3.0

• インスタンスメソッド

第一引数に与えられたオブジェクトの種類によって Ruby のオブジェクトか JSON 形式の文字列を返します。

第一引数に与えられたオブジェクトの種類によって Ruby のオブジェクトか JSON 形式の文字列を返します。

第一引数に文字列のようなオブジェクトを指定した場合は、それを JSON.#parse を用いてパースした結果を返します。
そうでないオブジェクトを指定した場合は、それを JSON.#generate を用いて変換した結果を返します。

@param object 任意のオブジェクトを指定します。

@param options JSON.#parse, JSON.#generate に渡すオプションを指定します。

//emlist[例][ruby]{
require "json...

• Kernel

URI::MailTo#headers -> [[String]] (9058.0)

• 2.3.0

• インスタンスメソッド

自身のヘッダーを文字列の配列の配列として設定します。

自身のヘッダーを文字列の配列の配列として設定します。

例:
require 'uri'
m = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
p m.headers #=> [["subject", "subscribe"], ["cc", "myaddr"]]

• URI::MailTo

CSV::FieldInfo#index -> Integer (9040.0)

• 2.3.0

• インスタンスメソッド

行内で何番目のフィールドかわかるゼロベースのインデックスを返します。

行内で何番目のフィールドかわかるゼロベースのインデックスを返します。

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

csv = CSV.new("date1,date2\n2018-07-09,2018-07-10", headers: true)
csv.convert do |field,field_info|
p field_info.index
Date.parse(field)
end
p csv.first

# => 0
# => 1
# => #<CSV::Row "date1":#<Date: 2018-07-09 ((2458309j,0s...

• CSV::FieldInfo

絞り込み条件を変える

CSV#convert {|field, field_info| ... } (658.0)

• 2.3.0

• インスタンスメソッド

引数 name で指定した変換器かブロックに各フィールドを渡して文字列から別 のオブジェクトへと変換します。

引数 name で指定した変換器かブロックに各フィールドを渡して文字列から別
のオブジェクトへと変換します。

引数 name を指定した場合は、組み込みの CSV::Converters を変換器
として利用するために使います。また、独自の変換器を追加することもできま
す。

ブロックパラメータを一つ受け取るブロックを与えた場合は、そのブロックは
フィールドを受け取ります。ブロックパラメータを二つ受け取るブロックを与
えた場合は、そのブロックは、フィールドと CSV::FieldInfo のインス
タンスを受け取ります。ブロックは変換後の値かフィールドそのものを返さな
ければなりません。
...

• CSV
• CSV::FieldInfo

Net::HTTPHeader#fetch(key, default) -> String (448.0)

• 2.3.0

• インスタンスメソッド

key ヘッダフィールドを返します。

key ヘッダフィールドを返します。

たとえばキー 'content-length' に対しては '2048'
のような文字列が得られます。キーが存在しなければ nil を返します。

該当するキーが登録されてい
ない時には、引数 default が与えられていればその値を、ブロッ
クが与えられていればそのブロックを評価した値を返します。

一種類のヘッダフィールドが一つのヘッダの中に複数存在する
場合にはそれを全て ", " で連結した文字列を返します。
key は大文字小文字を区別しません。

@param key ヘッダフィール名を文字列で与えます。
@param default 該...

• Net::HTTPHeader

Net::HTTPHeader#range -> Range|nil (376.0)

• 2.3.0

• インスタンスメソッド

Range: ヘッダの示す範囲を Range オブジェクトで返します。

Range: ヘッダの示す範囲を Range オブジェクトで返します。

ヘッダにない場合は nil を返します。

@raise Net::HTTPHeaderSyntaxError Range:ヘッダの中身が規格通り
でない場合に発生します。

//emlist[例 正常な値][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
r...

• Net::HTTPHeader
• Range

Net::HTTPResponse#read_body(dest=nil) -> String|nil (376.0)

• 2.3.0

• インスタンスメソッド

ブロックを与えなかった場合にはエンティティボディを 文字列で返します。 ブロックを与えた場合には エンティティボディを少しずつ取得して順次ブロックに 文字列で与えます。

ブロックを与えなかった場合にはエンティティボディを
文字列で返します。
ブロックを与えた場合には
エンティティボディを少しずつ取得して順次ブロックに
文字列で与えます。

レスポンスがボディを持たない場合には nil を返します。

//emlist[例1 ブロックを与えずに一度に結果取得][ruby]{
require 'net/http'

uri = "http://www.example.com/index.html"
response = Net::HTTP.get_response(URI.parse(uri))
response.read_body[0..10] # => "<...

• Net::HTTPResponse

CSV#convert {|field| ... } (358.0)

• 2.3.0

• インスタンスメソッド

引数 name で指定した変換器かブロックに各フィールドを渡して文字列から別 のオブジェクトへと変換します。

引数 name で指定した変換器かブロックに各フィールドを渡して文字列から別
のオブジェクトへと変換します。

引数 name を指定した場合は、組み込みの CSV::Converters を変換器
として利用するために使います。また、独自の変換器を追加することもできま
す。

ブロックパラメータを一つ受け取るブロックを与えた場合は、そのブロックは
フィールドを受け取ります。ブロックパラメータを二つ受け取るブロックを与
えた場合は、そのブロックは、フィールドと CSV::FieldInfo のインス
タンスを受け取ります。ブロックは変換後の値かフィールドそのものを返さな
ければなりません。
...

• CSV
• CSV::FieldInfo

絞り込み条件を変える

Net::HTTPHeader#[](key) -> String|nil (358.0)

• 2.3.0

• インスタンスメソッド

key ヘッダフィールドを返します。

key ヘッダフィールドを返します。

たとえばキー 'content-length' に対しては '2048'
のような文字列が得られます。キーが存在しなければ nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req['user-agent'] # => Ruby
//}

一種類のヘッダフィールドが一つのヘッダの中に複数存在する
場合にはそれを全て...

• Net::HTTPHeader

Net::HTTPHeader#[]=(key, val) (358.0)

• 2.3.0

• インスタンスメソッド

key ヘッダフィールドに文字列 val をセットします。

key ヘッダフィールドに文字列 val をセットします。

key に元々設定されていた値は破棄されます。
key は大文字小文字を区別しません。
val に nil を与えるとそのフィールドを削除します。

@param key ヘッダフィール名を文字列で与えます。
@param val keyで指定したフィールドにセットする文字列を与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.re...

• Net::HTTPHeader

Net::HTTPHeader#each {|name, val| .... } -> () (358.0)

• 2.3.0

• インスタンスメソッド

保持しているヘッダ名とその値をそれぞれ ブロックに渡して呼びだします。

保持しているヘッダ名とその値をそれぞれ
ブロックに渡して呼びだします。

ヘッダ名は小文字で統一されます。
val は ", " で連結した文字列がブロックに渡されます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_header { |key,value| puts "#{key} = #{value}" }

# => accept-encoding...

• Net::HTTPHeader

Net::HTTPHeader#each_header {|name, val| .... } -> () (358.0)

• 2.3.0

• インスタンスメソッド

保持しているヘッダ名とその値をそれぞれ ブロックに渡して呼びだします。

保持しているヘッダ名とその値をそれぞれ
ブロックに渡して呼びだします。

ヘッダ名は小文字で統一されます。
val は ", " で連結した文字列がブロックに渡されます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_header { |key,value| puts "#{key} = #{value}" }

# => accept-encoding...

• Net::HTTPHeader

Net::HTTPGenericRequest#request_body_permitted? -> bool (340.0)

• 2.3.0

• インスタンスメソッド

リクエストにエンティティボディを一緒に送ることが許されている HTTP メソッド (POST など)の場合真を返します。

リクエストにエンティティボディを一緒に送ることが許されている
HTTP メソッド (POST など)の場合真を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
post = Net::HTTP::Post.new(uri.request_uri)
post.request_body_permitted? # => true

head = Net::HTTP::Head.new(uri.request_uri)
head.request_bo...

• Net::HTTPGenericRequest

絞り込み条件を変える

Net::HTTPGenericRequest#response_body_permitted? -> bool (340.0)

• 2.3.0

• インスタンスメソッド

サーバからのレスポンスにエンティティボディを含むことが許されている HTTP メソッド (GET, POST など)の場合真を返します。

サーバからのレスポンスにエンティティボディを含むことが許されている
HTTP メソッド (GET, POST など)の場合真を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
post = Net::HTTP::Post.new(uri.request_uri)
post.response_body_permitted? # => true

head = Net::HTTP::Head.new(uri.request_uri)
head.r...

• Net::HTTPGenericRequest

Net::HTTPHeader#chunked? -> bool (340.0)

• 2.3.0

• インスタンスメソッド

Transfer-Encoding: ヘッダフィールドが "chunked" である 場合に真を返します。

Transfer-Encoding: ヘッダフィールドが "chunked" である
場合に真を返します。

Transfer-Encoding: ヘッダフィールドが存在しなかったり、
"chunked" 以外である場合には偽を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.chunked? # => false
req["Transfer-Encodin...

• Net::HTTPHeader

Net::HTTPHeader#content_range -> Range|nil (340.0)

• 2.3.0

• インスタンスメソッド

Content-Range: ヘッダフィールドの値を Range で返します。 Range の表わす長さは Net::HTTPHeader#range_length で得られます。

Content-Range: ヘッダフィールドの値を Range で返します。
Range の表わす長さは Net::HTTPHeader#range_length で得られます。

ヘッダが設定されていない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_range # => nil
req['Content...

• Net::HTTPHeader

Net::HTTPHeader#content_type -> String|nil (340.0)

• 2.3.0

• インスタンスメソッド

"text/html" のような Content-Type を表す 文字列を返します。

"text/html" のような Content-Type を表す
文字列を返します。

Content-Type: ヘッダフィールドが存在しない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/comments.cgi?post=comment')
req = Net::HTTP::Post.new(uri.request_uri)
req.content_type # => nil
req.content_type = 'multipart/for...

• Net::HTTPHeader

Net::HTTPHeader#key?(key) -> bool (340.0)

• 2.3.0

• インスタンスメソッド

key というヘッダフィールドがあれば真を返します。 key は大文字小文字を区別しません。

key というヘッダフィールドがあれば真を返します。
key は大文字小文字を区別しません。

@param key 探すヘッダフィールド名を文字列で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.key?('content-type') # => true
res.key?('nonexist-header') # => false
//}

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#main_type -> String|nil (340.0)

• 2.3.0

• インスタンスメソッド

"text/html" における "text" のようなタイプを表す 文字列を返します。

"text/html" における "text" のようなタイプを表す
文字列を返します。

Content-Type: ヘッダフィールドが存在しない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.main_type # => "text"
//}

• Net::HTTPHeader

Net::HTTPHeader#sub_type -> String|nil (340.0)

• 2.3.0

• インスタンスメソッド

"text/html" における "html" のようなサブタイプを表す 文字列を返します。

"text/html" における "html" のようなサブタイプを表す
文字列を返します。

Content-Type: ヘッダフィールドが存在しない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.sub_type # => "html"
//}

• Net::HTTPHeader

Net::HTTPResponse#body -> String | () | nil (340.0)

• 2.3.0

• インスタンスメソッド

エンティティボディを返します。

エンティティボディを返します。

レスポンスにボディがない場合には nil を返します。

Net::HTTPResponse#read_body をブロック付きで呼んだ場合には
このメソッドはNet::ReadAdapter のインスタンスを返しますが、
これは使わないでください。

entity は obsolete です。

//emlist[例][ruby]{
require 'net/http'

uri = "http://www.example.com/index.html"
response = Net::HTTP.get_response(URI.parse(uri))
r...

• Net::HTTPResponse

Net::HTTPResponse#entity -> String | () | nil (340.0)

• 2.3.0

• インスタンスメソッド

エンティティボディを返します。

エンティティボディを返します。

レスポンスにボディがない場合には nil を返します。

Net::HTTPResponse#read_body をブロック付きで呼んだ場合には
このメソッドはNet::ReadAdapter のインスタンスを返しますが、
これは使わないでください。

entity は obsolete です。

//emlist[例][ruby]{
require 'net/http'

uri = "http://www.example.com/index.html"
response = Net::HTTP.get_response(URI.parse(uri))
r...

• Net::HTTPResponse