ii_policy 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12f75fa515f57c1d7cb21138025c5fea4f8202ecfdde800abec38451c54c9604
-  data.tar.gz: 5b52a7b58ed0eb07e3ff42165518e3be2b79f41846a6d34c92a0c4090c90b51a
+  metadata.gz: df4defb25b2a7c7225aa220ed7494e10d40d0313bedad29bed9d4f45f8a87285
+  data.tar.gz: c381b03ef5c094101c6f8a2fa75af0b602c2115d75b58f8dd2631a6a7c959722
 SHA512:
-  metadata.gz: '0933c5f001415a5c54ab3a89d3485d62579f0a7c0cb4a4519934dc68a17843eed920feeb44356c7f4d0e04203fd8e28f8541211ce448aa7c468de51fda0a13d8'
-  data.tar.gz: 73b0729f99bfd3ed83a13fa4ffda3ec091934b03b834f6a522667dacd822ffac4294ad11ea332cc40f5de53dabd58cd61e6726dcc1a62619fa80aaf9c131e67d
+  metadata.gz: 55f7d820cbd95e1e4294977c464539c4cf4eca1455a62e7ef38c9f7a3eee655b11207ca749fb9044c20058929f5083e3fb5199df126a0f013883a83d5597b415
+  data.tar.gz: 43ad5e24e33295aa08e3960639d58c1ea7c94ac82a5c15f1a21994042a8e7d7974f47ffe96afbb307f2f3b270b571ac495d8c980eab865c4a65226269d3ddaaf

data/.github/workflows/ci.yml

@@ -4,21 +4,29 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
-        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0']
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61', 'rails70']
         exclude:
           - ruby: 2.3
             gemfile: rails60
           - ruby: 2.3
             gemfile: rails61
+          - ruby: 2.3
+            gemfile: rails70
           - ruby: 2.4
             gemfile: rails60
           - ruby: 2.4
             gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails70
+          - ruby: 2.5
+            gemfile: rails70
+          - ruby: 2.6
+            gemfile: rails70
           - ruby: 3.0
             gemfile: rails50
           - ruby: 3.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 2.1.0
+
+* Add traversal config.
+* Add callbacks for `call_all`.
+* Add calling instrumentation.
+* Clear class cache when reloaded.
+* Bump coactive version to 0.2.
+
 ## 2.0.0
 
 * Replace chain feature with coactive.

data/README.md

@@ -262,7 +262,9 @@ IIPolicy::LogSubscriber.attach_to :ii_policy
 This subscriber will write logs in debug mode as the following example:
 
 ```
-Called ItemPolicy#index? for Item#1 and return true (Duration: 0.1ms, Allocations: 9)
+Calling ItemPolicy#index? with #<IIPolicy::Context ...>
+...
+Called ItemPolicy#index? and return true (Duration: 0.1ms, Allocations: 9)
 ```
 
 ## Contributing

data/gemfiles/rails70.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/ii_policy.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
-  spec.add_dependency "coactive", ">= 0.1"
+  spec.add_dependency "coactive", ">= 0.2"
 
   spec.add_development_dependency "rails", ">= 5.0"
   spec.add_development_dependency "sqlite3"

data/lib/ii_policy/base.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'context'
 require_relative 'core'
 require_relative 'callbacks'
 require_relative 'instrumentation'
 require_relative 'lookup'
+require_relative 'context'
+require_relative 'contextualizer'
 require_relative 'coactors'
 
 module IIPolicy
@@ -13,6 +14,7 @@ module IIPolicy
     include Callbacks
     include Instrumentation
     include Lookup
+    include Contextualizer
     include Coactors
   end
 end

data/lib/ii_policy/callbacks.rb

@@ -6,16 +6,35 @@ module IIPolicy
     include ActiveSupport::Callbacks
 
     included do
+      define_callbacks :all
       define_callbacks :call
     end
 
+    def call_all(action)
+      run_callbacks :all do
+        super
+      end
+    end
+
     def call(action)
-      run_callbacks(:call) do
+      run_callbacks :call do
         super
       end
     end
 
     class_methods do
+      def before_all(*args, &block)
+        set_callback(:all, :before, *args, &block)
+      end
+
+      def after_all(*args, &block)
+        set_callback(:all, :after, *args, &block)
+      end
+
+      def around_all(*args, &block)
+        set_callback(:all, :around, *args, &block)
+      end
+
       def before_call(*args, &block)
         set_callback(:call, :before, *args, &block)
       end

data/lib/ii_policy/coactors.rb

@@ -18,12 +18,5 @@ module IIPolicy
         alias_method :chain, :coact
       end
     end
-
-    def call(action)
-      coactors.each do |policy|
-        return false unless policy.new(@context).call(action)
-      end
-      super
-    end
   end
 end

data/lib/ii_policy/config.rb

