Class: Spree::PermissionSets::Base

Inherits:

Object

• Object
• Spree::PermissionSets::Base

Defined in:

app/models/spree/permission_sets/base.rb

Direct Known Subclasses

ConfigurationManagement, DashboardDisplay, DefaultCustomer, OrderDisplay, OrderManagement, ProductDisplay, ProductManagement, PromotionManagement, RoleManagement, StockDisplay, StockManagement, SuperUser, UserDisplay, UserManagement

Instance Attribute Summary

• #ability ⇒ CanCan::Ability readonly

  The ability instance to add permissions to.

Instance Method Summary

• #activate! ⇒ void abstract

  Activates this permission set by adding its permissions to 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 instance to add permissions to

# File 'app/models/spree/permission_sets/base.rb', line 26

def initialize(ability)
  @ability = ability
end

Instance Attribute Details

#ability ⇒ CanCan::Ability (readonly)

Returns the ability instance to add permissions to.

Returns:

• (CanCan::Ability) —

  the ability instance to add permissions to

# File 'app/models/spree/permission_sets/base.rb', line 23

def ability
  @ability
end

Instance Method Details

#activate! ⇒ void

This method is abstract.

This method returns an undefined value.

Activates this permission set by adding its permissions to the ability. Override this method in subclasses to define the permissions.

Raises:

• (NotImplementedError)

# File 'app/models/spree/permission_sets/base.rb', line 35

def activate!
  raise NotImplementedError, "#{self.class} must implement #activate!"
end