https://github.com/jbox-web/royce
A Ruby on Rails roles solution
https://github.com/jbox-web/royce
rails roles-management ruby
Last synced: 3 months ago
JSON representation
A Ruby on Rails roles solution
- Host: GitHub
- URL: https://github.com/jbox-web/royce
- Owner: jbox-web
- License: mit
- Created: 2019-02-04T00:09:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T16:07:43.000Z (10 months ago)
- Last Synced: 2024-09-06T19:15:29.870Z (10 months ago)
- Topics: rails, roles-management, ruby
- Language: Ruby
- Homepage:
- Size: 149 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Royce
[](https://github.com/jbox-web/royce/blob/master/LICENSE)
[](https://github.com/jbox-web/royce/releases/latest)
[](https://github.com/jbox-web/royce/actions)
[](https://codeclimate.com/github/jbox-web/royce)
[](https://codeclimate.com/github/jbox-web/royce/coverage)
Roles in Rails.
## Installation
Put this in your `Gemfile` :
```ruby
git_source(:github){ |repo_name| "https://github.com/#{repo_name}.git" }
gem 'royce', github: 'jbox-web/royce', tag: '1.3.0'
```
then run `bundle install`.
Run this in your terminal to generate DB migration :
```sh
bin/rails g royce:install
bin/rails db:migrate
```
Add this to a model :
```ruby
royce_roles %w[owner editor administrator]
```
## In Depth
Adding royce to a model is super simple. The following code will add the roles `user`, `admin`, and `editor` to your model class.
You can pass in an array of strings or symbols. You can even pass in a mixed array of strings and symbols.
```ruby
class User < ActiveRecord::Base
royce_roles %w[user admin editor] # array of strings
end
class Sailor < ActiveRecord::Base
royce_roles %i[captain bosun quartermaster] # array of symbols
end
class RockAndRoller < ActiveRecord::Base
royce_roles [:drummer, 'bassist', :editor] # array of strings and symbols
end
```
Now instances of your user class have some roles methods. You can add, remove, query role status, and even ask if an instance can accept such a role.
```ruby
user = User.create()
user.add_role :user
user.add_role 'user'
user.add_role Royce::Role.find_by(name: 'user')
user.remove_role :user
user.remove_role 'user'
user.remove_role Royce::Role.find_by(name: 'user')
user.has_role? :user
user.has_role? 'user'
user.has_role? Royce::Role.find_by(name: 'user')
user.allowed_role? 'user'
user.allowed_role? :user
user.allowed_role? Royce::Role.find_by(name: 'user')
```
You also get some conveneint methods to query if a user has a certain named role.
```ruby
user.admin?
user.editor?
user.user?
```
You can easily add a role to your model object using our bang! methods.
```ruby
user.user!
user.admin!
user.editor!
```
Get a list of roles that a particular user has
```ruby
user.add_role :user
user.add_role :admin
user.role_list # => ['user', 'admin']
```
Get a list of all roles available to a class
```ruby
User.available_role_names # => ['user', 'admin', 'editor']
```
Not enough. You also get named scopes on your models.
```ruby
User.admins
User.editors
User.users
```
If you liked that, you'll LOVE this. We've added the ability to take a role, and return all instances of a class that have that role.
For `User`s it'll look like this:
```ruby
admin_role = Royce::Role.find_by(name: 'admin')
admin_role.users.all # Array of user objects
```