passpartu 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21336de32d4938c7815f3792fa6fa99be0ec64ee45f2a401eb870b5cd7cfe669
-  data.tar.gz: 2a5a48df685793599dddd4271919b00d75c08343d95f7d5c8e93b21a4d787d5b
+  metadata.gz: 6941eb262c351f25dd525ced8ce9d27cf03c90f6977d9e31674b5aa675db2ada
+  data.tar.gz: e9fd5451850cc07bec8b6a2db6e23cadbc9415eb14945a39ab3913857c7e4628
 SHA512:
-  metadata.gz: 1940690916391b4053c30a6d4cc00b1c6f49cf4650434cfa95ed5ca57529e9f734bbe197c73d7c4e89becc2dae841f3c8c62b897b5be70bd7d7b15bedc703137
-  data.tar.gz: 7bfc6007b1aa0490ad4ec21b0e41bddc4b96a3658a8e484e8b5194d3e5fd633772502d03d1d1c9863217f771947b6f7f3a581d17fe8f46e0846e59a4ff54d101
+  metadata.gz: 8986a0743c963712de307a141bfe37405636ec7f952e29ae13c22c2512ec5ae04ef0f4e93e29a8ee5ffd32ebcf39675c7800e58332b451acfc34444d875178a6
+  data.tar.gz: 5d1fde0b670dd30acd04bb819d503588cccaaacbae773076eee10fbd865a16fa370e822c1227d73388d588afd49f3cf96ad759a2db373ef8774d3206d39b3524

data/README.md

