# Registrable

## Install

### Bundler: `gem "registrable"`

### RubyGems: `gem install registrable`

## Examples

### Plugin

```rb
<%= file('examples/plugin.rb') %>
```

```rb
p Plugin.registry.keys                     # => [:my_plugin, :another_plugin]
p Plugin[:my_plugin] == MyPlugin           # => true
p Plugin[:another_plugin] == AnotherPlugin # => true
```

### Role

```rb
<%= file('examples/role.rb') %>
```

```rb
other = User.new(:other)

p other.role.readable?   # => true
p other.role.modifiable? # => true

user = User.new(:user)

p admin.role.readable?   # => true
p admin.role.modifiable? # => false

admin = User.new(:admin)

p admin.role.readable?   # => true
p admin.role.modifiable? # => true
```

## Development

* `bin/setup` to install dependencies
* `bin/console` for an interactive prompt
* `bin/rake -T` to run view tasks
  * `bin/rake test` to test
  * `bin/rake lint` to lint
  * `bin/rake docs` to generate documentation
  * `bin/rake install` to install this gem onto your machine
  * `bin/rake` to test, lint, and generate documentation
* To release a new version
  * `bin/rake version:bump`
  * `bin/rake release` to create a git tag for the version, push git commits and tags, and push the gem to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RyanScottLewis/registrable.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).