Contents

# frozen_string_literal: true

module Spree
  module PermissionSets
    # This is the base class used for crafting permission sets.
    #
    # This is used by {Spree::RoleConfiguration} when adding custom behavior to {Spree::Ability}.
    # See one of the subclasses for example structure such as {Spree::PermissionSets::UserDisplay}
    #
    # @see Spree::RoleConfiguration
    # @see Spree::PermissionSets
    class Base
      # @param ability [CanCan::Ability]
      #   The ability that will be extended with the current permission set.
      #   The ability passed in must respond to #user
      def initialize(ability)
        @ability = ability
      end

      # Activate permissions on the ability. Put your can and cannot statements here.
      # Must be overridden by subclasses
      def activate!
        raise NotImplementedError.new
      end

      # Provide the permission set privilege in the form of a :symbol.
      # Must be overridden by subclasses.
      def self.privilege
        raise NotImplementedError, "Subclass #{name} must define a privilege using `self.privilege :symbol`"
      end

      # Provide the permission set category in the form of a :symbol.
      # Must be overridden by subclasses.
      def self.category
        raise NotImplementedError, "Subclass #{name} must define a category using `self.category :symbol`"
      end

      private

      attr_reader :ability
      delegate :can, :cannot, :user, to: :ability
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
solidus_core-4.4.2	lib/spree/permission_sets/base.rb
solidus_core-4.4.1	lib/spree/permission_sets/base.rb
solidus_core-4.4.0	lib/spree/permission_sets/base.rb