ruby-changes:19515
From: drbrain <ko1@a...>
Date: Sat, 14 May 2011 05:03:30 +0900 (JST)
Subject: [ruby-changes:19515] drbrain:r31555 (trunk): * lib/uri.rb: Add toplevel documentation. Patch by Vincent Batts.
drbrain 2011-05-14 05:03:21 +0900 (Sat, 14 May 2011) New Revision: 31555 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=31555 Log: * lib/uri.rb: Add toplevel documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #4690] Modified files: trunk/ChangeLog trunk/lib/uri/common.rb trunk/lib/uri/ftp.rb trunk/lib/uri/generic.rb trunk/lib/uri/http.rb trunk/lib/uri/https.rb trunk/lib/uri/ldap.rb trunk/lib/uri/ldaps.rb trunk/lib/uri/mailto.rb trunk/lib/uri.rb Index: ChangeLog =================================================================== --- ChangeLog (revision 31554) +++ ChangeLog (revision 31555) @@ -1,3 +1,8 @@ +Sat May 14 05:02:58 2011 Eric Hodel <drbrain@s...> + + * lib/uri.rb: Add toplevel documentation. Patch by Vincent Batts. + [Ruby 1.9 - Bug #4690] + Sat May 14 04:19:06 2011 Martin Bosslet <Martin.Bosslet@g...> * NEWS: Describe altered behaviour for RSA and DSA public key Index: lib/uri.rb =================================================================== --- lib/uri.rb (revision 31554) +++ lib/uri.rb (revision 31555) @@ -1,15 +1,97 @@ +# URI is a module providing classes to handle Uniform Resource Identifiers +# (RFC2396[http://tools.ietf.org/html/rfc2396]) # -# URI support for Ruby +# == Features # +# * Uniform handling of handling URIs +# * Flexibility to introduce custom URI schemes +# * Flexibility to have an alternate URI::Parser (or just different patterns +# and regexp's) +# +# == Basic example +# +# require 'uri' +# +# uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413") +# #=> #<URI::HTTP:0x00000000b14880 +# URL:http://foo.com/posts?id=30&limit=5#time=1305298413> +# uri.scheme +# #=> "http" +# uri.host +# #=> "foo.com" +# uri.path +# #=> "/posts" +# uri.query +# #=> "id=30&limit=5" +# uri.fragment +# #=> "time=1305298413" +# +# uri.to_s +# #=> "http://foo.com/posts?id=30&limit=5#time=1305298413" +# +# == Adding custom URIs +# +# module URI +# class RSYNC < Generic +# DEFAULT_PORT = 873 +# end +# @@schemes['RSYNC'] = RSYNC +# end +# #=> URI::RSYNC +# +# URI.scheme_list +# #=> {"FTP"=>URI::FTP, "HTTP"=>URI::HTTP, "HTTPS"=>URI::HTTPS, +# "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS, "MAILTO"=>URI::MailTo, +# "RSYNC"=>URI::RSYNC} +# +# uri = URI("rsync://rsync.foo.com") +# #=> #<URI::RSYNC:0x00000000f648c8 URL:rsync://rsync.foo.com> +# +# == RFC References +# +# A good place to view an RFC spec is http://www.ietf.org/rfc.html +# +# Here is a list of all related RFC's. +# - RFC822[http://tools.ietf.org/html/rfc822] +# - RFC1738[http://tools.ietf.org/html/rfc1738] +# - RFC2255[http://tools.ietf.org/html/rfc2255] +# - RFC2368[http://tools.ietf.org/html/rfc2368] +# - RFC2373[http://tools.ietf.org/html/rfc2373] +# - RFC2396[http://tools.ietf.org/html/rfc2396] +# - RFC2732[http://tools.ietf.org/html/rfc2732] +# - RFC3986[http://tools.ietf.org/html/rfc3986] +# +# == Class tree +# +# - URI::Generic (in uri/generic.rb) +# - URI::FTP - (in uri/ftp.rb) +# - URI::HTTP - (in uri/http.rb) +# - URI::HTTPS - (in uri/https.rb) +# - URI::LDAP - (in uri/ldap.rb) +# - URI::LDAPS - (in uri/ldaps.rb) +# - URI::MailTo - (in uri/mailto.rb) +# - URI::Parser - (in uri/common.rb) +# - URI::REGEXP - (in uri/common.rb) +# - URI::REGEXP::PATTERN - (in uri/common.rb) +# - URI::Util - (in uri/common.rb) +# - URI::Escape - (in uri/common.rb) +# - URI::Error - (in uri/common.rb) +# - URI::InvalidURIError - (in uri/common.rb) +# - URI::InvalidComponentError - (in uri/common.rb) +# - URI::BadURIError - (in uri/common.rb) +# +# == Copyright Info +# # Author:: Akira Yamada <akira@r...> -# Documentation:: Akira Yamada <akira@r...>, Dmitry V. Sabanin <sdmitry@l...> +# Documentation:: +# Akira Yamada <akira@r...> +# Dmitry V. Sabanin <sdmitry@l...> +# Vincent Batts <vbatts@h...> # License:: # Copyright (c) 2001 akira yamada <akira@r...> # You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # -# See URI for documentation -# module URI # :stopdoc: Index: lib/uri/http.rb =================================================================== --- lib/uri/http.rb (revision 31554) +++ lib/uri/http.rb (revision 31555) @@ -1,10 +1,11 @@ -# # = uri/http.rb # # Author:: Akira Yamada <akira@r...> # License:: You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # +# See URI for general documentation +# require 'uri/generic' Index: lib/uri/ldap.rb =================================================================== --- lib/uri/ldap.rb (revision 31554) +++ lib/uri/ldap.rb (revision 31555) @@ -1,4 +1,3 @@ -# # = uri/ldap.rb # # Author:: @@ -9,6 +8,8 @@ # You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # +# See URI for general documentation +# require 'uri/generic' Index: lib/uri/https.rb =================================================================== --- lib/uri/https.rb (revision 31554) +++ lib/uri/https.rb (revision 31555) @@ -1,10 +1,11 @@ -# # = uri/https.rb # # Author:: Akira Yamada <akira@r...> # License:: You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # +# See URI for general documentation +# require 'uri/http' Index: lib/uri/ldaps.rb =================================================================== --- lib/uri/ldaps.rb (revision 31554) +++ lib/uri/ldaps.rb (revision 31555) @@ -1,3 +1,10 @@ +# = uri/ldap.rb +# +# License:: You can redistribute it and/or modify it under the same term as Ruby. +# +# See URI for general documentation +# + require 'uri/ldap' module URI Index: lib/uri/mailto.rb =================================================================== --- lib/uri/mailto.rb (revision 31554) +++ lib/uri/mailto.rb (revision 31555) @@ -1,10 +1,11 @@ -# # = uri/mailto.rb # # Author:: Akira Yamada <akira@r...> # License:: You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # +# See URI for general documentation +# require 'uri/generic' Index: lib/uri/common.rb =================================================================== --- lib/uri/common.rb (revision 31554) +++ lib/uri/common.rb (revision 31555) @@ -1,3 +1,4 @@ +#-- # = uri/common.rb # # Author:: Akira Yamada <akira@r...> @@ -5,6 +6,8 @@ # License:: # You can redistribute it and/or modify it under the same term as Ruby. # +# See URI for general documentation +# module URI # @@ -634,7 +637,7 @@ DEFAULT_PARSER.unescape(*arg) end alias decode unescape - end + end # module Escape extend Escape include REGEXP @@ -978,7 +981,7 @@ end ary end -end +end # module URI module Kernel Index: lib/uri/ftp.rb =================================================================== --- lib/uri/ftp.rb (revision 31554) +++ lib/uri/ftp.rb (revision 31555) @@ -1,10 +1,11 @@ -# # = uri/ftp.rb # # Author:: Akira Yamada <akira@r...> # License:: You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # +# See URI for general documentation +# require 'uri/generic' Index: lib/uri/generic.rb =================================================================== --- lib/uri/generic.rb (revision 31554) +++ lib/uri/generic.rb (revision 31555) @@ -1,11 +1,11 @@ - -# # = uri/generic.rb # # Author:: Akira Yamada <akira@r...> # License:: You can redistribute it and/or modify it under the same term as Ruby. # Revision:: $Id$ # +# See URI for general documentation +# require 'uri/common' -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/