voltex 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e670d0917034aa52407212065d3d8e21a1b7308
-  data.tar.gz: 2ff3dc581a86984951ae557d94f90d09ad3dd922
+  metadata.gz: 5cfc96e3f591dcffa4d5118a19ba8f93a577b562
+  data.tar.gz: 8b5c5e101cf8a4f00d22ad5f21b1b57452749394
 SHA512:
-  metadata.gz: 66a73c70bed244afb603325830c81845beefc9829292b359aa01c3978a48a693d359ab6cc10c187b56eeaea6a446d66d7627355da67381ec031dfb5df9639760
-  data.tar.gz: 8f1ed3f14937ca80439990b87c136929313dd9d849e31f76ebe22cf2d58193485379cf8ec3702925222b1f6cbb9876dcbfe263f7c2c79a251ed773000b8e0b33
+  metadata.gz: 0158489ca3fbde74c60bb58466505f225fff4fbdb22057b0741a36def2dbbcd3cfbfcd67888b2375fe3fb091d0b80eea1b35a20eff5be5c837bff74f7ef60646
+  data.tar.gz: ec5e3f9f3c11128579353550178373272c193f8af1ac2706f9df3072f0b71ac65decc31a12e6b4a6900ce46b004d9ec1430aeecf44083b5c239f5640447fa4a4

data/README.md

@@ -0,0 +1,154 @@
+# Voltex
+This engine aims to provide an easy way to work with dynamic permissions.
+
+
+## Compatibility
+* Rails 4+
+* ActiveRecord 4+
+* Ruby 2+
+
+
+## Installation
+1. Add Voltex to your Gemfile.
+
+    ```ruby
+    gem 'voltex'
+    ```
+
+2. Generate voltex initializer.
+
+    ```
+    bundle exec rails g voltex:install
+    ```
+
+3. Update initializer according your needs.
+
+    ```ruby
+    Voltex.setup do |config|
+      # Voltex classes configuration.
+      # config.user_class = 'User'
+      # config.role_class = 'Role'
+      # config.permission_class = 'Permission'
+      ...
+    end
+    ```
+
+4. Generate voltex resources.
+
+    ```
+    bundle exec rails g voltex:resources
+    ```
+
+5. Migrate your database.
+
+    ```
+    bundle exec rake db:migrate
+    ```
+
+6. Create default permissions.
+
+    ```
+    bundle exec rake voltex
+    ```
+
+7. Load current user permissions in your application controller.
+
+    ```ruby
+    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:
+```ruby
+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.
+```ruby
+require 'voltex/pundit'
+
+class ApplicationPolicy
+  include Voltex::Pundit
+end
+```
+Now a new helper is available in your policies.
+```ruby
+class PostPolicy
+  def index?
+    permission?(Post, :index)
+  end
+end
+```
+
+
+## Using Voltex with CanCan
+Include voltex in your ability class.
+```ruby
+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:
+```ruby
+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:
+```ruby
+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.

data/Rakefile

@@ -10,7 +10,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Voltex'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/lib/voltex/version.rb

@@ -1,3 +1,3 @@
 module Voltex
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voltex
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Erick Fabian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,98 +17,98 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: cancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.10
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.10
+        version: '1.6'
 description: This engine aims to provide an easy way to work with dynamic permissions.
 email:
 - fabianerickalfonso@gmail.com
@@ -118,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/controllers/voltex/application_controller.rb
 - app/controllers/voltex/roles_controller.rb
@@ -148,7 +149,7 @@ files:
 - lib/voltex/scope.rb
 - lib/voltex/setup.rb
 - lib/voltex/version.rb
-homepage: ''
+homepage: https://github.com/SyeSoftware/voltex
 licenses:
 - MIT
 metadata: {}
@@ -160,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Dynamic permissions authorization.