rbs-relaxed 3.9.0.1

data/stdlib/uri/0/http.rbs

@@ -0,0 +1,104 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/http.rb -->
+  # The syntax of HTTP URIs is defined in RFC1738 section 3.3.
+  #
+  # Note that the Ruby URI library allows HTTP URLs containing usernames and
+  # passwords. This is not legal as per the RFC, but used to be supported in
+  # Internet Explorer 5 and 6, before the MS04-004 security update. See
+  # <URL:http://support.microsoft.com/kb/834489>.
+  #
+  class HTTP < Generic
+    # <!-- rdoc-file=lib/uri/http.rb -->
+    # A Default port of 80 for URI::HTTP.
+    #
+    DEFAULT_PORT: Integer
+
+    # <!-- rdoc-file=lib/uri/http.rb -->
+    # An Array of the available components for URI::HTTP.
+    #
+    COMPONENT: Array[Symbol]
+
+    # <!--
+    #   rdoc-file=lib/uri/http.rb
+    #   - build(args)
+    # -->
+    # ## Description
+    #
+    # Creates a new URI::HTTP object from components, with syntax checking.
+    #
+    # The components accepted are userinfo, host, port, path, query, and fragment.
+    #
+    # 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 `[userinfo,
+    # host, port, path, query, fragment]`.
+    #
+    # Example:
+    #
+    #     uri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
+    #
+    #     uri = URI::HTTP.build([nil, "www.example.com", nil, "/path",
+    #       "query", 'fragment'])
+    #
+    # Currently, if passed userinfo components this method generates invalid HTTP
+    # URIs as per RFC 1738.
+    #
+    def self.build: (Array[String | Integer] args) -> instance
+                  | ({ userinfo: String?, host: String?, port: Integer?, path: String?, query: String?, fragment: String? }) -> instance
+
+    # <!--
+    #   rdoc-file=lib/uri/http.rb
+    #   - authority()
+    # -->
+    # ## Description
+    #
+    # Returns the authority for an HTTP uri, as defined in
+    # https://www.rfc-editor.org/rfc/rfc3986#section-3.2.
+    #
+    # Example:
+    #
+    #     URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').authority #=> "www.example.com"
+    #     URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').authority #=> "www.example.com:8000"
+    #     URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').authority #=> "www.example.com"
+    #
+    def authority: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/http.rb
+    #   - origin()
+    # -->
+    # ## Description
+    #
+    # Returns the origin for an HTTP uri, as defined in
+    # https://www.rfc-editor.org/rfc/rfc6454.
+    #
+    # Example:
+    #
+    #     URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').origin #=> "http://www.example.com"
+    #     URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').origin #=> "http://www.example.com:8000"
+    #     URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').origin #=> "http://www.example.com"
+    #     URI::HTTPS.build(host: 'www.example.com', path: '/foo/bar').origin #=> "https://www.example.com"
+    #
+    def origin: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/http.rb
+    #   - request_uri()
+    # -->
+    # ## Description
+    #
+    # Returns the full path for an HTTP request, as required by Net::HTTP::Get.
+    #
+    # If the URI contains a query, the full path is URI#path + '?' + URI#query.
+    # Otherwise, the path is simply URI#path.
+    #
+    # Example:
+    #
+    #     uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
+    #     uri.request_uri #  => "/foo/bar?test=true"
+    #
+    def request_uri: () -> String
+  end
+end

data/stdlib/uri/0/https.rbs

@@ -0,0 +1,14 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/https.rb -->
+  # The default port for HTTPS URIs is 443, and the scheme is 'https:' rather than
+  # 'http:'. Other than that, HTTPS URIs are identical to HTTP URIs; see
+  # URI::HTTP.
+  #
+  class HTTPS < HTTP
+    # <!-- rdoc-file=lib/uri/https.rb -->
+    # A Default port of 443 for URI::HTTPS
+    #
+    DEFAULT_PORT: Integer
+  end
+end

