модуль ActionDispatch::Http::MimeNegotiation

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 42
def accepts
  fetch_header("action_dispatch.request.accepts") do |k|
    header = get_header("HTTP_ACCEPT").to_s.strip

    v = if header.empty?
      [content_mime_type]
    else
      Mime::Type.parse(header)
    end
    set_header k, v
  rescue ::Mime::Type::InvalidMimeType => e
    raise InvalidType, e.message
  end
end

Возвращает MIME-тип, принимаемый запросом.

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 24
def content_mime_type
  fetch_header("action_dispatch.request.content_type") do |k|
    v = if get_header("CONTENT_TYPE") =~ /^([^,;]*)/
      Mime::Type.lookup($1.strip.downcase)
    else
      nil
    end
    set_header k, v
  rescue ::Mime::Type::InvalidMimeType => e
    raise InvalidType, e.message
  end
end

MIME-тип HTTP-запроса, например Mime.

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 68
def format(_view_path = nil)
  formats.first || Mime::NullType.instance
end

Возвращает MIME-тип формата, используемого в запросе.

# GET /posts/5.xml
request.format # => Mime[:xml]

# GET /posts/5.xhtml
request.format # => Mime[:html]

# GET /posts/5
request.format # => Mime[:html] or Mime[:js], or request.accepts.first

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 174
def format=(extension)
  parameters[:format] = extension.to_s
  set_header "action_dispatch.request.formats", [Mime::Type.lookup_by_extension(parameters[:format])]
end

Устанавливает формат по строковому расширению. Это позволяет принудительно задавать пользовательские форматы, не контролируемые расширением.

class ApplicationController < ActionController::Base
  before_action :adjust_format_for_iphone

  private
    def adjust_format_for_iphone
      request.format = :iphone if request.env["HTTP_USER_AGENT"][/iPhone/]
    end
end

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 194
def formats=(extensions)
  parameters[:format] = extensions.first.to_s
  set_header "action_dispatch.request.formats", extensions.collect { |extension|
    Mime::Type.lookup_by_extension(extension)
  }
end

Устанавливает форматы по строковым расширениям. Этот метод отличается от format= тем, что позволяет задать несколько упорядоченных форматов, что полезно, когда требуется резервный вариант.

В этом примере будет использоваться формат :iphone, если он доступен; в противном случае будет выбран формат :html.

class ApplicationController < ActionController::Base
  before_action :adjust_format_for_iphone_with_html_fallback

  private
    def adjust_format_for_iphone_with_html_fallback
      request.formats = [ :iphone, :html ] if request.env["HTTP_USER_AGENT"][/iPhone/]
    end
end

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 202
def negotiate_mime(order)
  formats.each do |priority|
    if priority == Mime::ALL
      return order.first
    elsif order.include?(priority)
      return priority
    end
  end

  order.include?(Mime::ALL) ? format : nil
end

Возвращает первый MIME-тип, соответствующий переданному массиву MIME-типов.

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 159
def variant
  @variant ||= ActiveSupport::ArrayInquirer.new
end

Возвращает вариант шаблона ответа в виде экземпляра ActiveSupport::ArrayInquirer.

request.variant = :phone
request.variant.phone?  # => true
request.variant.tablet? # => false

request.variant = [:phone, :tablet]
request.variant.phone?                  # => true
request.variant.desktop?                # => false
request.variant.any?(:phone, :desktop)  # => true
request.variant.any?(:desktop, :watch)  # => false

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 137
def variant=(variant)
  variant = Array(variant)

  if variant.all?(Symbol)
    @variant = ActiveSupport::ArrayInquirer.new(variant)
  else
    raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols."
  end
end

Устанавливает вариант шаблона ответа.

При выборе шаблона для отображения Action View учитывает все варианты из запроса. Например, если действие ArticlesController#index должно обработать запрос request.variant = [:ios, :turbo_native], оно отобразит первый найденный файл шаблона из следующего списка:

• app/views/articles/index.html+ios.erb

• app/views/articles/index.html+turbo_native.erb

• app/views/articles/index.html.erb

Варианты добавляют к запросам контекст, позволяющий представлениям отображать подходящее содержимое. Названия вариантов произвольны и могут обозначать что угодно: платформу запроса (:android, :ios, :linux, :macos, :windows), браузер (:chrome, :edge, :firefox, :safari) или тип пользователя (:admin, :guest, :user).

Примечание. Добавление множества новых шаблонов вариантов, похожих на существующие файлы шаблонов, может затруднить сопровождение кода представлений.

Parameters

• variant — символьное имя или массив символьных имён вариантов, используемых для отображения шаблона ответа

Примеры

class ApplicationController < ActionController::Base
  before_action :determine_variants

  private
    def determine_variants
      variants = []

      # some code to determine the variant(s) to use

      variants << :ios if request.user_agent.include?("iOS")
      variants << :turbo_native if request.user_agent.include?("Turbo Native")

      request.variant = variants
    end
end