Class: Merb::AcceptType

Inherits:
Object show all
Defined in:
lib/merb-core/controller/mixins/responder.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(entry, index) ⇒ AcceptType

Parameters

entry<String>

The accept type pattern

index<Fixnum>

The index used for sorting accept types. A lower value indicates higher priority.



409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 409

def initialize(entry,index)
  @index = index
  
  entry =~ /\s*([^;\s]*)\s*(;\s*q=\s*(.*))?/
  @media_range, quality = $1, $3
  
  @type, @sub_type = @media_range.split(%r{/})
  (quality ||= 0.0) if @media_range == "*/*"
  @quality = quality ? (quality.to_f * 100).to_i : 100
  @quality *= (mime && mime[:default_quality] || 1)
end

Instance Attribute Details

#index ⇒ Object (readonly)

Returns the value of attribute index.



402
403
404
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 402

def index
  @index
end

#media_range ⇒ Object (readonly)

Returns the value of attribute media_range.



402
403
404
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 402

def media_range
  @media_range
end

#quality ⇒ Object (readonly)

Returns the value of attribute quality.



402
403
404
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 402

def quality
  @quality
end

#sub_type ⇒ Object (readonly)

Returns the value of attribute sub_type.



402
403
404
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 402

def sub_type
  @sub_type
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



402
403
404
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 402

def type
  @type
end

Instance Method Details

#<=>(entry) ⇒ Object

Compares two accept types for sorting purposes.

Parameters

entry<AcceptType>

The accept type to compare.

Returns

Fixnum

-1, 0 or 1, depending on whether entry has a lower, equal or higher priority than the accept type being compared.



430
431
432
433
434
435
436
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 430

def <=>(entry)
  if entry.quality == quality
    @index <=> entry.index
  else
    entry.quality <=> @quality
  end
end

#==(entry) ⇒ Object

An alias for eql?.



451
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 451

def ==(entry); eql?(entry); end

#eql?(entry) ⇒ Boolean

Parameters

entry<AcceptType>

The accept type to compare.

Returns

Boolean

True if the accept types are equal, i.e. if the synonyms for this accept type includes the entry media range.

Returns:

  • (Boolean) 


446
447
448
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 446

def eql?(entry)
  synonyms.include?(entry.media_range)
end

#hash ⇒ Object

Returns

Fixnum

A hash based on the super range.



455
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 455

def hash; super_range.hash; end

#mime ⇒ Object 



469
470
471
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 469

def mime
  @mime ||= Merb.available_mime_types[Merb::ResponderMixin::MIMES[@media_range]]
end

#super_range ⇒ Object

Returns

String

The primary media range for this accept type, i.e. either the first synonym or, if none exist, the media range.



477
478
479
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 477

def super_range
  synonyms.first || @media_range
end

#synonyms ⇒ Object

Returns

Array

All Accept header values, such as “text/html”, that match this type.



460
461
462
463
464
465
466
467
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 460

def synonyms
  return @syns if @syns
  if _mime = mime
    @syns = _mime[:accepts]
  else
    @syns = []
  end
end

#to_s ⇒ Object

Returns

String

The accept type as a string, i.e. the media range.



490
491
492
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 490

def to_s
  @media_range
end

#to_sym ⇒ Object

Returns

Symbol: The type as a symbol, e.g. :html.



483
484
485
486
 
# File 'lib/merb-core/controller/mixins/responder.rb', line 483

def to_sym
  Merb.available_mime_types.select{|k,v| 
    v[:accepts] == synonyms || v[:accepts][0] == synonyms[0]}.flatten.first
end