Class: Rack::Headers

Inherits:
Hash
  • Object
show all
Defined in:
lib/rack/headers.rb

Overview

Rack::Headers is a Hash subclass that downcases all keys. It's designed to be used by rack applications that don't implement the Rack 3 SPEC (by using non-lowercase response header keys), automatically handling the downcasing of keys.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.[](*items) ⇒ Object 


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/rack/headers.rb', line 7

def self.[](*items)
  if items.length % 2 != 0
    if items.length == 1 && items.first.is_a?(Hash)
      new.merge!(items.first)
    else
      raise ArgumentError, "odd number of arguments for Rack::Headers"
    end
  else
    hash = new
    loop do
      break if items.length == 0
      key = items.shift
      value = items.shift
      hash[key] = value
    end
    hash
  end
end

Instance Method Details

#[](key) ⇒ Object 


26
27
28
 
# File 'lib/rack/headers.rb', line 26

def [](key)
  super(downcase_key(key))
end

#[]=(key, value) ⇒ Object Also known as: store 


30
31
32
 
# File 'lib/rack/headers.rb', line 30

def []=(key, value)
  super(key.downcase.freeze, value)
end

#assoc(key) ⇒ Object 


35
36
37
 
# File 'lib/rack/headers.rb', line 35

def assoc(key)
  super(downcase_key(key))
end

#compare_by_identity ⇒ Object

Raises:

  • (TypeError) 

39
40
41
 
# File 'lib/rack/headers.rb', line 39

def compare_by_identity
  raise TypeError, "Rack::Headers cannot compare by identity, use regular Hash"
end

#delete(key) ⇒ Object 


43
44
45
 
# File 'lib/rack/headers.rb', line 43

def delete(key)
  super(downcase_key(key))
end

#dig(key, *a) ⇒ Object 


47
48
49
 
# File 'lib/rack/headers.rb', line 47

def dig(key, *a)
  super(downcase_key(key), *a)
end

#except(*a) ⇒ Object

:nocov:


143
144
145
 
# File 'lib/rack/headers.rb', line 143

def except(*a)
  super(*a.map!{|key| downcase_key(key)})
end

#fetch(key, *default, &block) ⇒ Object 


51
52
53
54
 
# File 'lib/rack/headers.rb', line 51

def fetch(key, *default, &block)
  key = downcase_key(key)
  super
end

#fetch_values(*a) ⇒ Object 


56
57
58
 
# File 'lib/rack/headers.rb', line 56

def fetch_values(*a)
  super(*a.map!{|key| downcase_key(key)})
end

#has_key?(key) ⇒ Boolean Also known as: include?, key?, member?

Returns:

  • (Boolean) 

60
61
62
 
# File 'lib/rack/headers.rb', line 60

def has_key?(key)
  super(downcase_key(key))
end

#invert ⇒ Object 


67
68
69
70
71
 
# File 'lib/rack/headers.rb', line 67

def invert
  hash = self.class.new
  each{|key, value| hash[value] = key}
  hash
end

#merge(hash, &block) ⇒ Object 


73
74
75
 
# File 'lib/rack/headers.rb', line 73

def merge(hash, &block)
  dup.merge!(hash, &block)
end

#reject(&block) ⇒ Object 


77
78
79
80
81
 
# File 'lib/rack/headers.rb', line 77

def reject(&block)
  hash = dup
  hash.reject!(&block)
  hash
end

#replace(hash) ⇒ Object 


83
84
85
86
 
# File 'lib/rack/headers.rb', line 83

def replace(hash)
  clear
  update(hash)
end

#select(&block) ⇒ Object 


88
89
90
91
92
 
# File 'lib/rack/headers.rb', line 88

def select(&block)
  hash = dup
  hash.select!(&block)
  hash
end

#slice(*a) ⇒ Object

:nocov:


121
122
123
124
125
 
# File 'lib/rack/headers.rb', line 121

def slice(*a)
  h = self.class.new
  a.each{|k| h[k] = self[k] if has_key?(k)}
  h
end

#to_proc ⇒ Object 


94
95
96
 
# File 'lib/rack/headers.rb', line 94

def to_proc
  lambda{|x| self[x]}
end

#transform_keys(&block) ⇒ Object 


127
128
129
 
# File 'lib/rack/headers.rb', line 127

def transform_keys(&block)
  dup.transform_keys!(&block)
end

#transform_keys! ⇒ Object 


131
132
133
134
135
136
137
 
# File 'lib/rack/headers.rb', line 131

def transform_keys!
  hash = self.class.new
  each do |k, v|
    hash[yield k] = v
  end
  replace(hash)
end

#transform_values(&block) ⇒ Object 


98
99
100
 
# File 'lib/rack/headers.rb', line 98

def transform_values(&block)
  dup.transform_values!(&block)
end

#update(hash, &block) ⇒ Object Also known as: merge! 


102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rack/headers.rb', line 102

def update(hash, &block)
  hash.each do |key, value|
    self[key] = if block_given? && include?(key)
      block.call(key, self[key], value)
    else
      value
    end
  end
  self
end

#values_at(*keys) ⇒ Object 


114
115
116
 
# File 'lib/rack/headers.rb', line 114

def values_at(*keys)
  keys.map{|key| self[key]}
end