Lf::Roles

Roles management

Installation

Add this line to your application's Gemfile:

gem 'lf-roles'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lf-roles

Usage

Include Lf::Roles in any class that has a roles_mask integer attribute and declare the possible roles:

class User < ApplicationRecord
  include Lf::Roles
  possible_role "super"
  possible_role "admin"
  possible_role "patron"
end

Instance methods

user.roles                          # => ["admin"]
user.roles = ["admin", "patron"]

user.is?("admin")                   # => true
user.is_any?("super", "admin")      # => true
user.is_only?("admin")              # => false (has patron too)

Class methods

by_role requires ActiveRecord. It returns a relation of all records that include the given role:

User.by_role("admin")   # => ActiveRecord::Relation

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/leequarella/lf-roles. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.