class ActionController::Parameters

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 350
def [](key)
  convert_hashes_to_parameters(key, super)
end

Возвращает параметр для заданного key. Если не найден, возвращает nil.

params = ActionController::Parameters.new(person: { name: 'Francesco' })
params[:person] # => {"name"=>"Francesco"}
params[:none]   # => nil

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 197
def converted_arrays
  @converted_arrays ||= Set.new
end

Атрибут, отслеживающий преобразованные массивы (если таковые имеются), чтобы избежать двойного циклирования в распространённом случае с разрешениями + массовым назначением. Определён в методе для инициализации только при необходимости.

Тестирование членства всё ещё выполняет циклирование, но это будет быстрее, чем наш собственный цикл, преобразующий значения. Кроме того, мы не будем создавать новый объект массива при каждом извлечении.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 420
def delete(key, &block)
  convert_hashes_to_parameters(key, super, false)
end

Удаляет и возвращает пару «ключ-значение» из Parameters, у которого ключ равен key. Если ключ не найден, возвращает значение по умолчанию. Если задан необязательный блок кода, и ключ не найден, передаёт ключ и возвращает результат выполнения блока.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 437
def dup
  super.tap do |duplicate|
    duplicate.permitted = @permitted
  end
end

Возвращает точную копию экземпляра ActionController::Parameters. permitted состояние сохраняется в дублированном объекте.

params = ActionController::Parameters.new(a: 1)
params.permit!
params.permitted?        # => true
copy_params = params.dup # => {"a"=>1}
copy_params.permitted?   # => true

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 180
def each_pair(&block)
  super do |key, value|
    convert_hashes_to_parameters(key, value)
  end

  super
end

Преобразует все хэши в значения в параметры, затем передает каждую пару таким же образом, как и Hash#each_pair

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 387
def extract!(*keys)
  new_instance_with_inherited_permitted_status(super)
end

Удаляет и возвращает пары «ключ-значение», соответствующие заданным ключам.

params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
params.extract!(:a, :b) # => {"a"=>1, "b"=>2}
params                  # => {"c"=>3}

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 365
def fetch(key, *args)
  convert_hashes_to_parameters(key, super, false)
rescue KeyError
  raise ActionController::ParameterMissing.new(key)
end

Возвращает параметр для заданного key. Если key не найден, есть несколько вариантов: без дополнительных аргументов он вызывает ошибку ActionController::ParameterMissing; если заданы дополнительные аргументы, они возвращаются; если задан блок, выполняется блок, и возвращается его результат.

params = ActionController::Parameters.new(person: { name: 'Francesco' })
params.fetch(:person)               # => {"name"=>"Francesco"}
params.fetch(:none)                 # => ActionController::ParameterMissing: param not found: none
params.fetch(:none, 'Francesco')    # => "Francesco"
params.fetch(:none) { 'Francesco' } # => "Francesco"

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 327
def permit(*filters)
  params = self.class.new

  filters.flatten.each do |filter|
    case filter
    when Symbol, String
      permitted_scalar_filter(params, filter)
    when Hash then
      hash_filter(params, filter)
    end
  end

  unpermitted_parameters!(params) if self.class.action_on_unpermitted_parameters

  params.permit!
end

Возвращает новый экземпляр ActionController::Parameters, включающий только заданные filters, и устанавливает атрибут permitted объекта в true. Это полезно для ограничения атрибутов, которые должны разрешаться для массового обновления.

params = ActionController::Parameters.new(user: { name: 'Francesco', age: 22, role: 'admin' })
permitted = params.require(:user).permit(:name, :age)
permitted.permitted?      # => true
permitted.has_key?(:name) # => true
permitted.has_key?(:age)  # => true
permitted.has_key?(:role) # => false

Только разрешённые скаляры проходят фильтр. Например, при

params.permit(:name)

:name проходит, если это ключ params, а связанное с ним значение имеет тип String, Symbol, NilClass, Numeric, TrueClass, FalseClass, Date, Time, DateTime, StringIO, IO, ActionDispatch::Http::UploadedFile или Rack::Test::UploadedFile. В противном случае ключ :name отфильтровывается.

Вы можете объявить, что параметр должен быть массивом разрешённых скаляров, сопоставив его с пустым массивом:

