devise_can 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 934d07c42518a35a3e89437c51ccd32b67815bbe
-  data.tar.gz: 2cb334bd027c0f7b07e96a6ad009a1a0ae00224d
+  metadata.gz: 22a34ac3b6cb874e6ca8209a066f48f48119cd7a
+  data.tar.gz: 8ae3c0f0d99ca238d3587e4121c68520e366f4fc
 SHA512:
-  metadata.gz: aad10371fe2ff05e9e638b03b1ea6fd30d711ae8c858b7913597640e6480763f28a64469f4bb7c47b5d4d3af71f376fb51e47bba60468941b0f8c1c239d9288f
-  data.tar.gz: c1fab890221ea5b706d818d0bfe8d83bb32bb2735821a2216461049a2a1a045a0f0e0e80638b3ac78f1f07d0dbecb18d14005c6b6e858d6887567e4de5ec342a
+  metadata.gz: eb7805d06a2b115d63f087222333a2c54e2d1a0737ec73e9bb02aa1712e8164902574b823d7e061a60245f547063c9d0022316bab93b90ff97241f766ba1dc76
+  data.tar.gz: dbf135e81334f2e8d464e006e53406cc660d6301d0e71cf7ee193f8c266670e9a08f61a665ceccff06ba15b23c21fb4299bb59601d3b2f77baff0c4af81e4dd8

data/README.md

@@ -1,8 +1,8 @@
 # DeviseCan
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise_can`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Why **devise_can** gem?
 
-TODO: Delete this and the text above, and describe your gem
+By `device_can` gem you'll get functionality of devise,cancancan and `user_role_association` that make your development easy.
 
 ## Installation
 
@@ -22,7 +22,196 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+ You need to follow all given steps i.e.
+
+ ## Generate devise component
+
+ `rails generate devise:install`
+
+
+ Now add `require 'devise'` to your config/application.rb
+
+
+
+ `rails generate devise user`
+
+
+ This will generate devise model with name `User`, you can either generate views and controller as well by following command:
+
+ `rails generate devise:views`
+
+
+ `rails generate devise:controllers users`
+
+
+
+ ## Generate association component
+
+ `rails generate association user_role`
+
+  It'll generate two models with name `Role` and `UserRole`
+
+  ```
+  	class Role < ActiveRecord::Base
+	    has_many :user_roles
+	  	has_many :users,through: :user_roles
+
+	    validates :name,presence: true
+	end
+
+  ```
+
+
+  ```
+  	class UserRole < ActiveRecord::Base
+	  	belongs_to :user
+	  	belongs_to :role
+	  	validates :user,presence: true
+	  	validates :role,presence: true
+	  	validates_uniqueness_of  :user_id, scope: :role_id
+	end
+
+  ```
+
+  Add association into model `User` i.e.
+
+  ```
+  	has_many :user_roles
+    has_many :roles,through: :user_roles   
+
+  ```
+
+
+
+ ## Generate cancan component
+
+ `rails generate cancan:ability`
+
+ It'll create a model with name `Ability`
+
+
+## Generate permission component
+
+ `rails generate permission module`
+
+ It'll generate three models with name `ModuleAction` , `ModuleGroup` and  `ModulePermission`.Each model looks like:
+
+ ```
+
+ 	class ModuleAction < ApplicationRecord
+		has_many :module_permissions
+		has_many :module_groups,through: :module_permissions
+	end
+
+ ```
+
+ 	This model will contain all module name like `User` or `Role` etc..
+
+ ```
+
+ 	class ModuleGroup < ApplicationRecord
+
+		has_many :module_permissions
+		has_many :module_actions,through: :module_permissions
+
+	end
+
+ ```
+
+ 	This model will contain all actions for controller like `create/new/index/update/show` etc..  
+
+ ```
+
+ 	class ModulePermission < ApplicationRecord
+
+		belongs_to :module_group
+		belongs_to :module_action
+		belongs_to :role
+
+	end
+
+ ```
+
+ 	This model will contain association between `module_group` , `module_action` and `role`.
+ 	 
+
+ Now your ability.rb file should look like:
+
+ ```
+
+ 	class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    # Define abilities for the passed in user here. For example:
+    #
+    #   user ||= User.new # guest user (not logged in)
+    #   if user.admin?
+    #     can :manage, :all
+    #   else
+    #     can :read, :all
+    #   end
+    #
+    # The first argument to `can` is the action you are giving the user
+    # permission to do.
+    # If you pass :manage it will apply to every action. Other common actions
+    # here are :read, :create, :update and :destroy.
+    #
+    # The second argument is the resource the user can perform the action on.
+    # If you pass :all it will apply to every resource. Otherwise pass a Ruby
+    # class of the resource.
+    #
+    # The third argument is an optional hash of conditions to further filter the
+    # objects.
+    # For example, here the user can only update published articles.
+    #
+    #   can :update, Article, :published => true
+    #
+    # See the wiki for details:
+    # https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities
+  
+    if user.roles.pluck(:name).include?('superadmin')
+        can :manage, :all
+    else
+        user.roles.map{|role| role.module_permissions}.each do |permissions|
+            permissions.each do |permission|
+                can permission.module_action.name.to_sym,permission.module_group.name.constantize
+            end
+        end
+    end
+
+    
+
+
+  end
+end
+
+
+ ```
+
+ Here superadmin is a role with all permissions on each module.
+
+ ## Run migrations
+
+ Now you need to run migrations for schema update
+
+ `rails db:migrate`
+
+ ## Other stuffs
+
+  Add following lines into your application controller:
+
+  ```
+
+  	rescue_from CanCan::AccessDenied do |exception|
+	  flash[:warning] = exception.message
+	  redirect_to root_path
+    end
+
+  ```
+  It'll check ability.rb on each action and reirect to `root_path` if found unpermitted action. 
+
+
 
 ## Development
 

data/devise_can.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["Raghav.Singh@lptpl.com"]
 
   spec.summary       = %q{This gem is to use for devise,cancancan and user role association.}
-  spec.description   = %q{Enjoy the functionality of this gem.}
+  spec.description   = %q{Integrate devise,cancancan and user roles together for easy implementation.}
   spec.homepage      = "https://github.com/RaghavVishnoi/devise_can.git"
   spec.license       = "MIT"
 

data/lib/devise_can/version.rb

@@ -1,3 +1,3 @@
 module DeviseCan
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_can
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - RaghavSingh
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Enjoy the functionality of this gem.
+description: Integrate devise,cancancan and user roles together for easy implementation.
 email:
 - Raghav.Singh@lptpl.com
 executables: []