@@ -5,7 +5,8 @@ module IIPolicy
     class_attribute :data
 
     self.data = {
-      lookup_cache: true
+      lookup_cache: true,
+      traversal: :postorder
     }
 
     data.keys.each do |key|

data/lib/ii_policy/context.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module IIPolicy
-  class Context < OpenStruct
+  class Context < Coactive::Context
   end
 end

data/lib/ii_policy/contextualizer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module IIPolicy
+  module Contextualizer
+    extend ActiveSupport::Concern
+    include Coactive::Contextualizer
+
+    def call(action)
+      contextualize do
+        super
+      end
+    end
+  end
+end

data/lib/ii_policy/controller.rb

@@ -20,7 +20,7 @@ module IIPolicy
 
     def authorize(item, context = {})
       instance = policy(item, context)
-      raise IIPolicy::AuthorizationError.new('Not Authorized') unless instance.call("#{action_name}?")
+      raise IIPolicy::AuthorizationError.new('Not Authorized') unless instance.allowed("#{action_name}?")
       instance
     end
   end

data/lib/ii_policy/core.rb

@@ -3,19 +3,35 @@
 module IIPolicy
   module Core
     extend ActiveSupport::Concern
+    include Coactive::Initializer
 
     included do
-      attr_reader :context, :user, :item, :_result
+      self.context_class = IIPolicy::Context
+      context :user, :item
+      attr_reader :_result
     end
 
-    def initialize(context = {})
-      @context = if context.is_a?(IIPolicy::Context)
-          context
-        else
-          IIPolicy::Context.new(context)
+    def initialize(args = {})
+      super
+    end
+
+    def call_all(action)
+      planned = case IIPolicy.config.traversal
+        when :preorder
+          [self] + coactors
+        when :postorder
+          coactors + [self]
+        when :inorder
+          planned = coactors.in_groups(2, false)
+          planned[0] + [self] + planned[1]
         end
-      @item = @context.item
-      @user = @context.user
+
+      planned.each do |policy|
+        result = policy == self ? call(action) : policy.new(@context).call_all(action)
+        return false unless result
+      end
+
+      return true
     end
 
     def call(action)
@@ -27,12 +43,11 @@ module IIPolicy
     end
 
     def allowed(action)
-      call(action)
+      call_all(action)
     end
 
     def policy(item)
-      context = @context.dup
-      context.item = item
+      context = self.class.context_class.new(@context.to_h.dup.merge(item: item))
       self.class.lookup(item).new(context)
     end
   end

data/lib/ii_policy/instrumentation.rb

@@ -4,6 +4,11 @@ module IIPolicy
   module Instrumentation
     extend ActiveSupport::Concern
 
+    def call_all(action)
+      ActiveSupport::Notifications.instrument 'calling.ii_policy', policy: self, action: action
+      super
+    end
+
     def call(action)
       ActiveSupport::Notifications.instrument 'call.ii_policy', policy: self, action: action do
         super

data/lib/ii_policy/log_subscriber.rb

@@ -2,15 +2,24 @@
 
 module IIPolicy
   class LogSubscriber < ActiveSupport::LogSubscriber
+    def calling(event)
+      debug do
+        policy = event.payload[:policy]
+        action = event.payload[:action]
+        "Calling #{policy.class}##{action} with #{policy.context}"
+      end
+    end
+
     def call(event)
       debug do
         policy = event.payload[:policy]
         action = event.payload[:action]
-        item = " for #{policy.item.class}##{policy.item.id}" if policy.item
-        "Called #{policy.class}##{action}#{item} and return #{policy._result} (#{additional_log(event)})"
+        "Called #{policy.class}##{action} and return #{policy._result} (#{additional_log(event)})"
       end
     end
 
+    private
+
     def additional_log(event)
       additions = ["Duration: %.1fms" % event.duration]
       additions << "Allocations: %d" % event.allocations if event.respond_to?(:allocations)

data/lib/ii_policy/railtie.rb

@@ -9,5 +9,9 @@ module IIPolicy
     ActiveSupport.on_load :action_view do
       ActionView::Base.send :include, IIPolicy::Helper
     end
+
+    ActiveSupport::Reloader.to_prepare do
+      IIPolicy::Lookup.cache.clear
+    end
   end
 end

data/lib/ii_policy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IIPolicy
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_policy
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - gemfiles/rails52.gemfile
 - gemfiles/rails60.gemfile
 - gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
 - ii_policy.gemspec
 - lib/ii_policy.rb
 - lib/ii_policy/base.rb
@@ -137,6 +138,7 @@ files:
 - lib/ii_policy/coactors.rb
 - lib/ii_policy/config.rb
 - lib/ii_policy/context.rb
+- lib/ii_policy/contextualizer.rb
 - lib/ii_policy/controller.rb
 - lib/ii_policy/core.rb
 - lib/ii_policy/errors.rb
@@ -164,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A base policy to support management of authorization logic