Module: Bundler::URI::Escape

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In: `::Bundler::URI`
Defined in:	lib/bundler/vendor/uri/lib/uri/common.rb

Overview

Module for escaping unsafe characters with codes.

Instance Method Summary

#decode(*arg)

Alias for #unescape.
#encode(*arg)

Alias for #escape.
#escape(*arg) (also: #encode)

Synopsis.
#unescape(*arg) (also: #decode)

Synopsis.

Instance Method Details

#decode(*arg)

Alias for #unescape.

[ GitHub ]

# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 136


alias decode unescape

#encode(*arg)

Alias for #escape.

[ GitHub ]

# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 105


alias encode escape

#escape(*arg) Also known as: #encode

Synopsis

Bundler::URI.escape(str [, unsafe])

Args

str: String to replaces in.
unsafe: Regexp that matches all symbols that must be replaced with codes. By default uses UNSAFE. When this argument is a String, it represents a character set.

Description

Escapes the string, replacing all unsafe characters with codes.

This method is obsolete and should not be used. Instead, use CGI.escape, Bundler::URI.encode_www_form or Bundler::URI.encode_www_form_component depending on your specific use case.

Usage

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

enc_uri = Bundler::URI.escape("http://example.com/?a=\11\15")
# => "http://example.com/?a=%09%0D"

Bundler::URI.unescape(enc_uri)
# => "http://example.com/?a=\t\r"

Bundler::URI.escape("@?@!", "!?")
# => "@%3F@%21"

[ GitHub ]

# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 101


def escape(*arg)
  warn "Bundler::URI.escape is obsolete", uplevel: 1
  DEFAULT_PARSER.escape(*arg)
end

#unescape(*arg) Also known as: #decode

Synopsis

Bundler::URI.unescape(str)

Args

str: String to unescape.

Description

This method is obsolete and should not be used. Instead, use CGI.unescape, Bundler::URI.decode_www_form or Bundler::URI.decode_www_form_component depending on your specific use case.

Usage

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

enc_uri = Bundler::URI.escape("http://example.com/?a=\11\15")
# => "http://example.com/?a=%09%0D"

Bundler::URI.unescape(enc_uri)
# => "http://example.com/?a=\t\r"

[ GitHub ]

# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 132


def unescape(*arg)
  warn "Bundler::URI.unescape is obsolete", uplevel: 1
  DEFAULT_PARSER.unescape(*arg)
end