Sha256: ebe5158b70addfd33af6dcc50b2587c15d4e493a1682fe1003e7eb7af1b9fb9f

Contents?: true

Size: 1.83 KB

Versions: 4

Compression:

Stored size: 1.83 KB

Contents

# Roles for Mongoid

A Mongoid implementation of [roles generic](http://github.com/kristianmandrup/roles_generic)

## Intro

Implements the [roles generic](http://github.com/kristianmandrup/roles_generic) Roles API
It also implements the following Role strategies:

* admin_flag
* many_roles
* one_role
* roles_mask
* role_string
* role_strings

# Install

<code>gem install roles_mongoid</code>

## Rails generator

The library comes with a Rails 3 generator that lets you populate a user model with a role strategy of your choice. 

The following role strategies are included by default. Add your own by adding extra files inside the strategy folder, one file for each role strategy is recommended.

* admin_flag
* many_roles
* one_role
* roles_mask
* role_string
* role_strings

*Roles generator*

Apply :admin_flag Role strategy to User model using default roles :admin and :guest (default)

<code>$ rails g mongoid:roles User --strategy admin_flag</code>

Apply :admin_flag Role strategy to User model using default roles and extra role :author

<code>$ rails g mongoid:roles_migration User --strategy admin_flag --roles author</code>

Apply :one_role Role strategy to User model without default roles, only with roles :user, :special and :editor

<code>$ rails g mongoid:roles_migration User --strategy one_role --roles user special editor --no-default-roles</code>
## Note on Patches/Pull Requests
 
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

## Copyright

Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

Version data entries

4 entries across 4 versions & 2 rubygems

Version Path
roles_mongoid-0.3.1 README.markdown
roles_mongoid-0.2.4 README.markdown
roles_for_mongoid-0.2.3 README.markdown
roles_for_mongoid-0.2.2 README.markdown