class Reference
A relative reference, excluding any authority. The path part of an HTTP request.
Definitions
def self.parse(path = "/", parameters = nil)
Generate a reference from a path and user parameters. The path may contain a #fragment
or ?query=parameters
.
Implementation
def self.parse(path = "/", parameters = nil)
base, fragment = path.split("#", 2)
path, query = base.split("?", 2)
self.new(path, query, fragment, parameters)
end
def initialize(path = "/", query = nil, fragment = nil, parameters = nil)
Initialize the reference.
Signature
-
parameter
path
String
The path component, e.g.
/foo/bar/index.html
.-
parameter
query
String | Nil
The un-parsed query string, e.g. 'x=10&y=20'.
-
parameter
fragment
String | Nil
The fragment, the part after the '#'.
-
parameter
parameters
Hash | Nil
User supplied parameters that will be appended to the query part.
Implementation
def initialize(path = "/", query = nil, fragment = nil, parameters = nil)
@path = path
@query = query
@fragment = fragment
@parameters = parameters
end
attr_accessor :path
Signature
-
attribute
String
The path component, e.g.
/foo/bar/index.html
.
attr_accessor :query
Signature
-
attribute
String
The un-parsed query string, e.g. 'x=10&y=20'.
attr_accessor :fragment
Signature
-
attribute
String
The fragment, the part after the '#'.
attr_accessor :parameters
Signature
-
attribute
Hash
User supplied parameters that will be appended to the query part.
def freeze
Freeze the reference.
Signature
-
returns
Reference
The frozen reference.
Implementation
def freeze
return self if frozen?
@path.freeze
@query.freeze
@fragment.freeze
@parameters.freeze
super
end
def to_ary
Implicit conversion to an array.
Signature
-
returns
Array
The reference as an array,
[path, query, fragment, parameters]
.
Implementation
def to_ary
[@path, @query, @fragment, @parameters]
end
def <=> other
Compare two references.
Signature
-
parameter
other
Reference
The other reference to compare.
-
returns
Integer
-1, 0, 1 if the reference is less than, equal to, or greater than the other reference.
Implementation
def <=> other
to_ary <=> other.to_ary
end
def self.[] reference
Type-cast a reference.
Signature
-
parameter
reference
Reference | String
The reference to type-cast.
-
returns
Reference
The type-casted reference.
Implementation
def self.[] reference
if reference.is_a? self
return reference
else
return self.parse(reference)
end
end
def parameters?
Signature
-
returns
Boolean
Whether the reference has parameters.
Implementation
def parameters?
@parameters and !@parameters.empty?
end
def query?
Signature
-
returns
Boolean
Whether the reference has a query string.
Implementation
def query?
@query and !@query.empty?
end
def fragment?
Signature
-
returns
Boolean
Whether the reference has a fragment.
Implementation
def fragment?
@fragment and !@fragment.empty?
end
def append(buffer = String.new)
Append the reference to the given buffer.
Implementation
def append(buffer = String.new)
if query?
buffer << URL.escape_path(@path) << "?" << @query
buffer << "&" << URL.encode(@parameters) if parameters?
else
buffer << URL.escape_path(@path)
buffer << "?" << URL.encode(@parameters) if parameters?
end
if fragment?
buffer << "#" << URL.escape(@fragment)
end
return buffer
end
def to_s
Convert the reference to a string, e.g. /foo/bar/index.html?x=10&y=20#section
Signature
-
returns
String
The reference as a string.
Implementation
def to_s
append
end
def + other
Merges two references as specified by RFC2396, similar to URI.join
.
Implementation
def + other
other = self.class[other]
self.class.new(
expand_path(self.path, other.path, true),
other.query,
other.fragment,
other.parameters,
)
end
def base
Just the base path, without any query string, parameters or fragment.
Implementation
def base
self.class.new(@path, nil, nil, nil)
end
def with(path: nil, parameters: nil, fragment: @fragment, pop: false, merge: true)
Update the reference with the given path, parameters and fragment.
Implementation
def with(path: nil, parameters: nil, fragment: @fragment, pop: false, merge: true)
if @parameters
if parameters and merge
parameters = @parameters.merge(parameters)
else
parameters = @parameters
end
end
if @query and !merge
query = nil
else
query = @query
end
if path
path = expand_path(@path, path, pop)
else
path = @path
end
self.class.new(path, query, fragment, parameters)
end
def expand_path(base, relative, pop = true)
Implementation
def expand_path(base, relative, pop = true)
if relative.start_with? "/"
return relative
end
path = split(base)
# RFC2396 Section 5.2:
# 6) a) All but the last segment of the base URI's path component is
# copied to the buffer. In other words, any characters after the
# last (right-most) slash character, if any, are excluded.
path.pop if pop or path.last == ""
parts = split(relative)
# Absolute path:
if path.first == ""
expand_absolute_path(path, parts)
else
expand_relative_path(path, parts)
end
return path.join("/")
end