Gem::UriFormatter

Class

The UriFormatter handles URIs from user-input and escaping.

uf = Gem::UriFormatter.new 'example.com'

p uf.normalize #=> 'http://example.com'

Attributes

uri

Read

The URI to be formatted.

Class Methods

new(uri)

lib/rubygems/uri_formatter.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/rubygems/uri_formatter.rb, line 19
def initialize(uri)
  require "cgi"

  @uri = uri
end

Creates a new URI formatter for uri.

Instance Methods

escape

lib/rubygems/uri_formatter.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/rubygems/uri_formatter.rb, line 28
def escape
  return unless @uri
  CGI.escape @uri
end

Escapes the uri for use as a CGI parameter

normalize

lib/rubygems/uri_formatter.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/rubygems/uri_formatter.rb, line 36
def normalize
  (@uri =~ /^(https?|ftp|file):/i) ? @uri : "http://#{@uri}"
end

Normalize the URI by adding “http://” if it is missing.

unescape

lib/rubygems/uri_formatter.rb View on GitHub

          
            # File tmp/rubies/ruby-3.2.0/lib/rubygems/uri_formatter.rb, line 43
def unescape
  return unless @uri
  CGI.unescape @uri
end

Unescapes the uri which came from a CGI parameter