Class Eymiha::UrlNormalizer
In: lib/eymiha/url/url_normalizer.rb
Parent: Object

A UrlNormalizer normalizes URLs. They are validated using the URI class except when they can be identified as file resources. When so, if the designated file‘s name starts with a slash (or a drive identifier followed by a slash on a windows box) the path is used verbatim. If not, the named file is assumed to be relative to a caller-supplied base directory.

Methods

absolute_file_path   absolute_file_path?   file_url?   new   normalize   normalize_file   normalize_file_path   relative_base   relative_base=   relative_base=   valid_relative_base?  

Attributes

relative_base  [R] 

Public Class methods

absolute_file_path(file_url)

grafts on the drive designator for an absolute file if not present and on a pc filesystem

absolute_file_path?(file_url)

Returns true if the given URL file resource is absolute.

file_url?(url)

Returns true if the given URL is a file resource.

new()

Creates a new instance using the default direcory for normalizing relative file resources.

relative_base()

Returns the default directory for normalizing relative file resources.

relative_base=(relative_base)

Sets and returns the default directory for normalizing relative file resources. The directory is validated prior to assignment - if invalid a UrlException will be raised.

valid_relative_base?(relative_base)

Returns true if the given relative_base is valid. It should start and end with a slash (or start with a drive designator and a slash and end with a slash on a PC).

Public Instance methods

normalize(url,relative_base=nil)

Returns a normalized URL relative to the given base if it is a relative file resource.

normalize_file(file_url)

Normalizes and returns a relative or absolute URL file resource.

normalize_file_path(file_url)

Returns an absolute path for the given URL file resource. This is either the incoming URL if absolute, or the URL anchored at the relative base if relative.

relative_base=(relative_base)

Sets and Returns the directory for normalizing relative file resources. The directory is validated prior to assignment - if invalid a UrlException will be raised.

[Validate]