модуль ActionController::ParamsWrapper

Оборачивает параметр хэш в вложенный хэш. Это позволит клиентам отправлять запросы без необходимости указывать корневые элементы.

Эта функциональность включена в config/initializers/wrap_parameters.rb и может быть настраиваема.

Вы также можете включить её для отдельного контроллера, установив массив форматов на непустой массив:

class UsersController < ApplicationController
  wrap_parameters format: [:json, :xml, :url_encoded_form, :multipart_form]
end

Если вы включите ParamsWrapper для формата :json, вместо того, чтобы отправлять JSON-параметры так:

{"user": {"name": "Konata"}}

Вы можете отправить параметры так:

{"name": "Konata"}

И они будут обернуты во вложенный хэш с именем ключа, соответствующим имени контроллера. Например, если вы отправляете POST-запрос на UsersController, ваш новый params хэш будет выглядеть так:

{"name" => "Konata", "user" => {"name" => "Konata"}}

Вы также можете указать ключ, в который должны быть обернуты параметры, а также список атрибутов, которые нужно обернуть, используя либо :include или :exclude опции, как в этом примере:

class UsersController < ApplicationController
  wrap_parameters :person, include: [:username, :password]
end

В моделях Active Record без установленных опций :include или :exclude будет обернут только параметр, возвращаемый методом класса attribute_names.

Если вы собираетесь передать параметры объекту ActiveModel (например, User.new(params[:user])), вы можете рассмотреть возможность передачи класса модели в метод вместо этого. ParamsWrapper будет пытаться определить список имён атрибутов из модели и обернуть только эти атрибуты:

class UsersController < ApplicationController
  wrap_parameters Person
end

Вы всё ещё можете передать :include и :exclude для установки списка атрибутов, которые нужно обернуть.

По умолчанию, если вы не указываете ключ, в который должны быть обернуты параметры, ParamsWrapper будет пытаться определить, есть ли связанная с ним модель или нет. Например, этот контроллер:

class Admin::UsersController < ApplicationController
end

будет пытаться проверить, существуют ли модели Admin::User или User, и соответственно использовать их для определения ключа обертки. Если обе модели не существуют, он затем вернётся к использованию user в качестве ключа.

Константы

EXCLUDE_PARAMETERS

Открытые методы экземпляров

process_action(*args) Показать исходный код

# File actionpack/lib/action_controller/metal/params_wrapper.rb, line 234
def process_action(*args)
  if _wrapper_enabled?
    if request.parameters[_wrapper_key].present?
      wrapped_hash = _extract_parameters(request.parameters)
    else
      wrapped_hash = _wrap_parameters request.request_parameters
    end

    wrapped_keys = request.request_parameters.keys
    wrapped_filtered_hash = _wrap_parameters request.filtered_parameters.slice(*wrapped_keys)

    # This will make the wrapped hash accessible from controller and view.
    request.parameters.merge! wrapped_hash
    request.request_parameters.merge! wrapped_hash

    # This will display the wrapped hash in the log file.
    request.filtered_parameters.merge! wrapped_filtered_hash
  end
  super
end

Выполняет обёртку параметров по запросу. Вызывается автоматически стеком вызовов метала.

Вызывает метод суперкласса