module Bundler::URI

Decodes URL-encoded form data from given str.

This decodes application/x-www-form-urlencoded data and returns an array of key-value arrays.

This refers url.spec.whatwg.org/#concept-urlencoded-parser, so this supports only &-separator, and doesn’t support ;-separator.

ary = Bundler::URI.decode_www_form("a=1&a=2&b=3")
ary                   #=> [['a', '1'], ['a', '2'], ['b', '3']]
ary.assoc('a').last   #=> '1'
ary.assoc('b').last   #=> '3'
ary.rassoc('a').last  #=> '2'
Hash[ary]             #=> {"a"=>"2", "b"=>"3"}

See Bundler::URI.decode_www_form_component, Bundler::URI.encode_www_form.

# File bundler/vendor/uri/lib/uri/common.rb, line 391
def self.decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
  raise ArgumentError, "the input of #{self.name}.#{__method__} must be ASCII only string" unless str.ascii_only?
  ary = []
  return ary if str.empty?
  enc = Encoding.find(enc)
  str.b.each_line(separator) do |string|
    string.chomp!(separator)
    key, sep, val = string.partition('=')
    if isindex
      if sep.empty?
        val = key
        key = +''
      end
      isindex = false
    end

    if use__charset_ and key == '_charset_' and e = get_encoding(val)
      enc = e
      use__charset_ = false
    end

    key.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_)
    if val
      val.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_)
    else
      val = +''
    end

    ary << [key, val]
  end
  ary.each do |k, v|
    k.force_encoding(enc)
    k.scrub!
    v.force_encoding(enc)
    v.scrub!
  end
  ary
end

Decodes given str of URL-encoded form data.

This decodes + to SP.

See Bundler::URI.encode_www_form_component, Bundler::URI.decode_www_form.

# File bundler/vendor/uri/lib/uri/common.rb, line 323
def self.decode_www_form_component(str, enc=Encoding::UTF_8)
  raise ArgumentError, "invalid %-encoding (#{str})" if /%(?!\h\h)/ =~ str
  str.b.gsub(/\+|%\h\h/, TBLDECWWWCOMP_).force_encoding(enc)
end

Generates URL-encoded form data from given enum.

This generates application/x-www-form-urlencoded data defined in HTML5 from given an Enumerable object.

This internally uses Bundler::URI.encode_www_form_component(str).

This method doesn’t convert the encoding of given items, so convert them before calling this method if you want to send data as other than original encoding or mixed encoding data. (Strings which are encoded in an HTML5 ASCII incompatible encoding are converted to UTF-8.)

This method doesn’t handle files. When you send a file, use multipart/form-data.

This refers url.spec.whatwg.org/#concept-urlencoded-serializer

Bundler::URI.encode_www_form([["q", "ruby"], ["lang", "en"]])
#=> "q=ruby&lang=en"
Bundler::URI.encode_www_form("q" => "ruby", "lang" => "en")
#=> "q=ruby&lang=en"
Bundler::URI.encode_www_form("q" => ["ruby", "perl"], "lang" => "en")
#=> "q=ruby&q=perl&lang=en"
Bundler::URI.encode_www_form([["q", "ruby"], ["q", "perl"], ["lang", "en"]])
#=> "q=ruby&q=perl&lang=en"

See Bundler::URI.encode_www_form_component, Bundler::URI.decode_www_form.

# File bundler/vendor/uri/lib/uri/common.rb, line 355
def self.encode_www_form(enum, enc=nil)
  enum.map do |k,v|
    if v.nil?
      encode_www_form_component(k, enc)
    elsif v.respond_to?(:to_ary)
      v.to_ary.map do |w|
        str = encode_www_form_component(k, enc)
        unless w.nil?
          str << '='
          str << encode_www_form_component(w, enc)
        end
      end.join('&')
    else
      str = encode_www_form_component(k, enc)
      str << '='
      str << encode_www_form_component(v, enc)
    end
  end.join('&')
end

Encodes given str to URL-encoded form data.

This method doesn’t convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP (ASCII space) to + and converts others to %XX.

If enc is given, convert str to the encoding before percent encoding.

This is an implementation of www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data.

See Bundler::URI.decode_www_form_component, Bundler::URI.encode_www_form.

# File bundler/vendor/uri/lib/uri/common.rb, line 305
def self.encode_www_form_component(str, enc=nil)
  str = str.to_s.dup
  if str.encoding != Encoding::ASCII_8BIT
    if enc && enc != Encoding::ASCII_8BIT
      str.encode!(Encoding::UTF_8, invalid: :replace, undef: :replace)
      str.encode!(enc, fallback: ->(x){"&##{x.ord};"})
    end
    str.force_encoding(Encoding::ASCII_8BIT)
  end
  str.gsub!(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_)
  str.force_encoding(Encoding::US_ASCII)
end

Synopsis¶ ↑

Bundler::URI::extract(str[, schemes][,&blk])

Args¶ ↑

str

String to extract URIs from.

schemes

Limit Bundler::URI matching to specific schemes.

Description¶ ↑

Extracts URIs from a string. If block given, iterates through all matched URIs. Returns nil if block given or array with matches.

Usage¶ ↑

require "bundler/vendor/uri/lib/uri"

Bundler::URI.extract("text here http://foo.example.org/bla and here mailto:test@example.com and here also.")
# => ["http://foo.example.com/bla", "mailto:test@example.com"]

# File bundler/vendor/uri/lib/uri/common.rb, line 235
def self.extract(str, schemes = nil, &block)
  warn "Bundler::URI.extract is obsolete", uplevel: 1 if $VERBOSE
  DEFAULT_PARSER.extract(str, schemes, &block)
end

Construct a Bundler::URI instance, using the scheme to detect the appropriate class from Bundler::URI.scheme_list.

# File bundler/vendor/uri/lib/uri/common.rb, line 75
def self.for(scheme, *arguments, default: Generic)
  if scheme
    uri_class = @@schemes[scheme.upcase] || default
  else
    uri_class = default
  end

  return uri_class.new(scheme, *arguments)
end

Synopsis¶ ↑

Bundler::URI::join(str[, str, ...])

Args¶ ↑

str

String(s) to work with, will be converted to RFC3986 URIs before merging.

Description¶ ↑

Joins URIs.

Usage¶ ↑

require 'bundler/vendor/uri/lib/uri'

Bundler::URI.join("http://example.com/","main.rbx")
# => #<Bundler::URI::HTTP http://example.com/main.rbx>

Bundler::URI.join('http://example.com', 'foo')
# => #<Bundler::URI::HTTP http://example.com/foo>

Bundler::URI.join('http://example.com', '/foo', '/bar')
# => #<Bundler::URI::HTTP http://example.com/bar>

Bundler::URI.join('http://example.com', '/foo', 'bar')
# => #<Bundler::URI::HTTP http://example.com/bar>

Bundler::URI.join('http://example.com', '/foo/', 'bar')
# => #<Bundler::URI::HTTP http://example.com/foo/bar>

# File bundler/vendor/uri/lib/uri/common.rb, line 207
def self.join(*str)
  RFC3986_PARSER.join(*str)
end

Synopsis¶ ↑

Bundler::URI::parse(uri_str)

Args¶ ↑

uri_str

String with Bundler::URI.

Description¶ ↑

Creates one of the Bundler::URI‘s subclasses instance from the string.

Raises¶ ↑

Bundler::URI::InvalidURIError

Raised if Bundler::URI given is not a correct one.

Usage¶ ↑

require 'bundler/vendor/uri/lib/uri'

uri = Bundler::URI.parse("http://www.ruby-lang.org/")
# => #<Bundler::URI::HTTP http://www.ruby-lang.org/>
uri.scheme
# => "http"
uri.host
# => "www.ruby-lang.org"

It’s recommended to first ::escape the provided uri_str if there are any invalid Bundler::URI characters.

# File bundler/vendor/uri/lib/uri/common.rb, line 170
def self.parse(uri)
  RFC3986_PARSER.parse(uri)
end

Synopsis¶ ↑

Bundler::URI::regexp([match_schemes])

Args¶ ↑

match_schemes

Array of schemes. If given, resulting regexp matches to URIs whose scheme is one of the match_schemes.

Description¶ ↑

Returns a Regexp object which matches to Bundler::URI-like strings. The Regexp object returned by this method includes arbitrary number of capture group (parentheses). Never rely on its number.

Usage¶ ↑

require 'bundler/vendor/uri/lib/uri'

# extract first Bundler::URI from html_string
html_string.slice(Bundler::URI.regexp)

# remove ftp URIs
html_string.sub(Bundler::URI.regexp(['ftp']), '')

# You should not rely on the number of parentheses
html_string.scan(Bundler::URI.regexp) do |*matches|
  p $&
end

# File bundler/vendor/uri/lib/uri/common.rb, line 272
def self.regexp(schemes = nil)
  warn "Bundler::URI.regexp is obsolete", uplevel: 1 if $VERBOSE
  DEFAULT_PARSER.make_regexp(schemes)
end

Returns a Hash of the defined schemes.

# File bundler/vendor/uri/lib/uri/common.rb, line 67
def self.scheme_list
  @@schemes
end

Synopsis¶ ↑

Bundler::URI::split(uri)

Args¶ ↑

uri

String with Bundler::URI.

Description¶ ↑

Splits the string on following parts and returns array with result:

• Scheme

• Userinfo

• Host

• Port

• Registry

• Path

• Opaque

• Query

• Fragment

Usage¶ ↑

require 'bundler/vendor/uri/lib/uri'

Bundler::URI.split("http://www.ruby-lang.org/")
# => ["http", nil, "www.ruby-lang.org", nil, nil, "/", nil, nil, nil]

# File bundler/vendor/uri/lib/uri/common.rb, line 133
def self.split(uri)
  RFC3986_PARSER.split(uri)
end