class Grabli

Constants

Intruder

When no subject specified by the user or the subject is a Symbol, we pass that object as a subject.

If the subject isn't used it means we can add this permission as allowed. If it's used, CURRENTLY, we assume that the given permission isn't allowed.

PolicyNotFound

VERSION

Public Class Methods

new(namespace: nil) click to toggle source

You can configure grabli by passing options to initializer @param namespace: nil [module] set the namespace for your policies

@example

# will search policies under specified namespace, e.g. User::SomePolicy
Grabli.new(namespace: User)

# File lib/grabli.rb, line 15
def initialize(namespace: nil)
  @namespace = namespace
end

Public Instance Methods

allowed?(policy, permission) click to toggle source

Check whether certain permission is allowed.

@param policy [ApplicationPolicy] instantiated policy @param permission [Symbol] permission name @return [Boolen, Object] true or false in case subject intruded

or whatever you policy permission returns

@example

policy = Pundit.policy(@user, @company)
Grabli.new.allowed?(policy, :create?)
#=> true

# File lib/grabli.rb, line 59
def allowed?(policy, permission)
  result = policy.public_send(permission)

  return false if policy.record.is_a?(Intruder) && policy.record.intruded

  result
end

collect(user, subject) click to toggle source

Collect allowed policy permissions for the given user.

@param user [Object] user object your policy work with @param subject [Symbol, Object] subject object your policy work with @return [Array<Symbol>] array of allowed policy permission

@example

Grabli.new.collect(@user, @company)
#=> [:create?, :update?, :manage_occupied?]

Grabli.new.collect(@user, :company)
#=> [:create?]

# File lib/grabli.rb, line 33
def collect(user, subject)
  policy_class(subject)
    .tap { |policy| raise PolicyNotFound if policy.nil? }
    .public_instance_methods(false)
    .reject { |n| n =~ /permitted_attributes/ }
    .each_with_object([]) do |permission, collection|
      # allows to collect permissions without subject, for more see Intruder
      isubject = subject.is_a?(Symbol) ? Intruder.new(false) : subject
      policy = policy_class(subject).new(user, isubject)

      collection << permission if allowed?(policy, permission)
    end
end

Private Instance Methods

policy_class(record) click to toggle source

# File lib/grabli.rb, line 67
        def policy_class(record)
  if @namespace.nil?
    Pundit::PolicyFinder.new(record).policy
  else
    Pundit::PolicyFinder.new([@namespace, record]).policy
  end
end