data/stdlib/uri/0/ldap.rbs

@@ -0,0 +1,230 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/ldap.rb -->
+  # LDAP URI SCHEMA (described in RFC2255).
+  #
+  class LDAP < Generic
+    # <!-- rdoc-file=lib/uri/ldap.rb -->
+    # A Default port of 389 for URI::LDAP.
+    #
+    DEFAULT_PORT: Integer
+
+    # <!-- rdoc-file=lib/uri/ldap.rb -->
+    # An Array of the available components for URI::LDAP.
+    #
+    COMPONENT: Array[Symbol]
+
+    # <!-- rdoc-file=lib/uri/ldap.rb -->
+    # Scopes available for the starting point.
+    #
+    # *   SCOPE_BASE - the Base DN
+    # *   SCOPE_ONE  - one level under the Base DN, not including the base DN and
+    #     not including any entries under this
+    # *   SCOPE_SUB  - subtrees, all entries at all levels
+    #
+    SCOPE: Array[String]
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - build(args)
+    # -->
+    # ## Description
+    #
+    # Creates a new URI::LDAP object from components, with syntax checking.
+    #
+    # The components accepted are host, port, dn, attributes, scope, filter, and
+    # extensions.
+    #
+    # 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 `[host, port,
+    # dn, attributes, scope, filter, extensions]`.
+    #
+    # Example:
+    #
+    #     uri = URI::LDAP.build({:host => 'ldap.example.com',
+    #       :dn => '/dc=example'})
+    #
+    #     uri = URI::LDAP.build(["ldap.example.com", nil,
+    #       "/dc=example;dc=com", "query", nil, nil, nil])
+    #
+    def self.build: (Array[nil | String | Integer] args) -> URI::LDAP
+                  | ({ host: String?, port: Integer?, dn: String?, attributes: String?, scope: String?, filter: String?, extensions: String? }) -> URI::LDAP
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - new(*arg)
+    # -->
+    # ## Description
+    #
+    # Creates a new URI::LDAP object from generic URI components as per RFC 2396. No
+    # LDAP-specific syntax checking is performed.
+    #
+    # Arguments are `scheme`, `userinfo`, `host`, `port`, `registry`, `path`,
+    # `opaque`, `query`, and `fragment`, in that order.
+    #
+    # Example:
+    #
+    #     uri = URI::LDAP.new("ldap", nil, "ldap.example.com", nil, nil,
+    #       "/dc=example;dc=com", nil, "query", nil)
+    #
+    # See also URI::Generic.new.
+    #
+    def initialize: (String schema, String? userinfo, String host, Integer? port, String? registry, String? path, String? opaque, String query, String? fragment) -> void
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - parse_dn()
+    # -->
+    # Private method to cleanup `dn` from using the `path` component attribute.
+    #
+    def parse_dn: () -> nil
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - parse_query()
+    # -->
+    # Private method to cleanup `attributes`, `scope`, `filter`, and `extensions`
+    # from using the `query` component attribute.
+    #
+    def parse_query: () -> nil
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - build_path_query()
+    # -->
+    # Private method to assemble `query` from `attributes`, `scope`, `filter`, and
+    # `extensions`.
+    #
+    def build_path_query: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - dn()
+    # -->
+    # Returns dn.
+    #
+    def dn: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - set_dn(val)
+    # -->
+    # Private setter for dn `val`.
+    #
+    def set_dn: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - dn=(val)
+    # -->
+    # Setter for dn `val`.
+    #
+    def dn=: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - attributes()
+    # -->
+    # Returns attributes.
+    #
+    def attributes: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - set_attributes(val)
+    # -->
+    # Private setter for attributes `val`.
+    #
+    def set_attributes: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - attributes=(val)
+    # -->
+    # Setter for attributes `val`.
+    #
+    def attributes=: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - scope()
+    # -->
+    # Returns scope.
+    #
+    def scope: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - set_scope(val)
+    # -->
+    # Private setter for scope `val`.
+    #
+    def set_scope: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - scope=(val)
+    # -->
+    # Setter for scope `val`.
+    #
+    def scope=: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - filter()
+    # -->
+    # Returns filter.
+    #
+    def filter: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - set_filter(val)
+    # -->
+    # Private setter for filter `val`.
+    #
+    def set_filter: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - filter=(val)
+    # -->
+    # Setter for filter `val`.
+    #
+    def filter=: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - extensions()
+    # -->
+    # Returns extensions.
+    #
+    def extensions: () -> untyped
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - set_extensions(val)
+    # -->
+    # Private setter for extensions `val`.
+    #
+    def set_extensions: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - extensions=(val)
+    # -->
+    # Setter for extensions `val`.
+    #
+    def extensions=: (String val) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/ldap.rb
+    #   - hierarchical?()
+    # -->
+    # Checks if URI has a path. For URI::LDAP this will return `false`.
+    #
+    def hierarchical?: () -> ::FalseClass
+  end
+end

