In Files

  • rubygems/uri_formatter.rb

Class/Module Index [+]

Quicksearch

Gem::UriFormatter

The UriFormatter handles URIs from user-input and escaping.

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

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

Attributes

uri[R]

The URI to be formatted.

Public Class Methods

new(uri) click to toggle source

Creates a new URI formatter for uri.

 
               # File rubygems/uri_formatter.rb, line 21
def initialize uri
  @uri = uri
end
            

Public Instance Methods

escape() click to toggle source

Escapes the uri for use as a CGI parameter

 
               # File rubygems/uri_formatter.rb, line 28
def escape
  return unless @uri
  CGI.escape @uri
end
            
normalize() click to toggle source

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

 
               # File rubygems/uri_formatter.rb, line 36
def normalize
  (@uri =~ /^(https?|ftp|file):/i) ? @uri : "http://#{@uri}"
end
            
unescape() click to toggle source

Unescapes the uri which came from a CGI parameter

 
               # File rubygems/uri_formatter.rb, line 43
def unescape
  return unless @uri
  CGI.unescape @uri
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus