Roles

Roles is an extremely simple roles gem inspired by rolify.

This library is recommended to be used with CanCan and devise.

Why Roles

Look at this discussion: comment

In a word, Rolify uses two tables roles and users_roles while Roles only uses one table roles.

Quick Start


# query roles
user.has_role?(:admin)  # if user is admin globally
user.has_role?(:admin, Organization)  # if user is admin for Organization type
user.has_role?(:admin, Organization.first) # if user is not admin of the first organization
user.role_names(instance = nil) # => returns role names of current user, optionally scoped by Class, instance or non-scoped(globally)

# grant roles
user.add_role(:admin) # a global admin
user.add_role(:admin, Organization) # admin for type Organization
user.add_role(:admin, Organization.first) #  admin for the first organization

# revoke roles
user.remove_role(:admin) # remove global admin
user.remove_role(:admin, Organization) # remove admin for type Organization
user.remove_role(:admin, Organization.first) # remove admin for the first organization

# global role DON'T overrides resource role request
user = User.find(4)
user.add_role :moderator # sets a global role
user.has_role? :moderator, Forum # => false
user.add_role :moderator, Forum # sets a role on resource type
user.has_role? :moderator, Forum.first # => false
user.has_role? :moderator, Forum.last  # => false

# query about users
Forum.users_with_role(role = nil) # => returns all users with roles defined on Forum
forum.users_with_role(role = nil) # => returns users with a role defined of current instance
User.with_role(role, resource = nil) # => returns all users with the given role, optionally scoped by Class, instance or non-scoped(globally)

# query about resources
user.resources_with_role(Project, role_name = nil)
# => returns all projects for a given user, optionally filtered by role_name.

Compatibility

Rails >= 3.1 and < 4.0 (plan to support 4.0 later)
supports ruby 1.9 and 2.0

Installation

Add this to your Gemfile and run the +bundle+ command.

gem "roles"

Getting Started

1. Generate Role Model

First, create your Role model and migration file using this generator:

rails g roles:role

The command will create a Role model and create migrations. Also it will add rolify to User class.

If you want to use a different name for role and user class, you can specify them as following:

rails g roles:role MyRole MyUser

2. Run the migration

rake db:migrate

3.1 Configure your user model

This generator automaticaly adds the rolify method to your User class.

class User < ActiveRecord::Base
  rolify
end

3.2 Configure your resource models

In the resource models you want to apply roles on, just add resourcify method. For example, on this ActiveRecord class:

class Forum < ActiveRecord::Base
  resourcify
end

If you use a different role or user class name than the default Role and User, you have to specify them as options to the resourcify method as following:

resourcify role_cname: 'MyRole', user_cname: 'MyUser'

Resources

License

Roles is distributed under the MIT-LICENSE.