Module: Shamu::Security::Roles

Extended by:

ActiveSupport::Concern

Included in:

Policy

Defined in:

lib/shamu/security/roles.rb

Overview

Mixin for Policy and Support classes to define security roles including inheritance.

Class Method Summary

• .expand_roles(*roles) ⇒ Array<Symbol>

  Expand the given roles to include the roles that they have inherited.

• .role(name, inherits: nil)

  Define a named role.

• .role_defined?(role) ⇒ Boolean

  True if the role has been defined.

• .roles ⇒ Hash

  The named roles defined on the class.

Class Method Details

.expand_roles(*roles) ⇒ Array<Symbol>

Expand the given roles to include the roles that they have inherited.

# File 'lib/shamu/security/roles.rb', line 29

def expand_roles( *roles )
  expand_roles_into( roles, [] )
end

.role(name, inherits: nil)

This method returns an undefined value.

Define a named role.

# File 'lib/shamu/security/roles.rb', line 22

def role( name, inherits: nil )
  roles[ name.to_sym ] = { inherits: Array( inherits ) }
end

.role_defined?(role) ⇒ Boolean

# File 'lib/shamu/security/roles.rb', line 35

def role_defined?( role )
  roles.key?( role.to_sym )
end

.roles ⇒ Hash

# File 'lib/shamu/security/roles.rb', line 12

def roles
  @roles ||= {}
end