класс ActionController::Parameters

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 287
def ==(other)
  if other.respond_to?(:permitted?)
    permitted? == other.permitted? && parameters == other.parameters
  else
    @parameters == other
  end
end

Возвращает true, если другой объект Parameters содержит тот же контент и флаг разрешения.

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

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

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 621
def []=(key, value)
  @parameters[key] = value
end

Присваивает значение данному key. Заданный ключ может быть отфильтрован при вызове permit.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 151
    

Возвращает хэш, который может быть использован в качестве JSON-представления для параметров.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 791
def compact
  new_instance_with_inherited_permitted_status(@parameters.compact)
end

Возвращает новый экземпляр ActionController::Parameters с удалёнными значениями nil.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 796
def compact!
  self if @parameters.compact!
end

Удаляет все значения nil на месте и возвращает self, или nil, если изменений не было.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 802
def compact_blank
  reject { |_k, v| v.blank? }
end

Возвращает новый экземпляр ActionController::Parameters без пустых значений. Использует Object#blank? для определения пустого значения.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 808
def compact_blank!
  reject! { |_k, v| v.blank? }
end

Удаляет все пустые значения на месте и возвращает self. Использует Object#blank? для определения пустого значения.

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

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

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 889
def deep_dup
  self.class.new(@parameters.deep_dup).tap do |duplicate|
    duplicate.permitted = @permitted
  end
end

Возвращает дубликат объекта, включая все параметры.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 742
def deep_transform_keys(&block)
  new_instance_with_inherited_permitted_status(
    @parameters.deep_transform_keys(&block)
  )
end

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 751
def deep_transform_keys!(&block)
  @parameters.deep_transform_keys!(&block)
  self
end

Возвращает экземпляр ActionController::Parameters, изменяя его ключи. Это включает ключи из корневого хэша и из всех вложенных хэшей и массивов. Значения не изменяются.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 760
def delete(key, &block)
  convert_value_to_parameters(@parameters.delete(key, &block))
end

Удаляет пару ключ-значение из Parameters и возвращает значение. Если key не найден, возвращает nil (или, с необязательным блоком кода, передаёт key и возвращает результат). См. #extract!, который возвращает соответствующий объект ActionController::Parameters.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 659
def dig(*keys)
  convert_hashes_to_parameters(keys.first, @parameters[keys.first])
  @parameters.dig(*keys)
end

Извлекает вложенный параметр из данного keys путём вызова dig на каждом шаге. Возвращает nil, если любой промежуточный шаг является nil.

params = ActionController::Parameters.new(foo: { bar: { baz: 1 } })
params.dig(:foo, :bar, :baz) # => 1
params.dig(:foo, :zot, :xyz) # => nil

params2 = ActionController::Parameters.new(foo: [10, 11, 12])
params2.dig(:foo, 1) # => 11

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 159
    

Вызывает блок один раз для каждого ключа в параметрах, передавая ключ. Если блок не задан, вместо него возвращается перечислитель.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 386
def each_pair(&block)
  return to_enum(__callee__) unless block_given?
  @parameters.each_pair do |key, value|
    yield [key, convert_hashes_to_parameters(key, value)]
  end

  self
end

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 398
def each_value(&block)
  return to_enum(:each_value) unless block_given?
  @parameters.each_pair do |key, value|
    yield convert_hashes_to_parameters(key, value)
  end

  self
end

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 168
    

Возвращает true, если параметры не имеют пар ключ/значение.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 688
def except(*keys)
  new_instance_with_inherited_permitted_status(@parameters.except(*keys))
end

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

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

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

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

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 638
def fetch(key, *args)
  convert_value_to_parameters(
    @parameters.fetch(key) {
      if block_given?
        yield
      else
        args.fetch(0) { raise ActionController::ParameterMissing.new(key, @parameters.keys) }
      end
    }
  )
end

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

