Module: Sprockets::HTTPUtils
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Extended In:
| |
Included In:
| |
Defined in: | lib/sprockets/http_utils.rb |
Overview
Internal: HTTP URI utilities. Many adapted from Rack::Utils
. Mixed into Environment
.
Instance Method Summary
-
#find_best_mime_type_match(q_value_header, available)
Internal: Find the best qvalue match from an Array of available mime type options.
-
#find_best_q_match(q_values, available, &matcher)
Internal: Find the best qvalue match from an Array of available options.
-
#find_mime_type_matches(q_value_header, available)
Internal: Find the all qvalue match from an Array of available mime type options.
-
#find_q_matches(q_values, available, &matcher)
Internal: Find all qvalue matches from an Array of available options.
-
#match_mime_type?(value, matcher) ⇒ Boolean
Public: Test mime type against mime range.
-
#match_mime_type_keys(hash, mime_type)
Public: Return values from Hash where the key matches the mime type.
-
#parse_q_values(values)
Internal: Parse Accept header quality values.
Instance Method Details
#find_best_mime_type_match(q_value_header, available)
Internal: Find the best qvalue match from an Array of available mime type options.
Adapted from Rack::Utils#q_values
.
Returns the matched mime type String from available Array or nil.
# File 'lib/sprockets/http_utils.rb', line 129
def find_best_mime_type_match(q_value_header, available) find_best_q_match(q_value_header, available) do |a, b| match_mime_type?(a, b) end end
#find_best_q_match(q_values, available, &matcher)
Internal: Find the best qvalue match from an Array of available options.
Adapted from Rack::Utils#q_values
.
Returns the matched String from available Array or nil.
# File 'lib/sprockets/http_utils.rb', line 107
def find_best_q_match(q_values, available, &matcher) find_q_matches(q_values, available, &matcher).first end
#find_mime_type_matches(q_value_header, available)
Internal: Find the all qvalue match from an Array of available mime type options.
Adapted from Rack::Utils#q_values
.
Returns Array of matched mime type Strings from available Array or [].
# File 'lib/sprockets/http_utils.rb', line 117
def find_mime_type_matches(q_value_header, available) find_q_matches(q_value_header, available) do |a, b| match_mime_type?(a, b) end end
#find_q_matches(q_values, available, &matcher)
Internal: Find all qvalue matches from an Array of available options.
Adapted from Rack::Utils#q_values
.
Returns Array of matched Strings from available Array or [].
# File 'lib/sprockets/http_utils.rb', line 74
def find_q_matches(q_values, available, &matcher) matcher ||= lambda { |a, b| a == b } matches = [] case q_values when Array when String q_values = parse_q_values(q_values) when NilClass q_values = [] else raise TypeError, "unknown q_values type: #{q_values.class}" end i = 0 q_values.each do |accepted, quality| if match = available.find { |option| matcher.call(option, accepted) } i += 1 matches << [-quality, i, match] end end matches.sort! matches.map! { |_, _, match| match } matches end
#match_mime_type?(value, matcher) ⇒ Boolean
Public: Test mime type against mime range.
match_mime_type?('text/html', 'text/*') => true
match_mime_type?('text/plain', '*') => true
match_mime_type?('text/html', 'application/json') => false
Returns true if the given value is a mime match for the given mime match specification, false otherwise.
# File 'lib/sprockets/http_utils.rb', line 16
def match_mime_type?(value, matcher) v1, v2 = value.split('/'.freeze, 2) m1, m2 = matcher.split('/'.freeze, 2) (m1 == '*'.freeze || v1 == m1) && (m2.nil? || m2 == '*'.freeze || m2 == v2) end
#match_mime_type_keys(hash, mime_type)
Public: Return values from Hash where the key matches the mime type.
hash - Hash of String matcher keys to Object values mime_type - String mime type
Returns Array of Object values.
# File 'lib/sprockets/http_utils.rb', line 28
def match_mime_type_keys(hash, mime_type) type, subtype = mime_type.split('/', 2) [ hash["*"], hash["*/*"], hash["#{type}/*"], hash["#{type}/#{subtype}"] ].compact end
#parse_q_values(values)
Internal: Parse Accept header quality values.
values - String e.g. “application/javascript”
Adapted from Rack::Utils#q_values
. Quality values are described in www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
parse_q_values("application/javascript")
# => [["application/javascript", 1.0]]
parse_q_values("*/*")
# => [["*/*", 1.0]]
parse_q_values("text/plain; q=0.5, image/*")
# => [["text/plain", 0.5], ["image/*", 1.0]]
parse_q_values("application/javascript, text/css")
# => [["application/javascript", 1.0], ["text/css", 1.0]]
Returns an Array of [String, Float].
# File 'lib/sprockets/http_utils.rb', line 58
def parse_q_values(values) values.to_s.split(/\s*,\s*/).map do |part| value, parameters = part.split(/\s*;\s*/, 2) quality = 1.0 if md = /\Aq=([\d.]+)/.match(parameters) quality = md[1].to_f end [value, quality] end end