data/stdlib/uri/0/ldaps.rbs

@@ -0,0 +1,14 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/ldaps.rb -->
+  # The default port for LDAPS URIs is 636, and the scheme is 'ldaps:' rather than
+  # 'ldap:'. Other than that, LDAPS URIs are identical to LDAP URIs; see
+  # URI::LDAP.
+  #
+  class LDAPS < LDAP
+    # <!-- rdoc-file=lib/uri/ldaps.rb -->
+    # A Default port of 636 for URI::LDAPS
+    #
+    DEFAULT_PORT: Integer
+  end
+end

data/stdlib/uri/0/mailto.rbs

@@ -0,0 +1,92 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/mailto.rb -->
+  # RFC6068, the mailto URL scheme.
+  #
+  class MailTo < Generic
+    EMAIL_REGEXP: Regexp
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - build(args)
+    # -->
+    # ## Description
+    #
+    # Creates a new URI::MailTo object from components, with syntax checking.
+    #
+    # Components can be provided as an Array or Hash. If an Array is used, the
+    # components must be supplied as `[to, headers]`.
+    #
+    # If a Hash is used, the keys are the component names preceded by colons.
+    #
+    # The headers can be supplied as a pre-encoded string, such as
+    # `"subject=subscribe&cc=address"`, or as an Array of Arrays like `[['subject',
+    # 'subscribe'], ['cc', 'address']]`.
+    #
+    # Examples:
+    #
+    #     require 'uri'
+    #
+    #     m1 = URI::MailTo.build(['joe@example.com', 'subject=Ruby'])
+    #     m1.to_s  # => "mailto:joe@example.com?subject=Ruby"
+    #
+    #     m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
+    #     m2.to_s  # => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"
+    #
+    #     m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
+    #     m3.to_s  # => "mailto:listman@example.com?subject=subscribe"
+    #
+    def self.build: (Array[String]) -> instance
+                  | ([String, Array[Array[String]]]) -> instance
+                  | (Hash[Symbol, String | Array[Array[String]]]) -> instance
+
+    # <!-- rdoc-file=lib/uri/mailto.rb -->
+    # E-mail headers set by the URL, as an Array of Arrays.
+    #
+    def headers: () -> Array[[String, String]]
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - headers=(v)
+    # -->
+    # Setter for headers `v`.
+    #
+    def headers=: (String) -> String
+
+    # <!-- rdoc-file=lib/uri/mailto.rb -->
+    # The primary e-mail address of the URL, as a String.
+    #
+    def to: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - to=(v)
+    # -->
+    # Setter for to `v`.
+    #
+    def to=: (String) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - to_mailtext()
+    # -->
+    # Returns the RFC822 e-mail text equivalent of the URL, as a String.
+    #
+    # Example:
+    #
+    #     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: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - to_rfc822text()
+    # -->
+    #
+    def to_rfc822text: () -> String
+  end
+end