params = ActionController::Parameters.new(person: { name: "Francesco" })
params.fetch(:person)               # => <ActionController::Parameters {"name"=>"Francesco"} permitted: false>
params.fetch(:none)                 # => ActionController::ParameterMissing: param is missing or the value is empty: none
params.fetch(:none, {})             # => <ActionController::Parameters {} permitted: false>
params.fetch(:none, "Francesco")    # => "Francesco"
params.fetch(:none) { "Francesco" } # => "Francesco"

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 176
    

Возвращает true, если заданный ключ присутствует в параметрах.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 184
    

Возвращает true, если заданное значение присутствует для какого-либо ключа в параметрах.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 192
    

Возвращает true, если заданный ключ присутствует в параметрах.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 200
    

Возвращает true, если заданный ключ присутствует в параметрах.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 216
    

Возвращает новый массив ключей параметров.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 208
    

Возвращает true, если заданный ключ присутствует в параметрах.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 820
def merge(other_hash)
  new_instance_with_inherited_permitted_status(
    @parameters.merge(other_hash.to_h)
  )
end

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 828
def merge!(other_hash)
  @parameters.merge!(other_hash.to_h)
  self
end

Возвращает текущий экземпляр ActionController::Parameters слиянием other_hash в текущий хэш.

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

  filters.flatten.each do |filter|
    case filter
    when Symbol, String
      permitted_scalar_filter(params, filter)
    when Hash
      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: [])

Иногда невозможно или неудобно объявлять допустимые ключи параметра или его внутреннюю структуру. Просто отобразите на пустой хэш:

params.permit(preferences: {})

Будьте осторожны, так как это открывает возможность произвольного ввода. В этом случае permit гарантирует, что значения в возвращаемой структуре являются разрешенными скалярами и фильтрует всё остальное.

Вы также можете использовать 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)
# => <ActionController::Parameters {} permitted: true>

params.require(:person).permit(contact: :phone)
# => <ActionController::Parameters {"contact"=><ActionController::Parameters {"phone"=>"555-1234"} permitted: true>} permitted: true>

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 440
def permit!
  each_pair do |key, value|
    Array.wrap(value).flatten.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 424
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 779
def reject(&block)
  new_instance_with_inherited_permitted_status(@parameters.reject(&block))
end

Возвращает новый экземпляр ActionController::Parameters с удалёнными элементами, для которых блок возвращает true.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 784
def reject!(&block)
  @parameters.reject!(&block)
  self
end

Удаляет элементы, для которых блок возвращает true, и возвращает self.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 501
def require(key)
  return key.map { |k| require(k) } if key.is_a?(Array)
  value = self[key]
  if value.present? || value == false
    value
  else
    raise ParameterMissing.new(key, @parameters.keys)
  end
end

Этот метод принимает как одиночный ключ, так и массив ключей.

При передаче одиночного ключа, если он существует и его связанное значение присутствует или является синглетоном false, возвращает данное значение:

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

В противном случае генерирует ActionController::ParameterMissing:

ActionController::Parameters.new.require(:person)
# ActionController::ParameterMissing: param is missing or the value is empty: person

ActionController::Parameters.new(person: nil).require(:person)
# ActionController::ParameterMissing: param is missing or the value is empty: person

ActionController::Parameters.new(person: "\t").require(:person)
# ActionController::ParameterMissing: param is missing or the value is empty: person

ActionController::Parameters.new(person: {}).require(:person)
# ActionController::ParameterMissing: param is missing or the value is empty: person

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

params = ActionController::Parameters.new(user: { ... }, profile: { ... })
user_params, profile_params = params.require([:user, :profile])

В противном случае метод повторно генерирует первую найденную ошибку:

params = ActionController::Parameters.new(user: {}, profile: {})
user_params, profile_params = params.require([:user, :profile])
# ActionController::ParameterMissing: param is missing or the value is empty: user

Технически этот метод может использоваться для получения терминальных значений:

# CAREFUL
params = ActionController::Parameters.new(person: { name: "Finn" })
name = params.require(:person).require(:name) # CAREFUL

но учтите, что в какой-то момент их нужно разрешить:

def person_params
  params.require(:person).permit(:name).tap do |person_params|
    person_params.require(:name) # SAFER
  end
end

