rbs 2.0.0 → 2.1.0

data/stdlib/uri/0/common.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/uri.rb -->
 # URI is a module providing classes to handle Uniform Resource Identifiers
 # ([RFC2396](http://tools.ietf.org/html/rfc2396)).
 #
@@ -30,7 +31,7 @@
 #       class RSYNC < Generic
 #         DEFAULT_PORT = 873
 #       end
-#       @@schemes['RSYNC'] = RSYNC
+#       register_scheme 'RSYNC', RSYNC
 #     end
 #     #=> URI::RSYNC
 #
@@ -75,7 +76,6 @@
 #     *   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)
@@ -93,12 +93,14 @@
 # License
 # :   Copyright (c) 2001 akira yamada <akira@ruby-lang.org> You can redistribute
 #     it and/or modify it under the same term as Ruby.
-# Revision
-# :   $Id$
 #
 module URI
   include URI::RFC2396_REGEXP
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
+  # -->
   # Decodes URL-encoded form data from given `str`.
   #
   # This decodes application/x-www-form-urlencoded data and returns an array of
@@ -118,6 +120,10 @@ module URI
   #
   def self.decode_www_form: (String str, ?encoding enc, ?isindex: boolish, ?use__charset_: boolish, ?separator: String) -> Array[[ String, String ]]
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - decode_www_form_component(str, enc=Encoding::UTF_8)
+  # -->
   # Decodes given `str` of URL-encoded form data.
   #
   # This decodes + to SP.
