Class: Yes::Auth::Principals::Role

Inherits:

ActiveRecord::Base

• Object
• ActiveRecord::Base
• Yes::Auth::Principals::Role

Defined in:

lib/yes/auth/principals/role.rb

Overview

Represents an authorization role that can be assigned to users and resource accesses.

Examples:

Finding the super admin role

Yes::Auth::Principals::Role.super_admin_role

Constant Summary

SUPER_ADMIN_ROLE_NAME =

'admin'

Class Method Summary

• .super_admin_role ⇒ Yes::Auth::Principals::Role^?

  The super admin role.

Instance Method Summary

• #resource_authorization_name ⇒ String^?

  The role name with colons replaced by underscores.

Class Method Details

.super_admin_role ⇒ Yes::Auth::Principals::Role^?

Returns the super admin role.

Returns:

• (Yes::Auth::Principals::Role, nil) —

  the super admin role

# File 'lib/yes/auth/principals/role.rb', line 30

def self.super_admin_role
  find_by(name: SUPER_ADMIN_ROLE_NAME)
end

Instance Method Details

#resource_authorization_name ⇒ String^?

Returns the role name with colons replaced by underscores.

Returns:

• (String, nil) —

  the role name with colons replaced by underscores

# File 'lib/yes/auth/principals/role.rb', line 25

def resource_authorization_name
  name&.tr(':', '_')
end