например.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 835
def reverse_merge(other_hash)
  new_instance_with_inherited_permitted_status(
    other_hash.to_h.merge(@parameters)
  )
end

Возвращает новый ActionController::Parameters слиянием всех ключей текущего хэша в other_hash.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 844
def reverse_merge!(other_hash)
  @parameters.merge!(other_hash.to_h) { |key, left, right| left }
  self
end

Возвращает текущий ActionController::Parameters экземпляр с текущим хэшем, объединённым в other_hash.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 766
def select(&block)
  new_instance_with_inherited_permitted_status(@parameters.select(&block))
end

Возвращает новый экземпляр ActionController::Parameters только с теми элементами, для которых блок возвращает true.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 771
def select!(&block)
  @parameters.select!(&block)
  self
end

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

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

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

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 677
def slice!(*keys)
  @parameters.slice!(*keys)
  self
end

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 312
def to_h
  if permitted?
    convert_parameters_to_hashes(@parameters, :to_h)
  else
    raise UnfilteredParameters
  end
end

Возвращает безопасное ActiveSupport::HashWithIndifferentAccess представление параметров с удалением всех запрещённых ключей.

params = ActionController::Parameters.new({
  name: "Senjougahara Hitagi",
  oddity: "Heavy stone crab"
})
params.to_h
# => ActionController::UnfilteredParameters: unable to convert unpermitted parameters to hash

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 332
def to_hash
  to_h.to_hash
end

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

params = ActionController::Parameters.new({
  name: "Senjougahara Hitagi",
  oddity: "Heavy stone crab"
})
params.to_hash
# => ActionController::UnfilteredParameters: unable to convert unpermitted parameters to hash

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 364
def to_query(*args)
  to_h.to_query(*args)
end

Возвращает строковое представление получателя, подходящее для использования в качестве строки запроса URL:

params = ActionController::Parameters.new({
  name: "David",
  nationality: "Danish"
})
params.to_query
# => ActionController::UnfilteredParameters: unable to convert unpermitted parameters to hash

safe_params = params.permit(:name, :nationality)
safe_params.to_query
# => "name=David&nationality=Danish"

Можно передать необязательное пространство имён для включения имён ключей:

params = ActionController::Parameters.new({
  name: "David",
  nationality: "Danish"
})
safe_params = params.permit(:name, :nationality)
safe_params.to_query("user")
# => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"

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

Этот метод также алиасируется как to_param.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 224
    

Возвращает содержимое параметров в виде строки.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 379
def to_unsafe_h
  convert_parameters_to_hashes(@parameters, :to_unsafe_h)
end

Возвращает небезопасное, нефильтрованное ActiveSupport::HashWithIndifferentAccess представление параметров.

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 724
def transform_keys(&block)
  return to_enum(:transform_keys) unless block_given?
  new_instance_with_inherited_permitted_status(
    @parameters.transform_keys(&block)
  )
end

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 733
def transform_keys!(&block)
  return to_enum(:transform_keys!) unless block_given?
  @parameters.transform_keys!(&block)
  self
end

Выполняет преобразование ключей и возвращает изменённый ActionController::Parameters экземпляр.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 707
def transform_values
  return to_enum(:transform_values) unless block_given?
  new_instance_with_inherited_permitted_status(
    @parameters.transform_values { |v| yield convert_value_to_parameters(v) }
  )
end

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

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 716
def transform_values!
  return to_enum(:transform_values!) unless block_given?
  @parameters.transform_values! { |v| yield convert_value_to_parameters(v) }
  self
end

Выполняет преобразование значений и возвращает изменённый ActionController::Parameters экземпляр.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 232
    

Возвращает true, если заданное значение присутствует для какого-либо ключа в параметрах.

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 246
delegate :keys, :key?, :has_key?, :member?, :values, :has_value?, :value?, :empty?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

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

# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 814
def values_at(*keys)
  convert_value_to_parameters(@parameters.values_at(*keys))
end

Возвращает значения, которые были присвоены указанным keys. Обратите внимание, что все Hash объекты будут преобразованы в ActionController::Parameters.