@@ -126,6 +132,10 @@ module URI
   #
   def self.decode_www_form_component: (String str, ?encoding enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - encode_www_form(enum, enc=nil)
+  # -->
   # Generates URL-encoded form data from given `enum`.
   #
   # This generates application/x-www-form-urlencoded data defined in HTML5 from
@@ -141,7 +151,7 @@ module URI
   # This method doesn't handle files.  When you send a file, use
   # multipart/form-data.
   #
-  # This refers http://url.spec.whatwg.org/#concept-urlencoded-serializer
+  # This refers https://url.spec.whatwg.org/#concept-urlencoded-serializer
   #
   #     URI.encode_www_form([["q", "ruby"], ["lang", "en"]])
   #     #=> "q=ruby&lang=en"
@@ -156,6 +166,10 @@ module URI
   #
   def self.encode_www_form: (Enumerable[[ _ToS, _ToS ]] enum, ?encoding? enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - encode_www_form_component(str, enc=nil)
+  # -->
   # Encodes given `str` to URL-encoded form data.
   #
   # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
@@ -164,12 +178,16 @@ module URI
   # If `enc` is given, convert `str` to the encoding before percent encoding.
   #
   # This is an implementation of
-  # http://www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.
+  # https://www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.
   #
   # See URI.decode_www_form_component, URI.encode_www_form.
   #
   def self.encode_www_form_component: (_ToS str, ?encoding? enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - extract(str, schemes = nil, &block)
+  # -->
   # ## Synopsis
   #
   #     URI::extract(str[, schemes][,&blk])
@@ -199,6 +217,10 @@ module URI
 
   def self.get_encoding: (String label) -> Encoding?
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - join(*str)
+  # -->
   # ## Synopsis
   #
   #     URI::join(str[, str, ...])
@@ -234,6 +256,10 @@ module URI
   #
   def self.join: (String str, *String strs) -> URI::Generic
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - parse(uri)
+  # -->
   # ## Synopsis
   #
   #     URI::parse(uri_str)
@@ -270,6 +296,10 @@ module URI
   #
   def self.parse: (_ToStr uri) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - regexp(schemes = nil)
+  # -->
   # ## Synopsis
   #
   #     URI::regexp([match_schemes])
@@ -285,7 +315,7 @@ module URI
   #
   # 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.
+  # (parentheses).  Never rely on its number.
   #
   # ## Usage
   #
@@ -304,15 +334,27 @@ module URI
   #
   def self.regexp: (?Array[String]? schemes) -> Regexp
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - scheme_list()
+  # -->
   # Returns a Hash of the defined schemes.
   #
   def self.scheme_list: () -> Hash[String, Class]
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - for(scheme, *arguments, default: Generic)
+  # -->
   # Construct a URI instance, using the scheme to detect the appropriate class
-  # from +URI.scheme_list+.
+  # from `URI.scheme_list`.
   #
   def self.for: (String scheme, *untyped arguments, ?default: Class) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - split(uri)
+  # -->
   # ## Synopsis
   #
   #     URI::split(uri)
@@ -354,7 +396,9 @@ URI::ABS_URI: Regexp
 
 URI::ABS_URI_REF: Regexp
 
+# <!-- rdoc-file=lib/uri/common.rb -->
 # URI::Parser.new
+#
 URI::DEFAULT_PARSER: URI::RFC2396_Parser
 
 URI::ESCAPED: Regexp
@@ -397,9 +441,14 @@ URI::VERSION_CODE: String
 
 URI::WEB_ENCODINGS_: Hash[String, String]
 
+%a{annotate:rdoc:skip}
 module Kernel
   private
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - URI(uri)
+  # -->
   # Returns `uri` converted to an URI object.
   #
   def self?.URI: (URI::Generic | String uri) -> URI::Generic

data/stdlib/uri/0/file.rbs

@@ -1,127 +1,34 @@
-# URI is a module providing classes to handle Uniform Resource Identifiers
-# ([RFC2396](http://tools.ietf.org/html/rfc2396)).
-#
-# ## Features
-#
-# *   Uniform way 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 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
-#     #=> {"FILE"=>URI::File, "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 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::File - (in uri/file.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@ruby-lang.org>
-# Documentation
-# :   Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru>
-#     Vincent Batts <vbatts@hashbangbash.com>
-# License
-# :   Copyright (c) 2001 akira yamada <akira@ruby-lang.org> You can redistribute
-#     it and/or modify it under the same term as Ruby.
-# Revision
-# :   $Id$
-#
-#
+%a{annotate:rdoc:skip}
 module URI
-  #
+  # <!-- rdoc-file=lib/uri/file.rb -->
   # The "file" URI is defined by RFC8089.
   #
   class File < Generic
+    # <!-- rdoc-file=lib/uri/file.rb -->
     # A Default port of nil for URI::File.
+    #
     DEFAULT_PORT: Integer?
 
-    #
+    # <!-- rdoc-file=lib/uri/file.rb -->
     # An Array of the available components for URI::File.
     #
     COMPONENT: Array[Symbol]
 
-    #
-    # == Description
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - build(args)
+    # -->
+    # ## Description
     #
     # Creates a new URI::File object from components, with syntax checking.
     #
-    # The components accepted are +host+ and +path+.
+    # The components accepted are `host` and `path`.
     #
-    # The components should be provided either as an Array, or as a Hash
-    # with keys formed by preceding the component names with a colon.
+    # The components should be provided either as an Array, or as a Hash with keys
+    # formed by preceding the component names with a colon.
     #
-    # If an Array is used, the components must be passed in the
-    # order <code>[host, path]</code>.
+    # If an Array is used, the components must be passed in the order `[host,
+    # path]`.
     #
     # Examples:
     #
@@ -137,31 +44,70 @@ module URI
     def self.build: (Array[String] args) -> URI::File
                   | ({ host: String, path: String }) -> URI::File
 
-    # Protected setter for the host component +v+.
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - set_host(v)
+    # -->
+    # Protected setter for the host component `v`.
     #
     # See also URI::Generic.host=.
     #
     def set_host: (String? v) -> String
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - set_port(v)
+    # -->
     # do nothing
+    #
     def set_port: (Integer v) -> nil
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - check_userinfo(user)
+    # -->
     # raise InvalidURIError
+    #
     def check_userinfo: (String user) -> nil
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - check_user(user)
+    # -->
     # raise InvalidURIError
+    #
     def check_user: (String user) -> nil
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - check_password(user)
+    # -->
     # raise InvalidURIError
+    #
     def check_password: (String user) -> nil
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - set_userinfo(v)
+    # -->
     # do nothing
+    #
     def set_userinfo: (String v) -> nil
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - set_user(v)
+    # -->
     # do nothing
+    #
     def set_user: (String v) -> nil
 
+    # <!--
+    #   rdoc-file=lib/uri/file.rb
+    #   - set_password(v)
+    # -->
     # do nothing
+    #
     def set_password: (String v) -> nil
   end
 end

data/stdlib/uri/0/ftp.rbs

@@ -1,10 +1,13 @@
+%a{annotate:rdoc:skip}
 module URI
+  # <!-- rdoc-file=lib/uri/ftp.rb -->
   # FTP URI syntax is defined by RFC1738 section 3.2.
   #
-  # This class will be redesigned because of difference of implementations;
-  # the structure of its path. draft-hoffman-ftp-uri-04 is a draft but it
-  # is a good summary about the de facto spec.
+  # This class will be redesigned because of difference of implementations; the
+  # structure of its path. draft-hoffman-ftp-uri-04 is a draft but it is a good
+  # summary about the de facto spec.
   # http://tools.ietf.org/html/draft-hoffman-ftp-uri-04
+  #
   class FTP < Generic
   end
 end