Class: Spree::RoleConfiguration

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/spree/core/role_configuration.rb

Overview

A class responsible for associating Role with a list of permission sets.

Examples:

Adding order, product, and user display to customer service users.

Spree::RoleConfiguration.configure do |config|
  config.assign_permissions :customer_service, [
    Spree::PermissionSets::OrderDisplay,
    Spree::PermissionSets::UserDisplay,
    Spree::PermissionSets::ProductDisplay
  ]
end

See Also:

Defined Under Namespace

Classes: Role

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Instance Attribute Details

- (Object) roles

Returns the value of attribute roles



22
23
24
# File 'lib/spree/core/role_configuration.rb', line 22

def roles
  @roles
end

Class Method Details

+ (Object) configure {|instance| ... }

Yields the instance of the singleton, used for configuration

Yields:

  • (instance)


26
27
28
# File 'lib/spree/core/role_configuration.rb', line 26

def self.configure
  yield(instance)
end

Instance Method Details

- (Object) activate_permissions!(ability, user)

Given a CanCan::Ability, and a user, determine what permissions sets can be activated on the ability, then activate them.

This performs can/cannot declarations on the ability, and can modify its internal permissions.

Parameters:

  • ability (CanCan::Ability)

    the ability to invoke declarations on

  • user (#spree_roles)

    the user that holds the spree_roles association.



38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/spree/core/role_configuration.rb', line 38

def activate_permissions!(ability, user)
  spree_roles = ['default'] | user.spree_roles.map(&:name)
  applicable_permissions = Set.new

  spree_roles.each do |role_name|
    applicable_permissions |= roles[role_name].permission_sets
  end

  applicable_permissions.each do |permission_set|
    permission_set.new(ability).activate!
  end
end

- (Object) assign_permissions(role_name, permission_sets)

Assign permission sets for a Spree::Role that has the name of role_name

Parameters:



63
64
65
66
67
68
# File 'lib/spree/core/role_configuration.rb', line 63

def assign_permissions(role_name, permission_sets)
  name = role_name.to_s

  roles[name].permission_sets |= permission_sets
  roles[name]
end