Skip to content

Commit

Permalink
Optionally allow overriding the policy class for permitted params
Browse files Browse the repository at this point in the history
  • Loading branch information
Numie committed Aug 18, 2024
1 parent 8992430 commit 6757dda
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 8 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,23 @@ def pundit_params_for(_record)
end
```

You can pass an argument to override the policy class if necessary. For example:

```ruby
# app/controllers/posts_controller.rb
class PostsController < ApplicationController
def update
@post = Post.find(params[:id])
if @post.update(permitted_attributes(@post), policy_class: PostPolicy)
redirect_to @post
else
render :edit
end
end
end

```

## RSpec

### Policy Specs
Expand Down
12 changes: 4 additions & 8 deletions lib/pundit/authorization.rb
Original file line number Diff line number Diff line change
Expand Up @@ -121,15 +121,11 @@ def policy(record)
# @param record [Object] the object we're retrieving permitted attributes for
# @param action [Symbol, String] the name of the action being performed on the record (e.g. `:update`).
# If omitted then this defaults to the Rails controller action name.
# @param policy_class [Class] the policy class we want to force use of
# @return [Hash{String => Object}] the permitted attributes
def permitted_attributes(record, action = action_name)
policy = policy(record)
method_name = if policy.respond_to?("permitted_attributes_for_#{action}")
"permitted_attributes_for_#{action}"
else
"permitted_attributes"
end
pundit_params_for(record).permit(*policy.public_send(method_name))
def permitted_attributes(record, action = action_name, policy_class: nil)
required_params = pundit_params_for(record)
pundit.permitted_attributes(record, action: action, required_params: required_params, policy_class: policy_class)
end

# Retrieves the params for the given record.
Expand Down
22 changes: 22 additions & 0 deletions lib/pundit/context.rb
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,28 @@ def policy!(record)
cached_find(record, &:policy!)
end

# Retrieves a set of permitted attributes from the policy by instantiating
# the policy class for the given record and calling `permitted_attributes` on
# it, or `permitted_attributes_for_{action}` if `action` is defined. It then infers
# what key the record should have in the params hash and retrieves the
# permitted attributes from the params hash under that key.
#
# @see https://github.com/varvet/pundit#strong-parameters
# @param record [Object] the object we're retrieving permitted attributes for
# @param action [Symbol, String] the name of the action being performed on the record (e.g. `:update`).
# @param required_params [ActionController::Parameters] the params
# @param policy_class [Class] the policy class we want to force use of
# @return [Hash{String => Object}] the permitted attributes
def permitted_attributes(record, action:, required_params:, policy_class: nil)
policy = policy_class ? policy_class.new(user, record) : policy(record)
method_name = if policy.respond_to?("permitted_attributes_for_#{action}")
"permitted_attributes_for_#{action}"
else
"permitted_attributes"
end
required_params.permit(*policy.public_send(method_name))
end

private

def cached_find(record)
Expand Down
15 changes: 15 additions & 0 deletions spec/authorization_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,21 @@ def to_params(*args, **kwargs, &block)
expect(Controller.new(double, action, params).permitted_attributes(post).to_h).to eq("votes" => 5)
end

it "checks different policy for permitted attributes" do
params = to_params(
post: {
title: "Hello",
votes: 5
}
)

action = "update"

expect(Controller.new(user, action, params).permitted_attributes(post, policy_class: PublicationPolicy).to_h).to eq(
"title" => "Hello"
)
end

it "checks policy for permitted attributes for record of a ActiveModel type" do
customer_post = Customer::Post.new(user)
params = to_params(
Expand Down
4 changes: 4 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,10 @@ def resolve
def create?
true
end

def permitted_attributes
[:title]
end
end

class Comment
Expand Down

0 comments on commit 6757dda

Please sign in to comment.