data/stdlib/uri/0/rfc2396_parser.rbs

@@ -0,0 +1,189 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
+  # Includes URI::REGEXP::PATTERN
+  #
+  module RFC2396_REGEXP
+  end
+
+  # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
+  # Class that parses String's into URI's.
+  #
+  # It contains a Hash set of patterns and Regexp's that match and validate.
+  #
+  class RFC2396_Parser
+    include RFC2396_REGEXP
+
+    # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
+    # The Hash of patterns.
+    #
+    # See also URI::Parser.initialize_pattern.
+    #
+    attr_reader pattern: Hash[Symbol, String]
+
+    # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
+    # The Hash of Regexp.
+    #
+    # See also URI::Parser.initialize_regexp.
+    #
+    attr_reader regexp: Hash[Symbol, Regexp]
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - new(opts = {})
+    # -->
+    # ## Synopsis
+    #
+    #     URI::Parser.new([opts])
+    #
+    # ## Args
+    #
+    # The constructor accepts a hash as options for parser. Keys of options are
+    # pattern names of URI components and values of options are pattern strings. The
+    # constructor generates set of regexps for parsing URIs.
+    #
+    # You can use the following keys:
+    #
+    #     * :ESCAPED (URI::PATTERN::ESCAPED in default)
+    #     * :UNRESERVED (URI::PATTERN::UNRESERVED in default)
+    #     * :DOMLABEL (URI::PATTERN::DOMLABEL in default)
+    #     * :TOPLABEL (URI::PATTERN::TOPLABEL in default)
+    #     * :HOSTNAME (URI::PATTERN::HOSTNAME in default)
+    #
+    # ## Examples
+    #
+    #     p = URI::Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
+    #     u = p.parse("http://example.jp/%uABCD") #=> #<URI::HTTP http://example.jp/%uABCD>
+    #     URI.parse(u.to_s) #=> raises URI::InvalidURIError
+    #
+    #     s = "http://example.com/ABCD"
+    #     u1 = p.parse(s) #=> #<URI::HTTP http://example.com/ABCD>
+    #     u2 = URI.parse(s) #=> #<URI::HTTP http://example.com/ABCD>
+    #     u1 == u2 #=> true
+    #     u1.eql?(u2) #=> false
+    #
+    def initialize: (?Hash[Symbol, String] opts) -> void
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - escape( str )
+    #   - escape( str, unsafe )
+    # -->
+    # ## Args
+    #
+    # `str`
+    # :   String to make safe
+    #
+    # `unsafe`
+    # :   Regexp to apply. Defaults to `self.regexp[:UNSAFE]`
+    #
+    #
+    # ## Description
+    #
+    # Constructs a safe String from `str`, removing unsafe characters, replacing
+    # them with codes.
+    #
+    def escape: (String str, ?Regexp unsafe) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - extract( str )
+    #   - extract( str, schemes )
+    #   - extract( str, schemes ) {|item| block }
+    # -->
+    # ## Args
+    #
+    # `str`
+    # :   String to search
+    #
+    # `schemes`
+    # :   Patterns to apply to `str`
+    #
+    #
+    # ## Description
+    #
+    # Attempts to parse and merge a set of URIs. If no `block` given, then returns
+    # the result, else it calls `block` for each element in result.
+    #
+    # See also URI::Parser.make_regexp.
+    #
+    def extract: (String str, ?Array[String] schemes) -> Array[String]
+               | (String str, ?Array[String] schemes) { (String) -> untyped } -> nil
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - join(*uris)
+    # -->
+    # ## Args
+    #
+    # `uris`
+    # :   an Array of Strings
+    #
+    #
+    # ## Description
+    #
+    # Attempts to parse and merge a set of URIs.
+    #
+    def join: (*String uris) -> URI::Generic
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - make_regexp(schemes = nil)
+    # -->
+    # Returns Regexp that is default `self.regexp[:ABS_URI_REF]`, unless `schemes`
+    # is provided. Then it is a Regexp.union with `self.pattern[:X_ABS_URI]`.
+    #
+    def make_regexp: (?Array[String] schemes) -> Regexp
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - parse(uri)
+    # -->
+    # ## Args
+    #
+    # `uri`
+    # :   String
+    #
+    #
+    # ## Description
+    #
+    # Parses `uri` and constructs either matching URI scheme object (File, FTP,
+    # HTTP, HTTPS, LDAP, LDAPS, or MailTo) or URI::Generic.
+    #
+    # ## Usage
+    #
+    #     p = URI::Parser.new
+    #     p.parse("ldap://ldap.example.com/dc=example?user=john")
+    #     #=> #<URI::LDAP ldap://ldap.example.com/dc=example?user=john>
+    #
+    def parse: (String uri) -> URI::Generic
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - split(uri)
+    # -->
+    # Returns a split URI against `regexp[:ABS_URI]`.
+    #
+    def split: (String uri) -> [ String?, String?, String?, String?, String?, String?, String?, String?, String? ]
+
+    # <!--
+    #   rdoc-file=lib/uri/rfc2396_parser.rb
+    #   - unescape( str )
+    #   - unescape( str, escaped )
+    # -->
+    # ## Args
+    #
+    # `str`
+    # :   String to remove escapes from
+    #
+    # `escaped`
+    # :   Regexp to apply. Defaults to `self.regexp[:ESCAPED]`
+    #
+    #
+    # ## Description
+    #
+    # Removes escapes from `str`.
+    #
+    def unescape: (String str, ?Regexp escaped) -> String
+  end
+end

