passpartu 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fdefd549a1c4e1cc70e938cfd9e14d1b39ee0686ee011796dd59abf1a3710a3
-  data.tar.gz: 65579c55e57bdbb8a4de830f2819aaede0aea5c195ad951808a91a88f30263c3
+  metadata.gz: cd628d50b6e52acefe4f503c5ada9cec0b224b70be8791fa07f8c5586f93def4
+  data.tar.gz: 5314cf52de8c7cf581768ed8842edb1164b3a57c9aa56456a5ed8e5f0dbfd1e9
 SHA512:
-  metadata.gz: fd3b87dc5660861a05ac0d76f9bfa87bb6b16cf108e4784ec8a99680030fe3e8631350a901fdc15e87853acb42a4faba971b9cf7b142eafb3536e8b911da0424
-  data.tar.gz: 2ff8ee8f80752d51fc0fbc332d77bb3441072bdd2df67a1f3e83507160734ff800a5d6c28f529d53317045b8c3f7e9e16279c9dbae2270c32dbc07e91cadf821
+  metadata.gz: 7ddafd099269680b9f05dbe140fdd9ebae94eff8072e81073cd5db3840bc8d87d4a8171db637de242df0f19c16043123972f9a8b518228d2e2712aab6559385c
+  data.tar.gz: 3f3cab407da0abde8da14764df233c625020d12f8c0d631912d6d009c90bc6fb69d23024aa7d272dc3247009824160df64b816561ec05be43d0fc630b5687d7d

data/README.md

@@ -67,6 +67,69 @@ It's possible to use `crud` key to set values for `create`, `read`, `update`, `d
 `create`, `read`, `update`, `delete` has higher priority than `crud`
 In case `crud: true` and `delete: false` - result `false` 
 
+
+#### Except
+It's possible to exclude role from checks
+```ruby
+    user_admin.can?(:orders, :edit) # check policy for admin and returns true if policy true
+    user_admin.can?(:orders, :edit, except: :admin) # returns false because user is admin and we excluded admin
+    
+```
+It's possible to give an array as except attribute
+
+```ruby
+  user_admin.can?(:orders, :edit, except: [:admin, :manager]) # returns false
+  user_manager.can?(:orders, :edit, except: [:admin, :manager]) # returns false
+```
+
+#### Per role methods
+Check user roles AND policy rule
+```ruby
+    # check if user admin AND returns true if policy true
+    user_admin.admin_can?(:orders, :edit) # true
+    
+    # check if user manager AND returns true if policy true
+    user_admin.manager_can?(:orders, :edit) # false
+```
+
+#### Code blocks
+```ruby
+  # check rules as usual AND code in the block   
+  user_agent.can?(:orders, :edit, except: [:admin, :manager]) { user_agent.orders.include?(order) }
+  
+  # OR   
+  user_agent.agent_can?(:orders, :edit, except: [:admin, :manager]) { user_agent.orders.include?(order) }
+```
+
+##### Real life example
+You need to check custom rule for agent
+```yml
+# ./config/passpartu.yml
+
+admin:
+  order:
+    create: true
+    edit: true
+    delete: true
+manager:
+  order:
+    create: true
+    edit: true
+    delete: false
+agent:
+  order:
+    create: true
+    edit: true
+    delete: false
+```
+
+```ruby
+    user.can?(:order, :edit, except: :agent) || user.agent_can?(:order, :edit) { user.orders.include?(order) }
+```
+
+1. This code returns `true` if user is `admin` or `manager`
+1. This code returns `true` if user is `agent` AND if agent policy set to `true` AND if given block returns true
+
 ## Configuration
 
 You can configure Passpartu by creating `./config/initializers/passpartu.rb`.

data/lib/passpartu.rb

@@ -2,6 +2,7 @@ require 'passpartu/version'
 require 'yaml'
 require_relative 'passpartu/patcher'
 require_relative 'passpartu/verify'
+require_relative 'passpartu/block_verify'
 require_relative 'passpartu/validate_result'
 require_relative 'passpartu/user' # for testing only
 

data/lib/passpartu/block_verify.rb

@@ -0,0 +1,10 @@
+module Passpartu
+  class BlockVerify < ::Passpartu::Verify
+    def call
+      policy_result = super
+      return policy_result if block.nil?
+
+      policy_result && block.call
+    end
+  end
+end

data/lib/passpartu/patcher.rb

@@ -11,8 +11,14 @@ module Passpartu
 
     def call
       klass.class_eval do
-        define_method('can?') do |*keys|
-          Passpartu::Verify.call(role, keys)
+        define_method('can?') do |*keys, except: nil, &block|
+          Passpartu::BlockVerify.call(role, keys, except: except, &block)
+        end
+
+        Passpartu.policy.keys.each do |policy_role|
+          define_method("#{policy_role}_can?") do |*keys, except: nil, &block|
+            role.to_s == policy_role && Passpartu::BlockVerify.call(role, keys, except: except, &block)
+          end
         end
       end
     end

data/lib/passpartu/verify.rb

@@ -2,18 +2,22 @@ module Passpartu
   class Verify
     CRUD_KEY = 'crud'.freeze
 
-    attr_reader :role, :keys, :result
-    def initialize(role, keys)
-      @role = role
+    attr_reader :role, :keys, :result, :except, :block
+    def initialize(role, keys, except, block)
+      @role = role.to_s
       @keys = keys.map(&:to_s)
+      @except = Array(except).map(&:to_s) if present?(except)
+      @block = block
     end
 
-    def self.call(role, keys)
-      new(role, keys).call
+    def self.call(role, keys, except: nil, &block)
+      new(role, keys, except, block).call
     end
 
     def call
-      check
+      return false if role_excepted?
+
+      check_policy
       check_crud if policy_missed? && last_key_crud?
 
       validate_result
@@ -21,13 +25,19 @@ module Passpartu
 
     private
 
-    def check
-      @result = Passpartu.policy.dig(role.to_s, *keys)
+    def role_excepted?
+      return false if blank?(except)
+
+      except.include?(role)
+    end
+
+    def check_policy
+      @result = Passpartu.policy.dig(role, *keys)
     end
 
     def check_crud
       change_crud_key
-      check
+      check_policy
     end
 
     def change_crud_key
@@ -45,5 +55,13 @@ module Passpartu
     def last_key_crud?
       %w[create read update delete].include?(keys[-1])
     end
+
+    def blank?(item)
+      item.respond_to?(:empty?) ? !!item.empty? : !item
+    end
+
+    def present?(item)
+      !blank?(item)
+    end
   end
 end

data/lib/passpartu/version.rb

@@ -1,3 +1,3 @@
 module Passpartu
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passpartu
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/passpartu.rb
+- lib/passpartu/block_verify.rb
 - lib/passpartu/patcher.rb
 - lib/passpartu/user.rb
 - lib/passpartu/validate_result.rb