Voltex

This engine aims to provide an easy way to work with dynamic permissions.

Compatibility

Rails 4+
ActiveRecord 4+
Ruby 2+

Installation

Add Voltex to your Gemfile.
```
gem 'voltex'
```
Generate voltex initializer.
```
bundle exec rails g voltex:install
```

Update initializer according your needs.

Voltex.setup do |config|
  # Voltex classes configuration.
  # config.user_class = 'User'
  # config.role_class = 'Role'
  # config.permission_class = 'Permission'
  ...
end

Generate voltex resources.
```
bundle exec rails g voltex:resources
```
Migrate your database.
```
bundle exec rake db:migrate
```
Create default permissions.
```
bundle exec rake voltex
```

Load current user permissions in your application controller.

class ApplicationController < ActionController::Base
  ...
  before_action :set_current_permissions
end

By default this callback preloads permissions for current_user if this is defined. If you need that this callback preloads permission for another user just overwrite voltex_user method.

Example:

class ApplicationController < ActionController::Base
  ...
  def voltex_user
    # Default is current_user.
    another_awesome_user
  end
end

Using Voltex with Pundit

Include voltex in your application policy.

require 'voltex/pundit'

class ApplicationPolicy
  include Voltex::Pundit
end

Now a new helper is available in your policies.

class PostPolicy
  def index?
    permission?(Post, :index)
  end
end

Using Voltex with CanCan

Include voltex in your ability class.

require 'voltex/cancan/ability'

class Ability
  include CanCan::Ability
  include Voltex::CanCan::Ability

  def initialize(user)
    define_voltex_abilities(user)
  end
end

Including and Excluding permissions

Update your voltex initializer:

Voltex.setup do |config|
  # Voltex classes configuration.
  # config.user_class = 'User'
  # config.role_class = 'Role'
  # config.permission_class = 'Permission'
  #
  # Excluding default permissions.
  config.exclude = [
    { resource: 'Payment', action: 'destroy' },
    { resource: 'Post', action: 'update' },
  ]
  #
  # Including other permissions.
  config.include = [
    { resource: 'User', action: 'enable' },
    { resource: 'User', action: 'disable' },
  ]
end

And run voltex rake task again:

bundle exec rake voltex

Defining role permissions

Mount voltex engine in your application:

Rails.application.routes.draw do
  mount Voltex::Engine => '/voltex'
end

Run voltex views generator:

bundle exec rails g voltex:views

This will define a route /voltex/roles/:id/edit where permissions can be defined for each role.