action_policy 0.3.4 → 0.4.4

data/lib/action_policy/policy/authorization.rb

@@ -43,21 +43,17 @@ module ActionPolicy
 
       attr_reader :authorization_context
 
-      def initialize(*args, **params)
-        super(*args)
+      def initialize(record = nil, **params)
+        super(record)
 
         @authorization_context = {}
 
         self.class.authorization_targets.each do |id, opts|
-          if opts[:optional] == true
-            val = params.fetch(id, nil)
-          else
-            raise AuthorizationContextMissing, id unless params.key?(id)
+          raise AuthorizationContextMissing, id unless params.key?(id) || opts[:optional]
 
-            val = params.fetch(id)
+          val = params.fetch(id, nil)
 
-            raise AuthorizationContextMissing, id if val.nil? && opts[:allow_nil] != true
-          end
+          raise AuthorizationContextMissing, id if val.nil? && opts[:allow_nil] != true
 
           authorization_context[id] = instance_variable_set("@#{id}", val)
         end
@@ -66,9 +62,9 @@ module ActionPolicy
       end
 
       module ClassMethods # :nodoc:
-        def authorize(*ids, **opts)
+        def authorize(*ids, allow_nil: false, optional: false)
           ids.each do |id|
-            authorization_targets[id] = opts
+            authorization_targets[id] = {allow_nil: allow_nil || optional, optional: optional}
           end
 
           attr_reader(*ids)

data/lib/action_policy/policy/cache.rb

@@ -30,9 +30,20 @@ module ActionPolicy # :nodoc:
         ActionPolicy::CACHE_NAMESPACE
       end
 
-      def cache_key(rule)
-        "#{cache_namespace}/#{context_cache_key}/" \
-        "#{record._policy_cache_key}/#{self.class.name}/#{rule}"
+      def cache_key(*parts)
+        [
+          cache_namespace,
+          *parts
+        ].map { |part| part._policy_cache_key }.join("/")
+      end
+
+      def rule_cache_key(rule)
+        cache_key(
+          context_cache_key,
+          record,
+          self.class,
+          rule
+        )
       end
 
       def context_cache_key
@@ -41,7 +52,7 @@ module ActionPolicy # :nodoc:
 
       def apply_with_cache(rule)
         options = self.class.cached_rules.fetch(rule)
-        key = cache_key(rule)
+        key = rule_cache_key(rule)
 
         ActionPolicy.cache_store.then do |store|
           @result = store.read(key)
@@ -62,6 +73,17 @@ module ActionPolicy # :nodoc:
         apply_with_cache(rule) { super }
       end
 
+      def cache(*parts, **options)
+        key = cache_key(*parts)
+        ActionPolicy.cache_store.then do |store|
+          res = store.read(key)
+          next res unless res.nil?
+          res = yield
+          store.write(key, res, **options)
+          res
+        end
+      end
+
       module ClassMethods # :nodoc:
         def cache(*rules, **options)
           rules.each do |rule|

data/lib/action_policy/policy/core.rb

@@ -66,7 +66,7 @@ module ActionPolicy
       attr_reader :record, :result
 
       # NEXT_RELEASE: deprecate `record` arg, migrate to `record: nil`
-      def initialize(record = nil, _opts = nil)
+      def initialize(record = nil, *)
         @record = record
       end
 
@@ -101,7 +101,7 @@ module ActionPolicy
       #
       # If record is `nil` then we uses the current policy.
       def allowed_to?(rule, record = :__undef__, **options)
-        if record == :__undef__ && options.empty?
+        if (record == :__undef__ || record == self.record) && options.empty?
           __apply__(rule)
         else
           policy_for(record: record, **options).apply(rule)

data/lib/action_policy/policy/pre_check.rb

@@ -168,7 +168,7 @@ module ActionPolicy
             check = pre_checks.find { |c| c.name == name }
             raise "Pre-check already defined: #{name}" unless check.nil?
 
-            pre_checks << Check.new(self, name, options)
+            pre_checks << Check.new(self, name, **options)
           end
         end
 
@@ -181,7 +181,7 @@ module ActionPolicy
             next pre_checks.delete(check) if options.empty?
 
             # otherwise duplicate and apply skip options
-            pre_checks[pre_checks.index(check)] = check.dup.tap { |c| c.skip! options }
+            pre_checks[pre_checks.index(check)] = check.dup.tap { |c| c.skip!(**options) }
           end
         end
 

data/lib/action_policy/policy/reasons.rb

@@ -179,7 +179,7 @@ module ActionPolicy
 
       def allowed_to?(rule, record = :__undef__, **options)
         res =
-          if record == :__undef__
+          if (record == :__undef__ || record == self.record) && options.empty?
             policy = self
             with_clean_result { apply(rule) }
           else
@@ -189,7 +189,7 @@ module ActionPolicy
             policy.result
           end
 
-        result.reasons.add(policy, rule, res.details) if res.fail?
+        result&.reasons&.add(policy, rule, res.details) if res.fail?
 
         res.clear_details
 

data/lib/action_policy/rails/ext/active_record.rb

@@ -7,4 +7,11 @@ ActiveRecord::Relation.include(Module.new do
   def policy_cache_key
     object_id
   end
+
+  # Explicitly define the policy_class method to avoid
+  # making Relation immutable (by initializing `arel` in `#respond_to_missing?).
+  # See https://github.com/palkan/action_policy/issues/101
+  def policy_class
+    nil
+  end
 end)

