Class: ActionController::Parameters

Inherits:
Object
  • Object
show all
Defined in:
lib/action_controller/metal/strong_parameters.rb

Overview

Action Controller Parameters

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 - Allow to control the behavior when parameters that are not explicitly permitted are found. The values can be false to just filter them out, :log to additionally write a message on the logger, or :raise to raise ActionController::UnpermittedParameters exception. The default value is :log in test and development environments, false otherwise.

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 ActionController::Parameters using either :key or "key".

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parameters = {}) ⇒ Parameters

Returns a new instance of ActionController::Parameters. Also, sets the permitted attribute to the default value of ActionController::Parameters.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">



280
281
282
283
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 280

def initialize(parameters = {})
  @parameters = parameters.with_indifferent_access
  @permitted = self.class.permit_all_parameters
end

Class Method Details

.hook_into_yaml_loading ⇒ Object

:nodoc:



861
862
863
864
865
866
867
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 861

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

:nodoc:

Returns:

  • (Boolean) 


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

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

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

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



287
288
289
290
291
292
293
 
# File '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

#[](key) ⇒ Object

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



615
616
617
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 615

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

#[]=(key, value) ⇒ Object

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



621
622
623
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 621

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

#compact ⇒ Object

Returns a new instance of ActionController::Parameters with nil values removed.



791
792
793
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 791

def compact
  new_instance_with_inherited_permitted_status(@parameters.compact)
end

#compact! ⇒ Object

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



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

def compact!
  self if @parameters.compact!
end

#compact_blank ⇒ Object

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



802
803
804
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 802

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

#compact_blank! ⇒ Object

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



808
809
810
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 808

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

#converted_arrays ⇒ Object

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.



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

def converted_arrays
  @converted_arrays ||= Set.new
end

#deep_dup ⇒ Object

Returns duplicate of object including all parameters.



889
890
891
892
893
 
# File '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

#deep_transform_keys(&block) ⇒ Object

Returns a new ActionController::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.



742
743
744
745
746
 
# File '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

#deep_transform_keys!(&block) ⇒ Object

Returns the ActionController::Parameters instance changing its keys. This includes the keys from the root hash and from all nested hashes and arrays. The values are unchanged.



751
752
753
754
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 751

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

#delete(key, &block) ⇒ Object

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). Cf. #extract!, which returns the corresponding ActionController::Parameters object.



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

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

#dig(*keys) ⇒ Object

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



659
660
661
662
 
# File '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

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

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



386
387
388
389
390
391
392
393
 
# File '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

#each_value(&block) ⇒ Object

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



398
399
400
401
402
403
404
405
 
# File '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

#except(*keys) ⇒ Object

Returns a new ActionController::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>



688
689
690
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 688

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

#extract!(*keys) ⇒ Object

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>



697
698
699
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 697

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

#fetch(key, *args) ⇒ Object

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 ActionController::ParameterMissing error; if a second argument is given, then that is returned (converted to an instance of ActionController::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"



638
639
640
641
642
643
644
645
646
647
648
 
# File '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

#hash ⇒ Object 



296
297
298
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 296

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

#init_with(coder) ⇒ Object

:nodoc:



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 870

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

#inspect ⇒ Object 



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

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

#keys ⇒ Object

:method: values

:call-seq:

values()

Returns a new array of the values of the parameters.



246
247
 
# File '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

#merge(other_hash) ⇒ Object

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



820
821
822
823
824
 
# File '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

#merge!(other_hash) ⇒ Object

Returns current ActionController::Parameters instance with other_hash merged into current hash.



828
829
830
831
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 828

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

#permit(*filters) ⇒ Object

Returns a new ActionController::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>



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File '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

#permit! ⇒ Object

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



440
441
442
443
444
445
446
447
448
449
 
# File '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? ⇒ Boolean

Returns true if the parameter is permitted, false otherwise.

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

Returns:

  • (Boolean) 


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

def permitted?
  @permitted
end

#reject(&block) ⇒ Object

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



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

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

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

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



784
785
786
787
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 784

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

#require(key) ⇒ Object 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 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

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.



501
502
503
504
505
506
507
508
509
 
# File '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

#reverse_merge(other_hash) ⇒ Object Also known as: with_defaults

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



835
836
837
838
839
 
# File '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

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

Returns current ActionController::Parameters instance with current hash merged into other_hash.



844
845
846
847
 
# File '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

#select(&block) ⇒ Object

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



766
767
768
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 766

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

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

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



771
772
773
774
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 771

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

#slice(*keys) ⇒ Object

Returns a new ActionController::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>



671
672
673
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 671

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

#slice!(*keys) ⇒ Object

Returns current ActionController::Parameters instance which contains only the given keys.



677
678
679
680
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 677

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

#stringify_keys ⇒ Object

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.



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

def stringify_keys # :nodoc:
  dup
end

#to_h ⇒ Object

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



312
313
314
315
316
317
318
 
# File '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

#to_hash ⇒ Object

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



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

def to_hash
  to_h.to_hash
end

#to_query(*args) ⇒ Object 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.

This method is also aliased as to_param.



364
365
366
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 364

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

#to_unsafe_h ⇒ Object 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"}



379
380
381
 
# File 'lib/action_controller/metal/strong_parameters.rb', line 379

def to_unsafe_h
  convert_parameters_to_hashes(@parameters, :to_unsafe_h)
end

#transform_keys(&block) ⇒ Object

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



724
725
726
727
728
729
 
# File '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

#transform_keys!(&block) ⇒ Object

Performs keys transformation and returns the altered ActionController::Parameters instance.



733
734
735
736
737
 
# File '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

#transform_values ⇒ Object

Returns a new ActionController::Parameters 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>



707
708
709
710
711
712
 
# File '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

#transform_values! ⇒ Object

Performs values transformation and returns the altered ActionController::Parameters instance.



716
717
718
719
720
 
# File '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

#values_at(*keys) ⇒ Object

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



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

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