ii_policy 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4b0ae3047d7ec960796e3bc2cb0fec29584717eb19e23035337121b17b0f66e
-  data.tar.gz: 2d0e5696b4a5888f062ae7b9240eff50f7d94e5ee0f4bf49c461c037e4006619
+  metadata.gz: 62f7efd3ac2e7db1c4c9532e987e3ed592083cec2e00f5cca700c5c5a5bab4e6
+  data.tar.gz: e6df72f0fae98ff640ff6f87bc8bf3a1297c4470c64c45e5449b9ab439c96bdc
 SHA512:
-  metadata.gz: caec6ed0fba367ae7f425afc1c427acef1ec1260e5e0b5057f106a95f237a65d598daadd75156875a4f282d7a606c0616fb7caeccc25b8147e4edc9f7e08adde
-  data.tar.gz: a49b1a52334ce402ea35a11055a76823713564d84b9d6105e42ec931973acf67dd15d6a85f0e3c98c8d06631ac1369323b8b862883000300d275fef062fb33bf
+  metadata.gz: 928646d051e6296eff7dcb3330f8080c36fba6949ffd706165e598f8849d1cf5d6084a4eaf15daab013f289783087a1406c3417c6fb096c963ffd858e4f0c8dc
+  data.tar.gz: e21fbbf89718aa908b42acd332b85178cfe7ab8ca9c5b11525b1c0454f6475df77820e4604bc3c275f46359ac32ac9d800107444973b95bc785593d72a6d37a2

data/.github/workflows/ci.yml

@@ -39,4 +39,4 @@ jobs:
         bundler-cache: true
     - name: Run test
       run: |
-        bundle exec rspec
+        DEBUG=1 bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 1.1.0
+
+* Support method and block for `chain`.
+* Include `IIPolicy::Chain` by default.
+* Add log subscriber.
+
 ## 1.0.0
 
 * First release.

data/README.md

@@ -177,7 +177,7 @@ end
 
 #### Policy chain
 
-You can chain shared policies to base policy by including `IIPolicy::Chain` as follows:
+You can chain shared policies to base policy by using `chain` as follows:
 
 ```ruby
 # shared policy
@@ -189,8 +189,6 @@ end
 
 # base policy
 class ItemPolicy < IIPolicy::Base
-  include IIPolicy::Chain
-
   chain SharedPolicy
 
   def show?
@@ -205,6 +203,23 @@ 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
+```
+
+
 ### Lookup for policy
 
 `authorize` and `policy` lookups policy class if the first argument of them is not a policy class.
@@ -250,6 +265,21 @@ IIPolicy::Base.lookup(InheritedItem.new)
 #=> ItemPolicy
 ```
 
+### Logging
+
+Policy supports instrumentation hook supplied by `ActiveSupport::Notifications`.
+You can enable log subscriber as follows:
+
+```ruby
+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)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome at https://github.com/kanety/ii_policy.

data/lib/ii_policy.rb

@@ -6,6 +6,7 @@ require 'ii_policy/errors'
 require 'ii_policy/base'
 require 'ii_policy/controller'
 require 'ii_policy/helper'
+require 'ii_policy/log_subscriber'
 require 'ii_policy/railtie' if defined?(Rails)
 
 module IIPolicy

data/lib/ii_policy/base.rb

@@ -1,42 +1,18 @@
 # frozen_string_literal: true
 
 require_relative 'context'
+require_relative 'core'
 require_relative 'callbacks'
+require_relative 'instrumentation'
 require_relative 'lookup'
 require_relative 'chain'
 
 module IIPolicy
   class Base
+    include Core
     include Callbacks
+    include Instrumentation
     include Lookup
-
-    attr_reader :context, :user, :item
-
-    def initialize(context = {})
-      @context = if context.is_a?(IIPolicy::Context)
-          context
-        else
-          IIPolicy::Context.new(context)
-        end
-      @item = @context.item
-      @user = @context.user
-    end
-
-    def call(action)
-      run_callbacks(:call) do
-        return false if respond_to?(action) && !send(action)
-      end
-      return true
-    end
-
-    def allowed(action)
-      call(action)
-    end
-
-    def policy(item)
-      context = @context.dup
-      context.item = item
-      self.class.lookup(item).new(context)
-    end
+    include Chain
   end
 end

data/lib/ii_policy/callbacks.rb

@@ -9,6 +9,12 @@ module IIPolicy
       define_callbacks :call
     end
 
+    def call(action)
+      run_callbacks(:call) do
+        super
+      end
+    end
+
     class_methods do
       def before_call(*args, &block)
         set_callback(:call, :before, *args, &block)

data/lib/ii_policy/chain.rb

@@ -10,15 +10,28 @@ module IIPolicy
     end
 
     def call(action)
-      self.class._chains.each do |policy|
+      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)
+      def chain(*policies, &block)
         self._chains = _chains + policies
+        self._chains << block if block
       end
     end
   end

data/lib/ii_policy/core.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module IIPolicy
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :context, :user, :item, :_result
+    end
+
+    def initialize(context = {})
+      @context = if context.is_a?(IIPolicy::Context)
+          context
+        else
+          IIPolicy::Context.new(context)
+        end
+      @item = @context.item
+      @user = @context.user
+    end
+
+    def call(action)
+      if respond_to?(action) && !send(action)
+        @_result = false
+      else
+        @_result = true
+      end
+    end
+
+    def allowed(action)
+      call(action)
+    end
+
+    def policy(item)
+      context = @context.dup
+      context.item = item
+      self.class.lookup(item).new(context)
+    end
+  end
+end

data/lib/ii_policy/instrumentation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IIPolicy
+  module Instrumentation
+    extend ActiveSupport::Concern
+
+    def call(action)
+      ActiveSupport::Notifications.instrument 'call.ii_policy', policy: self, action: action do
+        super
+      end
+    end
+  end
+end

data/lib/ii_policy/log_subscriber.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module IIPolicy
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    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)})"
+      end
+    end
+
+    def additional_log(event)
+      additions = ["Duration: %.1fms" % event.duration]
+      additions << "Allocations: %d" % event.allocations if event.respond_to?(:allocations)
+      additions.join(', ')
+    end
+  end
+end

data/lib/ii_policy/lookup.rb

@@ -11,14 +11,14 @@ module IIPolicy
     end
 
     class << self
-      class_attribute :_cache
-      self._cache = {}
+      class_attribute :cache
+      self.cache = {}
 
       def call(klass)
         klass = klass.class unless klass.is_a?(Module)
         return if terminate?(klass)
 
-        cache(klass) do
+        with_cache(klass) do
           if klass.name && (policy = resolve(klass))
             policy
           elsif klass.superclass
@@ -29,9 +29,9 @@ module IIPolicy
 
       private
 
-      def cache(klass)
+      def with_cache(klass)
         if Config.lookup_cache
-          self._cache[klass] ||= yield
+          self.cache[klass] ||= yield
         else
           yield
         end

data/lib/ii_policy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_policy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -124,8 +124,11 @@ files:
 - lib/ii_policy/config.rb
 - lib/ii_policy/context.rb
 - lib/ii_policy/controller.rb
+- lib/ii_policy/core.rb
 - lib/ii_policy/errors.rb
 - lib/ii_policy/helper.rb
+- lib/ii_policy/instrumentation.rb
+- lib/ii_policy/log_subscriber.rb
 - lib/ii_policy/lookup.rb
 - lib/ii_policy/railtie.rb
 - lib/ii_policy/version.rb