module Puppet::Network::FormatHandler

create(*args, &block) click to toggle source

# File lib/puppet/network/format_handler.rb, line 12
def self.create(*args, &block)
  instance = Puppet::Network::Format.new(*args, &block)

  @formats[instance.name] = instance
  instance
end

create_serialized_formats(name,options = {},&block) click to toggle source

# File lib/puppet/network/format_handler.rb, line 19
def self.create_serialized_formats(name,options = {},&block)
  ["application/x-#{name}", "application/#{name}", "text/x-#{name}", "text/#{name}"].each { |mime_type|
    create name, {:mime => mime_type}.update(options), &block
  }
end

format(name) click to toggle source

# File lib/puppet/network/format_handler.rb, line 25
def self.format(name)
  @formats[name.to_s.downcase.intern]
end

format_by_extension(ext) click to toggle source

# File lib/puppet/network/format_handler.rb, line 34
def self.format_by_extension(ext)
  @formats.each do |name, format|
    return format if format.extension == ext
  end
  nil
end

format_for(name) click to toggle source

# File lib/puppet/network/format_handler.rb, line 29
def self.format_for(name)
  name = format_to_canonical_name(name)
  format(name)
end

format_to_canonical_name(format) click to toggle source

Return a format name given:

* a format name
* a mime-type
* a format instance

# File lib/puppet/network/format_handler.rb, line 56
def self.format_to_canonical_name(format)
  case format
  when Puppet::Network::Format
    out = format
  when %r{\w+/\w+}
    out = mime(format)
  else
    out = format(format)
  end
  raise ArgumentError, "No format match the given format name or mime-type (#{format})" if out.nil?
  out.name
end

format_to_canonical_name_or_nil(format) click to toggle source

@api private

# File lib/puppet/network/format_handler.rb, line 98
def self.format_to_canonical_name_or_nil(format)
  format_to_canonical_name(format)
rescue ArgumentError
  nil
end

formats() click to toggle source

Provide a list of all formats.

# File lib/puppet/network/format_handler.rb, line 42
def self.formats
  @formats.keys
end

mime(mimetype) click to toggle source

Return a format capable of handling the provided mime type.

# File lib/puppet/network/format_handler.rb, line 47
def self.mime(mimetype)
  mimetype = mimetype.to_s.downcase
  @formats.values.find { |format| format.mime == mimetype }
end

most_suitable_format_for(accepted, supported) click to toggle source

Determine which of the accepted formats should be used given what is supported.

@param accepted [Array<String, Symbol>] the accepted formats in a form a

that generally conforms to an HTTP Accept header. Any quality specifiers
are ignored and instead the formats are simply in strict preference order
(most preferred is first)

@param supported [Array<Symbol>] the names of the supported formats (the

most preferred format is first)

@return [Puppet::Network::Format, nil] the most suitable format @api private

# File lib/puppet/network/format_handler.rb, line 79
def self.most_suitable_format_for(accepted, supported)
  format_name = accepted.collect do |accepted|
    accepted.to_s.sub(/;q=.*$/, '')
  end.collect do |accepted|
    if accepted == ALL_MEDIA_TYPES
      supported.first
    else
      format_to_canonical_name_or_nil(accepted)
    end
  end.find do |accepted|
    supported.include?(accepted)
  end

  if format_name
    format_for(format_name)
  end
end

Constants

Public Class Methods