Class: ActionController::Parameters

Inherits:
ActiveSupport::HashWithIndifferentAccess
  • Object
show all
Defined in:
lib/action_controller/parameters.rb

Constant Summary collapse

NEVER_UNPERMITTED_PARAMS =

Never raise an UnpermittedParameters exception because of these params are present. They are added by Rails and it’s of no concern.

%w( controller action )

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = nil) ⇒ Parameters

Returns a new instance of Parameters.



40
41
42
43
 
# File 'lib/action_controller/parameters.rb', line 40

def initialize(attributes = nil)
  super(attributes)
  @permitted = false
end

Instance Attribute Details

#permitted ⇒ Object Also known as: permitted?

Returns the value of attribute permitted.



31
32
33
 
# File 'lib/action_controller/parameters.rb', line 31

def permitted
  @permitted
end

Instance Method Details

#[](key) ⇒ Object 



80
81
82
 
# File 'lib/action_controller/parameters.rb', line 80

def [](key)
  convert_hashes_to_parameters(key, super)
end

#dup ⇒ Object 



96
97
98
99
100
101
 
# File 'lib/action_controller/parameters.rb', line 96

def dup
  self.class.new(self).tap do |duplicate|
    duplicate.default = default
    duplicate.instance_variable_set :@permitted, @permitted
  end
end

#fetch(key, *args) ⇒ Object 



84
85
86
87
88
 
# File 'lib/action_controller/parameters.rb', line 84

def fetch(key, *args)
  convert_hashes_to_parameters(key, super, false)
rescue KeyError, IndexError
  raise ActionController::ParameterMissing.new(key)
end

#permit(*filters) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/action_controller/parameters.rb', line 63

def permit(*filters)
  params = self.class.new

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

  unpermitted_parameters!(params) if self.class.action_on_unpermitted_parameters

  params.permit!
end

#permit! ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/action_controller/parameters.rb', line 45

def permit!
  each_pair do |key, value|
    value = convert_hashes_to_parameters(key, value)
    Array.wrap(value).each do |_|
      _.permit! if _.respond_to? :permit!
    end
  end

  @permitted = true
  self
end

#require(key) ⇒ Object Also known as: required 



57
58
59
 
# File 'lib/action_controller/parameters.rb', line 57

def require(key)
  self[key].presence || raise(ActionController::ParameterMissing.new(key))
end

#slice(*keys) ⇒ Object 



90
91
92
93
94
 
# File 'lib/action_controller/parameters.rb', line 90

def slice(*keys)
  self.class.new(super).tap do |new_instance|
    new_instance.instance_variable_set :@permitted, @permitted
  end
end