Class: Rack::Utils::HeaderHash Private

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

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A case-insensitive Hash that preserves the original case of a header when set.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash = {}) ⇒ HeaderHash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of HeaderHash.



429
430
431
432
433
 
# File 'lib/rack/utils.rb', line 429

def initialize(hash = {})
  super()
  @names = {}
  hash.each { |k, v| self[k] = v }
end

Class Method Details

.[](headers) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

:nodoc:



421
422
423
424
425
426
427
 
# File 'lib/rack/utils.rb', line 421

def self.[](headers)
  if headers.is_a?(HeaderHash) && !headers.frozen?
    return headers
  else
    return self.new(headers)
  end
end

Instance Method Details

#[](k) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



459
460
461
 
# File 'lib/rack/utils.rb', line 459

def [](k)
  super(k) || super(@names[k.downcase])
end

#[]=(k, v) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



463
464
465
466
467
468
 
# File 'lib/rack/utils.rb', line 463

def []=(k, v)
  canonical = k.downcase.freeze
  delete k if @names[canonical] && @names[canonical] != k # .delete is expensive, don't invoke it unless necessary
  @names[canonical] = k
  super k, v
end

#clear ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

on clear, we need to clear @names hash



442
443
444
445
 
# File 'lib/rack/utils.rb', line 442

def clear
  super
  @names.clear
end

#delete(k) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



470
471
472
473
474
 
# File 'lib/rack/utils.rb', line 470

def delete(k)
  canonical = k.downcase
  result = super @names.delete(canonical)
  result
end

#each ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



447
448
449
450
451
 
# File 'lib/rack/utils.rb', line 447

def each
  super do |k, v|
    yield(k, v.respond_to?(:to_ary) ? v.to_ary.join("\n") : v)
  end
end

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


476
477
478
 
# File 'lib/rack/utils.rb', line 476

def include?(k)
  super || @names.include?(k.downcase)
end

#initialize_copy(other) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

on dup/clone, we need to duplicate @names hash



436
437
438
439
 
# File 'lib/rack/utils.rb', line 436

def initialize_copy(other)
  super
  @names = other.names.dup
end

#merge(other) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



489
490
491
492
 
# File 'lib/rack/utils.rb', line 489

def merge(other)
  hash = dup
  hash.merge! other
end

#merge!(other) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



484
485
486
487
 
# File 'lib/rack/utils.rb', line 484

def merge!(other)
  other.each { |k, v| self[k] = v }
  self
end

#replace(other) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



494
495
496
497
498
 
# File 'lib/rack/utils.rb', line 494

def replace(other)
  clear
  other.each { |k, v| self[k] = v }
  self
end

#to_hash ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



453
454
455
456
457
 
# File 'lib/rack/utils.rb', line 453

def to_hash
  hash = {}
  each { |k, v| hash[k] = v }
  hash
end