Class: ActionController::Parameters

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `::ActiveSupport::DeepMergeable`
Inherits:	Object
Defined in:	actionpack/lib/action_controller/metal/strong_parameters.rb

Overview

Allows you to choose which attributes should be permitted for mass updating and thus prevent accidentally exposing that which shouldn’t be exposed. Provides two methods for this purpose: #require and #permit. The former is used to mark parameters as required. The latter is used to set the parameter as permitted and limit which attributes should be allowed for mass updating.

params = ActionController::Parameters.new({
  person: {
    name: "Francesco",
    age:  22,
    role: "admin"
  }
})

permitted = params.require(:person).permit(:name, :age)
permitted            # => #<ActionController::Parameters {"name"=>"Francesco", "age"=>22} permitted: true>
permitted.permitted? # => true

Person.first.update!(permitted)
# => #<Person id: 1, name: "Francesco", age: 22, role: "user">

It provides two options that controls the top-level behavior of new instances:

.permit_all_parameters - If it’s true, all the parameters will be permitted by default. The default is ‘false`.
.action_on_unpermitted_parameters - Controls behavior when parameters that are not explicitly permitted are found. The default value is ‘:log` in test and development environments, false otherwise. The values can be:
- ‘false` to take no action.
- ‘:log` to emit an ActiveSupport::Notifications.instrument event on the unpermitted_parameters.action_controller topic and log at the DEBUG level.
- ‘:raise` to raise an ActionController::UnpermittedParameters exception.

Examples:

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

ActionController::Parameters.permit_all_parameters = true

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

params = ActionController::Parameters.new(a: "123", b: "456")
params.permit(:c)
# => #<ActionController::Parameters {} permitted: true>

ActionController::Parameters.action_on_unpermitted_parameters = :raise

params = ActionController::Parameters.new(a: "123", b: "456")
params.permit(:c)
# => ActionController::UnpermittedParameters: found unpermitted keys: a, b

Please note that these options *are not thread-safe*. In a multi-threaded environment they should only be set once at boot-time and never mutated at runtime.

You can fetch values of Parameters using either :key or "key".

params = ActionController::Parameters.new(key: "value")
params[:key]  # => "value"
params["key"] # => "value"

Constant Summary

EMPTY_ARRAY = Internal use only
# File 'actionpack/lib/action_controller/metal/strong_parameters.rb', line 1187
```
[]
```
EMPTY_HASH = Internal use only
# File 'actionpack/lib/action_controller/metal/strong_parameters.rb', line 1188
```
{}
```
PERMITTED_SCALAR_TYPES =

— Filtering ———————————————————-

This is a list of permitted scalar types that includes the ones supported in XML and JSON requests.

This list is in particular used to filter ordinary requests, ::String goes as first element to quickly short-circuit the common case.

If you modify this collection please update the one in the #permit doc as well.

# File 'actionpack/lib/action_controller/metal/strong_parameters.rb', line 1132
```
[
  String,
  Symbol,
  NilClass,
  Numeric,
  TrueClass,
  FalseClass,
  Date,
  Time,
  # DateTimes are Dates, we document the type but avoid the redundant check.
  StringIO,
  IO,
  ActionDispatch::Http::UploadedFile,
  Rack::Test::UploadedFile,
]
```

Class Attribute Summary

.action_on_unpermitted_parameters rw
.allow_deprecated_parameters_hash_equality rw
.allow_deprecated_parameters_hash_equality=(value) rw
.always_permitted_parameters (also: #always_permitted_parameters) rw

By default, never raise an UnpermittedParameters exception if these params are present.
.permit_all_parameters rw

Class Method Summary

.new(parameters = {}, logging_context = {}) ⇒ Parameters constructor

Returns a new Parameters instance.
.hook_into_yaml_loading Internal use only
.nested_attribute?(key, value) ⇒ Boolean Internal use only

Instance Attribute Summary

#always_permitted_parameters rw
#each_key(&block) readonly

Calls block once for each key in the parameters, passing the key.
#has_key? readonly

Alias for #include?.
#key? readonly

Alias for #include?.
#keys readonly

Returns a new array of the keys of the parameters.
#member? readonly

Alias for #include?.
#permitted? ⇒ Boolean rw

Returns true if the parameter is permitted, false otherwise.
#nested_attributes? ⇒ Boolean readonly protected
#parameters readonly protected
#permitted=(value) rw protected

Instance Method Summary

#==(other)

Returns true if another Parameters object contains the same content and permitted flag.
#[](key)

Returns a parameter for the given key.
#[]=(key, value)

Assigns a value to a given key.
#as_json(options = nil)

Returns a hash that can be used as the JSON representation for the parameters.
#compact

Returns a new Parameters instance with nil values removed.
#compact!

Removes all nil values in place and returns self, or nil if no changes were made.
#compact_blank

Returns a new Parameters instance without the blank values.
#compact_blank!

Removes all blank values in place and returns self.
#converted_arrays

Attribute that keeps track of converted arrays, if any, to avoid double looping in the common use case permit + mass-assignment.
#deep_dup

Returns a duplicate Parameters instance with the same permitted parameters.
#deep_merge(other_hash, &block)

Returns a new Parameters instance with self and other_hash merged recursively.
#deep_merge!(other_hash, &block)

Same as #deep_merge, but modifies self.
#deep_transform_keys(&block)

Returns a new Parameters instance with the results of running block once for every key.
#deep_transform_keys!(&block)

Returns the same Parameters instance with changed keys.
#delete(key, &block)

Deletes a key-value pair from Parameters and returns the value.
#delete_if(&block)

Alias for #reject!.
#dig(*keys)

Extracts the nested parameter from the given #keys by calling dig at each step.
#each(&block)

Alias for #each_pair.
#each_pair(&block) (also: #each)

Convert all hashes in values into parameters, then yield each pair in the same way as Hash#each_pair.
#each_value(&block)

Convert all hashes in values into parameters, then yield each value in the same way as Hash#each_value.
#empty? ⇒ Boolean

Returns true if the parameters have no key/value pairs.
#eql?(other) ⇒ Boolean
#except(*keys) (also: #without)

Returns a new Parameters instance that filters out the given #keys.
#exclude?(key) ⇒ Boolean

Returns true if the given key is not present in the parameters.
#extract!(*keys)

Removes and returns the key/value pairs matching the given keys.
#extract_value(key, delimiter: "_")

Returns parameter value for the given key separated by delimiter.
#fetch(key, *args)

Returns a parameter for the given key.
#has_value?(value) ⇒ Boolean (also: #value?)

Returns true if the given value is present for some key in the parameters.
#hash
#include?(key) ⇒ Boolean (also: #has_key?, #key?, #member?)

Returns true if the given key is present in the parameters.
#inspect
#keep_if(&block)

Alias for #select!.
#merge(other_hash)

Returns a new Parameters instance with all keys from other_hash merged into current hash.
#merge!(other_hash)

Returns the current Parameters instance with other_hash merged into current hash.
#permit(*filters)

Returns a new Parameters instance that includes only the given filters and sets the permitted attribute for the object to true.
#permit!

Sets the permitted attribute to true.
#reject(&block)

Returns a new Parameters instance with items that the block evaluates to true removed.
#reject!(&block) (also: #delete_if)

Removes items that the block evaluates to true and returns self.
#require(key) (also: #required)

This method accepts both a single key and an array of keys.
#required(key)

Alias for #require.
#reverse_merge(other_hash) (also: #with_defaults)

Returns a new Parameters instance with all keys from current hash merged into other_hash.
#reverse_merge!(other_hash) (also: #with_defaults!)

Returns the current Parameters instance with current hash merged into other_hash.
#select(&block)

Returns a new Parameters instance with only items that the block evaluates to true.
#select!(&block) (also: #keep_if)

Equivalent to Hash#keep_if, but returns nil if no changes were made.
#slice(*keys)

Returns a new Parameters instance that includes only the given #keys.
#slice!(*keys)

Returns the current Parameters instance which contains only the given #keys.
#to_h(&block)

Returns a safe ::ActiveSupport::HashWithIndifferentAccess representation of the parameters with all unpermitted keys removed.
#to_hash

Returns a safe ::Hash representation of the parameters with all unpermitted keys removed.
#to_param(*args)

Alias for #to_query.
#to_query(*args) (also: #to_param)

Returns a string representation of the receiver suitable for use as a URL query string:
#to_s ⇒ ?

Returns the content of the parameters as a string.
#to_unsafe_h (also: #to_unsafe_hash)

Returns an unsafe, unfiltered ::ActiveSupport::HashWithIndifferentAccess representation of the parameters.
#to_unsafe_hash

Alias for #to_unsafe_h.
#transform_keys(&block)

Returns a new Parameters instance with the results of running block once for every key.
#transform_keys!(&block)

Performs keys transformation and returns the altered Parameters instance.
#transform_values

Returns a new Parameters instance with the results of running block once for every value.
#transform_values!

Performs values transformation and returns the altered Parameters instance.
#value?(value)

Alias for #has_value?.
#values

Returns a new array of the values of the parameters.
#values_at(*keys)

Returns values that were assigned to the given #keys.
#with_defaults(other_hash)

Alias for #reverse_merge.
#with_defaults!(other_hash)

Alias for #reverse_merge!.
#without(*keys)

Alias for #except.
#each_nested_attribute protected
#_deep_transform_keys_in_object(object, &block) private
#_deep_transform_keys_in_object!(object, &block) private
#array_of_permitted_scalars?(value) ⇒ Boolean private
#convert_hashes_to_parameters(key, value) private
#convert_parameters_to_hashes(value, using, &block) private
#convert_value_to_parameters(value) private
#each_element(object, filter, &block) private
#hash_filter(params, filter) private
#initialize_copy(source) private
#new_instance_with_inherited_permitted_status(hash) private
#non_scalar?(value) ⇒ Boolean private
#permit_any_in_array(array) private
#permit_any_in_parameters(params) private
#permitted_scalar?(value) ⇒ Boolean private
#permitted_scalar_filter(params, permitted_key) private

Adds existing keys to the params if their values are scalar.
#specify_numeric_keys?(filter) ⇒ Boolean private
#unpermitted_keys(params) private
#unpermitted_parameters!(params) private
#deep_merge?(other_hash) ⇒ Boolean Internal use only
#encode_with(coder) Internal use only
#init_with(coder) Internal use only
#stringify_keys Internal use only

This is required by ::ActiveModel attribute assignment, so that user can pass Parameters to a mass assignment methods in a model.

`::ActiveSupport::DeepMergeable` - Included

#deep_merge	Returns a new instance with the values from `other` merged recursively.
#deep_merge!	Same as #deep_merge, but modifies `self`.
#deep_merge?	Returns true if `other` can be deep merged into `self`.

Constructor Details

.new(parameters = {}, logging_context = {}) ⇒ `Parameters`

Returns a new Parameters instance. Also, sets the permitted attribute to the default value of .permit_all_parameters.

class Person < ActiveRecord::Base
end

params = ActionController::Parameters.new(name: "Francesco")
params.permitted?  # => false
Person.new(params) # => ActiveModel::ForbiddenAttributesError

ActionController::Parameters.permit_all_parameters = true

params = ActionController::Parameters.new(name: "Francesco")
params.permitted?  # => true
Person.new(params) # => #<Person id: nil, name: "Francesco">

[ GitHub ]

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


def initialize(parameters = {}, logging_context = {})
  parameters.each_key do |key|
    unless key.is_a?(String) || key.is_a?(Symbol)
      raise InvalidParameterKey, "all keys must be Strings or Symbols, got: #{key.class}"
    end
  end

  @parameters = parameters.with_indifferent_access
  @logging_context = logging_context
  @permitted = self.class.permit_all_parameters
end

Class Attribute Details

.action_on_unpermitted_parameters (rw)

[ GitHub ]

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


cattr_accessor :action_on_unpermitted_parameters, instance_accessor: false

.allow_deprecated_parameters_hash_equality (rw)

[ GitHub ]

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


def allow_deprecated_parameters_hash_equality
  ActionController.deprecator.warn <<-WARNING.squish
    `Rails.application.config.action_controller.allow_deprecated_parameters_hash_equality` is
    deprecated and will be removed in Rails 7.3.
  WARNING
end

.allow_deprecated_parameters_hash_equality=(value) (rw)

[ GitHub ]

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


def allow_deprecated_parameters_hash_equality=(value)
  ActionController.deprecator.warn <<-WARNING.squish
    `Rails.application.config.action_controller.allow_deprecated_parameters_hash_equality`
    is deprecated and will be removed in Rails 7.3.
  WARNING
end

.always_permitted_parameters (rw) Also known as: #always_permitted_parameters

By default, never raise an UnpermittedParameters exception if these params are present. The default includes both ‘controller’ and ‘action’ because they are added by ::Rails and should be of no concern. One way to change these is to specify always_permitted_parameters in your config. For instance:

config.action_controller.always_permitted_parameters = %w( controller action format )

[ GitHub ]

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


cattr_accessor :always_permitted_parameters, default: %w( controller action )

.permit_all_parameters (rw)

[ GitHub ]

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


cattr_accessor :permit_all_parameters, instance_accessor: false, default: false

Class Method Details

.hook_into_yaml_loading

This method is for internal use only.

[ GitHub ]

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


def self.hook_into_yaml_loading # :nodoc:
  # Wire up YAML format compatibility with Rails 4.2 and Psych 2.0.8 and 2.0.9+.
  # Makes the YAML parser call `init_with` when it encounters the keys below
  # instead of trying its own parsing routines.
  YAML.load_tags["!ruby/hash-with-ivars:ActionController::Parameters"] = name
  YAML.load_tags["!ruby/hash:ActionController::Parameters"] = name
end

.nested_attribute?(key, value) ⇒ `Boolean`

This method is for internal use only.

[ GitHub ]

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


def nested_attribute?(key, value) # :nodoc:
  /\A-?\d+\z/.match?(key) && (value.is_a?(Hash) || value.is_a?(Parameters))
end

Instance Attribute Details

#always_permitted_parameters (rw)

[ GitHub ]

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


cattr_accessor :always_permitted_parameters, default: %w( controller action )

#each_key(&block) (readonly)

Calls block once for each key in the parameters, passing the key. If no block is given, an enumerator is returned instead.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#has_key? (readonly)

Alias for #include?.

[ GitHub ]

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


alias_method :has_key?, :include?

#key? (readonly)

Alias for #include?.

[ GitHub ]

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


alias_method :key?, :include?

#keys (readonly)

Returns a new array of the keys of the parameters.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#member? (readonly)

Alias for #include?.

[ GitHub ]

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


alias_method :member?, :include?

#nested_attributes? ⇒ `Boolean` (readonly, protected)

[ GitHub ]

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


def nested_attributes?
  @parameters.any? { |k, v| Parameters.nested_attribute?(k, v) }
end

#parameters (readonly, protected)

[ GitHub ]

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


attr_reader :parameters

#permitted=(value) (rw, protected)

[ GitHub ]

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


attr_writer :permitted

#permitted? ⇒ `Boolean` (rw)

Returns true if the parameter is permitted, false otherwise.

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

[ GitHub ]

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


def permitted?
  @permitted
end

Instance Method Details

#==(other)

Returns true if another Parameters object contains the same content and permitted flag.

[ GitHub ]

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


def ==(other)
  if other.respond_to?(:permitted?)
    permitted? == other.permitted? && parameters == other.parameters
  else
    super
  end
end

#[](key)

Returns a parameter for the given key. If not found, returns nil.

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

[ GitHub ]

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


def [](key)
  convert_hashes_to_parameters(key, @parameters[key])
end

#[]=(key, value)

Assigns a value to a given key. The given key may still get filtered out when #permit is called.

[ GitHub ]

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


def []=(key, value)
  @parameters[key] = value
end

#_deep_transform_keys_in_object(object, &block) (private)

[ GitHub ]

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


def _deep_transform_keys_in_object(object, &block)
  case object
  when Hash
    object.each_with_object(self.class.new) do |(key, value), result|
      result[yield(key)] = _deep_transform_keys_in_object(value, &block)
    end
  when Parameters
    if object.permitted?
      object.to_h.deep_transform_keys(&block)
    else
      object.to_unsafe_h.deep_transform_keys(&block)
    end
  when Array
    object.map { |e| _deep_transform_keys_in_object(e, &block) }
  else
    object
  end
end

#_deep_transform_keys_in_object!(object, &block) (private)

[ GitHub ]

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


def _deep_transform_keys_in_object!(object, &block)
  case object
  when Hash
    object.keys.each do |key|
      value = object.delete(key)
      object[yield(key)] = _deep_transform_keys_in_object!(value, &block)
    end
    object
  when Parameters
    if object.permitted?
      object.to_h.deep_transform_keys!(&block)
    else
      object.to_unsafe_h.deep_transform_keys!(&block)
    end
  when Array
    object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
  else
    object
  end
end

#array_of_permitted_scalars?(value) ⇒ `Boolean` (private)

[ GitHub ]

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


def array_of_permitted_scalars?(value)
  if value.is_a?(Array) && value.all? { |element| permitted_scalar?(element) }
    yield value
  end
end

#as_json(options = nil)

Returns a hash that can be used as the JSON representation for the parameters.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#compact

Returns a new Parameters instance with nil values removed.

[ GitHub ]

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


def compact
  new_instance_with_inherited_permitted_status(@parameters.compact)
end

#compact!

Removes all nil values in place and returns self, or nil if no changes were made.

[ GitHub ]

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


def compact!
  self if @parameters.compact!
end

#compact_blank

Returns a new Parameters instance without the blank values. Uses Object#blank? for determining if a value is blank.

[ GitHub ]

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


def compact_blank
  reject { |_k, v| v.blank? }
end

#compact_blank!

Removes all blank values in place and returns self. Uses Object#blank? for determining if a value is blank.

[ GitHub ]

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


def compact_blank!
  reject! { |_k, v| v.blank? }
end

#convert_hashes_to_parameters(key, value) (private)

[ GitHub ]

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


def convert_hashes_to_parameters(key, value)
  converted = convert_value_to_parameters(value)
  @parameters[key] = converted unless converted.equal?(value)
  converted
end

#convert_parameters_to_hashes(value, using, &block) (private)

[ GitHub ]

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


def convert_parameters_to_hashes(value, using, &block)
  case value
  when Array
    value.map { |v| convert_parameters_to_hashes(v, using) }
  when Hash
    transformed = value.transform_values do |v|
      convert_parameters_to_hashes(v, using)
    end
    (block_given? ? transformed.to_h(&block) : transformed).with_indifferent_access
  when Parameters
    value.send(using)
  else
    value
  end
end

#convert_value_to_parameters(value) (private)

[ GitHub ]

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


def convert_value_to_parameters(value)
  case value
  when Array
    return value if converted_arrays.member?(value)
    converted = value.map { |_| convert_value_to_parameters(_) }
    converted_arrays << converted.dup
    converted
  when Hash
    self.class.new(value, @logging_context)
  else
    value
  end
end

#converted_arrays

Attribute that keeps track of converted arrays, if any, to avoid double looping in the common use case permit + mass-assignment. Defined in a method to instantiate it only if needed.

Testing membership still loops, but it’s going to be faster than our own loop that converts values. Also, we are not going to build a new array object per fetch.

[ GitHub ]

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


def converted_arrays
  @converted_arrays ||= Set.new
end

#deep_dup

Returns a duplicate Parameters instance with the same permitted parameters.

[ GitHub ]

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


def deep_dup
  self.class.new(@parameters.deep_dup, @logging_context).tap do |duplicate|
    duplicate.permitted = @permitted
  end
end

#deep_merge(other_hash, &block)

Returns a new Parameters instance with self and other_hash merged recursively.

Like with Hash#merge in the standard library, a block can be provided to merge values.

[ GitHub ]

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


rdoc_method :method: deep_merge

#deep_merge!(other_hash, &block)

Same as #deep_merge, but modifies self.

[ GitHub ]

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


rdoc_method :method: deep_merge!

#deep_merge?(other_hash) ⇒ `Boolean`

This method is for internal use only.

[ GitHub ]

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


def deep_merge?(other_hash) # :nodoc:
  other_hash.is_a?(ActiveSupport::DeepMergeable)
end

#deep_transform_keys(&block)

Returns a new Parameters instance with the results of running block once for every key. This includes the keys from the root hash and from all nested hashes and arrays. The values are unchanged.

[ GitHub ]

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


def deep_transform_keys(&block)
  new_instance_with_inherited_permitted_status(
    _deep_transform_keys_in_object(@parameters, &block).to_unsafe_h
  )
end

#deep_transform_keys!(&block)

Returns the same Parameters instance with changed keys. This includes the keys from the root hash and from all nested hashes and arrays. The values are unchanged.

[ GitHub ]

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


def deep_transform_keys!(&block)
  @parameters = _deep_transform_keys_in_object(@parameters, &block).to_unsafe_h
  self
end

#delete(key, &block)

Deletes a key-value pair from Parameters and returns the value. If key is not found, returns nil (or, with optional code block, yields key and returns the result). This method is similar to #extract!, which returns the corresponding Parameters object.

[ GitHub ]

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


def delete(key, &block)
  convert_value_to_parameters(@parameters.delete(key, &block))
end

#delete_if(&block)

Alias for #reject!.

[ GitHub ]

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


alias_method :delete_if, :reject!

#dig(*keys)

Extracts the nested parameter from the given #keys by calling dig at each step. Returns nil if any intermediate step is 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

[ GitHub ]

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


def dig(*keys)
  convert_hashes_to_parameters(keys.first, @parameters[keys.first])
  @parameters.dig(*keys)
end

#each(&block)

Alias for #each_pair.

[ GitHub ]

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


alias_method :each, :each_pair

#each_element(object, filter, &block) (private)

[ GitHub ]

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


def each_element(object, filter, &block)
  case object
  when Array
    object.grep(Parameters).filter_map(&block)
  when Parameters
    if object.nested_attributes? && !specify_numeric_keys?(filter)
      object.each_nested_attribute(&block)
    else
      yield object
    end
  end
end

#each_nested_attribute (protected)

[ GitHub ]

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


def each_nested_attribute
  hash = self.class.new
  self.each { |k, v| hash[k] = yield v if Parameters.nested_attribute?(k, v) }
  hash
end

#each_pair(&block) Also known as: #each

Convert all hashes in values into parameters, then yield each pair in the same way as Hash#each_pair.

[ GitHub ]

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


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

#each_value(&block)

Convert all hashes in values into parameters, then yield each value in the same way as Hash#each_value.

[ GitHub ]

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


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

#empty? ⇒ `Boolean`

Returns true if the parameters have no key/value pairs.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#encode_with(coder)

This method is for internal use only.

[ GitHub ]

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


def encode_with(coder) # :nodoc:
  coder.map = { "parameters" => @parameters, "permitted" => @permitted }
end

#eql?(other) ⇒ `Boolean`

[ GitHub ]

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


def eql?(other)
  self.class == other.class &&
    permitted? == other.permitted? &&
    parameters.eql?(other.parameters)
end

#except(*keys) Also known as: #without

Returns a new Parameters instance that filters out the given #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>

[ GitHub ]

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


def except(*keys)
  new_instance_with_inherited_permitted_status(@parameters.except(*keys))
end

#exclude?(key) ⇒ `Boolean`

Returns true if the given key is not present in the parameters.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#extract!(*keys)

Removes and returns the key/value pairs matching the given keys.

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>

[ GitHub ]

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


def extract!(*keys)
  new_instance_with_inherited_permitted_status(@parameters.extract!(*keys))
end

#extract_value(key, delimiter: "_")

Returns parameter value for the given key separated by delimiter.

params = ActionController::Parameters.new(id: "1_123", tags: "ruby,rails")
params.extract_value(:id) # => ["1", "123"]
params.extract_value(:tags, delimiter: ",") # => ["ruby", "rails"]
params.extract_value(:non_existent_key) # => nil

Note that if the given key‘s value contains blank elements, then the returned array will include empty strings.

params = ActionController::Parameters.new(tags: "ruby,rails,,web")
params.extract_value(:tags) # => ["ruby", "rails", "", "web"]

[ GitHub ]

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


def extract_value(key, delimiter: "_")
  @parameters[key]&.split(delimiter, -1)
end

#fetch(key, *args)

Returns a parameter for the given key. If the key can’t be found, there are several options: With no other arguments, it will raise an ParameterMissing error; if a second argument is given, then that is returned (converted to an instance of Parameters if possible); if a block is given, then that will be run and its result returned.

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"

[ GitHub ]

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


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

#has_value?(value) ⇒ `Boolean` Also known as: #value?

Returns true if the given value is present for some key in the parameters.

[ GitHub ]

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


def has_value?(value)
  each_value.include?(convert_value_to_parameters(value))
end

#hash

[ GitHub ]

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


def hash
  [self.class, @parameters, @permitted].hash
end

#hash_filter(params, filter) (private)

[ GitHub ]

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


def hash_filter(params, filter)
  filter = filter.with_indifferent_access

  # Slicing filters out non-declared keys.
  slice(*filter.keys).each do |key, value|
    next unless value
    next unless has_key? key

    if filter[key] == EMPTY_ARRAY
      # Declaration { comment_ids: [] }.
      array_of_permitted_scalars?(self[key]) do |val|
        params[key] = val
      end
    elsif filter[key] == EMPTY_HASH
      # Declaration { preferences: {} }.
      if value.is_a?(Parameters)
        params[key] = permit_any_in_parameters(value)
      end
    elsif non_scalar?(value)
      # Declaration { user: :name } or { user: [:name, :age, { address: ... }] }.
      params[key] = each_element(value, filter[key]) do |element|
        element.permit(*Array.wrap(filter[key]))
      end
    end
  end
end

#include?(key) ⇒ `Boolean` Also known as: #has_key?, #key?, #member?

Returns true if the given key is present in the parameters.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#init_with(coder)

This method is for internal use only.

[ GitHub ]

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


def init_with(coder) # :nodoc:
  case coder.tag
  when "!ruby/hash:ActionController::Parameters"
    # YAML 2.0.8's format where hash instance variables weren't stored.
    @parameters = coder.map.with_indifferent_access
    @permitted  = false
  when "!ruby/hash-with-ivars:ActionController::Parameters"
    # YAML 2.0.9's Hash subclass format where keys and values were stored under an
    # elements hash and `permitted` within an ivars hash.
    @parameters = coder.map["elements"].with_indifferent_access
    @permitted  = coder.map["ivars"][:@permitted]
  when "!ruby/object:ActionController::Parameters"
    # YAML's Object format. Only needed because of the format backwards
    # compatibility above, otherwise equivalent to YAML's initialization.
    @parameters, @permitted = coder.map["parameters"], coder.map["permitted"]
  end
end

#initialize_copy(source) (private)

[ GitHub ]

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


def initialize_copy(source)
  super
  @parameters = @parameters.dup
end

#inspect

[ GitHub ]

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


def inspect
  "#<#{self.class} #{@parameters} permitted: #{@permitted}>"
end

#keep_if(&block)

Alias for #select!.

[ GitHub ]

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


alias_method :keep_if, :select!

#merge(other_hash)

Returns a new Parameters instance with all keys from other_hash merged into current hash.

[ GitHub ]

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


def merge(other_hash)
  new_instance_with_inherited_permitted_status(
    @parameters.merge(other_hash.to_h)
  )
end

#merge!(other_hash)

Returns the current Parameters instance with other_hash merged into current hash.

[ GitHub ]

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


def merge!(other_hash, &block)
  @parameters.merge!(other_hash.to_h, &block)
  self
end

#new_instance_with_inherited_permitted_status(hash) (private)

[ GitHub ]

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


def new_instance_with_inherited_permitted_status(hash)
  self.class.new(hash, @logging_context).tap do |new_instance|
    new_instance.permitted = @permitted
  end
end

#non_scalar?(value) ⇒ `Boolean` (private)

[ GitHub ]

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


def non_scalar?(value)
  value.is_a?(Array) || value.is_a?(Parameters)
end

#permit(*filters)

Returns a new Parameters instance that includes only the given filters and sets the permitted attribute for the object to true. This is useful for limiting which attributes should be allowed for mass updating.

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

Only permitted scalars pass the filter. For example, given

params.permit(:name)

:name passes if it is a key of params whose associated value is of type ::String, ::Symbol, ::NilClass, ::Numeric, ::TrueClass, ::FalseClass, ::Date, ::Time, ::DateTime, StringIO, ::IO, ::ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile. Otherwise, the key :name is filtered out.

You may declare that the parameter should be an array of permitted scalars by mapping it to an empty array:

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

Sometimes it is not possible or convenient to declare the valid keys of a hash parameter or its internal structure. Just map to an empty hash:

params.permit(preferences: {})

Be careful because this opens the door to arbitrary input. In this case, permit ensures values in the returned structure are permitted scalars and filters out anything else.

You can also use permit on nested parameters, like:

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

Note that if you use permit in a key that points to a hash, it won’t allow all the hash. You also need to specify which attributes inside the hash should be permitted.

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>

If your parameters specify multiple parameters indexed by a number, you can permit each set of parameters under the numeric key to be the same using the same syntax as permitting a single item.

params = ActionController::Parameters.new({
  person: {
    '0': {
      email: "none@test.com",
      phone: "555-1234"
    },
    '1': {
      email: "nothing@test.com",
      phone: "555-6789"
    },
  }
})
params.permit(person: [:email]).to_h
# => {"person"=>{"0"=>{"email"=>"none@test.com"}, "1"=>{"email"=>"nothing@test.com"}}}

If you want to specify what keys you want from each numeric key, you can instead specify each one individually

params = ActionController::Parameters.new({
  person: {
    '0': {
      email: "none@test.com",
      phone: "555-1234"
    },
    '1': {
      email: "nothing@test.com",
      phone: "555-6789"
    },
  }
})
params.permit(person: { '0': [:email], '1': [:phone]}).to_h
# => {"person"=>{"0"=>{"email"=>"none@test.com"}, "1"=>{"phone"=>"555-6789"}}}

[ GitHub ]

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


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

#permit!

Sets the permitted attribute to true. This can be used to pass mass assignment. Returns 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">

[ GitHub ]

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


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

#permit_any_in_array(array) (private)

[ GitHub ]

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


def permit_any_in_array(array)
  [].tap do |sanitized|
    array.each do |element|
      case element
      when ->(e) { permitted_scalar?(e) }
        sanitized << element
      when Array
        sanitized << permit_any_in_array(element)
      when Parameters
        sanitized << permit_any_in_parameters(element)
      else
        # Filter this one out.
      end
    end
  end
end

#permit_any_in_parameters(params) (private)

[ GitHub ]

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


def permit_any_in_parameters(params)
  self.class.new.tap do |sanitized|
    params.each do |key, value|
      case value
      when ->(v) { permitted_scalar?(v) }
        sanitized[key] = value
      when Array
        sanitized[key] = permit_any_in_array(value)
      when Parameters
        sanitized[key] = permit_any_in_parameters(value)
      else
        # Filter this one out.
      end
    end
  end
end

#permitted_scalar?(value) ⇒ `Boolean` (private)

[ GitHub ]

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


def permitted_scalar?(value)
  PERMITTED_SCALAR_TYPES.any? { |type| value.is_a?(type) }
end

#permitted_scalar_filter(params, permitted_key) (private)

Adds existing keys to the params if their values are scalar.

For example:

puts self.keys #=> ["zipcode(90210i)"]
params = {}

permitted_scalar_filter(params, "zipcode")

puts params.keys # => ["zipcode"]

[ GitHub ]

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


def permitted_scalar_filter(params, permitted_key)
  permitted_key = permitted_key.to_s

  if has_key?(permitted_key) && permitted_scalar?(self[permitted_key])
    params[permitted_key] = self[permitted_key]
  end

  each_key do |key|
    next unless key =~ /\(\d+[if]?\)\z/
    next unless $~.pre_match == permitted_key

    params[key] = self[key] if permitted_scalar?(self[key])
  end
end

#reject(&block)

Returns a new Parameters instance with items that the block evaluates to true removed.

[ GitHub ]

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


def reject(&block)
  new_instance_with_inherited_permitted_status(@parameters.reject(&block))
end

#reject!(&block) Also known as: #delete_if

Removes items that the block evaluates to true and returns self.

[ GitHub ]

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


def reject!(&block)
  @parameters.reject!(&block)
  self
end

#require(key) Also known as: #required

This method accepts both a single key and an array of keys.

When passed a single key, if it exists and its associated value is either present or the singleton false, returns said value:

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

Otherwise raises 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

When given an array of keys, the method tries to require each one of them in order. If it succeeds, an array with the respective return values is returned:

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

Otherwise, the method re-raises the first exception found:

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

Technically this method can be used to fetch terminal values:

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

but take into account that at some point those ones have to be permitted:

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

for example.

[ GitHub ]

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


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

#required(key)

Alias for #require.

[ GitHub ]

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


alias :required :require

#reverse_merge(other_hash) Also known as: #with_defaults

Returns a new Parameters instance with all keys from current hash merged into other_hash.

[ GitHub ]

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


def reverse_merge(other_hash)
  new_instance_with_inherited_permitted_status(
    other_hash.to_h.merge(@parameters)
  )
end

#reverse_merge!(other_hash) Also known as: #with_defaults!

Returns the current Parameters instance with current hash merged into other_hash.

[ GitHub ]

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


def reverse_merge!(other_hash)
  @parameters.merge!(other_hash.to_h) { |key, left, right| left }
  self
end

#select(&block)

Returns a new Parameters instance with only items that the block evaluates to true.

[ GitHub ]

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


def select(&block)
  new_instance_with_inherited_permitted_status(@parameters.select(&block))
end

#select!(&block) Also known as: #keep_if

Equivalent to Hash#keep_if, but returns nil if no changes were made.

[ GitHub ]

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


def select!(&block)
  @parameters.select!(&block)
  self
end

#slice(*keys)

Returns a new Parameters instance that includes only the given #keys. If the given #keys don’t exist, returns an empty hash.

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>

[ GitHub ]

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


def slice(*keys)
  new_instance_with_inherited_permitted_status(@parameters.slice(*keys))
end

#slice!(*keys)

Returns the current Parameters instance which contains only the given #keys.

[ GitHub ]

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


def slice!(*keys)
  @parameters.slice!(*keys)
  self
end

#specify_numeric_keys?(filter) ⇒ `Boolean` (private)

[ GitHub ]

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


def specify_numeric_keys?(filter)
  if filter.respond_to?(:keys)
    filter.keys.any? { |key| /\A-?\d+\z/.match?(key) }
  end
end

#stringify_keys

This method is for internal use only.

This is required by ::ActiveModel attribute assignment, so that user can pass Parameters to a mass assignment methods in a model. It should not matter as we are using HashWithIndifferentAccess internally.

[ GitHub ]

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


def stringify_keys # :nodoc:
  dup
end

#to_h(&block)

Returns a safe ::ActiveSupport::HashWithIndifferentAccess representation of the parameters with all unpermitted keys removed.

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"}

[ GitHub ]

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


def to_h(&block)
  if permitted?
    convert_parameters_to_hashes(@parameters, :to_h, &block)
  else
    raise UnfilteredParameters
  end
end

#to_hash

Returns a safe ::Hash representation of the parameters with all unpermitted keys removed.

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"}

[ GitHub ]

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


def to_hash
  to_h.to_hash
end

#to_param(*args)

Alias for #to_query.

[ GitHub ]

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


alias_method :to_param, :to_query

#to_query(*args) Also known as: #to_param

Returns a string representation of the receiver suitable for use as a URL query string:

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"

An optional namespace can be passed to enclose key names:

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"

The string pairs "key=value" that conform the query string are sorted lexicographically in ascending order.

[ GitHub ]

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


def to_query(*args)
  to_h.to_query(*args)
end

#to_s ⇒ ?

Returns the content of the parameters as a string.

[ GitHub ]

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


delegate :keys, :empty?, :exclude?, :include?,
  :as_json, :to_s, :each_key, to: :@parameters

#to_unsafe_h Also known as: #to_unsafe_hash

Returns an unsafe, unfiltered ::ActiveSupport::HashWithIndifferentAccess representation of the parameters.

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

[ GitHub ]

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


def to_unsafe_h
  convert_parameters_to_hashes(@parameters, :to_unsafe_h)
end

#to_unsafe_hash

Alias for #to_unsafe_h.

[ GitHub ]

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


alias_method :to_unsafe_hash, :to_unsafe_h

#transform_keys(&block)

Returns a new Parameters instance with the results of running block once for every key. The values are unchanged.

[ GitHub ]

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


def transform_keys(&block)
  return to_enum(:transform_keys) unless block_given?
  new_instance_with_inherited_permitted_status(
    @parameters.transform_keys(&block)
  )
end

#transform_keys!(&block)

Performs keys transformation and returns the altered Parameters instance.

[ GitHub ]

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


def transform_keys!(&block)
  return to_enum(:transform_keys!) unless block_given?
  @parameters.transform_keys!(&block)
  self
end

#transform_values

Returns a new Parameters instance with the results of running block once for every value. The keys are unchanged.

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>

[ GitHub ]

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


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

#transform_values!

Performs values transformation and returns the altered Parameters instance.

[ GitHub ]

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


def transform_values!
  return to_enum(:transform_values!) unless block_given?
  @parameters.transform_values! { |v| yield convert_value_to_parameters(v) }
  self
end

#unpermitted_keys(params) (private)

[ GitHub ]

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


def unpermitted_keys(params)
  keys - params.keys - always_permitted_parameters
end

#unpermitted_parameters!(params) (private)

[ GitHub ]

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


def unpermitted_parameters!(params)
  unpermitted_keys = unpermitted_keys(params)
  if unpermitted_keys.any?
    case self.class.action_on_unpermitted_parameters
    when :log
      name = "unpermitted_parameters.action_controller"
      ActiveSupport::Notifications.instrument(name, keys: unpermitted_keys, context: @logging_context)
    when :raise
      raise ActionController::UnpermittedParameters.new(unpermitted_keys)
    end
  end
end

#value?(value)

Alias for #has_value?.

[ GitHub ]

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


alias value? has_value?

#values

Returns a new array of the values of the parameters.

[ GitHub ]

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


def values
  to_enum(:each_value).to_a
end

#values_at(*keys)

Returns values that were assigned to the given #keys. Note that all the ::Hash objects will be converted to Parameters.

[ GitHub ]

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


def values_at(*keys)
  convert_value_to_parameters(@parameters.values_at(*keys))
end

#with_defaults(other_hash)

Alias for #reverse_merge.

[ GitHub ]

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


alias_method :with_defaults, :reverse_merge

#with_defaults!(other_hash)

Alias for #reverse_merge!.

[ GitHub ]

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


alias_method :with_defaults!, :reverse_merge!

#without(*keys)

Alias for #except.

[ GitHub ]

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


alias_method :without, :except

Class: ActionController::Parameters

Overview

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::ActiveSupport::DeepMergeable - Included

Constructor Details

.new(parameters = {}, logging_context = {}) ⇒ Parameters

Class Attribute Details

.action_on_unpermitted_parameters (rw)

.allow_deprecated_parameters_hash_equality (rw)

.allow_deprecated_parameters_hash_equality=(value) (rw)

.always_permitted_parameters (rw) Also known as: #always_permitted_parameters

.permit_all_parameters (rw)

Class Method Details

.hook_into_yaml_loading

.nested_attribute?(key, value) ⇒ Boolean

Instance Attribute Details

#always_permitted_parameters (rw)

#each_key(&block) (readonly)

#has_key? (readonly)

#key? (readonly)

#keys (readonly)

#member? (readonly)

#nested_attributes? ⇒ Boolean (readonly, protected)

#parameters (readonly, protected)

#permitted=(value) (rw, protected)

#permitted? ⇒ Boolean (rw)

Instance Method Details

#==(other)

#[](key)

#[]=(key, value)

#_deep_transform_keys_in_object(object, &block) (private)

#_deep_transform_keys_in_object!(object, &block) (private)

#array_of_permitted_scalars?(value) ⇒ Boolean (private)

#as_json(options = nil)

#compact

#compact!

#compact_blank

#compact_blank!

#convert_hashes_to_parameters(key, value) (private)

#convert_parameters_to_hashes(value, using, &block) (private)

#convert_value_to_parameters(value) (private)

#converted_arrays

#deep_dup

#deep_merge(other_hash, &block)

#deep_merge!(other_hash, &block)

#deep_merge?(other_hash) ⇒ Boolean

#deep_transform_keys(&block)

#deep_transform_keys!(&block)

#delete(key, &block)

#delete_if(&block)

#dig(*keys)

#each(&block)

#each_element(object, filter, &block) (private)

#each_nested_attribute (protected)

#each_pair(&block) Also known as: #each

#each_value(&block)

#empty? ⇒ Boolean

#encode_with(coder)

#eql?(other) ⇒ Boolean

#except(*keys) Also known as: #without

#exclude?(key) ⇒ Boolean

#extract!(*keys)

#extract_value(key, delimiter: "_")

#fetch(key, *args)

#has_value?(value) ⇒ Boolean Also known as: #value?

#hash

#hash_filter(params, filter) (private)

#include?(key) ⇒ Boolean Also known as: #has_key?, #key?, #member?

#init_with(coder)

#initialize_copy(source) (private)

#inspect

#keep_if(&block)

#merge(other_hash)

#merge!(other_hash)

#new_instance_with_inherited_permitted_status(hash) (private)

#non_scalar?(value) ⇒ Boolean (private)

`::ActiveSupport::DeepMergeable` - Included

.new(parameters = {}, logging_context = {}) ⇒ `Parameters`

.nested_attribute?(key, value) ⇒ `Boolean`

#nested_attributes? ⇒ `Boolean` (readonly, protected)

#permitted? ⇒ `Boolean` (rw)

#array_of_permitted_scalars?(value) ⇒ `Boolean` (private)

#deep_merge?(other_hash) ⇒ `Boolean`

#empty? ⇒ `Boolean`

#eql?(other) ⇒ `Boolean`

#exclude?(key) ⇒ `Boolean`

#has_value?(value) ⇒ `Boolean` Also known as: #value?

#include?(key) ⇒ `Boolean` Also known as: #has_key?, #key?, #member?

#non_scalar?(value) ⇒ `Boolean` (private)

#permitted_scalar?(value) ⇒ `Boolean` (private)

#specify_numeric_keys?(filter) ⇒ `Boolean` (private)