Skip to content
This repository was archived by the owner on Aug 17, 2017. It is now read-only.

Add use-case to use an array as required parameter #194

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ Thanks to Nick Kallen for the permit idea!

## Require Multiple Parameters

If you want to make sure only certain parameters have to be required you can do:

``` ruby
params.require([:foo, :bar])
```

If you want to make sure that multiple keys are present in a params hash, you can call the method twice:

``` ruby
Expand Down
15 changes: 13 additions & 2 deletions lib/action_controller/parameters.rb
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,15 @@ def permit!
self
end

def require(key)
self[key].presence || raise(ActionController::ParameterMissing.new(key))
def require(filter)
case filter
when Symbol, String
require_presence?(filter)
when Array
filter.each do |k|
require_presence?(k)
end
end
end

alias :required :require
Expand Down Expand Up @@ -113,6 +120,10 @@ def convert_value(value)

private

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

def convert_hashes_to_parameters(key, value, assign_if_converted=true)
converted = convert_value_to_parameters(value)
self[key] = converted if assign_if_converted && !converted.equal?(value)
Expand Down
14 changes: 14 additions & 0 deletions test/action_controller_required_params_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ def create
params.require(:book).require(:name)
head :ok
end

def update
params.require([:books, :authors])
head :ok
end
end

class ActionControllerRequiredParamsTest < ActionController::TestCase
Expand All @@ -16,6 +21,15 @@ class ActionControllerRequiredParamsTest < ActionController::TestCase

post :create, { :book => { :title => "Mjallo!" } }
assert_response :bad_request

put :update, { :books => 'foo', :authors => 'bar' }
assert_response :ok

put :update, { :books => { :bar => 'foo' }, :authors => 'bar' }
assert_response :ok

put :update, { :books => 'foo' }
assert_response :bad_request
end

test "required parameters that are present will not raise" do
Expand Down