ii_policy 1.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62f7efd3ac2e7db1c4c9532e987e3ed592083cec2e00f5cca700c5c5a5bab4e6
-  data.tar.gz: e6df72f0fae98ff640ff6f87bc8bf3a1297c4470c64c45e5449b9ab439c96bdc
+  metadata.gz: c7b1c0f55a4109c53a364e8350cfd853609f69b4748779b5eecf15ea79d63e98
+  data.tar.gz: dd71c867fba51c0b26aff0cf4746eda351e74437117475951ce6c0cacc81da8d
 SHA512:
-  metadata.gz: 928646d051e6296eff7dcb3330f8080c36fba6949ffd706165e598f8849d1cf5d6084a4eaf15daab013f289783087a1406c3417c6fb096c963ffd858e4f0c8dc
-  data.tar.gz: e21fbbf89718aa908b42acd332b85178cfe7ab8ca9c5b11525b1c0454f6475df77820e4604bc3c275f46359ac32ac9d800107444973b95bc785593d72a6d37a2
+  metadata.gz: 7e8cb50a214fdbc7a130c526ebdd4f24839d2539ab8be1a6a38cbc1b6d855ffcfd70aa058ddfd758af3d48d4e8a932eb494249e2ba975f5fe1beb7f6a7bf9423
+  data.tar.gz: 1f267e1d1ecd857bfd440934a047afad89667cc221cf5d89afba1d65971011e0f946fc9754b53c1c372f8e7e9afb3bf18f355946863ec5fe118c8959f3b2dada

data/.github/workflows/ci.yml

@@ -4,27 +4,41 @@ 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', 3.1]
+        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
             gemfile: rails51
           - ruby: 3.0
             gemfile: rails52
+          - ruby: 3.1
+            gemfile: rails50
+          - ruby: 3.1
+            gemfile: rails51
+          - ruby: 3.1
+            gemfile: rails52
 
     name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
 

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## 2.2.0
+
+* Use coactive 0.3.
+
+## 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.
+
 ## 1.1.0
 
 * Support method and block for `chain`.

data/README.md

@@ -175,9 +175,9 @@ class ItemPolicy < IIPolicy::Base
 end
 ```
 
-#### Policy chain
+#### Coactors
 
-You can chain shared policies to base policy by using `chain` as follows:
+You can define multiple coactors by using `coact` as follows:
 
 ```ruby
 # shared policy
@@ -189,7 +189,7 @@ end
 
 # base policy
 class ItemPolicy < IIPolicy::Base
-  chain SharedPolicy
+  coact SharedPolicy
 
   def show?
     @item.status != 'deleted'
@@ -203,22 +203,7 @@ policy.allowed(:show?)
 
 In this example, `policy.allowed(:show?)` is evaluated by `SharedPolicy#show? && ItemPolicy#show?`.
 
-You can also use method or block to find policy class dynamically:
-
-```ruby
-class ItemPolicy < IIPolicy::Base
-  chain -> { SharedPolicy }
-end
-
-class ItemPolicy < IIPolicy::Base
-  chain :chain_policy
-
-  def chain_policy
-    SharedPolicy
-  end
-end
-```
-
+See [coactive](https://github.com/kanety/coactive) for more `coact` examples:
 
 ### Lookup for policy
 
@@ -277,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/bin/console

@@ -10,5 +10,5 @@ require "ii_policy"
 # require "pry"
 # Pry.start
 
-# require "irb"
-# IRB.start
+require "irb"
+IRB.start

data/gemfiles/rails60.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem "rails", "~> 6.0.0"
+gem "psych", "~> 3.3.0"
 
 gemspec path: "../"

data/gemfiles/rails70.gemfile

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

data/ii_policy.gemspec

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

data/lib/ii_policy/base.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'context'
 require_relative 'core'
 require_relative 'callbacks'
 require_relative 'instrumentation'
 require_relative 'lookup'
-require_relative 'chain'
+require_relative 'context'
+require_relative 'contextualizer'
+require_relative 'coactors'
 
 module IIPolicy
   class Base
@@ -13,6 +14,7 @@ module IIPolicy
     include Callbacks
     include Instrumentation
     include Lookup
-    include Chain
+    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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module IIPolicy
+  module Coactors
+    extend ActiveSupport::Concern
+
+    included do
+      include Coactive::Base
+
+      configure_coactive do |config|
+        config.load_paths = ['app/policies']
+        config.class_suffix = 'Policy'
+        config.use_cache = true
+        config.lookup_superclass_until = ['ActiveRecord::Base', 'ActiveModel::Base']
+      end
+
+      class << self
+        alias_method :chain, :coact
+      end
+    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 = '1.1.0'
+  VERSION = '2.2.0'
 end

data/lib/ii_policy.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'coactive'
 
 require 'ii_policy/version'
 require 'ii_policy/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_policy
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: coactive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -116,13 +130,15 @@ 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
 - lib/ii_policy/callbacks.rb
-- lib/ii_policy/chain.rb
+- 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
@@ -150,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: A base policy to support management of authorization logic

data/lib/ii_policy/chain.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module IIPolicy
-  module Chain
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :_chains
-      self._chains = []
-    end
-
-    def call(action)
-      lookup.each do |policy|
-        return false unless policy.new(@context).call(action)
-      end
-      super
-    end
-
-    def lookup
-      self.class._chains.map do |policy|
-        if policy.is_a?(Symbol) && respond_to?(policy, true)
-          send(policy)
-        elsif policy.is_a?(Proc)
-          instance_exec(&policy)
-        else
-          policy
-        end
-      end.flatten.compact
-    end
-
-    class_methods do
-      def chain(*policies, &block)
-        self._chains = _chains + policies
-        self._chains << block if block
-      end
-    end
-  end
-end