Module: Sprockets::HTTPUtils

Extended by:
HTTPUtils
Included in:
HTTPUtils, Mime, Resolve, Transformers
Defined in:
lib/sprockets/http_utils.rb

Overview

Internal: HTTP URI utilities. Many adapted from Rack::Utils. Mixed into Environment.

Instance Method Summary collapse

Instance Method Details

#find_best_mime_type_match(q_value_header, available) ⇒ Object

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.


127
128
129
130
131
# File 'lib/sprockets/http_utils.rb', line 127

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) ⇒ Object

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.


105
106
107
# File 'lib/sprockets/http_utils.rb', line 105

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) ⇒ Object

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 [].


115
116
117
118
119
# File 'lib/sprockets/http_utils.rb', line 115

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) ⇒ Object

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 [].


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# 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

  q_values.each do |accepted, quality|
    if match = available.find { |option| matcher.call(option, accepted) }
      matches << [match, quality]
    end
  end

  matches.sort_by! { |match, quality| -quality }
  matches.map! { |match, quality| 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.

Returns:

  • (Boolean)

16
17
18
19
20
# 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) ⇒ Object

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.


28
29
30
31
32
33
34
35
36
# 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) ⇒ Object

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].


58
59
60
61
62
63
64
65
66
67
# 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