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.


426
427
428
429
430
# File 'lib/rack/utils.rb', line 426

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:


418
419
420
421
422
423
424
# File 'lib/rack/utils.rb', line 418

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.


456
457
458
# File 'lib/rack/utils.rb', line 456

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.


460
461
462
463
464
465
# File 'lib/rack/utils.rb', line 460

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

#clearObject

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


439
440
441
442
# File 'lib/rack/utils.rb', line 439

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.


467
468
469
470
471
# File 'lib/rack/utils.rb', line 467

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

#eachObject

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.


444
445
446
447
448
# File 'lib/rack/utils.rb', line 444

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)

473
474
475
# File 'lib/rack/utils.rb', line 473

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


433
434
435
436
# File 'lib/rack/utils.rb', line 433

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.


486
487
488
489
# File 'lib/rack/utils.rb', line 486

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.


481
482
483
484
# File 'lib/rack/utils.rb', line 481

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.


491
492
493
494
495
# File 'lib/rack/utils.rb', line 491

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

#to_hashObject

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.


450
451
452
453
454
# File 'lib/rack/utils.rb', line 450

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