data/stdlib/uri/0/rfc3986_parser.rbs

@@ -0,0 +1,2 @@
+class URI::RFC3986_Parser
+end

data/stdlib/uri/0/ws.rbs

@@ -0,0 +1,13 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/ws.rb -->
+  # The syntax of WS URIs is defined in RFC6455 section 3.
+  #
+  # Note that the Ruby URI library allows WS URLs containing usernames and
+  # passwords. This is not legal as per the RFC, but used to be supported in
+  # Internet Explorer 5 and 6, before the MS04-004 security update. See
+  # <URL:http://support.microsoft.com/kb/834489>.
+  #
+  class WS < Generic
+  end
+end

data/stdlib/uri/0/wss.rbs

@@ -0,0 +1,9 @@
+%a{annotate:rdoc:skip}
+module URI
+  # <!-- rdoc-file=lib/uri/wss.rb -->
+  # The default port for WSS URIs is 443, and the scheme is 'wss:' rather than
+  # 'ws:'. Other than that, WSS URIs are identical to WS URIs; see URI::WS.
+  #
+  class WSS < WS
+  end
+end

data/stdlib/yaml/0/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: psych

data/stdlib/yaml/0/yaml.rbs

@@ -0,0 +1 @@
+module YAML = Psych

data/stdlib/zlib/0/buf_error.rbs

@@ -0,0 +1,10 @@
+%a{annotate:rdoc:skip}
+module Zlib
+  # <!-- rdoc-file=ext/zlib/zlib.c -->
+  # Subclass of Zlib::Error when zlib returns a Z_BUF_ERROR.
+  #
+  # Usually if no progress is possible.
+  #
+  class BufError < Zlib::Error
+  end
+end

data/stdlib/zlib/0/data_error.rbs

@@ -0,0 +1,10 @@
+%a{annotate:rdoc:skip}
+module Zlib
+  # <!-- rdoc-file=ext/zlib/zlib.c -->
+  # Subclass of Zlib::Error when zlib returns a Z_DATA_ERROR.
+  #
+  # Usually if a stream was prematurely freed.
+  #
+  class DataError < Zlib::Error
+  end
+end