action_policy 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946e026afb064f557ce87761fb4ddb981635d0b95ca5f8a6415ae7572932f758
-  data.tar.gz: c97a78ac4be2b1482280c70345caa881d4b6d126e1d92c7b8e852592ccca09ed
+  metadata.gz: 6530513fc2b087beae97b3b33e662f421a0f12911a1e21b2cce9778dc7f693c9
+  data.tar.gz: a915127b22da7b43cb0fc1aa1048c8a4d9c0b5a51f458039594eac17b29e92bc
 SHA512:
-  metadata.gz: 5585386d303ef8af41651a3951fadd6970d4a127226a88b7c220852235d8f7cd34f7b608ef1390ed02b921fe64f93abc9d0ddc2d2f0780293e7b925818830d17
-  data.tar.gz: '0954283e4e9576ced888c80e1e02bec3fa2c128f69f79962ba748b69aa6fbab0c46814746a9ac6fe36dd2609dc9a626fb4ee51848b84a5ebe3a584838e2eeb9e'
+  metadata.gz: 2a34ac6a7ab8289521e2ccb977ed6c6b6e655a185deb053676aad2d78674b7367d04c75abd552dafd59b1ae46465cfa117ae97239b9fd2e3cc6947d020d80775
+  data.tar.gz: 991f5b553314cf11dedaab9964d5d4b4ee384877474ed6dc814fa0c4d4bdf383b8288df46bf987a437b82a33f859ac5314a1c4bd75b1df28d8a2438886f37c40

data/.travis.yml

@@ -18,11 +18,11 @@ matrix:
       gemfile: gemfiles/railsmaster.gemfile
     - rvm: jruby-9.2.8.0
       gemfile: gemfiles/jruby.gemfile
-    - rvm: 2.6.0
+    - rvm: 2.6.5
       gemfile: gemfiles/rails6.gemfile
     - rvm: 2.5.3
       gemfile: Gemfile
-    - rvm: 2.4.3
+    - rvm: 2.5.3
       gemfile: gemfiles/rails42.gemfile
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## master
 
+## 0.4.3 (2019-12-14)
+
+- Add `#cache(*parts, **options) { ... }` method. ([@palkan][])
+
+  Allows you to cache anything in policy classes using the Action Policy
+  cache key generation mechanism.
+
+- Handle versioned Rails cache keys. ([@palkan][])
+
+  Use `#cache_with_version` as a cache key if defined.
+
 ## 0.4.2 (2019-12-13)
 
 - Fix regression introduced in 0.4.0 which broke testing Class targets. ([@palkan][])

data/docs/README.md

@@ -65,6 +65,8 @@ Learn more about the motivation behind the Action Policy and its features by wat
 
 ## Resources
 
+- RubyRussia, 2019 "Welcome, or access denied?" talk ([video](https://www.youtube.com/watch?v=y15a2g7v8i0) [RU], [slides](https://speakerdeck.com/palkan/rubyrussia-2019-welcome-or-access-denied))
+
 - Seattle.rb, 2019 "A Denial!" talk [[slides](https://speakerdeck.com/palkan/seattle-dot-rb-2019-a-denial)]
 
 - RailsConf, 2018 "Access Denied" talk [[video](https://www.youtube.com/watch?v=NVwx0DARDis), [slides](https://speakerdeck.com/palkan/railsconf-2018-access-denied-the-missing-guide-to-authorization-in-rails)]

data/docs/caching.md

@@ -166,7 +166,7 @@ Cache store must provide at least a `#read(key)` and `write(key, value, **option
 
 **NOTE:** cache store also should take care of serialiation/deserialization since the `value` is `ExecutionResult` instance (which contains also some additional information, e.g. failure reasons). Rails cache store supports serialization/deserialization out-of-the-box.
 
-By default, Action Policy builds a cache key using the following scheme:
+By default, Action Policy builds a cache key using the following scheme (defined in `#rule_cache_key(rule)` method):
 
 ```ruby
 "#{cache_namespace}/#{context_cache_key}" \
@@ -175,11 +175,29 @@ By default, Action Policy builds a cache key using the following scheme:
 
 Where `cache_namespace` is equal to `"acp:#{MAJOR_GEM_VERSION}.#{MINOR_GEM_VERSION}"`, and `context_cache_key` is a concatenation of all authorization contexts cache keys (in the same order as they are defined in the policy class).
 
-If any object does not respond to `#policy_cache_key`, we fallback to `#cache_key`. If `#cache_key` is not defined, an `ArgumentError` is raised.
+If any object does not respond to `#policy_cache_key`, we fallback to `#cache_key` (or `#cache_key_with_version` for modern Rails versions). If `#cache_key` is not defined, an `ArgumentError` is raised.
 
 **NOTE:** if your `#cache_key` method is performance-heavy (e.g. like the `ActiveRecord::Relation`'s one), we recommend to explicitly define the `#policy_cache_key` method on the corresponding class to avoid unnecessary load. See also [action_policy#55](https://github.com/palkan/action_policy/issues/55).
 
-You can define your own `cache_key` / `cache_namespace` / `context_cache_key` methods for policy class to override this logic.
+You can define your own `rule_cache_key` / `cache_namespace` / `context_cache_key` methods for policy class to override this logic.
+
+You can also use the `#cache` instance method to cache arbitrary values in you policies:
+
+```ruby
+class ApplicationPolicy < ActionPolicy::Base
+  # Suppose that a user has many roles each having an array of permissions
+  def permissions
+    cache(user) { user.roles.pluck(:permissions).flatten.uniq }
+  end
+
+  # You can pass multiple cache key "parts"
+  def account_permissions(account)
+    cache(user, account) { user.account_roles.where(account: account).pluck(:permissions).flatten.uniq }
+  end
+end
+```
+
+**NOTE:** `#cache` method uses the same cache key generation logic as rules caching (described above).
 
 #### Invalidation
 

data/gemfiles/rails42.gemfile

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gem "sqlite3", "~> 1.3.0"
 gem "rails", "~> 4.2"
+gem "thor", "< 1.0"
 gem "method_source"
 gem "unparser"
 

data/lib/action_policy/ext/policy_cache_key.rb

@@ -13,19 +13,15 @@ module ActionPolicy
       module ObjectExt
         def _policy_cache_key(use_object_id: false)
           return policy_cache_key if respond_to?(:policy_cache_key)
+          return cache_key_with_version if respond_to?(:cache_key_with_version)
           return cache_key if respond_to?(:cache_key)
 
-          return object_id if use_object_id == true
+          return object_id.to_s if use_object_id == true
 
           raise ArgumentError, "object is not cacheable"
         end
       end
 
-      # JRuby doesn't support _global_ modules refinements (see https://github.com/jruby/jruby/issues/5220)
-      # Fallback to monkey-patching.
-      # TODO: remove after 9.2.7.0 (See https://github.com/jruby/jruby/pull/5627)
-      ::Object.include(ObjectExt) if RUBY_PLATFORM =~ /java/i
-
       refine Object do
         include ObjectExt
       end
@@ -85,6 +81,12 @@ module ActionPolicy
           to_s
         end
       end
+
+      refine Module do
+        def _policy_cache_key(*)
+          name
+        end
+      end
     end
   end
 end

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2019-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter