summaryrefslogtreecommitdiff
path: root/lib/uri
diff options
context:
space:
mode:
authorgsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-03-24 11:53:31 +0000
committergsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-03-24 11:53:31 +0000
commit42ad5216ec57a5890eb20230efb09e1aa53ed528 (patch)
treee165885640ee8aee2f1b0c76d5a295acb75430c9 /lib/uri
parent5e23ff603f53c99ac45e331e24498bfa124b4d72 (diff)
* lib/uri.rb: Documented (thanks Dmitry V. Sabanin).
* lib/uri/common.rb: Ditto. * lib/uri/ftp.rb: Ditto. * lib/uri/generic.rb: Ditto. * lib/uri/http.rb: Ditto. * lib/uri/https.rb: Ditto. * lib/uri/ldap.rb: Ditto. * lib/uri/mailto.rb: Ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@6015 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/uri')
-rw-r--r--lib/uri/common.rb407
-rw-r--r--lib/uri/ftp.rb130
-rw-r--r--lib/uri/generic.rb961
-rw-r--r--lib/uri/http.rb65
-rw-r--r--lib/uri/https.rb20
-rw-r--r--lib/uri/ldap.rb102
-rw-r--r--lib/uri/mailto.rb232
7 files changed, 957 insertions, 960 deletions
diff --git a/lib/uri/common.rb b/lib/uri/common.rb
index c9b3e0de70..175ef97304 100644
--- a/lib/uri/common.rb
+++ b/lib/uri/common.rb
@@ -1,19 +1,19 @@
+# = uri/common.rb
#
-# $Id$
+# Author:: Akira Yamada <akira@ruby-lang.org>
+# Revision:: $Id$
+# License::
+# You can redistribute it and/or modify it under the same term as Ruby.
#
-# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
-# You can redistribute it and/or modify it under the same term as Ruby.
-#
-
-=begin
-
-== URI
-
-=end
module URI
module REGEXP
+ #
+ # Patterns used to parse URI's
+ #
module PATTERN
+ # :stopdoc:
+
# RFC 2396 (URI Generic Syntax)
# RFC 2732 (IPv6 Literal Addresses in URL's)
# RFC 2373 (IPv6 Addressing Architecture)
@@ -143,23 +143,23 @@ module URI
# XXX:
X_ABS_URI = "
- (#{PATTERN::SCHEME}): (?# 1: scheme)
- (?:
- (#{PATTERN::OPAQUE_PART}) (?# 2: opaque)
- |
- (?:(?:
- //(?:
- (?:(?:(#{PATTERN::USERINFO})@)? (?# 3: userinfo)
- (?:(#{PATTERN::HOST})(?::(\\d*))?))?(?# 4: host, 5: port)
- |
- (#{PATTERN::REG_NAME}) (?# 6: registry)
- )
- |
- (?!//)) (?# XXX: '//' is the mark for hostport)
- (#{PATTERN::ABS_PATH})? (?# 7: path)
- )(?:\\?(#{PATTERN::QUERY}))? (?# 8: query)
- )
- (?:\\#(#{PATTERN::FRAGMENT}))? (?# 9: fragment)
+ (#{PATTERN::SCHEME}): (?# 1: scheme)
+ (?:
+ (#{PATTERN::OPAQUE_PART}) (?# 2: opaque)
+ |
+ (?:(?:
+ //(?:
+ (?:(?:(#{PATTERN::USERINFO})@)? (?# 3: userinfo)
+ (?:(#{PATTERN::HOST})(?::(\\d*))?))?(?# 4: host, 5: port)
+ |
+ (#{PATTERN::REG_NAME}) (?# 6: registry)
+ )
+ |
+ (?!//)) (?# XXX: '//' is the mark for hostport)
+ (#{PATTERN::ABS_PATH})? (?# 7: path)
+ )(?:\\?(#{PATTERN::QUERY}))? (?# 8: query)
+ )
+ (?:\\#(#{PATTERN::FRAGMENT}))? (?# 9: fragment)
"
X_REL_URI = "
(?:
@@ -179,13 +179,16 @@ module URI
(?:\\?(#{PATTERN::QUERY}))? (?# 7: query)
(?:\\#(#{PATTERN::FRAGMENT}))? (?# 8: fragment)
"
+ # :startdoc:
end # PATTERN
+ # :stopdoc:
+
# for URI::split
ABS_URI = Regexp.new('^' + PATTERN::X_ABS_URI + '$', #'
- Regexp::EXTENDED, 'N').freeze
+ Regexp::EXTENDED, 'N').freeze
REL_URI = Regexp.new('^' + PATTERN::X_REL_URI + '$', #'
- Regexp::EXTENDED, 'N').freeze
+ Regexp::EXTENDED, 'N').freeze
# for URI::extract
URI_REF = Regexp.new(PATTERN::URI_REF, false, 'N').freeze
@@ -195,7 +198,7 @@ module URI
# for URI::escape/unescape
ESCAPED = Regexp.new(PATTERN::ESCAPED, false, 'N').freeze
UNSAFE = Regexp.new("[^#{PATTERN::UNRESERVED}#{PATTERN::RESERVED}]",
- false, 'N').freeze
+ false, 'N').freeze
# for Generic#initialize
SCHEME = Regexp.new("^#{PATTERN::SCHEME}$", false, 'N').freeze #"
@@ -208,32 +211,33 @@ module URI
REL_PATH = Regexp.new("^#{PATTERN::REL_PATH}$", false, 'N').freeze #"
QUERY = Regexp.new("^#{PATTERN::QUERY}$", false, 'N').freeze #"
FRAGMENT = Regexp.new("^#{PATTERN::FRAGMENT}$", false, 'N').freeze #"
+ # :startdoc:
end # REGEXP
module Util
def make_components_hash(klass, array_hash)
tmp = {}
if array_hash.kind_of?(Array) &&
- array_hash.size == klass.component.size - 1
- klass.component[1..-1].each_index do |i|
- begin
- tmp[klass.component[i + 1]] = array_hash[i].clone
- rescue TypeError
- tmp[klass.component[i + 1]] = array_hash[i]
- end
- end
+ array_hash.size == klass.component.size - 1
+ klass.component[1..-1].each_index do |i|
+ begin
+ tmp[klass.component[i + 1]] = array_hash[i].clone
+ rescue TypeError
+ tmp[klass.component[i + 1]] = array_hash[i]
+ end
+ end
elsif array_hash.kind_of?(Hash)
- array_hash.each do |key, value|
- begin
- tmp[key] = value.clone
- rescue TypeError
- tmp[key] = value
- end
- end
+ array_hash.each do |key, value|
+ begin
+ tmp[key] = value.clone
+ rescue TypeError
+ tmp[key] = value
+ end
+ end
else
- raise ArgumentError,
- "expected Array of or Hash of components of #{klass.to_s} (#{klass.component[1..-1].join(', ')})"
+ raise ArgumentError,
+ "expected Array of or Hash of components of #{klass.to_s} (#{klass.component[1..-1].join(', ')})"
end
tmp[:scheme] = klass.to_s.sub(/\A.*::/, '').downcase
@@ -245,24 +249,72 @@ module URI
module Escape
include REGEXP
+ #
+ # == Synopsis
+ #
+ # URI.escape(str [, unsafe])
+ #
+ # == Args
+ #
+ # +str+::
+ # String to replaces in.
+ # +unsafe+::
+ # Regexp that matches all symbols that must be replaced with codes.
+ # By default uses <tt>REGEXP::SAFE</tt>.
+ #
+ # == Description
+ #
+ # Escapes the string, replacing all unsafe characters with codes.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # enc_uri = URI.escape("http://foobar.com/?a=\11\15")
+ # p enc_uri
+ # # => "http://foobar.com/?a=%09%0D"
+ #
+ # p URI.unescape(enc_uri)
+ # # => "http://foobar.com/?a=\t\r"
+ #
def escape(str, unsafe = UNSAFE)
unless unsafe.kind_of?(Regexp)
- # perhaps unsafe is String object
- unsafe = Regexp.new(Regexp.quote(unsafe), false, 'N')
+ # perhaps unsafe is String object
+ unsafe = Regexp.new(Regexp.quote(unsafe), false, 'N')
end
str.gsub(unsafe) do |us|
- tmp = ''
- us.each_byte do |uc|
- tmp << sprintf('%%%02X', uc)
- end
- tmp
+ tmp = ''
+ us.each_byte do |uc|
+ tmp << sprintf('%%%02X', uc)
+ end
+ tmp
end
end
alias encode escape
-
+ #
+ # == Synopsis
+ #
+ # URI.unescape(str)
+ #
+ # == Args
+ #
+ # +str+::
+ # Unescapes the string.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # enc_uri = URI.escape("http://foobar.com/?a=\11\15")
+ # p enc_uri
+ # # => "http://foobar.com/?a=%09%0D"
+ #
+ # p URI.unescape(enc_uri)
+ # # => "http://foobar.com/?a=\t\r"
+ #
def unescape(str)
str.gsub(ESCAPED) do
- $&[1,2].hex.chr
+ $&[1,2].hex.chr
end
end
alias decode unescape
@@ -272,20 +324,55 @@ module URI
extend Escape
@@schemes = {}
-
+
+ #
+ # Base class for all URI exceptions.
+ #
class Error < StandardError; end
- class InvalidURIError < Error; end # it is not URI.
- class InvalidComponentError < Error; end # it is not component of URI.
- class BadURIError < Error; end # the URI is valid but it is bad for the position.
-
-=begin
-
-=== Methods
-
---- URI::split(uri)
-
-=end
-
+ #
+ # Not a URI.
+ #
+ class InvalidURIError < Error; end
+ #
+ # Not a URI component.
+ #
+ class InvalidComponentError < Error; end
+ #
+ # URI is valid, bad usage is not.
+ #
+ class BadURIError < Error; end
+
+ #
+ # == Synopsis
+ #
+ # URI::split(uri)
+ #
+ # == Args
+ #
+ # +uri+::
+ # String with URI.
+ #
+ # == Description
+ #
+ # Splits the string on following parts and returns array with result:
+ #
+ # * Scheme
+ # * Userinfo
+ # * Host
+ # * Port
+ # * Registry
+ # * Path
+ # * Opaque
+ # * Query
+ # * Fragment
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # p URI.split("http://www.ruby-lang.org/")
+ # # => ["http", nil, "www.ruby-lang.org", nil, nil, "/", nil, nil, nil]
+ #
def self.split(uri)
case uri
when ''
@@ -293,7 +380,7 @@ module URI
when ABS_URI
scheme, opaque, userinfo, host, port,
- registry, path, query, fragment = $~[1..-1]
+ registry, path, query, fragment = $~[1..-1]
# URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
@@ -308,12 +395,12 @@ module URI
# server = [ [ userinfo "@" ] hostport ]
if !scheme
- raise InvalidURIError,
- "bad URI(absolute but no scheme): #{uri}"
+ raise InvalidURIError,
+ "bad URI(absolute but no scheme): #{uri}"
end
if !opaque && (!path && (!host && !registry))
- raise InvalidURIError,
- "bad URI(absolute but no path): #{uri}"
+ raise InvalidURIError,
+ "bad URI(absolute but no path): #{uri}"
end
when REL_URI
@@ -321,13 +408,13 @@ module URI
opaque = nil
userinfo, host, port, registry,
- rel_segment, abs_path, query, fragment = $~[1..-1]
+ rel_segment, abs_path, query, fragment = $~[1..-1]
if rel_segment && abs_path
- path = rel_segment + abs_path
+ path = rel_segment + abs_path
elsif rel_segment
- path = rel_segment
+ path = rel_segment
elsif abs_path
- path = abs_path
+ path = abs_path
end
# URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
@@ -348,41 +435,83 @@ module URI
path = '' if !path && !opaque # (see RFC2396 Section 5.2)
ret = [
scheme,
- userinfo, host, port, # X
- registry, # X
- path, # Y
- opaque, # Y
+ userinfo, host, port, # X
+ registry, # X
+ path, # Y
+ opaque, # Y
query,
fragment
]
return ret
end
-=begin
-
---- URI::parse(uri_str)
-
-=end
+ #
+ # == Synopsis
+ #
+ # URI::parse(uri_str)
+ #
+ # == Args
+ #
+ # +uri_str+::
+ # String with URI.
+ #
+ # == Description
+ #
+ # Creates one of the URI's subclasses instance from the string.
+ #
+ # == Raises
+ #
+ # URI::InvalidURIError
+ # Raised if URI given is not a correct one.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # uri = URI.parse("http://www.ruby-lang.org/")
+ # p uri
+ # # => #<URI::HTTP:0x202281be URL:http://www.ruby-lang.org/>
+ # p uri.scheme
+ # # => "http"
+ # p uri.host
+ # # => "www.ruby-lang.org"
+ #
def self.parse(uri)
scheme, userinfo, host, port,
registry, path, opaque, query, fragment = self.split(uri)
if scheme && @@schemes.include?(scheme.upcase)
@@schemes[scheme.upcase].new(scheme, userinfo, host, port,
- registry, path, opaque, query,
- fragment)
+ registry, path, opaque, query,
+ fragment)
else
Generic.new(scheme, userinfo, host, port,
- registry, path, opaque, query,
- fragment)
+ registry, path, opaque, query,
+ fragment)
end
end
-=begin
-
---- URI::join(str[, str, ...])
-
-=end
+ #
+ # == Synopsis
+ #
+ # URI::join(str[, str, ...])
+ #
+ # == Args
+ #
+ # +str+::
+ # String(s) to work with
+ #
+ # == Description
+ #
+ # Joins URIs.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # p URI.join("http:/localhost/","main.rbx")
+ # # => #<URI::HTTP:0x2022ac02 URL:http:/localhost/main.php>
+ #
def self.join(*str)
u = self.parse(str[0])
str[1 .. -1].each do |x|
@@ -391,11 +520,30 @@ module URI
u
end
-=begin
-
---- URI::extract(str[, schemes])
-
-=end
+ #
+ # == Synopsis
+ #
+ # URI::extract(str[, schemes][,&blk])
+ #
+ # == Args
+ #
+ # +str+::
+ # String to extract URIs from.
+ # +schemes+::
+ # Limit URI matching to a specific schemes.
+ #
+ # == Description
+ #
+ # Extracts URIs from a string. If block given, iterates through all matched URIs.
+ # Returns nil if block given or array with matches.
+ #
+ # == Usage
+ #
+ # require "uri"
+ #
+ # URI.extract("text here http://foo.bar.org/bla and here mailto:test@ruby.com and here also.")
+ # # => ["http://foo.bar.com/foobar", "mailto:foo@bar.com"]
+ #
def self.extract(str, schemes = nil, &block)
if block_given?
str.scan(regexp(schemes)) { yield $& }
@@ -407,30 +555,37 @@ module URI
end
end
-=begin
-
---- URI::regexp([match_schemes])
-
- Returns a Regexp object which matches to URI-like strings.
- If MATCH_SCHEMES given, resulting regexp matches to URIs
- whose scheme is one of the MATCH_SCHEMES.
-
- The Regexp object returned by this method includes arbitrary
- number of capture group (parentheses). Never rely on its
- number.
-
- # extract first URI from html_string
- html_string.slice(URI.regexp)
-
- # remove ftp URIs
- html_string.sub(URI.regexp(['ftp'])
-
- # You should not rely on the number of parentheses
- html_string.scan(URI.regexp) do |*matches|
- p $&
- end
-
-=end
+ #
+ # == Synopsis
+ #
+ # URI::regexp([match_schemes])
+ #
+ # == Args
+ #
+ # +match_schemes+::
+ # Array of schemes. If given, resulting regexp matches to URIs
+ # whose scheme is one of the match_schemes.
+ #
+ # == Description
+ # Returns a Regexp object which matches to URI-like strings.
+ # The Regexp object returned by this method includes arbitrary
+ # number of capture group (parentheses). Never rely on it's number.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # # extract first URI from html_string
+ # html_string.slice(URI.regexp)
+ #
+ # # remove ftp URIs
+ # html_string.sub(URI.regexp(['ftp'])
+ #
+ # # You should not rely on the number of parentheses
+ # html_string.scan(URI.regexp) do |*matches|
+ # p $&
+ # end
+ #
def self.regexp(schemes = nil)
unless schemes
ABS_URI_REF
@@ -439,4 +594,4 @@ module URI
end
end
-end # URI
+end
diff --git a/lib/uri/ftp.rb b/lib/uri/ftp.rb
index 8183fbcd51..26109e4d27 100644
--- a/lib/uri/ftp.rb
+++ b/lib/uri/ftp.rb
@@ -1,25 +1,18 @@
#
-# $Id$
+# = uri/ftp.rb
#
-# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
-# You can redistribute it and/or modify it under the same term as Ruby.
+# Author:: Akira Yamada <akira@ruby-lang.org>
+# License:: You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
#
require 'uri/generic'
module URI
-=begin
-
-== URI::FTP
-
-=== Super Class
-
-((<URI::Generic>))
-
-=end
-
+ #
# RFC1738 section 3.2.
+ #
class FTP < Generic
DEFAULT_PORT = 21
@@ -28,82 +21,91 @@ module URI
:userinfo, :host, :port,
:path, :typecode
].freeze
-
+ #
+ # Typecode is, "a", "i" or "d".
+ # As for "a" the text, as for "i" binary,
+ # as for "d" the directory is displayed.
+ # "A" with the text, as for "i" being binary,
+ # is because the respective data type was called ASCII and
+ # IMAGE with the protocol of FTP.
+ #
TYPECODE = ['a', 'i', 'd'].freeze
TYPECODE_PREFIX = ';type='.freeze
-=begin
-
-=== Class Methods
-
---- URI::FTP::build
- Create a new URI::FTP object from components of URI::FTP with
- check. It is scheme, userinfo, host, port, path and typecode. It
- provided by an Array or a Hash. typecode is "a", "i" or "d".
-
---- URI::FTP::new
- Create a new URI::FTP object from ``generic'' components with no
- check.
-
-=end
-
def self.new2(user, password, host, port, path,
- typecode = nil, arg_check = true)
+ typecode = nil, arg_check = true)
typecode = nil if typecode.size == 0
if typecode && !TYPECODE.include?(typecode)
- raise ArgumentError,
- "bad typecode is specified: #{typecode}"
+ raise ArgumentError,
+ "bad typecode is specified: #{typecode}"
end
# do escape
self.new('ftp',
- [user, password],
- host, port, nil,
- typecode ? path + TYPECODE_PREFIX + typecode : path,
- nil, nil, nil, arg_check)
+ [user, password],
+ host, port, nil,
+ typecode ? path + TYPECODE_PREFIX + typecode : path,
+ nil, nil, nil, arg_check)
end
+ #
+ # == Description
+ #
+ # Creates a new URI::FTP object from components of URI::FTP with
+ # check. It is scheme, userinfo, host, port, path and typecode. It
+ # provided by an Array or a Hash. typecode is "a", "i" or "d".
+ #
def self.build(args)
tmp = Util::make_components_hash(self, args)
if tmp[:typecode]
- if tmp[:typecode].size == 1
- tmp[:typecode] = TYPECODE_PREFIX + tmp[:typecode]
- end
- tmp[:path] << tmp[:typecode]
+ if tmp[:typecode].size == 1
+ tmp[:typecode] = TYPECODE_PREFIX + tmp[:typecode]
+ end
+ tmp[:path] << tmp[:typecode]
end
return super(tmp)
end
+ #
+ # == Description
+ #
+ # Create a new URI::FTP object from ``generic'' components with no
+ # check.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ # p ftp = URI.parse("ftp://ftp.ruby-lang.org/pub/ruby/;type=d")
+ # # => #<URI::FTP:0x201fad08 URL:ftp://ftp.ruby-lang.org/pub/ruby/;type=d>
+ # p ftp.typecode
+ # # => "d"
+ #
def initialize(*arg)
super(*arg)
@typecode = nil
tmp = @path.index(TYPECODE_PREFIX)
if tmp
- typecode = @path[tmp + TYPECODE_PREFIX.size..-1]
- self.set_path(@path[0..tmp - 1])
-
- if arg[-1]
- self.typecode = typecode
- else
- self.set_typecode(typecode)
- end
+ typecode = @path[tmp + TYPECODE_PREFIX.size..-1]
+ self.set_path(@path[0..tmp - 1])
+
+ if arg[-1]
+ self.typecode = typecode
+ else
+ self.set_typecode(typecode)
+ end
end
end
attr_reader :typecode
- #
- # methods for typecode
- #
-
def check_typecode(v)
if TYPECODE.include?(v)
- return true
+ return true
else
- raise InvalidComponentError,
- "bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
+ raise InvalidComponentError,
+ "bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
end
end
private :check_typecode
@@ -119,32 +121,28 @@ module URI
typecode
end
-=begin
-=end
- def merge(oth)
+ def merge(oth) # :nodoc:
tmp = super(oth)
if self != tmp
- tmp.set_typecode(oth.typecode)
+ tmp.set_typecode(oth.typecode)
end
return tmp
end
-=begin
-=end
def to_s
save_path = nil
if @typecode
- save_path = @path
- @path = @path + TYPECODE_PREFIX + @typecode
+ save_path = @path
+ @path = @path + TYPECODE_PREFIX + @typecode
end
str = super
if @typecode
- @path = save_path
+ @path = save_path
end
return str
end
- end # FTP
+ end
@@schemes['FTP'] = FTP
-end # URI
+end
diff --git a/lib/uri/generic.rb b/lib/uri/generic.rb
index c1d0d63cae..aebb924e85 100644
--- a/lib/uri/generic.rb
+++ b/lib/uri/generic.rb
@@ -1,37 +1,27 @@
#
-# $Id$
+# = uri/generic.rb
#
-# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
-# You can redistribute it and/or modify it under the same term as Ruby.
+# Author:: Akira Yamada <akira@ruby-lang.org>
+# License:: You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
#
require 'uri/common'
module URI
-
-=begin
-
-== URI::Generic
-
-=== Super Class
-
-Object
-
-=end
-
+
+ #
+ # Base class for all URI classes.
+ #
class Generic
include URI
include REGEXP
-=begin
-
-=== Class Methods
-
---- URI::Generic::default_port
-
-=end
DEFAULT_PORT = nil
+ #
+ # Returns default port
+ #
def self.default_port
self::DEFAULT_PORT
end
@@ -40,9 +30,6 @@ Object
self.class.default_port
end
-=begin
---- URI::Generic::component
-=end
COMPONENT = [
:scheme,
:userinfo, :host, :port, :registry,
@@ -51,90 +38,126 @@ Object
:fragment
].freeze
+ #
+ # Components of the URI in the order.
+ #
def self.component
self::COMPONENT
end
-=begin
---- URI::Generic::use_registry
-=end
USE_REGISTRY = false
+ #
+ # DOC: FIXME!
+ #
def self.use_registry
self::USE_REGISTRY
end
-=begin
-
---- URI::Generic::build2
- At first, try to create a new URI::Generic object using
- URI::Generic::build. But, if you get a exception
- URI::InvalidComponentError, then re-try to create an object with
- escaped components.
-
---- URI::Generic::build
- Create a new URI::Generic object from components of URI::Generic
- with check. It is scheme, userinfo, host, port, registry, path,
- opaque, query and fragment. It provided by an Array of a Hash.
-
---- URI::Generic::new
- Create new URI::Generic object from ``generic'' components with no
- check.
-
-=end
+ #
+ # == Synopsis
+ #
+ # See #new
+ #
+ # == Description
+ #
+ # At first, tries to create a new URI::Generic instance using
+ # URI::Generic::build. But, if exception URI::InvalidComponentError is raised,
+ # then it URI::Escape.escape all URI components and tries again.
+ #
+ #
def self.build2(args)
begin
- return self.build(args)
+ return self.build(args)
rescue InvalidComponentError
- if args.kind_of?(Array)
- return self.build(args.collect{|x|
- if x
- URI.escape(x)
- else
- x
- end
- })
- elsif args.kind_of?(Hash)
- tmp = {}
- args.each do |key, value|
- tmp[key] = if value
- URI.escape(value)
- else
- value
- end
- end
- return self.build(tmp)
- end
+ if args.kind_of?(Array)
+ return self.build(args.collect{|x|
+ if x
+ URI.escape(x)
+ else
+ x
+ end
+ })
+ elsif args.kind_of?(Hash)
+ tmp = {}
+ args.each do |key, value|
+ tmp[key] = if value
+ URI.escape(value)
+ else
+ value
+ end
+ end
+ return self.build(tmp)
+ end
end
end
+ #
+ # == Synopsis
+ #
+ # See #new
+ #
+ # == Description
+ #
+ # Creates a new URI::Generic instance from components of URI::Generic
+ # with check. Components are: scheme, userinfo, host, port, registry, path,
+ # opaque, query and fragment. You can provide arguments either by an Array or a Hash.
+ # See #new for hash keys to use or for order of array items.
+ #
def self.build(args)
if args.kind_of?(Array) &&
- args.size == ::URI::Generic::COMPONENT.size
- tmp = args
+ args.size == ::URI::Generic::COMPONENT.size
+ tmp = args
elsif args.kind_of?(Hash)
- tmp = ::URI::Generic::COMPONENT.collect do |c|
- if args.include?(c)
- args[c]
- else
- nil
- end
- end
+ tmp = ::URI::Generic::COMPONENT.collect do |c|
+ if args.include?(c)
+ args[c]
+ else
+ nil
+ end
+ end
else
- raise ArgumentError,
- "expected Array of or Hash of components of #{self.class} (#{self.class.component.join(', ')})"
+ raise ArgumentError,
+ "expected Array of or Hash of components of #{self.class} (#{self.class.component.join(', ')})"
end
tmp << true
return self.new(*tmp)
end
-
+ #
+ # == Args
+ #
+ # +scheme+::
+ # Protocol scheme, i.e. 'http','ftp','mailto' and so on.
+ # +userinfo+::
+ # User name and password, i.e. 'sdmitry:bla'
+ # +host+::
+ # Server host name
+ # +port+::
+ # Server port
+ # +registry+::
+ # DOC: FIXME!
+ # +path+::
+ # Path on server
+ # +opaque+::
+ # DOC: FIXME!
+ # +query+::
+ # Query data
+ # +fragment+::
+ # A part of URI after '#' sign
+ # +arg_check+::
+ # Check arguments [false by default]
+ #
+ # == Description
+ #
+ # Creates a new URI::Generic instance from ``generic'' components without check.
+ #
def initialize(scheme,
- userinfo, host, port, registry,
- path, opaque,
- query,
- fragment,
- arg_check = false)
+ userinfo, host, port, registry,
+ path, opaque,
+ query,
+ fragment,
+ arg_check = false)
@scheme = nil
@user = nil
@password = nil
@@ -147,28 +170,29 @@ Object
@fragment = nil
if arg_check
- self.scheme = scheme
- self.userinfo = userinfo
- self.host = host
- self.port = port
- self.path = path
- self.query = query
- self.opaque = opaque
- self.registry = registry
- self.fragment = fragment
+ self.scheme = scheme
+ self.userinfo = userinfo
+ self.host = host
+ self.port = port
+ self.path = path
+ self.query = query
+ self.opaque = opaque
+ self.registry = registry
+ self.fragment = fragment
else
- self.set_scheme(scheme)
- self.set_userinfo(userinfo)
- self.set_host(host)
- self.set_port(port)
- self.set_path(path)
- self.set_query(query)
- self.set_opaque(opaque)
- self.set_registry(registry)
- self.set_fragment(fragment)
+ self.set_scheme(scheme)
+ self.set_userinfo(userinfo)
+ self.set_host(host)
+ self.set_port(port)
+ self.set_path(path)
+ self.set_query(query)
+ self.set_opaque(opaque)
+ self.set_registry(registry)
+ self.set_fragment(fragment)
end
if @registry && !self.class.use_registry
- raise InvalidURIError, "the scheme #{@scheme} does not accept registry part: #{@registry} (or bad hostname?)"
+ raise InvalidURIError,
+ "the scheme #{@scheme} does not accept registry part: #{@registry} (or bad hostname?)"
end
@scheme.freeze if @scheme
@@ -187,48 +211,23 @@ Object
# replace self by other URI object
def replace!(oth)
if self.class != oth.class
- raise ArgumentError, "expected #{self.class} object"
+ raise ArgumentError, "expected #{self.class} object"
end
component.each do |c|
- self.__send__("#{c}=", oth.__send__(c))
+ self.__send__("#{c}=", oth.__send__(c))
end
end
private :replace!
-=begin
-
-=== Instance Methods
-
-=end
-
-=begin
-
---- URI::Generic#component
-
-=end
def component
self.class.component
end
- # set_XXX method sets value to @XXX instance variable with no check,
- # so be careful if you use these methods. or, you use these method
- # with check_XXX method, or you use XXX= methods.
-
-=begin
-
---- URI::Generic#scheme
-
---- URI::Generic#scheme=(v)
-
-=end
- #
- # methods for scheme
- #
def check_scheme(v)
if v && SCHEME !~ v
- raise InvalidComponentError,
- "bad component(expected scheme component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected scheme component): #{v}"
end
return true
@@ -246,27 +245,9 @@ Object
v
end
-=begin
-
---- URI::Generic#userinfo
-
---- URI::Generic#userinfo=(v)
-
---- URI::Generic#user
-
---- URI::Generic#user=(v)
-
---- URI::Generic#password
-
---- URI::Generic#password=(v)
-
-=end
- #
- # methods for userinfo
- #
def check_userinfo(user, password = nil)
if !password
- user, password = split_userinfo(user)
+ user, password = split_userinfo(user)
end
check_user(user)
check_password(password, user)
@@ -277,15 +258,15 @@ Object
def check_user(v)
if @registry || @opaque
- raise InvalidURIError,
- "can not set user with registry or opaque"
+ raise InvalidURIError,
+ "can not set user with registry or opaque"
end
return v unless v
if USERINFO !~ v
- raise InvalidComponentError,
- "bad component(expected userinfo component or user component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected userinfo component or user component): #{v}"
end
return true
@@ -294,28 +275,31 @@ Object
def check_password(v, user = @user)
if @registry || @opaque
- raise InvalidURIError,
- "can not set password with registry or opaque"
+ raise InvalidURIError,
+ "can not set password with registry or opaque"
end
return v unless v
if !user
- raise InvalidURIError,
- "password component depends user component"
+ raise InvalidURIError,
+ "password component depends user component"
end
if USERINFO !~ v
- raise InvalidComponentError,
- "bad component(expected user component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected user component): #{v}"
end
return true
end
private :check_password
+ #
+ # Sets userinfo, argument is string like 'name:pass'
+ #
def userinfo=(userinfo)
if userinfo.nil?
- return nil
+ return nil
end
check_userinfo(*userinfo)
set_userinfo(*userinfo)
@@ -327,7 +311,7 @@ Object
set_user(user)
user
end
-
+
def password=(password)
check_password(password)
set_password(password)
@@ -336,7 +320,7 @@ Object
def set_userinfo(user, password = nil)
unless password
- user, password = split_userinfo(user)
+ user, password = split_userinfo(user)
end
@user = user
@password = password if password
@@ -361,11 +345,11 @@ Object
return nil, nil unless ui
tmp = ui.index(':')
if tmp
- user = ui[0..tmp - 1]
- password = ui[tmp + 1..-1]
+ user = ui[0..tmp - 1]
+ password = ui[tmp + 1..-1]
else
- user = ui
- password = nil
+ user = ui
+ password = nil
end
return user, password
@@ -379,9 +363,9 @@ Object
def userinfo
if !@password
- @user
+ @user
else
- @user + ':' + @password
+ @user + ':' + @password
end
end
@@ -393,26 +377,15 @@ Object
@password
end
-=begin
-
---- URI::Generic#host
-
---- URI::Generic#host=(v)
-
-=end
- #
- # methods for host
- #
-
def check_host(v)
return v unless v
if @registry || @opaque
- raise InvalidURIError,
- "can not set host with registry or opaque"
+ raise InvalidURIError,
+ "can not set host with registry or opaque"
elsif HOST !~ v
- raise InvalidComponentError,
- "bad component(expected host component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected host component): #{v}"
end
return true
@@ -430,26 +403,15 @@ Object
v
end
-=begin
-
---- URI::Generic#port
-
---- URI::Generic#port=(v)
-
-=end
- #
- # methods for port
- #
-
def check_port(v)
return v unless v
if @registry || @opaque
- raise InvalidURIError,
- "can not set port with registry or opaque"
+ raise InvalidURIError,
+ "can not set port with registry or opaque"
elsif !v.kind_of?(Fixnum) && PORT !~ v
- raise InvalidComponentError,
- "bad component(expected port component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected port component): #{v}"
end
return true
@@ -458,11 +420,11 @@ Object
def set_port(v)
unless !v || v.kind_of?(Fixnum)
- if v.empty?
- v = nil
- else
- v = v.to_i
- end
+ if v.empty?
+ v = nil
+ else
+ v = v.to_i
+ end
end
@port = v
end
@@ -474,17 +436,6 @@ Object
port
end
-=begin
-
---- URI::Generic#registry
-
---- URI::Generic#registry=(v)
-
-=end
- #
- # methods for registry
- #
-
def check_registry(v)
return v unless v
@@ -492,11 +443,11 @@ Object
# authority = server | reg_name
# server = [ [ userinfo "@" ] hostport ]
if @host || @port || @user # userinfo = @user + ':' + @password
- raise InvalidURIError,
- "can not set registry with host, port, or userinfo"
+ raise InvalidURIError,
+ "can not set registry with host, port, or userinfo"
elsif v && REGISTRY !~ v
- raise InvalidComponentError,
- "bad component(expected registry component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected registry component): #{v}"
end
return true
@@ -514,36 +465,25 @@ Object
v
end
-=begin
-
---- URI::Generic#path
-
---- URI::Generic#path=(v)
-
-=end
- #
- # methods for path
- #
-
def check_path(v)
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if v && @opaque
- raise InvalidURIError,
- "path conflicts with opaque"
+ raise InvalidURIError,
+ "path conflicts with opaque"
end
if @scheme
- if v && v != '' && ABS_PATH !~ v
- raise InvalidComponentError,
- "bad component(expected absolute path component): #{v}"
- end
+ if v && v != '' && ABS_PATH !~ v
+ raise InvalidComponentError,
+ "bad component(expected absolute path component): #{v}"
+ end
else
- if v && v != '' && ABS_PATH !~ v && REL_PATH !~ v
- raise InvalidComponentError,
- "bad component(expected relative path component): #{v}"
- end
+ if v && v != '' && ABS_PATH !~ v && REL_PATH !~ v
+ raise InvalidComponentError,
+ "bad component(expected relative path component): #{v}"
+ end
end
return true
@@ -561,17 +501,6 @@ Object
v
end
-=begin
-
---- URI::Generic#query
-
---- URI::Generic#query=(v)
-
-=end
- #
- # methods for query
- #
-
def check_query(v)
return v unless v
@@ -579,14 +508,14 @@ Object
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if @opaque
- raise InvalidURIError,
- "query conflicts with opaque"
+ raise InvalidURIError,
+ "query conflicts with opaque"
end
if v && v != '' && QUERY !~ v
- raise InvalidComponentError,
- "bad component(expected query component): #{v}"
- end
+ raise InvalidComponentError,
+ "bad component(expected query component): #{v}"
+ end
return true
end
@@ -603,17 +532,6 @@ Object
v
end
-=begin
-
---- URI::Generic#opaque
-
---- URI::Generic#opaque=(v)
-
-=end
- #
- # methods for opaque
- #
-
def check_opaque(v)
return v unless v
@@ -621,11 +539,11 @@ Object
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if @host || @port || @user || @path # userinfo = @user + ':' + @password
- raise InvalidURIError,
- "can not set opaque with host, port, userinfo or path"
+ raise InvalidURIError,
+ "can not set opaque with host, port, userinfo or path"
elsif v && OPAQUE !~ v
- raise InvalidComponentError,
- "bad component(expected opaque component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected opaque component): #{v}"
end
return true
@@ -643,23 +561,12 @@ Object
v
end
-=begin
-
---- URI::Generic#fragment
-
---- URI::Generic#fragment=(v)
-
-=end
- #
- # methods for fragment
- #
-
def check_fragment(v)
return v unless v
if v && v != '' && FRAGMENT !~ v
- raise InvalidComponentError,
- "bad component(expected fragment component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected fragment component): #{v}"
end
return true
@@ -677,49 +584,36 @@ Object
v
end
-=begin
-
---- URI::Generic#hierarchical?
-
-=end
+ #
+ # Checks if URI has a path
+ #
def hierarchical?
if @path
- true
+ true
else
- false
+ false
end
end
-=begin
-
---- URI::Generic#absolute?
-
-=end
+ #
+ # Checks if URI is an absolute one
+ #
def absolute?
if @scheme
- true
+ true
else
- false
+ false
end
end
alias absolute absolute?
-=begin
-
---- URI::Generic#relative?
-
-=end
+ #
+ # Checks if URI is relative
+ #
def relative?
!absolute?
end
-=begin
-
---- URI::Generic#merge(rel)
---- URI::Generic#merge!(rel)
---- URI::Generic#+(rel)
-
-=end
def split_path(path)
path.split(%r{/+}, -1)
end
@@ -728,85 +622,121 @@ Object
def merge_path(base, rel)
# RFC2396, Section 5.2, 5)
if rel[0] == ?/ #/
- # RFC2396, Section 5.2, 5)
- return rel
+ # RFC2396, Section 5.2, 5)
+ return rel
else
- # RFC2396, Section 5.2, 6)
- base_path = split_path(base)
- rel_path = split_path(rel)
-
- if base_path.empty?
- base_path = [''] # XXX
- end
-
- # RFC2396, Section 5.2, 6), a)
- base_path.pop unless base_path.size == 1
-
- # RFC2396, Section 5.2, 6), c)
- # RFC2396, Section 5.2, 6), d)
- rel_path.push('') if rel_path.last == '.'
- rel_path.delete('.')
-
- # RFC2396, Section 5.2, 6), e)
- tmp = []
- rel_path.each do |x|
- if x == '..' &&
- !(tmp.empty? || tmp.last == '..')
- tmp.pop
- else
- tmp << x
- end
- end
-
- add_trailer_slash = true
- while x = tmp.shift
- if x == '..' && base_path.size > 1
- # RFC2396, Section 4
- # a .. or . in an absolute path has no special meaning
- base_path.pop
- else
- # if x == '..'
- # valid absolute (but abnormal) path "/../..."
- # else
- # valid absolute path
- # end
- base_path << x
- tmp.each {|t| base_path << t}
- add_trailer_slash = false
- break
- end
- end
- base_path.push('') if add_trailer_slash
-
- return base_path.join('/')
+ # RFC2396, Section 5.2, 6)
+ base_path = split_path(base)
+ rel_path = split_path(rel)
+
+ if base_path.empty?
+ base_path = [''] # XXX
+ end
+
+ # RFC2396, Section 5.2, 6), a)
+ base_path.pop unless base_path.size == 1
+
+ # RFC2396, Section 5.2, 6), c)
+ # RFC2396, Section 5.2, 6), d)
+ rel_path.push('') if rel_path.last == '.'
+ rel_path.delete('.')
+
+ # RFC2396, Section 5.2, 6), e)
+ tmp = []
+ rel_path.each do |x|
+ if x == '..' &&
+ !(tmp.empty? || tmp.last == '..')
+ tmp.pop
+ else
+ tmp << x
+ end
+ end
+
+ add_trailer_slash = true
+ while x = tmp.shift
+ if x == '..' && base_path.size > 1
+ # RFC2396, Section 4
+ # a .. or . in an absolute path has no special meaning
+ base_path.pop
+ else
+ # if x == '..'
+ # valid absolute (but abnormal) path "/../..."
+ # else
+ # valid absolute path
+ # end
+ base_path << x
+ tmp.each {|t| base_path << t}
+ add_trailer_slash = false
+ break
+ end
+ end
+ base_path.push('') if add_trailer_slash
+
+ return base_path.join('/')
end
end
private :merge_path
+ #
+ # == Args
+ #
+ # +oth+::
+ # URI or String
+ #
+ # == Description
+ #
+ # Destructive form of #merge
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # uri = URI.parse("http://my.rubysite.com")
+ # uri.merge!("/main.rbx?page=1")
+ # p uri
+ # # => #<URI::HTTP:0x2021f3b0 URL:http://my.rubysite.com/main.rbx?page=1>
+ #
def merge!(oth)
t = merge(oth)
if self == t
- nil
+ nil
else
- replace!(t)
- self
+ replace!(t)
+ self
end
end
- # abs(self) + rel(oth) => abs(new)
+ #
+ # == Args
+ #
+ # +oth+::
+ # URI or String
+ #
+ # == Description
+ #
+ # Merges two URI's.
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # uri = URI.parse("http://my.rubysite.com")
+ # p uri.merge("/main.rbx?page=1")
+ # # => #<URI::HTTP:0x2021f3b0 URL:http://my.rubysite.com/main.rbx?page=1>
+ #
def merge(oth)
base, rel = merge0(oth)
if base == rel
- return base
+ return base
end
authority = rel.userinfo || rel.host || rel.port
# RFC2396, Section 5.2, 2)
if rel.path.empty? && !authority && !rel.query
- base.set_fragment(rel.fragment) if rel.fragment
- return base
+ base.set_fragment(rel.fragment) if rel.fragment
+ return base
end
base.set_query(nil)
@@ -814,10 +744,10 @@ Object
# RFC2396, Section 5.2, 4)
if !authority
- base.set_path(merge_path(base.path, rel.path))
+ base.set_path(merge_path(base.path, rel.path))
else
- # RFC2396, Section 5.2, 4)
- base.set_path(rel.path)
+ # RFC2396, Section 5.2, 4)
+ base.set_path(rel.path)
end
# RFC2396, Section 5.2, 7)
@@ -837,46 +767,40 @@ Object
case oth
when Generic
when String
- oth = URI.parse(oth)
+ oth = URI.parse(oth)
else
- raise ArgumentError,
- "bad argument(expected URI object or URI string)"
+ raise ArgumentError,
+ "bad argument(expected URI object or URI string)"
end
if self.relative? && oth.relative?
- raise BadURIError,
- "both URI are relative"
+ raise BadURIError,
+ "both URI are relative"
end
if self.absolute? && oth.absolute?
- #raise BadURIError,
- # "both URI are absolute"
- # hmm... should return oth for usability?
- return oth, oth
+ #raise BadURIError,
+ # "both URI are absolute"
+ # hmm... should return oth for usability?
+ return oth, oth
end
if !self.hierarchical?
- raise BadURIError,
- "not hierarchical URI: #{self}"
+ raise BadURIError,
+ "not hierarchical URI: #{self}"
elsif !oth.hierarchical?
- raise BadURIError,
- "not hierarchical URI: #{oth}"
+ raise BadURIError,
+ "not hierarchical URI: #{oth}"
end
if self.absolute?
- return self.dup, oth
+ return self.dup, oth
else
- return oth, oth
+ return oth, oth
end
end
private :merge0
-=begin
-
---- URI::Generic#route_from(src)
---- URI::Generic#-(src)
-
-=end
def route_from_path(src, dst)
# RFC2396, Section 4.2
return '' if src == dst
@@ -887,31 +811,31 @@ Object
# hmm... dst has abnormal absolute path,
# like "/./", "/../", "/x/../", ...
if dst_path.include?('..') ||
- dst_path.include?('.')
- return dst.dup
+ dst_path.include?('.')
+ return dst.dup
end
src_path.pop
# discard same parts
while dst_path.first == src_path.first
- break if dst_path.empty?
+ break if dst_path.empty?
- src_path.shift
- dst_path.shift
+ src_path.shift
+ dst_path.shift
end
tmp = dst_path.join('/')
# calculate
if src_path.empty?
- if tmp.empty?
- return './'
- elsif dst_path.first.include?(':') # (see RFC2396 Section 5)
- return './' + tmp
- else
- return tmp
- end
+ if tmp.empty?
+ return './'
+ elsif dst_path.first.include?(':') # (see RFC2396 Section 5)
+ return './' + tmp
+ else
+ return tmp
+ end
end
return '../' * src_path.size + tmp
@@ -922,179 +846,202 @@ Object
case oth
when Generic
when String
- oth = URI.parse(oth)
+ oth = URI.parse(oth)
else
- raise ArgumentError,
- "bad argument(expected URI object or URI string)"
+ raise ArgumentError,
+ "bad argument(expected URI object or URI string)"
end
if self.relative?
- raise BadURIError,
- "relative URI: #{self}"
+ raise BadURIError,
+ "relative URI: #{self}"
end
if oth.relative?
- raise BadURIError,
- "relative URI: #{oth}"
+ raise BadURIError,
+ "relative URI: #{oth}"
end
if !self.hierarchical? || !oth.hierarchical?
- return self, self.dup
+ return self, self.dup
end
if self.scheme != oth.scheme
- return oth, oth.dup
+ return oth, oth.dup
end
rel = URI::Generic.new(nil, # it is relative URI
- self.userinfo, self.host, self.port,
- self.registry, self.path, self.opaque,
- self.query, self.fragment)
+ self.userinfo, self.host, self.port,
+ self.registry, self.path, self.opaque,
+ self.query, self.fragment)
if rel.userinfo != oth.userinfo ||
- rel.host.to_s.downcase != oth.host.to_s.downcase ||
- rel.port != oth.port
- rel.set_port(nil) if rel.port == oth.default_port
- return rel, rel
+ rel.host.to_s.downcase != oth.host.to_s.downcase ||
+ rel.port != oth.port
+ rel.set_port(nil) if rel.port == oth.default_port
+ return rel, rel
end
rel.set_userinfo(nil)
rel.set_host(nil)
rel.set_port(nil)
if rel.path == oth.path
- rel.set_path('')
- rel.set_query(nil) if rel.query == oth.query
- return rel, rel
+ rel.set_path('')
+ rel.set_query(nil) if rel.query == oth.query
+ return rel, rel
end
# you can modify `rel', but can not `oth'.
return oth, rel
end
private :route_from0
-
- # calculate relative path from oth to self
+ #
+ # == Args
+ #
+ # +oth+::
+ # URI or String
+ #
+ # == Description
+ #
+ # Calculates relative path from oth to self
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # uri = URI.parse('http://my.rubysite.com/main.rbx?page=1')
+ # p uri.route_from('http://my.rubysite.com')
+ # #=> #<URI::Generic:0x20218858 URL:/main.rbx?page=1>
+ #
def route_from(oth)
# you can modify `rel', but can not `oth'.
oth, rel = route_from0(oth)
if oth == rel
- return rel
+ return rel
end
rel.set_path(route_from_path(oth.path, self.path))
if rel.path == './' && self.query
- # "./?foo" -> "?foo"
- rel.set_path('')
+ # "./?foo" -> "?foo"
+ rel.set_path('')
end
return rel
end
- # abs1 - abs2 => relative_path_to_abs1_from_abs2
- # (see http://www.nikonet.or.jp/spring/what_v/what_v_4.htm :-)
- alias - route_from
-=begin
-
---- URI::Generic#route_to(dst)
+ alias - route_from
-=end
- # calculate relative path to oth from self
+ #
+ # == Args
+ #
+ # +oth+::
+ # URI or String
+ #
+ # == Description
+ #
+ # Calculates relative path to oth from self
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # uri = URI.parse('http://my.rubysite.com')
+ # p uri.route_to('http://my.rubysite.com/main.rbx?page=1')
+ # #=> #<URI::Generic:0x2020c2f6 URL:/main.rbx?page=1>
+ #
def route_to(oth)
case oth
when Generic
when String
- oth = URI.parse(oth)
+ oth = URI.parse(oth)
else
- raise ArgumentError,
- "bad argument(expected URI object or URI string)"
+ raise ArgumentError,
+ "bad argument(expected URI object or URI string)"
end
oth.route_from(self)
end
-=begin
-
---- URI::Generic#normalize
---- URI::Generic#normalize!
-
-=end
+ #
+ # Returns normalized URI
+ #
def normalize
uri = dup
uri.normalize!
uri
end
+ #
+ # Destructive version of #normalize
+ #
def normalize!
if path && path == ''
- set_path('/')
+ set_path('/')
end
if host && host != host.downcase
- set_host(self.host.downcase)
- end
+ set_host(self.host.downcase)
+ end
end
-=begin
-
---- URI::Generic#to_s
-
-=end
def path_query
str = @path
if @query
- str += '?' + @query
+ str += '?' + @query
end
str
end
private :path_query
+ #
+ # Constructs String from URI
+ #
def to_s
str = ''
if @scheme
- str << @scheme
- str << ':'
+ str << @scheme
+ str << ':'
end
if @opaque
- str << @opaque
+ str << @opaque
else
- if @registry
- str << @registry
- else
- if @host
- str << '//'
- end
- if self.userinfo
- str << self.userinfo
- str << '@'
- end
- if @host
- str << @host
- end
- if @port && @port != self.default_port
- str << ':'
- str << @port.to_s
- end
- end
-
- str << path_query
+ if @registry
+ str << @registry
+ else
+ if @host
+ str << '//'
+ end
+ if self.userinfo
+ str << self.userinfo
+ str << '@'
+ end
+ if @host
+ str << @host
+ end
+ if @port && @port != self.default_port
+ str << ':'
+ str << @port.to_s
+ end
+ end
+
+ str << path_query
end
if @fragment
- str << '#'
- str << @fragment
+ str << '#'
+ str << @fragment
end
str
end
-=begin
-
---- URI::Generic#==(oth)
-
-=end
+ #
+ # Compares to URI's
+ #
def ==(oth)
if self.class == oth.class
- self.normalize.component_ary == oth.normalize.component_ary
+ self.normalize.component_ary == oth.normalize.component_ary
else
- false
+ false
end
end
@@ -1111,42 +1058,52 @@ Object
=end
def component_ary
component.collect do |x|
- self.send(x)
+ self.send(x)
end
end
protected :component_ary
-=begin
---- URI::Generic#select(*components)
-=end
+ # == Args
+ #
+ # +components+::
+ # Multiple Symbol arguments defined in URI::HTTP
+ #
+ # == Description
+ #
+ # Selects specified components from URI
+ #
+ # == Usage
+ #
+ # require 'uri'
+ #
+ # uri = URI.parse('http://myuser:mypass@my.rubysite.com/test.rbx')
+ # p uri.select(:userinfo, :host, :path)
+ # # => ["myuser:mypass", "my.rubysite.com", "/test.rbx"]
+ #
def select(*components)
components.collect do |c|
- if component.include?(c)
- self.send(c)
- else
- raise ArgumentError,
- "expected of components of #{self.class} (#{self.class.component.join(', ')})"
- end
+ if component.include?(c)
+ self.send(c)
+ else
+ raise ArgumentError,
+ "expected of components of #{self.class} (#{self.class.component.join(', ')})"
+ end
end
end
-=begin
-=end
def inspect
sprintf("#<%s:0x%x URL:%s>", self.class.to_s, self.object_id, self.to_s)
end
-=begin
-=end
def coerce(oth)
case oth
when String
- oth = URI.parse(oth)
+ oth = URI.parse(oth)
else
- super
+ super
end
return oth, self
end
- end # Generic
-end # URI
+ end
+end
diff --git a/lib/uri/http.rb b/lib/uri/http.rb
index 3e5b209d49..1f8bf587aa 100644
--- a/lib/uri/http.rb
+++ b/lib/uri/http.rb
@@ -1,25 +1,18 @@
#
-# $Id$
+# = uri/http.rb
#
-# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
-# You can redistribute it and/or modify it under the same term as Ruby.
+# Author:: Akira Yamada <akira@ruby-lang.org>
+# License:: You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
#
require 'uri/generic'
module URI
-=begin
-
-== URI::HTTP
-
-=== Super Class
-
-((<URI::Generic>))
-
-=end
-
+ #
# RFC1738 section 3.3.
+ #
class HTTP < Generic
DEFAULT_PORT = 80
@@ -31,46 +24,42 @@ module URI
:fragment
].freeze
-=begin
-
-=== Class Methods
-
---- URI::HTTP::build
- Create a new URI::HTTP object from components of URI::HTTP with
- check. It is scheme, userinfo, host, port, path, query and
- fragment. It provided by an Array of a Hash.
-
---- URI::HTTP::new
- Create a new URI::HTTP object from ``generic'' components with no
- check.
-
-=end
-
+ #
+ # == Description
+ #
+ # Create a new URI::HTTP object from components of URI::HTTP with
+ # check. It is scheme, userinfo, host, port, path, query and
+ # fragment. It provided by an Array of a Hash.
+ #
def self.build(args)
tmp = Util::make_components_hash(self, args)
return super(tmp)
end
+ #
+ # == Description
+ #
+ # Create a new URI::HTTP object from ``generic'' components with no
+ # check.
+ #
def initialize(*arg)
super(*arg)
end
-=begin
-
-=== Instance Methods
-
---- URI::HTTP#request_uri
-
-=end
+ #
+ # == Description
+ #
+ # Returns: path + '?' + query
+ #
def request_uri
r = path_query
if r[0] != ?/
- r = '/' + r
+ r = '/' + r
end
r
end
- end # HTTP
+ end
@@schemes['HTTP'] = HTTP
-end # URI
+end
diff --git a/lib/uri/https.rb b/lib/uri/https.rb
index 691198fafa..78e5b9af12 100644
--- a/lib/uri/https.rb
+++ b/lib/uri/https.rb
@@ -1,26 +1,16 @@
#
-# $Id$
+# = uri/https.rb
#
-# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
-# You can redistribute it and/or modify it under the same term as Ruby.
+# Author:: Akira Yamada <akira@ruby-lang.org>
+# License:: You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
#
require 'uri/http'
module URI
-
-=begin
-
-== URI::HTTPS
-
-=== Super Class
-
-((<URI::HTTP>))
-
-=end
-
class HTTPS < HTTP
DEFAULT_PORT = 443
end
@@schemes['HTTPS'] = HTTPS
-end # URI
+end
diff --git a/lib/uri/ldap.rb b/lib/uri/ldap.rb
index ae85bb2164..e75cdc4552 100644
--- a/lib/uri/ldap.rb
+++ b/lib/uri/ldap.rb
@@ -1,29 +1,23 @@
#
-# $Id$
+# = uri/ldap.rb
+#
+# Author::
+# Takaaki Tateishi <ttate@jaist.ac.jp>
+# Akira Yamada <akira@ruby-lang.org>
+# License::
+# URI::LDAP is copyrighted free software by Takaaki Tateishi and Akira Yamada.
+# You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
#
require 'uri/generic'
module URI
-=begin
-
-== URI::LDAP
-
-URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
-
- Copyright (c) 2001 Takaaki Tateishi <ttate@jaist.ac.jp> and
- akira yamada <akira@ruby-lang.org>.
- You can redistribute it and/or modify it under the same term as Ruby.
-
-=== Super Class
-
-((<URI::Generic>))
-
-=end
-
+ #
# LDAP URI SCHEMA (described in RFC2255)
# ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]]
+ #
class LDAP < Generic
DEFAULT_PORT = 389
@@ -44,27 +38,17 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
SCOPE_BASE = 'base',
].freeze
-=begin
-
-=== Class Methods
-
---- URI::LDAP::build
-
---- URI::LDAP::new
-
-=end
-
def self.build(args)
tmp = Util::make_components_hash(self, args)
if tmp[:dn]
- tmp[:path] = tmp[:dn]
+ tmp[:path] = tmp[:dn]
end
query = []
[:extensions, :filter, :scope, :attributes].collect do |x|
- next if !tmp[x] && query.size == 0
- query.unshift(tmp[x])
+ next if !tmp[x] && query.size == 0
+ query.unshift(tmp[x])
end
tmp[:query] = query.join('?')
@@ -76,7 +60,7 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
super(*arg)
if @fragment
- raise InvalidURIError, 'bad LDAP URL'
+ raise InvalidURIError, 'bad LDAP URL'
end
parse_dn
@@ -95,12 +79,12 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
@extensions = nil
if @query
- attrs, scope, filter, extensions = @query.split('?')
+ attrs, scope, filter, extensions = @query.split('?')
- @attributes = attrs if attrs && attrs.size > 0
- @scope = scope if scope && scope.size > 0
- @filter = filter if filter && filter.size > 0
- @extensions = extensions if extensions && extensions.size > 0
+ @attributes = attrs if attrs && attrs.size > 0
+ @scope = scope if scope && scope.size > 0
+ @filter = filter if filter && filter.size > 0
+ @extensions = extensions if extensions && extensions.size > 0
end
end
private :parse_query
@@ -110,23 +94,13 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
query = []
[@extensions, @filter, @scope, @attributes].each do |x|
- next if !x && query.size == 0
- query.unshift(x)
+ next if !x && query.size == 0
+ query.unshift(x)
end
@query = query.join('?')
end
private :build_path_query
-=begin
-
-=== Instance Methods
-
---- URI::LDAP#dn
-
---- URI::LDAP#dn=(v)
-
-=end
-
def dn
@dn
end
@@ -143,14 +117,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
val
end
-=begin
-
---- URI::LDAP#attributes
-
---- URI::LDAP#attributes=(v)
-
-=end
-
def attributes
@attributes
end
@@ -167,14 +133,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
val
end
-=begin
-
---- URI::LDAP#scope
-
---- URI::LDAP#scope=(v)
-
-=end
-
def scope
@scope
end
@@ -191,14 +149,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
val
end
-=begin
-
---- URI::LDAP#filter
-
---- URI::LDAP#filter=(v)
-
-=end
-
def filter
@filter
end
@@ -215,14 +165,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
val
end
-=begin
-
---- URI::LDAP#extensions
-
---- URI::LDAP#extensions=(v)
-
-=end
-
def extensions
@extensions
end
diff --git a/lib/uri/mailto.rb b/lib/uri/mailto.rb
index 3f2439ed34..0c93ae1c0d 100644
--- a/lib/uri/mailto.rb
+++ b/lib/uri/mailto.rb
@@ -1,35 +1,26 @@
#
-# $Id$
+# = uri/mailto.rb
#
-# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
-# You can redistribute it and/or modify it under the same term as Ruby.
+# Author:: Akira Yamada <akira@ruby-lang.org>
+# License:: You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
#
require 'uri/generic'
module URI
-=begin
-
-== URI::MailTo
-
-=== Super Class
-
-((<URI::Generic>))
-
-=end
-
+ #
# RFC2368, The mailto URL scheme
+ #
class MailTo < Generic
include REGEXP
DEFAULT_PORT = nil
- COMPONENT = [
- :scheme,
- :to, :headers
- ].freeze
+ COMPONENT = [ :scheme, :to, :headers ].freeze
+ # :stopdoc:
# "hname" and "hvalue" are encodings of an RFC 822 header name and
# value, respectively. As with "to", all URL reserved characters must
# be encoded.
@@ -52,7 +43,7 @@ module URI
# to = #mailbox
# mailtoURL = "mailto:" [ to ] [ headers ]
MAILBOX_PATTERN = "(?:#{PATTERN::ESCAPED}|[^(),%?=&])".freeze
- MAILTO_REGEXP = Regexp.new("
+ MAILTO_REGEXP = Regexp.new(" # :nodoc:
\\A
(#{MAILBOX_PATTERN}*?) (?# 1: to)
(?:
@@ -61,63 +52,62 @@ module URI
)?
(?:
\\#
- (#{PATTERN::FRAGMENT}) (?# 3: fragment)
+ (#{PATTERN::FRAGMENT}) (?# 3: fragment)
)?
\\z
", Regexp::EXTENDED, 'N').freeze
+ # :startdoc:
-=begin
-
-=== Class Methods
-
---- URI::MailTo::build
- Create a new URI::MailTo object from components of URI::MailTo
- with check. It is to and headers. It provided by an Array of a
- Hash. You can provide headers as an String like
- "subject=subscribe&cc=addr" or an Array like [["subject",
- "subscribe"], ["cc", "addr"]]
-
---- URI::MailTo::new
- Create a new URI::MailTo object from ``generic'' components with
- no check. Because, this method is usually called from URI::parse
- and the method checks validity of each components.
-
-=end
-
+ #
+ # == Description
+ #
+ # Creates a new URI::MailTo object from components of URI::MailTo
+ # with check. It is to and headers. It provided by an Array of a
+ # Hash. You can provide headers as String like
+ # "subject=subscribe&cc=addr" or Array like [["subject",
+ # "subscribe"], ["cc", "addr"]]
+ #
def self.build(args)
tmp = Util::make_components_hash(self, args)
if tmp[:to]
- tmp[:opaque] = tmp[:to]
+ tmp[:opaque] = tmp[:to]
else
- tmp[:opaque] = ''
+ tmp[:opaque] = ''
end
if tmp[:headers]
- tmp[:opaque] << '?'
-
- if tmp[:headers].kind_of?(Array)
- tmp[:opaque] << tmp[:headers].collect { |x|
- if x.kind_of?(Array)
- x[0] + '=' + x[1..-1].to_s
- else
- x.to_s
- end
- }.join('&')
-
- elsif tmp[:headers].kind_of?(Hash)
- tmp[:opaque] << tmp[:headers].collect { |h,v|
- h + '=' + v
- }.join('&')
-
- else
- tmp[:opaque] << tmp[:headers].to_s
- end
+ tmp[:opaque] << '?'
+
+ if tmp[:headers].kind_of?(Array)
+ tmp[:opaque] << tmp[:headers].collect { |x|
+ if x.kind_of?(Array)
+ x[0] + '=' + x[1..-1].to_s
+ else
+ x.to_s
+ end
+ }.join('&')
+
+ elsif tmp[:headers].kind_of?(Hash)
+ tmp[:opaque] << tmp[:headers].collect { |h,v|
+ h + '=' + v
+ }.join('&')
+
+ else
+ tmp[:opaque] << tmp[:headers].to_s
+ end
end
return super(tmp)
end
+ #
+ # == Description
+ #
+ # Creates a new URI::MailTo object from ``generic'' components with
+ # no check. Because, this method is usually called from URI::parse
+ # and the method checks validity of each components.
+ #
def initialize(*arg)
super(*arg)
@@ -125,43 +115,29 @@ module URI
@headers = []
if MAILTO_REGEXP =~ @opaque
- if arg[-1]
- self.to = $1
- self.headers = $2
- else
- set_to($1)
- set_headers($2)
- end
+ if arg[-1]
+ self.to = $1
+ self.headers = $2
+ else
+ set_to($1)
+ set_headers($2)
+ end
else
- raise InvalidComponentError,
- "unrecognised opaque part for mailtoURL: #{@opaque}"
+ raise InvalidComponentError,
+ "unrecognised opaque part for mailtoURL: #{@opaque}"
end
end
attr_reader :to
attr_reader :headers
-=begin
-
-=== Instance Methods
-
---- URI::MailTo#to
-
---- URI::MailTo#to=(v)
-
-=end
-
- #
- # methods for to
- #
-
def check_to(v)
return true unless v
return true if v.size == 0
if OPAQUE !~ v || /\A#{MAILBOX_PATTERN}*\z/o !~ v
- raise InvalidComponentError,
- "bad component(expected opaque component): #{v}"
+ raise InvalidComponentError,
+ "bad component(expected opaque component): #{v}"
end
return true
@@ -179,26 +155,14 @@ module URI
v
end
-=begin
-
---- URI::MailTo#headers
-
---- URI::MailTo#headers=(v)
-
-=end
-
- #
- # methods for headers
- #
-
def check_headers(v)
return true unless v
return true if v.size == 0
if OPAQUE !~ v ||
- /\A(#{HEADER_PATTERN}(?:\&#{HEADER_PATTERN})*)\z/o !~ v
- raise InvalidComponentError,
- "bad component(expected opaque component): #{v}"
+ /\A(#{HEADER_PATTERN}(?:\&#{HEADER_PATTERN})*)\z/o !~ v
+ raise InvalidComponentError,
+ "bad component(expected opaque component): #{v}"
end
return true
@@ -208,9 +172,9 @@ module URI
def set_headers(v)
@headers = []
if v
- v.scan(HEADER_REGEXP) do |x|
- @headers << x.split(/=/o, 2)
- end
+ v.scan(HEADER_REGEXP) do |x|
+ @headers << x.split(/=/o, 2)
+ end
end
end
protected :set_headers
@@ -223,42 +187,44 @@ module URI
def to_s
@scheme + ':' +
- if @to
- @to
- else
- ''
- end +
- if @headers.size > 0
- '?' + @headers.collect{|x| x.join('=')}.join('&')
- else
- ''
- end +
- if @fragment
- '#' + @fragment
- else
- ''
- end
+ if @to
+ @to
+ else
+ ''
+ end +
+ if @headers.size > 0
+ '?' + @headers.collect{|x| x.join('=')}.join('&')
+ else
+ ''
+ end +
+ if @fragment
+ '#' + @fragment
+ else
+ ''
+ end
end
-
-=begin
-
---- URI::MailTo#to_mailtext
-
-=end
+ #
+ # == Usage
+ # require 'uri'
+ #
+ # uri = URI.parse("mailto:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr")
+ # uri.to_mailtext
+ # # => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"
+ #
def to_mailtext
to = URI::unescape(@to)
head = ''
body = ''
@headers.each do |x|
- case x[0]
- when 'body'
- body = URI::unescape(x[1])
- when 'to'
- to << ', ' + URI::unescape(x[1])
- else
- head << URI::unescape(x[0]).capitalize + ': ' +
- URI::unescape(x[1]) + "\n"
- end
+ case x[0]
+ when 'body'
+ body = URI::unescape(x[1])
+ when 'to'
+ to << ', ' + URI::unescape(x[1])
+ else
+ head << URI::unescape(x[0]).capitalize + ': ' +
+ URI::unescape(x[1]) + "\n"
+ end
end
return "To: #{to}
@@ -267,7 +233,7 @@ module URI
"
end
alias to_rfc822text to_mailtext
- end # MailTo
+ end
@@schemes['MAILTO'] = MailTo
-end # URI
+end