params = ActionController::Parameters.new(tags: ['rails', 'parameters'])
params.permit(tags: [])

Вы также можете использовать permit для вложенных параметров, например:

params = ActionController::Parameters.new({
  person: {
    name: 'Francesco',
    age:  22,
    pets: [{
      name: 'Purplish',
      category: 'dogs'
    }]
  }
})

permitted = params.permit(person: [ :name, { pets: :name } ])
permitted.permitted?                    # => true
permitted[:person][:name]               # => "Francesco"
permitted[:person][:age]                # => nil
permitted[:person][:pets][0][:name]     # => "Purplish"
permitted[:person][:pets][0][:category] # => nil

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

params = ActionController::Parameters.new({
  person: {
    contact: {
      email: 'none@test.com',
      phone: '555-1234'
    }
  }
})

params.require(:person).permit(:contact)
# => {}

params.require(:person).permit(contact: :phone)
# => {"contact"=>{"phone"=>"555-1234"}}

params.require(:person).permit(contact: [ :email, :phone ])
# => {"contact"=>{"email"=>"none@test.com", "phone"=>"555-1234"}}

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 223
def permit!
  each_pair do |key, value|
    Array.wrap(value).each do |v|
      v.permit! if v.respond_to? :permit!
    end
  end

  @permitted = true
  self
end

Устанавливает атрибут permitted в true. Это может быть использовано для передачи массового назначения. Возвращает self.

class Person < ActiveRecord::Base
end

params = ActionController::Parameters.new(name: 'Francesco')
params.permitted?  # => false
Person.new(params) # => ActiveModel::ForbiddenAttributesError
params.permit!
params.permitted?  # => true
Person.new(params) # => #<Person id: nil, name: "Francesco">

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 207
def permitted?
  @permitted
end

Возвращает true, если параметр разрешён, false в противном случае.

params = ActionController::Parameters.new
params.permitted? # => false
params.permit!
params.permitted? # => true

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 246
def require(key)
  value = self[key]
  if value.present? || value == false
    value
  else
    raise ParameterMissing.new(key)
  end
end

Обеспечивает наличие параметра. Если он присутствует, возвращает параметр по заданному key, иначе вызывает ошибку ActionController::ParameterMissing.

ActionController::Parameters.new(person: { name: 'Francesco' }).require(:person)
# => {"name"=>"Francesco"}

ActionController::Parameters.new(person: nil).require(:person)
# => ActionController::ParameterMissing: param not found: person

ActionController::Parameters.new(person: {}).require(:person)
# => ActionController::ParameterMissing: param not found: person

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 425
def select!(&block)
  convert_value_to_parameters(super)
end

Эквивалентно Hash#keep_if, но возвращает nil, если изменений не было.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 378
def slice(*keys)
  new_instance_with_inherited_permitted_status(super)
end

Возвращает новый экземпляр ActionController::Parameters, включающий только заданные keys. Если заданные keys не существуют, возвращает пустой хэш.

params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
params.slice(:a, :b) # => {"a"=>1, "b"=>2}
params.slice(:d)     # => {}

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 164
def to_h
  if permitted?
    to_hash
  else
    slice(*self.class.always_permitted_parameters).permit!.to_h
  end
end

Возвращает безопасное представление Hash этого параметра со всеми неразрешёнными ключами, удалёнными.

params = ActionController::Parameters.new({
  name: 'Senjougahara Hitagi',
  oddity: 'Heavy stone crab'
})
params.to_h # => {}

safe_params = params.permit(:name)
safe_params.to_h # => {"name"=>"Senjougahara Hitagi"}

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 173
def to_unsafe_h
  to_hash
end

Возвращает небезопасное, нефильтрованное представление Hash этого параметра.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 397
def transform_values
  if block_given?
    new_instance_with_inherited_permitted_status(super)
  else
    super
  end
end

Возвращает новый ActionController::Parameters с результатами выполнения block один раз для каждого значения. Ключи остаются неизменными.

params = ActionController::Parameters.new(a: 1, b: 2, c: 3)
params.transform_values { |x| x * 2 }
# => {"a"=>2, "b"=>4, "c"=>6}