Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > uriライブラリ > URI::Genericクラス

class URI::Generic

クラスの継承リスト: URI::Generic < URI < Object < Kernel < BasicObject

Abstract

すべての URI クラスの基底クラスです。

特異メソッド

build(ary) -> URI::Generic

build(hash) -> URI::Generic

引数で与えられた URI 構成要素から URI::Generic オブジェクトを生成します。

[PARAM] ary:

構成要素を表す配列を与えます。要素は以下の順です。

      [scheme, userinfo, host, port, registry, path, opaque, query, fragment]

[UNKNOWN_META_INFO] @path:

hash 構成要素を表すハッシュを与えます。ハッシュのキーはシンボルは以下のいずれかです。ハッシュの値は文字列で与えます。

      :scheme ,:userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment

[EXCEPTION] URI::InvalidComponentError:

各要素が適合しない場合に発生します。

build2(ary) -> URI::Generic

build2(hash) -> URI::Generic

URI::Generic.build と同じですが、例外 URI::InvalidComponentError が発生した場合に、引数の各要素を URI.escape して再度 build を試みます。

[PARAM] ary:

構成要素を表す文字列の配列を与えます。要素は以下の順です。

      [scheme, userinfo, host, port, registry, path, opaque, query, fragment]

[PARAM] hash:

構成要素を表すハッシュを与えます。ハッシュのキーはシンボルは以下のいずれかです。ハッシュの値は文字列で与えます。

      :scheme, :userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment

component -> [Symbol]

URI の構成要素を表すシンボルの配列を返します。

require 'uri'
p URI::Generic.component
p URI::MailTo.component

# => [:scheme, :userinfo, :host, :port, :registry, :path, :opaque, :query, :fragment]
# => [:scheme, :to, :headers]

default_port -> Integer | nil

スキームに対応するデフォルトのポート番号を整数で返します。

require 'uri'
URI::Generic.default_port     # => nil
URI::FTP.default_port         # => 21
URI::HTTP.default_port        # => 80
URI::HTTPS.default_port       # => 443
URI::LDAP.default_port        # => 389
URI::LDAPS.default_port       # => 636
URI::MailTo.default_port      # => nil

new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, arg_check = false) -> URI::Generic

各引数を成分とする URI::Generic オブジェクトを生成して返します。

[PARAM] scheme:: 構成要素 scheme を表す文字列を与えます。
[PARAM] userinfo:: 構成要素を表す文字列を与えます。
[PARAM] host:: 構成要素を表す文字列を与えます。
[PARAM] port:: 構成要素を表す文字列を与えます。
[PARAM] registry:: 構成要素を表す文字列を与えます。
[PARAM] path:: 構成要素を表す文字列を与えます。
[PARAM] opaque:: 構成要素を表す文字列を与えます。
[PARAM] query:: 構成要素を表す文字列を与えます。
[PARAM] fragment:: 構成要素を表す文字列を与えます。
[PARAM] arg_check:: 真が与えられた場合は、各引数が字句規則に適合しているか否かを検査します。適合しない場合は例外 URI::InvalidComponentError が起ります。
[EXCEPTION] URI::InvalidURIError:: use_registry が偽のとき、registry が与えられると発生します。

use_registry -> bool

構成要素 registry を受け付けるなら true を返します。 URI::Generic クラスでは false です。

インスタンスメソッド

merge(rel) -> URI::Generic

self + rel -> URI::Generic

自身と与えられたパス rel を連結した新しい URI オブジェクトを生成して返します。

[RFC3986] の Section 5.2 の仕様に従います。 rel が文字列の場合は URI.parse(rel) によって、URI に変換してから連結します。

[PARAM] rel:: 連結したいパスを文字列か URI オブジェクトで与えます。

例:

require 'uri'
p URI.parse('http://www.ruby-lang.org/') + '/en/raa.html'
#=> #<URI::HTTP:0x201001c0 URL:http://www.ruby-lang.org/en/raa.html>
URI('http://a/b/c/d;p?q').merge('?y')            #=> #<URI::HTTP:0xb7ca2e2c URL:http://a/b/c/d;p?y>
URI('http://a/b/c/d;p?q').merge('/./g')          #=> #<URI::HTTP:0xb7ca2738 URL:http://a/g>
URI('http://a/b/c/d;p?q').merge('/../g')         #=> #<URI::HTTP:0xb7ca2008 URL:http://a/g>
URI('http://a/b/c/d;p?q').merge('../../../g')    #=> #<URI::HTTP:0xb7ca1888 URL:http://a/g>
URI('http://a/b/c/d;p?q').merge('../../../../g') #=> #<URI::HTTP:0xb7ca10a4 URL:http://a/g>

route_from(src) -> URI::Generic

self - src -> URI::Generic

与えられた URI を表す src からの相対パスを返します。

[PARAM] src:: 自身の相対パスを算出するための、ルートとなる Absolute URI を与えます。

例:

require 'uri'
p URI.parse('http://www.ruby-lang.org/en/raa.html') - 'http://www.ruby-lang.org/'
#=> #<URI::Generic:0x20100256 URL:en/raa.html>

self == uri -> bool

引数に指定した URI (文字列またはURIオブジェクト)との一致判定を行います。URI は正規化して比較されます。

[PARAM] uri:: 比較したい URI を URI オブジェクトで指定します。

例:

require 'uri'
u1 = URI.parse('http://example.com/?hoge')
u2 = URI.parse('http://Example.Com/?hoge')
p u1 == u2                                  #=> true

absolute -> bool

absolute? -> bool

自身に scheme が設定されているなら true を返します。そうでない場合は false を返します。

例:

p URI.parse('http://example.com/').absolute?    #=> true
p URI.parse('./').absolute?                     #=> false

component -> [Symbol]

self.class.component を返します。

[SEE_ALSO] URI::Generic.component

default_port -> Integer | nil

self.class.default_port を返します。

[SEE_ALSO] URI::Generic.default_port

fragment -> String | nil

自身の fragment を文字列で返します。設定されていない場合は nil を返します。

例:

require 'uri'
u = URI.parse('http://example.com/#frgmt')
p u.fragment                                #=> "frgmt"

fragment=(s)

自身の fragment を設定します。

[PARAM] s:: 自身の fragment を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。

hierarchical? -> bool

自身に path が設定されているなら true を返します。そうでない場合は false を返します。

host -> String | nil

自身の host を文字列で返します。設定されていない場合は nil を返します。

host=(s)

自身の host を設定します。

[PARAM] s:: 自身の host を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: host と registry を同時に設定した場合に発生します。

merge!(rel) -> self

与えられたパス rel を自身へ連結します。

[RFC2396] の Section 5.2 の仕様に従います。 rel が文字列の場合は URI.parse(rel) によって、URI に変換してから連結します。

[PARAM] rel:: 連結したいパスを文字列か URI オブジェクトで与えます。

例:

u = URI.parse('http://www.ruby-lang.org/')
u.merge!('/en/raa.html')
p u.to_s                                   #=> http://www.ruby-lang.org/en/raa.html

normalize -> URI::Generic

normalize! -> nil

URI オブジェクトを正規化して返します。ホスト名を小文字にし、パスと構成要素がなければ '/' をセットします。

例:

u = URI.parse('http://Example.Com')
p u.to_s                            #=> "http://Example.Com"
p u.normalize.to_s                  #=> "http://example.com/"

opaque -> String | nil

自身の opaque を文字列で返します。設定されていない場合は nil を返します。

例:

p URI.parse('http://example.com/').opaque       #=> nil
p URI.parse('mailto:nospam@localhost').opaque   #=> "nospam@localhost"
p URI.parse('urn:ietf:rfc:1149').opaque         #=> "ietf:rfc:1149"

opaque=(s)

自身の opaque を設定します。

[PARAM] s:: 自身の opaque を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: opaque とヒエラルキーパートを同時に設定した場合に発生します。

password -> String | nil

自身の password を文字列で返します。設定されていない場合は nil を返します。

password=(s)

自身の password を設定します。