data/lib/action_policy/rails/policy/instrumentation.rb

@@ -6,12 +6,19 @@ module ActionPolicy # :nodoc:
       # Add ActiveSupport::Notifications support.
       #
       # Fires `action_policy.apply_rule` event on every `#apply` call.
+      # Fires `action_policy.init` event on every policy initialization.
       module Instrumentation
-        EVENT_NAME = "action_policy.apply_rule"
+        INIT_EVENT_NAME = "action_policy.init"
+        APPLY_EVENT_NAME = "action_policy.apply_rule"
+
+        def initialize(*)
+          event = {policy: self.class.name}
+          ActiveSupport::Notifications.instrument(INIT_EVENT_NAME, event) { super }
+        end
 
         def apply(rule)
           event = {policy: self.class.name, rule: rule.to_s}
-          ActiveSupport::Notifications.instrument(EVENT_NAME, event) do
+          ActiveSupport::Notifications.instrument(APPLY_EVENT_NAME, event) do
             res = super
             event[:cached] = result.cached?
             event[:value] = result.value

data/lib/action_policy/rspec/dsl.rb

@@ -13,18 +13,18 @@ module ActionPolicy
 
       ["", "f", "x"].each do |prefix|
         class_eval <<~CODE, __FILE__, __LINE__ + 1
-          def #{prefix}succeed(msg = "succeeds", *args, **kwargs)
+          def #{prefix}succeed(msg = "succeeds", *args, **kwargs, &block)
             the_caller = caller
             #{prefix}context(msg, *args, **kwargs) do
-              instance_eval(&Proc.new) if block_given?
+              instance_eval(&block) if block_given?
               find_and_eval_shared("examples", "action_policy:policy_rule_example", the_caller.first, true, the_caller)
             end
           end
 
-          def #{prefix}failed(msg = "fails", *args, **kwargs)
+          def #{prefix}failed(msg = "fails", *args, **kwargs, &block)
             the_caller = caller
             #{prefix}context(msg, *args, **kwargs) do
-              instance_eval(&Proc.new) if block_given?
+              instance_eval(&block) if block_given?
               find_and_eval_shared("examples", "action_policy:policy_rule_example", the_caller.first, false, the_caller)
             end
           end
@@ -68,7 +68,7 @@ if defined?(::RSpec)
 
   ::RSpec.shared_examples_for "action_policy:policy_rule_example" do |success, the_caller|
     if success
-      specify do
+      specify "is allowed" do
         next if subject.success?
         raise(
           RSpec::Expectations::ExpectationNotMetError,
@@ -77,7 +77,7 @@ if defined?(::RSpec)
         )
       end
     else
-      specify do
+      specify "is denied" do
         next if subject.fail?
         raise(
           RSpec::Expectations::ExpectationNotMetError,

data/lib/action_policy/rspec/have_authorized_scope.rb

@@ -44,8 +44,8 @@ module ActionPolicy
         self
       end
 
-      def with_target
-        @target_expectations = Proc.new
+      def with_target(&block)
+        @target_expectations = block
         self
       end
 

data/lib/action_policy/testing.rb

@@ -15,7 +15,7 @@ module ActionPolicy
 
         def matches?(policy_class, actual_rule, target)
           policy_class == policy.class &&
-            target == policy.record &&
+            (target.is_a?(Class) ? target == policy.record : target === policy.record) &&
             rule == actual_rule
         end
 
@@ -107,8 +107,8 @@ module ActionPolicy
         super
       end
 
-      def scopify(*args)
-        AuthorizeTracker.track_scope(*args)
+      def scopify(*args, **kwargs)
+        AuthorizeTracker.track_scope(*args, **kwargs)
         super
       end
     end

data/lib/action_policy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionPolicy
-  VERSION = "0.3.4"
+  VERSION = "0.4.4"
 end

data/lib/generators/action_policy/install/templates/application_policy.rb

@@ -5,7 +5,7 @@ class ApplicationPolicy < ActionPolicy::Base
   #
   #   authorize :account, optional: true
   #
-  # Read more about authoriztion context: https://actionpolicy.evilmartians.io/#/authorization_context
+  # Read more about authorization context: https://actionpolicy.evilmartians.io/#/authorization_context
 
   private
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.4
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -158,9 +158,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
-- ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/bug_report_template.rb"
 - ".gitignore"
 - ".rubocop.yml"
 - ".tidelift.yml"
@@ -172,6 +172,7 @@ files:
 - Rakefile
 - action_policy.gemspec
 - benchmarks/namespaced_lookup_cache.rb
+- benchmarks/pre_checks.rb
 - bin/console
 - bin/setup
 - docs/.nojekyll
@@ -235,7 +236,7 @@ files:
 - lib/action_policy/ext/string_constantize.rb
 - lib/action_policy/ext/string_match.rb
 - lib/action_policy/ext/string_underscore.rb
-- lib/action_policy/ext/symbol_classify.rb
+- lib/action_policy/ext/symbol_camelize.rb
 - lib/action_policy/ext/yield_self_then.rb
 - lib/action_policy/i18n.rb
 - lib/action_policy/lookup_chain.rb

data/.github/FUNDING.yml

@@ -1 +0,0 @@
-tidelift: "rubygems/action_policy"