2021-03-17 17:11:29 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module RuboCop
|
|
|
|
module Cop
|
|
|
|
# Cop that rejects the usage of `User#admin?`
|
2022-09-14 11:12:56 -04:00
|
|
|
class UserAdmin < RuboCop::Cop::Base
|
2021-03-17 17:11:29 -04:00
|
|
|
MSG = 'Direct calls to `User#admin?` to determine admin status should be ' \
|
|
|
|
'avoided as they will not take into account the policies framework ' \
|
|
|
|
'and will ignore Admin Mode if enabled. Please use a policy check ' \
|
|
|
|
'with `User#can_admin_all_resources?` or `User#can_read_all_resources?`.'
|
|
|
|
|
|
|
|
def_node_matcher :admin_call?, <<~PATTERN
|
|
|
|
({send | csend} _ :admin? ...)
|
|
|
|
PATTERN
|
|
|
|
|
|
|
|
def on_send(node)
|
|
|
|
on_handler(node)
|
|
|
|
end
|
|
|
|
|
|
|
|
def on_csend(node)
|
|
|
|
on_handler(node)
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def on_handler(node)
|
|
|
|
return unless admin_call?(node)
|
|
|
|
|
2022-09-14 11:12:56 -04:00
|
|
|
add_offense(node.loc.selector)
|
2021-03-17 17:11:29 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|