Class: Spree::PermissionSets::Base

Inherits:

Object

• Object
• Spree::PermissionSets::Base

Defined in:

lib/spree/permission_sets/base.rb

Overview

This is the base class used for crafting permission sets.

This is used by RoleConfiguration when adding custom behavior to Ability. See one of the subclasses for example structure such as UserDisplay

See Also:

• RoleConfiguration
• Spree::PermissionSets

Direct Known Subclasses

ConfigurationDisplay, ConfigurationManagement, DashboardDisplay, DefaultCustomer, OrderDisplay, OrderManagement, ProductDisplay, ProductManagement, PromotionDisplay, PromotionManagement, RestrictedStockDisplay, RestrictedStockManagement, StockDisplay, StockManagement, SuperUser, UserDisplay, UserManagement

Instance Method Summary

• #activate! ⇒ Object

  Activate permissions on the ability.

• #initialize(ability) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(ability) ⇒ Base

Returns a new instance of Base.

Parameters:

• ability (CanCan::Ability) —

  The ability that will be extended with the current permission set. The ability passed in must respond to #user

# File 'lib/spree/permission_sets/base.rb', line 16

def initialize(ability)
  @ability = ability
end

Instance Method Details

#activate! ⇒ Object

Activate permissions on the ability. Put your can and cannot statements here. Must be overriden by subclasses

Raises:

• (NotImplementedError)

# File 'lib/spree/permission_sets/base.rb', line 22

def activate!
  raise NotImplementedError.new
end