danger-packwerk 0.7.0 → 0.7.1

data/sorbet/rbi/gems/addressable@2.8.1.rbi

@@ -0,0 +1,1505 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `addressable` gem.
+# Please instead update this file by running `bin/tapioca gem addressable`.
+
+# Addressable is a library for processing links and URIs.
+module Addressable; end
+
+module Addressable::IDNA
+  class << self
+    # Converts from a Unicode internationalized domain name to an ASCII
+    # domain name as described in RFC 3490.
+    def to_ascii(input); end
+
+    # Converts from an ASCII domain name to a Unicode internationalized
+    # domain name as described in RFC 3490.
+    def to_unicode(input); end
+
+    # Unicode normalization form KC.
+    def unicode_normalize_kc(input); end
+
+    private
+
+    def lookup_unicode_combining_class(codepoint); end
+    def lookup_unicode_compatibility(codepoint); end
+    def lookup_unicode_composition(unpacked); end
+    def lookup_unicode_lowercase(codepoint); end
+
+    # Bias adaptation method
+    def punycode_adapt(delta, numpoints, firsttime); end
+
+    # @return [Boolean]
+    def punycode_basic?(codepoint); end
+
+    def punycode_decode(punycode); end
+
+    # Returns the numeric value of a basic codepoint
+    # (for use in representing integers) in the range 0 to
+    # base - 1, or PUNYCODE_BASE if codepoint does not represent a value.
+    def punycode_decode_digit(codepoint); end
+
+    # @return [Boolean]
+    def punycode_delimiter?(codepoint); end
+
+    def punycode_encode(unicode); end
+    def punycode_encode_digit(d); end
+    def ucs4_to_utf8(char, buffer); end
+    def unicode_compose(unpacked); end
+    def unicode_compose_pair(ch_one, ch_two); end
+    def unicode_decompose(unpacked); end
+    def unicode_decompose_hangul(codepoint); end
+
+    # Unicode aware downcase method.
+    #
+    # @api private
+    # @param input [String] The input string.
+    # @return [String] The downcased result.
+    def unicode_downcase(input); end
+
+    def unicode_sort_canonical(unpacked); end
+  end
+end
+
+Addressable::IDNA::ACE_MAX_LENGTH = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::ACE_PREFIX = T.let(T.unsafe(nil), String)
+Addressable::IDNA::COMPOSITION_TABLE = T.let(T.unsafe(nil), Hash)
+Addressable::IDNA::HANGUL_LBASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::HANGUL_LCOUNT = T.let(T.unsafe(nil), Integer)
+
+# 588
+Addressable::IDNA::HANGUL_NCOUNT = T.let(T.unsafe(nil), Integer)
+
+Addressable::IDNA::HANGUL_SBASE = T.let(T.unsafe(nil), Integer)
+
+# 11172
+Addressable::IDNA::HANGUL_SCOUNT = T.let(T.unsafe(nil), Integer)
+
+Addressable::IDNA::HANGUL_TBASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::HANGUL_TCOUNT = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::HANGUL_VBASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::HANGUL_VCOUNT = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_BASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_DAMP = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_DELIMITER = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_INITIAL_BIAS = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_INITIAL_N = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_MAXINT = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_PRINT_ASCII = T.let(T.unsafe(nil), String)
+Addressable::IDNA::PUNYCODE_SKEW = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_TMAX = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::PUNYCODE_TMIN = T.let(T.unsafe(nil), Integer)
+
+# Input is invalid.
+class Addressable::IDNA::PunycodeBadInput < ::StandardError; end
+
+# Output would exceed the space provided.
+class Addressable::IDNA::PunycodeBigOutput < ::StandardError; end
+
+# Input needs wider integers to process.
+class Addressable::IDNA::PunycodeOverflow < ::StandardError; end
+
+Addressable::IDNA::UNICODE_DATA = T.let(T.unsafe(nil), Hash)
+Addressable::IDNA::UNICODE_DATA_CANONICAL = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_DATA_COMBINING_CLASS = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_DATA_COMPATIBILITY = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_DATA_EXCLUSION = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_DATA_LOWERCASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_DATA_TITLECASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_DATA_UPPERCASE = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_MAX_LENGTH = T.let(T.unsafe(nil), Integer)
+Addressable::IDNA::UNICODE_TABLE = T.let(T.unsafe(nil), String)
+Addressable::IDNA::UTF8_REGEX = T.let(T.unsafe(nil), Regexp)
+Addressable::IDNA::UTF8_REGEX_MULTIBYTE = T.let(T.unsafe(nil), Regexp)
+
+# This is an implementation of a URI template based on
+# RFC 6570 (http://tools.ietf.org/html/rfc6570).
+class Addressable::Template
+  # Creates a new <tt>Addressable::Template</tt> object.
+  #
+  # @param pattern [#to_str] The URI Template pattern.
+  # @return [Addressable::Template] The initialized Template object.
+  def initialize(pattern); end
+
+  # Returns <code>true</code> if the Template objects are equal. This method
+  # does NOT normalize either Template before doing the comparison.
+  #
+  # @param template [Object] The Template to compare.
+  # @return [TrueClass, FalseClass] <code>true</code> if the Templates are equivalent, <code>false</code>
+  #   otherwise.
+  def ==(template); end
+
+  # Returns <code>true</code> if the Template objects are equal. This method
+  # does NOT normalize either Template before doing the comparison.
+  # Addressable::Template makes no distinction between `==` and `eql?`.
+  #
+  # @param template [Object] The Template to compare.
+  # @return [TrueClass, FalseClass] <code>true</code> if the Templates are equivalent, <code>false</code>
+  #   otherwise.
+  # @see #==
+  def eql?(template); end
+
+  # Expands a URI template into a full URI.
+  #
+  # The object should respond to either the <tt>validate</tt> or
+  # <tt>transform</tt> messages or both. Both the <tt>validate</tt> and
+  # <tt>transform</tt> methods should take two parameters: <tt>name</tt> and
+  # <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>
+  # or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,
+  # <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt>
+  # exception will be raised if the value is invalid. The <tt>transform</tt>
+  # method should return the transformed variable value as a <tt>String</tt>.
+  # If a <tt>transform</tt> method is used, the value will not be percent
+  # encoded automatically. Unicode normalization will be performed both
+  # before and after sending the value to the transform method.
+  #
+  # @example
+  #   class ExampleProcessor
+  #   def self.validate(name, value)
+  #   return !!(value =~ /^[\w ]+$/) if name == "query"
+  #   return true
+  #   end
+  #
+  #   def self.transform(name, value)
+  #   return value.gsub(/ /, "+") if name == "query"
+  #   return value
+  #   end
+  #   end
+  #
+  #   Addressable::Template.new(
+  #   "http://example.com/search/{query}/"
+  #   ).expand(
+  #   {"query" => "an example search query"},
+  #   ExampleProcessor
+  #   ).to_str
+  #   #=> "http://example.com/search/an+example+search+query/"
+  #
+  #   Addressable::Template.new(
+  #   "http://example.com/search/{query}/"
+  #   ).expand(
+  #   {"query" => "an example search query"}
+  #   ).to_str
+  #   #=> "http://example.com/search/an%20example%20search%20query/"
+  #
+  #   Addressable::Template.new(
+  #   "http://example.com/search/{query}/"
+  #   ).expand(
+  #   {"query" => "bogus!"},
+  #   ExampleProcessor
+  #   ).to_str
+  #   #=> Addressable::Template::InvalidTemplateValueError
+  # @param mapping [Hash] The mapping that corresponds to the pattern.
+  # @param processor [#validate, #transform] An optional processor object may be supplied.
+  # @param normalize_values [Boolean] Optional flag to enable/disable unicode normalization. Default: true
+  # @return [Addressable::URI] The expanded URI template.
+  def expand(mapping, processor = T.unsafe(nil), normalize_values = T.unsafe(nil)); end
+
+  # Extracts a mapping from the URI using a URI Template pattern.
+  #
+  # @example
+  #   class ExampleProcessor
+  #   def self.restore(name, value)
+  #   return value.gsub(/\+/, " ") if name == "query"
+  #   return value
+  #   end
+  #
+  #   def self.match(name)
+  #   return ".*?" if name == "first"
+  #   return ".*"
+  #   end
+  #   end
+  #
+  #   uri = Addressable::URI.parse(
+  #   "http://example.com/search/an+example+search+query/"
+  #   )
+  #   Addressable::Template.new(
+  #   "http://example.com/search/{query}/"
+  #   ).extract(uri, ExampleProcessor)
+  #   #=> {"query" => "an example search query"}
+  #
+  #   uri = Addressable::URI.parse("http://example.com/a/b/c/")
+  #   Addressable::Template.new(
+  #   "http://example.com/{first}/{second}/"
+  #   ).extract(uri, ExampleProcessor)
+  #   #=> {"first" => "a", "second" => "b/c"}
+  #
+  #   uri = Addressable::URI.parse("http://example.com/a/b/c/")
+  #   Addressable::Template.new(
+  #   "http://example.com/{first}/{-list|/|second}/"
+  #   ).extract(uri)
+  #   #=> {"first" => "a", "second" => ["b", "c"]}
+  # @param uri [Addressable::URI, #to_str] The URI to extract from.
+  # @param processor [#restore, #match] A template processor object may optionally be supplied.
+  #
+  #   The object should respond to either the <tt>restore</tt> or
+  #   <tt>match</tt> messages or both. The <tt>restore</tt> method should
+  #   take two parameters: `[String] name` and `[String] value`.
+  #   The <tt>restore</tt> method should reverse any transformations that
+  #   have been performed on the value to ensure a valid URI.
+  #   The <tt>match</tt> method should take a single
+  #   parameter: `[String] name`.  The <tt>match</tt> method should return
+  #   a <tt>String</tt> containing a regular expression capture group for
+  #   matching on that particular variable. The default value is `".*?"`.
+  #   The <tt>match</tt> method has no effect on multivariate operator
+  #   expansions.
+  # @return [Hash, NilClass] The <tt>Hash</tt> mapping that was extracted from the URI, or
+  #   <tt>nil</tt> if the URI didn't match the template.
+  def extract(uri, processor = T.unsafe(nil)); end
+
+  # Freeze URI, initializing instance variables.
+  #
+  # @return [Addressable::URI] The frozen URI object.
+  def freeze; end
+
+  # Returns a <tt>String</tt> representation of the Template object's state.
+  #
+  # @return [String] The Template object's state, as a <tt>String</tt>.
+  def inspect; end
+
+  # Returns an Array of variables used within the template pattern.
+  # The variables are listed in the Array in the order they appear within
+  # the pattern.  Multiple occurrences of a variable within a pattern are
+  # not represented in this Array.
+  #
+  # @return [Array] The variables present in the template's pattern.
+  def keys; end
+
+  # Extracts match data from the URI using a URI Template pattern.
+  #
+  # @example
+  #   class ExampleProcessor
+  #   def self.restore(name, value)
+  #   return value.gsub(/\+/, " ") if name == "query"
+  #   return value
+  #   end
+  #
+  #   def self.match(name)
+  #   return ".*?" if name == "first"
+  #   return ".*"
+  #   end
+  #   end
+  #
+  #   uri = Addressable::URI.parse(
+  #   "http://example.com/search/an+example+search+query/"
+  #   )
+  #   match = Addressable::Template.new(
+  #   "http://example.com/search/{query}/"
+  #   ).match(uri, ExampleProcessor)
+  #   match.variables
+  #   #=> ["query"]
+  #   match.captures
+  #   #=> ["an example search query"]
+  #
+  #   uri = Addressable::URI.parse("http://example.com/a/b/c/")
+  #   match = Addressable::Template.new(
+  #   "http://example.com/{first}/{+second}/"
+  #   ).match(uri, ExampleProcessor)
+  #   match.variables
+  #   #=> ["first", "second"]
+  #   match.captures
+  #   #=> ["a", "b/c"]
+  #
+  #   uri = Addressable::URI.parse("http://example.com/a/b/c/")
+  #   match = Addressable::Template.new(
+  #   "http://example.com/{first}{/second*}/"
+  #   ).match(uri)
+  #   match.variables
+  #   #=> ["first", "second"]
+  #   match.captures
+  #   #=> ["a", ["b", "c"]]
+  # @param uri [Addressable::URI, #to_str] The URI to extract from.
+  # @param processor [#restore, #match] A template processor object may optionally be supplied.
+  #
+  #   The object should respond to either the <tt>restore</tt> or
+  #   <tt>match</tt> messages or both. The <tt>restore</tt> method should
+  #   take two parameters: `[String] name` and `[String] value`.
+  #   The <tt>restore</tt> method should reverse any transformations that
+  #   have been performed on the value to ensure a valid URI.
+  #   The <tt>match</tt> method should take a single
+  #   parameter: `[String] name`. The <tt>match</tt> method should return
+  #   a <tt>String</tt> containing a regular expression capture group for
+  #   matching on that particular variable. The default value is `".*?"`.
+  #   The <tt>match</tt> method has no effect on multivariate operator
+  #   expansions.
+  # @return [Hash, NilClass] The <tt>Hash</tt> mapping that was extracted from the URI, or
+  #   <tt>nil</tt> if the URI didn't match the template.
+  def match(uri, processor = T.unsafe(nil)); end
+
+  # Returns the named captures of the coerced `Regexp`.
+  #
+  # @api private
+  # @return [Hash] The named captures of the `Regexp` given by {#to_regexp}.
+  def named_captures; end
+
+  # Returns an Array of variables used within the template pattern.
+  # The variables are listed in the Array in the order they appear within
+  # the pattern.  Multiple occurrences of a variable within a pattern are
+  # not represented in this Array.
+  #
+  # @return [Array] The variables present in the template's pattern.
+  def names; end
+
+  # Expands a URI template into another URI template.
+  #
+  # The object should respond to either the <tt>validate</tt> or
+  # <tt>transform</tt> messages or both. Both the <tt>validate</tt> and
+  # <tt>transform</tt> methods should take two parameters: <tt>name</tt> and
+  # <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>
+  # or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,
+  # <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt>
+  # exception will be raised if the value is invalid. The <tt>transform</tt>
+  # method should return the transformed variable value as a <tt>String</tt>.
+  # If a <tt>transform</tt> method is used, the value will not be percent
+  # encoded automatically. Unicode normalization will be performed both
+  # before and after sending the value to the transform method.
+  #
+  # @example
+  #   Addressable::Template.new(
+  #   "http://example.com/{one}/{two}/"
+  #   ).partial_expand({"one" => "1"}).pattern
+  #   #=> "http://example.com/1/{two}/"
+  #
+  #   Addressable::Template.new(
+  #   "http://example.com/{?one,two}/"
+  #   ).partial_expand({"one" => "1"}).pattern
+  #   #=> "http://example.com/?one=1{&two}/"
+  #
+  #   Addressable::Template.new(
+  #   "http://example.com/{?one,two,three}/"
+  #   ).partial_expand({"one" => "1", "three" => 3}).pattern
+  #   #=> "http://example.com/?one=1{&two}&three=3"
+  # @param mapping [Hash] The mapping that corresponds to the pattern.
+  # @param processor [#validate, #transform] An optional processor object may be supplied.
+  # @param normalize_values [Boolean] Optional flag to enable/disable unicode normalization. Default: true
+  # @return [Addressable::Template] The partially expanded URI template.
+  def partial_expand(mapping, processor = T.unsafe(nil), normalize_values = T.unsafe(nil)); end
+
+  # @return [String] The Template object's pattern.
+  def pattern; end
+
+  # Returns the source of the coerced `Regexp`.
+  #
+  # @api private
+  # @return [String] The source of the `Regexp` given by {#to_regexp}.
+  def source; end
+
+  # Coerces a template into a `Regexp` object. This regular expression will
+  # behave very similarly to the actual template, and should match the same
+  # URI values, but it cannot fully handle, for example, values that would
+  # extract to an `Array`.
+  #
+  # @return [Regexp] A regular expression which should match the template.
+  def to_regexp; end
+
+  # Returns a mapping of variables to their default values specified
+  # in the template. Variables without defaults are not returned.
+  #
+  # @return [Hash] Mapping of template variables to their defaults
+  def variable_defaults; end
+
+  # Returns an Array of variables used within the template pattern.
+  # The variables are listed in the Array in the order they appear within
+  # the pattern.  Multiple occurrences of a variable within a pattern are
+  # not represented in this Array.
+  #
+  # @return [Array] The variables present in the template's pattern.
+  def variables; end
+
+  private
+
+  # Takes a set of values, and joins them together based on the
+  # operator.
+  #
+  # @param operator [String, Nil] One of the operators from the set
+  #   (?,&,+,#,;,/,.), or nil if there wasn't one.
+  # @param return_value [Array] The set of return values (as [variable_name, value] tuples) that will
+  #   be joined together.
+  # @return [String] The transformed mapped value
+  def join_values(operator, return_value); end
+
+  # Generates a hash with string keys
+  #
+  # @param mapping [Hash] A mapping hash to normalize
+  # @return [Hash] A hash with stringified keys
+  def normalize_keys(mapping); end
+
+  # Takes a set of values, and joins them together based on the
+  # operator.
+  #
+  # @param value [Hash, Array, String] Normalizes keys and values with IDNA#unicode_normalize_kc
+  # @return [Hash, Array, String] The normalized values
+  def normalize_value(value); end
+
+  def ordered_variable_defaults; end
+
+  # Generates the <tt>Regexp</tt> that parses a template pattern.
+  #
+  # @param pattern [String] The URI template pattern.
+  # @param processor [#match] The template processor to use.
+  # @return [Array, Regexp] An array of expansion variables nad a regular expression which may be
+  #   used to parse a template pattern
+  def parse_new_template_pattern(pattern, processor = T.unsafe(nil)); end
+
+  # Generates the <tt>Regexp</tt> that parses a template pattern. Memoizes the
+  # value if template processor not set (processors may not be deterministic)
+  #
+  # @param pattern [String] The URI template pattern.
+  # @param processor [#match] The template processor to use.
+  # @return [Array, Regexp] An array of expansion variables nad a regular expression which may be
+  #   used to parse a template pattern
+  def parse_template_pattern(pattern, processor = T.unsafe(nil)); end
+
+  # Transforms a mapped value so that values can be substituted into the
+  # template.
+  #
+  # The object should respond to either the <tt>validate</tt> or
+  # <tt>transform</tt> messages or both. Both the <tt>validate</tt> and
+  # <tt>transform</tt> methods should take two parameters: <tt>name</tt> and
+  # <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>
+  # or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,
+  # <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt> exception
+  # will be raised if the value is invalid. The <tt>transform</tt> method
+  # should return the transformed variable value as a <tt>String</tt>. If a
+  # <tt>transform</tt> method is used, the value will not be percent encoded
+  # automatically. Unicode normalization will be performed both before and
+  # after sending the value to the transform method.
+  #
+  # @param mapping [Hash] The mapping to replace captures
+  # @param capture [String] The expression to replace
+  # @param processor [#validate, #transform] An optional processor object may be supplied.
+  # @param normalize_values [Boolean] Optional flag to enable/disable unicode normalization. Default: true
+  # @return [String] The expanded expression
+  def transform_capture(mapping, capture, processor = T.unsafe(nil), normalize_values = T.unsafe(nil)); end
+
+  # Loops through each capture and expands any values available in mapping
+  #
+  # The object should respond to either the <tt>validate</tt> or
+  # <tt>transform</tt> messages or both. Both the <tt>validate</tt> and
+  # <tt>transform</tt> methods should take two parameters: <tt>name</tt> and
+  # <tt>value</tt>. The <tt>validate</tt> method should return <tt>true</tt>
+  # or <tt>false</tt>; <tt>true</tt> if the value of the variable is valid,
+  # <tt>false</tt> otherwise. An <tt>InvalidTemplateValueError</tt> exception
+  # will be raised if the value is invalid. The <tt>transform</tt> method
+  # should return the transformed variable value as a <tt>String</tt>. If a
+  # <tt>transform</tt> method is used, the value will not be percent encoded
+  # automatically. Unicode normalization will be performed both before and
+  # after sending the value to the transform method.
+  #
+  # @param mapping [Hash] Set of keys to expand
+  # @param capture [String] The expression to expand
+  # @param processor [#validate, #transform] An optional processor object may be supplied.
+  # @param normalize_values [Boolean] Optional flag to enable/disable unicode normalization. Default: true
+  # @return [String] The expanded expression
+  def transform_partial_capture(mapping, capture, processor = T.unsafe(nil), normalize_values = T.unsafe(nil)); end
+end
+
+Addressable::Template::EXPRESSION = T.let(T.unsafe(nil), Regexp)
+
+# Raised if an invalid template operator is used in a pattern.
+class Addressable::Template::InvalidTemplateOperatorError < ::StandardError; end
+
+# Raised if an invalid template value is supplied.
+class Addressable::Template::InvalidTemplateValueError < ::StandardError; end
+
+Addressable::Template::JOINERS = T.let(T.unsafe(nil), Hash)
+Addressable::Template::LEADERS = T.let(T.unsafe(nil), Hash)
+
+# This class represents the data that is extracted when a Template
+# is matched against a URI.
+class Addressable::Template::MatchData
+  # Creates a new MatchData object.
+  # MatchData objects should never be instantiated directly.
+  #
+  # @param uri [Addressable::URI] The URI that the template was matched against.
+  # @return [MatchData] a new instance of MatchData
+  def initialize(uri, template, mapping); end
+
+  # Accesses captured values by name or by index.
+  #
+  # @param key [String, Symbol, Fixnum] Capture index or name. Note that when accessing by with index
+  #   of 0, the full URI will be returned. The intention is to mimic
+  #   the ::MatchData#[] behavior.
+  # @param len [#to_int, nil] If provided, an array of values will be returend with the given
+  #   parameter used as length.
+  # @return [Array, String, nil] The captured value corresponding to the index or name. If the
+  #   value was not provided or the key is unknown, nil will be
+  #   returned.
+  #
+  #   If the second parameter is provided, an array of that length will
+  #   be returned instead.
+  def [](key, len = T.unsafe(nil)); end
+
+  # @return [Array] The list of values that were captured by the Template.
+  #   Note that this list will include nils for any variables which
+  #   were in the Template, but did not appear in the URI.
+  def captures; end
+
+  # Returns a <tt>String</tt> representation of the MatchData's state.
+  #
+  # @return [String] The MatchData's state, as a <tt>String</tt>.
+  def inspect; end
+
+  # @return [Array] The list of variables that were present in the Template.
+  #   Note that this list will include variables which do not appear
+  #   in the mapping because they were not present in URI.
+  def keys; end
+
+  # @return [Hash] The mapping that resulted from the match.
+  #   Note that this mapping does not include keys or values for
+  #   variables that appear in the Template, but are not present
+  #   in the URI.
+  def mapping; end
+
+  # @return [Array] The list of variables that were present in the Template.
+  #   Note that this list will include variables which do not appear
+  #   in the mapping because they were not present in URI.
+  def names; end
+
+  # Dummy method for code expecting a ::MatchData instance
+  #
+  # @return [String] An empty string.
+  def post_match; end
+
+  # Dummy method for code expecting a ::MatchData instance
+  #
+  # @return [String] An empty string.
+  def pre_match; end
+
+  # @return [String] The matched URI as String.
+  def string; end
+
+  # @return [Addressable::Template] The Template used for the match.
+  def template; end
+
+  # @return [Array] Array with the matched URI as first element followed by the captured
+  #   values.
+  def to_a; end
+
+  # @return [String] The matched URI as String.
+  def to_s; end
+
+  # @return [Addressable::URI] The URI that the Template was matched against.
+  def uri; end
+
+  # @return [Array] The list of values that were captured by the Template.
+  #   Note that this list will include nils for any variables which
+  #   were in the Template, but did not appear in the URI.
+  def values; end
+
+  # Returns multiple captured values at once.
+  #
+  # @param *indexes [String, Symbol, Fixnum] Indices of the captures to be returned
+  # @return [Array] Values corresponding to given indices.
+  # @see Addressable::Template::MatchData#[]
+  def values_at(*indexes); end
+
+  # @return [Array] The list of variables that were present in the Template.
+  #   Note that this list will include variables which do not appear
+  #   in the mapping because they were not present in URI.
+  def variables; end
+end
+
+Addressable::Template::RESERVED = T.let(T.unsafe(nil), String)
+
+# Raised if an invalid template operator is used in a pattern.
+class Addressable::Template::TemplateOperatorAbortedError < ::StandardError; end
+
+Addressable::Template::UNRESERVED = T.let(T.unsafe(nil), String)
+Addressable::Template::VARIABLE_LIST = T.let(T.unsafe(nil), Regexp)
+Addressable::Template::VARNAME = T.let(T.unsafe(nil), Regexp)
+Addressable::Template::VARSPEC = T.let(T.unsafe(nil), Regexp)
+
+# This is an implementation of a URI parser based on
+# <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>,
+# <a href="http://www.ietf.org/rfc/rfc3987.txt">RFC 3987</a>.
+class Addressable::URI
+  # Creates a new uri object from component parts.
+  #
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @option [String,
+  # @param [String, [Hash] a customizable set of options
+  # @return [Addressable::URI] The constructed URI object.
+  def initialize(options = T.unsafe(nil)); end
+
+  # Joins two URIs together.
+  #
+  # @param The [String, Addressable::URI, #to_str] URI to join with.
+  # @return [Addressable::URI] The joined URI.
+  def +(uri); end
+
+  # Returns <code>true</code> if the URI objects are equal. This method
+  # normalizes both URIs before doing the comparison.
+  #
+  # @param uri [Object] The URI to compare.
+  # @return [TrueClass, FalseClass] <code>true</code> if the URIs are equivalent, <code>false</code>
+  #   otherwise.
+  def ==(uri); end
+
+  # Returns <code>true</code> if the URI objects are equal. This method
+  # normalizes both URIs before doing the comparison, and allows comparison
+  # against <code>Strings</code>.
+  #
+  # @param uri [Object] The URI to compare.
+  # @return [TrueClass, FalseClass] <code>true</code> if the URIs are equivalent, <code>false</code>
+  #   otherwise.
+  def ===(uri); end
+
+  # Determines if the URI is absolute.
+  #
+  # @return [TrueClass, FalseClass] <code>true</code> if the URI is absolute. <code>false</code>
+  #   otherwise.
+  def absolute?; end
+
+  # The authority component for this URI.
+  # Combines the user, password, host, and port components.
+  #
+  # @return [String] The authority component.
+  def authority; end
+
+  # Sets the authority component for this URI.
+  #
+  # @param new_authority [String, #to_str] The new authority component.
+  def authority=(new_authority); end
+
+  # The basename, if any, of the file in the path component.
+  #
+  # @return [String] The path's basename.
+  def basename; end
+
+  # The default port for this URI's scheme.
+  # This method will always returns the default port for the URI's scheme
+  # regardless of the presence of an explicit port in the URI.
+  #
+  # @return [Integer] The default port.
+  def default_port; end
+
+  # This method allows you to make several changes to a URI simultaneously,
+  # which separately would cause validation errors, but in conjunction,
+  # are valid.  The URI will be revalidated as soon as the entire block has
+  # been executed.
+  #
+  # @param block [Proc] A set of operations to perform on a given URI.
+  # @raise [LocalJumpError]
+  def defer_validation; end
+
+  # Creates a URI suitable for display to users. If semantic attacks are
+  # likely, the application should try to detect these and warn the user.
+  # See <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>,
+  # section 7.6 for more information.
+  #
+  # @return [Addressable::URI] A URI suitable for display purposes.
+  def display_uri; end
+
+  # Returns the public suffix domain for this host.
+  #
+  # @example
+  #   Addressable::URI.parse("http://www.example.co.uk").domain # => "example.co.uk"
+  def domain; end
+
+  # Clones the URI object.
+  #
+  # @return [Addressable::URI] The cloned URI.
+  def dup; end
+
+  # Determines if the URI is an empty string.
+  #
+  # @return [TrueClass, FalseClass] Returns <code>true</code> if empty, <code>false</code> otherwise.
+  def empty?; end
+
+  # Returns <code>true</code> if the URI objects are equal. This method
+  # does NOT normalize either URI before doing the comparison.
+  #
+  # @param uri [Object] The URI to compare.
+  # @return [TrueClass, FalseClass] <code>true</code> if the URIs are equivalent, <code>false</code>
+  #   otherwise.
+  def eql?(uri); end
+
+  # The extname, if any, of the file in the path component.
+  # Empty string if there is no extension.
+  #
+  # @return [String] The path's extname.
+  def extname; end
+
+  # The fragment component for this URI.
+  #
+  # @return [String] The fragment component.
+  def fragment; end
+
+  # Sets the fragment component for this URI.
+  #
+  # @param new_fragment [String, #to_str] The new fragment component.
+  def fragment=(new_fragment); end
+
+  # Freeze URI, initializing instance variables.
+  #
+  # @return [Addressable::URI] The frozen URI object.
+  def freeze; end
+
+  # A hash value that will make a URI equivalent to its normalized
+  # form.
+  #
+  # @return [Integer] A hash of the URI.
+  def hash; end
+
+  # The host component for this URI.
+  #
+  # @return [String] The host component.
+  def host; end
+
+  # Sets the host component for this URI.
+  #
+  # @param new_host [String, #to_str] The new host component.
+  def host=(new_host); end
+
+  # This method is same as URI::Generic#host except
+  # brackets for IPv6 (and 'IPvFuture') addresses are removed.
+  #
+  # @return [String] The hostname for this URI.
+  # @see Addressable::URI#host
+  def hostname; end
+
+  # This method is same as URI::Generic#host= except
+  # the argument can be a bare IPv6 address (or 'IPvFuture').
+  #
+  # @param new_hostname [String, #to_str] The new hostname for this URI.
+  # @see Addressable::URI#host=
+  def hostname=(new_hostname); end
+
+  # The inferred port component for this URI.
+  # This method will normalize to the default port for the URI's scheme if
+  # the port isn't explicitly specified in the URI.
+  #
+  # @return [Integer] The inferred port component.
+  def inferred_port; end
+
+  # Returns a <code>String</code> representation of the URI object's state.
+  #
+  # @return [String] The URI object's state, as a <code>String</code>.
+  def inspect; end
+
+  # Determines if the scheme indicates an IP-based protocol.
+  #
+  # @return [TrueClass, FalseClass] <code>true</code> if the scheme indicates an IP-based protocol.
+  #   <code>false</code> otherwise.
+  def ip_based?; end
+
+  # Joins two URIs together.
+  #
+  # @param The [String, Addressable::URI, #to_str] URI to join with.
+  # @return [Addressable::URI] The joined URI.
+  def join(uri); end
+
+  # Destructive form of <code>join</code>.
+  #
+  # @param The [String, Addressable::URI, #to_str] URI to join with.
+  # @return [Addressable::URI] The joined URI.
+  # @see Addressable::URI#join
+  def join!(uri); end
+
+  # Merges a URI with a <code>Hash</code> of components.
+  # This method has different behavior from <code>join</code>. Any
+  # components present in the <code>hash</code> parameter will override the
+  # original components. The path component is not treated specially.
+  #
+  # @param The [Hash, Addressable::URI, #to_hash] components to merge with.
+  # @return [Addressable::URI] The merged URI.
+  # @see Hash#merge
+  def merge(hash); end
+
+  # Destructive form of <code>merge</code>.
+  #
+  # @param The [Hash, Addressable::URI, #to_hash] components to merge with.
+  # @return [Addressable::URI] The merged URI.
+  # @see Addressable::URI#merge
+  def merge!(uri); end
+
+  # Returns a normalized URI object.
+  #
+  # NOTE: This method does not attempt to fully conform to specifications.
+  # It exists largely to correct other people's failures to read the
+  # specifications, and also to deal with caching issues since several
+  # different URIs may represent the same resource and should not be
+  # cached multiple times.
+  #
+  # @return [Addressable::URI] The normalized URI.
+  def normalize; end
+
+  # Destructively normalizes this URI object.
+  #
+  # @return [Addressable::URI] The normalized URI.
+  # @see Addressable::URI#normalize
+  def normalize!; end
+
+  # The authority component for this URI, normalized.
+  #
+  # @return [String] The authority component, normalized.
+  def normalized_authority; end
+
+  # The fragment component for this URI, normalized.
+  #
+  # @return [String] The fragment component, normalized.
+  def normalized_fragment; end
+
+  # The host component for this URI, normalized.
+  #
+  # @return [String] The host component, normalized.
+  def normalized_host; end
+
+  # The password component for this URI, normalized.
+  #
+  # @return [String] The password component, normalized.
+  def normalized_password; end
+
+  # The path component for this URI, normalized.
+  #
+  # @return [String] The path component, normalized.
+  def normalized_path; end
+
+  # The port component for this URI, normalized.
+  #
+  # @return [Integer] The port component, normalized.
+  def normalized_port; end
+
+  # The query component for this URI, normalized.
+  #
+  # @return [String] The query component, normalized.
+  def normalized_query(*flags); end
+
+  # The scheme component for this URI, normalized.
+  #
+  # @return [String] The scheme component, normalized.
+  def normalized_scheme; end
+
+  # The normalized combination of components that represent a site.
+  # Combines the scheme, user, password, host, and port components.
+  # Primarily useful for HTTP and HTTPS.
+  #
+  # For example, <code>"http://example.com/path?query"</code> would have a
+  # <code>site</code> value of <code>"http://example.com"</code>.
+  #
+  # @return [String] The normalized components that identify a site.
+  def normalized_site; end
+
+  # The user component for this URI, normalized.
+  #
+  # @return [String] The user component, normalized.
+  def normalized_user; end
+
+  # The userinfo component for this URI, normalized.
+  #
+  # @return [String] The userinfo component, normalized.
+  def normalized_userinfo; end
+
+  # Omits components from a URI.
+  #
+  # @example
+  #   uri = Addressable::URI.parse("http://example.com/path?query")
+  #   #=> #<Addressable::URI:0xcc5e7a URI:http://example.com/path?query>
+  #   uri.omit(:scheme, :authority)
+  #   #=> #<Addressable::URI:0xcc4d86 URI:/path?query>
+  # @param *components [Symbol] The components to be omitted.
+  # @return [Addressable::URI] The URI with components omitted.
+  def omit(*components); end
+
+  # Destructive form of omit.
+  #
+  # @param *components [Symbol] The components to be omitted.
+  # @return [Addressable::URI] The URI with components omitted.
+  # @see Addressable::URI#omit
+  def omit!(*components); end
+
+  # The origin for this URI, serialized to ASCII, as per
+  # RFC 6454, section 6.2.
+  #
+  # @return [String] The serialized origin.
+  def origin; end
+
+  # Sets the origin for this URI, serialized to ASCII, as per
+  # RFC 6454, section 6.2. This assignment will reset the `userinfo`
+  # component.
+  #
+  # @param new_origin [String, #to_str] The new origin component.
+  def origin=(new_origin); end
+
+  # The password component for this URI.
+  #
+  # @return [String] The password component.
+  def password; end
+
+  # Sets the password component for this URI.
+  #
+  # @param new_password [String, #to_str] The new password component.
+  def password=(new_password); end
+
+  # The path component for this URI.
+  #
+  # @return [String] The path component.
+  def path; end
+
+  # Sets the path component for this URI.
+  #
+  # @param new_path [String, #to_str] The new path component.
+  def path=(new_path); end
+
+  # The port component for this URI.
+  # This is the port number actually given in the URI. This does not
+  # infer port numbers from default values.
+  #
+  # @return [Integer] The port component.
+  def port; end
+
+  # Sets the port component for this URI.
+  #
+  # @param new_port [String, Integer, #to_s] The new port component.
+  def port=(new_port); end
+
+  # The query component for this URI.
+  #
+  # @return [String] The query component.
+  def query; end
+
+  # Sets the query component for this URI.
+  #
+  # @param new_query [String, #to_str] The new query component.
+  def query=(new_query); end
+
+  # Converts the query component to a Hash value.
+  #
+  # @example
+  #   Addressable::URI.parse("?one=1&two=2&three=3").query_values
+  #   #=> {"one" => "1", "two" => "2", "three" => "3"}
+  #   Addressable::URI.parse("?one=two&one=three").query_values(Array)
+  #   #=> [["one", "two"], ["one", "three"]]
+  #   Addressable::URI.parse("?one=two&one=three").query_values(Hash)
+  #   #=> {"one" => "three"}
+  #   Addressable::URI.parse("?").query_values
+  #   #=> {}
+  #   Addressable::URI.parse("").query_values
+  #   #=> nil
+  # @param return_type [Class] The return type desired. Value must be either
+  #   `Hash` or `Array`.
+  # @return [Hash, Array, nil] The query string parsed as a Hash or Array
+  #   or nil if the query string is blank.
+  def query_values(return_type = T.unsafe(nil)); end
+
+  # Sets the query component for this URI from a Hash object.
+  # An empty Hash or Array will result in an empty query string.
+  #
+  # @example
+  #   uri.query_values = {:a => "a", :b => ["c", "d", "e"]}
+  #   uri.query
+  #   # => "a=a&b=c&b=d&b=e"
+  #   uri.query_values = [['a', 'a'], ['b', 'c'], ['b', 'd'], ['b', 'e']]
+  #   uri.query
+  #   # => "a=a&b=c&b=d&b=e"
+  #   uri.query_values = [['a', 'a'], ['b', ['c', 'd', 'e']]]
+  #   uri.query
+  #   # => "a=a&b=c&b=d&b=e"
+  #   uri.query_values = [['flag'], ['key', 'value']]
+  #   uri.query
+  #   # => "flag&key=value"
+  # @param new_query_values [Hash, #to_hash, Array] The new query values.
+  def query_values=(new_query_values); end
+
+  # Determines if the URI is relative.
+  #
+  # @return [TrueClass, FalseClass] <code>true</code> if the URI is relative. <code>false</code>
+  #   otherwise.
+  def relative?; end
+
+  # The HTTP request URI for this URI.  This is the path and the
+  # query string.
+  #
+  # @return [String] The request URI required for an HTTP request.
+  def request_uri; end
+
+  # Sets the HTTP request URI for this URI.
+  #
+  # @param new_request_uri [String, #to_str] The new HTTP request URI.
+  def request_uri=(new_request_uri); end
+
+  # Returns the shortest normalized relative form of this URI that uses the
+  # supplied URI as a base for resolution. Returns an absolute URI if
+  # necessary. This is effectively the opposite of <code>route_to</code>.
+  #
+  # @param uri [String, Addressable::URI, #to_str] The URI to route from.
+  # @return [Addressable::URI] The normalized relative URI that is equivalent to the original URI.
+  def route_from(uri); end
+
+  # Returns the shortest normalized relative form of the supplied URI that
+  # uses this URI as a base for resolution. Returns an absolute URI if
+  # necessary. This is effectively the opposite of <code>route_from</code>.
+  #
+  # @param uri [String, Addressable::URI, #to_str] The URI to route to.
+  # @return [Addressable::URI] The normalized relative URI that is equivalent to the supplied URI.
+  def route_to(uri); end
+
+  # The scheme component for this URI.
+  #
+  # @return [String] The scheme component.
+  def scheme; end
+
+  # Sets the scheme component for this URI.
+  #
+  # @param new_scheme [String, #to_str] The new scheme component.
+  def scheme=(new_scheme); end
+
+  # The combination of components that represent a site.
+  # Combines the scheme, user, password, host, and port components.
+  # Primarily useful for HTTP and HTTPS.
+  #
+  # For example, <code>"http://example.com/path?query"</code> would have a
+  # <code>site</code> value of <code>"http://example.com"</code>.
+  #
+  # @return [String] The components that identify a site.
+  def site; end
+
+  # Sets the site value for this URI.
+  #
+  # @param new_site [String, #to_str] The new site value.
+  def site=(new_site); end
+
+  # Returns the top-level domain for this host.
+  #
+  # @example
+  #   Addressable::URI.parse("http://www.example.co.uk").tld # => "co.uk"
+  def tld; end
+
+  # Sets the top-level domain for this URI.
+  #
+  # @param new_tld [String, #to_str] The new top-level domain.
+  def tld=(new_tld); end
+
+  # Returns a Hash of the URI components.
+  #
+  # @return [Hash] The URI as a <code>Hash</code> of components.
+  def to_hash; end
+
+  # Converts the URI to a <code>String</code>.
+  #
+  # @return [String] The URI's <code>String</code> representation.
+  def to_s; end
+
+  # Converts the URI to a <code>String</code>.
+  # URI's are glorified <code>Strings</code>. Allow implicit conversion.
+  #
+  # @return [String] The URI's <code>String</code> representation.
+  def to_str; end
+
+  # The user component for this URI.
+  #
+  # @return [String] The user component.
+  def user; end
+
+  # Sets the user component for this URI.
+  #
+  # @param new_user [String, #to_str] The new user component.
+  def user=(new_user); end
+
+  # The userinfo component for this URI.
+  # Combines the user and password components.
+  #
+  # @return [String] The userinfo component.
+  def userinfo; end
+
+  # Sets the userinfo component for this URI.
+  #
+  # @param new_userinfo [String, #to_str] The new userinfo component.
+  def userinfo=(new_userinfo); end
+
+  protected
+
+  # Converts the string to be UTF-8 if it is not already UTF-8
+  #
+  # @api private
+  def force_utf8_encoding_if_needed(str); end
+
+  # Resets composite values for the entire URI
+  #
+  # @api private
+  def remove_composite_values; end
+
+  # Replaces the internal state of self with the specified URI's state.
+  # Used in destructive operations to avoid massive code repetition.
+  #
+  # @param uri [Addressable::URI] The URI to replace <code>self</code> with.
+  # @return [Addressable::URI] <code>self</code>.
+  def replace_self(uri); end
+
+  # Splits path string with "/" (slash).
+  # It is considered that there is empty string after last slash when
+  # path ends with slash.
+  #
+  # @param path [String] The path to split.
+  # @return [Array<String>] An array of parts of path.
+  def split_path(path); end
+
+  # Ensures that the URI is valid.
+  def validate; end
+
+  class << self
+    # Converts a path to a file scheme URI. If the path supplied is
+    # relative, it will be returned as a relative URI. If the path supplied
+    # is actually a non-file URI, it will parse the URI as if it had been
+    # parsed with <code>Addressable::URI.parse</code>. Handles all of the
+    # various Microsoft-specific formats for specifying paths.
+    #
+    # @example
+    #   base = Addressable::URI.convert_path("/absolute/path/")
+    #   uri = Addressable::URI.convert_path("relative/path")
+    #   (base + uri).to_s
+    #   #=> "file:///absolute/path/relative/path"
+    #
+    #   Addressable::URI.convert_path(
+    #   "c:\\windows\\My Documents 100%20\\foo.txt"
+    #   ).to_s
+    #   #=> "file:///c:/windows/My%20Documents%20100%20/foo.txt"
+    #
+    #   Addressable::URI.convert_path("http://example.com/").to_s
+    #   #=> "http://example.com/"
+    # @param path [String, Addressable::URI, #to_str] Typically a <code>String</code> path to a file or directory, but
+    #   will return a sensible return value if an absolute URI is supplied
+    #   instead.
+    # @return [Addressable::URI] The parsed file scheme URI or the original URI if some other URI
+    #   scheme was provided.
+    def convert_path(path); end
+
+    # Percent encodes any special characters in the URI.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI to encode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @return [String, Addressable::URI] The encoded URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def encode(uri, return_type = T.unsafe(nil)); end
+
+    # Percent encodes a URI component.
+    #
+    #  '9' to be percent encoded. If a <code>Regexp</code> is passed, the
+    #   value <code>/[^b-zB-Z0-9]/</code> would have the same effect. A set of
+    #   useful <code>String</code> values may be found in the
+    #   <code>Addressable::URI::CharacterClasses</code> module. The default
+    #   value is the reserved plus unreserved character classes specified in
+    #   <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
+    #
+    # @example
+    #   Addressable::URI.encode_component("simple/example", "b-zB-Z0-9")
+    #   => "simple%2Fex%61mple"
+    #   Addressable::URI.encode_component("simple/example", /[^b-zB-Z0-9]/)
+    #   => "simple%2Fex%61mple"
+    #   Addressable::URI.encode_component(
+    #   "simple/example", Addressable::URI::CharacterClasses::UNRESERVED
+    #   )
+    #   => "simple%2Fexample"
+    # @param component [String, #to_str] The URI component to encode.
+    # @param character_class [String, Regexp] The characters which are not percent encoded. If a <code>String</code>
+    #   is passed, the <code>String</code> must be formatted as a regular
+    #   expression character class. (Do not include the surrounding square
+    #   brackets.)  For example, <code>"b-zB-Z0-9"</code> would cause
+    #   everything but the letters 'b' through 'z' and the numbers '0' through
+    # @param upcase_encoded [Regexp] A string of characters that may already be percent encoded, and whose
+    #   encodings should be upcased. This allows normalization of percent
+    #   encodings for characters not included in the
+    #   <code>character_class</code>.
+    # @return [String] The encoded component.
+    def encode_component(component, character_class = T.unsafe(nil), upcase_encoded = T.unsafe(nil)); end
+
+    # Percent encodes any special characters in the URI.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI to encode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @return [String, Addressable::URI] The encoded URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def escape(uri, return_type = T.unsafe(nil)); end
+
+    # Percent encodes a URI component.
+    #
+    #  '9' to be percent encoded. If a <code>Regexp</code> is passed, the
+    #   value <code>/[^b-zB-Z0-9]/</code> would have the same effect. A set of
+    #   useful <code>String</code> values may be found in the
+    #   <code>Addressable::URI::CharacterClasses</code> module. The default
+    #   value is the reserved plus unreserved character classes specified in
+    #   <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
+    #
+    # @example
+    #   Addressable::URI.encode_component("simple/example", "b-zB-Z0-9")
+    #   => "simple%2Fex%61mple"
+    #   Addressable::URI.encode_component("simple/example", /[^b-zB-Z0-9]/)
+    #   => "simple%2Fex%61mple"
+    #   Addressable::URI.encode_component(
+    #   "simple/example", Addressable::URI::CharacterClasses::UNRESERVED
+    #   )
+    #   => "simple%2Fexample"
+    # @param component [String, #to_str] The URI component to encode.
+    # @param character_class [String, Regexp] The characters which are not percent encoded. If a <code>String</code>
+    #   is passed, the <code>String</code> must be formatted as a regular
+    #   expression character class. (Do not include the surrounding square
+    #   brackets.)  For example, <code>"b-zB-Z0-9"</code> would cause
+    #   everything but the letters 'b' through 'z' and the numbers '0' through
+    # @param upcase_encoded [Regexp] A string of characters that may already be percent encoded, and whose
+    #   encodings should be upcased. This allows normalization of percent
+    #   encodings for characters not included in the
+    #   <code>character_class</code>.
+    # @return [String] The encoded component.
+    def escape_component(component, character_class = T.unsafe(nil), upcase_encoded = T.unsafe(nil)); end
+
+    # Encodes a set of key/value pairs according to the rules for the
+    # <code>application/x-www-form-urlencoded</code> MIME type.
+    #
+    # @param form_values [#to_hash, #to_ary] The form values to encode.
+    # @param sort [TrueClass, FalseClass] Sort the key/value pairs prior to encoding.
+    #   Defaults to <code>false</code>.
+    # @return [String] The encoded value.
+    def form_encode(form_values, sort = T.unsafe(nil)); end
+
+    # Decodes a <code>String</code> according to the rules for the
+    # <code>application/x-www-form-urlencoded</code> MIME type.
+    #
+    # @param encoded_value [String, #to_str] The form values to decode.
+    # @return [Array] The decoded values.
+    #   This is not a <code>Hash</code> because of the possibility for
+    #   duplicate keys.
+    def form_unencode(encoded_value); end
+
+    # Converts an input to a URI. The input does not have to be a valid
+    # URI — the method will use heuristics to guess what URI was intended.
+    # This is not standards-compliant, merely user-friendly.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI string to parse.
+    #   No parsing is performed if the object is already an
+    #   <code>Addressable::URI</code>.
+    # @param hints [Hash] A <code>Hash</code> of hints to the heuristic parser.
+    #   Defaults to <code>{:scheme => "http"}</code>.
+    # @return [Addressable::URI] The parsed URI.
+    def heuristic_parse(uri, hints = T.unsafe(nil)); end
+
+    # Returns an array of known ip-based schemes. These schemes typically
+    # use a similar URI form:
+    # <code>//<user>:<password>@<host>:<port>/<url-path></code>
+    def ip_based_schemes; end
+
+    # Joins several URIs together.
+    #
+    # @example
+    #   base = "http://example.com/"
+    #   uri = Addressable::URI.parse("relative/path")
+    #   Addressable::URI.join(base, uri)
+    #   #=> #<Addressable::URI:0xcab390 URI:http://example.com/relative/path>
+    # @param *uris [String, Addressable::URI, #to_str] The URIs to join.
+    # @return [Addressable::URI] The joined URI.
+    def join(*uris); end
+
+    # Normalizes the encoding of a URI component.
+    #
+    # @example
+    #   Addressable::URI.normalize_component("simpl%65/%65xampl%65", "b-zB-Z")
+    #   => "simple%2Fex%61mple"
+    #   Addressable::URI.normalize_component(
+    #   "simpl%65/%65xampl%65", /[^b-zB-Z]/
+    #   )
+    #   => "simple%2Fex%61mple"
+    #   Addressable::URI.normalize_component(
+    #   "simpl%65/%65xampl%65",
+    #   Addressable::URI::CharacterClasses::UNRESERVED
+    #   )
+    #   => "simple%2Fexample"
+    #   Addressable::URI.normalize_component(
+    #   "one%20two%2fthree%26four",
+    #   "0-9a-zA-Z &/",
+    #   "/"
+    #   )
+    #   => "one two%2Fthree&four"
+    # @param component [String, #to_str] The URI component to encode.
+    # @param character_class [String, Regexp] The characters which are not percent encoded. If a <code>String</code>
+    #   is passed, the <code>String</code> must be formatted as a regular
+    #   expression character class. (Do not include the surrounding square
+    #   brackets.)  For example, <code>"b-zB-Z0-9"</code> would cause
+    #   everything but the letters 'b' through 'z' and the numbers '0'
+    #   through '9' to be percent encoded. If a <code>Regexp</code> is passed,
+    #   the value <code>/[^b-zB-Z0-9]/</code> would have the same effect. A
+    #   set of useful <code>String</code> values may be found in the
+    #   <code>Addressable::URI::CharacterClasses</code> module. The default
+    #   value is the reserved plus unreserved character classes specified in
+    #   <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
+    # @param leave_encoded [String] When <code>character_class</code> is a <code>String</code> then
+    #   <code>leave_encoded</code> is a string of characters that should remain
+    #   percent encoded while normalizing the component; if they appear percent
+    #   encoded in the original component, then they will be upcased ("%2f"
+    #   normalized to "%2F") but otherwise left alone.
+    # @return [String] The normalized component.
+    def normalize_component(component, character_class = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end
+
+    # Resolves paths to their simplest form.
+    #
+    # @param path [String] The path to normalize.
+    # @return [String] The normalized path.
+    def normalize_path(path); end
+
+    # Normalizes the encoding of a URI. Characters within a hostname are
+    # not percent encoded to allow for internationalized domain names.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI to encode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @return [String, Addressable::URI] The encoded URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def normalized_encode(uri, return_type = T.unsafe(nil)); end
+
+    # Returns a URI object based on the parsed string.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI string to parse.
+    #   No parsing is performed if the object is already an
+    #   <code>Addressable::URI</code>.
+    # @return [Addressable::URI] The parsed URI.
+    def parse(uri); end
+
+    # Returns a hash of common IP-based schemes and their default port
+    # numbers. Adding new schemes to this hash, as necessary, will allow
+    # for better URI normalization.
+    def port_mapping; end
+
+    # Unencodes any percent encoded characters within a URI component.
+    # This method may be used for unencoding either components or full URIs,
+    # however, it is recommended to use the <code>unencode_component</code>
+    # alias when unencoding components.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI or component to unencode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @param leave_encoded [String] A string of characters to leave encoded. If a percent encoded character
+    #   in this list is encountered then it will remain percent encoded.
+    # @return [String, Addressable::URI] The unencoded component or URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def unencode(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end
+
+    # Unencodes any percent encoded characters within a URI component.
+    # This method may be used for unencoding either components or full URIs,
+    # however, it is recommended to use the <code>unencode_component</code>
+    # alias when unencoding components.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI or component to unencode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @param leave_encoded [String] A string of characters to leave encoded. If a percent encoded character
+    #   in this list is encountered then it will remain percent encoded.
+    # @return [String, Addressable::URI] The unencoded component or URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def unencode_component(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end
+
+    # Unencodes any percent encoded characters within a URI component.
+    # This method may be used for unencoding either components or full URIs,
+    # however, it is recommended to use the <code>unencode_component</code>
+    # alias when unencoding components.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI or component to unencode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @param leave_encoded [String] A string of characters to leave encoded. If a percent encoded character
+    #   in this list is encountered then it will remain percent encoded.
+    # @return [String, Addressable::URI] The unencoded component or URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def unescape(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end
+
+    # Unencodes any percent encoded characters within a URI component.
+    # This method may be used for unencoding either components or full URIs,
+    # however, it is recommended to use the <code>unencode_component</code>
+    # alias when unencoding components.
+    #
+    # @param uri [String, Addressable::URI, #to_str] The URI or component to unencode.
+    # @param return_type [Class] The type of object to return.
+    #   This value may only be set to <code>String</code> or
+    #   <code>Addressable::URI</code>. All other values are invalid. Defaults
+    #   to <code>String</code>.
+    # @param leave_encoded [String] A string of characters to leave encoded. If a percent encoded character
+    #   in this list is encountered then it will remain percent encoded.
+    # @return [String, Addressable::URI] The unencoded component or URI.
+    #   The return type is determined by the <code>return_type</code>
+    #   parameter.
+    def unescape_component(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end
+  end
+end
+
+# Container for the character classes specified in
+# <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.
+#
+# Note: Concatenated and interpolated `String`s are not affected by the
+#       `frozen_string_literal` directive and must be frozen explicitly.
+#
+#       Interpolated `String`s *were* frozen this way before Ruby 3.0:
+#       https://bugs.ruby-lang.org/issues/17104
+module Addressable::URI::CharacterClasses; end
+
+Addressable::URI::CharacterClasses::ALPHA = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::AUTHORITY = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::DIGIT = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::FRAGMENT = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::GEN_DELIMS = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::HOST = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::PATH = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::PCHAR = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::QUERY = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::RESERVED = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::SCHEME = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::SUB_DELIMS = T.let(T.unsafe(nil), String)
+Addressable::URI::CharacterClasses::UNRESERVED = T.let(T.unsafe(nil), String)
+Addressable::URI::EMPTY_STR = T.let(T.unsafe(nil), String)
+
+# Raised if something other than a uri is supplied.
+class Addressable::URI::InvalidURIError < ::StandardError; end
+
+Addressable::URI::NORMPATH = T.let(T.unsafe(nil), Regexp)
+module Addressable::URI::NormalizeCharacterClasses; end
+Addressable::URI::NormalizeCharacterClasses::FRAGMENT = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::NormalizeCharacterClasses::HOST = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::NormalizeCharacterClasses::PCHAR = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::NormalizeCharacterClasses::QUERY = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::NormalizeCharacterClasses::SCHEME = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::NormalizeCharacterClasses::UNRESERVED = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::PARENT = T.let(T.unsafe(nil), String)
+Addressable::URI::PORT_MAPPING = T.let(T.unsafe(nil), Hash)
+Addressable::URI::RULE_2A = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::RULE_2B_2C = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::RULE_2D = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::RULE_PREFIXED_PARENT = T.let(T.unsafe(nil), Regexp)
+Addressable::URI::SELF_REF = T.let(T.unsafe(nil), String)
+
+# Tables used to optimize encoding operations in `self.encode_component`
+# and `self.normalize_component`
+Addressable::URI::SEQUENCE_ENCODING_TABLE = T.let(T.unsafe(nil), Hash)
+
+Addressable::URI::SEQUENCE_UPCASED_PERCENT_ENCODING_TABLE = T.let(T.unsafe(nil), Hash)
+Addressable::URI::SLASH = T.let(T.unsafe(nil), String)
+Addressable::URI::URIREGEX = T.let(T.unsafe(nil), Regexp)
+module Addressable::VERSION; end
+Addressable::VERSION::MAJOR = T.let(T.unsafe(nil), Integer)
+Addressable::VERSION::MINOR = T.let(T.unsafe(nil), Integer)
+Addressable::VERSION::STRING = T.let(T.unsafe(nil), String)
+Addressable::VERSION::TINY = T.let(T.unsafe(nil), Integer)