@@ -1,8 +1,9 @@
-# Passpartu v1.0.1 - [changelog](https://github.com/coaxsoft/passpartu/blob/master/CHANGELOG.md)
+# Passpartu v1.0.2 - [changelog](https://github.com/coaxsoft/passpartu/blob/master/CHANGELOG.md)
 
 Passpartu makes policies great again (works awesome with [Pundit](https://rubygems.org/gems/pundit)).
 
 Instead of this:
+
 ```ruby
 class PostPolicy < ApplicationPolicy
   def update?
@@ -12,6 +13,7 @@ end
 ```
 
 just this:
+
 ```ruby
 class PostPolicy < ApplicationPolicy
   def update?
@@ -19,19 +21,24 @@ class PostPolicy < ApplicationPolicy
   end
 end
 ```
+
 ## Usage
+
 Include `Passpartu` into your policy model.
+
 ```ruby
 class User
   include Passpartu
 end
 ```
+
 NOTE: Your `User` model must respond to `role` method that returns a string or a symbol!
 
 Keep all your policies in one place.
 Create `./config/passpartu.yml` and start writing your policies.
 
 #### Example of `passpartu.yml`
+
 ```yml
 # ./config/passpartu.yml
 manager: &manager
@@ -65,18 +72,25 @@ admin:
 ```
 
 ## Features
+
 #### CRUD
+
 It's possible to use `crud` key to set values for `create`, `read`, `update`, `delete` at once.
 `create`, `read`, `update`, `delete` has higher priority than `crud`
+
 In case `crud: true` and `delete: false` - result `false` 
 
+
 #### Only
+
 It's possible to include specific roles to checks
+
 ```ruby
     user_admin.can?(:orders, :edit) # check policy for admin and returns true if policy true
     user_admin.can?(:orders, :edit, only: :admin) # returns true because the user is an admin and we included only admin
     user_manager.can?(:orders, :edit, only: :admin) # returns false because user is manager and we included only admin
 ```
+
 It's possible to give an array as only attribute
 
 ```ruby
@@ -85,18 +99,21 @@ It's possible to give an array as only attribute
 ```
 
 Note: `only` has higher priority than `except/skip`. Do not use both.
+
 ```ruby
   user_admin.can?(:orders, :edit, only: :admin, except: :admin) # returns true
 ```
 
-
 #### Skip (except)
+
 It's possible to exclude roles 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
@@ -107,6 +124,7 @@ It's possible to give an array as except attribute
 `skip` alias to `except`
 
 Note: `expect` has higher priority than `skip`. Do not use both.
+
 ```ruby
   user_agent.can?(:orders, :edit, except: [:admin, :manager]) { user_agent.orders.include?(order) }
   # equals to
@@ -114,7 +132,9 @@ Note: `expect` has higher priority than `skip`. Do not use both.
 ```
 
 #### 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
@@ -124,6 +144,7 @@ Check user roles AND policy rule
 ```
 
 #### 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) }
@@ -133,7 +154,9 @@ Check user roles AND policy rule
 ```
 
 #### Waterfall check
+
 Allow or restrict absolutely everything for particular role or/and particular domain.
+
 ```ruby
 # ./config/initializers/passpartu.rb
 
@@ -153,6 +176,7 @@ medium_looser:
     delete: false
   products: true
 ```
+
 ```ruby
 user_super_admin.can?(:do, :whatever, :want) # true
 user_super_loser.can?(:do, :whatever, :want) # false
@@ -161,10 +185,10 @@ user_medium_loser.can?(:orders, :delete) # false
 user_medium_loser.can?(:products, :create) # true
 user_medium_loser.can?(:products, :create, :and_delete) # true
 ```
-
-
 ##### Real life example
+
 You need to check custom rule for agent
+
 ```yml
 # ./config/passpartu.yml
 
@@ -202,9 +226,13 @@ You can configure Passpartu by creating `./config/initializers/passpartu.rb`.
 Passpartu.configure do |config|
   config.policy_file = './config/passpartu.yml'
   config.raise_policy_missed_error = true
+  config.check_waterfall = false
 end
+
 ```
+
 ### Raise policy missed errors
+
 By default Passpartu will raise an PolicyMissedError if policy is missed in `passpartu.yml`. In initializer set  `config.raise_policy_missed_error = false` in order to return `false` in case when policy is not defined. This is a good approach to write only "positive" policies (only true) and automatically restricts everything that is not mentioned in `passpartu.yml`
 
 ## Installation
@@ -244,4 +272,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 Everyone interacting in the Passpartu project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coaxsoft/passpartu/blob/master/CODE_OF_CONDUCT.md).
 
 ## Idea
+
 Initially designed and created by [Orest Falchuk](https://github.com/OrestF)

data/lib/passpartu.rb

@@ -6,7 +6,6 @@ require_relative 'passpartu/patcher'
 require_relative 'passpartu/verify'
 require_relative 'passpartu/block_verify'
 require_relative 'passpartu/validate_result'
-require_relative 'passpartu/check_waterfall'
 require_relative 'passpartu/user' # for testing only
 
 module Passpartu
@@ -32,14 +31,14 @@ module Passpartu
   end
 
   class Config
-    attr_accessor :policy, :raise_policy_missed_error
-    attr_reader :policy_file, :check_waterfall
+    attr_accessor :raise_policy_missed_error
+    attr_reader :policy_file, :check_waterfall, :policy
 
     DEFAULT_POLICY_FILE = './config/passpartu.yml'
 
     def initialize
       @policy_file = DEFAULT_POLICY_FILE
-      @policy = YAML.load_file(policy_file) if File.exist?(policy_file)
+      set_policy(YAML.load_file(policy_file)) if File.exist?(policy_file)
       @raise_policy_missed_error = true
       @check_waterfall = false
     end
@@ -49,15 +48,50 @@ module Passpartu
 
       raise PolicyYmlNotFoundError unless File.exist?(policy_file)
 
-      @policy = YAML.load_file(policy_file)
+      set_policy(YAML.load_file(policy_file))
     end
 
     def check_waterfall=(value)
       @check_waterfall = value
-      @raise_policy_missed_error = false if @check_waterfall
+
+      if @check_waterfall
+        @raise_policy_missed_error = false
+        set_policy(@policy)
+      end
 
       @check_waterfall
     end
+
+    private
+
+    def set_policy(value)
+      @policy = patch_policy_booleans_if(value)
+    end
+
+    # patch all booleans in hash to support check_waterfall
+    def patch_policy_booleans_if(hash)
+      return hash unless @check_waterfall
+
+      hash.transform_values! do |value|
+        if value.is_a?(TrueClass)
+          value.define_singleton_method(:dig) { |*_keys| true }
+        elsif value.is_a?(FalseClass)
+          value.define_singleton_method(:dig) { |*_keys| false }
+        elsif
+          patch_policy_booleans_if(value)
+        end
+
+        value
+      end
+    end
+
+    def blank?(item)
+      item.respond_to?(:empty?) ? !!item.empty? : !item
+    end
+
+    def present?(item)
+      !blank?(item)
+    end
   end
 
   configure {}

data/lib/passpartu/verify.rb

@@ -25,7 +25,6 @@ module Passpartu
     def call
       return false if role_ignore?
 
-      check_waterfall_if
       default_check
       check_crud_if
 
@@ -72,12 +71,6 @@ module Passpartu
       %w[create read update delete].include?(keys[-1])
     end
 
-    def check_waterfall_if
-      return unless Passpartu.config.check_waterfall && policy_missed?
-
-      @result = Passpartu::CheckWaterfall.call(role, keys)
-    end
-
     def blank?(item)
       item.respond_to?(:empty?) ? !!item.empty? : !item
     end

data/lib/passpartu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Passpartu
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passpartu
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,7 +64,6 @@ files:
 - README.md
 - lib/passpartu.rb
 - lib/passpartu/block_verify.rb
-- lib/passpartu/check_waterfall.rb
 - lib/passpartu/patcher.rb
 - lib/passpartu/user.rb
 - lib/passpartu/validate_result.rb
@@ -90,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Passpartu makes policies great again

data/lib/passpartu/check_waterfall.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Passpartu
-  class CheckWaterfall
-    attr_reader :waterfall, :policy_hash
-    def initialize(role, keys)
-      @waterfall = [role] + keys
-      @policy_hash = Passpartu.policy
-    end
-
-    def self.call(role, keys)
-      new(role, keys).call
-    end
-
-    def call
-      patch_boolean_classes
-      @result = policy_hash.dig(*waterfall)
-      reset_boolean_classes
-
-      @result
-    end
-
-    def patch_boolean_classes
-      TrueClass.define_method(:dig) { |*_keys| true }
-      FalseClass.define_method(:dig) { |*_keys| false }
-    end
-
-    def reset_boolean_classes
-      TrueClass.undef_method(:dig)
-      FalseClass.undef_method(:dig)
-    end
-  end
-end