自身に user が設定されていない場合には例外が発生します。

[PARAM] s:: 自身の password を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: userinfo と registry を同時に設定した場合に発生します。

path -> String | nil

自身の path を文字列で返します。設定されていない場合は nil を返します。

p URI.parse('http://example.com/hoge').path       #=> "/hoge"
p URI.parse('http://example.com').path            #=> ""
p URI.parse('mailto:nospam@localhost').path       #=> nil
p URI('ftp://example.com/foo').path    #=> 'foo'
p URI('ftp://example.com/%2Ffoo').path #=> '/foo'

path=(s)

自身の path を設定します。

[PARAM] s:: 自身の path を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: opaque と path を同時に設定した場合に発生します。

port -> String | nil

自身の port を文字列で返します。設定されていない場合は nil を返します。

port=(s)

自身の port を設定します。

[PARAM] s:: 自身の port を表す文字列か整数を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: port と registry を同時に設定した場合に発生します。

query -> String | nil

自身の query を文字列で返します。設定されていない場合は nil を返します。

例:

p URI.parse('http://example.com/?hoge').query   #=> "hoge"

query=(s)

自身の query を設定します。

[PARAM] s:: 自身の query を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: opaque と query を同時に設定した場合に発生します。

registry -> String | nil

自身の registry を文字列で返します。設定されていない場合は nil を返します。

registry=(s)

自身の registry を設定します。

[PARAM] s:: 自身の registry を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: server 部と registry を同時に設定した場合に発生します。

relative? -> bool

自身に scheme が設定されていないなら true を返します。そうでない場合は false を返します。

例:

p URI.parse('http://example.com/').relative?    #=> false
p URI.parse('./').relative?                     #=> true

route_to(dst) -> URI::Generic

自身から dst への相対パスを返します。

[PARAM] dst:: URI を文字列かURIオブジェクトで与えます。

例:

require 'uri'
p URI.parse('http://www.ruby-lang.org/').route_to('http://www.ruby-lang.org/en/raa.html')

#=> #<URI::Generic:0x20100198 URL:en/raa.html>

scheme -> String | nil

自身の scheme を文字列で返します。設定されていない場合は nil を返します。

scheme=(s)

自身の scheme を設定します。

[PARAM] s:: 自身の scheme を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。

select(*components) -> [String]

指定された components に対応する構成要素を文字列の配列として返します。

[PARAM] components:: 構成要素名をシンボルで指定します。

例:

require 'uri'

uri = URI.parse('http://myuser:mypass@my.example.com/test.rbx')
p uri.select(:userinfo, :host, :path)
# => ["myuser:mypass", "my.example.com", "/test.rbx"]

to_s -> String

to_str -> String

自身が表す URI を文字列として返します。

例:

p URI.parse('http://example.com/').to_s #=> "http://example.com/"

user -> String | nil

自身の userinfo を文字列で返します。

userinfo が「username:password」の形式である場合は、username 部を返します。設定されていない場合は nil を返します。

user=(s)

自身の user を設定します。

[PARAM] s:: 自身の user を表す文字列を指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: user と registry を同時に設定した場合に発生します。

userinfo -> String | nil

自身の userinfo を "username:password" という形式の文字列で返します。設定されていない場合は nil を返します。

userinfo=(s)

自身の userinfo を設定します。

[PARAM] s:: 自身の userinfo を "username" か "username:password" という形式の文字列、あるいは [username, password] という形式の文字列の配列で指定します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。
[EXCEPTION] URI::InvalidURIError:: userinfo と registry を同時に設定した場合に発生します。

例:

require 'uri'
u = URI.parse('http://example.com/')
u.userinfo = 'hoge-san:jfae82kj'
p u.to_s                             #=> "http://hoge-san:jfae82kj@example.com/"

u.userinfo = 'oreore'
p u.to_s                             #=> "http://oreore:jfae82kj@example.com/"

u.userinfo = ['you', 'akakfd']
p u.to_s                             #=> "http://you:akakfd@example.com/"

class URI::Generic

Abstract

特異メソッド

インスタンスメソッド

Methods

Classes