mirror of
https://github.com/varvet/pundit.git
synced 2022-11-09 12:30:11 -05:00
2f68c154f0
The fewer exceptions to the default the better, and we're going to want to use an access modifier in a generator, which will end up in other people's codebases, so we should be as conventional as possible.
103 lines
2.9 KiB
Ruby
103 lines
2.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Pundit
|
|
# Finds policy and scope classes for given object.
|
|
# @api public
|
|
# @example
|
|
# user = User.find(params[:id])
|
|
# finder = PolicyFinder.new(user)
|
|
# finder.policy #=> UserPolicy
|
|
# finder.scope #=> UserPolicy::Scope
|
|
#
|
|
class PolicyFinder
|
|
attr_reader :object
|
|
|
|
# @param object [any] the object to find policy and scope classes for
|
|
#
|
|
def initialize(object)
|
|
@object = object
|
|
end
|
|
|
|
# @return [nil, Scope{#resolve}] scope class which can resolve to a scope
|
|
# @see https://github.com/varvet/pundit#scopes
|
|
# @example
|
|
# scope = finder.scope #=> UserPolicy::Scope
|
|
# scope.resolve #=> <#ActiveRecord::Relation ...>
|
|
#
|
|
def scope
|
|
"#{policy}::Scope".safe_constantize
|
|
end
|
|
|
|
# @return [nil, Class] policy class with query methods
|
|
# @see https://github.com/varvet/pundit#policies
|
|
# @example
|
|
# policy = finder.policy #=> UserPolicy
|
|
# policy.show? #=> true
|
|
# policy.update? #=> false
|
|
#
|
|
def policy
|
|
klass = find(object)
|
|
klass.is_a?(String) ? klass.safe_constantize : klass
|
|
end
|
|
|
|
# @return [Scope{#resolve}] scope class which can resolve to a scope
|
|
# @raise [NotDefinedError] if scope could not be determined
|
|
#
|
|
def scope!
|
|
scope or raise NotDefinedError, "unable to find scope `#{find(object)}::Scope` for `#{object.inspect}`"
|
|
end
|
|
|
|
# @return [Class] policy class with query methods
|
|
# @raise [NotDefinedError] if policy could not be determined
|
|
#
|
|
def policy!
|
|
policy or raise NotDefinedError, "unable to find policy `#{find(object)}` for `#{object.inspect}`"
|
|
end
|
|
|
|
# @return [String] the name of the key this object would have in a params hash
|
|
#
|
|
def param_key
|
|
model = object.is_a?(Array) ? object.last : object
|
|
|
|
if model.respond_to?(:model_name)
|
|
model.model_name.param_key.to_s
|
|
elsif model.is_a?(Class)
|
|
model.to_s.demodulize.underscore
|
|
else
|
|
model.class.to_s.demodulize.underscore
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def find(subject)
|
|
if subject.is_a?(Array)
|
|
modules = subject.dup
|
|
last = modules.pop
|
|
context = modules.map { |x| find_class_name(x) }.join("::")
|
|
[context, find(last)].join("::")
|
|
elsif subject.respond_to?(:policy_class)
|
|
subject.policy_class
|
|
elsif subject.class.respond_to?(:policy_class)
|
|
subject.class.policy_class
|
|
else
|
|
klass = find_class_name(subject)
|
|
"#{klass}#{SUFFIX}"
|
|
end
|
|
end
|
|
|
|
def find_class_name(subject)
|
|
if subject.respond_to?(:model_name)
|
|
subject.model_name
|
|
elsif subject.class.respond_to?(:model_name)
|
|
subject.class.model_name
|
|
elsif subject.is_a?(Class)
|
|
subject
|
|
elsif subject.is_a?(Symbol)
|
|
subject.to_s.camelize
|
|
else
|
|
subject.class
|
|
end
|
|
end
|
|
end
|
|
end
|